mlogjs 0.2.0 → 0.3.0-beta.0

package/lib/helpers.d.ts

@@ -1,23 +1,23 @@
-/// <reference path="./kinds.d.ts" />
-
-/**
- * Allows getting unlisted processor variables or symbols.
- *
- * Using this method is discouraged because most values are
- * already accessible under the namespaces `Units`, `Blocks`,
- * `Items`, `Liquids`, `ControlKind`, `Vars` and `UnitCommands`.
- *
- * @param key The identifier of the value
- */
-declare function getVar<T>(key: string): T;
-
-/**
- * Gets a building linked to the processor by its name.
- *
- * @param name
- */
-declare function getBuilding<T extends BasicBuilding = AnyBuilding>(
-  name: string
-): T;
-
-declare function concat(...strings: string[]): string;
+/// <reference path="./kinds.d.ts" />
+
+/**
+ * Allows getting unlisted processor variables or symbols.
+ *
+ * Using this method is discouraged because most values are
+ * already accessible under the namespaces `Units`, `Blocks`,
+ * `Items`, `Liquids`, `ControlKind`, `Vars` and `UnitCommands`.
+ *
+ * @param name The identifier of the value
+ */
+declare function getVar<T>(name: string): T;
+
+/**
+ * Gets a building linked to the processor by its name.
+ *
+ * @param name
+ */
+declare function getBuilding<T extends BasicBuilding = AnyBuilding>(
+  name: string
+): T;
+
+declare function concat(...strings: string[]): string;

package/lib/index.d.ts

@@ -1,7 +1,7 @@
-/// <reference path="./eslib/index.d.ts" />
-/// <reference path="./commands.d.ts" />
-/// <reference path="./globals.d.ts" />
-/// <reference path="./helpers.d.ts" />
-/// <reference path="./kinds.d.ts" />
-/// <reference path="./memory.d.ts" />
-/// <reference path="./traits.d.ts" />
+/// <reference path="./eslib/index.d.ts" />
+/// <reference path="./commands.d.ts" />
+/// <reference path="./globals.d.ts" />
+/// <reference path="./helpers.d.ts" />
+/// <reference path="./kinds.d.ts" />
+/// <reference path="./memory.d.ts" />
+/// <reference path="./traits.d.ts" />

package/lib/kinds.d.ts

@@ -1,36 +1,36 @@
-/// <reference path="./traits.d.ts" />
-
-interface BasicUnit
-  extends ItemHolder,
-    Shooting,
-    WithHealth,
-    Rotatable,
-    Spaced,
-    Ranged,
-    Typed<UnitSymbol>,
-    Flagged,
-    Controllable,
-    Nameable {}
-
-interface AnyUnit extends BasicUnit, Boosted {}
-
-interface BasicBuilding
-  extends LiquidHolder,
-    ItemHolder,
-    PowerHolder,
-    WithHealth,
-    WithEffiency,
-    WithTimescale,
-    Rotatable,
-    Spaced,
-    Ranged,
-    Typed<BlockSymbol>,
-    WithEnable,
-    WithConfig {}
-
-interface BasicTurret extends BasicBuilding, Shooting, WithProgress {}
-
-// just to make this future proof
-interface AnyTurret extends BasicTurret {}
-
-interface AnyBuilding extends AnyTurret, Heatable {}
+/// <reference path="./traits.d.ts" />
+
+interface BasicUnit
+  extends ItemHolder,
+    Shooting,
+    WithHealth,
+    Rotatable,
+    Spaced,
+    Ranged,
+    Typed<UnitSymbol>,
+    Flagged,
+    Controllable,
+    Nameable {}
+
+interface AnyUnit extends BasicUnit, Boosted {}
+
+interface BasicBuilding
+  extends LiquidHolder,
+    ItemHolder,
+    PowerHolder,
+    WithHealth,
+    WithEffiency,
+    WithTimescale,
+    Rotatable,
+    Spaced,
+    Ranged,
+    Typed<BlockSymbol>,
+    WithEnable,
+    WithConfig {}
+
+interface BasicTurret extends BasicBuilding, Shooting, WithProgress {}
+
+// just to make this future proof
+interface AnyTurret extends BasicTurret {}
+
+interface AnyBuilding extends AnyTurret, Heatable {}

