isaacscript 2.0.11-alpha.2 → 2.0.12

package/README.md

@@ -1,11 +1,9 @@
 # isaacscript-cli
 
-This library was generated with [Nx](https://nx.dev).
+[![npm version](https://img.shields.io/npm/v/isaacscript.svg)](https://www.npmjs.com/package/isaacscript)
 
-## Building
+IsaacScript is a tool to help you create _Binding of Isaac: Repentance_ mods using [TypeScript](https://www.typescriptlang.org/).
 
-Run `nx build isaacscript-cli` to build the library.
+Please visit the [official website](https://isaacscript.github.io/) for more information.
 
-## Running unit tests
-
-Run `nx test isaacscript-cli` to execute the unit tests via [Jest](https://jestjs.io).
+This package contains the command-line tool that initializes new mods and monitors the current project. (The binary is called `isaacscript`, not `isaacscript-cli`. The package is named `isaacscript-cli` to disambiguate it from the other projects in this monorepo.)

package/file-templates/dynamic/README.md

@@ -0,0 +1,3 @@
+# 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.

package/file-templates/dynamic/gitignore

@@ -0,0 +1,147 @@
+# Per-user IsaacScript settings
+isaacscript.json
+
+# The transpiled Lua output
+mod/main.lua
+
+# Windows artifacts
+thumbs.db
+
+# MacOS artifacts
+.DS_Store
+
+# ------------------------------
+# GitHub Node.gitignore template
+# https://raw.githubusercontent.com/github/gitignore/master/Node.gitignore
+# ------------------------------
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

package/file-templates/dynamic/main.ts

@@ -0,0 +1,19 @@
+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.
+  const mod = RegisterMod(MOD_NAME, 1);
+
+  // 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.
+  Isaac.DebugString(`${MOD_NAME} initialized.`);
+}
+
+function postGameStarted() {
+  Isaac.DebugString("Callback triggered: MC_POST_GAME_STARTED");
+}

package/file-templates/dynamic/metadata.vdf

@@ -0,0 +1,6 @@
+"workshopitem"
+{
+  "appid" "250900"
+  "publishedfileid" ""
+  "contentfolder" "MOD-TARGET-DIR"
+}

package/file-templates/dynamic/metadata.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<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>
+  <version>1.0</version>
+  <visibility />
+</metadata>

package/file-templates/dynamic/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "MOD-NAME-TO-REPLACE",
+  "version": "0.0.1",
+  "description": "A mod for The Binding of Isaac: Repentance",
+  "keywords": [
+    "isaac",
+    "mod",
+    "rebirth",
+    "afterbirth",
+    "repentance"
+  ],
+  "license": "GPL-3.0",
+  "dependencies": {
+    "isaac-typescript-definitions": "^0.0.1",
+    "isaacscript": "^0.0.1",
+    "isaacscript-common": "^0.0.1",
+    "isaacscript-lint": "^0.0.1",
+    "isaacscript-spell": "^0.0.1"
+  }
+}

package/file-templates/static/.env_template

@@ -0,0 +1,2 @@
+STEAM_USERNAME=""
+STEAM_PASSWORD=""

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

@@ -0,0 +1,24 @@
+// 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
+     */
+    "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.
+     */
+    project: "./tsconfig.eslint.json",
+  },
+
+  rules: {
+    // Insert changed or disabled rules here, if necessary.
+  },
+};

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

@@ -0,0 +1,54 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build_and_lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v3
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          # The default version is 14. The ESLint config requires Node 16 to work properly.
+          node-version: "16"
+          cache: "npm"
+
+      - 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-lock.json') }}
+
+      - name: Install dependencies (if the cached directory was not found)
+        if: steps.node-cache.outputs.cache-hit != 'true'
+        run: npm ci
+
+      - name: Install xmllint (which the "lint.sh" script uses)
+        run: sudo apt-get update && sudo apt-get install libxml2-utils -y
+
+      - name: Test to see if the project compiles
+        run: bash build.sh
+
+      - name: Perform automated checks
+        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.
+
+  #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.
+  #  runs-on: ubuntu-latest
+  #  steps:
+  #    - uses: technote-space/workflow-conclusion-action@v2
+  #    - if: env.WORKFLOW_CONCLUSION != 'success' && env.WORKFLOW_CONCLUSION != 'cancelled'
+  #      uses: sarisia/actions-status-discord@v1
+  #      with:
+  #        webhook: ${{ secrets.DISCORD_WEBHOOK }}
+  #        status: ${{ env.WORKFLOW_CONCLUSION }}
+  #        title: ""

package/file-templates/static/.prettierignore

@@ -0,0 +1,14 @@
+# 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

@@ -0,0 +1,42 @@
+// 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",
+      },
+    },
+    {
+      files: ["**/*.xml"],
+      options: {
+        printWidth: 1000000,
+      },
+    },
+  ],
+
+  // Allow proper formatting of XML files:
+  // https://github.com/prettier/plugin-xml#configuration
+  // The default is "struct". However, whitespace cannot be reformatted unless this is set to
+  // "ignore".
+  xmlWhitespaceSensitivity: "ignore",
+};

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

@@ -0,0 +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
+{
+  "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

@@ -0,0 +1,79 @@
+// 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,
+
+  "files.associations": {
+    "*.anm2": "xml", // anm2 files are just XML files
+    "*.dat": "json", // Nearly all mods save JSON to the "save#.dat" file
+  },
+
+  // 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": {
+    "**/*.png": true,
+    "**/*.wav": true,
+    "dist/**/*.ts": true,
+    "dist/**/*.js": true,
+    "dist/**/*.json": true,
+    "dist/**/*.lua": 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,
+  },
+  "[xml]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+  },
+  "[markdown]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.tabSize": 2,
+  },
+}