@pkmn/engine 0.1.0-dev.6195e056 → 0.1.0-dev.6e63f5e4

package/build.zig

@@ -1,15 +1,20 @@
 const std = @import("std");
 const builtin = @import("builtin");
 
-const NativeTargetInfo = std.zig.system.NativeTargetInfo;
-
-pub const Options = struct { showdown: ?bool = null, trace: ?bool = null };
+pub const Options = struct {
+    showdown: ?bool = null,
+    log: ?bool = null,
+    chance: ?bool = null,
+    calc: ?bool = null,
+};
 
 pub fn module(b: *std.Build, options: Options) *std.Build.Module {
     const dirname = comptime std.fs.path.dirname(@src().file) orelse ".";
     const build_options = b.addOptions();
     build_options.addOption(?bool, "showdown", options.showdown);
-    build_options.addOption(?bool, "trace", options.trace);
+    build_options.addOption(?bool, "log", options.log);
+    build_options.addOption(?bool, "chance", options.chance);
+    build_options.addOption(?bool, "calc", options.calc);
     return b.createModule(.{
         .source_file = .{ .path = dirname ++ "/src/lib/pkmn.zig" },
         .dependencies = &.{.{ .name = "build_options", .module = build_options.createModule() }},
@@ -29,25 +34,30 @@ pub fn build(b: *std.Build) !void {
     const dynamic = b.option(bool, "dynamic", "Build a dynamic library") orelse false;
     const strip = b.option(bool, "strip", "Strip debugging symbols from binary") orelse false;
     const pic = b.option(bool, "pic", "Force position independent code") orelse false;
+    const emit_asm = b.option(bool, "emit-asm", "Output .s (assembly code)") orelse false;
+    const emit_ll = b.option(bool, "emit-ll", "Output .ll (LLVM IR)") orelse false;
 
-    const cmd = b.findProgram(&[_][]const u8{"strip"}, &[_][]const u8{}) catch null;
+    const cmd = b.findProgram(&.{"strip"}, &.{}) catch null;
 
-    var parser = std.json.Parser.init(b.allocator, false);
-    defer parser.deinit();
-    var tree = try parser.parse(@embedFile("package.json"));
-    defer tree.deinit();
-    const version = tree.root.Object.get("version").?.String;
-    const description = tree.root.Object.get("description").?.String;
-    var repository = std.mem.split(u8, tree.root.Object.get("repository").?.String, ":");
+    const json = @embedFile("package.json");
+    var parsed = try std.json.parseFromSlice(std.json.Value, b.allocator, json, .{});
+    defer parsed.deinit();
+    const version = parsed.value.object.get("version").?.string;
+    const description = parsed.value.object.get("description").?.string;
+    var repository = std.mem.split(u8, parsed.value.object.get("repository").?.string, ":");
     std.debug.assert(std.mem.eql(u8, repository.first(), "github"));
 
     const showdown =
         b.option(bool, "showdown", "Enable Pokémon Showdown compatibility mode") orelse false;
-    const trace = b.option(bool, "trace", "Enable trace logs") orelse false;
+    const log = b.option(bool, "log", "Enable protocol message logging") orelse false;
+    const chance = b.option(bool, "chance", "Enable update probability tracking") orelse false;
+    const calc = b.option(bool, "calc", "Enable damage calculator support") orelse false;
 
     const options = b.addOptions();
     options.addOption(?bool, "showdown", showdown);
-    options.addOption(?bool, "trace", trace);
+    options.addOption(?bool, "log", log);
+    options.addOption(?bool, "chance", chance);
+    options.addOption(?bool, "calc", calc);
 
     const name = if (showdown) "pkmn-showdown" else "pkmn";
 
@@ -56,17 +66,17 @@ pub fn build(b: *std.Build) !void {
         const addon = b.fmt("{s}.node", .{name});
         const lib = b.addSharedLibrary(.{
             .name = addon,
+            .main_pkg_path = .{ .path = "." },
             .root_source_file = .{ .path = "src/lib/binding/node.zig" },
             .optimize = optimize,
             .target = target,
         });
         lib.addOptions("build_options", options);
-        lib.setMainPkgPath("./");
-        lib.addSystemIncludePath(headers);
+        lib.addSystemIncludePath(.{ .path = headers });
         lib.linkLibC();
         if (node_import_lib) |il| {
-            lib.addObjectFile(il);
-        } else if ((try NativeTargetInfo.detect(target)).target.os.tag == .windows) {
+            lib.addObjectFile(.{ .path = il });
+        } else if ((try std.zig.system.NativeTargetInfo.detect(target)).target.os.tag == .windows) {
             try std.io.getStdErr().writeAll("Must provide --node-import-library path on Windows\n");
             std.process.exit(1);
         }
@@ -74,17 +84,18 @@ pub fn build(b: *std.Build) !void {
         maybeStrip(b, lib, b.getInstallStep(), strip, cmd);
         if (pic) lib.force_pic = pic;
         // Always emit to build/lib because this is where the driver code expects to find it
-        // TODO(ziglang/zig#2231): using the following used to work (though be hacky):
+        // TODO(ziglang/zig#2231): using the following used to work (though was hacky):
         //
         //    lib.emit_bin = .{ .emit_to = b.fmt("build/lib/{s}", .{addon}) };
         //    b.getInstallStep().dependOn(&lib.step);
         //
         // But ziglang/zig#14647 broke this so we now need to do an install() and then manually
         // rename the file ourself in install-pkmn-engine
-        lib.install();
+        b.installArtifact(lib);
     } else if (wasm) {
         const lib = b.addSharedLibrary(.{
             .name = name,
+            .main_pkg_path = .{ .path = "." },
             .root_source_file = .{ .path = "src/lib/binding/wasm.zig" },
             .optimize = switch (optimize) {
                 .ReleaseFast, .ReleaseSafe => .ReleaseSmall,
@@ -93,53 +104,63 @@ pub fn build(b: *std.Build) !void {
             .target = .{ .cpu_arch = .wasm32, .os_tag = .freestanding },
         });
         lib.addOptions("build_options", options);
-        lib.setMainPkgPath("./");
         lib.stack_size = wasm_stack_size;
         lib.rdynamic = true;
         lib.strip = strip;
         if (pic) lib.force_pic = pic;
-        const opt = b.findProgram(
-            &[_][]const u8{"wasm-opt"},
-            &[_][]const u8{"./node_modules/.bin"},
-        ) catch null;
+        const opt = b.findProgram(&.{"wasm-opt"}, &.{"./node_modules/.bin"}) catch null;
         if (optimize != .Debug and opt != null) {
             const out = b.fmt("build/lib/{s}.wasm", .{name});
-            const sh = b.addSystemCommand(&[_][]const u8{ opt.?, "-O4" });
+            const sh = b.addSystemCommand(&.{ opt.?, "-O4" });
             sh.addArtifactArg(lib);
             sh.addArg("-o");
             sh.addFileSourceArg(.{ .path = out });
             b.getInstallStep().dependOn(&sh.step);
         }
-        lib.install();
+        b.installArtifact(lib);
     } else if (dynamic) {
         const lib = b.addSharedLibrary(.{
             .name = name,
+            .main_pkg_path = .{ .path = "." },
             .root_source_file = .{ .path = "src/lib/binding/c.zig" },
-            .version = try std.builtin.Version.parse(version),
+            .version = try std.SemanticVersion.parse(version),
             .optimize = optimize,
             .target = target,
         });
         lib.addOptions("build_options", options);
-        lib.setMainPkgPath("./");
-        lib.addIncludePath("src/include");
+        lib.addIncludePath(.{ .path = "src/include" });
         maybeStrip(b, lib, b.getInstallStep(), strip, cmd);
         if (pic) lib.force_pic = pic;
-        lib.install();
+        b.installArtifact(lib);
         c = true;
     } else {
         const lib = b.addStaticLibrary(.{
             .name = name,
+            .main_pkg_path = .{ .path = "." },
             .root_source_file = .{ .path = "src/lib/binding/c.zig" },
             .optimize = optimize,
             .target = target,
         });
         lib.addOptions("build_options", options);
-        lib.setMainPkgPath("./");
-        lib.addIncludePath("src/include");
+        lib.addIncludePath(.{ .path = "src/include" });
         lib.bundle_compiler_rt = true;
         maybeStrip(b, lib, b.getInstallStep(), strip, cmd);
         if (pic) lib.force_pic = pic;
-        lib.install();
+        if (emit_asm) {
+            b.getInstallStep().dependOn(&b.addInstallFileWithDir(
+                lib.getEmittedAsm(),
+                .prefix,
+                b.fmt("{s}.s", .{name}),
+            ).step);
+        }
+        if (emit_ll) {
+            b.getInstallStep().dependOn(&b.addInstallFileWithDir(
+                lib.getEmittedLlvmIr(),
+                .prefix,
+                b.fmt("{s}.ll", .{name}),
+            ).step);
+        }
+        b.installArtifact(lib);
         c = true;
     }
 
@@ -181,14 +202,20 @@ pub fn build(b: *std.Build) !void {
         .strip = strip,
         .cmd = cmd,
     };
+
+    // TODO: tests can be run multiple times due to @imports
     const tests = TestStep.create(b, options, config);
 
     var exes = std.ArrayList(*std.Build.CompileStep).init(b.allocator);
     const tools: ToolConfig = .{
+        .options = .{
+            .showdown = showdown,
+            .log = log,
+            .chance = chance,
+            .calc = calc,
+        },
         .general = config,
         .tool = .{
-            .showdown = showdown,
-            .trace = trace,
             .tests = if (tests.build) tests else null,
             .exes = &exes,
         },
@@ -202,23 +229,25 @@ pub fn build(b: *std.Build) !void {
     var fuzz_config = tools;
     fuzz_config.general.strip = false;
     fuzz_config.tool.name = "fuzz";
-    const fuzz = tool(b, "src/test/benchmark.zig", fuzz_config);
+    const fuzz = tool(b, "src/test/fuzz.zig", fuzz_config);
 
-    const serde = tool(b, "src/tools/serde.zig", tools);
-    const protocol = tool(b, "src/tools/protocol.zig", tools);
+    const analyze = tool(b, "src/tools/analyze.zig", tools);
+    const dump = tool(b, "src/tools/dump.zig", tools);
+    const transitions = tool(b, "src/tools/transitions.zig", tools);
 
-    const lint_exe =
-        b.addExecutable(.{ .name = "lint", .root_source_file = .{ .path = "src/tools/lint.zig" } });
-    if (tests.build) tests.step.dependOn(&lint_exe.step);
-    const lint = lint_exe.run();
+    // FIXME: serde randomly fails to build in some release configurations
+    var hack = tools;
+    if (optimize != .Debug) hack.tool.tests = null;
+    const serde = tool(b, "src/tools/serde.zig", hack);
 
+    b.step("analyze", "Run LLVM analysis tool").dependOn(&analyze.step);
     b.step("benchmark", "Run benchmark code").dependOn(&benchmark.step);
+    b.step("dump", "Run protocol dump tool").dependOn(&dump.step);
     b.step("fuzz", "Run fuzz tester").dependOn(&fuzz.step);
-    b.step("lint", "Lint source files").dependOn(&lint.step);
-    b.step("protocol", "Run protocol dump tool").dependOn(&protocol.step);
     b.step("serde", "Run serialization/deserialization tool").dependOn(&serde.step);
     b.step("test", "Run all tests").dependOn(&tests.step);
     b.step("tools", "Install tools").dependOn(&ToolsStep.create(b, &exes).step);
+    b.step("transitions", "Visualize transitions algorithm search").dependOn(&transitions.step);
 }
 
 fn maybeStrip(
@@ -235,7 +264,7 @@ fn maybeStrip(
     if (mac and artifact.isDynamicLibrary()) return;
     // Assuming GNU strip, which complains "illegal pathname found in archive member"...
     if (!mac and artifact.isStaticLibrary()) return;
-    const sh = b.addSystemCommand(&[_][]const u8{ cmd.?, if (mac) "-x" else "-s" });
+    const sh = b.addSystemCommand(&.{ cmd.?, if (mac) "-x" else "-s" });
     sh.addArtifactArg(artifact);
     step.dependOn(&sh.step);
 }
@@ -248,12 +277,6 @@ const Config = struct {
     cmd: ?[]const u8,
 };
 
-const TESTS = [_][]const u8{
-    "src/lib/common/test.zig",
-    "src/lib/gen1/test.zig",
-    "src/lib/gen2/test.zig",
-};
-
 const TestStep = struct {
     step: std.Build.Step,
     build: bool,
@@ -261,49 +284,42 @@ const TestStep = struct {
     pub fn create(b: *std.Build, options: *std.Build.OptionsStep, config: Config) *TestStep {
         const coverage = b.option([]const u8, "test-coverage", "Generate test coverage");
         const test_file = b.option([]const u8, "test-file", "Input file for test");
-        const test_bin = b.option([]const u8, "test-bin", "Emit test binary to");
         const test_filter =
             b.option([]const u8, "test-filter", "Skip tests that do not match filter");
-        const test_no_exec =
-            b.option(bool, "test-no-exec", "Compiles test binary without running it") orelse false;
 
         const self = b.allocator.create(TestStep) catch @panic("OOM");
         const step = std.Build.Step.init(.{ .id = .custom, .name = "Run all tests", .owner = b });
-        self.* = TestStep{ .step = step, .build = test_filter == null };
-
-        const paths: []const []const u8 =
-            if (test_file) |t| &.{t} else if (coverage != null) &.{"src/lib/test.zig"} else &TESTS;
-        for (paths) |path| {
-            const tests = b.addTest(.{
-                .name = std.fs.path.basename(std.fs.path.dirname(path).?),
-                .root_source_file = .{ .path = path },
-                .optimize = config.optimize,
-                .target = config.target,
-            });
-            tests.setMainPkgPath("./");
-            tests.setFilter(test_filter);
-            tests.addOptions("build_options", options);
-            tests.single_threaded = true;
-            maybeStrip(b, tests, &tests.step, config.strip, config.cmd);
-            if (config.pic) tests.force_pic = config.pic;
-            if (test_bin) |bin| {
-                tests.name = std.fs.path.basename(bin);
-                if (std.fs.path.dirname(bin)) |dir| tests.setOutputDir(dir);
-            }
-            if (coverage) |c| {
-                tests.setExecCmd(&.{ "kcov", "--include-pattern=src/lib", c, null });
-            }
-            self.step.dependOn(if (test_no_exec) &tests.step else &tests.run().step);
+        self.* = .{ .step = step, .build = test_filter == null };
+
+        const path = test_file orelse "src/lib/test.zig";
+        const tests = b.addTest(.{
+            .name = b.fmt("{s}-{s}", .{
+                std.fs.path.basename(std.fs.path.dirname(path).?),
+                std.fs.path.stem(std.fs.path.basename(path)),
+            }),
+            .main_pkg_path = .{ .path = "." },
+            .root_source_file = .{ .path = path },
+            .optimize = config.optimize,
+            .target = config.target,
+            .filter = test_filter,
+        });
+        tests.addOptions("build_options", options);
+        tests.single_threaded = true;
+        maybeStrip(b, tests, &tests.step, config.strip, config.cmd);
+        if (config.pic) tests.force_pic = config.pic;
+        if (coverage) |c| {
+            tests.setExecCmd(&.{ "kcov", "--include-pattern=src/lib", c, null });
         }
+        self.step.dependOn(&b.addRunArtifact(tests).step);
+
         return self;
     }
 };
 
 const ToolConfig = struct {
+    options: Options,
     general: Config,
     tool: struct {
-        showdown: bool,
-        trace: bool,
         tests: ?*TestStep,
         name: ?[]const u8 = null,
         exes: *std.ArrayList(*std.Build.CompileStep),
@@ -314,7 +330,7 @@ fn tool(b: *std.Build, path: []const u8, config: ToolConfig) *std.Build.RunStep
     var name = config.tool.name orelse std.fs.path.basename(path);
     const index = std.mem.lastIndexOfScalar(u8, name, '.');
     if (index) |i| name = name[0..i];
-    if (config.tool.showdown) name = b.fmt("{s}-showdown", .{name});
+    if (config.options.showdown orelse false) name = b.fmt("{s}-showdown", .{name});
 
     const exe = b.addExecutable(.{
         .name = name,
@@ -322,16 +338,14 @@ fn tool(b: *std.Build, path: []const u8, config: ToolConfig) *std.Build.RunStep
         .target = config.general.target,
         .optimize = config.general.optimize,
     });
-    exe.addModule("pkmn", module(b, .{
-        .showdown = config.tool.showdown,
-        .trace = config.tool.trace,
-    }));
+    exe.addModule("pkmn", module(b, config.options));
+
     exe.single_threaded = true;
     if (config.general.pic) exe.force_pic = config.general.pic;
     if (config.tool.tests) |ts| ts.step.dependOn(&exe.step);
     config.tool.exes.append(exe) catch @panic("OOM");
 
-    const run = exe.run();
+    const run = b.addRunArtifact(exe);
     maybeStrip(b, exe, &run.step, config.general.strip, config.general.cmd);
     if (b.args) |args| run.addArgs(args);
 
@@ -344,8 +358,8 @@ const ToolsStep = struct {
     pub fn create(b: *std.Build, exes: *std.ArrayList(*std.Build.CompileStep)) *ToolsStep {
         const self = b.allocator.create(ToolsStep) catch @panic("OOM");
         const step = std.Build.Step.init(.{ .id = .custom, .name = "Install tools", .owner = b });
-        self.* = ToolsStep{ .step = step };
-        for (exes.items) |t| self.step.dependOn(&b.addInstallArtifact(t).step);
+        self.* = .{ .step = step };
+        for (exes.items) |t| self.step.dependOn(&b.addInstallArtifact(t, .{}).step);
         return self;
     }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pkmn/engine",
-  "version": "0.1.0-dev.6195e056",
+  "version": "0.1.0-dev.6e63f5e4",
   "description": "A minimal, complete, Pokémon battle simulation engine optimized for performance",
   "repository": "github:pkmn/engine",
   "license": "MIT",
@@ -9,85 +9,103 @@
   "types": "build/pkg/index.d.ts",
   "files": [
     "build.zig",
+    "build/pkg/data.d.ts",
+    "build/pkg/data.js.map",
+    "build/pkg/addon.d.ts",
+    "build/pkg/addon.js.map",
+    "build/pkg/addon.js",
+    "build/pkg/data.js",
+    "build/pkg/data/ids.json",
+    "build/pkg/data/layout.json",
+    "build/pkg/data/protocol.json",
+    "build/pkg/gen1.d.ts",
+    "build/pkg/gen1.js.map",
+    "build/pkg/gen1.js",
+    "build/pkg/index.d.ts",
+    "build/pkg/index.js.map",
+    "build/pkg/index.js",
+    "build/pkg/protocol.d.ts",
+    "build/pkg/protocol.js.map",
+    "build/pkg/protocol.js",
+    "build/test/display.js.map",
+    "build/test/display.js",
+    "build/tools/debug.js.map",
+    "build/tools/debug.js",
     "src/bin/install-pkmn-engine",
     "src/lib/binding/node.zig",
     "src/lib/binding/wasm.zig",
+    "src/lib/common/battle.zig",
     "src/lib/common/data.zig",
+    "src/lib/common/debug.zig",
+    "src/lib/common/js.zig",
+    "src/lib/common/optional.zig",
     "src/lib/common/options.zig",
     "src/lib/common/protocol.zig",
+    "src/lib/common/rational.zig",
     "src/lib/common/rng.zig",
+    "src/lib/common/util.zig",
+    "src/lib/gen1/calc.zig",
+    "src/lib/gen1/chance.zig",
+    "src/lib/gen1/data.zig",
     "src/lib/gen1/data/moves.zig",
     "src/lib/gen1/data/species.zig",
     "src/lib/gen1/data/types.zig",
-    "src/lib/gen1/data.zig",
     "src/lib/gen1/helpers.zig",
     "src/lib/gen1/mechanics.zig",
+    "src/lib/gen2/data.zig",
     "src/lib/gen2/data/items.zig",
     "src/lib/gen2/data/moves.zig",
     "src/lib/gen2/data/species.zig",
     "src/lib/gen2/data/types.zig",
-    "src/lib/gen2/data.zig",
     "src/lib/gen2/helpers.zig",
     "src/lib/gen2/mechanics.zig",
     "src/lib/pkmn.zig",
-    "build/pkg/data/ids.json",
-    "build/pkg/data/layout.json",
-    "build/pkg/data/protocol.json",
-    "build/pkg/data.d.ts",
-    "build/pkg/data.js",
-    "build/pkg/data.js.map",
-    "build/pkg/gen1.d.ts",
-    "build/pkg/gen1.js",
-    "build/pkg/gen1.js.map",
-    "build/pkg/index.d.ts",
-    "build/pkg/index.js",
-    "build/pkg/index.js.map",
-    "build/pkg/protocol.d.ts",
-    "build/pkg/protocol.js",
-    "build/pkg/protocol.js.map"
+    "src/test/display/pkmn.html.tmpl"
   ],
   "engines": {
     "node": ">=16.0.0"
   },
   "bin": {
-    "install-pkmn-engine": "src/bin/install-pkmn-engine"
+    "install-pkmn-engine": "src/bin/install-pkmn-engine",
+    "pkmn-debug": "src/bin/pkmn-debug"
   },
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
-    "@pkmn/data": "^0.7.33",
-    "@pkmn/protocol": "^0.6.11"
+    "@pkmn/data": "^0.7.50",
+    "@pkmn/protocol": "^0.6.13"
   },
   "devDependencies": {
-    "@pkmn/eslint-config": "^3.0.0-alpha.0",
-    "@pkmn/img": "^0.2.8",
+    "@pkmn/eslint-config": "^5.2.0",
+    "@pkmn/img": "^0.2.15",
     "@pkmn/sets": "^5.0.4",
-    "@pkmn/sim": "0.7.33",
+    "@pkmn/sim": "0.7.50",
     "@types/html-minifier": "^4.0.2",
-    "@types/jest": "^29.5.0",
+    "@types/jest": "^29.5.4",
     "@types/minimist": "^1.2.2",
     "@types/mustache": "^4.2.2",
-    "@types/node": "^18.15.11",
-    "@vitest/coverage-c8": "^0.29.8",
-    "binaryen": "^112.0.0",
-    "eslint": "^8.37.0",
+    "@types/node": "^20.5.9",
+    "@vitest/coverage-c8": "^0.33.0",
+    "binaryen": "^114.0.0",
+    "eslint": "^8.48.0",
     "html-minifier": "^4.0.0",
     "json-stringify-pretty-compact": "3.0.0",
     "minimist": "^1.2.8",
     "mustache": "^4.2.0",
     "source-map-support": "^0.5.21",
     "trakr": "^0.2.0",
-    "typescript": "^5.0.2",
-    "vitest": "^0.29.8"
+    "typescript": "^5.2.2",
+    "vitest": "^0.34.4"
   },
   "scripts": {
-    "lint": "eslint --cache src --ext ts,js && eslint src/bin/install-pkmn-engine",
-    "fix": "eslint --fix src --ext ts,js && eslint --fix src/bin/install-pkmn-engine",
+    "lint": "eslint --cache src --ext ts,js && eslint src/bin/*",
+    "fix": "eslint --fix src --ext ts,js && eslint --fix src/bin/*",
     "compile": "tsc -p .",
     "build": "npm run compile",
     "test": "vitest src/pkg",
     "test:integration": "vitest src/test",
+    "debug": "npm run compile && node build/tools/debug",
     "fuzz": "npm run compile && node build/test/fuzz",
     "generate": "npm run compile && node build/tools/generate",
     "release": "npm run compile && node build/tools/release",
@@ -129,7 +147,8 @@
         "rules": {
           "no-control-regex": "off",
           "@typescript-eslint/no-empty-interface": "off",
-          "@typescript-eslint/no-shadow": "off"
+          "@typescript-eslint/no-shadow": "off",
+          "@typescript-eslint/no-unsafe-declaration-merging": "off"
         }
       },
       {
@@ -145,12 +164,14 @@
           "src/test/benchmark*.ts"
         ],
         "rules": {
-          "@typescript-eslint/no-unused-vars": "off"
+          "@typescript-eslint/no-unused-vars": "off",
+          "@typescript-eslint/no-redundant-type-constituents": "off"
         }
       },
       {
         "files": [
-          "src/test/*.test.ts"
+          "src/test/*.test.ts",
+          "src/test/regression/*.test.ts"
         ],
         "rules": {
           "jest/no-standalone-expect": "off"