isaacscript 1.2.45 → 2.0.2

package/dist/src/utils.js

@@ -35,7 +35,7 @@ function isKebabCase(s) {
 }
 exports.isKebabCase = isKebabCase;
 /**
- * parseIntSafe is a more reliable version of parseInt. By default, "parseInt('1a')" will return
+ * `parseIntSafe` is a more reliable version of `parseInt`. By default, "parseInt('1a')" will return
  * "1", which is unexpected. This returns either an integer or NaN.
  */
 function parseIntSafe(input) {

package/dist/src/validateNodeVersion.js

@@ -8,9 +8,10 @@ const chalk_1 = __importDefault(require("chalk"));
 const constants_1 = require("./constants");
 const utils_1 = require("./utils");
 const REQUIRED_NODE_JS_MAJOR_VERSION = 16;
-// This program requires Node to be at least v16.0.0,
-// since that is the version that added the "fs.rmSync()" function
-// (I tested on Node v15.0.0 and it failed)
+/**
+ * This program requires Node to be at least v16.0.0, since that is the version that added the
+ * "fs.rmSync" function. (Node v15.0.0 is confirmed to not work.)
+ */
 function validateNodeVersion() {
     const { version } = process;
     const [majorVersion] = (0, utils_1.parseSemVer)(version);

package/dist/src/validateNodeVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"validateNodeVersion.js","sourceRoot":"","sources":["../../src/validateNodeVersion.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAC1B,2CAA2C;AAC3C,mCAAsC;AAEtC,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAE1C,qDAAqD;AACrD,kEAAkE;AAClE,2CAA2C;AAC3C,SAAgB,mBAAmB;IACjC,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAC5B,MAAM,CAAC,YAAY,CAAC,GAAG,IAAA,mBAAW,EAAC,OAAO,CAAC,CAAC;IAE5C,IAAI,YAAY,IAAI,8BAA8B,EAAE;QAClD,OAAO;KACR;IAED,OAAO,CAAC,KAAK,CAAC,4BAA4B,eAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAChE,OAAO,CAAC,KAAK,CACX,GAAG,wBAAY,kCAAkC,eAAK,CAAC,GAAG,CACxD,GAAG,8BAA8B,MAAM,CACxC,cAAc,CAChB,CAAC;IACF,OAAO,CAAC,KAAK,CACX,uDAAuD,wBAAY,GAAG,CACvE,CAAC;IACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAlBD,kDAkBC"}
+{"version":3,"file":"validateNodeVersion.js","sourceRoot":"","sources":["../../src/validateNodeVersion.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAC1B,2CAA2C;AAC3C,mCAAsC;AAEtC,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAE1C;;;GAGG;AACH,SAAgB,mBAAmB;IACjC,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAE5B,MAAM,CAAC,YAAY,CAAC,GAAG,IAAA,mBAAW,EAAC,OAAO,CAAC,CAAC;IAC5C,IAAI,YAAY,IAAI,8BAA8B,EAAE;QAClD,OAAO;KACR;IAED,OAAO,CAAC,KAAK,CAAC,4BAA4B,eAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAChE,OAAO,CAAC,KAAK,CACX,GAAG,wBAAY,kCAAkC,eAAK,CAAC,GAAG,CACxD,GAAG,8BAA8B,MAAM,CACxC,cAAc,CAChB,CAAC;IACF,OAAO,CAAC,KAAK,CACX,uDAAuD,wBAAY,GAAG,CACvE,CAAC;IACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAlBD,kDAkBC"}

package/eslint-debug.sh

@@ -1,3 +1,11 @@
 #!/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 eslint --print-config ./src/main.ts > debug.txt

package/file-templates/dynamic/README.md

@@ -1,3 +1,3 @@
-# MOD_NAME_TO_REPLACE
+# MOD-NAME-TO-REPLACE
 
-MOD_NAME_TO_REPLACE is a mod for *[The Binding of Isaac: Repentance](https://store.steampowered.com/app/1426300/The_Binding_of_Isaac_Repentance/)*, written in [TypeScript](https://www.typescriptlang.org/) using the [IsaacScript](https://isaacscript.github.io/) framework.
+MOD-NAME-TO-REPLACE is a mod for _[The Binding of Isaac: Repentance](https://store.steampowered.com/app/1426300/The_Binding_of_Isaac_Repentance/)_, written in [TypeScript](https://www.typescriptlang.org/) using the [IsaacScript](https://isaacscript.github.io/) framework.

package/file-templates/dynamic/main.ts

@@ -1,14 +1,16 @@
-const MOD_NAME = "MOD_NAME_TO_REPLACE";
+import { ModCallback } from "isaac-typescript-definitions";
+
+const MOD_NAME = "MOD-NAME-TO-REPLACE";
 
 export function main(): void {
   // Instantiate a new mod object, which grants the ability to add callback functions that
-  // correspond to in-game events
+  // correspond to in-game events.
   const mod = RegisterMod(MOD_NAME, 1);
 
-  // Set a callback function that corresponds to when a new run is started
-  mod.AddCallback(ModCallbacks.MC_POST_GAME_STARTED, postGameStarted);
+  // Set a callback function that corresponds to when a new run is started.
+  mod.AddCallback(ModCallback.POST_GAME_STARTED, postGameStarted);
 
-  // Print an initialization message to the "log.txt" file
+  // Print an initialization message to the "log.txt" file.
   Isaac.DebugString(`${MOD_NAME} initialized.`);
 }
 

package/file-templates/dynamic/metadata.vdf

@@ -2,5 +2,5 @@
 {
   "appid" "250900"
   "publishedfileid" ""
-  "contentfolder" "MOD_TARGET_DIR"
+  "contentfolder" "MOD-TARGET-DIR"
 }

package/file-templates/dynamic/metadata.xml

@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <metadata>
-  <name>MOD_NAME_TO_REPLACE</name>
-  <directory>MOD_NAME_TO_REPLACE</directory>
+  <name>MOD-NAME-TO-REPLACE</name>
+  <directory>MOD-NAME-TO-REPLACE</directory>
   <description>
-    MOD_NAME_TO_REPLACE is a currently a work in progress.
+    MOD-NAME-TO-REPLACE is a currently a work in progress.
   </description>
   <version>1.0</version>
   <visibility />

package/file-templates/dynamic/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "MOD_NAME_TO_REPLACE",
+  "name": "MOD-NAME-TO-REPLACE",
   "version": "0.0.1",
   "description": "A mod for The Binding of Isaac: Repentance",
   "keywords": [

package/file-templates/static/.cspell-check-unused.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
+  "version": "0.2",
+  "import": [
+    "./node_modules/isaac-typescript-definitions/.cspell-isaacscript.json"
+  ],
+  "files": ["**"],
+  "ignorePaths": [".cspell-temp.json", ".git/**", "dist/**", "node_modules/**"]
+}

package/file-templates/static/.cspell.json.template

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
+  "version": "0.2",
+  "import": [
+    "./node_modules/isaac-typescript-definitions/.cspell-isaacscript.json"
+  ],
+  "files": ["**"],
+  "ignorePaths": [".git/**", "dist/**", "node_modules/**", "main.lua"]
+}

package/file-templates/static/.eslintrc.js

@@ -1,23 +1,24 @@
-// This is the configuration file for ESLint, the TypeScript linter
+// This is the configuration file for ESLint, the TypeScript linter:
 // https://eslint.org/docs/user-guide/configuring
 module.exports = {
   extends: [
-    // The linter base is the IsaacScript mod config
-    // https://github.com/IsaacScript/eslint-config-isaacscript/blob/main/mod.js
+    /**
+     * The linter base is the IsaacScript mod config:
+     * https://github.com/IsaacScript/eslint-config-isaacscript/blob/main/mod.js
+     */
     "eslint-config-isaacscript/mod",
   ],
 
   parserOptions: {
-    // ESLint needs to know about the project's TypeScript settings in order for TypeScript-specific
-    // things to lint correctly
-    // We do not point this at "./tsconfig.json" because certain files (such at this file) should be
-    // linted but not included in the actual project output
+    /**
+     * ESLint needs to know about the project's TypeScript settings in order for TypeScript-specific
+     * things to lint correctly. We do not point this at "./tsconfig.json" because certain files
+     * (such at this file) should be linted but not included in the actual project output.
+     */
     project: "./tsconfig.eslint.json",
   },
 
-  // We modify the linting rules from the base for some specific things
-  // (listed in alphabetical order)
   rules: {
-    // Insert changed or disabled rules here, if necessary
+    // Insert changed or disabled rules here, if necessary.
   },
 };

package/file-templates/static/.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/file-templates/static/.github/workflows/ci.yml

@@ -12,9 +12,8 @@ jobs:
       - 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'
+          # 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
@@ -37,12 +36,12 @@ jobs:
         run: bash lint.sh
 
   # To enable CI failure notifications over Discord, add a "DISCORD_WEBHOOK" secret to the
-  # repository equal to the URL for the webhook, and then uncomment the lines below
+  # repository equal to the URL for the webhook, and then uncomment the lines below.
 
   #discord:
   #  name: Discord Failure Notification
   #  needs: [build_and_lint]
-  #  if: always() # This is needed to always run this job, even if the other jobs fail
+  #  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

package/file-templates/static/.prettierignore

@@ -1,5 +1,14 @@
-# Ignore all of the XML files created by Basement Renovator
+# Ignore compiled output.
+dist
+
+# The VSCode CSpell plugin causes the file to become unformatted whenever a new word is added.
+.cspell.json
+
+# Ignore all of the XML files created by Basement Renovator.
 mod/content/rooms/**/*.xml
 mod/content/luarooms/**/*.xml
 mod/resources/rooms/**/*.xml
 mod/resources/luarooms/**/*.xml
+
+# Ignore all of the XML files created by the animation editor.
+mod/resources/**/*.anm2

package/file-templates/static/.prettierrc.js

@@ -1,10 +1,9 @@
-// This is the configuration file for Prettier, the auto-formatter
+// 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:
+  // 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
@@ -13,8 +12,23 @@ module.exports = {
   // 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",
+      },
+    },
+  ],
+
   // https://github.com/prettier/plugin-xml#configuration
-  // The default is "struct"
-  // However, whitespace cannot be reformatted unless this is set to "ignore"
+  // The default is "struct".
+  // Whitespace cannot be reformatted unless this is set to "ignore".
   xmlWhitespaceSensitivity: "ignore",
 };

package/file-templates/static/.vscode/extensions.json

@@ -1,11 +1,10 @@
 // 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
     "typescript-to-lua.vscode-typescript-to-lua", // The TypeScriptToLua extension
-  ]
+  ],
 }

