isaacscript-lint 1.0.150 → 1.0.151

package/.cspell.json

@@ -1,18 +1,25 @@
 {
-    "version": "0.2",
-    "words": [
-        "dbaeumer",
-        "eqeqeq",
-        "esbenp",
-        "gofmt",
-        "gofmt's",
-        "Gruntfile",
-        "isaacscript",
-        "prettier's",
-        "rossum",
-        "rustfmt",
-        "tiamtowtdi",
-        "unexported",
-        "zamiell"
-    ]
+  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
+  "version": "0.2",
+  "files": [
+    "**"
+  ],
+  "ignorePaths": [
+    ".git/**",
+    "dist/**",
+    "node_modules/**"
+  ],
+  "words": [
+    "dbaeumer",
+    "esbenp",
+    "gofmt",
+    "Gruntfile",
+    "isaacscript",
+    "prettierignore",
+    "prettierrc",
+    "rossum",
+    "rustfmt",
+    "tiamtowtdi",
+    "zamiell"
+  ]
 }

package/.gitattributes

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

package/.prettierignore

@@ -0,0 +1,5 @@
+# Ignore compiled output.
+dist
+
+# The VSCode CSpell plugin causes the file to become unformatted whenever a new word is added.
+.cspell.json

package/.prettierrc.js

@@ -0,0 +1,30 @@
+// This is the configuration file for Prettier, the auto-formatter:
+// https://prettier.io/docs/en/configuration.html
+module.exports = {
+  // Always print trailing commas:
+  // 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
+  // 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",
+
+  // We want to always use "lf" to be consistent with all platforms.
+  endOfLine: "lf",
+
+  // Allow proper formatting of JSONC files:
+  // https://github.com/prettier/prettier/issues/5708
+  overrides: [
+    {
+      files: ["**/.vscode/*.json", "**/tsconfig.json", "**/tsconfig.*.json"],
+      options: {
+        parser: "json5",
+        quoteProps: "preserve",
+      },
+    },
+  ],
+};

package/.vscode/extensions.json

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

package/.vscode/settings.json

@@ -1,16 +1,66 @@
-// These are Visual Studio Code settings that should apply to this particular repository
+// These are Visual Studio Code settings that should apply to this particular repository.
 {
   // ----------------
   // Vanilla settings
   // ----------------
 
-  // This matches the Airbnb JavaScript style guide
+  // This matches the Airbnb JavaScript style guide.
   "editor.rulers": [100],
   "editor.tabSize": 2,
 
-  // Linux line endings are used in this project
+  // We want to always use "lf" to be consistent with all platforms.
   "files.eol": "\n",
 
-  // Automatically removing all trailing whitespace when saving a file
+  // Automatically removing all trailing whitespace when saving a file.
   "files.trimTrailingWhitespace": true,
+
+  // Configure glob patterns for excluding files and folders in full text searches and quick open.
+  // (File extensions must be specified or the glob won't work properly.)
+  "search.exclude": {
+    "dist/**/*.ts": true,
+    "dist/**/*.js": true,
+    "dist/**/*.json": true,
+  },
+
+  // -----------------
+  // Language settings
+  // -----------------
+
+  // By default, VSCode will not automatically fill-in function arguments.
+  "javascript.suggest.completeFunctionCalls": true,
+  "typescript.suggest.completeFunctionCalls": true,
+
+  // 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,
+  },
+  "[typescript]": {
+    "editor.codeActionsOnSave": ["source.fixAll.eslint"],
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+  },
+  "[json]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+  },
+  "[jsonc]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+  },
+  "[yaml]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+  },
+  "[markdown]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+  },
 }

package/README.md

@@ -1,5 +1,7 @@
 # isaacscript-lint
 
