eslint-config-isaacscript 4.20.0 → 5.0.0

package/configs/base-import.js

@@ -1,250 +0,0 @@
-// This ESLint config only contains rules from `eslint-plugin-import`:
-// https://github.com/import-js/eslint-plugin-import
-
-// Rules are separated into categories:
-// 1) Helpful warnings
-// 2) Module systems
-// 3) Static analysis
-// 4) Style guide
-
-/** @type {import("eslint").Linter.RulesRecord} */
-const HELPFUL_WARNINGS = {
-  "import/export": "error",
-
-  /**
-   * Superseded by the `deprecation/deprecation` rule. (That rule is better because it catches
-   * deprecated usage that does not come from import statements specifically.)
-   */
-  "import/no-deprecated": "off",
-
-  "import/no-empty-named-blocks": "error",
-
-  /**
-   * The options are [copied from
-   * Airbnb](https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/import.js).
-   *
-   * We also add a "scripts" directory entry for "devDependencies".
-   */
-  "import/no-extraneous-dependencies": [
-    "error",
-    {
-      devDependencies: [
-        "test/**", // tape, common npm pattern
-        "tests/**", // also common npm pattern
-        "spec/**", // mocha, rspec-like pattern
-        "**/__tests__/**", // jest pattern
-        "**/__mocks__/**", // jest pattern
-        "test.{js,jsx}", // repos with a single test file
-        "test-*.{js,jsx}", // repos with multiple top-level test files
-        "**/*{.,_}{test,spec}.{js,jsx}", // tests where the extension or filename suffix denotes that it is a test
-        "**/jest.config.js", // jest config
-        "**/jest.setup.js", // jest setup
-        "**/vue.config.js", // vue-cli config
-        "**/webpack.config.js", // webpack config
-        "**/webpack.config.*.js", // webpack config
-        "**/rollup.config.js", // rollup config
-        "**/rollup.config.*.js", // rollup config
-        "**/gulpfile.js", // gulp config
-        "**/gulpfile.*.js", // gulp config
-        "**/Gruntfile{,.js}", // grunt config
-        "**/protractor.conf.js", // protractor config
-        "**/protractor.conf.*.js", // protractor config
-        "**/karma.conf.js", // karma config
-        "**/.eslintrc.js", // eslint config
-
-        "**/scripts/*.{js,cjs,mjs,ts,cts,mts}", // Files inside of a "scripts" directory.
-      ],
-      optionalDependencies: false,
-    },
-  ],
-
-  "import/no-mutable-exports": "error",
-  "import/no-named-as-default": "error",
-
-  /**
-   * Disabled because this is [already handled by the TypeScript
-   * compiler](https://typescript-eslint.io/linting/troubleshooting/performance-troubleshooting/#eslint-plugin-import).
-   */
-  "import/no-named-as-default-member": "off",
-
-  /**
-   * Disabled since this check is better performed by the [`knip`](https://github.com/webpro/knip)
-   * tool.
-   */
-  "import/no-unused-modules": "off",
-};
-
-/** @type {import("eslint").Linter.RulesRecord} */
-const MODULE_SYSTEMS = {
-  "import/no-amd": "error",
-  "import/no-commonjs": "error",
-  "import/no-import-module-exports": "error",
-
-  /** Disabled because it is only used in specific environments (like the browser). */
-  "import/no-nodejs-modules": "off",
-
-  /** Disabled because this is already handled by the TypeScript compiler. */
-  "import/unambiguous": "off",
-};
-
-/** @type {import("eslint").Linter.RulesRecord} */
-const STATIC_ANALYSIS = {
-  /**
-   * Disabled because this is [already handled by the TypeScript
-   * compiler](https://typescript-eslint.io/linting/troubleshooting/performance-troubleshooting/#eslint-plugin-import).
-   */
-  "import/default": "off",
-
-  /**
-   * Disabled because this is [already handled by the TypeScript
-   * compiler](https://typescript-eslint.io/linting/troubleshooting/performance-troubleshooting/#eslint-plugin-import).
-   */
-  "import/named": "off",
-
-  /**
-   * Disabled because this is [already handled by the TypeScript
-   * compiler](https://typescript-eslint.io/linting/troubleshooting/performance-troubleshooting/#eslint-plugin-import).
-   */
-  "import/namespace": "off",
-
-  "import/no-absolute-path": "error",
-  "import/no-cycle": "error",
-  "import/no-dynamic-require": "error",
-
-  /** Disabled since a prescribed import pattern is not generalizable enough across projects. */
-  "import/no-internal-modules": "off",
-
-  "import/no-relative-packages": "error",
-
-  /**
-   * Disabled since a forward import direction pattern is not generalizable enough across projects.
-   */
-  "import/no-relative-parent-imports": "off",
-
-  /** Disabled since this rule should only contain a project-specific path restriction. */
-  "import/no-restricted-paths": "off",
-
-  "import/no-self-import": "error",
-
-  /**
-   * Disabled because this is [already handled by the TypeScript
-   * compiler](https://github.com/iamturns/eslint-config-airbnb-typescript/blob/master/lib/shared.js).
-   */
-  "import/no-unresolved": "off",
-
-  "import/no-useless-path-segments": "error",
-  "import/no-webpack-loader-syntax": "error",
-};
-
-/** @type {import("eslint").Linter.RulesRecord} */
-const STYLE_GUIDE = {
-  "import/consistent-type-specifier-style": "error",
-
-  /** Disabled because it is only useful in environments that use webpack. */
-  "import/dynamic-import-chunkname": "off",
-
-  /** Disabled because this style is not generally used. */
-  "import/exports-last": "off",
-
-  /** Disabled because this is already handled by the TypeScript compiler. */
-  "import/extensions": "off",
-
-  "import/first": "error",
-
-  /** Disabled because this style is not generally used. */
-  "import/group-exports": "off",
-
-  /** Disabled because this rule is deprecated. */
-  "import/imports-first": "off",
-
-  /** Disabled since it will trigger false positives in codebases that prefer smaller files. */
-  "import/max-dependencies": "off",
-
-  "import/newline-after-import": "error",
-
-  /**
-   * Disabled since we disallow default exports elsewhere in this config (in favor of named
-   * exports).
-   */
-  "import/no-anonymous-default-export": "off",
-
-  /**
-   * The case against default exports is [layed out by Basarat Ali
-   * Syed](https://basarat.gitbook.io/typescript/main-1/defaultisbad).
-   */
-  "import/no-default-export": "error",
-
-  "import/no-duplicates": "error",
-  "import/no-named-default": "error",
-
-  /**
-   * Disabled since we disallow default exports elsewhere in this config (in favor of named
-   * exports).
-   */
-  "import/no-named-export": "off",
-
-  /**
-   * Disabled since it is too prescriptive for a general audience. (Using `import * as` is common.)
-   */
-  "import/no-namespace": "off",
-
-  "import/no-unassigned-import": "error",
-
-  /** Disabled because this is automatically handled by `prettier-plugin-organize-imports`. */
-  "import/order": "off",
-
-  /**
-   * Disabled because we disallow default exports elsewhere in this config (in favor of named
-   * exports).
-   */
-  "import/prefer-default-export": "off",
-};
-
-/*
- * @type {import("eslint").Linter.Config}
- */
-const config = {
-  // Beyond just specifying the plugin, additional configuration is necessary to make the plugin
-  // work properly with TypeScript. We extend the upstream TypeScript config to accomplish this:
-  // https://github.com/import-js/eslint-plugin-import/blob/main/config/typescript.js
-  // (The necessity of this extra configuration was tested with the `import/no-cycle` rule.)
-  extends: ["plugin:import/typescript"],
-
-  plugins: ["import"],
-
-  rules: {
-    ...HELPFUL_WARNINGS,
-    ...MODULE_SYSTEMS,
-    ...STATIC_ANALYSIS,
-    ...STYLE_GUIDE,
-  },
-
-  overrides: [
-    // Disable some TypeScript-specific rules in JavaScript files.
-    {
-      files: ["*.js", "*.cjs", "*.mjs", "*.jsx"],
-      rules: {
-        "import/no-commonjs": "off",
-      },
-    },
-
-    // Disable some specific rules in config files.
-    {
-      files: [
-        ".remarkrc.mjs",
-        ".remarkrc.js",
-        "prettier.config.mjs",
-        "prettier.config.js",
-        "typedoc.config.mjs",
-        "typedoc.config.js",
-        "vite.config.js",
-        "vite.config.mjs",
-      ],
-      rules: {
-        "import/no-default-export": "off",
-      },
-    },
-  ],
-};
-
-module.exports = config;