package/file-templates/static/.vscode/settings.json

@@ -1,10 +1,10 @@
-// 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,
 
@@ -13,40 +13,52 @@
     "*.dat": "json", // Nearly all mods save JSON to the "save#.dat" file
   },
 
-  // Linux line endings are used in this project
+  // Linux line endings are used in this project.
   "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
+  // Configure glob patterns for excluding files and folders in full text searches and quick open.
   "search.exclude": {
     "**/mod/main.lua": true,
     "**/*.png": true,
     "**/*.wav": true,
+    "dist/**": true,
   },
 
   // -----------------
   // Language settings
   // -----------------
 
-  // By default, VSCode will not automatically fill-in function arguments
+  // 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
+  // Automatically run the formatter when certain files are saved.
   "[javascript]": {
-    "editor.codeActionsOnSave": [
-      "source.fixAll.eslint",
-    ],
+    "editor.codeActionsOnSave": ["source.fixAll.eslint"],
     "editor.defaultFormatter": "esbenp.prettier-vscode",
     "editor.formatOnSave": true,
     "editor.tabSize": 2,
   },
   "[typescript]": {
-    "editor.codeActionsOnSave": [
-      "source.fixAll.eslint",
-    ],
+    "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,
@@ -54,7 +66,7 @@
   "[markdown]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode",
     "editor.formatOnSave": true,
-    "editor.tabSize": 2
+    "editor.tabSize": 2,
   },
   "[xml]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode",

