Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

types(vue.config.js): add descriptions for config #5967

Merged
merged 6 commits into from
Nov 2, 2020

Conversation

vegerot
Copy link
Contributor

@vegerot vegerot commented Oct 15, 2020

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Docs
  • Underlying tools
  • Other, please describe: Config descriptions

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

Other information:
Personally, I have found it frustrating working with vue.config.js, due to lack of type information available. Yesterday I discovered #2138 (comment) , and was delighted to see I had a bit more info, but still not as much as I'd like.

This commit adds JSDoc documentation (from docs/config/README.md) to add better editor support for vue.config.js

@fangbinwei fangbinwei self-requested a review October 26, 2020 03:26
Copy link
Collaborator

@fangbinwei fangbinwei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you 😃, just a small problem

packages/@vue/cli-service/types/ProjectOptions.d.ts Outdated Show resolved Hide resolved
Copy link
Collaborator

@fangbinwei fangbinwei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct spelling

packages/@vue/cli-service/types/ProjectOptions.d.ts Outdated Show resolved Hide resolved
fangbinwei
fangbinwei approved these changes Nov 2, 2020
Copy link
Collaborator

@fangbinwei fangbinwei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot!

@fangbinwei fangbinwei merged commit 0b86e70 into vuejs:dev Nov 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants