feat!: capitalize default pattern of require-meta-docs-description
rule
#495
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 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.