package/file-templates/static/build.sh

@@ -2,13 +2,13 @@
 
 set -e # Exit on any errors
 
-# Get the directory of this script
+# 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 )"
 
 SECONDS=0
 
-# Convert the TypeScript to a single Lua file (based on the settings in "tsconfig.json")
+# Convert the TypeScript to a single Lua file (based on the settings in "tsconfig.json").
 cd "$DIR"
 npx tstl
 

package/file-templates/static/check-orphaned-words.sh

@@ -0,0 +1,53 @@
+#!/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_CONFIGURATION_PATH="$REPO_ROOT/.cspell.json"
+if ! test -f "$CSPELL_CONFIGURATION_PATH"; then
+  exit 0
+fi
+
+# Do nothing if the configuration file does not have any words in it.
+if ! grep -q '"words": ' "$CSPELL_CONFIGURATION_PATH"; then
+  exit 0
+fi
+
+# Make a list of every misspelled word without any custom dictionaries.
+# We need to move the configuration path temporarily or else the cspell command won't work properly.
+CSPELL_CONFIGURATION_PATH_TEMP="$REPO_ROOT/.cspell-temp.json"
+mv "$CSPELL_CONFIGURATION_PATH" "$CSPELL_CONFIGURATION_PATH_TEMP"
+MISSPELLED_WORDS_PATH="/tmp/misspelled-words.txt"
+CSPELL_CONFIGURATION_TEST_PATH="$REPO_ROOT/.cspell-check-unused.json"
+npx cspell lint --config "$CSPELL_CONFIGURATION_TEST_PATH" --dot --no-progress --no-summary --unique --words-only | sort --ignore-case --unique > "$MISSPELLED_WORDS_PATH"
+mv "$CSPELL_CONFIGURATION_PATH_TEMP" "$CSPELL_CONFIGURATION_PATH"
+
+# Check that each ".cspell.json" word is actually being used.
+echo "Checking for orphaned CSpell configuration words in: $CSPELL_CONFIGURATION_PATH"
+CSPELL_CONFIGURATION_WORDS=$(cat "$CSPELL_CONFIGURATION_PATH" | python -c "import sys, json; print('\n'.join(json.load(sys.stdin)['words']))")
+ONE_OR_MORE_FAILURES=0
+set +e
+for LINE in $CSPELL_CONFIGURATION_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/file-templates/static/lint.sh

