eslint-config-isaacscript 3.7.1 → 4.0.0

package/base-unicorn.js

@@ -0,0 +1,227 @@
+// This ESLint config only contains rules from `eslint-plugin-unicorn`:
+// https://github.com/sindresorhus/eslint-plugin-unicorn
+
+// Rules are separated into categories:
+// 1) Normal rules
+// 2) Deprecated rules
+
+/** @type {import("eslint").Linter.RulesRecord} */
+const NORMAL_RULES = {
+  "unicorn/better-regex": "error",
+  "unicorn/catch-error-name": "error",
+
+  /** Disabled because it has too many false positives. */
+  "unicorn/consistent-destructuring": "off",
+
+  "unicorn/consistent-function-scoping": "error",
+  "unicorn/custom-error-definition": "error",
+  "unicorn/empty-brace-spaces": "off", // eslint-config-prettier
+  "unicorn/error-message": "error",
+  "unicorn/escape-case": "error",
+  "unicorn/expiring-todo-comments": "error",
+  "unicorn/explicit-length-check": "error",
+
+  /** Disabled since projects may use different file naming conventions. */
+  "unicorn/filename-case": "off",
+
+  "unicorn/import-style": "error",
+  "unicorn/new-for-builtins": "error",
+
+  /** Superseded by the `eslint-comments/no-unlimited-disable` rule. */
+  "unicorn/no-abusive-eslint-disable": "off",
+
+  "unicorn/no-array-callback-reference": "error",
+  "unicorn/no-array-for-each": "error",
+  "unicorn/no-array-method-this-argument": "error",
+  "unicorn/no-array-push-push": "error",
+  "unicorn/no-array-reduce": "error",
+  "unicorn/no-await-expression-member": "error",
+  "unicorn/no-console-spaces": "error",
+  "unicorn/no-document-cookie": "error",
+  "unicorn/no-empty-file": "error",
+  "unicorn/no-for-loop": "error",
+  "unicorn/no-hex-escape": "error",
+  "unicorn/no-instanceof-array": "error",
+  "unicorn/no-invalid-remove-event-listener": "error",
+
+  /** Disabled because it is common to prefix variables with "new". */
+  "unicorn/no-keyword-prefix": "off",
+
+  "unicorn/no-lonely-if": "error",
+  "unicorn/no-negated-condition": "error",
+  "unicorn/no-nested-ternary": "off", // eslint-config-prettier
+  "unicorn/no-new-array": "error",
+  "unicorn/no-new-buffer": "error",
+  "unicorn/no-null": "error",
+  "unicorn/no-object-as-default-parameter": "error",
+
+  /**
+   * Disabled because using `process.exit` is common to exit command-line applications without
+   * verbose output.
+   */
+  "unicorn/no-process-exit": "off",
+
+  "unicorn/no-static-only-class": "error",
+  "unicorn/no-thenable": "error",
+  "unicorn/no-this-assignment": "error",
+  "unicorn/no-typeof-undefined": "error",
+  "unicorn/no-unnecessary-await": "error",
+  "unicorn/no-unreadable-array-destructuring": "error",
+  "unicorn/no-unreadable-iife": "error",
+  "unicorn/no-unused-properties": "error",
+  "unicorn/no-useless-fallback-in-spread": "error",
+  "unicorn/no-useless-length-check": "error",
+  "unicorn/no-useless-promise-resolve-reject": "error",
+  "unicorn/no-useless-spread": "error",
+  "unicorn/no-useless-switch-case": "error",
+
+  /** Disabled since it does not work properly with TypeScript. */
+  "unicorn/no-useless-undefined": "off",
+
+  "unicorn/no-zero-fractions": "error",
+  "unicorn/number-literal-case": "off", // eslint-config-prettier
+  "unicorn/numeric-separators-style": "error",
+  "unicorn/prefer-add-event-listener": "error",
+  "unicorn/prefer-array-find": "error",
+  "unicorn/prefer-array-flat": "error",
+  "unicorn/prefer-array-flat-map": "error",
+  "unicorn/prefer-array-index-of": "error",
+  "unicorn/prefer-array-some": "error",
+  "unicorn/prefer-at": "error",
+  "unicorn/prefer-blob-reading-methods": "error",
+  "unicorn/prefer-code-point": "error",
+  "unicorn/prefer-date-now": "error",
+  "unicorn/prefer-default-parameters": "error",
+  "unicorn/prefer-dom-node-append": "error",
+  "unicorn/prefer-dom-node-dataset": "error",
+  "unicorn/prefer-dom-node-remove": "error",
+  "unicorn/prefer-dom-node-text-content": "error",
+  "unicorn/prefer-event-target": "error",
+  "unicorn/prefer-export-from": "error",
+  "unicorn/prefer-includes": "error",
+
+  /** Disabled because the rule is not compatible with TypeScript. */
+  "unicorn/prefer-json-parse-buffer": "off",
+
+  "unicorn/prefer-keyboard-event-key": "error",
+  "unicorn/prefer-logical-operator-over-ternary": "error",
+  "unicorn/prefer-math-trunc": "error",
+  "unicorn/prefer-modern-dom-apis": "error",
+  "unicorn/prefer-modern-math-apis": "error",
+  "unicorn/prefer-module": "error",
+  "unicorn/prefer-native-coercion-functions": "error",
+  "unicorn/prefer-negative-index": "error",
+  "unicorn/prefer-node-protocol": "error",
+  "unicorn/prefer-number-properties": "error",
+  "unicorn/prefer-object-from-entries": "error",
+  "unicorn/prefer-optional-catch-binding": "error",
+  "unicorn/prefer-prototype-methods": "error",
+  "unicorn/prefer-query-selector": "error",
+  "unicorn/prefer-reflect-apply": "error",
+  "unicorn/prefer-regexp-test": "error",
+  "unicorn/prefer-set-has": "error",
+  "unicorn/prefer-set-size": "error",
+  "unicorn/prefer-spread": "error",
+  "unicorn/prefer-string-replace-all": "error",
+  "unicorn/prefer-string-slice": "error",
+  "unicorn/prefer-string-starts-ends-with": "error",
+  "unicorn/prefer-string-trim-start-end": "error",
+  "unicorn/prefer-switch": "error",
+  "unicorn/prefer-ternary": "error",
+  "unicorn/prefer-top-level-await": "error",
+  "unicorn/prefer-type-error": "error",
+
+  /** Disabled since it is common to use the variable name of "i". */
+  "unicorn/prevent-abbreviations": "off",
+
+  "unicorn/relative-url-style": "error",
+  "unicorn/require-array-join-separator": "error",
+  "unicorn/require-number-to-fixed-digits-argument": "error",
+
+  /** Disabled since it is not recommended by the plugin authors. */
+  "unicorn/require-post-message-target-origin": "off",
+
+  /** Disabled since string content enforcement is too project-specific. */
+  "unicorn/string-content": "off",
+
+  "unicorn/switch-case-braces": "error",
+  "unicorn/template-indent": "error",
+  "unicorn/text-encoding-identifier-case": "error",
+  "unicorn/throw-new-error": "error",
+};
+
+/** @type {import("eslint").Linter.RulesRecord} */
+const DEPRECATED_RULES = {
+  /** Disabled because this rule is deprecated. */
+  "unicorn/import-index": "off",
+
+  /** Disabled because this rule is deprecated. */
+  "unicorn/no-array-instanceof": "off",
+
+  /** Disabled because this rule is deprecated. */
+  "unicorn/no-fn-reference-in-iterator": "off",
+
+  /** Disabled because this rule is deprecated. */
+  "unicorn/no-reduce": "off",
+
+  /** Disabled because this rule is deprecated. */
+  "unicorn/no-unsafe-regex": "off",
+
+  /** Disabled because this rule is deprecated. */
+  "unicorn/prefer-dataset": "off",
+
+  /** Disabled because this rule is deprecated. */
+  "unicorn/prefer-event-key": "off",
+
+  /** Disabled because this rule is deprecated. */
+  "unicorn/prefer-exponentiation-operator": "off",
+
+  /** Disabled because this rule is deprecated. */
+  "unicorn/prefer-flat-map": "off",
+
+  /** Disabled because this rule is deprecated. */
+  "unicorn/prefer-node-append": "off",
+
+  /** Disabled because this rule is deprecated. */
+  "unicorn/prefer-node-remove": "off",
+
+  /** Disabled because this rule is deprecated. */
+  "unicorn/prefer-object-has-own": "off",
+
+  /** Disabled because this rule is deprecated. */
+  "unicorn/prefer-replace-all": "off",
+
+  /** Disabled because this rule is deprecated. */
+  "unicorn/prefer-starts-ends-with": "off",
+
+  /** Disabled because this rule is deprecated. */
+  "unicorn/prefer-text-content": "off",
+
+  /** Disabled because this rule is deprecated. */
+  "unicorn/prefer-trim-start-end": "off",
+
+  /** Disabled because this rule is deprecated. */
+  "unicorn/regex-shorthand": "off",
+};
+
+/** @type {import("eslint").Linter.Config} */
+const config = {
+  plugins: ["unicorn"],
+
+  rules: {
+    ...NORMAL_RULES,
+    ...DEPRECATED_RULES,
+  },
+
+  overrides: [
+    // Disable some TypeScript-specific rules in JavaScript files.
+    {
+      files: ["*.js", "*.cjs", "*.mjs", "*.jsx"],
+      rules: {
+        "unicorn/prefer-module": "off",
+      },
+    },
+  ],
+};
+
+module.exports = config;

