eslint-config-isaacscript 1.2.2 → 2.0.0

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",
 
@@ -243,6 +243,18 @@ module.exports = {
       },
     ],
 
+    /**
+     * Documentation:
+     * https://eslint.org/docs/latest/rules/curly
+     *
+     * Defined at: ?
+     *
+     * Always requiring curly braces can partially ward against Apple-style if statement bugs:
+     * https://www.imperialviolet.org/2014/02/22/applebug.html
+     * ?
+     */
+    curly: ["warn", "all"],
+
     /**
      * Documentation:
      * https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/master/docs/rules/disable-enable-pair.md
@@ -305,6 +317,17 @@ module.exports = {
      */
     "no-console": "off",
 
+    /**
+     * Documentation:
+     * https://eslint.org/docs/latest/rules/no-constant-binary-expression
+     *
+     * Not defined in parent configs.
+     *
+     * This rule was released in 2022 and is known to catch many subtle bugs:
+     * https://github.com/eslint/eslint.org/pull/240/files
+     */
+    "no-constant-binary-expression": "warn",
+
     /**
      * Documentation:
      * https://eslint.org/docs/rules/no-continue

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/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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-isaacscript",
-  "version": "1.2.2",
+  "version": "2.0.0",
   "description": "A sharable ESLint config for TypeScript and IsaacScript projects.",
   "keywords": [
     "eslint",
@@ -22,4 +22,4 @@
   "license": "MIT",
   "author": "Zamiell",
   "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)