eslint-config-isaacscript 4.20.0 → 5.0.0

package/configs/base-unicorn.js

@@ -1,233 +0,0 @@
-// 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",
-
-  /** Disabled since it is not helpful when using TypeScript. */
-  "unicorn/no-array-callback-reference": "off",
-
-  "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",
-
-  /** Superseded by the `@typescript-eslint/no-this-alias` rule. */
-  "unicorn/no-this-assignment": "off",
-
-  "unicorn/no-typeof-undefined": "error",
-  "unicorn/no-unnecessary-await": "error",
-  "unicorn/no-unnecessary-polyfills": "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/mod.js

@@ -1,229 +0,0 @@
-/**
- * This config is meant to be used as a base for IsaacScript mods (or TypeScriptToLua projects).
- *
- * @type {import("eslint").Linter.Config}
- */
-const config = {
-  extends: [
-    /**
-     * The IsaacScript mod config extends the base configuration:
-     * https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-config-isaacscript/base.js
-     * (Normal TypeScript projects would just use the base configuration directly.)
-     */
-    "./base",
-  ],
-
-  rules: {
-    /**
-     * Defined at: base-typescript-eslint.js
-     *
-     * It is conventional in IsaacScript mods to put the "v" object outside of the class, which
-     * makes it likely that some methods will not use any internal class variables.
-     */
-    "@typescript-eslint/class-methods-use-this": "off",
-
-    /**
-     * Defined at: base-typescript-eslint.js
-     *
-     * We expand the original definition to ensure that all enums match the Isaac convention of
-     * using UPPER_CASE.
-     */
-    "@typescript-eslint/naming-convention": [
-      "error",
-      // Allow camelCase variables (23.2), PascalCase variables (23.8), and UPPER_CASE variables
-      // (23.10).
-      {
-        selector: "variable",
-        format: ["camelCase", "PascalCase", "UPPER_CASE"],
-        leadingUnderscore: "allow",
-
-        // Polyfilling "__dirname" in ESM files is a common pattern.
-        filter: {
-          regex: "^__dirname$",
-          match: false,
-        },
-      },
-      // Allow camelCase functions (23.2), and PascalCase functions (23.8).
-      {
-        selector: "function",
-        format: ["camelCase", "PascalCase"],
-        leadingUnderscore: "allow",
-      },
-      // Airbnb recommends PascalCase for classes (23.3), and although Airbnb does not make
-      // TypeScript recommendations, we are assuming this rule would similarly apply to anything
-      // "type like", including interfaces, type aliases, and enums.
-      {
-        selector: "typeLike",
-        format: ["PascalCase"],
-        leadingUnderscore: "allow",
-      },
-      // The vanilla Isaac enums all use UPPER_CASE:
-      // https://wofsauge.github.io/IsaacDocs/rep/enums/CollectibleType.html
-      {
-        selector: "enumMember",
-        format: ["UPPER_CASE"],
-      },
-    ],
-
-    /**
-     * Defined at: base-typescript-eslint.js
-     *
-     * The `Vector` object has a `tostring` meta-method, so it can be properly printed without
-     * explicitly specifying the X and Y values.
-     */
-    "@typescript-eslint/no-base-to-string": [
-      "error",
-      {
-        ignoredTypeNames: ["Vector"],
-      },
-    ],
-
-    /**
-     * Defined at: base-typescript-eslint.js
-     *
-     * TSTL has special behavior with respect to `this: void`, so we need to configure this rule to
-     * allow the `this` parameter.
-     */
-    "@typescript-eslint/no-invalid-void-type": [
-      "error",
-      {
-        allowAsThisParameter: true,
-      },
-    ],
-
-    /**
-     * Defined at: base-typescript-eslint.js
-     *
-     * This rule throws false positives with Isaac API functions. It can be worked around by
-     * supplying lists of globals to ESLint, but this is ugly. See:
-     * https://github.com/typescript-eslint/typescript-eslint/issues/2780
-     */
-    "@typescript-eslint/no-loop-func": "off",
-
-    /**
-     * Defined at: base-typescript-eslint.js
-     *
-     * Enums that are used with the API must be numbers since that is what the API expects. We also
-     * prefer that unofficial enums are also number enums for consistency.
-     */
-    "@typescript-eslint/prefer-enum-initializers": "off",
-
-    /**
-     * Defined at: base-typescript-eslint.js
-     *
-     * It is common to initialize enums with the `Isaac.GetEntityVariantByName` method.
-     */
-    "@typescript-eslint/prefer-literal-enum-member": "off",
-
-    /**
-     * Defined at: base-typescript-eslint.js
-     *
-     * The `Number.sort` method transpiles to use `table.sort`, which does not have the
-     * coercion-based bugs of the JavaScript implementation. Thus, this lint rule is unnecessary.
-     */
-    "@typescript-eslint/require-array-sort-compare": "off",
-
-    /**
-     * Defined in "isaacscript/recommended".
-     *
-     * Enums that are used with the API use upper case letters. We also prefer that unofficial enums
-     * are also use upper case letters for consistency.
-     */
-    "isaacscript/consistent-enum-values": "off",
-
-    /**
-     * Not defined in the parent configs.
-     *
-     * Since Isaac enums use the `SHOUTING_SNAKE_CASE` convention, this rule ensures correctness.
-     */
-    "isaacscript/enum-member-number-separation": "error",
-
-    /**
-     * Defined in "isaacscript/recommended".
-     *
-     * Enums that are used with the API must be numbers since that is what the API expects. We also
-     * prefer that unofficial enums are also number enums for consistency.
-     */
-    "isaacscript/no-number-enums": "off",
-
-    /**
-     * Not defined in the parent configs.
-     *
-     * Prevents misuse of the custom `DefaultMap` class in the standard library.
-     */
-    "isaacscript/no-invalid-default-map": "error",
-
-    /**
-     * Not defined in the parent configs.
-     *
-     * The `throw` keyword should never be used in Isaac mods.
-     */
-    "isaacscript/no-throw": "error",
-
-    /**
-     * Not defined in the parent configs.
-     *
-     * We must explicitly enable this rule, since it should only apply to IsaacScript mods.
-     */
-    "isaacscript/require-v-registration": "error",
-
-    /**
-     * Defined at: base-n.js
-     *
-     * IsaacScript mods to not use ESM, so we must turn this rule off.
-     */
-    "n/file-extension-in-import": "off",
-
-    /**
-     * Defined at: base-unicorn.js
-     *
-     * `null` values are conventionally used with the `isaacscript-common` save data manager (even
-     * though they are transpiled to `nil`).
-     */
-    "unicorn/no-null": "off",
-
-    /**
-     * Defined at: base-unicorn.js
-     *
-     * IsaacScript mods use Lua bitwise operators, which are safe.
-     */
-    "unicorn/prefer-math-trunc": "off",
-
-    /**
-     * Defined at: base-eslint.js
-     *
-     * Isaac API methods use capital letters, so we must make the options for the rule less strict.
-     */
-    "new-cap": [
-      "error",
-      {
-        newIsCap: true,
-        capIsNew: false,
-        properties: true,
-      },
-    ],
-
-    /**
-     * Defined at: base-eslint.js
-     *
-     * Isaac enums use bitwise operators (e.g. "EntityFlag").
-     */
-    "no-bitwise": "off",
-
-    /**
-     * Defined at: base-eslint.js
-     *
-     * The Isaac API callback functions expect you to modify the provided object.
-     */
-    "no-param-reassign": "off",
-
-    /**
-     * Defined at: base-eslint.js
-     *
-     * "print" is used with Lua mods.
-     */
-    "no-restricted-globals": "off",
-  },
-};
-
-module.exports = config;