Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 910 Bytes

require-meta-docs-recommended.md

File metadata and controls

39 lines (27 loc) · 910 Bytes

Require rules to implement a meta.docs.recommended property (eslint-plugin/require-meta-docs-recommended)

Defining a whether recommended value for each rule can help developers understand whether they're recommended.

Rule Details

This rule requires ESLint rules to have a valid meta.docs.recommended property.

Examples of incorrect code for this rule:

/* eslint eslint-plugin/require-meta-docs-recommended: error */

module.exports = {
  meta: {},
  create(context) {
    /* ... */
  },
};

Examples of correct code for this rule:

/* eslint eslint-plugin/require-meta-docs-recommended: error */

module.exports = {
  meta: { recommended: true },
  create(context) {
    /* ... */
  },
};

Further Reading