isaacscript 2.0.14-dev.1 → 2.0.14-dev.2

package/file-templates/static/build.sh

@@ -0,0 +1,15 @@
+#!/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 )"
+
+SECONDS=0
+
+# Convert the TypeScript to a single Lua file (based on the settings in "tsconfig.json").
+cd "$DIR"
+npx tstl
+
+echo "Successfully built in $SECONDS seconds."

package/file-templates/static/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/file-templates/static/lint.sh

@@ -0,0 +1,39 @@
+#!/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 )"
+
+SECONDS=0
+
+cd "$DIR"
+
+# 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.
+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
+
+# 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.)
+# 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

@@ -0,0 +1,18 @@
+#!/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 )"
+
+PACKAGE_LOCK="$DIR/package-lock.json"
+rm -f "$PACKAGE_LOCK"
+echo "Successfully deleted: $PACKAGE_LOCK"
+
+NODE_MODULES="$DIR/node_modules"
+rm -rf "$NODE_MODULES"
+echo "Successfully deleted: $NODE_MODULES"
+
+npm install
+echo "Successfully reinstalled Node dependencies."

package/file-templates/static/plugins/addCrashDebugStatements.ts

@@ -0,0 +1,40 @@
+/**
+ * When you write code that causes the game to crash, it can be difficult to find the exact line of
+ * code that is causing the crash.
+ *
+ * In these situations, you can enable this plugin, which will add a log statement in between every
+ * line of Lua code with a randomly-generated UUID. That way, you can cause the crash, and then look
+ * at the bottom of the "log.txt" for the final UUID that shows up.
+ *
+ * Next, you can Ctrl + f in the "main.lua" file for the matching UUID, which will bring you to the
+ * exact point in the code where the crash happened.
+ */
+
+import * as crypto from "crypto";
+import { SourceNode } from "source-map";
+import * as ts from "typescript";
+import * as tstl from "typescript-to-lua";
+
+class CustomPrinter extends tstl.LuaPrinter {
+  printStatement(statement: tstl.Statement): SourceNode {
+    const uuid = crypto.randomUUID();
+    const debugLineToInsert = `Isaac.DebugString("CRASH DEBUG ${uuid}")\n`;
+    const originalResult = super.printStatement(statement);
+    return this.createSourceNode(statement, [
+      debugLineToInsert,
+      originalResult,
+    ]);
+  }
+}
+
+const plugin: tstl.Plugin = {
+  printer: (
+    program: ts.Program,
+    emitHost: tstl.EmitHost,
+    fileName: string,
+    file: tstl.File,
+  ) => new CustomPrinter(emitHost, program, fileName).print(file),
+};
+
+// ts-prune-ignore-next
+export default plugin;

package/file-templates/static/plugins/addIsaacScriptCommentHeader.ts

@@ -0,0 +1,37 @@
+/** This plugin adds an explanatory header to the top of the generated Lua code. */
+
+import * as ts from "typescript";
+import * as tstl from "typescript-to-lua";
+
+const INFORMATIONAL_HEADER = `--[[
+
+This Isaac mod was created with the IsaacScript tool.
+
+The Lua code in this file is not actually the source code for the program. Rather, it was
+automatically generated from higher-level TypeScript code, and might be hard to read. If you want to
+understand how the code in this mod works, you should read the actual TypeScript source code
+directly instead of trying to read this file. Usually, the link to the source code can be found in
+the mod's description on the Steam Workshop. If not, you can ask the mod author directly if the
+source code is publicly available.
+
+IsaacScript provides a lot of advantages over using raw Lua. For more information about the tool,
+see the official website: https://isaacscript.github.io/
+
+--]]
+
+`;
+
+const plugin: tstl.Plugin = {
+  beforeEmit(
+    _program: ts.Program,
+    _options: tstl.CompilerOptions,
+    _emitHost: tstl.EmitHost,
+    result: tstl.EmitFile[],
+  ) {
+    for (const file of result) {
+      file.code = `${INFORMATIONAL_HEADER}${file.code}`;
+    }
+  },
+};
+
+export default plugin;

package/file-templates/static/plugins/noExtendedEnums.ts

@@ -0,0 +1,69 @@
+/**
+ * This plugin prevents transpiled enums from using global variables as a base (if present).
+ *
+ * For example, by default, the following enum:
+ *
+ * ```ts
+ * export enum Foo {
+ *   Value1,
+ *   Value2,
+ * }
+ * ```
+ *
+ * Will be transpiled to this:
+ *
+ * ```lua
+ * local ____exports = {}
+ * ____exports.Foo = Foo or ({})
+ * ____exports.Foo.Value1 = 0
+ * ____exports.Foo[____exports.Foo.Value1] = "Value1"
+ * ____exports.Foo.Value2 = 1
+ * ____exports.Foo[____exports.Foo.Value2] = "Value2"
+ * return ____exports
+ * ```
+ *
+ * As we can see, the first line uses the existing global variable of "Foo" as a base, if present.
+ * The reason it does this is because TSTL needs to support the TypeScript feature of combining
+ * enums, like this:
+ *
+ * ```ts
+ * enum Foo {
+ *   Value1,
+ * }
+ * enum Foo {
+ *   Value2,
+ * }
+ * ```
+ *
+ * Unfortunately, this design decision means that local enums will essentially turn into global
+ * variables. This plugin removes this behavior, always making enums local variables.
+ */
+
+import * as ts from "typescript";
+import * as tstl from "typescript-to-lua";
+
+const plugin: tstl.Plugin = {
+  visitors: {
+    [ts.SyntaxKind.EnumDeclaration]: (node, context) => {
+      // Call the normal TSTL enum transpilation method
+      const statements = context.superTransformStatements(node);
+
+      // Get the first element, which will be equal to something like:
+      // local ____exports.Foo = Foo or ({})
+      const oldDeclaration = statements[0];
+      if (
+        oldDeclaration !== undefined &&
+        tstl.isAssignmentStatement(oldDeclaration)
+      ) {
+        // Replace the right side of the assignment with a blank Lua table, e.g.
+        // local ____exports.Foo = {}
+        const blankTable = tstl.createTableExpression();
+        oldDeclaration.right = [blankTable];
+      }
+
+      return statements;
+    },
+  },
+};
+
+export default plugin;

