Provide meta prerequisites for automatic document generation

[MikeMcC399]

This is a suggestion to provide or modify the necessary meta tags to enable automatic documentation generation using eslint-doc-generator.

ESLint doc generator recommendations

The ESLint organization recommends using the npm module eslint-doc-generator (Automatic documentation generator for ESLint plugins and rules) to support the generation of consistent documentation for ESLint plugins.

In its Configure Linting documentation it recommends the following:

... enable the recommended rules from eslint-plugin-eslint-plugin as well as:

• eslint-plugin/require-meta-docs-description to ensure your rules have consistent descriptions for use in the generated docs
• eslint-plugin/require-meta-docs-url to ensure your rule docs are linked to by editors on highlighted violations
• eslint-plugin/require-meta-schema to ensure your rules have schemas for use in determining options

Current compatibility

The repo is currently not compatible with the recommendations. The items in the following list can be checked off as they are addressed

Pass rules from:

• eslint-plugin/recommended
• eslint-plugin/require-meta-docs-description
• eslint-plugin/require-meta-docs-url
• eslint-plugin/require-meta-schema

The eslint-plugin/recommended rules fail due to meta.type and meta.schema. The rules eslint-plugin/require-meta-docs-description and eslint-plugin/require-meta-docs-url fail individually.

[MikeMcC399]

The set of 9 rules in this repo have now all been adjusted so that their meta properties pass linting for use with the eslint-doc-generator (Automatic documentation generator for ESLint plugins and rules).

The next step will be to apply the doc generator to the repo.