package/configs/base-jsdoc.js

@@ -1,253 +0,0 @@
-/**
- * This ESLint config only contains rules from `eslint-plugin-jsdoc`:
- * https://github.com/gajus/eslint-plugin-jsdoc
- *
- * @type {import("eslint").Linter.Config}
- */
-const config = {
-  plugins: ["jsdoc"],
-
-  rules: {
-    /** Disabled because it is not needed in TypeScript. */
-    "jsdoc/check-access": "off",
-
-    /** Superseded by the `isaacscript/limit-jsdoc-comments` rule. */
-    "jsdoc/check-alignment": "off",
-
-    /**
-     * Disabled since it [does not work with ESLint
-     * 8](https://github.com/eslint/eslint/issues/14745).
-     */
-    "jsdoc/check-examples": "off",
-
-    /** Superseded by the `isaacscript/limit-jsdoc-comments` rule. */
-    "jsdoc/check-indentation": "off",
-
-    /**
-     * Disabled since this is not a common formatting scheme. It is also not recommended by the
-     * plugin authors.
-     */
-    "jsdoc/check-line-alignment": "off",
-
-    "jsdoc/check-param-names": "error",
-
-    /** Disabled because it is not needed in TypeScript. */
-    "jsdoc/check-property-names": "off",
-
-    /** Disabled because it is not needed in TypeScript. */
-    "jsdoc/check-syntax": "off",
-
-    "jsdoc/check-tag-names": [
-      "error",
-      {
-        definedTags: [
-          // Ignore tags used by the TypeScript compiler:
-          // https://www.typescriptlang.org/tsconfig#stripInternal
-          "internal", // Used by TypeScript
-
-          // Ignore tags used in TypeDoc:
-          // https://typedoc.org/guides/doccomments/
-          "category",
-          "hidden",
-          "notExported", // From: typedoc-plugin-not-exported
-          "rename", // From: typedoc-plugin-rename
-
-          // Ignore tags used in TypeScriptToLua:
-          // https://typescripttolua.github.io/docs/advanced/compiler-annotations
-          "noResolution",
-          "noSelf",
-          "noSelfInFile",
-
-          // Ignore tags used in `ts-json-schema-generator`:
-          // https://github.com/vega/ts-json-schema-generator
-          "minimum",
-          "maximum",
-
-          // Ignore tags used in `eslint-plugin-isaacscript`:
-          // https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-plugin-isaacscript/docs/rules/require-variadic-function-argument.md
-          "allowEmptyVariadic",
-        ],
-      },
-    ],
-
-    /** Disabled because it is not needed in TypeScript. */
-    "jsdoc/check-types": "off",
-
-    "jsdoc/check-values": "error",
-    "jsdoc/empty-tags": "error",
-    "jsdoc/implements-on-classes": "error",
-
-    /** Disabled since you cannot configure it with a path to the correct "package.json" file. */
-    "jsdoc/imports-as-dependencies": "off",
-
-    "jsdoc/informative-docs": "error",
-
-    /** Superseded by the `isaacscript/jsdoc-full-sentences` rule. */
-    "jsdoc/match-description": "off",
-
-    /** Disabled because it is only needed for projects with specific JSDoc requirements. */
-    "jsdoc/match-name": "off",
-
-    /** Superseded by the `isaacscript/limit-jsdoc-comments` rule. */
-    "jsdoc/multiline-blocks": "off",
-
-    /** Superseded by the `isaacscript/limit-jsdoc-comments` rule. */
-    "jsdoc/newline-after-description": "off",
-
-    /**
-     * Disabled because it provides little value; it only detects JSDoc comments with tags in them.
-     */
-    "jsdoc/no-bad-blocks": "off",
-
-    /** Superseded by the `isaacscript/format-jsdoc-comments` rule. */
-    "jsdoc/no-blank-block-descriptions": "off",
-
-    /** Superseded by the `isaacscript/no-empty-jsdoc` rule. */
-    "jsdoc/no-blank-blocks": "off",
-
-    /** Disabled because it provides little value; the `@default` tag is rare. */
-    "jsdoc/no-defaults": "off",
-
-    /** Disabled because it is too project-specific. */
-    "jsdoc/no-missing-syntax": "off",
-
-    /** Superseded by the `isaacscript/limit-jsdoc-comments` rule. */
-    "jsdoc/no-multi-asterisks": "off",
-
-    /** Disabled because it is intended for disabling of specific language features per-project. */
-    "jsdoc/no-restricted-syntax": "off",
-
-    /** The `contexts` option is set to `any` to make the rule stricter. */
-    "jsdoc/no-types": [
-      "error",
-      {
-        contexts: ["any"],
-      },
-    ],
-
-    /** Disabled because it is not needed in TypeScript. */
-    "jsdoc/no-undefined-types": "off",
-
-    "jsdoc/require-asterisk-prefix": "error",
-
-    /** Superseded by the `isaacscript/jsdoc-complete-sentences` rule. */
-    "jsdoc/require-description-complete-sentence": "off",
-
-    /** Disabled because it is overboard for every function to have a description. */
-    "jsdoc/require-description": "off",
-
-    /** Disabled because it is overboard for every function to require an example. */
-    "jsdoc/require-example": "off",
-
-    /** Disabled because it is overboard for every file to require an overview. */
-    "jsdoc/require-file-overview": "off",
-
-    /**
-     * The `never` option is provided to make the rule match the format of the official TypeScript
-     * codebase.
-     */
-    "jsdoc/require-hyphen-before-param-description": ["error", "never"],
-
-    /** Disabled since it is overboard for every function to have a JSDoc comment. */
-    "jsdoc/require-jsdoc": "off",
-
-    /** The `contexts` option is set to `any` to make the rule stricter. */
-    "jsdoc/require-param-description": [
-      "error",
-      {
-        contexts: ["any"],
-      },
-    ],
-
-    /** The `contexts` option is set to `any` to make the rule stricter. */
-    "jsdoc/require-param-name": [
-      "error",
-      {
-        contexts: ["any"],
-      },
-    ],
-
-    /** Disabled because it is not needed in TypeScript. */
-    "jsdoc/require-param-type": "off",
-
-    /** Configured to only apply when there are one or more parameters. */
-    "jsdoc/require-param": [
-      "error",
-      {
-        contexts: [
-          {
-            context: "FunctionDeclaration",
-            comment: 'JsdocBlock:has(JsdocTag[tag="param"])',
-          },
-        ],
-      },
-    ],
-
-    /** Disabled because it is not needed in TypeScript. */
-    "jsdoc/require-property": "off",
-
-    "jsdoc/require-property-description": "error",
-    "jsdoc/require-property-name": "error",
-
-    /** Disabled because it is not needed in TypeScript. */
-    "jsdoc/require-property-type": "off",
-
-    /** Disabled because it is overboard for every function to document every return value. */
-    "jsdoc/require-returns-check": "off",
-
-    /** The `contexts` option is set to `any` to make the rule stricter. */
-    "jsdoc/require-returns-description": [
-      "error",
-      {
-        contexts: ["any"],
-      },
-    ],
-
-    /** Disabled because it is not needed in TypeScript. */
-    "jsdoc/require-returns-type": "off",
-
-    /** Disabled because it is overboard for every function to document every return value. */
-    "jsdoc/require-returns": "off",
-
-    /** Disabled because it is overboard to document every throw statement. */
-    "jsdoc/require-throws": "off",
-
-    /** Disabled because it is overboard to document every yield. */
-    "jsdoc/require-yields": "off",
-
-    /** Disabled because it is overboard to document every yield. */
-    "jsdoc/require-yields-check": "off",
-
-    /**
-     * Disabled because it is not very useful. In most cases, a function will only have `@param` and
-     * `@return` tags, making sorting unnecessary.
-     */
-    "jsdoc/sort-tags": "off",
-
-    /** Superseded by the `isaacscript/format-jsdoc-comments` rule. */
-    "jsdoc/tag-lines": "off",
-
-    /**
-     * Disabled since it is only useful in certain environments (e.g. when your project converts
-     * JSDoc comments to Markdown).
-     */
-    "jsdoc/text-escaping": "off",
-
-    /** Disabled because it is not needed in TypeScript. */
-    "jsdoc/valid-types": "off",
-  },
-
-  overrides: [
-    // Disable some TypeScript-specific rules in JavaScript files.
-    {
-      files: ["*.js", "*.cjs", "*.mjs", "*.jsx"],
-      rules: {
-        "jsdoc/no-types": "off",
-        "jsdoc/require-param-description": "off",
-        "jsdoc/require-returns-description": "off",
-      },
-    },
-  ],
-};
-
-module.exports = config;

