Chore: avoid hard-coding the list of core rules in eslint:recommended (#11336)

This updates the `eslint:recommended` config to be generated dynamically rather than being hard-coded, to reduce the number of places that need to be kept up to date when core rules are added.

Author: not-an-aardvark

Makefile.js

@@ -837,7 +837,6 @@ target.checkRuleFiles = function() {
 
  echo("Validating rules");
 
- const eslintRecommended = require("./conf/eslint-recommended").rules;
  const ruleTypes = require("./tools/rule-types.json");
  const ruleFiles = find("lib/rules/").filter(fileType("js"));
  let errors = 0;
@@ -846,15 +845,6 @@ target.checkRuleFiles = function() {
  const basename = path.basename(filename, ".js");
  const docFilename = `docs/rules/${basename}.md`;
 
- /**
- * Check if basename is present in eslint:recommended configuration.
- * @returns {boolean} true if present
- * @private
- */
- function isInConfig() {
- return Object.prototype.hasOwnProperty.call(eslintRecommended, basename);
- }
-
  /**
  * Check if basename is present in rule-types.json file.
  * @returns {boolean} true if present
@@ -896,12 +886,6 @@ target.checkRuleFiles = function() {
  }
  }
 
- // check for recommended configuration
- if (!isInConfig()) {
- console.error("Missing eslint:recommended setting for %s in conf/eslint-recommended.js", basename);
- errors++;
- }
-
  // check for recommended configuration
  if (!isInRuleTypes()) {
  console.error("Missing setting for %s in tools/rule-types.json", basename);

conf/eslint-recommended.js

@@ -6,274 +6,10 @@
 
 "use strict";
 
-/* eslint sort-keys: ["error", "asc"] */
+const builtInRules = require("../lib/built-in-rules-index");
 
 module.exports = {
- rules: {
- "accessor-pairs": "off",
- "array-bracket-newline": "off",
- "array-bracket-spacing": "off",
- "array-callback-return": "off",
- "array-element-newline": "off",
- "arrow-body-style": "off",
- "arrow-parens": "off",
- "arrow-spacing": "off",
- "block-scoped-var": "off",
- "block-spacing": "off",
- "brace-style": "off",
- "callback-return": "off",
- camelcase: "off",
- "capitalized-comments": "off",
- "class-methods-use-this": "off",
- "comma-dangle": "off",
- "comma-spacing": "off",
- "comma-style": "off",
- complexity: "off",
- "computed-property-spacing": "off",
- "consistent-return": "off",
- "consistent-this": "off",
- "constructor-super": "error",
- curly: "off",
- "default-case": "off",
- "dot-location": "off",
- "dot-notation": "off",
- "eol-last": "off",
- eqeqeq: "off",
- "for-direction": "error",
- "func-call-spacing": "off",
- "func-name-matching": "off",
- "func-names": "off",
- "func-style": "off",
- "function-paren-newline": "off",
- "generator-star-spacing": "off",
- "getter-return": "error",
- "global-require": "off",
- "guard-for-in": "off",
- "handle-callback-err": "off",
- "id-blacklist": "off",
- "id-length": "off",
- "id-match": "off",
- "implicit-arrow-linebreak": "off",
- indent: "off",
- "indent-legacy": "off",
- "init-declarations": "off",
- "jsx-quotes": "off",
- "key-spacing": "off",
- "keyword-spacing": "off",
- "line-comment-position": "off",
- "linebreak-style": "off",
- "lines-around-comment": "off",
- "lines-around-directive": "off",
- "lines-between-class-members": "off",
- "max-classes-per-file": "off",
- "max-depth": "off",
- "max-len": "off",
- "max-lines": "off",
- "max-lines-per-function": "off",
- "max-nested-callbacks": "off",
- "max-params": "off",
- "max-statements": "off",
- "max-statements-per-line": "off",
- "multiline-comment-style": "off",
- "multiline-ternary": "off",
- "new-cap": "off",
- "new-parens": "off",
- "newline-after-var": "off",
- "newline-before-return": "off",
- "newline-per-chained-call": "off",
- "no-alert": "off",
- "no-array-constructor": "off",
- "no-async-promise-executor": "off",
- "no-await-in-loop": "off",
- "no-bitwise": "off",
- "no-buffer-constructor": "off",
- "no-caller": "off",
- "no-case-declarations": "error",
- "no-catch-shadow": "off",
- "no-class-assign": "error",
- "no-compare-neg-zero": "error",
- "no-cond-assign": "error",
- "no-confusing-arrow": "off",
- "no-console": "error",
- "no-const-assign": "error",
- "no-constant-condition": "error",
- "no-continue": "off",
- "no-control-regex": "error",
- "no-debugger": "error",
- "no-delete-var": "error",
- "no-div-regex": "off",
- "no-dupe-args": "error",
- "no-dupe-class-members": "error",
- "no-dupe-keys": "error",
- "no-duplicate-case": "error",
- "no-duplicate-imports": "off",
- "no-else-return": "off",
- "no-empty": "error",
- "no-empty-character-class": "error",
- "no-empty-function": "off",
- "no-empty-pattern": "error",
- "no-eq-null": "off",
- "no-eval": "off",
- "no-ex-assign": "error",
- "no-extend-native": "off",
- "no-extra-bind": "off",
- "no-extra-boolean-cast": "error",
- "no-extra-label": "off",
- "no-extra-parens": "off",
- "no-extra-semi": "error",
- "no-fallthrough": "error",
- "no-floating-decimal": "off",
- "no-func-assign": "error",
- "no-global-assign": "error",
- "no-implicit-coercion": "off",
- "no-implicit-globals": "off",
- "no-implied-eval": "off",
- "no-inline-comments": "off",
- "no-inner-declarations": "error",
- "no-invalid-regexp": "error",
- "no-invalid-this": "off",
- "no-irregular-whitespace": "error",
- "no-iterator": "off",
- "no-label-var": "off",
- "no-labels": "off",
- "no-lone-blocks": "off",
- "no-lonely-if": "off",
- "no-loop-func": "off",
- "no-magic-numbers": "off",
- "no-misleading-character-class": "off",
- "no-mixed-operators": "off",
- "no-mixed-requires": "off",
- "no-mixed-spaces-and-tabs": "error",
- "no-multi-assign": "off",
- "no-multi-spaces": "off",
- "no-multi-str": "off",
- "no-multiple-empty-lines": "off",
- "no-native-reassign": "off",
- "no-negated-condition": "off",
- "no-negated-in-lhs": "off",
- "no-nested-ternary": "off",
- "no-new": "off",
- "no-new-func": "off",
- "no-new-object": "off",
- "no-new-require": "off",
- "no-new-symbol": "error",
- "no-new-wrappers": "off",
- "no-obj-calls": "error",
- "no-octal": "error",
- "no-octal-escape": "off",
- "no-param-reassign": "off",
- "no-path-concat": "off",
- "no-plusplus": "off",
- "no-process-env": "off",
- "no-process-exit": "off",
- "no-proto": "off",
- "no-prototype-builtins": "off",
- "no-redeclare": "error",
- "no-regex-spaces": "error",
- "no-restricted-globals": "off",
- "no-restricted-imports": "off",
- "no-restricted-modules": "off",
- "no-restricted-properties": "off",
- "no-restricted-syntax": "off",
- "no-return-assign": "off",
- "no-return-await": "off",
- "no-script-url": "off",
- "no-self-assign": "error",
- "no-self-compare": "off",
- "no-sequences": "off",
- "no-shadow": "off",
- "no-shadow-restricted-names": "off",
- "no-spaced-func": "off",
- "no-sparse-arrays": "error",
- "no-sync": "off",
- "no-tabs": "off",
- "no-template-curly-in-string": "off",
- "no-ternary": "off",
- "no-this-before-super": "error",
- "no-throw-literal": "off",
- "no-trailing-spaces": "off",
- "no-undef": "error",
- "no-undef-init": "off",
- "no-undefined": "off",
- "no-underscore-dangle": "off",
- "no-unexpected-multiline": "error",
- "no-unmodified-loop-condition": "off",
- "no-unneeded-ternary": "off",
- "no-unreachable": "error",
- "no-unsafe-finally": "error",
- "no-unsafe-negation": "error",
- "no-unused-expressions": "off",
- "no-unused-labels": "error",
- "no-unused-vars": "error",
- "no-use-before-define": "off",
- "no-useless-call": "off",
- "no-useless-catch": "off",
- "no-useless-computed-key": "off",
- "no-useless-concat": "off",
- "no-useless-constructor": "off",
- "no-useless-escape": "error",
- "no-useless-rename": "off",
- "no-useless-return": "off",
- "no-var": "off",
- "no-void": "off",
- "no-warning-comments": "off",
- "no-whitespace-before-property": "off",
- "no-with": "off",
- "nonblock-statement-body-position": "off",
- "object-curly-newline": "off",
- "object-curly-spacing": "off",
- "object-property-newline": "off",
- "object-shorthand": "off",
- "one-var": "off",
- "one-var-declaration-per-line": "off",
- "operator-assignment": "off",
- "operator-linebreak": "off",
- "padded-blocks": "off",
- "padding-line-between-statements": "off",
- "prefer-arrow-callback": "off",
- "prefer-const": "off",
- "prefer-destructuring": "off",
- "prefer-numeric-literals": "off",
- "prefer-object-spread": "off",
- "prefer-promise-reject-errors": "off",
- "prefer-reflect": "off",
- "prefer-rest-params": "off",
- "prefer-spread": "off",
- "prefer-template": "off",
- "quote-props": "off",
- quotes: "off",
- radix: "off",
- "require-atomic-updates": "off",
- "require-await": "off",
- "require-jsdoc": "off",
- "require-unicode-regexp": "off",
- "require-yield": "error",
- "rest-spread-spacing": "off",
- semi: "off",
- "semi-spacing": "off",
- "semi-style": "off",
- "sort-imports": "off",
- "sort-keys": "off",
- "sort-vars": "off",
- "space-before-blocks": "off",
- "space-before-function-paren": "off",
- "space-in-parens": "off",
- "space-infix-ops": "off",
- "space-unary-ops": "off",
- "spaced-comment": "off",
- strict: "off",
- "switch-colon-spacing": "off",
- "symbol-description": "off",
- "template-curly-spacing": "off",
- "template-tag-spacing": "off",
- "unicode-bom": "off",
- "use-isnan": "error",
- "valid-jsdoc": "off",
- "valid-typeof": "error",
- "vars-on-top": "off",
- "wrap-iife": "off",
- "wrap-regex": "off",
- "yield-star-spacing": "off",
- yoda: "off"
- }
+ rules: Object.assign({}, ...Object.keys(builtInRules).map(ruleId => ({
+ [ruleId]: builtInRules[ruleId].meta.docs.recommended ? "error" : "off"
+ })))
 };