eslint-config-isaacscript 4.20.0 → 5.0.1

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 IsaacScript
+Copyright (c) 2022 The IsaacScript Contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/README.md

@@ -1,7 +1,5 @@
-# eslint-config-isaacscript
+# `eslint-config-isaacscript`
 
 [![npm version](https://img.shields.io/npm/v/eslint-config-isaacscript.svg)](https://www.npmjs.com/package/eslint-config-isaacscript)
 
-This is a sharable configuration for [ESLint](https://eslint.org/) that is intended to be used in TypeScript projects.
-
-Please see the [docs](https://isaacscript.github.io/eslint-config-isaacscript) for more information.
+This is a shared configuration for [ESLint](https://eslint.org/) that is intended to be used in [IsaacScript](https://isaacscript.github.io/) mods. (By default, IsaacScript mods are automatically configured to use this config.)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-isaacscript",
-  "version": "4.20.0",
+  "version": "5.0.1",
   "description": "A sharable ESLint config for TypeScript and IsaacScript projects.",
   "keywords": [
     "eslint",
@@ -21,20 +21,21 @@
   },
   "license": "MIT",
   "author": "Zamiell",
-  "type": "commonjs",
+  "type": "module",
   "files": [
-    "configs",
-    "base.js",
     "LICENSE",
-    "mod.js",
     "package.json",
-    "README.md"
+    "README.md",
+    "src"
   ],
   "scripts": {
-    "lint": "tsx ./scripts/lint.mts",
-    "query-rule": "tsx ./scripts/queryRule.mts"
+    "lint": "tsx ./scripts/lint.ts"
   },
   "dependencies": {
-    "confusing-browser-globals": "^1.0.11"
+    "eslint-plugin-isaacscript": "^4.0.0",
+    "typescript-eslint": "^8.5.0"
+  },
+  "devDependencies": {
+    "complete-node": "^1.3.0"
   }
 }

package/src/mod.js

@@ -0,0 +1,203 @@
+import ESLintPluginIsaacScript from "eslint-plugin-isaacscript";
+import tseslint from "typescript-eslint";
+
+// Hot-patch "eslint-plugin-isaacscript" to convert errors to warnings.
+for (const config of ESLintPluginIsaacScript.configs.recommended) {
+  if (config.rules !== undefined) {
+    for (const [key, value] of Object.entries(config.rules)) {
+      if (value === "error") {
+        config.rules[key] = "warn";
+      }
+    }
+  }
+}
+
+/**
+ * This ESLint config is meant to be used as a base for IsaacScript mods (or TypeScriptToLua
+ * projects).
+ */
+export const isaacScriptModConfigBase = tseslint.config(
+  // `eslint-plugin-isaacscript` provides rules specifically for IsaacScript mods.
+  ...ESLintPluginIsaacScript.configs.recommended,
+
+  {
+    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": [
+        "warn",
+        // Allow camelCase variables (23.2), PascalCase variables (23.8), and UPPER_CASE variables
+        // (23.10).
+        {
+          selector: "variable",
+          format: ["camelCase", "PascalCase", "UPPER_CASE"],
+          leadingUnderscore: "allow",
+        },
+        // 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": [
+        "warn",
+        {
+          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": [
+        "warn",
+        {
+          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 "complete/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.
+       */
+      "complete/consistent-enum-values": "off",
+
+      /**
+       * Defined in "complete/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.
+       */
+      "complete/no-number-enums": "off",
+
+      /**
+       * 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": [
+        "warn",
+        {
+          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",
+    },
+  },
+);

package/base.js

@@ -1,68 +0,0 @@
-/**
- * This ESLint config is meant to be used as a base for all TypeScript projects.
- *
- *  @type {import("eslint").Linter.Config}
- */
-const config = {
-  extends: [
-    /**
-     * Find deprecated code:
-     * https://github.com/gund/eslint-plugin-deprecation
-     */
-    "plugin:deprecation/recommended",
-
-    /**
-     * This provides extra miscellaneous rules to keep code safe:
-     * https://github.com/IsaacScript/isaacscript/tree/main/packages/eslint-plugin-isaacscript
-     */
-    "plugin:isaacscript/recommended",
-
-    /**
-     * Disable any ESLint rules that conflict with Prettier:
-     * https://github.com/prettier/eslint-config-prettier
-     * 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 (based on the
-     * originating plugin) .
-     */
-    "./configs/base-eslint",
-    "./configs/base-no-autofix",
-    "./configs/base-typescript-eslint",
-    "./configs/base-eslint-comments",
-    "./configs/base-import",
-    "./configs/base-jsdoc",
-    "./configs/base-n", // "n" stands for Node.
-    "./configs/base-unicorn",
-  ],
-
-  plugins: [
-    /**
-     * Activate the "eslint-plugin-only-warn" plugin to change all errors to warnings:
-     * https://github.com/bfanger/eslint-plugin-only-warn
-     *
-     * This allows the end-user to more easily distinguish between errors from the TypeScript
-     * compiler (which show up in red) and ESLint rule violations (which show up in yellow).
-     */
-    "only-warn",
-  ],
-
-  overrides: [
-    // Disable some TypeScript-specific rules in JavaScript files.
-    {
-      files: ["*.js", "*.cjs", "*.mjs", "*.jsx"],
-      rules: {
-        "isaacscript/no-let-any": "off",
-        "isaacscript/no-object-any": "off",
-        "isaacscript/require-capital-const-assertions": "off",
-        "isaacscript/require-capital-read-only": "off",
-      },
-    },
-  ],
-};
-
-module.exports = config;

package/configs/base-eslint-comments.js

@@ -1,59 +0,0 @@
-// This ESLint config only contains rules from `eslint-plugin-eslint-comments`:
-// https://github.com/mysticatea/eslint-plugin-eslint-comments
-
-// Rules are separated into categories:
-// 1) Best Practices
-// 2) Stylistic Issues
-
-/** @type {import("eslint").Linter.RulesRecord} */
-const BEST_PRACTICES = {
-  /**
-   * The `allowWholeFile` option is enabled because it is common practice to use "eslint-disable"
-   * comments for a whole file.
-   */
-  "eslint-comments/disable-enable-pair": [
-    "error",
-    {
-      allowWholeFile: true,
-    },
-  ],
-
-  "eslint-comments/no-aggregating-enable": "error",
-  "eslint-comments/no-duplicate-disable": "error",
-
-  /**
-   * Disabled because if a line breaks three or more ESLint rules, then it is useful to use a single
-   * "eslint-disable" comment to make things more concise.
-   */
-  "eslint-comments/no-unlimited-disable": "off",
-
-  "eslint-comments/no-unused-disable": "error",
-  "eslint-comments/no-unused-enable": "error",
-};
-
-/** @type {import("eslint").Linter.RulesRecord} */
-const STYLISTIC_ISSUES = {
-  /**
-   * Disabled because it is only useful in projects that want to prevent disabling specific ESLint
-   * rules.
-   */
-  "eslint-comments/no-restricted-disable": "off",
-
-  /** Disabled because we want to allow disabling ESLint rules where appropriate. */
-  "eslint-comments/no-use": "off",
-
-  /** Disabled because requiring descriptions for every ESLint disable would be too cumbersome. */
-  "eslint-comments/require-description": "off",
-};
-
-/** @type {import("eslint").Linter.Config} */
-const config = {
-  plugins: ["eslint-comments"],
-
-  rules: {
-    ...BEST_PRACTICES,
-    ...STYLISTIC_ISSUES,
-  },
-};
-
-module.exports = config;