eslint-doc-generator icon indicating copy to clipboard operation
eslint-doc-generator copied to clipboard

Add notice link to explain rule options

Open bmish opened this issue 4 months ago • 0 comments

There are a few ESLint doc pages mentioning rule options today:

  • https://eslint.org/docs/latest/use/configure/rules
  • https://eslint.org/docs/latest/use/core-concepts#rules
  • https://eslint.org/docs/latest/extend/custom-rules#accessing-options-passed-to-a-rule
  • https://eslint.org/docs/latest/extend/custom-rules#options-schemas

Ideally, I think there would be a section we could link to on this page https://eslint.org/docs/latest/use/configure/rules that is specifically about rule options. It would be best to make this doc improvement to ESLint first before adding a link on our side.

The link would be on "configurable" or "options" in the following legends/notices:

⚙️ This rule is configurable.

⚙️ Has configuration options.

Related:

  • https://github.com/bmish/eslint-doc-generator/issues/514
  • https://github.com/bmish/eslint-doc-generator/pull/509

bmish avatar Feb 03 '24 22:02 bmish