isaacscript 3.5.10-dev.4 → 3.5.10-dev.6

package/file-templates/dynamic/.github/workflows/ci.yml

@@ -13,18 +13,18 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: lts/*
-          cache: PACKAGE-MANAGER-NAME
+          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') }}
+          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
+        run: PACKAGE_MANAGER_INSTALL_COMMAND
 
       - name: Test to see if the project compiles
         run: bash build.sh
@@ -32,6 +32,7 @@ jobs:
       - 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.
@@ -40,6 +41,7 @@ jobs:
       #  if: "contains(github.event.head_commit.message, 'chore: release') && github.event_name != 'pull_request'"
       #  env:
       #    CONFIG_VDF_CONTENTS: ${{ secrets.CONFIG_VDF_CONTENTS }}
+      # @template-mod-end
 
   # To enable CI failure notifications over Discord:
   # - Right click on a channel in Discord and select "Edit Channel".
@@ -50,7 +52,10 @@ jobs:
   # - Change the image to: https://github.com/IsaacScript/isaacscript/raw/main/misc/github.png
   # - Click on the "Save Changes" button at the bottom.
   # - Click on the "Copy Webhook URL" button.
-  # - Go to this page: https://github.com/Zamiell/PROJECT-NAME/settings/secrets/actions
+  # - Go to the main page for your repository on GitHub.
+  # - Click on the "Settings" tab near the top.
+  # - Click on "Secrets and variables" in the left menu.
+  # - Click on "Actions" from the dropdown list.
   # - Click on the "New repository secret" button in the top right.
   # - For the "Name" box, use "DISCORD_WEBHOOK" (without the quotes).
   # - For the "Secret" box, paste in the URL that was copied in the "Copy Webhook URL" step.

package/file-templates/dynamic/{README.md → README.mod.md}

@@ -1,6 +1,6 @@
-# MOD-NAME-TO-REPLACE
+# PROJECT-NAME
 
-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.
+PROJECT-NAME 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.
 
 ## How To Play
 

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

@@ -0,0 +1,3 @@
+# PROJECT-NAME
+
+PROJECT-NAME is a [TypeScript](https://www.typescriptlang.org/) project.

package/file-templates/dynamic/gitignore

@@ -1,9 +1,11 @@
+# @template-mod-start
 # Per-user IsaacScript settings
 isaacscript.json
 
 # The transpiled Lua output
 mod/main.lua
 
+# @template-mod-end
 # OS-specific artifacts
 .DS_Store
 thumbs.db

package/file-templates/dynamic/mod/metadata.xml

@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <?xml-model href="https://wofsauge.github.io/isaac-xml-validator/xsd/metadata.xsd" ?>
 <metadata>
-  <name>MOD-NAME-TO-REPLACE</name>
-  <directory>MOD-NAME-TO-REPLACE</directory>
-  <description>MOD-NAME-TO-REPLACE is a currently a work in progress.</description>
+  <name>PROJECT_NAME</name>
+  <directory>PROJECT_NAME</directory>
+  <description>PROJECT_NAME is a currently a work in progress.</description>
   <version>1.0</version>
   <visibility />
 </metadata>

package/file-templates/dynamic/{package.json → package.mod.json}

@@ -1,16 +1,9 @@
 {
-  "name": "MOD-NAME-TO-REPLACE",
+  "name": "PROJECT_NAME",
   "version": "0.0.0",
   "description": "A mod for The Binding of Isaac: Repentance.",
-  "keywords": [
-    "isaac",
-    "mod",
-    "rebirth",
-    "afterbirth",
-    "repentance"
-  ],
+  "keywords": ["isaac", "mod", "rebirth", "afterbirth", "repentance"],
   "license": "GPL-3.0",
-  "author": "AUTHOR-NAME",
   "type": "commonjs",
   "dependencies": {
     "isaac-typescript-definitions": "^0.0.1",
@@ -18,6 +11,7 @@
     "isaacscript-common": "^0.0.1",
     "isaacscript-lint": "^0.0.1",
     "isaacscript-spell": "^0.0.1",
+    "isaacscript-tsconfig": "^0.0.1",
     "typescript": "^0.0.1",
     "typescript-to-lua": "^0.0.1"
   }

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

@@ -0,0 +1,30 @@
+{
+  "name": "PROJECT_NAME",
+  "version": "0.0.0",
+  "description": "",
+  "keywords": [],
+  "homepage": "https://github.com/AUTHOR_NAME/PROJECT_NAME",
+  "bugs": {
+    "url": "https://github.com/AUTHOR_NAME/PROJECT_NAME/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AUTHOR_NAME/PROJECT_NAME.git"
+  },
+  "license": "GPL-3.0",
+  "type": "commonjs",
+  "author": "AUTHOR_NAME",
+  "files": ["dist", "LICENSE", "package.json", "README.md"],
+  "scripts": {
+    "build": "rimraf dist && tsc",
+    "start": "PACKAGE_MANAGER run build && node dist/main.js"
+  },
+  "devDependencies": {
+    "@types/node": "^0.0.1",
+    "isaacscript": "^0.0.1",
+    "isaacscript-lint": "^0.0.1",
+    "isaacscript-tsconfig": "^0.0.1",
+    "rimraf": "^0.0.1",
+    "typescript": "^0.0.1"
+  }
+}

package/file-templates/dynamic/src/main.ts

@@ -1,6 +1,6 @@
 import { ModCallback } from "isaac-typescript-definitions";
 
-const MOD_NAME = "MOD-NAME-TO-REPLACE";
+const MOD_NAME = "PROJECT_NAME";
 
 main();
 

package/file-templates/static/gitattributes

@@ -10,6 +10,7 @@ pull.rebase=true
 
 # Specify the file type for some binary files to prevent Git from changing the line endings upon
 # cloning the repository.
+*.mp3 binary
 *.png binary
 *.wav binary
 

package/file-templates/{static → static-mod}/.eslintrc.template.cjs

@@ -1,5 +1,5 @@
 // This is the configuration file for ESLint, the TypeScript linter:
-// https://eslint.org/docs/latest/user-guide/configuring
+// https://eslint.org/docs/latest/use/configure/
 module.exports = {
   extends: [
     // The linter base is the IsaacScript mod config:

package/file-templates/{static → static-mod}/.prettierrc.cjs

@@ -3,6 +3,7 @@
 
 /** @type {import("prettier").Config} */
 module.exports = {
+  // Always print trailing commas:
   // https://prettier.io/docs/en/options.html#trailing-commas
   // The default is "es5" (only having trailing commas where valid in ES5). However, always having
   // trailing commas is objectively better. The Airbnb style guide agrees:

package/file-templates/{static → static-mod}/.vscode/settings.json

@@ -22,6 +22,7 @@
 
   // Configure glob patterns for excluding files and folders in full text searches and quick open.
   "search.exclude": {
+    "**/*.mp3": true,
     "**/*.png": true,
     "**/*.wav": true,
     "**/dist/": true,

package/file-templates/{static → static-mod}/cspell.template.json

@@ -21,5 +21,14 @@
     "mod/resources/rooms/**",
     "yarn.lock"
   ],
-  "words": []
+  "words": [
+    "autocrlf",
+    "dbaeumer",
+    "esbenp",
+    "isaacscript",
+    "pnpm",
+    "sarisia",
+    "technote",
+    "Zamiell"
+  ]
 }

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

