@wllzhang/afsim-compiler 0.5.6 → 0.5.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wllzhang/afsim-compiler",
-  "version": "0.5.6",
+  "version": "0.5.8",
   "description": "JSON to AFSIM DSL compiler — WebAssembly build for browsers and Node.js",
   "type": "module",
   "main": "index.mjs",

package/pkg/README.md

@@ -0,0 +1,198 @@
+# AFScriptGenerator
+
+JSON to AFSIM DSL compiler.
+
+这个项目包含两个主要用法：
+
+- Rust 命令行工具：把 `.json` 文件编译为同名 `.txt` 文件。
+- npm/WASM 包：在前端或 Node 项目里通过 `compile()` 直接把 JS 对象或 JSON 字符串编译成 DSL 文本。
+
+## 环境准备
+
+需要安装：
+
+- Rust / Cargo
+- Node.js / npm
+- `wasm-pack`，用于构建 npm 包里的 WASM 文件
+
+安装 `wasm-pack`：
+
+```powershell
+cargo install wasm-pack
+```
+
+安装 WASM target：
+
+```powershell
+rustup target add wasm32-unknown-unknown
+```
+
+## Rust 命令行
+
+查看帮助：
+
+```powershell
+cargo run -- --help
+```
+
+运行编译器：
+
+```powershell
+cargo run -- docx\afsim_script\define.json
+```
+
+输出文件会自动写到输入文件同目录，扩展名改为 `.txt`：
+
+```text
+docx\afsim_script\define.txt
+```
+
+也可以先构建再运行：
+
+```powershell
+cargo build
+.\target\debug\afsim-compiler.exe docx\afsim_script\define.json
+```
+
+构建 release 版本：
+
+```powershell
+cargo build --release
+.\target\release\afsim-compiler.exe docx\afsim_script\define.json
+```
+
+## Rust 常用检查
+
+格式化代码：
+
+```powershell
+cargo fmt
+```
+
+检查编译：
+
+```powershell
+cargo check
+```
+
+运行测试：
+
+```powershell
+cargo test
+```
+
+## 本地 npm 包
+
+npm 包目录在：
+
+```text
+npm
+```
+
+包名是：
+
+```text
+@wllzhang/afsim-compiler
+```
+
+改动 `src` 后，运行一键脚本重新构建 WASM，并准备好本地 npm 包目录：
+
+```powershell
+.\script\package-npm.ps1
+```
+
+或者使用 cmd 包装脚本：
+
+```powershell
+.\script\package-npm.cmd
+```
+
+脚本会自动：
+
+- 检查 `cargo`、`node`、`npm`、`wasm-pack`、`wasm32-unknown-unknown`
+- 从 Rust `src` 重新构建 WASM 到 `npm\pkg`
+- 清理 `wasm-pack` 生成的 `npm\pkg\.gitignore`
+- 输出本地目录安装命令
+
+如果依赖缺失，脚本会打印对应的下载地址和安装命令。
+
+指定 npm 包版本：
+
+```powershell
+.\script\package-npm.ps1 -Version 0.1.1
+```
+
+跳过 WASM 构建，只整理当前 npm 目录：
+
+```powershell
+.\script\package-npm.ps1 -SkipWasmBuild
+```
+
+## 安装到另一个项目
+
+在目标项目里直接通过目录安装：
+
+```powershell
+cd D:\your-other-project
+npm install D:\code_spaces\AFScriptGenerator\npm
+```
+
+使用示例：
+
+```js
+import { compile } from '@wllzhang/afsim-compiler';
+
+const dsl = compile({
+  my_platform: {
+    type: 'platform_type',
+    parent_model: 'WSF_PLATFORM',
+    icon: 'missile',
+  },
+});
+
+console.log(dsl);
+```
+
+## Vite 项目使用
+
+这个 npm 包包含 WASM。Vite 项目建议安装 `vite-plugin-wasm`：
+
+```powershell
+npm install vite-plugin-wasm
+```
+
+`vite.config.js`：
+
+```js
+import wasm from 'vite-plugin-wasm';
+
+export default {
+  plugins: [wasm()],
+  build: { target: 'esnext' },
+};
+```
+
+## 发布
+
+发布 Rust 二进制和 npm 包的 GitHub Actions 在：
+
+```text
+.github\workflows\release-rust.yml
+```
+
+发布 workflow 当前只构建 Linux 和 Windows 产物，不再构建 macOS 产物。
+
+打 tag 后推送：
+
+```powershell
+git tag v0.1.0
+git push origin v0.1.0
+```
+
+## 清理
+
+清理 Rust 构建产物：
+
+```powershell
+cargo clean
+```

package/pkg/afsim_compiler_lib.js

@@ -1,7 +1,7 @@
 /* @ts-self-types="./afsim_compiler_lib.d.ts" */
-
 import * as wasm from "./afsim_compiler_lib_bg.wasm";
 import { __wbg_set_wasm } from "./afsim_compiler_lib_bg.js";
+
 __wbg_set_wasm(wasm);
 
 export {

package/pkg/afsim_compiler_lib_bg.js

@@ -39,8 +39,7 @@ function getDataViewMemory0() {
 }
 
 function getStringFromWasm0(ptr, len) {
-    ptr = ptr >>> 0;
-    return decodeText(ptr, len);
+    return decodeText(ptr >>> 0, len);
 }
 
 let cachedUint8ArrayMemory0 = null;