package/lib/memory.d.ts

@@ -1,17 +1,17 @@
-/// <reference path="./kinds.d.ts" />
-
-type MemoryCapacity = 64 | 512;
-/**
- * A wrapper around memory cells/banks that is compatible with custom types.
- */
-declare class Memory<S extends MemoryCapacity = 64> {
-  constructor(cell: BasicBuilding, size?: S);
-
-  [Symbol.iterator](): IterableIterator<number>;
-  [index: number]: number;
-
-  /**
-   * The practical length of the memory view.
-   */
-  readonly length: S;
-}
+/// <reference path="./kinds.d.ts" />
+
+type MemoryCapacity = 64 | 512;
+/**
+ * Allows you to view and modify the data of memory cells and memory banks.
+ */
+declare class Memory<S extends MemoryCapacity = 64> {
+  constructor(cell: BasicBuilding, size?: S);
+
+  [Symbol.iterator](): IterableIterator<number>;
+  [index: number]: number;
+
+  /**
+   * The practical length of the memory view.
+   */
+  readonly length: S;
+}

package/lib/traits.d.ts

@@ -1,121 +1,141 @@
-import "./globals";
-import "./custom-lib";
-
-type LogicSymbols = typeof Items & typeof Liquids & typeof LAccess;
-
-type WithSymbols<T extends Record<string, unknown>> = T & {
-  readonly [K in keyof (LogicSymbols | T) as LogicSymbols[K]]: T[K];
-};
-
-declare global {
-  type LiquidHolder = WithSymbols<
-    {
-      readonly [L in keyof typeof Liquids]: number;
-    } & {
-      readonly totalLiquids: number;
-      readonly liquidCapacity: number;
-    }
-  >;
-
-  type ItemHolder = WithSymbols<
-    {
-      readonly [I in keyof typeof Items]: number;
-    } & {
-      readonly totalItems: number;
-      readonly firstItem: ItemSymbol | null;
-      readonly itemCapacity: number;
-    }
-  >;
-
-  type PowerHolder = WithSymbols<{
-    readonly totalPower: number;
-    readonly powerCapacity: number;
-    readonly powerNetStored: number;
-    readonly powerNetCapacity: number;
-    readonly powerNetIn: number;
-    readonly powerNetOut: number;
-  }>;
-
-  type Shooting = WithSymbols<{
-    readonly shootX: number;
-    readonly shootY: number;
-    readonly ammo: number;
-    readonly ammoCapacity: number;
-  }>;
-
-  type WithHealth = WithSymbols<{
-    readonly health: number;
-    readonly maxHealth: number;
-    readonly dead: boolean;
-  }>;
-
-  type Heatable = WithSymbols<{
-    readonly heat: number;
-  }>;
-
-  type WithEffiency = WithSymbols<{
-    readonly efficiency: number;
-  }>;
-
-  type WithProgress = WithSymbols<{
-    readonly progress: number;
-  }>;
-
-  type WithTimescale = WithSymbols<{
-    readonly timescale: number;
-  }>;
-
-  type Rotatable = WithSymbols<{
-    readonly rotation: number;
-  }>;
-
-  type Spaced = WithSymbols<{
-    readonly x: number;
-    readonly y: number;
-    readonly size: number;
-  }>;
-
-  type Ranged = WithSymbols<{
-    readonly range: number;
-  }>;
-
-  type Boosted = WithSymbols<{
-    readonly boosting: number;
-  }>;
-
-  type Mining = WithSymbols<{
-    readonly mineX: number;
-    readonly mineY: number;
-    readonly mining: number;
-  }>;
-
-  type Typed<T extends symbol = symbol> = WithSymbols<{
-    readonly type: T;
-  }>;
-  type Flagged = WithSymbols<{
-    readonly flag: number;
-  }>;
-
-  type Controllable = WithSymbols<{
-    readonly controlled: 0 | ControlKind;
-    readonly controller: AnyUnit | BasicBuilding;
-  }>;
-
-  type Nameable = WithSymbols<{
-    readonly name: string | null;
-  }>;
-
-  type PayloadHolder = WithSymbols<{
-    readonly payloadCount: number;
-    readonly payloadType: symbol | null;
-  }>;
-
-  type WithEnable = WithSymbols<{
-    enabled: boolean;
-  }>;
-
-  type WithConfig<T extends symbol | number | null = symbol | null> =
-    WithSymbols<{
-      readonly config: T;
-    }>;
-}
+import "./globals";
+
+type LogicSymbols = typeof Items & typeof Liquids & typeof LAccess;
+
+type WithSymbols<T extends Record<string, unknown>> = T & {
+  readonly [K in keyof (LogicSymbols | T) as LogicSymbols[K]]: T[K];
+};
+
+declare global {
+  interface LiquidHolder
+    extends WithSymbols<
+      {
+        readonly [L in keyof typeof Liquids]: number;
+      } & {
+        readonly totalLiquids: number;
+        readonly liquidCapacity: number;
+      }
+    > {}
+
+  interface ItemHolder
+    extends WithSymbols<
+      {
+        readonly [I in keyof typeof Items]: number;
+      } & {
+        readonly totalItems: number;
+        readonly firstItem: ItemSymbol | null;
+        readonly itemCapacity: number;
+      }
+    > {}
+
+  interface PowerHolder
+    extends WithSymbols<{
+      readonly totalPower: number;
+      readonly powerCapacity: number;
+      readonly powerNetStored: number;
+      readonly powerNetCapacity: number;
+      readonly powerNetIn: number;
+      readonly powerNetOut: number;
+    }> {}
+
+  interface Shooting
+    extends WithSymbols<{
+      readonly shootX: number;
+      readonly shootY: number;
+      readonly ammo: number;
+      readonly ammoCapacity: number;
+    }> {}
+
+  interface WithHealth
+    extends WithSymbols<{
+      readonly health: number;
+      readonly maxHealth: number;
+      readonly dead: boolean;
+    }> {}
+
+  interface Heatable
+    extends WithSymbols<{
+      readonly heat: number;
+    }> {}
+
+  interface WithEffiency
+    extends WithSymbols<{
+      readonly efficiency: number;
+    }> {}
+
+  interface WithProgress
+    extends WithSymbols<{
+      readonly progress: number;
+    }> {}
+
+  interface WithTimescale
+    extends WithSymbols<{
+      readonly timescale: number;
+    }> {}
+
+  interface Rotatable
+    extends WithSymbols<{
+      readonly rotation: number;
+    }> {}
+
+  interface Spaced
+    extends WithSymbols<{
+      readonly x: number;
+      readonly y: number;
+      readonly size: number;
+    }> {}
+
+  interface Ranged
+    extends WithSymbols<{
+      readonly range: number;
+    }> {}
+
+  interface Boosted
+    extends WithSymbols<{
+      readonly boosting: number;
+    }> {}
+
+  interface Mining
+    extends WithSymbols<{
+      readonly mineX: number;
+      readonly mineY: number;
+      readonly mining: number;
+    }> {}
+
+  interface Typed<T extends symbol = symbol>
+    extends WithSymbols<{
+      readonly type: T;
+    }> {}
+  interface Flagged
+    extends WithSymbols<{
+      readonly flag: number;
+    }> {}
+
+  interface Controllable
+    extends WithSymbols<{
+      readonly controlled: 0 | ControlKind;
+      readonly controller: AnyUnit | BasicBuilding;
+    }> {}
+
+  interface Nameable
+    extends WithSymbols<{
+      readonly name: string | null;
+    }> {}
+
+  interface PayloadHolder
+    extends WithSymbols<{
+      readonly payloadCount: number;
+      readonly payloadType: symbol | null;
+    }> {}
+
+  interface WithEnable
+    extends WithSymbols<{
+      enabled: boolean;
+    }> {}
+
+  interface WithConfig<
+    T extends symbol | number | null = symbol | null
+  > extends WithSymbols<{
+      readonly config: T;
+    }> {}
+}