@@ -7,12 +7,6 @@
   // https://github.com/IsaacScript/isaacscript/blob/main/packages/isaacscript-tsconfig/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"],
 

package/file-templates/static-ts/.eslintrc.template.cjs

@@ -0,0 +1,24 @@
+// This is the configuration file for ESLint, the TypeScript linter:
+// https://eslint.org/docs/latest/use/configure/
+module.exports = {
+  extends: [
+    // The linter base is the shared IsaacScript config:
+    // https://github.com/IsaacScript/isaacscript/blob/main/packages/eslint-config-isaacscript/base.js
+    "eslint-config-isaacscript/base",
+  ],
+
+  // The ".prettierrc.cjs" file is ignored by default, so we have to un-ignore it. Additionally, we
+  // don't bother linting the compiled output.
+  ignorePatterns: ["!.prettierrc.cjs", "**/dist/**"],
+
+  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.
+    project: "./tsconfig.eslint.json",
+  },
+
+  rules: {
+    // Insert changed or disabled rules here, if necessary.
+  },
+};

package/file-templates/static-ts/.prettierignore

@@ -0,0 +1,7 @@
+# Compiled output
+dist
+
+# Package manager lock files
+package-lock.json
+yarn.lock
+pnpm-lock.yaml

package/file-templates/{static-alt/.prettierrc-base.cjs → static-ts/.prettierrc.cjs}

