Skip to content

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 force-pushed the feat/capitalize-description branch from 1fa99c4 to ecaf037 Compare November 17, 2024 22:39
@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

@aladdin-add aladdin-add force-pushed the feat/capitalize-description branch from ecaf037 to 4dc9a43 Compare November 18, 2024 03:58
@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:

@aladdin-add aladdin-add force-pushed the feat/capitalize-description branch from 4dc9a43 to 914d12c Compare December 2, 2024 06:18
@azat-io azat-io mentioned this pull request Aug 4, 2025
@bmish bmish mentioned this pull request Aug 4, 2025
@Zamiell
Copy link

Zamiell commented Oct 5, 2025

I support this PR! (Today, I had to make this change manually and was surprised that it was not the default.)

@azat-io azat-io force-pushed the feat/capitalize-description branch 6 times, most recently from cf8ee69 to d668e89 Compare October 5, 2025 15:58
@azat-io azat-io force-pushed the feat/capitalize-description branch from d668e89 to e794e42 Compare October 5, 2025 16:01
@azat-io
Copy link
Contributor Author

azat-io commented Oct 5, 2025

Rebased

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.

4 participants