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
docs: mention about name
field in flat config
#18252
Conversation
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for putting this together. Just left a few suggestions for clarifying.
Co-authored-by: Nicholas C. Zakas <[email protected]>
Co-authored-by: Nicholas C. Zakas <[email protected]>
Co-authored-by: Tanuj Kanti <[email protected]>
Co-authored-by: Nicholas C. Zakas <[email protected]>
recommended: { | ||
name: "example/recommended", | ||
rules: { | ||
"no-unused-vars": "warn" | ||
} | ||
}, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What would be the convention if the configuration is an array of configuration objects? Would it be the same name for all configuration objects?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point! I mentioned it here 8cccc58
Supposely the config inspector could have an indicator of duplicated names to help with that as well.
Co-authored-by: Milos Djermanovic <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a bit of grammar cleanup, but otherwise LGTM.
Co-authored-by: Nicholas C. Zakas <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thanks!
* feat: add `name` to flat configs refs: eslint/eslint#18252 * fix: npm install error
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
What changes did you make? (Give an overview)
Resolves #18231
This PR updates the docs for flat config, mentioning the
name
property. Recommending people to provide that field with a convention to have/
as the separator (consistent with how rules are composed).Is there anything you'd like reviewers to focus on?