@@ -5,8 +5,8 @@
 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:
+  // The default is "es5" (only having trailing commas where valid in ES5). 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

package/file-templates/{static-alt/.vscode/settings-typescript.json → static-ts/.vscode/settings.json}

@@ -8,6 +8,10 @@
   "editor.rulers": [100],
   "editor.tabSize": 2,
 
+  "files.associations": {
+    ".env*": "shellscript", // e.g. ".env.example" is the same as ".env".
+  },
+
   // We want to always use "lf" to be consistent with all platforms.
   "files.eol": "\n",
 
@@ -16,6 +20,9 @@
 
   // Configure glob patterns for excluding files and folders in full text searches and quick open.
   "search.exclude": {
+    "**/*.mp3": true,
+    "**/*.png": true,
+    "**/*.wav": true,
     "**/dist/": true,
     "**/node_modules/": true,
   },
@@ -35,6 +42,10 @@
   "javascript.suggest.completeFunctionCalls": true,
   "typescript.suggest.completeFunctionCalls": true,
 
+  // By default, VSCode will prefer non-relative paths for deeply nested files.
+  "javascript.preferences.importModuleSpecifier": "relative",
+  "typescript.preferences.importModuleSpecifier": "relative",
+
   // Automatically run the formatter when certain files are saved.
   "[javascript]": {
     "editor.codeActionsOnSave": ["source.fixAll.eslint"],
@@ -48,6 +59,18 @@
     "editor.formatOnSave": true,
     "editor.tabSize": 2,
   },
+  "[javascriptreact]": {
+    "editor.codeActionsOnSave": ["source.fixAll.eslint"],
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+  },
+  "[typescriptreact]": {
+    "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,
@@ -68,4 +91,23 @@
     "editor.formatOnSave": true,
     "editor.tabSize": 2,
   },
+  "[html]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+  },
+  "[css]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+  },
+  "[postcss]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+  },
+  "[prisma]": {
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+  },
 }

package/file-templates/static-ts/build.sh

@@ -0,0 +1,43 @@
+#!/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
+
+NPM_LOCK="$DIR/package-lock.json"
+if test -f "$NPM_LOCK"; then
+  NPM_LOCK_EXISTS=1
+fi
+
+YARN_LOCK="$DIR/yarn.lock"
+if test -f "$YARN_LOCK"; then
+  YARN_LOCK_EXISTS=1
+fi
+
+PNPM_LOCK="$DIR/pnpm-lock.yaml"
+if test -f "$PNPM_LOCK"; then
+  PNPM_LOCK_EXISTS=1
+fi
+
+if [[ -z "$NPM_LOCK_EXISTS" && -z "$YARN_LOCK_EXISTS" && -z "$PNPM_LOCK_EXISTS" ]]; then
+  echo "No package manager lock files were found. You should manually invoke the package manager that you want to use for this project. e.g. \"npm install\""
+  exit 1
+elif [[ ! -z "$NPM_LOCK_EXISTS" && -z "$YARN_LOCK_EXISTS" && -z "$PNPM_LOCK_EXISTS" ]]; then
+  PACKAGE_MANAGER="npm"
+elif [[ -z "$NPM_LOCK_EXISTS" && ! -z "$YARN_LOCK_EXISTS" && -z "$PNPM_LOCK_EXISTS" ]]; then
+  PACKAGE_MANAGER="yarn"
+elif [[ -z "$NPM_LOCK_EXISTS" && -z "$YARN_LOCK_EXISTS" && ! -z "$PNPM_LOCK_EXISTS" ]]; then
+  PACKAGE_MANAGER="pnpm"
+else
+  echo "Error: Multiple different kinds of package manager lock files were found. You should manually invoke the package manager that you want to use for this project. e.g. \"npm install\""
+  exit 1
+fi
+
+cd "$DIR"
+"$PACKAGE_MANAGER" run build
+
+echo "Successfully built in $SECONDS seconds."

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

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
+  "version": "0.2",
+  "files": ["**"],
+  "enableFiletypes": ["*"],
+  "enableGlobDot": true,
+  "useGitignore": true,
+  "ignorePaths": [
+    "*.pyc",
+    ".git/**",
+    "dist/**",
+    "node_modules/**",
+    "package-lock.json",
+    "pnpm-lock.yaml",
+    "yarn.lock"
+  ],
+  "words": [
+    "autocrlf",
+    "dbaeumer",
+    "esbenp",
+    "isaacscript",
+    "pnpm",
+    "sarisia",
+    "technote",
+    "Zamiell"
+  ]
+}