package/lib/util.d.ts

@@ -1,32 +1,32 @@
-export type TRadarFilter =
-  | "any"
-  | "enemy"
-  | "ally"
-  | "player"
-  | "attacker"
-  | "flying"
-  | "boss"
-  | "ground";
-
-export type TRadarFilterArray =
-  | [TRadarFilter]
-  | [TRadarFilter, TRadarFilter]
-  | [TRadarFilter, TRadarFilter, TRadarFilter];
-
-export type TRadarSort =
-  | "distance"
-  | "health"
-  | "shield"
-  | "armor"
-  | "maxHealth";
-
-export type TUnitLocateBuildingGroup =
-  | "core"
-  | "storage"
-  | "generator"
-  | "turret"
-  | "factory"
-  | "repair"
-  | "rally"
-  | "battery"
-  | "reactor";
+export type TRadarFilter =
+  | "any"
+  | "enemy"
+  | "ally"
+  | "player"
+  | "attacker"
+  | "flying"
+  | "boss"
+  | "ground";
+
+export type TRadarFilterArray =
+  | [TRadarFilter]
+  | [TRadarFilter, TRadarFilter]
+  | [TRadarFilter, TRadarFilter, TRadarFilter];
+
+export type TRadarSort =
+  | "distance"
+  | "health"
+  | "shield"
+  | "armor"
+  | "maxHealth";
+
+export type TUnitLocateBuildingGroup =
+  | "core"
+  | "storage"
+  | "generator"
+  | "turret"
+  | "factory"
+  | "repair"
+  | "rally"
+  | "battery"
+  | "reactor";

