isaacscript 2.20.0 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -18,5 +18,5 @@ If you are a developer, or the mod is not yet uploaded to the Steam Workshop, yo
18
18
  - Unzip the zip file to a new directory.
19
19
  - 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.
20
20
  - The script might ask you some questions, like which save file that you use for testing.
21
- - 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.)
21
+ - 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.)
22
22
  - 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.
@@ -17,7 +17,7 @@
17
17
  "isaacscript-common": "^0.0.1",
18
18
  "isaacscript-lint": "^0.0.1",
19
19
  "isaacscript-spell": "^0.0.1",
20
- "typescript": "4.7.4",
20
+ "typescript": "^0.0.1",
21
21
  "typescript-to-lua": "^0.0.1"
22
22
  }
23
23
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "isaacscript",
3
- "version": "2.20.0",
3
+ "version": "3.0.0",
4
4
  "description": "A command line tool for managing Isaac mods written in TypeScript.",
5
5
  "keywords": [
6
6
  "isaac",
@@ -37,13 +37,13 @@
37
37
  "isaacscript-tsconfig": "^2.0.0",
38
38
  "jsonc-parser": "^3.2.0",
39
39
  "moment": "^2.29.4",
40
- "npm-check-updates": "^16.0.6",
40
+ "npm-check-updates": "^16.1.0",
41
41
  "prompt": "^1.3.0",
42
42
  "source-map": "^0.7.4",
43
43
  "source-map-support": "^0.5.21",
44
44
  "sync-directory": "^5.1.7",
45
45
  "tslib": "^2.4.0",
46
- "typescript-to-lua": "^1.9.0",
46
+ "typescript-to-lua": "^1.10.0",
47
47
  "update-notifier": "5.1.0",
48
48
  "xml2js": "^0.4.23",
49
49
  "yaml": "^2.1.1",
@@ -4,12 +4,27 @@
4
4
  "definitions": {
5
5
  "Config": {
6
6
  "additionalProperties": false,
7
- "description": "The mandatory properties must be explicitly validated in `configFile.ts`.",
7
+ "description": "This is the format for the \"isaacscript.json\" file.",
8
8
  "properties": {
9
+ "$schema": {
10
+ "type": "string"
11
+ },
12
+ "modsDirectory": {
13
+ "description": "The \"mods\" directory that lives next to the \"isaac-ng.exe\" program.",
14
+ "type": "string"
15
+ },
16
+ "saveSlot": {
17
+ "description": "The save slot that you test your mod on.",
18
+ "type": "number"
19
+ },
9
20
  "customTargetModDirectoryName": {
10
21
  "description": "By default, the target mod directory name will be the same as the project directory name. This setting allows you to customize it.",
11
22
  "type": "string"
12
23
  },
24
+ "steamCmdPath": {
25
+ "description": "The path to \"steamcmd.exe\". This is optional and only needed for automating publishing.",
26
+ "type": "string"
27
+ },
13
28
  "enableIsaacScriptWatcherAutoRestart": {
14
29
  "description": "When your code is recompiled, IsaacScript watcher can restart the game to ensure that any run-related variables are properly reset. This is set to true by default.",
15
30
  "type": "boolean"
@@ -17,10 +32,6 @@
17
32
  "isaacScriptCommonDev": {
18
33
  "description": "If set to true, the IsaacScript watcher will spawn an additional watcher process for the files in the `isaacscript-common` directory. (It assumes that you have `isaacscript-common` linked to a forked development repository.)",
19
34
  "type": "boolean"
20
- },
21
- "steamCmdPath": {
22
- "description": "The path to \"steamcmd.exe\". This is optional and only needed for automating publishing.",
23
- "type": "string"
24
35
  }
25
36
  },
26
37
  "type": "object"
@@ -1,7 +1,8 @@
1
1
  "use strict";
2
+ // Note that all mandatory properties must be explicitly validated in `configFile.ts`.
2
3
  Object.defineProperty(exports, "__esModule", { value: true });
3
4
  exports.Config = void 0;
4
- /** The mandatory properties must be explicitly validated in `configFile.ts`. */
5
+ /** This is the format for the "isaacscript.json" file. */
5
6
  class Config {
6
7
  constructor(modsDirectory, saveSlot, isaacScriptCommonDev) {
7
8
  this.$schema = "https://raw.githubusercontent.com/IsaacScript/isaacscript/main/packages/isaacscript-cli/schemas/isaacscript-schema.json";
@@ -1 +1 @@
1
- {"version":3,"file":"Config.js","sourceRoot":"","sources":["../../../../../packages/isaacscript-cli/src/classes/Config.ts"],"names":[],"mappings":";;;AAAA,gFAAgF;AAChF,MAAa,MAAM;IAiCjB,YACE,aAAsB,EACtB,QAAiB,EACjB,oBAA8B;QAnChC,YAAO,GACL,yHAAyH,CAAC;QAE5H,0EAA0E;QAC1E,kBAAa,GACX,uFAAuF,CAAC;QAE1F,+CAA+C;QAC/C,aAAQ,GAAG,CAAC,CAAC;QA6BX,IAAI,aAAa,KAAK,SAAS,EAAE;YAC/B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;SACpC;QAED,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC1B;QAED,IAAI,oBAAoB,KAAK,SAAS,EAAE;YACtC,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;SAClD;IACH,CAAC;CACF;AAlDD,wBAkDC"}
1
+ {"version":3,"file":"Config.js","sourceRoot":"","sources":["../../../../../packages/isaacscript-cli/src/classes/Config.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,0DAA0D;AAC1D,MAAa,MAAM;IAiCjB,YACE,aAAsB,EACtB,QAAiB,EACjB,oBAA8B;QAnChC,YAAO,GACL,yHAAyH,CAAC;QAE5H,0EAA0E;QAC1E,kBAAa,GACX,uFAAuF,CAAC;QAE1F,+CAA+C;QAC/C,aAAQ,GAAG,CAAC,CAAC;QA6BX,IAAI,aAAa,KAAK,SAAS,EAAE;YAC/B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;SACpC;QAED,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC1B;QAED,IAAI,oBAAoB,KAAK,SAAS,EAAE;YACtC,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;SAClD;IACH,CAAC;CACF;AAlDD,wBAkDC"}