@eslinted/defaults 12.9.0 → 12.11.0

package/src/rules/scopes/enable.ts

@@ -1,12 +1,10 @@
 import {
   ID,
-  OFF,
+  // OFF,
   ON,
-  never,
   always,
   as_needed,
   consecutive,
-  allow,
   all,
   multi,
   both,
@@ -20,33 +18,25 @@ export const Enable = {
     "array-callback-return": [
       ON,
       {
-        allowImplicit: false,
-        checkForEach: true,
-        allowVoid: true,
+        // allowImplicit: false /* @default: false */,
+        checkForEach: true /* @default: false */,
+        allowVoid: true /* only works if checkForEach | @default: false */,
       },
     ],
     "constructor-super": ON /* tsc */,
     "for-direction": ON,
-    "getter-return": [
-      ON,
-      {
-        allowImplicit: false,
-      },
-    ] /* tsc */,
+    "getter-return": ON /* tsc */,
     "no-async-promise-executor": ON,
     "no-await-in-loop": ON,
     "no-class-assign": ON,
     "no-compare-neg-zero": ON,
-    "no-cond-assign": [
-      ON,
-      always,
-    ],
+    "no-cond-assign": ON,
     "no-const-assign": ON /* tsc */,
     "no-constant-binary-expression": ON,
     "no-constant-condition": [
       ON,
       {
-        checkLoops: true,
+        checkLoops: all /* none === false | all === true | @default: allExceptWhileTrue */,
       },
     ] /* BUG: incorrect option description (claims "all" is ok): https://eslint.org/docs/latest/rules/no-constant-condition */,
     "no-constructor-return": ON,
@@ -60,50 +50,22 @@ export const Enable = {
     "no-duplicate-imports": [
       ON,
       {
-        includeExports: true /* @default: false */,
-        allowSeparateTypeImports: true /* @default: false */,
+        includeExports: true /* @default false */,
+        allowSeparateTypeImports: true /* @default false */,
       },
     ],
     "no-empty-character-class": ON,
-    "no-empty-pattern": [
-      ON,
-      {
-        allowObjectPatternsAsParameters: false,
-      },
-    ],
+    "no-empty-pattern": ON,
     "no-ex-assign": ON,
-    "no-fallthrough": [
-      ON,
-      {
-        allowEmptyCase: true,
-        reportUnusedFallthroughComment: true,
-      },
-    ],
+    "no-fallthrough": ON,
     "no-func-assign": ON /* tsc */,
     "no-import-assign": ON /* tsc (except Object.assign()) */,
     "no-inner-declarations": [
       ON,
-      both,
-      {
-        blockScopedFunctions: allow,
-      },
-    ],
-    "no-invalid-regexp": [
-      ON,
-      {
-        allowConstructorFlags: [],
-      },
-    ],
-    "no-irregular-whitespace": [
-      ON,
-      {
-        skipStrings: true,
-        skipComments: true,
-        skipRegExps: true,
-        skipTemplates: true,
-        skipJSXText: true,
-      },
+      both /* both (function & var) | @default functions */,
     ],
+    "no-invalid-regexp": ON,
+    "no-irregular-whitespace": ON,
     "no-loss-of-precision": ON /* TS-capable, originally had TSLint rule but was deprecated */,
     "no-misleading-character-class": ON,
     "no-new-native-nonconstructor": ON,
@@ -111,16 +73,11 @@ export const Enable = {
     "no-promise-executor-return": [
       ON,
       {
-        allowVoid: true,
+        allowVoid: true /* @default false */,
       },
     ],
     "no-prototype-builtins": ON,
-    "no-self-assign": [
-      ON,
-      {
-        props: true,
-      },
-    ],
+    "no-self-assign": ON,
     "no-self-compare": ON,
     "no-setter-return": ON /* tsc */,
     "no-sparse-arrays": ON,
@@ -131,68 +88,48 @@ export const Enable = {
     "no-unexpected-multiline": ON,
     "no-unmodified-loop-condition": ON,
     "no-unreachable": ON /* tsc */,
-    "no-unreachable-loop": [
-      ON,
-      {
-        ignore: [] /* WhileStatement, DoWhileStatement, ForStatement, ForInStatement, ForOfStatement */,
-      },
-    ],
+    "no-unreachable-loop": ON,
     "no-unsafe-finally": ON,
     "no-unsafe-negation": [
       ON,
       {
-        enforceForOrderingRelations: true,
+        enforceForOrderingRelations: true /* @default false */,
       },
     ] /* tsc */,
     "no-unsafe-optional-chaining": [
       ON,
       {
-        disallowArithmeticOperators: true,
+        disallowArithmeticOperators: true /* @default false */,
       },
     ],
     "no-unused-private-class-members": ON,
-    "no-unused-vars": [
-      ON,
-      {
-        vars: all,
-        args: all,
-        caughtErrors: all,
-        ignoreRestSiblings: false,
-        ignoreClassWithStaticInitBlock: false,
-        reportUsedIgnorePattern: true,
-      },
-    ] /* TSLint */,
+    "no-unused-vars": ON /* TSLint */,
     "no-use-before-define": [
       ON,
       {
-        functions: true,
-        classes: true,
-        variables: true,
-        allowNamedExports: false,
-        enums: true,
+        // functions: true,
+        // classes: true,
+        // variables: true,
+        // allowNamedExports: false,
+        // enums: true,
         typedefs: false /* changed 14.2.2 (still questionable) */,
-        ignoreTypeReferences: true,
+        // ignoreTypeReferences: true,
       },
     ] /* TS-capable */,
     "no-useless-assignment": ON,
     "no-useless-backreference": ON,
-    "require-atomic-updates": [
-      ON,
-      {
-        allowProperties: false,
-      },
-    ],
+    "require-atomic-updates": ON,
     "use-isnan": [
       ON,
       {
-        enforceForSwitchCase: true,
-        enforceForIndexOf: true,
+        // enforceForSwitchCase: true,
+        enforceForIndexOf: true /* @default false */,
       },
     ],
     "valid-typeof": [
       ON,
       {
-        requireStringLiterals: true,
+        requireStringLiterals: true /* @default false */,
       },
     ],
     // #endregion
@@ -202,98 +139,65 @@ export const Enable = {
     "accessor-pairs": [
       ON,
       {
-        setWithoutGet: true,
-        getWithoutSet: false,
-        enforceForClassMembers: true,
-        enforceForTSTypes: true,
-      },
-    ],
-    "arrow-body-style": [
-      ON,
-      as_needed,
-      {
-        requireReturnForObjectLiteral: true,
+        // setWithoutGet: true,
+        // getWithoutSet: false,
+        // enforceForClassMembers: true,
+        enforceForTSTypes: true /* @default false */,
       },
     ],
+    "arrow-body-style": ON,
     "block-scoped-var": ON,
-    camelcase: OFF /* preference */,
-    "capitalized-comments": OFF /* preference */,
-    "class-methods-use-this": OFF /* TS-capable; (preference) */,
-    complexity: OFF /* preference */,
-    "consistent-return": [
-      ON,
-      {
-        treatUndefinedAsUnspecified: false,
-      },
-    ] /* tsc -- TSLint:OFF: tsconfig: noImplicitReturns */,
+    // camelcase: OFF /* preference */,
+    // "capitalized-comments": OFF /* preference */,
+    // "class-methods-use-this": OFF /* TS-capable; (preference) */,
+    // complexity: OFF /* preference */,
+    "consistent-return": ON /* tsc -- TSLint:OFF: tsconfig: noImplicitReturns */,
     "consistent-this": ON,
     curly: [
       ON,
-      multi,
+      multi /* multi | multi-line | multi-or-nest | consistent | @default all */,
     ],
-    "default-case": OFF /* preference: don't care */,
+    // "default-case": OFF /* preference: don't care */,
     "default-case-last": ON,
     "default-param-last": ON /* TS-capable */,
-    "dot-notation": [
-      ON,
-      {
-        allowKeywords: true,
-      },
-    ] /* TSLint */,
-    eqeqeq: [
-      ON,
-      always,
-    ],
-    "func-name-matching": OFF /* preference */,
-    "func-names": OFF /* preference */,
-    "func-style": OFF /* TS-capable BUT preference */,
-    "grouped-accessor-pairs": OFF /* preference -- BUG: requires adjacency, not as described in documentation */,
-    "guard-for-in": OFF /* preference - not helpful because using for-in on non-literal objects is bad practice and this rule doesn't guard against that anyway, while adding a pointless check to known object literals */,
-    "id-denylist": OFF /* preference */,
-    "id-length": OFF /* preference */,
-    "id-match": OFF /* preference */,
-    "init-declarations": [
-      ON,
-      always,
-    ] /* TS-capable */,
+    "dot-notation": ON /* TSLint */,
+    eqeqeq: ON,
+    // "func-name-matching": OFF /* preference */,
+    // "func-names": OFF /* preference */,
+    // "func-style": OFF /* TS-capable BUT preference */,
+    // "grouped-accessor-pairs": OFF /* preference -- BUG: requires adjacency, not as described in documentation */,
+    // "guard-for-in": OFF /* preference - not helpful because using for-in on non-literal objects is bad practice and this rule doesn't guard against that anyway, while adding a pointless check to known object literals */,
+    // "id-denylist": OFF /* preference */,
+    // "id-length": OFF /* preference */,
+    // "id-match": OFF /* preference */,
+    "init-declarations": ON /* TS-capable */,
     "logical-assignment-operators": [
       ON,
-      always,
+      always /* never | @default always */,
       {
-        enforceForIfStatements: true,
+        enforceForIfStatements: true /* @default false */,
       },
     ],
-    "max-classes-per-file": OFF /* preference */,
-    "max-depth": OFF /* preference */,
-    "max-lines": OFF /* preference */,
-    "max-lines-per-function": OFF /* preference */,
-    "max-nested-callbacks": OFF /* preference */,
-    "max-params": OFF /* TS-capable BUT preference -- TSLint:OFF: preference */,
-    "max-statements": OFF /* preference */,
-    "multiline-comment-style": OFF /* preference */,
-    "new-cap": OFF /* preference -- breaks Scriptable */,
+    // "max-classes-per-file": OFF /* preference */,
+    // "max-depth": OFF /* preference */,
+    // "max-lines": OFF /* preference */,
+    // "max-lines-per-function": OFF /* preference */,
+    // "max-nested-callbacks": OFF /* preference */,
+    // "max-params": OFF /* TS-capable BUT preference -- TSLint:OFF: preference */,
+    // "max-statements": OFF /* preference */,
+    // "multiline-comment-style": OFF /* preference */,
+    // "new-cap": OFF /* preference -- breaks Scriptable */,
     "no-alert": ON,
     "no-array-constructor": ON /* TS-capable */,
-    "no-bitwise": [
-      ON,
-      {
-        allow: [],
-        int32Hint: true,
-      },
-    ],
+    "no-bitwise": ON,
     "no-caller": ON,
     "no-case-declarations": ON,
-    "no-console": OFF /* preference -- breaks Node.js console applications and Scriptable, and otherwise unnecessarily hampers browser test code */,
+    // "no-console": OFF /* preference -- breaks Node.js console applications and Scriptable, and otherwise unnecessarily hampers browser test code */,
     "no-continue": ON,
     "no-delete-var": ON,
     "no-div-regex": ON,
-    "no-else-return": OFF /* preference */,
-    "no-empty": [
-      ON,
-      {
-        allowEmptyCatch: false,
-      },
-    ],
+    // "no-else-return": OFF /* preference */,
+    "no-empty": ON,
     "no-empty-function": [
       ON,
       {
@@ -303,71 +207,51 @@ export const Enable = {
           "protectedConstructors",
           "decoratedFunctions",
           "overrideMethods",
-        ],
-      }, /* functions, arrowFunctions, generatorFunctions, methods, generatorMethods, getters, setters, constructors, asyncFunctions, asyncMethods; TS-ONLY: privateConstructors, protectedConstructors, decoratedFunctions, overrideMethods */
+        ] /* (functions | `${arrow|generator|async|TS:decorated}Functions` | methods | `${generator|async|TS:override}Methods` | `${g|s}etters` | constructors | TS:`${private|protected}Constructors`)[] | @default [] */,
+      },
     ] /* TS-capable */,
     "no-empty-static-block": ON,
     "no-eq-null": ON,
-    "no-eval": [
-      ON,
-      {
-        allowIndirect: false,
-      },
-    ],
-    "no-extend-native": [
-      ON,
-      {
-        exceptions: [],
-      },
-    ],
+    "no-eval": ON,
+    "no-extend-native": ON,
     "no-extra-bind": ON,
     "no-extra-boolean-cast": [
       ON,
       {
-        enforceForLogicalOperands: true,
+        enforceForLogicalOperands: true /* @default false */,
       },
     ],
     "no-extra-label": ON,
-    "no-global-assign": [
-      ON,
-      {
-        exceptions: [],
-      },
-    ],
+    "no-global-assign": ON,
     "no-implicit-coercion": [
       ON,
       {
-        "boolean": true,
-        number: true,
-        string: true,
+        // "boolean": true,
+        // number: true,
+        // string: true,
         disallowTemplateShorthand: true,
-        allow: [] /**  "~" | "!!" | "+" | "- -" | "-" | "*"  */,
+        // allow: [],
       },
     ],
-    "no-implicit-globals": OFF /* investigate (breaks Scriptable? breaks Sveltekit?) */,
+    // "no-implicit-globals": OFF /* investigate (breaks Scriptable? breaks Sveltekit?) */,
     "no-implied-eval": ON /* TSLint */,
-    "no-inline-comments": OFF /* preference */,
+    // "no-inline-comments": OFF /* preference */,
     "no-invalid-this": [
       ON,
       {
-        capIsConstructor: false,
+        capIsConstructor: false /* @default true */,
       },
     ] /* TS-capable BUT tsc: TSLint:OFF: tsconfig: { strict, noImplicitThis } */,
     "no-iterator": ON,
     "no-label-var": ON,
     "no-lone-blocks": ON,
-    "no-lonely-if": OFF /* preference */,
+    // "no-lonely-if": OFF /* preference */,
     "no-loop-func": ON /* TS-capable */,
-    "no-magic-numbers": OFF /* TS-capable BUT preference - breaks TypeScript number literals, even with most liberal exceptions */,
-    "no-multi-assign": [
-      ON,
-      {
-        ignoreNonDeclaration: false,
-      },
-    ],
+    // "no-magic-numbers": OFF /* TS-capable BUT preference - breaks TypeScript number literals, even with most liberal exceptions */,
+    "no-multi-assign": ON,
     "no-multi-str": ON,
-    "no-negated-condition": OFF /* preference */,
-    "no-nested-ternary": OFF /* preference */,
+    // "no-negated-condition": OFF /* preference */,
+    // "no-nested-ternary": OFF /* preference */,
     "no-new": ON,
     "no-new-func": ON,
     "no-new-wrappers": ON,
@@ -378,199 +262,129 @@ export const Enable = {
     "no-param-reassign": [
       ON,
       {
-        props: true,
-        ignorePropertyModificationsFor: [],
-        ignorePropertyModificationsForRegex: [],
+        props: true /* @default false */,
+        // ignorePropertyModificationsFor: [],
+        // ignorePropertyModificationsForRegex: [],
       },
     ],
     "no-plusplus": [
       ON,
       {
-        allowForLoopAfterthoughts: true,
+        allowForLoopAfterthoughts: true /* @default false */,
       },
     ],
     "no-proto": ON,
-    "no-redeclare": [
-      ON,
-      {
-        builtinGlobals: true,
-      },
-    ] /* tsc -- TSLint:OFF: tsc (let, const, -var) */,
-    "no-regex-spaces": OFF /* preference */,
-    "no-restricted-exports": OFF /* preference */,
-    "no-restricted-globals": OFF /* TS-capable BUT preference */,
-    "no-restricted-imports": OFF /* preference -- TSLint:OFF */,
-    "no-restricted-properties": OFF /* preference */,
-    "no-restricted-syntax": OFF /* preference */,
-    "no-return-assign": OFF /* "always" | "except-parens" (disallow assignments unless enclosed in parens) */,
+    // "no-redeclare": OFF /* tsc -- TSLint:OFF: tsc (let, const, -var) */,
+    // "no-regex-spaces": OFF /* preference */,
+    // "no-restricted-exports": OFF /* preference */,
+    // "no-restricted-globals": OFF /* TS-capable BUT preference */,
+    // "no-restricted-imports": OFF /* preference -- TSLint:OFF */,
+    // "no-restricted-properties": OFF /* preference */,
+    // "no-restricted-syntax": OFF /* preference */,
+    // "no-return-assign": OFF /* "always" | "except-parens" (disallow assignments unless enclosed in parens) */,
     "no-script-url": ON,
-    "no-sequences": [
-      ON,
-      {
-        allowInParentheses: true,
-      },
-    ],
-    "no-shadow": OFF /* TS-capable BUT investigate */,
-    "no-shadow-restricted-names": [
-      ON,
-      {
-        reportGlobalThis: false,
-      },
-    ],
-    "no-ternary": OFF /* preference */,
+    "no-sequences": ON,
+    // "no-shadow": OFF /* TS-capable BUT investigate */,
+    "no-shadow-restricted-names": ON,
+    // "no-ternary": OFF /* preference */,
     "no-throw-literal": ON /* TSLint */,
     "no-undef-init": ON,
-    "no-undefined": OFF /* investigate (breaks Scriptable? breaks Sveltekit?) */,
-    "no-underscore-dangle": OFF /* preference */,
-    "no-unneeded-ternary": [
-      ON,
-      {
-        defaultAssignment: false,
-      },
-    ],
+    // "no-undefined": OFF /* investigate (breaks Scriptable? breaks Sveltekit?) */,
+    // "no-underscore-dangle": OFF /* preference */,
+    "no-unneeded-ternary": ON,
     "no-unused-expressions": [
       ON,
       {
-        allowShortCircuit: true,
-        allowTernary: true,
-        allowTaggedTemplates: true,
-        enforceForJSX: false,
-        ignoreDirectives: false,
+        allowShortCircuit: true /* @default false */,
+        allowTernary: true /* @default false */,
       },
     ] /* TS-capable */,
     "no-unused-labels": ON,
     "no-useless-call": ON,
     "no-useless-catch": ON,
-    "no-useless-computed-key": [
-      ON,
-      {
-        enforceForClassMembers: true,
-      },
-    ],
+    "no-useless-computed-key": ON,
     "no-useless-concat": ON,
     "no-useless-constructor": ON /* TS-capable */,
     "no-useless-escape": [
       ON,
       {
-        allowRegexCharacters: ["-"],
-      },
-    ],
-    "no-useless-rename": [
-      ON,
-      {
-        ignoreImport: false,
-        ignoreExport: false,
-        ignoreDestructuring: false,
+        allowRegexCharacters: ["-"] /* why isn't this the default behavior? */,
       },
     ],
+    "no-useless-rename": ON,
     "no-useless-return": ON,
     "no-var": ON /* TS-capable */,
     "no-void": [
       ON,
       {
-        allowAsStatement: true,
+        allowAsStatement: true /* @default false */,
       },
     ],
-    "no-warning-comments": OFF /* preference */,
+    // "no-warning-comments": OFF /* preference */,
     "no-with": ON,
-    "object-shorthand": [
-      ON,
-      always,
-      {
-        avoidQuotes: true,
-        ignoreConstructors: false,
-        avoidExplicitReturnArrows: false,
-      },
-    ],
+    "object-shorthand": ON,
     "one-var": [
       ON,
       {
         "var": consecutive,
         let: consecutive,
         "const": consecutive,
+        using: consecutive,
+        awaitUsing: consecutive,
         separateRequires: true,
       },
     ],
-    "operator-assignment": [
-      ON,
-      always,
-    ],
-    "prefer-arrow-callback": [
-      ON,
-      {
-        allowNamedFunctions: false,
-        allowUnboundThis: true,
-      },
-    ] /* TS-capable */,
+    "operator-assignment": ON,
+    "prefer-arrow-callback": ON /* TS-capable */,
     "prefer-const": [
       ON,
       {
-        destructuring: all,
-        ignoreReadBeforeAssign: false,
+        destructuring: all /* any | @default all */,
       },
     ],
     "prefer-destructuring": [
       ON,
       {
-        VariableDeclarator: {
-          array: true,
-          object: true,
-        },
         AssignmentExpression: {
-          array: false,
-          object: false,
+          array: false /* @default true */,
+          object: false /* @default true */,
         },
       },
-      {
-        enforceForRenamedProperties: true,
-      },
     ] /* TSLint */,
     "prefer-exponentiation-operator": ON,
-    "prefer-named-capture-group": OFF,
+    // "prefer-named-capture-group": OFF,
     "prefer-numeric-literals": ON,
     "prefer-object-has-own": ON,
     "prefer-object-spread": ON,
-    "prefer-promise-reject-errors": [
-      ON,
-      {
-        allowEmptyReject: false,
-      },
-    ],
+    "prefer-promise-reject-errors": ON,
     "prefer-regex-literals": [
       ON,
       {
-        disallowRedundantWrapping: true,
+        disallowRedundantWrapping: true /* @default false */,
       },
     ] /* TSLint */,
     "prefer-rest-params": ON,
     "prefer-spread": ON,
-    "prefer-template": OFF /* preference: performance */,
+    // "prefer-template": OFF /* preference: performance */,
     radix: [
       ON,
-      as_needed,
+      as_needed /* as-needed | @default always */,
     ],
     "require-await": ON /* TSLint */,
     "require-unicode-regexp": ON,
     "require-yield": ON,
-    "sort-imports": OFF /* preference */,
-    "sort-keys": OFF /* preference */,
-    "sort-vars": OFF /* preference */,
-    strict: OFF /* preference */,
-    "symbol-description": OFF /* preference */,
+    // "sort-imports": OFF /* preference */,
+    // "sort-keys": OFF /* preference */,
+    // "sort-vars": OFF /* preference */,
+    // strict: OFF /* preference */,
+    // "symbol-description": OFF /* preference */,
     "vars-on-top": ON,
-    yoda: [
-      ON,
-      never,
-      {
-        exceptRange: false,
-        onlyEquality: false,
-      },
-    ],
+    yoda: ON,
     // #endregion
 
     // #region FORMATTING
     // [ https://eslint.org/docs/latest/rules/#layout--formatting ]
-    "unicode-bom": OFF /* preference: don't care */,
+    // "unicode-bom": OFF /* preference: don't care */,
     // #endregion
   } as const,
 };