package/package.json

@@ -1,48 +1,68 @@
-{
-  "name": "mlogjs",
-  "version": "0.2.0",
-  "description": "Compiler that compiles Javascript to Mindustry Logic Code.",
-  "main": "build/index.js",
-  "bin": "./build/bin.js",
-  "scripts": {
-    "build": "tsc && webpack",
-    "start": "npm run build && npm i -g . && mlogjs",
-    "prepublishOnly": "npm run build"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/weisrc/mlogjs.git"
-  },
-  "packageManager": "yarn@3.2.0",
-  "keywords": [],
-  "author": "str1z",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/weisrc/mlogjs/issues"
-  },
-  "homepage": "https://github.com/weisrc/mlogjs#readme",
-  "dependencies": {
-    "esprima": "^4.0.1",
-    "yargs": "^17.0.1"
-  },
-  "devDependencies": {
-    "@types/esprima": "^4.0.2",
-    "@types/jest": "^27.4.1",
-    "@types/node": "^15.3.0",
-    "@types/yargs": "^16.0.1",
-    "jest": "^27.5.1",
-    "prettier": "^2.5.1",
-    "ts-jest": "^27.1.3",
-    "ts-loader": "^9.1.2",
-    "typescript": "^4.6.2",
-    "webpack": "^5.37.0",
-    "webpack-cli": "^4.7.0"
-  },
-  "files": [
-    "build",
-    "dist",
-    "lib",
-    "LICENSE",
-    "README.md"
-  ]
-}
+{
+  "name": "mlogjs",
+  "version": "0.3.0-beta.0",
+  "description": "Compiler that compiles Javascript to Mindustry Logic Code.",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "bin": "./dist/bin.cjs",
+  "types": "./dist/types",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/weisrc/mlogjs.git"
+  },
+  "keywords": [],
+  "author": "str1z",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/weisrc/mlogjs/issues"
+  },
+  "homepage": "https://github.com/weisrc/mlogjs#readme",
+  "dependencies": {
+    "@babel/parser": "^7.17.7",
+    "chalk": "^4.1.2",
+    "cli-highlight": "^2.1.11",
+    "yargs": "^17.0.1"
+  },
+  "devDependencies": {
+    "@babel/types": "^7.17.0",
+    "@rollup/plugin-alias": "^3.1.9",
+    "@rollup/plugin-replace": "^4.0.0",
+    "@rollup/plugin-typescript": "^8.3.1",
+    "@types/estree": "^0.0.51",
+    "@types/jest": "^27.4.1",
+    "@types/node": "^15.3.0",
+    "@types/yargs": "^16.0.1",
+    "@typescript-eslint/eslint-plugin": "^5.15.0",
+    "@typescript-eslint/parser": "^5.15.0",
+    "eslint": "^8.11.0",
+    "jest": "^27.5.1",
+    "npm-run-all": "^4.1.5",
+    "rollup": "^2.70.1",
+    "ts-jest": "^27.1.3",
+    "ts-node": "^10.6.0",
+    "tslib": "^2.3.1",
+    "typedoc": "^0.22.12",
+    "typescript": "*"
+  },
+  "files": [
+    "build",
+    "dist",
+    "lib",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "clean": "rm -rf ../docs dist build",
+    "build": "rollup -c",
+    "build:dev": "rollup -c --environment DEV",
+    "dev": "ts-node src/bin",
+    "test": "jest",
+    "lint": "eslint src/**/*.ts",
+    "coverage": "jest --coverage",
+    "docs:doc": "mkdir -p ../docs && cp -r doc/. ../docs",
+    "docs:lib": "typedoc --out ../docs/lib lib/*",
+    "docs:src": "typedoc --out ../docs/src src/index.ts",
+    "docs": "run-p docs:lib docs:src docs:doc",
+    "start": "npm run build && npm i -g . && mlogjs"
+  }
+}

