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

feat!: capitalize default pattern of require-meta-docs-description rule #495

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

azat-io
Copy link
Contributor

@azat-io azat-io commented Nov 17, 2024

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.

@azat-io azat-io changed the title feat: capitalize default pattern of rule feat: capitalize default pattern of require-meta-docs-description rule Nov 17, 2024
@aladdin-add aladdin-add changed the title feat: capitalize default pattern of require-meta-docs-description rule feat!: capitalize default pattern of require-meta-docs-description rule Nov 18, 2024
@aladdin-add
Copy link
Contributor

👍 I support it. However this is a breaking change, we'll have to wait until the next major release to consider it. / @bmish

@bmish bmish added the BREAKING CHANGE This change will require a major version bump label Nov 18, 2024
@bmish
Copy link
Member

bmish commented Nov 18, 2024

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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
BREAKING CHANGE This change will require a major version bump
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants