Skip to content

docs: document plugins field and core rules usage in config reference#774

Merged
fansenze merged 1 commit intomainfrom
docs/plugins-config-20260422
Apr 22, 2026
Merged

docs: document plugins field and core rules usage in config reference#774
fansenze merged 1 commit intomainfrom
docs/plugins-config-20260422

Conversation

@fansenze
Copy link
Copy Markdown
Contributor

Summary

  • Add a dedicated plugins section to website/docs/en/config/index.md covering the field type, built-in plugin names (@typescript-eslint, import, jest, promise, react), and a usage example, filling the gap where the previous page described every other config field except plugins.
  • Expand the plugins table in website/docs/en/config/rules-and-presets.md to include jest and promise, aligning the docs with the current KnownPlugins list on the Go side.
  • Clarify in both pages that ESLint core rules (e.g. no-unused-vars, prefer-const) carry no prefix and can be enabled directly in rules without declaring anything under plugins.

Related Links

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).

Add a dedicated plugins section to the config index page covering the
field type, built-in plugin names, and a usage example. Expand the
plugins table in rules-and-presets to cover jest and promise, and
clarify that ESLint core rules need no plugin entry to be enabled.
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the documentation by adding a comprehensive section for the plugins configuration option in index.md and expanding the list of supported plugins in rules-and-presets.md. It also clarifies the usage of ESLint core rules, noting that they do not require a plugin prefix. I have no feedback to provide as there were no review comments.

@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying rslint with  Cloudflare Pages  Cloudflare Pages

Latest commit: 8b6310a
Status: ✅  Deploy successful!
Preview URL: https://720463bd.rslint.pages.dev
Branch Preview URL: https://docs-plugins-config-20260422.rslint.pages.dev

View logs

@fansenze fansenze merged commit 9e34c0b into main Apr 22, 2026
11 checks passed
@fansenze fansenze deleted the docs/plugins-config-20260422 branch April 22, 2026 07:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants