isaacscript 3.15.3 → 3.16.1-dev.0

package/dist/packageManager.js

@@ -0,0 +1,68 @@
+import chalk from "chalk";
+import commandExists from "command-exists";
+import { PackageManager, fatalError, getPackageManagerLockFileName, getPackageManagersForProject, } from "isaacscript-common-node";
+import { CWD } from "./constants.js";
+export const PACKAGE_MANAGER_USED_FOR_ISAACSCRIPT = PackageManager.yarn;
+export function getPackageManagerUsedForNewProject(args) {
+    const packageManagerFromArgs = getPackageManagerFromArgs(args);
+    if (packageManagerFromArgs !== undefined) {
+        return packageManagerFromArgs;
+    }
+    if (commandExists.sync("yarn")) {
+        return PackageManager.yarn;
+    }
+    if (commandExists.sync("pnpm")) {
+        return PackageManager.pnpm;
+    }
+    return PackageManager.npm;
+}
+export function getPackageManagerUsedForExistingProject(args) {
+    const packageManagers = getPackageManagersForProject(CWD);
+    if (packageManagers.length > 1) {
+        const packageManagerLockFileNames = packageManagers
+            .map((packageManager) => getPackageManagerLockFileName(packageManager))
+            .map((packageManagerLockFileName) => `"${packageManagerLockFileName}"`)
+            .join(" & ");
+        fatalError(`Multiple different kinds of package manager lock files were found (${packageManagerLockFileNames}). You should delete the ones that you are not using so that this program can correctly detect your package manager.`);
+    }
+    const packageManager = packageManagers[0];
+    if (packageManager !== undefined) {
+        return packageManager;
+    }
+    return getPackageManagerUsedForNewProject(args);
+}
+function getPackageManagerFromArgs(args) {
+    const dev = args.dev === true;
+    if (dev) {
+        const packageManagerCommandExists = commandExists.sync(PACKAGE_MANAGER_USED_FOR_ISAACSCRIPT);
+        if (!packageManagerCommandExists) {
+            fatalError(`You specified the "dev" flag, but "${chalk.green(PACKAGE_MANAGER_USED_FOR_ISAACSCRIPT)}" does not seem to be a valid command. The IsaacScript monorepo uses ${PACKAGE_MANAGER_USED_FOR_ISAACSCRIPT}, so in order to initiate a linked development mod, you must also have ${PACKAGE_MANAGER_USED_FOR_ISAACSCRIPT} installed. Try running "corepack enable" to install it.`);
+        }
+        return PACKAGE_MANAGER_USED_FOR_ISAACSCRIPT;
+    }
+    const npm = args.npm === true;
+    if (npm) {
+        const npmExists = commandExists.sync("npm");
+        if (!npmExists) {
+            fatalError(`You specified the "--npm" flag, but "${chalk.green("npm")}" does not seem to be a valid command.`);
+        }
+        return PackageManager.npm;
+    }
+    const yarn = args.yarn === true;
+    if (yarn) {
+        const yarnExists = commandExists.sync("yarn");
+        if (!yarnExists) {
+            fatalError(`You specified the "--yarn" flag, but "${chalk.green("yarn")}" does not seem to be a valid command.`);
+        }
+        return PackageManager.yarn;
+    }
+    const pnpm = args.pnpm === true;
+    if (pnpm) {
+        const pnpmExists = commandExists.sync("pnpm");
+        if (!pnpmExists) {
+            fatalError(`You specified the "--pnpm" flag, but "${chalk.green("pnpm")}" does not seem to be a valid command.`);
+        }
+        return PackageManager.pnpm;
+    }
+    return undefined;
+}

package/{src → dist}/parseArgs.js

