@irrelon/battlescript 3.1.4

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../types/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,kCAAkC,CAAC;AACjD,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC"}

package/dist/utils.d.ts

@@ -0,0 +1,3 @@
+export declare const loadFile: (...paths: string[]) => Promise<string>;
+export declare const loadBuffer: (...paths: string[]) => Promise<Buffer<ArrayBufferLike>>;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../utils.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,QAAQ,GAAU,GAAG,OAAO,MAAM,EAAE,oBAEhD,CAAA;AAED,eAAO,MAAM,UAAU,GAAU,GAAG,OAAO,MAAM,EAAE,qCAElD,CAAA"}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@irrelon/battlescript",
+  "version": "3.1.4",
+  "binaryVersion": 7,
+  "description": "BattleScript Lexer, Parser and Compiler",
+  "bin": {
+    "index": "bin/index.js"
+  },
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "compile-grammar-ts": "antlr4ts -visitor ./language/BattleScript.g4 -o ./services/grammar/ts",
+    "build:exports": "npx tsx $(pwd)/scripts/exportGen/index.ts",
+    "build:js": "rollup -c",
+    "build:types": "tsc -p tsconfig.types.json",
+    "build:native-libraries": "tsx ./scripts/compileNativeLibraries.ts",
+    "build": "npm run compile-grammar-ts && npm run build:native-libraries && npm run build:exports && npm run build:js && npm run build:types && yalc push",
+    "test": "NODE_ENV=test jest --coverage",
+    "test-watch": "NODE_ENV=test jest --watch",
+    "compile-ast-test-ts": "tsx ./bin/index.ts toAst ./examples/test.bst ./examples/test.json",
+    "decompile-ast-test-ts": "tsx ./bin/index.js fromAst ./examples/test.json ./examples/test.decompiled.bst",
+    "compile-binary-test-ts": "tsx ./bin/index.js toBinary ./examples/test.bst ./examples/test.bin",
+    "decompile-binary-test-ts": "tsx ./bin/index.ts fromBinary ./examples/test.bin ./examples/test.miniDecompiled.json",
+    "compile-mini-ast-test-ts": "tsx ./bin/index.ts toMiniAst ./examples/test.bst ./examples/test.miniAst.json",
+    "compile-bytecode-test-ts": "tsx ./bin/index.ts toByteCode ./examples/test.bst ./examples/test.bcode.json",
+    "disassemble-bytecode-test-ts": "tsx ./bin/index.ts fromByteCode ./examples/test.bcode.json ./examples/test.bcode.disassembled.txt",
+    "decompile-ast-simple-ts": "tsx ./bin/index.ts fromAst ./examples/simple.json ./examples/simple.decompiled.bst",
+    "compile-ast-complex-literals-ts": "tsx ./bin/index.ts toAst ./examples/complexLiterals.bst ./examples/complexLiterals.json",
+    "decompile-ast-complex-literals-ts": "tsx ./bin/index.ts fromAst ./examples/complexLiterals.json ./examples/complexLiterals.decompiled.bst",
+    "compile-ast-postfix-operator-ts": "tsx ./bin/index.ts toAst ./examples/postfixOperator.bst ./examples/postfixOperator.json",
+    "decompile-ast-postfix-operator-ts": "tsx ./bin/index.ts fromAst ./examples/postfixOperator.json ./examples/postfixOperator.decompiled.bst",
+    "format": "prettier --write \"**/*.bst\"",
+    "format:check": "prettier --check \"**/*.bst\"",
+    "build:plugin": "cd prettier-plugin-battlescript && npm run build"
+  },
+  "files": [
+    "dist",
+    "bin"
+  ],
+  "author": "Irrelon Software Limited",
+  "license": "ISC",
+  "devDependencies": {
+    "@irrelon/path": "^7.0.2",
+    "@rollup/plugin-commonjs": "^28.0.3",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@types/express": "^4.17.21",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.13.11",
+    "@typescript-eslint/eslint-plugin": "^8.19.0",
+    "@typescript-eslint/parser": "^8.19.0",
+    "antlr4ts": "^0.5.0-alpha.4",
+    "antlr4ts-cli": "^0.5.0-alpha.4",
+    "eslint": "^9.17.0",
+    "jest": "^29.7.0",
+    "rollup": "^4.30.0",
+    "rollup-plugin-dts": "^6.1.1",
+    "rollup-plugin-typescript2": "^0.36.0",
+    "rollup-plugin-visualizer": "^5.14.0",
+    "ts-jest": "^29.3.0",
+    "ts-morph": "^25.0.1",
+    "tsx": "^4.19.3",
+    "typescript": "^5.8.2"
+  }
+}