+<!-- markdownlint-disable MD033 -->
+
 [![npm version](https://img.shields.io/npm/v/isaacscript-lint.svg)](https://www.npmjs.com/package/isaacscript-lint)
 
 `isaacscript-lint` is a helper package to install all of the dependencies necessary for ESLint to work with a typical TypeScript project or a typical IsaacScript mod.
@@ -30,7 +32,7 @@ One of the key insights of [Guido van Rossum](https://en.wikipedia.org/wiki/Guid
 
 [Go](https://golang.org/), the programming language designed at Google in 2009, took this concept a step further. They included a code formatter inside of the language itself, called `gofmt` (which is short for "Go formatter"). When you are coding a Go program, it will automatically format all of the code as soon as you save the file. This can be surprising and disturbing for newcomers: "Why does `gofmt` make my code ugly?!"
 
-However, once people get used to the formatter, they realize that it saves them a *tremendous amount of time*. By ignoring all formatting and typing out code "raw", and then summoning the formatter to instantly fix everything, you can quite literally code twice as fast. Rob Pike, one of the creators of Go, famously said that "gofmt's style is no one's favorite, yet gofmt is everyone's favorite". ([This YouTube clip](https://www.youtube.com/embed/PAAkCSZUG1c?start=523&end=568) of Rob is a much-watch!)
+However, once people get used to the formatter, they realize that it saves them a _tremendous amount of time_. By ignoring all formatting and typing out code "raw", and then summoning the formatter to instantly fix everything, you can quite literally code twice as fast. Rob Pike, one of the creators of Go, famously said that "gofmt's style is no one's favorite, yet gofmt is everyone's favorite". ([This YouTube clip](https://www.youtube.com/embed/PAAkCSZUG1c?start=523&end=568) of Rob is a much-watch!)
 
 `gofmt` is nice because it saves people from mundane code formatting. But there is also a benefit that is entirely separate and not readily apparent. When looking at other people's Go code on StackOverflow or GitHub, you realize that it looks exactly like your code. It's easy to read and comprehend. And you can copy-paste code snippets from other programs into your own applications without having to change anything! For programmers, this is not the norm, and it feels great - it's the hidden superpower of Go.
 
@@ -48,7 +50,7 @@ Historically, the the most popular style guide is the world is the [Airbnb JavaS
 
 ESLint is the industry standard tool for linting in JavaScript and TypeScript. Airbnb helpfully provides an ESLint configuration with most of their style recommendations. ESLint can function in a way similar to `gofmt` by configuring your text editor to do `eslint --fix` on save. However, this has a lot of limitations. It can't automatically fix everything and leaves a lot up to the end user to fix.
 
-[Prettier](https://prettier.io/) was released in 2017 and it has quickly become very widespread. (It could *probably* also be considered to be industry standard in 2022.) Prettier works by completely rebuilding your code from scratch using the [AST](https://en.wikipedia.org/wiki/Abstract_syntax_tree), which allows it to make much better transformations than pure ESLint can.
+[Prettier](https://prettier.io/) was released in 2017 and it has quickly become very widespread. (It could _probably_ also be considered to be industry standard in 2022.) Prettier works by completely rebuilding your code from scratch using the [AST](https://en.wikipedia.org/wiki/Abstract_syntax_tree), which allows it to make much better transformations than pure ESLint can.
 
 Because of the advantages of Prettier, we use it on top of the Airbnb config, and prefer Prettier's changes if there are any conflicts. Any ESLint rules that conflict with Prettier are turned off with [`eslint-config-prettier`](https://github.com/prettier/eslint-config-prettier).
 
@@ -116,8 +118,8 @@ Create a `tsconfig.eslint.json` file in the root of your repository:
     // These are ESLint-only inclusions
     // Usually, this includes any files that are outside of your "src" directory,
     // such as "webpack.config.js", "jest.config.js", "Gruntfile.js", and so forth
-    "./.eslintrc.js",
-  ],
+    "./.eslintrc.js"
+  ]
 }
 ```
 
@@ -157,20 +159,16 @@ Furthermore, you will probably want Prettier and ESLint to be run automatically
 // These are Visual Studio Code settings that should apply to this particular repository
 {
   "[javascript]": {
-    "editor.codeActionsOnSave": [
-      "source.fixAll.eslint",
-    ],
+    "editor.codeActionsOnSave": ["source.fixAll.eslint"],
     "editor.defaultFormatter": "esbenp.prettier-vscode",
-    "editor.formatOnSave": true,
+    "editor.formatOnSave": true
   },
 
   "[typescript]": {
-    "editor.codeActionsOnSave": [
-      "source.fixAll.eslint",
-    ],
+    "editor.codeActionsOnSave": ["source.fixAll.eslint"],
     "editor.defaultFormatter": "esbenp.prettier-vscode",
-    "editor.formatOnSave": true,
-  },
+    "editor.formatOnSave": true
+  }
 }
 ```
 
@@ -190,8 +188,8 @@ Optionally, you can also provide a hint to anyone cloning your repository that t
   "recommendations": [
     "esbenp.prettier-vscode", // The TypeScript formatter
     "dbaeumer.vscode-eslint", // The TypeScript linter
-    "streetsidesoftware.code-spell-checker", // A spell-checker extension based on cspell
-  ],
+    "streetsidesoftware.code-spell-checker" // A spell-checker extension based on cspell
+  ]
 }
 ```
 

package/check-file-updates.sh

@@ -0,0 +1,67 @@
+#!/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 )"
+
+TEMPLATE_FILES_FILE_NAME="check-file-updates.txt"
+TEMPLATE_FILES_PATH="$DIR/$TEMPLATE_FILES_FILE_NAME"
+
+# Do nothing if the metadata file does not exist.
+if ! test -f "$TEMPLATE_FILES_PATH"; then
+  echo "The \"$TEMPLATE_FILES_FILE_NAME\" file does not exist. Skipping checks."
+  exit 0
+fi
+
+ONE_OR_MORE_FAILURES=0
+for FILE_SPECIFICATION in $(cat "$TEMPLATE_FILES_PATH"); do
+  if [[ "$FILE_SPECIFICATION" =~ (.+):(.+) ]]; then
+    LOCAL_FILE=${BASH_REMATCH[1]}
+    REMOTE_FILE=${BASH_REMATCH[2]}
+    STATIC_DIRECTORY="static-alt"
+  else
+    LOCAL_FILE=$FILE_SPECIFICATION
+    REMOTE_FILE=$FILE_SPECIFICATION
+    STATIC_DIRECTORY="static"
+  fi
+
+  echo "Checking for an updated version of: $LOCAL_FILE"
+  TMP_FILE_PATH="/tmp/base-file"
+  URL="https://raw.githubusercontent.com/IsaacScript/isaacscript/main/file-templates/$STATIC_DIRECTORY/$REMOTE_FILE"
+  curl "$URL" --output "$TMP_FILE_PATH" --silent --show-error
+  if grep "^404: Not Found" "$TMP_FILE_PATH" --silent; then
+    echo
+    echo "Failed to find the following remote file:"
+    echo "$URL"
+    exit 1
+  fi
+
+  FILE_PATH="$DIR/$LOCAL_FILE"
+  if test -f "$FILE_PATH"; then
+    set +e
+    if ! cmp "$FILE_PATH" "$TMP_FILE_PATH" --silent; then
+      echo
+      echo "File \"$LOCAL_FILE\" is out of date. Get the updated version here:"
+      echo "$URL"
+      echo
+      diff "$FILE_PATH" "$TMP_FILE_PATH"
+      echo
+      ONE_OR_MORE_FAILURES=1
+    fi
+    set -e
+  else
+    echo "File \"$FILE_PATH\" does not exist! Change the \"$TEMPLATE_FILES_FILE_NAME\" file."
+    ONE_OR_MORE_FAILURES=1
+  fi
+
+  rm -f "$TMP_FILE_PATH"
+done
+
+if [ $ONE_OR_MORE_FAILURES -ne "0" ]; then
+  echo "One or more files was not valid."
+  exit 1
+fi
+
+echo "All core files up to date!"

package/check-file-updates.txt

@@ -0,0 +1,7 @@
+.vscode/extensions.json:.vscode/extensions-typescript.json
+.vscode/settings.json:.vscode/settings-typescript.json
+.gitattributes
+.prettierignore:.prettierignore-base
+.prettierrc.js:.prettierrc-base.js
+check-file-updates.sh:check-file-updates.sh
+check-orphaned-words.sh

package/check-orphaned-words.sh

@@ -0,0 +1,58 @@
+#!/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 )"
+
+REPO_ROOT="$DIR"
+cd "$REPO_ROOT"
+
+# Do nothing if the configuration file does not exist.
+CSPELL_CONFIG_NAME=".cspell.json"
+CSPELL_CONFIG_PATH="$REPO_ROOT/$CSPELL_CONFIG_NAME"
+if ! test -f "$CSPELL_CONFIG_PATH"; then
+  echo "The \"$CSPELL_CONFIG_NAME\" file does not exist. Skipping checks."
+  exit 0
+fi
+
+# Do nothing if the configuration file does not have any words in it.
+if ! grep -q '"words": ' "$CSPELL_CONFIG_PATH"; then
+  echo "The \"$CSPELL_CONFIG_NAME\" file does not have any whitelisted words in it. Skipping checks."
+  exit 0
+fi
+
+# Make a list of every misspelled word without any custom words.
+# We need to move the configuration path temporarily or else the cspell command won't work properly.
+CSPELL_CONFIG_WORDS=$(cat "$CSPELL_CONFIG_PATH" | python -c "import sys, json; print('\n'.join(json.load(sys.stdin)['words']))")
+CSPELL_CONFIG_WITHOUT_WORDS=$(cat "$CSPELL_CONFIG_PATH" | python -c "import sys, json; config = json.load(sys.stdin); del config['words']; print(json.dumps(config))")
+CSPELL_CONFIG_PATH_TEMP="$REPO_ROOT/.cspell-temp.json"
+mv "$CSPELL_CONFIG_PATH" "$CSPELL_CONFIG_PATH_TEMP"
+echo "$CSPELL_CONFIG_WITHOUT_WORDS" > "$CSPELL_CONFIG_PATH"
+MISSPELLED_WORDS_PATH="/tmp/misspelled-words.txt"
+npx cspell lint --no-progress --no-summary --unique --words-only | sort --ignore-case --unique > "$MISSPELLED_WORDS_PATH"
+mv "$CSPELL_CONFIG_PATH_TEMP" "$CSPELL_CONFIG_PATH"
+
+# Check that each ".cspell.json" word is actually being used.
+echo "Checking for orphaned CSpell configuration words in: $CSPELL_CONFIG_PATH"
+
+ONE_OR_MORE_FAILURES=0
+set +e
+for LINE in $CSPELL_CONFIG_WORDS; do
+  LINE_TRIMMED=$(echo "$LINE" | xargs)
+  if ! grep "$LINE_TRIMMED" "$MISSPELLED_WORDS_PATH" --ignore-case --quiet; then
+    echo "The following word in the CSpell config is not being used: $LINE_TRIMMED"
+    ONE_OR_MORE_FAILURES=1
+  fi
+done
+set -e
+
+rm -f "$MISSPELLED_WORDS_PATH"
+
+if [ $ONE_OR_MORE_FAILURES -ne "0" ]; then
+  echo "CSpell configuration words are not valid."
+  exit 1
+fi
+
+echo "CSpell configuration words are valid."

package/lint.sh

@@ -0,0 +1,22 @@
+#!/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"
+
+# Step 1 - Use Prettier to check formatting.
+npx prettier --check .
+
+# Step 2 - Spell check every file using cspell.
+# We use "--no-progress" and "--no-summary" because we want to only output errors.
+npx cspell --no-progress --no-summary
+
+# Step 3 - Check for orphaned words.
+bash "$DIR/check-orphaned-words.sh"
+
+# Step 4 - Check for base file updates.
+bash "$DIR/check-file-updates.sh"

package/nuke.sh

@@ -15,4 +15,4 @@ rm -rf "$NODE_MODULES"
 echo "Successfully deleted: $NODE_MODULES"
 
 npm install
-echo "Successfully reinstalled Node depedencies."
+echo "Successfully reinstalled Node dependencies."

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-lint",
-  "version": "1.0.150",
+  "version": "1.0.151",
   "description": "An updatable linting dependency container for IsaacScript and TypeScript projects",
   "repository": {
     "type": "git",
@@ -16,12 +16,12 @@
     "eslint": "^8.15.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-airbnb-typescript": "^17.0.0",
-    "eslint-config-isaacscript": "^1.0.76",
+    "eslint-config-isaacscript": "^1.0.77",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-isaacscript": "^1.0.39",
-    "eslint-plugin-jsdoc": "^39.2.9",
+    "eslint-plugin-isaacscript": "^1.0.40",
+    "eslint-plugin-jsdoc": "^39.3.0",
     "eslint-plugin-no-implicit-map-set-loops": "^1.0.3",
     "eslint-plugin-only-warn": "^1.0.3",
     "eslint-plugin-sort-exports": "^0.6.0",