eslint-config-isaacscript 1.0.74 → 1.0.77

package/README.md

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

package/base.js

@@ -4,7 +4,8 @@ module.exports = {
   extends: [
     /**
      * The linter base is the Airbnb style guide, which is the most popular JavaScript style guide
-     * in the world: https://github.com/airbnb/javascript
+     * in the world:
+     * https://github.com/airbnb/javascript
      *
      * The actual ESLint config is located here:
      * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules
@@ -294,7 +295,8 @@ module.exports = {
     "import/prefer-default-export": "off",
 
     /**
-     * Documentation: https://eslint.org/docs/rules/no-console
+     * Documentation:
+     * https://eslint.org/docs/rules/no-console
      *
      * Defined at:
      * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/errors.js
@@ -304,7 +306,8 @@ module.exports = {
     "no-console": "off",
 
     /**
-     * Documentation: https://eslint.org/docs/rules/no-continue
+     * Documentation:
+     * https://eslint.org/docs/rules/no-continue
      *
      * Defined at:
      * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/style.js
@@ -314,7 +317,8 @@ module.exports = {
     "no-continue": "off",
 
     /**
-     * Documentation: https://eslint.org/docs/rules/no-plusplus
+     * Documentation:
+     * https://eslint.org/docs/rules/no-plusplus
      *
      * Defined at:
      * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/style.js
@@ -330,7 +334,8 @@ module.exports = {
     ],
 
     /**
-     * Documentation: https://eslint.org/docs/rules/no-restricted-syntax
+     * Documentation:
+     * https://eslint.org/docs/rules/no-restricted-syntax
      *
      * Defined at:
      * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/style.js
@@ -363,7 +368,8 @@ module.exports = {
     ],
 
     /**
-     * Documentation: https://eslint.org/docs/rules/prefer-destructuring
+     * Documentation:
+     * https://eslint.org/docs/rules/prefer-destructuring
      *
      * Defined at:
      * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/es6.js

package/jsdoc.js

@@ -2,15 +2,18 @@
 // https://eslint.org/docs/user-guide/configuring
 module.exports = {
   plugins: [
-    /** Lint JSDoc style comments: https://github.com/gajus/eslint-plugin-jsdoc */
+    /**
+     * Lint JSDoc style comments:
+     * https://github.com/gajus/eslint-plugin-jsdoc
+     */
     "jsdoc",
   ],
 
   /**
    * Instead of using the recommended config, we specifically turn on every rule that is useful.
    *
-   * We must specify `contexts: ["any"]` for every rule because by default, the JSDoc rules will only
-   * affect a subset of AST node types.
+   * We must specify `contexts: ["any"]` for some rules because by default, only a subset of AST
+   * node types will be affected.
    */
   rules: {
     // - jsdoc/check-access - Not needed in TypeScript.
@@ -21,29 +24,25 @@ module.exports = {
     //   not recommended by the plugin.
 
     /**
-     * Documentation: https://github.com/gajus/eslint-plugin-jsdoc#check-param-names
+     * Documentation:
+     * https://github.com/gajus/eslint-plugin-jsdoc#check-param-names
      *
      * Ensures that parameter names in JSDoc match those in the function declaration.
      */
-    "jsdoc/check-param-names": [
-      "warn",
-      {
-        contexts: ["any"],
-      },
-    ],
+    "jsdoc/check-param-names": "warn",
 
     // - jsdoc/check-property-names - Not needed in TypeScript.
     // - jsdoc/check-syntax - Not needed in TypeScript.
 
     /**
-     * Documentation: https://github.com/gajus/eslint-plugin-jsdoc#check-tag-names
+     * Documentation:
+     * https://github.com/gajus/eslint-plugin-jsdoc#check-tag-names
      *
      * Reports invalid block tag names.
      */
     "jsdoc/check-tag-names": [
       "warn",
       {
-        contexts: ["any"],
         definedTags: [
           // Used by the TypeScript compiler:
           // https://www.typescriptlang.org/tsconfig#stripInternal
@@ -65,40 +64,28 @@ module.exports = {
     // - jsdoc/check-types - Not needed in TypeScript.
 
     /**
-     * Documentation: https://github.com/gajus/eslint-plugin-jsdoc#check-values
+     * Documentation:
+     * https://github.com/gajus/eslint-plugin-jsdoc#check-values
      *
      * Validates the content of some uncommon JSDoc tags.
      */
-    "jsdoc/check-values": [
-      "warn",
-      {
-        contexts: ["any"],
-      },
-    ],
+    "jsdoc/check-values": "warn",
 
     /**
-     * Documentation: https://github.com/gajus/eslint-plugin-jsdoc#check-values
+     * Documentation:
+     * https://github.com/gajus/eslint-plugin-jsdoc#check-values
      *
      * Validates that specific tags are never empty.
      */
-    "jsdoc/empty-tags": [
-      "warn",
-      {
-        contexts: ["any"],
-      },
-    ],
+    "jsdoc/empty-tags": "warn",
 
     /**
-     * Documentation: https://github.com/gajus/eslint-plugin-jsdoc#implements-on-classes
+     * Documentation:
+     * https://github.com/gajus/eslint-plugin-jsdoc#implements-on-classes
      *
      * Reports issues with incorrect usage of `@implements`.
      */
-    "jsdoc/implements-on-classes": [
-      "warn",
-      {
-        contexts: ["any"],
-      },
-    ],
+    "jsdoc/implements-on-classes": "warn",
 
     // - jsdoc/match-description - Overlaps with `isaacscript/jsdoc-full-sentences`.
     // - jsdoc/match-name - Only needed for projects with specific JSDoc requirements.
@@ -112,7 +99,8 @@ module.exports = {
     // - jsdoc/no-restricted-syntax - Not generally relevant.
 
     /**
-     * Documentation: https://github.com/gajus/eslint-plugin-jsdoc#no-types
+     * Documentation:
+     * https://github.com/gajus/eslint-plugin-jsdoc#no-types
      *
      * Disallows types being used on `@param` or `@returns`.
      */
@@ -126,16 +114,12 @@ module.exports = {
     // - jsdoc/no-undefined-types - Not needed in TypeScript.
 
     /**
-     * Documentation: https://github.com/gajus/eslint-plugin-jsdoc#require-asterisk-prefix
+     * Documentation:
+     * https://github.com/gajus/eslint-plugin-jsdoc#require-asterisk-prefix
      *
      * Requires that each JSDoc line starts with an `*`.
      */
-    "jsdoc/require-asterisk-prefix": [
-      "warn",
-      {
-        contexts: ["any"],
-      },
-    ],
+    "jsdoc/require-asterisk-prefix": "warn",
 
     // - jsdoc/require-description-complete-sentence - Overlaps with
     //   `isaacscript/jsdoc-complete-sentences`.
@@ -149,13 +133,7 @@ module.exports = {
      *
      * Disallow hyphens before parameter descriptions, as it is non-standard syntax.
      */
-    "jsdoc/require-hyphen-before-param-description": [
-      "warn",
-      "never",
-      {
-        contexts: ["any"],
-      },
-    ],
+    "jsdoc/require-hyphen-before-param-description": ["warn", "never"],
 
     // - jsdoc/require-jsdoc - It's overboard for every function to have a JSDoc comment.
 
@@ -195,12 +173,7 @@ module.exports = {
      *
      * Requires that each `@property` tag has a description.
      */
-    "jsdoc/require-property-description": [
-      "warn",
-      {
-        contexts: ["any"],
-      },
-    ],
+    "jsdoc/require-property-description": "warn",
 
     /**
      * Documentation:
@@ -208,16 +181,11 @@ module.exports = {
      *
      * Requires that each `@property` tag has a name.
      */
-    "jsdoc/require-property-name": [
-      "warn",
-      {
-        contexts: ["any"],
-      },
-    ],
+    "jsdoc/require-property-name": "warn",
 
     // - jsdoc/require-property-type - Not needed in TypeScript.
     // - jsdoc/require-returns-check - It's overboard for every function to document every return
-    // value.
+    //   value.
 
     /**
      * Documentation:
@@ -238,7 +206,7 @@ module.exports = {
     // - jsdoc/require-yields - It's overboard to document every yield.
     // - jsdoc/require-yields-check - It's overboard to document every yield.
     // - jsdoc/sort-tags - Not very useful since there are typically only `@param` and `@return`
-    // tags.
+    //   tags.
 
     /**
      * Documentation:
@@ -246,12 +214,7 @@ module.exports = {
      *
      * Enforces no lines between tags.
      */
-    "jsdoc/tag-lines": [
-      "warn",
-      {
-        contexts: ["any"],
-      },
-    ],
+    "jsdoc/tag-lines": "warn",
 
     // - jsdoc/valid-types - Not needed in TypeScript.
   },

package/mod.js

@@ -66,7 +66,18 @@ module.exports = {
     "@typescript-eslint/no-loop-func": "off",
 
     /**
-     * Documentation: https://github.com/eslint/eslint/blob/master/docs/rules/no-bitwise.md
+     * Documentation:
+     * https://github.com/IsaacScript/eslint-plugin-isaacscript/blob/main/docs/rules/enum-member-number-separation.md
+     *
+     * Not defined in the parent configs.
+     *
+     * Since Isaac enums use the `SHOUTING_SNAKE_CASE` convention, this rule ensures correctness.
+     */
+    "enum-member-number-separation": "on",
+
+    /**
+     * Documentation:
+     * https://github.com/eslint/eslint/blob/master/docs/rules/no-bitwise.md
      *
      * Defined at:
      * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/style.js
@@ -76,7 +87,8 @@ module.exports = {
     "no-bitwise": "off",
 
     /**
-     * Documentation: https://eslint.org/docs/rules/no-param-reassign
+     * Documentation:
+     * https://eslint.org/docs/rules/no-param-reassign
      *
      * Defined at:
      * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/best-practices.js
@@ -86,7 +98,8 @@ module.exports = {
     "no-param-reassign": "off",
 
     /**
-     * Documentation: https://eslint.org/docs/rules/no-restricted-globals
+     * Documentation:
+     * https://eslint.org/docs/rules/no-restricted-globals
      *
      * Defined at:
      * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/variables.js
@@ -96,7 +109,8 @@ module.exports = {
     "no-restricted-globals": "off",
 
     /**
-     * Documentation: https://eslint.org/docs/rules/no-underscore-dangle
+     * Documentation:
+     * https://eslint.org/docs/rules/no-underscore-dangle
      *
      * Defined at:
      * https://github.com/airbnb/javascript/blob/master/packages/eslint-config-airbnb-base/rules/style.js

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-isaacscript",
-  "version": "1.0.74",
+  "version": "1.0.77",
   "description": "An ESLint config for IsaacScript projects.",
   "repository": {
     "type": "git",
@@ -8,7 +8,14 @@
   },
   "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"
   }
 }

package/.cspell.json

@@ -1,14 +0,0 @@
-{
-    "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
-    "version": "0.2",
-    "words": [
-        "backticks",
-        "isaacscript",
-        "plusplus",
-        "sarisia",
-        "technote",
-        "Turnbull",
-        "unfixable",
-        "Zamiell"
-    ]
-}

package/.eslintrc.js

@@ -1,8 +0,0 @@
-// This is a shared configuration file for ESLint:
-// https://eslint.org/docs/user-guide/configuring
-module.exports = {
-  plugins: ["prettier"],
-  rules: {
-    "prettier/prettier": "warn",
-  },
-};

package/.gitattributes

@@ -1,9 +0,0 @@
-# Prevent Windows systems from cloning this repository with "\r\n" line endings
-core.autocrlf=false
-
-# Prevent people from making merge commits
-# https://www.endoflineblog.com/gitflow-considered-harmful
-pull.rebase=true
-
-# Convert all files to use "\n" line endings
-* text=auto eol=lf

package/.github/workflows/ci.yml

@@ -1,44 +0,0 @@
-name: CI
-
-on: [push, pull_request]
-
-jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout the repository
-        uses: actions/checkout@v2
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v2
-        with:
-          # The default version is 14. The ESLint config requires Node 16 to work properly.
-          node-version: '16'
-
-      - name: Retrieve the cached "node_modules" directory (if present)
-        uses: actions/cache@v2
-        id: node-cache
-        with:
-          path: node_modules
-          key: node-modules-${{ runner.os }}-${{ hashFiles('package-lock.json') }}
-
-      - name: Install dependencies (if the cached directory was not found)
-        if: steps.node-cache.outputs.cache-hit != 'true'
-        run: npm ci
-
-      - name: Perform automated checks
-        run: bash lint.sh
-
-  discord:
-    name: Discord Failure Notification
-    needs: [lint]
-    if: always() # This is needed to always run this job, even if the other jobs fail.
-    runs-on: ubuntu-latest
-    steps:
-      - uses: technote-space/workflow-conclusion-action@v2
-      - if: env.WORKFLOW_CONCLUSION != 'success' && env.WORKFLOW_CONCLUSION != 'cancelled'
-        uses: sarisia/actions-status-discord@v1
-        with:
-          webhook: ${{ secrets.DISCORD_WEBHOOK }}
-          status: ${{ env.WORKFLOW_CONCLUSION }}
-          title: ""

package/.prettierrc.js

@@ -1,15 +0,0 @@
-// This is the configuration file for Prettier, the auto-formatter:
-// https://prettier.io/docs/en/configuration.html
-module.exports = {
-  // https://prettier.io/docs/en/options.html#trailing-commas
-  // The default is "es5" - Trailing commas where valid in ES5 (objects, arrays, etc.)
-  // However, always having trailing commas is objectively better. The Airbnb style guide agrees:
-  // https://github.com/airbnb/javascript#commas--dangling
-  // Prettier itself also acknowledges Nik Graf's blog in their official blog:
-  // https://prettier.io/blog/2020/03/21/2.0.0.html#change-default-value-for-trailingcomma-to-es5-6963httpsgithubcomprettierprettierpull6963-by-fiskerhttpsgithubcomfisker
-  // https://medium.com/@nikgraf/why-you-should-enforce-dangling-commas-for-multiline-statements-d034c98e36f8
-  // Prettier will change the default in the future:
-  // https://github.com/prettier/prettier/issues/9369
-  trailingComma: "all",
-  endOfLine: "lf",
-};

package/.vscode/extensions.json

@@ -1,9 +0,0 @@
-// These are Visual Studio Code extensions that are intended to be used with this particular
-// repository:
-// https://go.microsoft.com/fwlink/?LinkId=827846
-{
-  "recommendations": [
-    "esbenp.prettier-vscode", // The TypeScript formatter
-    "streetsidesoftware.code-spell-checker", // A spell-checker extension based on cspell
-  ]
-}

package/.vscode/settings.json

@@ -1,30 +0,0 @@
-// These are Visual Studio Code settings that should apply to this particular repository.
-{
-  // ----------------
-  // Vanilla settings
-  // ----------------
-
-  // This matches the Airbnb JavaScript style guide.
-  "editor.rulers": [100],
-  "editor.tabSize": 2,
-
-  // Linux line endings are used in this project.
-  "files.eol": "\n",
-
-  // Automatically removing all trailing whitespace when saving a file.
-  "files.trimTrailingWhitespace": true,
-
-  // ----------
-  // JavaScript
-  // ----------
-
-  // Automatically run the formatter when certain files are saved.
-  "[javascript]": {
-    "editor.codeActionsOnSave": [
-      "source.fixAll.eslint",
-    ],
-    "editor.defaultFormatter": "esbenp.prettier-vscode",
-    "editor.formatOnSave": true,
-    "editor.tabSize": 2,
-  },
-}

package/lint.sh

@@ -1,11 +0,0 @@
-#!/bin/bash
-
-set -e # Exit on any errors
-
-# Get the directory of this script:
-# https://stackoverflow.com/questions/59895/getting-the-source-directory-of-a-bash-script-from-within
-DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
-
-cd "$DIR"
-npx prettier --check base.js mod.js
-echo "Success!"

package/publish.sh

@@ -1,11 +0,0 @@
-#!/bin/bash
-
-set -e # Exit on any errors
-
-# Get the directory of this script:
-# https://stackoverflow.com/questions/59895/getting-the-source-directory-of-a-bash-script-from-within
-DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
-
-cd "$DIR"
-pip install publish-npm --upgrade --quiet
-publish-npm "$@"

package/update.sh

@@ -1,17 +0,0 @@
-#!/bin/bash
-
-set -e # Exit on any errors
-
-# Get the directory of this script:
-# https://stackoverflow.com/questions/59895/getting-the-source-directory-of-a-bash-script-from-within
-DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
-
-cd "$DIR"
-
-PACKAGE_JSON="$DIR/package.json"
-OLD_HASH=$(md5sum "$PACKAGE_JSON")
-npx npm-check-updates --upgrade --packageFile "$PACKAGE_JSON"
-NEW_HASH=$(md5sum "$PACKAGE_JSON")
-if [[ $OLD_HASH != $NEW_HASH ]]; then
-  npm install
-fi