Revamp the essential style guide and mark others as legacy#3370
Open
haoqunjiang wants to merge 3 commits intovuejs:mainfrom
Open
Revamp the essential style guide and mark others as legacy#3370haoqunjiang wants to merge 3 commits intovuejs:mainfrom
haoqunjiang wants to merge 3 commits intovuejs:mainfrom
Conversation
✅ Deploy Preview for vuejs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Member
|
I'll definitely check it! And every team members should check also! |
Member
|
And since these are important changes, they should ultimately be decided by @yyx990803 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates the Style Guide in a deliberately narrow way instead of attempting a full rewrite.
The diff:
keyed v-forandv-ifwithv-forentries from the essential section and leaves those checks to toolingmulti-word-component-namesfrom the essential sectionThe essential rules in this draft are:
Taken together, these rules define the core boundaries of a Vue component: its contract, its communication model, its styling boundary, and its reactive semantics.
Why This Direction
I think the guide should stay small, stable, and principle-driven, and leave mechanical concerns to tooling.
In practice, that means:
This is also partly motivated by vuejs/eslint-plugin-vue#3060: the outdated guide is starting to create friction for tooling and keeps outdated rules in circulation.
It is also informed by the last large style guide revamp attempt in vuejs/v2.vuejs.org#2839, where the scope was broad enough that review became difficult to finish.