eslint-config-isaacscript 1.1.0 → 1.3.2

package/README.md

@@ -4,6 +4,6 @@
 
 This is a sharable configuration for ESLint that is intended to be used in TypeScript and IsaacScript projects.
 
-This package is consumed by the [`isaacscript-lint`](https://github.com/IsaacScript/isaacscript-lint) meta-linting package.
+This package is consumed by the [`isaacscript-lint`](https://github.com/IsaacScript/isaacscript/tree/main/packages/isaacscript-lint) meta-linting package.
 
 Please see the [IsaacScript webpage](https://isaacscript.github.io/) for more information.

package/base.js

@@ -32,7 +32,7 @@ module.exports = {
 
     /**
      * This provides extra miscellaneous rules to keep code safe:
-     * https://github.com/IsaacScript/eslint-plugin-isaacscript
+     * https://github.com/IsaacScript/isaacscript/tree/main/packages/eslint-plugin-isaacscript
      */
     "plugin:isaacscript/recommended",
 

package/jsdoc.js

@@ -18,7 +18,10 @@ module.exports = {
   rules: {
     // - jsdoc/check-access - Not needed in TypeScript.
     // - jsdoc/check-alignment - Overlaps with `isaacscript/limit-jsdoc-comments`.
-    // - jsdoc/check-examples - Not worth it since some ESLint rules may not apply to examples.
+
+    // - jsdoc/check-examples - Does not work with ESLint 8; see:
+    // https://github.com/eslint/eslint/issues/14745
+
     // - jsdoc/check-indentation - Overlaps with `isaacscript/limit-jsdoc-comments`.
     // - jsdoc/check-line-alignment - This is not a common formatting scheme in the wild. It's also
     //   not recommended by the plugin.
@@ -44,16 +47,17 @@ module.exports = {
       "warn",
       {
         definedTags: [
-          // Used by the TypeScript compiler:
+          // Ignore tags used by the TypeScript compiler:
           // https://www.typescriptlang.org/tsconfig#stripInternal
           "internal", // Used by TypeScript
 
-          // Add tags used in TypeDoc:
+          // Ignore tags used in TypeDoc:
           // https://typedoc.org/guides/doccomments/
           "category",
           "hidden",
+          "notExported",
 
-          // Add tags used in TypeScriptToLua:
+          // Ignore tags used in TypeScriptToLua:
           // https://typescripttolua.github.io/docs/advanced/compiler-annotations
           "noResolution",
           "noSelf",

package/mod.js

@@ -4,7 +4,7 @@ module.exports = {
   extends: [
     /**
      * The mod config extends the base configuration:
-     * https://github.com/IsaacScript/eslint-config-isaacscript/blob/main/base.js
+     * https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-config-isaacscript/base.js
      */
     "./base",
   ],
@@ -67,7 +67,7 @@ module.exports = {
 
     /**
      * Documentation:
-     * https://github.com/IsaacScript/eslint-plugin-isaacscript/blob/main/docs/rules/enum-member-number-separation.md
+     * https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-plugin-isaacscript/main/docs/rules/enum-member-number-separation.md
      *
      * Not defined in the parent configs.
      *
@@ -75,6 +75,16 @@ module.exports = {
      */
     "isaacscript/enum-member-number-separation": "warn",
 
+    /**
+     * Documentation:
+     * https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-plugin-isaacscript/main/docs/rules/no-invalid-default-map.md
+     *
+     * Not defined in the parent configs.
+     *
+     * Prevents misuse of the custom `DefaultMap` class in the standard library.
+     */
+    "isaacscript/no-invalid-default-map": "warn",
+
     /**
      * Documentation:
      * https://github.com/eslint/eslint/blob/master/docs/rules/no-bitwise.md

package/monorepo.js

@@ -0,0 +1,43 @@
+const path = require("path"); // eslint-disable-line @typescript-eslint/no-var-requires
+
+const REPO_ROOT = path.join(__dirname, "..", "..");
+
+// This is a shared configuration file for ESLint:
+// https://eslint.org/docs/user-guide/configuring
+module.exports = {
+  plugins: ["@nrwl/nx"],
+
+  // From:
+  // https://github.com/nrwl/nx/blob/master/packages/eslint-plugin-nx/src/configs/typescript.ts
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: "module",
+    /* eslint-disable-next-line isaacscript/complete-sentences-line-comments */
+    // This cannot be simplified to "./../.." because of relative path shenanigans.
+    tsconfigRootDir: REPO_ROOT,
+  },
+
+  rules: {
+    "@nrwl/nx/enforce-module-boundaries": [
+      "warn",
+      {
+        enforceBuildableLibDependency: true,
+        allow: [],
+        depConstraints: [
+          {
+            sourceTag: "*",
+            onlyDependOnLibsWithTags: ["*"],
+          },
+        ],
+      },
+    ],
+
+    // This rule has to be told which "package.json" file that the dependencies are located in.
+    "import/no-extraneous-dependencies": [
+      "warn",
+      {
+        packageDir: REPO_ROOT,
+      },
+    ],
+  },
+};

package/package.json

@@ -1,21 +1,25 @@
 {
   "name": "eslint-config-isaacscript",
-  "version": "1.1.0",
+  "version": "1.3.2",
   "description": "A sharable ESLint config for TypeScript and IsaacScript projects.",
+  "keywords": [
+    "eslint",
+    "config",
+    "configs",
+    "isaacscript",
+    "lint",
+    "linting",
+    "prettier"
+  ],
+  "homepage": "https://isaacscript.github.io/",
+  "bugs": {
+    "url": "https://github.com/IsaacScript/isaacscript/issues"
+  },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/IsaacScript/eslint-config-isaacscript.git"
+    "url": "git+https://github.com/IsaacScript/isaacscript.git"
   },
   "license": "MIT",
   "author": "Zamiell",
-  "files": [
-    "base.js",
-    "mod.js",
-    "jsdoc.js"
-  ],
-  "devDependencies": {
-    "cspell": "^5.21.0",
-    "isaacscript-spell": "^1.0.3",
-    "prettier": "^2.6.2"
-  }
+  "type": "commonjs"
 }

package/CHANGELOG.md

@@ -1,5 +0,0 @@
-# Changelog
-
-This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
-
-### [1.0.80](https://github.com/IsaacScript/isaacscript/compare/eslint-config-isaacscript-1.0.80-dev.0...eslint-config-isaacscript-1.0.80) (2022-05-24)