package/file-templates/static-ts/lint.sh

@@ -0,0 +1,32 @@
+#!/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"
+
+# Use Prettier to check formatting.
+# "--loglevel warn" makes it only output errors.
+npx prettier --loglevel warn --check .
+
+# Use ESLint to lint the TypeScript.
+# "--max-warnings 0" makes warnings fail in CI, since we set all ESLint errors to warnings.
+npx 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 orphaned words.
+bash "$DIR/check-orphaned-words.sh"
+
+echo "Successfully linted in $SECONDS seconds."

package/file-templates/static-ts/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 --ts "$@"

package/file-templates/static-ts/run.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 )"
+
+NPM_LOCK="$DIR/package-lock.json"
+if test -f "$NPM_LOCK"; then
+  NPM_LOCK_EXISTS=1
+fi
+
+YARN_LOCK="$DIR/yarn.lock"
+if test -f "$YARN_LOCK"; then
+  YARN_LOCK_EXISTS=1
+fi
+
+PNPM_LOCK="$DIR/pnpm-lock.yaml"
+if test -f "$PNPM_LOCK"; then
+  PNPM_LOCK_EXISTS=1
+fi
+
+if [[ -z "$NPM_LOCK_EXISTS" && -z "$YARN_LOCK_EXISTS" && -z "$PNPM_LOCK_EXISTS" ]]; then
+  echo "No package manager lock files were found. You should manually invoke the package manager that you want to use for this project. e.g. \"npm install\""
+  exit 1
+elif [[ ! -z "$NPM_LOCK_EXISTS" && -z "$YARN_LOCK_EXISTS" && -z "$PNPM_LOCK_EXISTS" ]]; then
+  PACKAGE_MANAGER="npm"
+elif [[ -z "$NPM_LOCK_EXISTS" && ! -z "$YARN_LOCK_EXISTS" && -z "$PNPM_LOCK_EXISTS" ]]; then
+  PACKAGE_MANAGER="yarn"
+elif [[ -z "$NPM_LOCK_EXISTS" && -z "$YARN_LOCK_EXISTS" && ! -z "$PNPM_LOCK_EXISTS" ]]; then
+  PACKAGE_MANAGER="pnpm"
+else
+  echo "Error: Multiple different kinds of package manager lock files were found. You should manually invoke the package manager that you want to use for this project. e.g. \"npm install\""
+  exit 1
+fi
+
+cd "$DIR"
+"$PACKAGE_MANAGER" run start

package/file-templates/static-ts/src/main.js

@@ -0,0 +1,4 @@
+"use strict";
+main();
+function main() { }
+//# sourceMappingURL=main.js.map

package/file-templates/static-ts/src/main.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../../../../../../packages/isaacscript-cli/file-templates/static-ts/src/main.ts"],"names":[],"mappings":";AAAA,IAAI,EAAE,CAAC;AAEP,SAAS,IAAI,KAAI,CAAC"}

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

@@ -0,0 +1,3 @@
+main();
+
+function main() {}

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

@@ -0,0 +1,14 @@
+// The configuration file for TypeScript.
+{
+  // We extend the standard IsaacScript config:
+  // https://github.com/IsaacScript/isaacscript/blob/main/packages/isaacscript-tsconfig/tsconfig.node.json
+  "extends": "isaacscript-tsconfig/tsconfig.node.json",
+
+  // https://www.typescriptlang.org/docs/handbook/compiler-options.html
+  "compilerOptions": {
+    "outDir": "./dist",
+  },
+
+  // A list of the TypeScript files to compile.
+  "include": ["./src/**/*.ts"],
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript",
-  "version": "3.5.10-dev.4",
+  "version": "3.5.10-dev.6",
   "description": "A command line tool for managing Isaac mods written in TypeScript.",
   "keywords": [
     "isaac",
@@ -32,8 +32,7 @@
     "figlet": "^1.5.2",
     "git-dirty": "^1.0.2",
     "glob": "^8.1.0",
-    "isaacscript-common-ts": "^7.0.4",
-    "isaacscript-tsconfig": "^3.0.4",
+    "isaacscript-common-ts": "^7.0.6",
     "jsonc-parser": "^3.2.0",
     "klaw-sync": "^6.0.0",
     "moment": "^2.29.4",