isaacscript 2.16.0 → 2.16.1

package/file-templates/static/tsconfig.json

@@ -26,7 +26,7 @@
       { "name": "isaacscript/src/plugins/addIsaacScriptCommentHeader.js" },
 
       // A plugin to make enums safe from global variables.
-      { "name": "isaacscript/src/plugins/noExtendedEnums.ts" },
+      { "name": "isaacscript/src/plugins/noExtendedEnums.js" },
 
       // 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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript",
-  "version": "2.16.0",
+  "version": "2.16.1",
   "description": "A command line tool for managing Isaac mods written in TypeScript.",
   "keywords": [
     "isaac",

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

@@ -1,40 +0,0 @@
-/**
- * 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

@@ -1,37 +0,0 @@
-/** 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

@@ -1,69 +0,0 @@
-/**
- * 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;