package/configs/base-n.js

@@ -1,158 +0,0 @@
-// This ESLint config only contains rules from `eslint-plugin-n`:
-// https://github.com/eslint-community/eslint-plugin-n
-// (This is a forked version of `eslint-plugin-node`.)
-
-// Rules are separated into categories:
-// 1) Best Practices
-// 2) Possible Errors
-// 3) Stylistic Issues
-
-/** @type {import("eslint").Linter.RulesRecord} */
-const BEST_PRACTICES = {
-  "n/no-deprecated-api": "error",
-};
-
-/** @type {import("eslint").Linter.RulesRecord} */
-const POSSIBLE_ERRORS = {
-  "n/handle-callback-err": "error",
-  "n/no-callback-literal": "error",
-  "n/no-exports-assign": "error",
-
-  /** Disabled since it is handled by the TypeScript compiler. */
-  "n/no-extraneous-import": "off",
-
-  /** Disabled since require statements are not used in TypeScript code. */
-  "n/no-extraneous-require": "off",
-
-  /** Disabled because this rule is deprecated. */
-  "n/no-hide-core-modules": "off",
-
-  /** Disabled since it is handled by the TypeScript compiler. */
-  "n/no-missing-import": "off",
-
-  "n/no-missing-require": "error",
-  "n/no-new-require": "error",
-  "n/no-path-concat": "error",
-
-  /**
-   * Disabled because using `process.exit` is common to exit command-line applications without
-   * verbose output.
-   */
-  "n/no-process-exit": "off",
-
-  "n/no-unpublished-bin": "error",
-
-  /**
-   * An exception is made for files in a "scripts" directory, since those should be allowed to
-   * import from "devDependencies".
-   */
-  "n/no-unpublished-import": "error",
-
-  "n/no-unpublished-require": "error",
-
-  /** Disabled because this rule is deprecated. */
-  "n/no-unsupported-features": "off",
-
-  /** Disabled because it is assumed that we are running on modern versions of Node.js. */
-  "n/no-unsupported-features/es-builtins": "off",
-
-  /**
-   * Disabled because it is assumed that our transpiler or runtime has support for the latest
-   * version of ESM.
-   */
-  "n/no-unsupported-features/es-syntax": "off",
-
-  /** Disabled since it is handled by the TypeScript compiler. */
-  "n/no-unsupported-features/node-builtins": "off",
-
-  "n/process-exit-as-throw": "error",
-
-  /**
-   * Disabled since it does not work very well with TypeScript. (It needs project-specific
-   * configuration depending on where the output directory is located.)
-   */
-  "n/shebang": "off",
-};
-
-/** @type {import("eslint").Linter.RulesRecord} */
-const STYLISTIC_ISSUES = {
-  /** Disabled since stylistic rules from this plugin are not used. */
-  "n/callback-return": "off",
-
-  /** Disabled since stylistic rules from this plugin are not used. */
-  "n/exports-style": "off",
-
-  /**
-   * This rule is helpful to automatically fix file extensions in import statements throughout an
-   * entire codebase.
-   */
-  "n/file-extension-in-import": ["error", "always"],
-
-  /** Disabled since stylistic rules from this plugin are not used. */
-  "n/global-require": "off",
-
-  /** Disabled since stylistic rules from this plugin are not used. */
-  "n/no-mixed-requires": "off",
-
-  /** Disabled since stylistic rules from this plugin are not used. */
-  "n/no-process-env": "off",
-
-  /** Disabled since stylistic rules from this plugin are not used. */
-  "n/no-restricted-import": "off",
-
-  /** Disabled since stylistic rules from this plugin are not used. */
-  "n/no-restricted-require": "off",
-
-  /** Disabled since stylistic rules from this plugin are not used. */
-  "n/no-sync": "off",
-
-  /** Disabled since stylistic rules from this plugin are not used. */
-  "n/prefer-global/buffer": "off",
-
-  /** Disabled since stylistic rules from this plugin are not used. */
-  "n/prefer-global/console": "off",
-
-  /** Disabled since stylistic rules from this plugin are not used. */
-  "n/prefer-global/process": "off",
-
-  /** Disabled since stylistic rules from this plugin are not used. */
-  "n/prefer-global/text-decoder": "off",
-
-  /** Disabled since stylistic rules from this plugin are not used. */
-  "n/prefer-global/text-encoder": "off",
-
-  /** Disabled since stylistic rules from this plugin are not used. */
-  "n/prefer-global/url": "off",
-
-  /** Disabled since stylistic rules from this plugin are not used. */
-  "n/prefer-global/url-search-params": "off",
-
-  /** Disabled since stylistic rules from this plugin are not used. */
-  "n/prefer-promises/dns": "off",
-
-  /** Disabled since stylistic rules from this plugin are not used. */
-  "n/prefer-promises/fs": "off",
-};
-
-/** @type {import("eslint").Linter.Config} */
-const config = {
-  extends: ["plugin:n/recommended"],
-
-  rules: {
-    ...BEST_PRACTICES,
-    ...POSSIBLE_ERRORS,
-    ...STYLISTIC_ISSUES,
-  },
-
-  overrides: [
-    // Imports in a "scripts" directory can use "devDependencies".
-    {
-      files: ["**/scripts/*.{js,cjs,mjs,ts,cts,mts}"],
-      rules: {
-        "n/no-unpublished-import": "off",
-      },
-    },
-  ],
-};
-
-module.exports = config;

package/configs/base-no-autofix.js

@@ -1,30 +0,0 @@
-/**
- * This ESLint config only contains rules from `eslint-plugin-no-autofix`:
- * https://github.com/aladdin-add/eslint-plugin/tree/master/packages/no-autofix
- *
- * This allows the fixer for specific core ESLint rules to be turned off.
- *
- * @type {import("eslint").Linter.Config}
- */
-const config = {
-  plugins: ["no-autofix"],
-
-  rules: {
-    /**
-     * It is common during development to comment out code after an [early
-     * return](https://medium.com/swlh/return-early-pattern-3d18a41bba8). In these cases, the
-     * auto-fixer is harmful, since it would require us to manually go put the return statement back
-     * after uncommenting the code.
-     */
-    "no-autofix/no-useless-return": "error",
-
-    /**
-     * It is common during development to comment out code that modifies a `let` variable. In these
-     * cases, the auto-fixer is harmful, since it would require us to manually go change the `const`
-     * back to a `let` after uncommenting the code.
-     */
-    "no-autofix/prefer-const": "error",
-  },
-};
-
-module.exports = config;