package/readme.md

@@ -0,0 +1,139 @@
+# BattleScript
+
+BattleScript is a programming language designed to allow
+event-driven logic to be executed at runtime inside
+resource-constrained microcontrollers.
+
+It was created to enable custom logic to be implemented
+in the BattleCore Laser Tag system so that new game types,
+IR protocols, comms protocols, and functionality could be
+written and uploaded to the device without needing to
+flash new firmware.
+
+BattleScript logic executes at runtime when events occur
+based on the finite state machine's current state.
+
+You can read, learn, and try out BattleScript at the
+language's home domain: https://battlescript.io
+
+## Compile BattleScript
+
+If you have a BattleScript file and want to compile it, you
+can run the compiler using the npx command line.
+
+### Compile to a JSON AST Tree
+
+This outputs a JSON file containing the Abstract Syntax Tree
+representation of the source code, useful for linting,
+debugging, code cleanup, or modifying source code using
+a structured tree.
+
+> If no output path is specified, the same input file path
+> will be used with a .json extension.
+
+```bash
+npx @irrelon/battlescript toAst <input file path> <output file path>
+```
+
+### Compile to a JSON Mini-AST Tree
+
+This outputs a minified AST JSON file. Minified ASTs are
+useful for inspecting the intermediate stage before binary
+output is generated but where the data is still
+human-readable. This is really only relevant from an
+academic point of view or when debugging the final binary
+output.
+
+> If no output path is specified, the same input file path
+> will be used with a .miniAst.json extension.
+
+```bash
+npx @irrelon/battlescript toMiniAst <input file path> <output file path>
+```
+
+### Compile to a Binary File
+
+This generates a binary representation of the source code
+for use in a BattleCore device or online interpreter. The
+binary representation encodes the source code to an integer
+stream describing operations to execute at a very low level.
+It is not human-readable. If you want a human-readable
+version of the binary, see the decompiler command below.
+
+> If no output path is specified, the same input file path
+> will be used with a .bin extension.
+
+```bash
+npx @irrelon/battlescript toBinary <input file path> <output file path>
+```
+
+## Decompile BattleScript
+
+If you have a binary file and want to convert it back to a mini-ast JSON
+representation, you can do so using the "fromBinary" command.
+
+The decompiled binary is human-readable but is still very
+low-level as most values are encoded or mapped by integer
+index to real data. This is primarily used for ensuring
+that the binary format is operating correctly via automated
+tests.
+
+> If no output path is specified, the same input file path
+> will be used with a .decompiled.json extension.
+
+```bash
+npx @irrelon/battlescript fromBinary <input file path> <output file path>
+```
+
+## Install in Another Project
+
+```bash
+npm i @irrelon/battlescript
+```
+
+Once installed, you can parse and compile BattleScript
+programmatically.
+
+### Compile to a JSON AST Tree
+
+```typescript
+import {fromSourceCodeToFullAst} from "@irrelon/battlescript";
+
+const myCode = `program {
+\tname "Test Program";
+}`;
+
+const ast = fromSourceCodeToFullAst(myCode);
+```
+
+### Compile to a JSON Mini-AST Tree
+
+```typescript
+import type {MiniAstJson} from "@irrelon/battlescript";
+import {fromSourceCodeToMiniAst} from "@irrelon/battlescript";
+
+const myCode = `program {
+\tname "Test Program";
+}`;
+
+const miniAst: MiniAstJson = fromSourceCodeToMiniAst(myCode);
+```
+
+### Compile to a Binary File
+
+```typescript
+import type {MiniAstBinary} from "@irrelon/battlescript";
+import {fromSourceCodeToBinary} from "@irrelon/battlescript";
+
+const myCode = `program {
+\tname "Test Program";
+}`;
+
+const bin: MiniAstBinary = fromSourceCodeToBinary(myCode);
+```
+
+# Irrelon Software Limited
+
+This software was made with ❤️ love by Irrelon
+Software Limited, a company incorporated in the United
+Kingdom.