package/build/Compiler.d.ts

@@ -1,18 +0,0 @@
-import { es, IScope, THandler, TValueInstructions } from "./types";
-declare type THandlerMap = {
-    [k in es.Node["type"]]?: THandler;
-};
-export declare class Compiler {
-    protected stackName?: string;
-    protected usingStack: boolean;
-    protected handlers: THandlerMap;
-    constructor(stackName?: string);
-    compile(script: string): string;
-    protected resolve(valueInst: TValueInstructions): void;
-    protected serialize(resLines: TValueInstructions): string;
-    protected parse(script: string): import("esprima").Program;
-    handle(scope: IScope, node: es.Node): TValueInstructions;
-    handleEval(scope: IScope, node: es.Node): TValueInstructions;
-    handleMany(scope: IScope, nodes: es.Node[], handler?: typeof Compiler.prototype.handle): TValueInstructions;
-}
-export {};

package/build/Scope.d.ts

@@ -1,26 +0,0 @@
-import { AddressResolver } from "./instructions";
-import { IFunctionValue, IInstruction, IScope, IValue } from "./types";
-export declare class Scope implements IScope {
-    parent: IScope;
-    name: string;
-    data: {
-        [k: string]: IValue;
-    };
-    stacked: boolean;
-    ntemp: number;
-    inst: IInstruction[];
-    break: AddressResolver;
-    continue: AddressResolver;
-    function: IFunctionValue;
-    constructor(values: {
-        [k: string]: IValue;
-    }, parent?: IScope, stacked?: boolean, ntemp?: number, name?: string, inst?: any[]);
-    copy(): IScope;
-    createScope(): IScope;
-    createFunction(name: string, stacked?: boolean): IScope;
-    has(name: string): boolean;
-    get(name: string): IValue;
-    set(name: string, value: IValue): IValue;
-    hardSet(name: string, value: IValue): IValue;
-    make(name: string, storeName: string): IValue;
-}