From 57dae8634719915a067e1b13b66682d99e1f9331 Mon Sep 17 00:00:00 2001 From: Brett Zamir Date: Mon, 12 Aug 2024 13:14:20 +0800 Subject: [PATCH] docs: add rationales section --- .README/README.md | 22 ++++++++++++++++++++++ README.md | 24 ++++++++++++++++++++++++ 2 files changed, 46 insertions(+) diff --git a/.README/README.md b/.README/README.md index 6ea9f938..768a0917 100644 --- a/.README/README.md +++ b/.README/README.md @@ -97,6 +97,28 @@ export default [ ]; ``` +##### Why certain rules were excluded from the granular configs + +A few rules were left out of the granular configs. Here is why: + +Rules which might have been added to `required`: + - [`require-throws`](./docs/rules/require-throws.md#readme) - Since this can't enforce all cases, some may not wish this rule enforced. + - [`require-file-overview`](./docs/rules/require-file-overview.md#readme) - Too demanding for all projects + - [`convert-to-jsdoc-comments`](./docs/rules/convert-to-jsdoc-comments.md#readme) - Overly aggressive for some projects + +Rules which might have been added to `logical`: + - [`no-missing-syntax`](./docs/rules/no-missing-syntax.md#readme) - Has no default options. + - [`no-restricted-syntax`](./docs/rules/no-restricted-syntax.md#readme) - Has no default options. + +Rules which might have been added to `contents`: + - [`match-name`](./docs/rules/match-name.md#readme) - Has no default options. + - [`require-description`](./docs/rules/require-description.md#readme) - Too demanding for all projects + - [`require-description-complete-sentence`](./docs/rules/require-description-complete-sentence.md#readme) - Too demanding for all projects + +Rules which might have been added to `stylistic`: + - [`check-indentation`](./docs/rules/check-indentation.md#readme) - May not be desired by all projects + - [`sort-tags`](./docs/rules/sort-tags.md#readme) - Too project-specific + ### `eslintrc` Add `plugins` section to [.eslintrc.*](https://eslint.org/docs/user-guide/configuring#configuration-file-formats) diff --git a/README.md b/README.md index 94096b48..2a0f62c9 100644 --- a/README.md +++ b/README.md @@ -117,6 +117,30 @@ export default [ ]; ``` + + +##### Why certain rules were excluded from the granular configs + +A few rules were left out of the granular configs. Here is why: + +Rules which might have been added to `required`: + - [`require-throws`](./docs/rules/require-throws.md#readme) - Since this can't enforce all cases, some may not wish this rule enforced. + - [`require-file-overview`](./docs/rules/require-file-overview.md#readme) - Too demanding for all projects + - [`convert-to-jsdoc-comments`](./docs/rules/convert-to-jsdoc-comments.md#readme) - Overly aggressive for some projects + +Rules which might have been added to `logical`: + - [`no-missing-syntax`](./docs/rules/no-missing-syntax.md#readme) - Has no default options. + - [`no-restricted-syntax`](./docs/rules/no-restricted-syntax.md#readme) - Has no default options. + +Rules which might have been added to `contents`: + - [`match-name`](./docs/rules/match-name.md#readme) - Has no default options. + - [`require-description`](./docs/rules/require-description.md#readme) - Too demanding for all projects + - [`require-description-complete-sentence`](./docs/rules/require-description-complete-sentence.md#readme) - Too demanding for all projects + +Rules which might have been added to `stylistic`: + - [`check-indentation`](./docs/rules/check-indentation.md#readme) - May not be desired by all projects + - [`sort-tags`](./docs/rules/sort-tags.md#readme) - Too project-specific + ### eslintrc