package/file-templates/static/publish.sh

@@ -0,0 +1,10 @@
+#!/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 isaacscript publish "$@"

package/file-templates/static/run.sh

@@ -0,0 +1,10 @@
+#!/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 isaacscript

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

@@ -0,0 +1,10 @@
+// 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";
+
+main();
+
+// Do not add any code to this file!

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

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

package/file-templates/static/tsconfig.json

@@ -0,0 +1,33 @@
+// The configuration file for TypeScript.
+{
+  // 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.
+    "rootDir": "./src",
+  },
+
+  // A list of the TypeScript files to compile.
+  "include": ["./src/**/*.ts"],
+
+  // TypeScriptToLua settings.
+  "tstl": {
+    "luaTarget": "5.3",
+    "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.
+      { "name": "./plugins/addIsaacScriptCommentHeader.ts" },
+
+      // 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.
+      // { "name": "./plugins/addCrashDebugStatements.ts" },
+    ],
+  },
+}

package/file-templates/static/update.sh

@@ -0,0 +1,21 @@
+#!/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
+  if test -f "$DIR/yarn.lock"; then
+    yarn
+  else
+    npm install
+  fi
+fi

package/file-templates/static-alt/.prettierignore-base

@@ -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/file-templates/static-alt/.prettierrc-base.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/file-templates/static-alt/.vscode/extensions-typescript.json

@@ -0,0 +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
+{
+  "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/file-templates/static-alt/.vscode/settings-typescript.json

@@ -0,0 +1,66 @@
+// 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,
+
+  // We want to always use "lf" to be consistent with all platforms.
+  "files.eol": "\n",
+
+  // 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/file-templates/static-alt/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/isaacscript-watcher/.luacheckrc

@@ -0,0 +1,96 @@
+-- These are all of the declarations in the "enums.lua" file in the "scripts" subdirectory,
+-- sorted alphabetically
+globals = {
+  "ActionTriggers",
+  "BabySubType",
+  "BombSubType",
+  "BombVariant",
+  "ButtonAction",
+  "CacheFlag",
+  "Card",
+  "Challenge",
+  "ChestSubType",
+  "CoinSubType",
+  "CollectibleType",
+  "Color",
+  "DamageFlag",
+  "Difficulty",
+  "Direction",
+  "DoorSlot",
+  "DoorState",
+  "DoorVariant",
+  "EffectVariant",
+  "EntityCollisionClass",
+  "EntityFlag",
+  "EntityGridCollisionClass",
+  "EntityPartition",
+  "EntityPtr",
+  "EntityRef",
+  "EntityType",
+  "FamiliarVariant",
+  "Font",
+  "Game",
+  "GameStateFlag",
+  "GetPtrHash",
+  "GridCollisionClass",
+  "GridEntityType",
+  "GridRooms",
+  "HeartSubType",
+  "Input",
+  "InputHook",
+  "Isaac",
+  "ItemConfig",
+  "ItemPoolType",
+  "ItemType",
+  "KColor",
+  "Keyboard",
+  "KeySubType",
+  "LaserOffset",
+  "LevelCurse",
+  "LevelStage",
+  "LevelStateFlag",
+  "LocustSubtypes",
+  "ModCallbacks",
+  "Mouse",
+  "Music",
+  "MusicManager",
+  "NpcState",
+  "NullItemID",
+  "PickupPrice",
+  "PickupVariant",
+  "PillColor",
+  "PillEffect",
+  "PlayerForm",
+  "PlayerItemState",
+  "PlayerSpriteLayer",
+  "PlayerType",
+  "ProjectileFlags",
+  "ProjectileParams",
+  "ProjectileVariant",
+  "Random",
+  "RandomVector",
+  "RegisterMod",
+  "RNG",
+  "RoomShape",
+  "RoomType",
+  "SeedEffect",
+  "SFXManager",
+  "SortingLayer",
+  "SoundEffect",
+  "Sprite",
+  "StageType",
+  "TearFlags",
+  "TearVariant",
+  "TrinketType",
+  "Vector",
+  "WeaponType",
+
+  -- Global variables
+  "ModConfigMenu",
+}
+
+max_line_length = 100
+
+-- Luacheck complains about functions in a module declared with a colon if self is unused;
+-- we may want all functions to be declared with a colon for uniformity
+unused_args = false

package/isaacscript-watcher/README.md

@@ -0,0 +1,8 @@
+# isaacscript-watcher
+
+`isaacscript-watcher` is a Lua mod that listens for messages from `IsaacScript`.
+
+It can:
+
+- print messages to the screen
+- execute console commands