Skip to content

feat!: enable no-meta-replaced-by, no-meta-schema-default, require-meta-default-options, require-meta-schema-description as recommended rules #530

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Aug 4, 2025
Merged

feat!: enable no-meta-replaced-by, no-meta-schema-default, require-meta-default-options, require-meta-schema-description as recommended rules #530

merged 2 commits into from
Aug 4, 2025

Conversation

bmish
Copy link
Member

@bmish bmish commented Jun 21, 2025 •
edited
Loading

Includes:

Note: the new rule require-meta-docs-recommended is NOT intended to become a recommended rule, so we won't add this

Part of:

@bmish
feat!: enable no-meta-replaced-by, no-meta-schema-default, require-me…
0751183 
…ta-default-options, require-meta-schema-description as recommended rules
@bmish bmish added the BREAKING CHANGE This change will require a major version bump label Jun 21, 2025
@bmish bmish requested a review from aladdin-add June 21, 2025 01:47
@bmish bmish mentioned this pull request Jun 21, 2025
Closed
@bmish
Copy link
Member Author

bmish commented Jul 17, 2025

@aladdin-add can you look?

@bmish
Merge branch 'main' into recommended-rules-v7
e352a34 
* main:
  feat: migrate package to TypeScript and publish types (eslint-community#534)
  build: convert eslint-remote-tester config to typescript (eslint-community#533)
  refactor: remove context compat functions (eslint-community#532)
  build: migrate eslint.config.js to typescript  (eslint-community#531)
@aladdin-add
Copy link
Contributor

the rule require-meta-docs-recommended was also introduced in v6: https://github.com/eslint-community/eslint-plugin-eslint-plugin/releases/tag/v6.1.0

do we want to enable it too (possibly helpful for eslint-doc-generator)?

@bmish
Copy link
Member Author

bmish commented Aug 4, 2025 •
edited
Loading

I tried to make it clear originally in the require-meta-docs-recommended rule doc that this rule is not suitable to become a recommended rule, especially because not all plugins even have a recommended config:

However, this rule may not be appropriate for all plugins:

  • Extra scripting/tooling is needed to keep the flags in sync with the config
  • The flag may not scale to plugins that have multiple/many configs or don't have a recommended config
  • Or some may simply prefer to keep the source of truth solely in the config rather than duplicating config membership data in the rules

eslint-doc-generator doesn't rely on it.

So I've intentionally omitted it from this PR.

aladdin-add
aladdin-add approved these changes Aug 4, 2025
View reviewed changes
Copy link
Contributor

@aladdin-add aladdin-add left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@aladdin-add aladdin-add merged commit b353bd1 into eslint-community:main Aug 4, 2025
6 checks passed
@github-actions github-actions bot mentioned this pull request Aug 4, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aladdin-add aladdin-add aladdin-add approved these changes

@brettz9 brettz9 Awaiting requested review from brettz9

@fasttime fasttime Awaiting requested review from fasttime

@MichaelDeBoey MichaelDeBoey Awaiting requested review from MichaelDeBoey

Assignees
No one assigned
Labels
BREAKING CHANGE This change will require a major version bump
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@bmish @aladdin-add