@pkmn/engine 0.1.0-dev.b9fb6eab → 0.1.0-dev.cf6f5d2c

package/build.zig

@@ -1,13 +1,13 @@
 const std = @import("std");
 const builtin = @import("builtin");
 
-pub const Options = struct { showdown: ?bool = null, trace: ?bool = null };
+pub const Options = struct { showdown: ?bool = null, log: ?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);
     return b.createModule(.{
         .source_file = .{ .path = dirname ++ "/src/lib/pkmn.zig" },
         .dependencies = &.{.{ .name = "build_options", .module = build_options.createModule() }},
@@ -27,6 +27,7 @@ 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 cmd = b.findProgram(&.{"strip"}, &.{}) catch null;
 
@@ -41,11 +42,11 @@ pub fn build(b: *std.Build) !void {
 
     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 options = b.addOptions();
     options.addOption(?bool, "showdown", showdown);
-    options.addOption(?bool, "trace", trace);
+    options.addOption(?bool, "log", log);
 
     const name = if (showdown) "pkmn-showdown" else "pkmn";
 
@@ -79,7 +80,7 @@ pub fn build(b: *std.Build) !void {
         //
         // 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,
@@ -105,7 +106,7 @@ pub fn build(b: *std.Build) !void {
             sh.addFileSourceArg(.{ .path = out });
             b.getInstallStep().dependOn(&sh.step);
         }
-        lib.install();
+        b.installArtifact(lib);
     } else if (dynamic) {
         const lib = b.addSharedLibrary(.{
             .name = name,
@@ -119,7 +120,7 @@ pub fn build(b: *std.Build) !void {
         lib.addIncludePath("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(.{
@@ -134,7 +135,8 @@ pub fn build(b: *std.Build) !void {
         lib.bundle_compiler_rt = true;
         maybeStrip(b, lib, b.getInstallStep(), strip, cmd);
         if (pic) lib.force_pic = pic;
-        lib.install();
+        if (emit_asm) lib.emit_asm = .emit;
+        b.installArtifact(lib);
         c = true;
     }
 
@@ -183,7 +185,7 @@ pub fn build(b: *std.Build) !void {
         .general = config,
         .tool = .{
             .showdown = showdown,
-            .trace = trace,
+            .log = log,
             .tests = if (tests.build) tests else null,
             .exes = &exes,
         },
@@ -205,7 +207,7 @@ pub fn build(b: *std.Build) !void {
     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();
+    const lint = b.addRunArtifact(lint_exe);
 
     b.step("benchmark", "Run benchmark code").dependOn(&benchmark.step);
     b.step("fuzz", "Run fuzz tester").dependOn(&fuzz.step);
@@ -256,11 +258,8 @@ 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 });
@@ -274,21 +273,17 @@ const TestStep = struct {
                 .root_source_file = .{ .path = path },
                 .optimize = config.optimize,
                 .target = config.target,
+                .filter = test_filter,
             });
             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.dependOn(&b.addRunArtifact(tests).step);
         }
         return self;
     }
@@ -298,7 +293,7 @@ const ToolConfig = struct {
     general: Config,
     tool: struct {
         showdown: bool,
-        trace: bool,
+        log: bool,
         tests: ?*TestStep,
         name: ?[]const u8 = null,
         exes: *std.ArrayList(*std.Build.CompileStep),
@@ -319,14 +314,14 @@ fn tool(b: *std.Build, path: []const u8, config: ToolConfig) *std.Build.RunStep
     });
     exe.addModule("pkmn", module(b, .{
         .showdown = config.tool.showdown,
-        .trace = config.tool.trace,
+        .log = config.tool.log,
     }));
     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);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pkmn/engine",
-  "version": "0.1.0-dev.b9fb6eab",
+  "version": "0.1.0-dev.cf6f5d2c",
   "description": "A minimal, complete, Pokémon battle simulation engine optimized for performance",
   "repository": "github:pkmn/engine",
   "license": "MIT",
@@ -9,6 +9,28 @@
   "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",
@@ -17,78 +39,66 @@
     "src/lib/common/options.zig",
     "src/lib/common/protocol.zig",
     "src/lib/common/rng.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.35",
+    "@pkmn/data": "^0.7.38",
     "@pkmn/protocol": "^0.6.11"
   },
   "devDependencies": {
     "@pkmn/eslint-config": "^3.0.0",
     "@pkmn/img": "^0.2.8",
     "@pkmn/sets": "^5.0.4",
-    "@pkmn/sim": "0.7.35",
+    "@pkmn/sim": "0.7.38",
     "@types/html-minifier": "^4.0.2",
     "@types/jest": "^29.5.0",
     "@types/minimist": "^1.2.2",
     "@types/mustache": "^4.2.2",
     "@types/node": "^18.15.11",
-    "@vitest/coverage-c8": "^0.29.8",
+    "@vitest/coverage-c8": "^0.30.1",
     "binaryen": "^112.0.0",
-    "eslint": "^8.37.0",
+    "eslint": "^8.38.0",
     "html-minifier": "^4.0.0",
-    "json-stringify-pretty-compact": "3.0.0",
+    "json-stringify-pretty-compact": "4.0.0",
     "minimist": "^1.2.8",
     "mustache": "^4.2.0",
     "source-map-support": "^0.5.21",
     "trakr": "^0.2.0",
-    "typescript": "^5.0.3",
-    "vitest": "^0.29.8"
+    "typescript": "^5.0.4",
+    "vitest": "^0.30.1"
   },
   "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",
@@ -151,7 +161,8 @@
       },
       {
         "files": [
-          "src/test/*.test.ts"
+          "src/test/*.test.ts",
+          "src/test/regression/*.test.ts"
         ],
         "rules": {
           "jest/no-standalone-expect": "off"

package/src/bin/install-pkmn-engine

@@ -10,7 +10,7 @@ const path = require('path');
 const {pipeline} = require('stream/promises');
 const tty = require('tty');
 
-const ZIG_VERSION = {major: 0, minor: 11, patch: 0, dev: 2168};
+const ZIG_VERSION = {major: 0, minor: 11, patch: 0, dev: 2750};
 const DEV = ZIG_VERSION.dev ? `-dev.${ZIG_VERSION.dev}` : '';
 const VERSION = `${ZIG_VERSION.major}.${ZIG_VERSION.minor}.${ZIG_VERSION.patch}${DEV}`;
 const INDEX = 'https://ziglang.org/download/index.json';
@@ -337,13 +337,13 @@ const downloadImportLib = async () => {
         if (!options) {
           const addon = require(copy);
           if (addon.options.showdown) opts.push('-Dshowdown');
-          if (addon.options.trace) opts.push('-Dtrace');
+          if (addon.options.log) opts.push('-Dlog');
         }
       } else if (!options) {
         const addon = await WebAssembly.instantiate(fs.readFileSync(copy));
         const values = new Uint8Array(addon.instance.exports.memory.buffer);
         if (values[addon.instance.exports.SHOWDOWN.value]) opts.push('-Dshowdown');
-        if (values[addon.instance.exports.TRACE.value]) opts.push('-Dtrace');
+        if (values[addon.instance.exports.LOG.value]) opts.push('-Dlog');
       }
       const key = `${type} ${opts.sort().join(' ')}`;
       if (!configs.has(key)) configs.set(key, {type, options: opts});

package/src/bin/pkmn-debug

@@ -0,0 +1,62 @@
+#!/usr/bin/env node
+'use strict';
+
+try {
+  require('source-map-support').install();
+} catch (err) {
+  if (err.code !== 'MODULE_NOT_FOUND') throw err;
+}
+
+const {execFileSync} = require('child_process');
+const {readFileSync} = require('fs');
+const {join, resolve} = require('path');
+
+const ROOT = resolve(__dirname, '..', '..');
+const packageJSON = JSON.parse(readFileSync(join(ROOT, 'package.json'), 'utf8'));
+
+const missing = [];
+for (const dep of ['@pkmn/img', 'html-minifier', 'mustache']) {
+  try {
+    require.resolve(dep);
+  } catch (e) {
+    if (e.code !== 'MODULE_NOT_FOUND') throw e;
+    missing.push(`${dep}@${packageJSON.devDependencies[dep]}`);
+  }
+}
+
+let Dex = undefined;
+try {
+  Dex = require('@pkmn/sim').Dex;
+} catch (err) {
+  if (err.code !== 'MODULE_NOT_FOUND') throw err;
+  try {
+    Dex = require('@pkmn/dex').Dex;
+  } catch (e) {
+    if (e.code !== 'MODULE_NOT_FOUND') throw e;
+    missing.push(`@pkmn/dex@${packageJSON.dependencies['@pkmn/data']}`);
+  }
+}
+
+if (missing.length) {
+  if (+/^v(\d+)/.exec(process.version)[1] < 16) {
+    console.error('pkmn-debug requires Node v16+');
+    process.exit(1);
+  }
+
+  execFileSync('npm', ['install', ...missing, '--global'], {encoding: 'utf8'});
+
+  const node_modules = execFileSync('npm', ['root', '--global'], {encoding: 'utf8'}).trim();
+  if (!process.env.NODE_PATH || !process.env.NODE_PATH.includes(node_modules)) {
+    console.error(`NODE_PATH must include npm's global node_modules directory: '${node_modules}'`);
+    process.exit(1);
+  }
+}
+
+const {Generations} = require('@pkmn/data');
+
+const {run} = require('../../build/tools/debug');
+
+run(new Generations(Dex)).catch(err => {
+  console.error(err.message);
+  process.exit(1);
+});

package/src/lib/binding/node.zig

@@ -21,7 +21,7 @@ fn options(env: c.napi_env) c.napi_value {
     var object = Object.init(env);
     const properties = [_]c.napi_property_descriptor{
         Property.init("showdown", .{ .value = Boolean.init(env, pkmn.options.showdown) }),
-        Property.init("trace", .{ .value = Boolean.init(env, pkmn.options.trace) }),
+        Property.init("log", .{ .value = Boolean.init(env, pkmn.options.log) }),
     };
     assert(c.napi_define_properties(env, object, properties.len, &properties) == c.napi_ok);
     return object;
@@ -34,11 +34,11 @@ fn bindings(env: c.napi_env) c.napi_value {
 }
 
 fn bind(env: c.napi_env, gen: anytype) c.napi_value {
-    const options_size = @intCast(u32, gen.OPTIONS_SIZE);
+    const choices_size = @intCast(u32, gen.CHOICES_SIZE);
     const logs_size = @intCast(u32, gen.LOGS_SIZE);
     var object = Object.init(env);
     const properties = [_]c.napi_property_descriptor{
-        Property.init("OPTIONS_SIZE", .{ .value = Number.init(env, options_size) }),
+        Property.init("CHOICES_SIZE", .{ .value = Number.init(env, choices_size) }),
         Property.init("LOGS_SIZE", .{ .value = Number.init(env, logs_size) }),
         Property.init("update", .{ .method = update(gen) }),
         Property.init("choices", .{ .method = choices(gen) }),
@@ -108,10 +108,10 @@ fn choices(gen: anytype) c.napi_callback {
             const request = @intToEnum(pkmn.Choice.Type, Number.get(env, argv[2], u8));
 
             assert(c.napi_get_arraybuffer_info(env, argv[3], &data, &len) == c.napi_ok);
-            assert(len == gen.OPTIONS_SIZE);
+            assert(len == gen.CHOICES_SIZE);
             assert(data != null);
 
-            var out = @ptrCast([*]pkmn.Choice, data.?)[0..gen.OPTIONS_SIZE];
+            var out = @ptrCast([*]pkmn.Choice, data.?)[0..gen.CHOICES_SIZE];
             const n = battle.choices(player, request, out);
             return Number.init(env, @bitCast(u8, n));
         }

package/src/lib/binding/wasm.zig

@@ -2,9 +2,9 @@ const std = @import("std");
 const pkmn = @import("../pkmn.zig");
 
 export const SHOWDOWN = pkmn.options.showdown;
-export const TRACE = pkmn.options.trace;
+export const LOG = pkmn.options.log;
 
-export const GEN1_OPTIONS_SIZE =
-    std.math.ceilPowerOfTwo(u32, @intCast(u32, pkmn.gen1.OPTIONS_SIZE)) catch unreachable;
+export const GEN1_CHOICES_SIZE =
+    std.math.ceilPowerOfTwo(u32, @intCast(u32, pkmn.gen1.CHOICES_SIZE)) catch unreachable;
 export const GEN1_LOGS_SIZE =
     std.math.ceilPowerOfTwo(u32, @intCast(u32, pkmn.gen1.LOGS_SIZE)) catch unreachable;

package/src/lib/common/debug.zig

@@ -58,6 +58,7 @@ fn inspect(value: anytype) void {
                     @compileError(err);
                 },
             },
+            .Optional => stderr.print("{?}", .{value}) catch return,
             else => stderr.print("{}", .{value}) catch return,
         }
     }

package/src/lib/common/options.zig

@@ -3,7 +3,7 @@ const root = @import("root");
 
 pub const Options = struct {
     showdown: ?bool = null,
-    trace: ?bool = null,
+    log: ?bool = null,
     advance: ?bool = null,
     ebc: ?bool = null,
     internal: ?bool = null,
@@ -11,8 +11,8 @@ pub const Options = struct {
 
 /// Whether or not Pokémon Showdown compatibility mode is enabled.
 pub const showdown = get("showdown", false);
-/// Whether or not protocol trace logging is enabled.
-pub const trace = get("trace", false);
+/// Whether or not protocol message logging is enabled.
+pub const log = get("log", false);
 
 pub const advance = get("advance", true);
 pub const ebc = get("ebc", true);