-
-
Notifications
You must be signed in to change notification settings - Fork 33
feat!: capitalize default pattern of require-meta-docs-description rule
#495
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
base: main
Are you sure you want to change the base?
Conversation
1fa99c4 to
ecaf037
Compare
require-meta-docs-description rule
require-meta-docs-description rulerequire-meta-docs-description rule
|
👍 I support it. However this is a breaking change, we'll have to wait until the next major release to consider it. / @bmish |
ecaf037 to
4dc9a43
Compare
|
If most of the top plugins use sentence case, then I'd be open to this. For context, I found the PR where ESLint switched over to sentence case descriptions: |
4dc9a43 to
914d12c
Compare
|
I support this PR! (Today, I had to make this change manually and was surprised that it was not the default.) |
cf8ee69 to
d668e89
Compare
d668e89 to
e794e42
Compare
|
Rebased |
|
Do you have any approximate dates for the release? |
eslint v10 is about to be released, and this will come after it - ~ 2026 Jan. refs: https://eslint.org/blog/2025/10/whats-coming-in-eslint-10.0.0/ |
This PR modifies the default pattern value of ESLint rules description.
Currently almost all ESLint plugins use descriptions starting with a capital letter.
ESLint rules, example:
https://github.com/eslint/eslint/blob/main/lib/rules/accessor-pairs.js#L149
TypeScript ESLint rules, example:
https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/rules/adjacent-overload-signatures.ts#L29
ESLint React:
https://github.com/jsx-eslint/eslint-plugin-react/blob/master/lib/rules/boolean-prop-naming.js#L47
ESLint Import:
https://github.com/un-ts/eslint-plugin-import-x/blob/master/src/rules/consistent-type-specifier-style.ts#L57
ESLint Promise:
https://github.com/eslint-community/eslint-plugin-promise/blob/main/rules/always-return.js#L162
ESLint Unicorn:
https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/rules/better-regex.js#L138
ESLint Perfectionist:
https://github.com/azat-io/eslint-plugin-perfectionist/blob/main/rules/sort-array-includes.ts#L104
I think we should change the default behavior of the rule, since even ESLint itself doesn't adhere to it and writes descriptions for rules with a capital letter.