@@ -2,7 +2,7 @@
 
 set -e # Exit on any errors
 
-# Get the directory of this script
+# 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 )"
 
@@ -10,29 +10,30 @@ SECONDS=0
 
 cd "$DIR"
 
-# Step 1 - Use Prettier to check formatting
-npx prettier --check "src/**/*.ts"
-npx prettier --check "mod/**/*.xml"
+# Step 1 - Use Prettier to check formatting.
+npx prettier --check .
 
-# Step 2 - Use ESLint to lint the TypeScript
-# Since all ESLint errors are set to warnings,
-# we set max warnings to 0 so that warnings will fail in CI
+# Step 2 - Use ESLint to lint the TypeScript.
+# Since all ESLint errors are set to warnings, we set max warnings to 0 so that warnings will fail
+# in CI.
 npx eslint --max-warnings 0 src
 
-# Step 3 - 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 "src/**/*.ts"
-npx cspell --no-progress --no-summary "mod/metadata.xml"
+# Step 3 - 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 4 - Use xmllint to lint XML files
-# (and skip this step if xmllint is not currently installed for whatever reason)
+# Step 4 - Use xmllint to lint XML files.
+# (Skip this step if xmllint is not currently installed for whatever reason.)
 if command -v xmllint &> /dev/null; then
   find "$DIR/mod" -name "*.xml" -print0 | xargs -0 xmllint --noout
 fi
 
-# Step 5 - Check for unused imports
-# The "--error" flag makes it return an error code of 1 if unused exports are found
-# (this starts out disabled by default, but you can uncomment the following line to find dead code)
+# Step 5 - Check for unused imports.
+# The "--error" flag makes it return an error code of 1 if unused exports are found.
+# (This starts out disabled by default, but you can uncomment the following line to find dead code.)
 # npx ts-prune --error
 
+# Step 6 - Check for orphaned words.
+bash "$DIR/check-orphaned-words.sh"
+
 echo "Successfully linted in $SECONDS seconds."

package/file-templates/static/nuke.sh

@@ -2,7 +2,7 @@
 
 set -e # Exit on any errors
 
-# Get the directory of this script
+# 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 )"
 

package/file-templates/static/publish.sh

@@ -2,7 +2,7 @@
 
 set -e # Exit on any errors
 
-# Get the directory of this script
+# 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 )"
 

package/file-templates/static/run.sh

@@ -2,7 +2,7 @@
 
 set -e # Exit on any errors
 
-# Get the directory of this script
+# 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 )"
 

package/file-templates/static/src/bundleEntry.ts