@@ -1,15 +1,29 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseArgs = void 0;
-const tslib_1 = require("tslib");
-const yargs_1 = tslib_1.__importDefault(require("yargs"));
-const constants_js_1 = require("./constants.js");
+// Other potential args libraries:
+// - util.parseArgs
+//   - https://nodejs.org/api/util.html#utilparseargsconfig
+//   - Too bare bones; does not support numbers.
+// - arg (1.2K stars)
+//   - https://github.com/vercel/arg
+//   - Does not support commands (i.e. positional arguments).
+// - cmd-ts (193 stars)
+//   - https://github.com/Schniz/cmd-ts
+//   - ?
+// - clack (4.3K stars)
+//   - https://github.com/natemoo-re/clack
+//   - ?
+// - commander (25.4K stars)
+//   - https://github.com/tj/commander.js
+//   - ?
+import { getArgs } from "isaacscript-common-node";
+import yargs from "yargs";
+import { PROJECT_NAME } from "./constants.js";
 /** Parse command-line arguments. */
-function parseArgs() {
-    const yargsObject = (0, yargs_1.default)(process.argv.slice(2))
+export function parseArgs() {
+    const args = getArgs();
+    const yargsObject = yargs(args)
         .strict()
-        .usage(`usage: ${constants_js_1.PROJECT_NAME.toLowerCase()} <command> [options]`)
-        .scriptName(constants_js_1.PROJECT_NAME.toLowerCase())
+        .usage(`usage: ${PROJECT_NAME.toLowerCase()} <command> [options]`)
+        .scriptName(PROJECT_NAME.toLowerCase())
         .alias("h", "help") // By default, only "--help" is enabled.
         .alias("V", "version") // By default, only "--version" is enabled.
         .command("monitor", "Monitor a project for changes. (default)", (builder) => builder
@@ -38,7 +52,7 @@ function parseArgs() {
         type: "boolean",
         description: "Enable verbose output",
     }))
-        .command("init [name]", `Initialize a new ${constants_js_1.PROJECT_NAME} mod.`, (builder) => builder
+        .command("init [name]", `Initialize a new ${PROJECT_NAME} mod.`, (builder) => builder
         .option("yes", {
         alias: "y",
         type: "boolean",
@@ -100,7 +114,7 @@ function parseArgs() {
         type: "boolean",
         description: "Enable verbose output",
     }))
-        .command("init-ts [name]", `Initialize a new ${constants_js_1.PROJECT_NAME} TypeScript project.`, (builder) => builder
+        .command("init-ts [name]", `Initialize a new ${PROJECT_NAME} TypeScript project.`, (builder) => builder
         .option("yes", {
         alias: "y",
         type: "boolean",
@@ -219,6 +233,10 @@ function parseArgs() {
         .option("skip-lint", {
         type: "boolean",
         description: "Skip linting before publishing",
+    })
+        .option("otp", {
+        type: "boolean",
+        description: "Provide a two-factor OTP code tied to the npm account",
     })
         .option("verbose", {
         alias: "v",
@@ -247,7 +265,12 @@ function parseArgs() {
         type: "boolean",
         description: "Enable verbose output",
     }))
-        .command("check-cspell", 'Check the "cspell.json" file to see if any unused words exist.', (builder) => builder.option("verbose", {
+        .command("update", "Update the dependencies in the current project.", (builder) => builder.option("verbose", {
+        alias: "v",
+        type: "boolean",
+        description: "Enable verbose output",
+    }))
+        .command("nuke", "Delete and reinstall the dependencies in the current project.", (builder) => builder.option("verbose", {
         alias: "v",
         type: "boolean",
         description: "Enable verbose output",
@@ -255,5 +278,3 @@ function parseArgs() {
         .parseSync();
     return yargsObject;
 }
-exports.parseArgs = parseArgs;
-//# sourceMappingURL=parseArgs.js.map

package/dist/prompt.js

@@ -0,0 +1,79 @@
+// Both the Inquirer.js library and the Prompts library have a bug where text is duplicated in a Git
+// Bash terminal. Thus, we revert to using the simpler Prompt library.
+import chalk from "chalk";
+import { fatalError } from "isaacscript-common-node";
+import { ReadonlySet, parseIntSafe } from "isaacscript-common-ts";
+import prompt from "prompt";
+const VALID_YES_RESPONSES = new ReadonlySet(["yes", "ye", "y"]);
+const VALID_NO_RESPONSES = new ReadonlySet(["no", "n"]);
+export function promptInit() {
+    // Override some of the prompt library's default values:
+    // https://github.com/flatiron/prompt#customizing-your-prompt
+    prompt.message = chalk.green("?");
+    prompt.delimiter = " ";
+    prompt.colors = false;
+}
+export async function getInputYesNo(msg, defaultValue = true) {
+    prompt.start();
+    // Capitalize the letter that represents the default option.
+    const y = defaultValue ? "Y" : "y";
+    const n = defaultValue ? "n" : "N";
+    const questionSuffix = `(${y}\\${n})`;
+    const description = `${chalk.bold(msg)} ${chalk.gray(questionSuffix)}`;
+    const { response } = await prompt.get({
+        properties: {
+            response: {
+                type: "string",
+                description,
+            },
+        },
+    });
+    if (typeof response !== "string") {
+        console.log(typeof response);
+        fatalError("Failed to get a proper response from the prompt library.");
+    }
+    const cleanedResponse = response.toLowerCase().trim();
+    // Default to true.
+    if (cleanedResponse === "") {
+        return defaultValue;
+    }
+    if (VALID_YES_RESPONSES.has(cleanedResponse)) {
+        return true;
+    }
+    if (VALID_NO_RESPONSES.has(cleanedResponse)) {
+        return false;
+    }
+    fatalError('Invalid response; must answer "yes" or "no".');
+}
+/** Returns trimmed input. */
+export async function getInputString(msg, defaultValue) {
+    prompt.start();
+    let description = `${chalk.bold(msg)}`;
+    if (defaultValue !== undefined) {
+        description += ` ${chalk.gray(`(${defaultValue})`)}`;
+    }
+    const { response } = await prompt.get({
+        properties: {
+            response: {
+                type: "string",
+                description,
+            },
+        },
+    });
+    if (typeof response !== "string") {
+        fatalError("Failed to get a proper response from the prompt library.");
+    }
+    if (response === "" && defaultValue !== undefined) {
+        return defaultValue;
+    }
+    return response.trim();
+}
+export async function getInputInt(msg, defaultValue = 1) {
+    const defaultValueString = defaultValue.toString();
+    const string = await getInputString(msg, defaultValueString);
+    const int = parseIntSafe(string);
+    if (int === undefined) {
+        fatalError("Error: You must enter an integer.");
+    }
+    return int;
+}

package/dist/tsconfig.js

@@ -0,0 +1,98 @@
+import ajvModule from "ajv";
+import chalk from "chalk";
+import { TSCONFIG_JSON, fatalError, getJSONC } from "isaacscript-common-node";
+import { isObject } from "isaacscript-common-ts";
+import { ISAACSCRIPT_SCHEMA_PATH, PROJECT_NAME, TSCONFIG_JSON_PATH, } from "./constants.js";
+const ADVICE = `Try copying the "${TSCONFIG_JSON}" from a brand new ${PROJECT_NAME} project.`;
+const isaacScriptSchema = getJSONC(ISAACSCRIPT_SCHEMA_PATH);
+// Ajv is messed up: https://github.com/ajv-validator/ajv/issues/2132
+const Ajv = ajvModule.default;
+const ajv = new Ajv();
+const schemaValidate = ajv.compile(isaacScriptSchema);
+function getTSConfigJSON() {
+    return getJSONC(TSCONFIG_JSON_PATH);
+}
+function getIsaacScriptSection() {
+    const tsConfig = getTSConfigJSON();
+    // We allow different kinds of casing for the field name.
+    for (const fieldName of ["isaacscript", "isaacScript", "IsaacScript"]) {
+        const field = tsConfig[fieldName];
+        if (field !== undefined) {
+            if (!isObject(field)) {
+                fatalError(`Your "${chalk.green(TSCONFIG_JSON_PATH)}" file has a non-object value for the "${fieldName}" field, which is surely a mistake. ${ADVICE}`);
+            }
+            return field;
+        }
+    }
+    return undefined;
+}
+export function getFirstTSConfigIncludePath() {
+    const tsConfig = getTSConfigJSON();
+    const { include } = tsConfig;
+    if (include === undefined) {
+        fatalError(`Your "${chalk.green(TSCONFIG_JSON_PATH)}" file does not have an "include" field, which is surely a mistake. ${ADVICE}`);
+    }
+    if (!Array.isArray(include)) {
+        fatalError(`Your "${chalk.green(TSCONFIG_JSON_PATH)}" file has an "include" field that is not an array, which is surely a mistake. ${ADVICE}`);
+    }
+    const firstInclude = include[0];
+    if (firstInclude === undefined) {
+        fatalError(`Your "${chalk.green(TSCONFIG_JSON_PATH)}" file has an empty "include" field, which is surely a mistake. ${ADVICE}`);
+    }
+    if (typeof firstInclude !== "string") {
+        fatalError(`Your "${chalk.green(TSCONFIG_JSON_PATH)}" file has a non-string "include" value, which is surely a mistake. ${ADVICE}`);
+    }
+    return firstInclude;
+}
+/**
+ * Parses the "tsconfig.json" file and returns the "customStages" section. If the section does not
+ * exist, returns an empty array.
+ *
+ * Most of this function is simply performing input validation.
+ */
+export function getCustomStagesFromTSConfig() {
+    const isaacScriptSection = getIsaacScriptSection();
+    if (isaacScriptSection === undefined) {
+        return [];
+    }
+    const valid = schemaValidate(isaacScriptSection);
+    if (!valid) {
+        console.error('Your "isaacscript" section in the "tsconfig.json" file has the following errors:');
+        console.error(schemaValidate.errors);
+        fatalError("For more information, see the custom stages documentation on the website.");
+    }
+    // "customStages" is an optional field.
+    const { customStages } = isaacScriptSection;
+    if (customStages === undefined) {
+        return [];
+    }
+    // The type of "customStages" should be validated by Ajv, but check again just in case.
+    if (!Array.isArray(customStages)) {
+        fatalError(`Failed to parse the "customStages" field, since it was not an array. ${ADVICE}.`);
+    }
+    // Perform some extra validation that can't be automatically done by Ajv.
+    for (const customStageTSConfig of customStages) {
+        const { name } = customStageTSConfig;
+        if (name === "") {
+            fatalError(chalk.red("One of the custom stages has a blank name, which is not allowed."));
+        }
+        const { xmlPath } = customStageTSConfig;
+        if (xmlPath === "") {
+            fatalError(chalk.red(`The "${name}" custom stage has a blank "xmlPath" field, which is not allowed.`));
+        }
+        const { roomVariantPrefix } = customStageTSConfig;
+        if (roomVariantPrefix < 100 || roomVariantPrefix > 999) {
+            fatalError(chalk.red(`The "${name}" custom stage has an invalid value for the "roomVariantPrefix" field: ${roomVariantPrefix}`));
+        }
+        const { baseStage } = customStageTSConfig;
+        if (baseStage !== undefined && (baseStage < 2 || baseStage > 13)) {
+            fatalError(`The "${name}" custom stage has an invalid value for the "baseStage" field: ${baseStage}`);
+        }
+        const { baseStageType } = customStageTSConfig;
+        if (baseStageType !== undefined &&
+            (baseStageType < 0 || baseStageType > 5)) {
+            fatalError(`The "${name}" custom stage has an invalid value for the "baseStageType" field: ${baseStageType}`);
+        }
+    }
+    return customStages;
+}

package/dist/types/Command.js

@@ -0,0 +1,4 @@
+export const DEFAULT_COMMAND = "monitor";
+export function isIsaacScriptModCommand(command) {
+    return !command.endsWith("-ts");
+}

package/dist/utils.js

@@ -0,0 +1,8 @@
+import moment from "moment";
+import { CURRENT_DIRECTORY_NAME } from "./constants.js";
+export function getModTargetDirectoryName(config) {
+    return config.customTargetModDirectoryName ?? CURRENT_DIRECTORY_NAME;
+}
+export function getTime() {
+    return moment().format("h:mm:ss A"); // e.g. "1:23:45 AM"
+}

package/dist/validateInIsaacScriptProject.js

@@ -0,0 +1,29 @@
+import chalk from "chalk";
+import { PACKAGE_JSON, isDirectory, isFile } from "isaacscript-common-node";
+import path from "node:path";
+import { CWD, PROJECT_NAME } from "./constants.js";
+const FILE_NAMES_TO_CHECK = [PACKAGE_JSON];
+/** We don't check "node_modules" because we might be cloning a fresh IsaacScript project. */
+const SUBDIRECTORY_NAMES_TO_CHECK = ["src", "mod"];
+// Validate that we are in a directory that looks like an IsaacScript project.
+export function validateInIsaacScriptProject() {
+    for (const fileName of FILE_NAMES_TO_CHECK) {
+        const filePath = path.join(CWD, fileName);
+        if (!isFile(filePath)) {
+            errorNotExists(fileName, true);
+        }
+    }
+    for (const subdirectoryName of SUBDIRECTORY_NAMES_TO_CHECK) {
+        const subdirectoryPath = path.join(CWD, subdirectoryName);
+        if (!isDirectory(subdirectoryPath)) {
+            errorNotExists(subdirectoryName, false);
+        }
+    }
+}
+function errorNotExists(dirName, file) {
+    const noun = file ? "file" : "subdirectory";
+    console.error(chalk.red(`It looks like the current working directory is not an ${PROJECT_NAME} project. (There is no "${dirName}" ${noun} here.)`));
+    console.error(`Did you mean to create a new ${PROJECT_NAME} project with "${chalk.green("npx isaacscript init")}"?`);
+    console.error(`If not, then change the current working directory to an ${PROJECT_NAME} project.`);
+    process.exit(1);
+}

package/dist/validateNodeVersion.js

@@ -0,0 +1,20 @@
+import chalk from "chalk";
+import { fatalError } from "isaacscript-common-node";
+import { parseSemanticVersion } from "isaacscript-common-ts";
+import { PROJECT_NAME } from "./constants.js";
+const REQUIRED_NODE_JS_MAJOR_VERSION = 16;
+export function validateNodeVersion() {
+    const { version } = process;
+    const semanticVersion = parseSemanticVersion(version);
+    if (semanticVersion === undefined) {
+        fatalError(`Failed to parse the Node version: ${version}`);
+    }
+    const { majorVersion } = semanticVersion;
+    if (majorVersion >= REQUIRED_NODE_JS_MAJOR_VERSION) {
+        return;
+    }
+    console.error(`Your Node.js version is: ${chalk.red(version)}`);
+    console.error(`${PROJECT_NAME} requires a Node.js version of ${chalk.red(`${REQUIRED_NODE_JS_MAJOR_VERSION}.0.0`)} or greater.`);
+    console.error(`Please upgrade your version of Node.js before using ${PROJECT_NAME}.`);
+    process.exit(1);
+}

package/file-templates/dynamic/.github/workflows/setup/action.yml

@@ -0,0 +1,21 @@
+runs:
+  using: composite
+
+  steps:
+    - name: Setup Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version: lts/*
+        cache: PACKAGE_MANAGER_NAME
+
+    - name: Retrieve the cached "node_modules" directory (if present)
+      uses: actions/cache@v3
+      id: node-modules-cache
+      with:
+        path: node_modules
+        key: client-build-node-modules-${{ hashFiles('PACKAGE_MANAGER_LOCK_FILE_NAME') }}
+
+    - name: Install dependencies (if the cached directory was not found)
+      if: steps.node-modules-cache.outputs.cache-hit != 'true'
+      run: PACKAGE_MANAGER_INSTALL_COMMAND
+      shell: bash # Composite jobs must specify the shell.

package/file-templates/dynamic/.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

package/file-templates/dynamic/README.mod.md

@@ -16,7 +16,8 @@ If you are a developer, or if the mod is not yet uploaded to the Steam Workshop,
   - Click on the "Code" button in the top-right-corner of this page.
   - Click on "Download ZIP".
 - Unzip the zip file to a new directory.
-- Open up the repository folder and double-click on the `run.sh` script. If prompted, choose to open it with Git for Windows. You will see a Git Bash terminal window open.
-- The script might ask you some questions, like which save file that you use for testing.
-- If the script is successful, you will see "Compilation successful." (You can continue to leave the terminal window open; it will monitor for changes in your project, and recompile if necessary.)
+- Open the command prompt (or another shell of your choice).
+- Use the `cd` command to navigate to the place where you unzipped the repository.
+- Use the `npm run start` command to start the IsaacScript watcher.
+- If IsaacScript is successful, you will see "Compilation successful." (You can continue to leave the terminal window open; it will monitor for changes in your project, and recompile if necessary.)
 - Completely close Isaac if it is already open, and then open the game again, and the mod should be in the list of mods. You can now play or test the mod.

package/file-templates/dynamic/_gitignore

@@ -13,7 +13,5 @@ mod/main.lua
 # ------------------------------
 # GitHub Node.gitignore template
 # https://raw.githubusercontent.com/github/gitignore/master/Node.gitignore
-# @template-ts-start
 # cspell:disable
-# @template-ts-end
 # ------------------------------

package/file-templates/dynamic/package.mod.json

@@ -5,6 +5,14 @@
   "keywords": ["isaac", "mod", "rebirth", "afterbirth", "repentance"],
   "license": "GPL-3.0",
   "type": "module",
+  "scripts": {
+    "build": "tstl",
+    "lint": "tsx ./scripts/lint.ts",
+    "nuke": "isaacscript nuke",
+    "start": "isaacscript monitor",
+    "publish": "isaacscript publish",
+    "update": "isaacscript update"
+  },
   "dependencies": {
     "isaac-typescript-definitions": "^0.0.1",
     "isaacscript-common": "^0.0.1"

package/file-templates/dynamic/package.ts.json

@@ -17,7 +17,11 @@
   "files": ["dist", "LICENSE", "package.json", "README.md"],
   "scripts": {
     "build": "rimraf dist && tsc",
-    "start": "PACKAGE_MANAGER run build && node dist/main.js"
+    "lint": "tsx ./scripts/lint.ts",
+    "nuke": "isaacscript nuke",
+    "publish": "isaacscript publish-ts",
+    "start": "PACKAGE_MANAGER run build && node dist/main.js",
+    "update": "isaacscript update"
   },
   "devDependencies": {
     "@types/node": "^0.0.1",

package/file-templates/{dynamic → static}/.github/workflows/ci.yml

@@ -3,47 +3,19 @@ name: CI
 on: [push, pull_request]
 
 jobs:
-  build_and_lint:
+  build:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout the repository
-        uses: actions/checkout@v3
+      - uses: actions/checkout@v3
+      - uses: ./.github/workflows/setup
+      - run: npm run build
 
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: lts/*
-          cache: PACKAGE_MANAGER_NAME
-
-      - name: Retrieve the cached "node_modules" directory (if present)
-        uses: actions/cache@v3
-        id: node-cache
-        with:
-          path: node_modules
-          key: node-modules-${{ runner.os }}-${{ hashFiles('PACKAGE_MANAGER_LOCK_FILE_NAME') }}
-
-      - name: Install dependencies (if the cached directory was not found)
-        if: steps.node-cache.outputs.cache-hit != 'true'
-        run: PACKAGE_MANAGER_INSTALL_COMMAND
-
-      - name: Test to see if the project compiles
-        run: bash build.sh
-
-      - name: Perform automated checks
-        run: bash lint.sh
-
-      # @template-mod-start
-      # To enable publishing in CI, follow the instructions here:
-      # https://github.com/IsaacScript/isaac-steam-workshop-upload
-      # Then, uncomment the lines below.
-      #- name: Upload the mod to Steam Workshop (if this is a release commit)
-      #  uses: IsaacScript/isaac-steam-workshop-upload@v2
-      #  if: "contains(github.event.head_commit.message, 'chore: release') && needs.pr-check.outputs.number != 'null'
-      #  with:
-      #    mod_path: mod
-      #  env:
-      #    CONFIG_VDF_CONTENTS: ${{ secrets.CONFIG_VDF_CONTENTS }}
-      # @template-mod-end
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./.github/workflows/setup
+      - run: npm run lint
 
   # To enable CI failure notifications over Discord:
   # - Right click on a channel in Discord and select "Edit Channel".

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

@@ -0,0 +1,28 @@
+// A TypeScript configuration file, used by project scripts.
+{
+  // We extend the IsaacScript config for Node.js:
+  // https://github.com/IsaacScript/isaacscript/blob/main/packages/isaacscript-tsconfig/tsconfig.node.json
+  "extends": "./packages/isaacscript-tsconfig/tsconfig.node.json",
+
+  // We want to lint every file in this directory. Two entries for each file extension are needed
+  // because TypeScript will exclude files that begin with a period from an asterisk glob by
+  // default.
+  "include": [
+    "./**/*.js",
+    "./**/.*.js",
+    "./**/*.cjs",
+    "./**/.*.cjs",
+    "./**/*.mjs",
+    "./**/.*.mjs",
+    "./**/*.jsx",
+    "./**/.*.jsx",
+    "./**/*.ts",
+    "./**/.*.ts",
+    "./**/*.cts",
+    "./**/.*.cts",
+    "./**/*.mts",
+    "./**/.*.mts",
+    "./**/*.tsx",
+    "./**/.*.tsx",
+  ],
+}

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

@@ -36,7 +36,7 @@
   // Extension settings
   // ------------------
 
-  // Use Prettier to format "cspell.json".
+  // Use Prettier to format "cspell.jsonc".
   "cSpell.autoFormatConfigFile": true,
 
   // -----------------

package/file-templates/static-mod/{_cspell.json → _cspell.jsonc}

@@ -21,7 +21,7 @@
     "node_modules/**",
     "package-lock.json",
     "pnpm-lock.yaml",
-    "yarn.lock"
+    "yarn.lock",
   ],
-  "words": []
+  "words": [],
 }

package/file-templates/static-mod/_eslintrc.cjs

@@ -5,7 +5,7 @@
 const config = {
   extends: [
     // The linter base is the IsaacScript mod config:
-    // https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-config-isaacscript/configs/mod.js
+    // https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-config-isaacscript/mod.js
     "eslint-config-isaacscript/mod",
   ],
 

package/file-templates/static-mod/prettier.config.mjs

@@ -13,7 +13,12 @@ const config = {
     // Allow proper formatting of JSONC files:
     // https://github.com/prettier/prettier/issues/5708
     {
-      files: ["**/.vscode/*.json", "**/tsconfig.json", "**/tsconfig.*.json"],
+      files: [
+        "**/*.jsonc",
+        "**/.vscode/*.json",
+        "**/tsconfig.json",
+        "**/tsconfig.*.json",
+      ],
       options: {
         parser: "json5",
         quoteProps: "preserve",

package/file-templates/static-mod/scripts/lint.ts

@@ -0,0 +1,36 @@
+import { $, $s, commandExists, lintScript } from "isaacscript-common-node";
+
+await lintScript(async () => {
+  const promises: Array<Promise<unknown>> = [];
+
+  promises.push(
+    // Use Prettier to check formatting.
+    // - "--log-level=warn" makes it only output errors.
+    $`npx prettier --log-level=warn --check .`,
+
+    // Type-check the code using the TypeScript compiler.
+    $`tsc --noEmit`,
+
+    // Use ESLint to lint the TypeScript.
+    // - "--max-warnings 0" makes warnings fail, since we set all ESLint errors to warnings.
+    $`eslint --max-warnings 0 .`,
+
+    // Check for unused exports.
+    // -"--error" makes it return an error code of 1 if unused exports are found.
+    $`npx ts-prune --error`,
+
+    // Spell check every file using CSpell.
+    // - "--no-progress" and "--no-summary" make it only output errors.
+    $`npx cspell --no-progress --no-summary .`,
+
+    // Check for unused CSpell words.
+    $`npx cspell-check-unused-words`,
+  );
+
+  if (commandExists("python")) {
+    $s`pip install isaac-xml-validator --upgrade --quiet`;
+    promises.push($`isaac-xml-validator --quiet`);
+  }
+
+  await Promise.all(promises);
+});