package/base.js

@@ -1,36 +1,15 @@
-// This is a shared configuration file for ESLint:
-// https://eslint.org/docs/latest/user-guide/configuring
-// This config is meant to be used as a base for all TypeScript projects.
-module.exports = {
+/**
+ * This ESLint config is meant to be used as a base for all TypeScript projects.
+ *
+ *  @type {import("eslint").Linter.Config}
+ */
+const config = {
   extends: [
     /**
-     * The linter base is the Airbnb style guide, which is the most popular JavaScript style guide
-     * in the world:
-     * https://github.com/airbnb/javascript
-     *
-     * The actual ESLint config is located here:
-     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules
-     */
-    "airbnb-base",
-
-    /**
-     * The TypeScript config extends it:
-     * https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
-     * (This includes the "parser" declaration of "@typescript-eslint/parser".)
-     */
-    "airbnb-typescript/base",
-
-    /**
-     * We extend the Airbnb rules with the "recommended", "recommended-requiring-type-checking", and
-     * "strict" rules from the "typescript-eslint" plugin, which is also recommended by Matt
-     * Turnbull, the author of "airbnb-typescript/base":
-     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/recommended.ts
-     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/recommended-requiring-type-checking.ts
-     * https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/strict.ts
+     * Find deprecated code:
+     * https://github.com/gund/eslint-plugin-deprecation
      */
-    "plugin:@typescript-eslint/recommended",
-    "plugin:@typescript-eslint/recommended-requiring-type-checking",
-    "plugin:@typescript-eslint/strict",
+    "plugin:deprecation/recommended",
 
     /**
      * This provides extra miscellaneous rules to keep code safe:
@@ -38,48 +17,30 @@ module.exports = {
      */
     "plugin:isaacscript/recommended",
 
-    /**
-     * Find unused "eslint-disable" comments:
-     * https://github.com/mysticatea/eslint-plugin-eslint-comments
-     */
-    "plugin:eslint-comments/recommended",
-
-    /**
-     * Lint Node-specific things:
-     * https://github.com/eslint-community/eslint-plugin-n
-     */
-    "plugin:n/recommended",
-
     /**
      * Disable any ESLint rules that conflict with Prettier:
      * https://github.com/prettier/eslint-config-prettier
-     * (Otherwise, we will have unfixable ESLint errors.)
+     * Otherwise, we will have unfixable ESLint errors. Note that the Prettier config has to be
+     * before the base ESLint config below since we customize some special rules as documented here:
+     * https://github.com/prettier/eslint-config-prettier#special-rules
      */
     "prettier",
 
-    /** Rule modifications are split out into different files for better organization. */
+    /**
+     * Rule modifications are split out into different files for better organization (based on the
+     * originating plugin) .
+     */
     "./base-eslint",
+    "./base-no-autofix",
     "./base-typescript-eslint",
+    "./base-eslint-comments",
+    "./base-import",
     "./base-jsdoc",
+    "./base-n", // "n" stands for Node.
+    "./base-unicorn",
   ],
 
   plugins: [
-    /** Activate the "deprecation" plugin, which helps to find deprecated code. */
-    "deprecation",
-
-    /**
-     * Activate the "no-autofix" plugin, which allows the fixer for specific rules to be turned off:
-     * https://github.com/aladdin-add/eslint-plugin/tree/master/packages/no-autofix
-     */
-    "no-autofix",
-
-    /**
-     * Activate the "no-type-assertion" plugin, which allows the "no-type-assertion" rule to be
-     * optionally enabled on a per-project basis:
-     * https://github.com/Dremora/eslint-plugin-no-type-assertion
-     */
-    "no-type-assertion",
-
     /**
      * Activate the "eslint-plugin-only-warn" plugin to change all errors to warnings:
      * https://github.com/bfanger/eslint-plugin-only-warn
@@ -88,280 +49,8 @@ module.exports = {
      * compiler (which show up in red) and ESLint rule violations (which show up in yellow).
      */
     "only-warn",
-
-    /**
-     * Activate the "sort-exports" plugin, which allows the "sort-exports" rule to be optionally
-     * enabled on a per-project basis:
-     * https://github.com/jrdrg/eslint-plugin-sort-exports
-     */
-    "sort-exports",
-
-    /**
-     * Activate the "unicorn" plugin, which allows for various miscellaneous useful rules:
-     * https://github.com/sindresorhus/eslint-plugin-unicorn
-     */
-    "unicorn",
   ],
 
-  rules: {
-    /**
-     * Documentation:
-     * https://github.com/gund/eslint-plugin-deprecation
-     *
-     * Not defined in parent configs.
-     *
-     * Warn on deprecated code.
-     */
-    "deprecation/deprecation": "warn",
-
-    /**
-     * Documentation:
-     * https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/docs/rules/disable-enable-pair.md
-     *
-     * Defined at:
-     * https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/lib/configs/recommended.js
-     *
-     * By default, it does not allow "eslint-disable" comments for a whole file, which is standard
-     * practice.
-     */
-    "eslint-comments/disable-enable-pair": [
-      "warn",
-      {
-        allowWholeFile: true,
-      },
-    ],
-
-    /**
-     * Documentation:
-     * https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/docs/rules/no-unlimited-disable.md
-     *
-     * Defined at:
-     * https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/lib/configs/recommended.js
-     *
-     * If a line breaks two or more ESLint rules, then it is useful to use a single "eslint-disable"
-     * comment.
-     */
-    "eslint-comments/no-unlimited-disable": "off",
-
-    /**
-     * Documentation:
-     * https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/docs/rules/no-unused-disable.md
-     *
-     * Not defined in the parent configs.
-     *
-     * This can help clean up unnecessary comments.
-     */
-    "eslint-comments/no-unused-disable": "warn",
-
-    /**
-     * Documentation:
-     * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/extensions.md
-     *
-     * Defined at:
-     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/imports.js
-     * https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js
-     *
-     * This rule is useful in commonjs codebases that want to ban file extensions on imports.
-     * However, ESM is now the standard and file extensions should be used. Furthermore, in
-     * TypeScript codebases, the compiler will alert us to any errors on a file extension in an
-     * import statement.
-     */
-    "import/extensions": "off",
-
-    /**
-     * Documentation:
-     * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-default-export.md
-     *
-     * Not defined in the parent configs.
-     *
-     * The case against default exports is layed out here:
-     * https://basarat.gitbook.io/typescript/main-1/defaultisbad
-     */
-    "import/no-default-export": "warn",
-
-    /**
-     * Documentation:
-     * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-unresolved.md
-     *
-     * Defined at:
-     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/imports.js
-     *
-     * This rule is not necessary in TypeScript codebases, since the compiler would error if you had
-     * a typo in an import statement.
-     */
-    "import/no-unresolved": "off",
-
-    /**
-     * Documentation:
-     * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/prefer-default-export.md
-     *
-     * Defined at:
-     * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/imports.js
-     *
-     * The case against default exports is layed out here:
-     * https://basarat.gitbook.io/typescript/main-1/defaultisbad
-     */
-    "import/prefer-default-export": "off",
-
-    /**
-     * Documentation:
-     * https://github.com/mysticatea/eslint-plugin-node/blob/master/docs/rules/file-extension-in-import.md
-     *
-     * Not defined in parent configs.
-     *
-     * We use this to automatically fix import statements to ESM.
-     */
-    "n/file-extension-in-import": ["warn", "always"],
-
-    /**
-     * Documentation:
-     * https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/no-extraneous-import.md
-     *
-     * Defined at:
-     * https://github.com/eslint-community/eslint-plugin-n/blob/master/lib/configs/_commons.js
-     *
-     * The TypeScript compiler will warn us if an import does not exist, so this rule is
-     * unnecessary.
-     */
-    "n/no-extraneous-import": "off",
-
-    /**
-     * Documentation:
-     * https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/no-extraneous-require.md
-     *
-     * Defined at:
-     * https://github.com/eslint-community/eslint-plugin-n/blob/master/lib/configs/_commons.js
-     *
-     * Require statements are not used in TypeScript code.
-     */
-    "n/no-extraneous-require": "off",
-
-    /**
-     * Documentation:
-     * https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/no-missing-import.md
-     *
-     * Defined at:
-     * https://github.com/eslint-community/eslint-plugin-n/blob/master/lib/configs/_commons.js
-     *
-     * The TypeScript compiler will warn us if an import does not exist, so this rule is
-     * unnecessary.
-     */
-    "n/no-missing-import": "off",
-
-    /**
-     * Documentation:
-     * https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/no-process-exit.md
-     *
-     * Defined at:
-     * https://github.com/eslint-community/eslint-plugin-n/blob/master/lib/configs/_commons.js
-     *
-     * Using "process.exit" allows the ability to exit command-line applications without verbose
-     * output.
-     */
-    "n/no-process-exit": "off",
-
-    /**
-     * Documentation:
-     * https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/no-unsupported-features/es-syntax.md
-     *
-     * Defined at:
-     * https://github.com/eslint-community/eslint-plugin-n/blob/master/lib/configs/_commons.js
-     *
-     * This rule requires adding `parserOptions.ecmaVersion` to every ESLint configuration file. The
-     * rule does not provide enough value to make that modification worth it.
-     */
-    "n/no-unsupported-features/es-syntax": "off",
-
-    /**
-     * Documentation:
-     * https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/no-unsupported-features/es-syntax.md
-     *
-     * Defined at:
-     * https://github.com/eslint-community/eslint-plugin-n/blob/master/lib/configs/_commons.js
-     *
-     * This rule requires adding `parserOptions.ecmaVersion` to every ESLint configuration file. The
-     * rule does not provide enough value to make that modification worth it.
-     */
-    "n/no-unsupported-features/es-builtins": "off",
-
-    /**
-     * Documentation:
-     * https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/no-unsupported-features/node-builtins.md
-     *
-     * Defined at:
-     * https://github.com/eslint-community/eslint-plugin-n/blob/master/lib/configs/_commons.js
-     *
-     * The TypeScript compiler will prevent us from using Node modules that are not present in the
-     * corresponding specified Node output environment, so this rule is unnecessary.
-     */
-    "n/no-unsupported-features/node-builtins": "off",
-
-    /**
-     * Documentation:
-     * https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/shebang.md
-     *
-     * Defined at:
-     * https://github.com/eslint-community/eslint-plugin-n/blob/master/lib/configs/_commons.js
-     *
-     * We need to configure this rule to be Typescript-aware.
-     */
-    "n/shebang": [
-      "warn",
-      {
-        convertPath: {
-          "src/**/*.ts": ["^src/(.+?)\\.ts$", "dist/$1.js"],
-        },
-      },
-    ],
-
-    /**
-     * Documentation:
-     * https://github.com/aladdin-add/eslint-plugin/tree/master/packages/no-autofix
-     *
-     * We want to disable the autofix for this rule, since it is almost always unwanted.
-     */
-    "no-useless-return": "off",
-    "no-autofix/no-useless-return": "warn",
-
-    /**
-     * Documentation:
-     * https://github.com/aladdin-add/eslint-plugin/tree/master/packages/no-autofix
-     *
-     * We want to disable the autofix for this rule, since it is almost always unwanted.
-     */
-    "prefer-const": "off",
-    "no-autofix/prefer-const": "warn",
-
-    /**
-     * Documentation:
-     * https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/prefer-node-protocol.md
-     *
-     * Not defined in parent configs.
-     *
-     * Enforce the new "node:" prefix as an extra safety measure.
-     */
-    "unicorn/prefer-node-protocol": "warn",
-
-    /**
-     * Documentation:
-     * https://eslint.org/docs/latest/rules/no-restricted-syntax
-     *
-     * Not defined in parent configs.
-     *
-     * Prevent superfluous type annotations, which can cause bugs with widened types.
-     */
-    // https://github.com/typescript-eslint/typescript-eslint/issues/6446
-    "no-restricted-syntax": [
-      "warn",
-      {
-        selector:
-          'VariableDeclarator[id.typeAnnotation] > :matches(TSTypeAssertion, TSAsExpression) > TSTypeReference.typeAnnotation > Identifier[name="const"]',
-        message:
-          "Don't use `as const` with a type annotated variable, since it widens the type.",
-      },
-    ],
-  },
-
   overrides: [
     // Disable some TypeScript-specific rules in JavaScript files.
     {
@@ -372,13 +61,7 @@ module.exports = {
         "isaacscript/require-capital-read-only": "off",
       },
     },
-
-    // Remark configs require a default export.
-    {
-      files: [".remarkrc.mjs"],
-      rules: {
-        "import/no-default-export": "off",
-      },
-    },
   ],
 };
+
+module.exports = config;