@@ -1,7 +1,7 @@
-// This is the entry point for the TypeScriptToLua bundler, which is set in the "tsconfig.json" file
-// All this file does is immediately execute the "main()" function in the "main.ts" file
-// (We don't want to point the TypeScriptToLua bundler at the "main.ts" file directly, because any
-// variables or functions that are declared in a bundle entry point will become global)
+// This is the entry point for the TypeScriptToLua bundler, which is set in the "tsconfig.json"
+// file. All this file does is immediately execute the "main()" function in the "main.ts" file. (We
+// don't want to point the TypeScriptToLua bundler at the "main.ts" file directly, because any
+// variables or functions that are declared in a bundle entry point will become global.)
 
 import { main } from "./main";
 

package/file-templates/static/tsconfig.eslint.json

@@ -1,11 +1,11 @@
-// A special TypeScript configuration file, used by ESLint only
+// A special TypeScript configuration file, used by ESLint only.
 {
   "extends": "./tsconfig.json",
   "include": [
-    // This must match the "include" setting in the "tsconfig.json" file
+    // This must match the "include" setting in the "tsconfig.json" file.
     "./src/**/*.ts",
 
-    // These are ESLint-only inclusions
+    // These are ESLint-only inclusions.
     "./.eslintrc.js",
   ],
 }

package/file-templates/static/tsconfig.json

@@ -1,19 +1,17 @@
-// The configuration file for TypeScript
+// The configuration file for TypeScript.
 {
-  // We extend the standard IsaacScript config
+  // We extend the standard IsaacScript config:
   // https://github.com/IsaacScript/isaacscript-tsconfig/blob/main/tsconfig.mod.json
   "extends": "isaacscript-tsconfig/tsconfig.mod.json",
 
   // https://www.typescriptlang.org/docs/handbook/compiler-options.html
   "compilerOptions": {
-    // Specifies the root folder within your source files
+    // Specifies the root folder within your source files.
     "rootDir": "./src",
   },
 
-  // A list of the TypeScript files to compile
-  "include": [
-    "./src/**/*.ts",
-  ],
+  // A list of the TypeScript files to compile.
+  "include": ["./src/**/*.ts"],
 
   // TypeScriptToLua settings
   "tstl": {
@@ -21,14 +19,14 @@
     "luaBundle": "./mod/main.lua", // Will bundle all output Lua files into a single file
     "luaBundleEntry": "./src/bundleEntry.ts", // This invokes the "main.ts" file
     "luaPlugins": [
-      // A plugin to add an explanatory comment at the top of the compiled "main.lua" file
+      // A plugin to add an explanatory comment at the top of the compiled "main.lua" file.
       { "name": "./plugins/addIsaacScriptCommentHeader.ts" },
 
-      // A plugin to make enums safe from global variables
+      // A plugin to make enums safe from global variables.
       { "name": "./plugins/noExtendedEnums.ts" },
 
       // Uncomment this and recompile the mod to enable crash debugging, which will tell you the
-      // exact line of the mod that is causing the crash
+      // exact line of the mod that is causing the crash.
       // { "name": "./plugins/addCrashDebugStatements.ts" },
     ],
   },

package/file-templates/static/update.sh

@@ -2,7 +2,7 @@
 
 set -e # Exit on any errors
 
-# Get the directory of this script
+# 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 )"
 

package/file-templates/static-alt/.cspell-base.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
+  "version": "0.2",
+  "loadDefaultConfiguration": true,
+  "import": [
+    "@cspell/dict-companies/cspell-ext.json",
+    "@cspell/dict-en_us/cspell-ext.json",
+    "@cspell/dict-public-licenses/cspell-ext.json",
+    "@cspell/dict-software-terms/cspell-ext.json",
+    "@cspell/dict-typescript/cspell-ext.json"
+  ],
+  "dictionaries": [
+    "companies",
+    "en_US",
+    "networking-terms",
+    "public-licenses",
+    "software-terms",
+    "typescript"
+  ],
+  "ignoreRegExpList": [
+    "Base64MultiLine",
+    "Base64SingleLine",
+    "CommitHash",
+    "CommitHashLink",
+    "CSSHexValue",
+    "CStyleHexValue",
+    "Email",
+    "HashStrings",
+    "RsaCert",
+    "SHA",
+    "SpellCheckerDisable",
+    "SpellCheckerIgnoreInDocSetting",
+    "SshRsa",
+    "UnicodeRef",
+    "Urls",
+    "UUID"
+  ]
+}