fcdev 0.3.1 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -10,7 +10,7 @@
10
10
  npm install --save-dev fcdev
11
11
  ```
12
12
 
13
- 要求 Node.js 22 及以上。cc65 编译器与模拟器是分平台的依赖包,npm 会按系统自动安装;目前 cc65 只提供 Windows x64 的包,其他系统可用环境变量 `FCDEV_CC65_HOME` 指向自备的 cc65 目录。模拟器只提供 Windows x64 的包,其他系统可用环境变量 `FCDEV_EMULATOR` 指向自备的模拟器,但调试命令需要该模拟器支持同样的调试服务。
13
+ 要求 Node.js 22 及以上。cc65 编译器与模拟器分别在 `@rujianjs/fcdev-cc65`、`@rujianjs/fcdev-emulator` 两个依赖包里,npm 会自动安装;也可以用环境变量 `FCDEV_CC65_HOME` 指向自备的 cc65 目录,用 `FCDEV_EMULATOR` 指向自备的模拟器,但调试命令需要该模拟器支持同样的调试服务。
14
14
 
15
15
  ## 使用
16
16
 
@@ -24,7 +24,7 @@ fcdev disasm game.nes # 反汇编成 ca65 源码,并回读校验
24
24
  fcdev sync # 生成 IDE 的 C/C++ 配置
25
25
  fcdev info --json # 显示目标、工具链与头文件目录
26
26
  fcdev api sb_file_open # 查询目标的 C 接口文档(函数名、模块名、$功能号或关键词;不带词列出全部模块)
27
- fcdev docs syscall # 查开发文档的本机路径与在线地址(主题名或关键词;不带词列出全部主题)
27
+ fcdev docs syscall # 查开发文档的本机路径(主题名或关键词;不带词列出全部主题)
28
28
  ```
29
29
 
30
30
  入口是 `main`(汇编程序写 `.export _main`)。产物放在项目根的 `build/<目标>/`,中间文件在 `build/obj/`。
@@ -61,9 +61,9 @@ fcdev disasm game.nes --cdl game.cdl --symbols sym.txt # 加 CDL 与符号文
61
61
  | `optimize` | `true` | 给 cc65 加优化选项 |
62
62
  | `define` | 空 | 预定义宏,值为字符串或数字 |
63
63
  | `include` | 空 | 额外的头文件目录 |
64
- | `toolchain` | 空 | 自备 cc65 的根目录,优先于平台包 |
64
+ | `toolchain` | 空 | 自备 cc65 的根目录,优先于工具链包 |
65
65
  | `firmware` | 无 | 固件(BIOS)文件;SB2000 运行时必填,fcdev 不提供任何 BIOS 或 ROM |
66
- | `emulator` | 空 | 自备模拟器的路径,优先于平台包 |
66
+ | `emulator` | 空 | 自备模拟器的路径,优先于模拟器包 |
67
67
  | `targetOptions` | 空 | 目标专用选项,如 NES 的 `font`(是否链接 ASCII 字库,默认 `true`)、SB2000 的 `banks`(大程序的库页个数,默认 0) |
68
68
 
69
69
  ## 目标
@@ -75,20 +75,20 @@ fcdev disasm game.nes --cdl game.cdl --symbols sym.txt # 加 CDL 与符号文
75
75
 
76
76
  ## 文档
77
77
 
78
- 完整的使用手册与开发文档随本包发布,装好后在 `node_modules/fcdev/docs/`,也可以在 Gitee 上阅读。终端里运行 `fcdev docs` 列出全部主题,`fcdev docs <主题>` 给出该文档的本机路径与在线地址。
78
+ 完整的使用手册与开发文档随本包发布,装好后在 `node_modules/fcdev/docs/`。终端里运行 `fcdev docs` 列出全部主题,`fcdev docs <主题>` 给出该文档的本机路径。
79
79
 
80
80
  | 想做什么 | 主题 | 文档 |
81
81
  | --- | --- | --- |
82
- | 查命令、`fcdev.json` 配置与构建流程 | `build` | [命令行与构建](https://gitee.com/sungbin/fcdev/blob/master/packages/fcdev/docs/02-命令行与构建.md) |
83
- | 开发 NES 程序 | `nes` | [NES 目标](https://gitee.com/sungbin/fcdev/blob/master/packages/fcdev/docs/nes/01-NES目标.md) |
84
- | 开发 SB2000(SB-DOS)程序 | `sb2000` | [SB2000 开发指南](https://gitee.com/sungbin/fcdev/blob/master/packages/fcdev/docs/sb2000/01-开发指南.md) |
85
- | 查 SB-DOS 系统调用与出错码 | `syscall` | [SB-DOS 系统调用手册](https://gitee.com/sungbin/fcdev/blob/master/packages/fcdev/docs/sb2000/02-系统调用手册.md) |
86
- | 查 SB2000 的硬件行为 | `hardware` | [SB2000 硬件说明](https://gitee.com/sungbin/fcdev/blob/master/packages/fcdev/docs/sb2000/03-硬件说明.md) |
87
- | 查 SB2000 运行库的 C 函数 | `api` | [SB2000 C 接口参考](https://gitee.com/sungbin/fcdev/blob/master/packages/fcdev/targets/sb2000/api-reference.md)(也可以用 `fcdev api` 查询) |
88
- | 在模拟器里运行与调试,查调试命令 | `emulator` | [模拟器与调试](https://gitee.com/sungbin/fcdev/blob/master/packages/fcdev/docs/05-模拟器与调试.md) |
89
- | 反汇编已有程序 | `disasm` | [反汇编](https://gitee.com/sungbin/fcdev/blob/master/packages/fcdev/docs/06-反汇编.md) |
90
- | 创建项目与模板 | `create` | [创建包与模板](https://gitee.com/sungbin/fcdev/blob/master/packages/fcdev/docs/07-创建包与模板.md) |
91
- | 新增机型的目标 | `targets` | [目标规范](https://gitee.com/sungbin/fcdev/blob/master/packages/fcdev/docs/03-目标规范.md) |
82
+ | 查命令、`fcdev.json` 配置与构建流程 | `build` | `docs/02-命令行与构建.md` |
83
+ | 开发 NES 程序 | `nes` | `docs/nes/01-NES目标.md` |
84
+ | 开发 SB2000(SB-DOS)程序 | `sb2000` | `docs/sb2000/01-开发指南.md` |
85
+ | 查 SB-DOS 系统调用与出错码 | `syscall` | `docs/sb2000/02-系统调用手册.md` |
86
+ | 查 SB2000 的硬件行为 | `hardware` | `docs/sb2000/03-硬件说明.md` |
87
+ | 查 SB2000 运行库的 C 函数 | `api` | `targets/sb2000/api-reference.md`(也可以用 `fcdev api` 查询) |
88
+ | 在模拟器里运行与调试,查调试命令 | `emulator` | `docs/05-模拟器与调试.md` |
89
+ | 反汇编已有程序 | `disasm` | `docs/06-反汇编.md` |
90
+ | 创建项目与模板 | `create` | `docs/07-创建包与模板.md` |
91
+ | 新增机型的目标 | `targets` | `docs/03-目标规范.md` |
92
92
 
93
93
  ## 限制
94
94
 
@@ -98,4 +98,4 @@ fcdev disasm game.nes --cdl game.cdl --symbols sym.txt # 加 CDL 与符号文
98
98
 
99
99
  ## 许可证
100
100
 
101
- Apache-2.0。cc65 部分为 zlib 许可,模拟器为 GPL-3.0,各自随平台包附带许可文件。
101
+ Apache-2.0。cc65 部分为 zlib 许可,模拟器为 GPL-3.0,各自随工具链包与模拟器包附带许可文件。
@@ -15,7 +15,7 @@ fcdev 是 6502 兼容机的开发工具集:一套用 npm 发布的开发环境
15
15
  范围外:
16
16
 
17
17
  - VS Code 扩展的任务、命令与调试:登记在 [待办备忘](待办备忘.md)。
18
- - BIOS 与固件的反汇编整理,BIOS 迁移到 ca65:不在本仓库范围。
18
+ - BIOS 与固件的反汇编整理,BIOS 迁移到 ca65:不属于 fcdev,各机型的这类工作放在仓库的 `machines/<机型>/`(如 `machines/sb2000/`)。
19
19
  - 把模拟器内核集成进 VS Code 面板,以及调试适配器协议(DAP)。
20
20
  - 步步高、裕兴的目标定义:缺少资料,加入前先调研。
21
21
  - 任何机型的 BIOS、ROM 文件:不随包发布,由用户提供。
@@ -26,14 +26,14 @@ fcdev 是 6502 兼容机的开发工具集:一套用 npm 发布的开发环境
26
26
  | 编号 | 决策 | 原因 |
27
27
  | --- | --- | --- |
28
28
  | D01 | 用 npm 包发布命令行、目标、模板、编译器与模拟器 | 项目锁定版本;终端、CI 与 Copilot 都能构建,不依赖 VS Code |
29
- | D02 | 包名:主包 `fcdev`,创建包 `create-fcdev`,工具链包 `@rujianjs/fcdev-cc65-<系统>-<架构>`,模拟器包 `@rujianjs/fcdev-emulator-<系统>-<架构>`;主包与创建包不带作用域,平台包放进 `@rujianjs` 作用域,目录名仍是 `fcdev-cc65-<系统>-<架构>`、`fcdev-emulator-<系统>-<架构>` | `npm create fcdev` 会自动运行 `create-fcdev`;不带作用域的平台包名发布时被 npm 的垃圾包名检测拦截(403);平台包只被主包依赖,使用者不直接输入名字,带作用域没有影响;作用域包要在 `package.json` 里写 `publishConfig.access` 为 `public` |
29
+ | D02 | 包名:主包 `fcdev`,创建包 `create-fcdev`,工具链包 `@rujianjs/fcdev-cc65`,模拟器包 `@rujianjs/fcdev-emulator`;主包与创建包不带作用域,工具链包与模拟器包放进 `@rujianjs` 作用域,目录名是 `fcdev-cc65`、`fcdev-emulator` | `npm create fcdev` 会自动运行 `create-fcdev`;不带作用域的包名发布时被 npm 的垃圾包名检测拦截(403);这两个包只被主包依赖,使用者不直接输入名字,带作用域没有影响;作用域包要在 `package.json` 里写 `publishConfig.access` 为 `public` |
30
30
  | D03 | 命令行与库用 Node 22 的 ESM(`.mjs`)加 JSDoc,运行时无依赖,不需要构建步骤 | 发布内容就是源码,便于核对 |
31
- | D04 | 用 npm workspaces 管理多个包,所有包同一个版本号,同步发布;主包对平台包写精确版本 | 命令行、目标、编译器与模拟器必须配套 |
31
+ | D04 | 用 npm workspaces 管理多个包,所有包同一个版本号,同步发布;主包对工具链包与模拟器包写精确版本 | 命令行、目标、编译器与模拟器必须配套 |
32
32
  | D05 | 一种机型是一个“目标”,是主包内 `targets/<名>/` 一个目录;新增机型只加目录,不改构建流程 | 多机型扩展 |
33
33
  | D06 | 目标声明可选能力:磁盘镜像、模拟器运行;没有该能力的目标,对应命令明确报错 | NES 没有磁盘,学习机有 |
34
34
  | D07 | 构建由 `fcdev` 自己判断增量,不用 `make` | Windows 上不必另装 `make` |
35
35
  | D08 | 目标运行库在发布前用 `cc65`、`ca65`、`ar65` 编译成 `.lib` 随包发布(C 与汇编源码都可以,一个函数一个目标文件) | 目标文件格式与平台无关,使用者不必再编译库 |
36
- | D09 | 工具与模拟器按平台分包,用 `optionalDependencies` 让 npm 只装当前系统的那个 | 与 esbuild 等相同的成熟做法 |
36
+ | D09 | 工具链与模拟器是体积较大的二进制,各放在独立的包里,主包用 `optionalDependencies` 引用 | 不适用的环境可以跳过安装,也不拖慢主包 |
37
37
  | D10 | 许可证分区,见第 7 节 | 各自保留原许可证,作为独立程序互不影响 |
38
38
  | D11 | cc65 与模拟器的源码放在仓库根目录的 `cc65/` 与 `virtuanes/`,由本仓库维护 | 以后在本仓库里直接修改与升级,来源仍可核对 |
39
39
  | D12 | 反汇编不改 `da65` 的 C 代码,用前端脚本生成它的信息文件 | 只有实测发现信息文件无法表达时才改,见 [06-反汇编](06-反汇编.md) |
@@ -44,8 +44,8 @@ fcdev 是 6502 兼容机的开发工具集:一套用 npm 发布的开发环境
44
44
  flowchart LR
45
45
  CREATE[create-fcdev] -->|生成的项目依赖| CLI[fcdev 主包]
46
46
  CLI --> TG[内置目标: nes、sb2000]
47
- CLI -->|optionalDependencies| TC[fcdev-cc65 平台包]
48
- CLI -->|optionalDependencies| EM[fcdev-emulator 平台包]
47
+ CLI -->|optionalDependencies| TC[fcdev-cc65 工具链包]
48
+ CLI -->|optionalDependencies| EM[fcdev-emulator 模拟器包]
49
49
  EXT[VS Code 扩展] -.->|调用命令行| CLI
50
50
  ```
51
51
 
@@ -53,8 +53,8 @@ flowchart LR
53
53
  | --- | --- | --- |
54
54
  | `fcdev` | 命令行、构建核心、内置目标、反汇编前端 | 是 |
55
55
  | `create-fcdev` | 创建项目的命令与四个模板 | 是 |
56
- | `@rujianjs/fcdev-cc65-win32-x64` | cc65、ca65、ld65、ar65、da65,头文件、库与链接配置 | 只入库 `package.json`,其余由脚本生成 |
57
- | `@rujianjs/fcdev-emulator-win32-x64` | 调试用模拟器可执行文件 | 只入库 `package.json` 与 `SOURCE.txt`,其余由脚本生成 |
56
+ | `@rujianjs/fcdev-cc65` | cc65、ca65、ld65、ar65、da65,头文件、库与链接配置 | 只入库 `package.json`,其余由脚本生成 |
57
+ | `@rujianjs/fcdev-emulator` | 调试用模拟器可执行文件 | 只入库 `package.json`,其余由脚本生成 |
58
58
 
59
59
  - 主包不引用具体机型的代码,只读取 `targets/` 下的目标定义。
60
60
  - 主包找不到工具链或模拟器时,不去 `PATH` 里猜,报错并说明可选的解决办法。
@@ -62,7 +62,7 @@ flowchart LR
62
62
  ## 4. 仓库目录
63
63
 
64
64
  ```text
65
- fcdev/
65
+ famiclone/
66
66
  LICENSE Apache-2.0
67
67
  README.md 使用说明
68
68
  package.json 工作区根(private)
@@ -75,14 +75,15 @@ fcdev/
75
75
  test/
76
76
  create-fcdev/ 创建包
77
77
  bin/ src/ templates/ test/
78
- fcdev-cc65-win32-x64/ 工具链平台包
79
- fcdev-emulator-win32-x64/ 模拟器平台包
78
+ fcdev-cc65/ 工具链包
79
+ fcdev-emulator/ 模拟器包
80
80
  cc65/ cc65 源码(删减版,本仓库维护)
81
- virtuanes/ 模拟器源码(改造版,本仓库维护)
81
+ virtuanes/ 模拟器源码(VirtuaNES 调试版,本仓库维护)
82
82
  vscode/ VS Code 扩展(独立的 npm 项目,不在工作区里),见 [10-VS Code扩展](10-VS%20Code扩展.md)
83
83
  tools/ 维护脚本,见第 8 节
84
- examples/ 示例项目(examples/sb2000:SB-DOS 程序),不在工作区里,见 [sb2000/01-开发指南](sb2000/01-开发指南.md) 第 10 节
85
- test/ 仓库级测试:目录结构、cc65 平台包、SB2000 头文件
84
+ apps/ 应用程序与示例(apps/sb2000:SB-DOS 的 asm、edit、runnes、disk 与 examples 示例),不在工作区里,见 [sb2000/01-开发指南](sb2000/01-开发指南.md) 第 10 节
85
+ test/ 仓库级测试:目录结构、cc65 工具链包、SB2000 头文件
86
+ machines/ 各机型的资料与工程(不属于 fcdev 包,不随包发布),一个机型一个目录,如 machines/sb2000
86
87
  build/ 构建中间目录(不入库)
87
88
  ```
88
89
 
@@ -94,7 +95,7 @@ fcdev/
94
95
  | --- | --- | --- |
95
96
  | `shared` | 错误类型、文件与进程小工具 | 无 |
96
97
  | `api` | 目标的 C 接口文档:解析头文件文档注释、查询与格式化 | 无 |
97
- | `docs` | 开发文档的主题登记表:主题名、文件、标题、说明,以及本机与在线地址 | `shared` |
98
+ | `docs` | 开发文档的主题登记表:主题名、文件、标题、说明,以及本机路径 | `shared` |
98
99
  | `config` | 查找与读取 `fcdev.json` | `shared` |
99
100
  | `targets` | 目标注册表、程序名规则 | `shared` |
100
101
  | `toolchain` | 定位与调用 cc65 工具链 | `shared` |
@@ -106,7 +107,7 @@ fcdev/
106
107
 
107
108
  - `bin/fcdev.mjs` 只调用 `cli` 的 `runCli`。
108
109
  - `targets`、`toolchain`、`packagers` 之间不互相引用,由 `build` 组装。
109
- - 依赖表在 [tools/check-structure.mjs](https://gitee.com/sungbin/fcdev/blob/master/tools/check-structure.mjs) 里登记,`npm run boundaries` 检查;新增目录要先登记,改表时同步改本节。
110
+ - 依赖表在 `tools/check-structure.mjs` 里登记,`npm run boundaries` 检查;新增目录要先登记,改表时同步改本节。
110
111
 
111
112
  ## 6. 错误处理
112
113
 
@@ -120,17 +121,17 @@ fcdev/
120
121
  | 部分 | 许可证 |
121
122
  | --- | --- |
122
123
  | 仓库与 `fcdev`、`create-fcdev` 自己的代码 | Apache-2.0,见根目录 `LICENSE` |
123
- | `cc65/` 及工具链平台包 | zlib,见 `cc65/LICENSE` |
124
- | `virtuanes/` 及模拟器平台包 | GPL-3.0-only,见 `virtuanes/LICENSE` |
124
+ | `cc65/` 及工具链包 | zlib,见 `cc65/LICENSE` |
125
+ | `virtuanes/` 及模拟器包 | GPL-3.0-only,见 `virtuanes/LICENSE` |
125
126
 
126
- 模拟器源码里只有 `interp.h`、`nx_hq2x.h`、`nx_Scale2x.h` 三个文件头写“版本 2 或以后”,合并后按 GPLv3 发布。两个平台包都是独立程序,许可证互不影响。
127
+ 模拟器源码里只有 `interp.h`、`nx_hq2x.h`、`nx_Scale2x.h` 三个文件头写“版本 2 或以后”,合并后按 GPLv3 发布。两个包都是独立程序,许可证互不影响。
127
128
 
128
129
  ## 8. 维护脚本
129
130
 
130
131
  | 脚本 | 作用 |
131
132
  | --- | --- |
132
- | `tools/build-cc65.mjs` | 构建 cc65 工具与运行库,组装 `@rujianjs/fcdev-cc65-<系统>-<架构>`,见 [04-cc65工具链](04-cc65工具链.md) |
133
- | `tools/build-emulator.mjs` | 构建模拟器,组装 `@rujianjs/fcdev-emulator-win32-x64`,见 [05-模拟器与调试](05-模拟器与调试.md) |
133
+ | `tools/build-cc65.mjs` | 构建 cc65 工具与运行库,组装 `@rujianjs/fcdev-cc65`,见 [04-cc65工具链](04-cc65工具链.md) |
134
+ | `tools/build-emulator.mjs` | 构建模拟器,组装 `@rujianjs/fcdev-emulator`,见 [05-模拟器与调试](05-模拟器与调试.md) |
134
135
  | `tools/build-libs.mjs` | 按各目标的 `lib-build.json` 用 `cc65`、`ca65`、`ar65` 编出 `lib/` 下的运行库(`.c` 与 `.s` 源码,目录项递归展开);`fcdev` 的 `prepack` 与 `npm test` 前自动运行 |
135
136
  | `tools/gen-sb2000-header.mjs` | 由 `sb2000.inc` 生成 `sb2000-symbols.h` |
136
137
  | `tools/check-sb2000-api.mjs` | 检查 SB2000 的 C 接口:函数文档完整、有且只有一处实现、每个功能号被封装或写明不封装的原因,见 [sb2000/01-开发指南](sb2000/01-开发指南.md) 第 6 节 |
@@ -138,17 +139,18 @@ fcdev/
138
139
  | `tools/check-structure.mjs` | 检查主包各层的依赖方向(`npm run boundaries`) |
139
140
  | `tools/release-check.mjs` | 发布前检查(`npm run release:check`),见 [09-发布](09-发布.md) |
140
141
  | `tools/verify-install.mjs` | 打包后在临时目录里创建、安装并构建四个模板(`npm run release:verify`) |
142
+ | `tools/release.mjs` | 发布脚本:升版本号、检查、试发布与按顺序发布(`npm run release:prepare`、`npm run release:publish`),见 [09-发布](09-发布.md) 第 6 节 |
141
143
 
142
144
  ## 9. 文档清单
143
145
 
144
- 文档放在主包的 `docs/` 目录,在这里维护,随 `fcdev` 包一起发布:安装后在 `node_modules/fcdev/docs/`,在线在 Gitee 仓库的 `packages/fcdev/docs/`。`fcdev docs` 列出全部主题并给出本机路径与在线地址,主题登记在 `src/docs/doc-topics.mjs`;新增、改名或删除文档时同步改登记,测试会核对登记与目录一致。文档里指向主包内文件的链接用相对路径,指向仓库其他目录(`tools/`、`virtuanes/`、`vscode/` 等,不随包发布)的链接用 Gitee 地址。`api` 主题是例外:它指向目标目录里由头文件文档注释生成的接口参考,不放进 `docs/`,避免两份不一致。
146
+ 文档放在主包的 `docs/` 目录,在这里维护,随 `fcdev` 包一起发布:安装后在 `node_modules/fcdev/docs/`。`fcdev docs` 列出全部主题并给出本机路径,主题登记在 `src/docs/doc-topics.mjs`;新增、改名或删除文档时同步改登记,测试会核对登记与目录一致。文档里指向主包内文件的链接用相对路径,指向仓库其他目录(`tools/`、`virtuanes/`、`vscode/` 等,不随包发布)的文件只写路径,不做链接。`api` 主题是例外:它指向目标目录里由头文件文档注释生成的接口参考,不放进 `docs/`,避免两份不一致。
145
147
 
146
148
  | 主题 | 文档 | 内容 |
147
149
  | --- | --- | --- |
148
150
  | `architecture` | 01-软件架构设计 | 本文 |
149
151
  | `build` | [02-命令行与构建](02-命令行与构建.md) | 命令、构建规则、配置文件、构建流程 |
150
152
  | `targets` | [03-目标规范](03-目标规范.md) | 目标定义、打包器、新增机型的步骤 |
151
- | `toolchain` | [04-cc65工具链](04-cc65工具链.md) | cc65 源码、构建与平台包 |
153
+ | `toolchain` | [04-cc65工具链](04-cc65工具链.md) | cc65 源码、构建与工具链包 |
152
154
  | `emulator` | [05-模拟器与调试](05-模拟器与调试.md) | 运行方案、调试服务与命令表、模拟器包 |
153
155
  | `disasm` | [06-反汇编](06-反汇编.md) | 反汇编前端的流程与限制 |
154
156
  | `create` | [07-创建包与模板](07-创建包与模板.md) | 创建命令、模板与生成内容 |
@@ -16,7 +16,7 @@
16
16
  | `fcdev sync` | 生成 IDE 配置,见第 6 节 |
17
17
  | `fcdev info [--json]` | 显示目标、工具链与头文件目录 |
18
18
  | `fcdev api [词] [--json]` | 查询目标的 C 接口文档,见第 5.1 节 |
19
- | `fcdev docs [词] [--json]` | 查询开发文档的本机路径与在线地址,见第 5.2 节 |
19
+ | `fcdev docs [词] [--json]` | 查询开发文档的本机路径,见第 5.2 节 |
20
20
 
21
21
  通用选项:
22
22
 
@@ -58,7 +58,7 @@
58
58
  | `optimize` | 布尔 | `true` | 给 `cc65` 加 `-Oirs` |
59
59
  | `define` | 对象 | 空 | 预定义宏,值为字符串或数字 |
60
60
  | `include` | 字符串数组 | 空 | 额外头文件目录,相对项目根 |
61
- | `toolchain` | 字符串 | 空 | 自备 cc65 的根目录,优先于平台包 |
61
+ | `toolchain` | 字符串 | 空 | 自备 cc65 的根目录,优先于工具链包 |
62
62
  | `firmware` | 字符串 | 无 | 固件(BIOS、ROM)文件路径;目标的运行方案要求固件时必填 |
63
63
  | `emulator` | 字符串 | 空 | 自备模拟器可执行文件路径,优先于模拟器包 |
64
64
  | `targetOptions` | 对象 | 空 | 目标专用选项,由各目标定义并校验 |
@@ -110,7 +110,7 @@
110
110
 
111
111
  1. 配置项 `toolchain`。
112
112
  2. 环境变量 `FCDEV_CC65_HOME`。
113
- 3. 平台包 `@rujianjs/fcdev-cc65-<系统>-<架构>`。
113
+ 3. 工具链包 `@rujianjs/fcdev-cc65`。
114
114
 
115
115
  目录里必须有 `bin` 下的 `cc65`、`ca65`、`ld65`,否则报“不是完整的 cc65 目录”。都找不到时报错并写明三种解决办法。不使用 `PATH` 里的 cc65,避免版本不一致。
116
116
 
@@ -141,12 +141,11 @@
141
141
  | 用法 | 结果 |
142
142
  | --- | --- |
143
143
  | `fcdev docs` | 列出全部主题(主题名、标题、一句话说明)与本机文档目录 |
144
- | `fcdev docs <主题>` | 该文档的标题、说明、本机绝对路径与在线地址,如 `fcdev docs syscall` |
144
+ | `fcdev docs <主题>` | 该文档的标题、说明与本机绝对路径,如 `fcdev docs syscall` |
145
145
  | `fcdev docs <词>` | 按文件名(去掉序号与扩展名也可)或主题、标题、说明里的关键词查找;只匹配到一份时同上,多份时列出摘要 |
146
146
 
147
- - 查询依次按主题名、文件名、关键词匹配,先匹配上的为准;一份都没有匹配上时报“没有找到”。`--json` 输出机器可读的结果:不带查询词时是全部文档,否则是匹配到的文档,每项含 `topic`、`title`、`summary`、`file`、`localPath`、`onlineUrl`。
148
- - 在线地址由主包 `package.json` 的 `repository` 推出(仓库地址加 `directory`),分支固定为 `master`,路径里的中文与空格已编码。
149
- - 登记项默认是 `docs/` 下的文件;登记项带 `inPackage` 时指向主包根目录下的文件,目前只有 `api` 主题(`targets/sb2000/api-reference.md`),它的在线地址不带 `docs/`。
147
+ - 查询依次按主题名、文件名、关键词匹配,先匹配上的为准;一份都没有匹配上时报“没有找到”。`--json` 输出机器可读的结果:不带查询词时是全部文档,否则是匹配到的文档,每项含 `topic`、`title`、`summary`、`file`、`localPath`。
148
+ - 登记项默认是 `docs/` 下的文件;登记项带 `inPackage` 时指向主包根目录下的文件,目前只有 `api` 主题(`targets/sb2000/api-reference.md`)。
150
149
  - 文档目录不存在时报错,提示改读在线文档。
151
150
 
152
151
  ## 6. `fcdev sync`
@@ -1,6 +1,6 @@
1
1
  # cc65 工具链
2
2
 
3
- `fcdev` 用 cc65 编译与链接,不使用使用者机器上自带的 cc65。cc65 的源码在本仓库的 `cc65/` 目录,由本仓库维护;构建脚本把它编成工具与运行库,组装成平台包 `@rujianjs/fcdev-cc65-<系统>-<架构>` 随 npm 发布。工具链怎么被主包找到,见 [02-命令行与构建](02-命令行与构建.md) 第 4.4 节。
3
+ `fcdev` 用 cc65 编译与链接,不使用使用者机器上自带的 cc65。cc65 的源码在本仓库的 `cc65/` 目录,由本仓库维护;构建脚本把它编成工具与运行库,组装成工具链包 `@rujianjs/fcdev-cc65` 随 npm 发布。工具链怎么被主包找到,见 [02-命令行与构建](02-命令行与构建.md) 第 4.4 节。
4
4
 
5
5
  ## 1. 源码目录 `cc65/`
6
6
 
@@ -26,23 +26,22 @@
26
26
  node tools/build-cc65.mjs
27
27
  ```
28
28
 
29
- [tools/build-cc65.mjs](https://gitee.com/sungbin/fcdev/blob/master/tools/build-cc65.mjs) 做的事:
29
+ `tools/build-cc65.mjs` 做的事:
30
30
 
31
31
  1. 把 `cc65/` 整个复制到 `build/cc65-work`,在副本里构建,不污染源码目录。
32
32
  2. 在 `src` 里构建 `ar65`、`ca65`、`cc65`、`da65`、`ld65`,版本串显式传 `BUILD_ID=Git <提交前 7 位>`;不传时 `Makefile` 会取当前目录所在仓库(也就是 `fcdev`)的提交号,版本输出会指向错误的提交。
33
33
  3. 在 `libsrc` 里构建 `none` 与 `nes` 两个运行库。
34
- 4. 组装平台包:`bin/` 放五个可执行文件,另有 `include/`、`asminc/`、`cfg/`、`lib/none.lib`、`lib/nes.lib`、`LICENSE`。
35
- 5. 写 `manifest.json`(上游地址、提交、系统、架构、各文件的 SHA-256)与 `package.json`(版本与主包同步,`os`、`cpu` 限定平台)。
34
+ 4. 组装工具链包:`bin/` 放五个可执行文件,另有 `include/`、`asminc/`、`cfg/`、`lib/none.lib`、`lib/nes.lib`、`LICENSE`。
35
+ 5. 写 `manifest.json`(上游地址、提交、各文件的 SHA-256)与 `package.json`(版本与主包同步)。
36
36
 
37
- Windows 用 `mingw32-make` 与 `gcc`,其他系统用 `make` 与 `cc`,环境变量 `FCDEV_MAKE` 可指定 make 程序。上游提交号常量 `CC65_COMMIT` 写在构建脚本里。
37
+ 用 `mingw32-make` 与 `gcc` 构建,环境变量 `FCDEV_MAKE` 可指定 make 程序。上游提交号常量 `CC65_COMMIT` 写在构建脚本里。
38
38
 
39
- ## 3. 平台包
39
+ ## 3. 工具链包
40
40
 
41
- - 包名 `@rujianjs/fcdev-cc65-<系统>-<架构>`(目录名不含作用域,仍是 `fcdev-cc65-<系统>-<架构>`),用 `os`、`cpu` 字段让 npm 只在对应系统安装,主包把它列为 `optionalDependencies`,版本精确一致。
41
+ - 包名 `@rujianjs/fcdev-cc65`(目录名不含作用域,是 `fcdev-cc65`),主包把它列为 `optionalDependencies`,版本精确一致。
42
42
  - 入库的只有 `package.json`;`bin/`、`include/`、`asminc/`、`lib/`、`cfg/`、`LICENSE`、`manifest.json` 都是生成物,由 `.gitignore` 排除。
43
- - 首批只发布 `win32-x64`。`darwin-arm64`、`linux-x64` 的构建脚本相同,但没有在这些系统上运行或验证,验证后再发布;发布前主包不列出它们。
44
- - 主包在没有平台包的系统上运行时,提示可用环境变量 `FCDEV_CC65_HOME` 指向自备的 cc65 目录。
45
- - `npm run release:check` 校验平台包里的文件与清单一致,且没有清单之外的文件;源码目录里的路径和清单由 `test/cc65-tools.test.mjs` 检查,见 [08-测试与验证](08-测试与验证.md)。
43
+ - 主包找不到工具链包时,提示可用环境变量 `FCDEV_CC65_HOME` 指向自备的 cc65 目录。
44
+ - `npm run release:check` 校验工具链包里的文件与清单一致,且没有清单之外的文件;源码目录里的路径和清单由 `test/cc65-tools.test.mjs` 检查,见 [08-测试与验证](08-测试与验证.md)。
46
45
 
47
46
  ## 4. 升级与修改
48
47
 
@@ -1,12 +1,12 @@
1
1
  # 模拟器与调试
2
2
 
3
- `fcdev` 自带一个调试用模拟器:VirtuaNES 的改造版,带调试服务,能运行 NES 游戏,以及 SB2000 等学习机的固件与程序。它的源码在本仓库的 `virtuanes/` 目录,由本仓库维护;构建脚本把它编成平台包 `@rujianjs/fcdev-emulator-win32-x64` 随 npm 发布。模拟器的改动清单见 [virtuanes/README.md](https://gitee.com/sungbin/fcdev/blob/master/virtuanes/README.md),调试服务的命令表见第 5.1 节。
3
+ `fcdev` 自带一个调试用模拟器:VirtuaNES 调试版,带调试服务,能运行 NES 游戏,以及 SB2000 等学习机的固件与程序。它的源码在本仓库的 `virtuanes/` 目录,由本仓库维护;构建脚本把它编成模拟器包 `@rujianjs/fcdev-emulator` 随 npm 发布。模拟器的改动清单见 `virtuanes/README.md`,调试服务的命令表见第 5.1 节。
4
4
 
5
5
  ## 1. 模拟器包
6
6
 
7
- - 只支持 Windows(Win32、DirectX)。许可证 GPL-3.0-only,包里附许可文件与 `SOURCE.txt`(写明源码仓库、目录、提交和编译命令)。
7
+ - 基于 Win32 与 DirectX。许可证 GPL-3.0-only,包里附许可文件。
8
8
  - 模拟器是 32 位程序,`bin/` 里随带 `vcruntime140.dll`、`msvcp140.dll`(应用本地部署)。
9
- - 包内容:`bin/VirtuaNES.exe`、`bin/Chinese.vlp`、两个运行库、`LICENSE`、`SOURCE.txt`、`manifest.json`、`package.json`。入库的只有 `package.json` 与 `SOURCE.txt`,其余是生成物。
9
+ - 包内容:`bin/VirtuaNES.exe`、`bin/Chinese.vlp`、两个运行库、`LICENSE`、`manifest.json`、`package.json`。入库的只有 `package.json`,其余是生成物。
10
10
  - 模拟器运行时会在 `bin/` 里写 `VirtuaNES.ini` 与 `save/`,发布前要删除;`release-check` 会把它们当作清单之外的文件报错。
11
11
 
12
12
  构建:
@@ -15,7 +15,7 @@
15
15
  node tools/build-emulator.mjs
16
16
  ```
17
17
 
18
- [tools/build-emulator.mjs](https://gitee.com/sungbin/fcdev/blob/master/tools/build-emulator.mjs) 只能在 Windows 上运行,需要 Visual Studio(含“使用 C++ 的桌面开发”)。它调用 `virtuanes/build.ps1 -Configuration Release`,把 `VirtuaNES.exe` 与 `Chinese.vlp` 复制进 `bin/`,再用 `vswhere` 找到 Visual Studio 里 32 位的 VC++ 运行库一并放入,最后写 `LICENSE`、`SOURCE.txt`、`manifest.json`(当前提交、`virtuanes/` 有无未提交改动 `sourceDirty`、各文件的 SHA-256)与 `package.json`。编译前先关闭正在运行的模拟器。
18
+ `tools/build-emulator.mjs` 需要 Visual Studio(含“使用 C++ 的桌面开发”)。它调用 `virtuanes/build.ps1 -Configuration Release`,把 `VirtuaNES.exe` 与 `Chinese.vlp` 复制进 `bin/`,再用 `vswhere` 找到 Visual Studio 里 32 位的 VC++ 运行库一并放入,最后写 `LICENSE`、`manifest.json`(当前提交、`virtuanes/` 有无未提交改动 `sourceDirty`、各文件的 SHA-256)与 `package.json`。编译前先关闭正在运行的模拟器。
19
19
 
20
20
  ## 2. 定位模拟器
21
21
 
@@ -23,9 +23,9 @@ node tools/build-emulator.mjs
23
23
 
24
24
  1. 配置项 `emulator`。
25
25
  2. 环境变量 `FCDEV_EMULATOR`。
26
- 3. 平台包 `@rujianjs/fcdev-emulator-<系统>-<架构>` 里的 `bin/VirtuaNES.exe`。
26
+ 3. 模拟器包 `@rujianjs/fcdev-emulator` 里的 `bin/VirtuaNES.exe`。
27
27
 
28
- 指定的路径不存在时报“找不到模拟器”。不是 Windows 且没有指定自备模拟器时报“模拟器只支持 Windows”,构建不受影响;自备的模拟器需要支持同样的调试服务才能用调试命令。
28
+ 指定的路径不存在时报“找不到模拟器”。自备的模拟器需要支持同样的调试服务才能用调试命令。
29
29
 
30
30
  ## 3. `fcdev run`
31
31
 
@@ -22,9 +22,9 @@ VS Code 扩展是独立的 npm 项目,测试在 `vscode/test/`,用 vitest;
22
22
 
23
23
  | 变量 | 作用 |
24
24
  | --- | --- |
25
- | `FCDEV_CC65_HOME` | 指向自备的 cc65 目录;没有平台包时用它跑集成测试 |
25
+ | `FCDEV_CC65_HOME` | 指向自备的 cc65 目录;没有工具链包时用它跑集成测试 |
26
26
  | `FCDEV_EMULATOR` | 指向自备的模拟器 |
27
- | `FCDEV_TEST_FIRMWARE` | 指向 SB2000 的 BIOS 文件;设置后额外运行“SB2000 程序在模拟器里运行”的用例(仓库不提供 BIOS) |
27
+ | `FCDEV_TEST_FIRMWARE` | 指向 SB2000 的 BIOS 文件(仓库里有一份:`machines/sb2000/reference/rom/SB2K_BIOS.NES`);设置后额外运行“SB2000 程序在模拟器里运行”的用例 |
28
28
  | `FCDEV_TEST_NES_ROM` | 指向一个 NROM 的 `.nes` 文件;设置后额外对它做完整反汇编与回读 |
29
29
  | `FCDEV_SKIP_GUI_TESTS` | 设为 `1` 时跳过会打开模拟器窗口的用例 |
30
30
 
@@ -39,7 +39,7 @@ VS Code 扩展是独立的 npm 项目,测试在 `vscode/test/`,用 vitest;
39
39
  | 反汇编 | `disasm` | 映像读取、CDL 与轨迹解析、静态追踪、信息文件、回读校验;对 `fcdev` 自己构建的 NES 与 SB2000 程序做完整反汇编;设置 `FCDEV_TEST_NES_ROM` 时对真实游戏做反汇编 |
40
40
  | 创建包 | `create`(`create-fcdev`) | 参数解析、模板列表、项目生成、目录检查、交互选择、安装流程;四个模板都能用 `fcdev` 构建 |
41
41
  | 接口文档 | `api-command`(主包)、`sb2000-api`(仓库) | `fcdev api` 命令的各种查询与错误提示、头文件文档注释的解析、系统调用标签的匹配;SB2000 接口检查(函数文档完整、有且只有一处实现、每个功能号被封装或写明不封装的原因);入库的 `api-reference.md` 与头文件生成的结果一致 |
42
- | 仓库 | `cc65-tools`、`sb2000-header`、`structure` | `cc65/` 里的必要路径与平台包的校验值;入库的 `sb2000-symbols.h` 与生成结果一致;分层检查对违规的识别 |
42
+ | 仓库 | `cc65-tools`、`sb2000-header`、`structure` | `cc65/` 里的必要路径与工具链包的校验值;入库的 `sb2000-symbols.h` 与生成结果一致;分层检查对违规的识别 |
43
43
  | 文档 | `docs-command`(主包) | `fcdev docs` 命令的列表、按主题名、文件名与关键词查询、`--json`、错误提示;文档主题登记与 `docs/` 目录里的文件一一对应(包内其他位置的登记项文件必须存在),主题名合法且不重复,架构文档的文档清单列全了每个主题 |
44
44
 
45
45
  集成测试用真实的 cc65 构建四个模板,检查产物头部与大小。
@@ -57,16 +57,16 @@ VS Code 扩展是独立的 npm 项目,测试在 `vscode/test/`,用 vitest;
57
57
 
58
58
  ## 6. 安装验证
59
59
 
60
- `npm run release:verify`([tools/verify-install.mjs](https://gitee.com/sungbin/fcdev/blob/master/tools/verify-install.mjs)):
60
+ `npm run release:verify`(`tools/verify-install.mjs`):
61
61
 
62
62
  1. 把四个包用 `npm pack` 打成 `.tgz`。
63
63
  2. 在临时目录里从本地 `.tgz` 安装 `create-fcdev`,不访问 npm 仓库,也不执行 `npm publish`。
64
- 3. 对四个模板分别:用 `create-fcdev` 创建项目(`--no-install`),从本地 `.tgz` 安装 `fcdev` 与两个平台包,运行 `npm run build`,检查产物头部:NES 为 iNES 文件头,SB2000 为 `4C ?? ?? AA 55`。
64
+ 3. 对四个模板分别:用 `create-fcdev` 创建项目(`--no-install`),从本地 `.tgz` 安装 `fcdev` 与两个工具链、模拟器包,运行 `npm run build`,检查产物头部:NES 为 iNES 文件头,SB2000 为 `4C ?? ?? AA 55`。
65
65
  4. 结束后删除临时目录;加 `--keep` 可保留,便于查看。
66
66
 
67
67
  只验证构建,不启动模拟器。
68
68
 
69
69
  ## 7. 注意事项
70
70
 
71
- - 带真实模拟器的用例运行后会在模拟器平台包的 `bin/` 里生成 `VirtuaNES.ini` 与 `save/`;发布前必须删除,`release:check` 会把它们当作清单之外的文件报错。
71
+ - 带真实模拟器的用例运行后会在模拟器包的 `bin/` 里生成 `VirtuaNES.ini` 与 `save/`;发布前必须删除,`release:check` 会把它们当作清单之外的文件报错。
72
72
  - 没有目测的界面输出,汇报时写明。
@@ -6,33 +6,33 @@
6
6
 
7
7
  | 包 | 说明 |
8
8
  | --- | --- |
9
- | `@rujianjs/fcdev-cc65-win32-x64` | 工具链平台包,目录 `packages/fcdev-cc65-win32-x64` |
10
- | `@rujianjs/fcdev-emulator-win32-x64` | 模拟器平台包,目录 `packages/fcdev-emulator-win32-x64` |
11
- | `fcdev` | 主包,对两个平台包写精确版本的 `optionalDependencies` |
9
+ | `@rujianjs/fcdev-cc65` | 工具链包,目录 `packages/fcdev-cc65` |
10
+ | `@rujianjs/fcdev-emulator` | 模拟器包,目录 `packages/fcdev-emulator` |
11
+ | `fcdev` | 主包,对两个包写精确版本的 `optionalDependencies` |
12
12
  | `create-fcdev` | 创建包;生成的项目依赖与它同版本的 `fcdev` |
13
13
 
14
- - 四个包同一个版本号,由 `release-check` 检查;`fcdev` 对平台包的依赖版本必须与之相同。
15
- - 两个平台包的包名带 `@rujianjs` 作用域,目录名不带。作用域包默认不能公开发布,所以它们的 `package.json` 写了 `publishConfig.access` 为 `public`,`release-check` 会检查这一项,以及平台包的包名是否都在 `fcdev` 的 `optionalDependencies` 里。
16
- - 平台包不带作用域的名字发布时被 npm 的垃圾包名检测拦截(403),所以改用作用域,见 [01-软件架构设计](01-软件架构设计.md) 的 D02。
17
- - 两个平台包的 `package.json` 由构建脚本生成,版本取主包的版本。修改版本号后,要重新运行 `node tools/build-cc65.mjs` 与 `node tools/build-emulator.mjs`。
18
- - 每个包的 `package.json` 写 `license`、`repository`、`engines`(`node >=22`)、`files`。作者与邮箱为 `sungbin`、`sungbin@3578.cn`,仓库地址为 `https://gitee.com/sungbin/fcdev.git`。
14
+ - 四个包同一个版本号,由 `release-check` 检查;`fcdev` 对工具链包与模拟器包的依赖版本必须与之相同。
15
+ - 工具链包与模拟器包的包名带 `@rujianjs` 作用域,目录名不带。作用域包默认不能公开发布,所以它们的 `package.json` 写了 `publishConfig.access` 为 `public`,`release-check` 会检查这一项,以及这两个包的包名是否都在 `fcdev` 的 `optionalDependencies` 里。
16
+ - 不带作用域的名字发布时被 npm 的垃圾包名检测拦截(403),所以改用作用域,见 [01-软件架构设计](01-软件架构设计.md) 的 D02。
17
+ - 工具链包与模拟器包的 `package.json` 由构建脚本生成,版本取主包的版本。修改版本号后,要重新运行 `node tools/build-cc65.mjs` 与 `node tools/build-emulator.mjs`。
18
+ - 每个包的 `package.json` 写 `license`、`engines`(`node >=22`)、`files`,不写 `repository`、`homepage`、`bugs`(源码不公开,写了也打不开)。作者与邮箱为 `sungbin`、`sungbin@3578.cn`。
19
19
 
20
20
  ## 2. 发布前提
21
21
 
22
22
  1. 所有改动已提交。
23
- 2. 在已提交的状态下重新运行 `node tools/build-emulator.mjs`,使模拟器平台包清单里的 `sourceDirty` 为 `false`。`sourceDirty` 只看 `virtuanes/` 目录有没有未提交的改动,构建脚本重写 `SOURCE.txt`(记录新的提交号)不会让它变成 `true`。
24
- 3. 平台包都已构建:`node tools/build-cc65.mjs`、`node tools/build-emulator.mjs`;各目标的运行库已构建(`fcdev` 的 `prepack` 会自动重建)。
25
- 4. 模拟器平台包的 `bin/` 里没有 `VirtuaNES.ini` 与 `save/`,见 [08-测试与验证](08-测试与验证.md) 第 7 节。
23
+ 2. 在已提交的状态下重新运行 `node tools/build-emulator.mjs`,使模拟器包清单里的 `sourceDirty` 为 `false`。`sourceDirty` 只看 `virtuanes/` 目录有没有未提交的改动。
24
+ 3. 工具链包与模拟器包都已构建:`node tools/build-cc65.mjs`、`node tools/build-emulator.mjs`;各目标的运行库已构建(`fcdev` 的 `prepack` 会自动重建)。
25
+ 4. 模拟器包的 `bin/` 里没有 `VirtuaNES.ini` 与 `save/`,见 [08-测试与验证](08-测试与验证.md) 第 7 节。
26
26
  5. `npm run release:check` 不带 `--allow-dirty` 通过。
27
27
 
28
28
  ## 3. 检查
29
29
 
30
- `npm run release:check`([tools/release-check.mjs](https://gitee.com/sungbin/fcdev/blob/master/tools/release-check.mjs))只检查,不修改任何文件,也不执行 `npm publish`:
30
+ `npm run release:check`(`tools/release-check.mjs`)只检查,不修改任何文件,也不执行 `npm publish`:
31
31
 
32
- - 四个包的版本一致,都写了 `license`,`fcdev` 对平台包的依赖版本一致;平台包的包名都在 `fcdev` 的依赖里,作用域包声明了公开发布。
32
+ - 四个包的版本一致,都写了 `license`,`fcdev` 对工具链包与模拟器包的依赖版本一致;这两个包的包名都在 `fcdev` 的依赖里,作用域包声明了公开发布。
33
33
  - 每个目标都已构建运行库,且运行库在 `fcdev` 的发布内容里。
34
34
  - `docs/` 目录下的全部开发文档都在 `fcdev` 的发布内容里(安装后在 `node_modules/fcdev/docs/`,`fcdev docs` 命令读取)。
35
- - 两个平台包里的文件与 `manifest.json` 记录的 SHA-256 一致,没有清单之外的文件。
35
+ - 两个包里的文件与 `manifest.json` 记录的 SHA-256 一致,没有清单之外的文件。
36
36
  - 模拟器清单的 `sourceDirty` 为 `true` 时报错;加 `--allow-dirty` 降为警告,只用于发布前的演练。
37
37
  - 每个包的发布内容(`npm pack --dry-run`)包含 `LICENSE`、`package.json` 与必需的文件,且不含测试、`node_modules`、`.env`、密钥与证书文件、`.tgz`。
38
38
 
@@ -40,10 +40,10 @@
40
40
 
41
41
  ## 4. 发布顺序
42
42
 
43
- 先发工具链与模拟器平台包,再发 `fcdev`,最后发 `create-fcdev`:
43
+ 先发工具链包与模拟器包,再发 `fcdev`,最后发 `create-fcdev`:
44
44
 
45
- 1. `@rujianjs/fcdev-cc65-win32-x64`
46
- 2. `@rujianjs/fcdev-emulator-win32-x64`
45
+ 1. `@rujianjs/fcdev-cc65`
46
+ 2. `@rujianjs/fcdev-emulator`
47
47
  3. `fcdev`
48
48
  4. `create-fcdev`
49
49
 
@@ -57,11 +57,19 @@
57
57
  | --- | --- | --- |
58
58
  | `fcdev` | 71 | 64 kB |
59
59
  | `create-fcdev` | 23 | 15 kB |
60
- | `@rujianjs/fcdev-cc65-win32-x64` | 223 | 1.9 MB(解压 6.2 MB) |
61
- | `@rujianjs/fcdev-emulator-win32-x64` | 8 | 0.7 MB(解压 1.8 MB) |
60
+ | `@rujianjs/fcdev-cc65` | 223 | 1.9 MB(解压 6.2 MB) |
61
+ | `@rujianjs/fcdev-emulator` | 7 | 0.7 MB(解压 1.8 MB) |
62
62
 
63
63
  体积随内容变化,以实际运行 `npm publish --dry-run` 的结果为准。
64
64
 
65
- ## 6. 其他平台
65
+ ## 6. 发布脚本
66
66
 
67
- 首批只发布 `win32-x64`。`darwin-arm64`、`linux-x64` 的构建脚本相同,但没有在这些系统上运行或验证;验证后再发布,发布前主包不列出它们,见 [待办备忘](待办备忘.md)。
67
+ `tools/release.mjs` 把上面的步骤串起来,不暂存、不提交:
68
+
69
+ | 命令 | 作用 |
70
+ | --- | --- |
71
+ | `npm run release:prepare -- <版本号>` | 升版本号:改主包与创建包的 `version`、主包对两个包的精确依赖,重新构建两个包并生成它们的 `package.json`,再运行 `npm install` 刷新锁文件。完成后由使用者自己提交 |
72
+ | `npm run release:publish -- --dry-run` | 演练:跑全部测试、重建模拟器包、`release:check`、`release:verify` 与各包的 `npm publish --dry-run`,不登录、不真正发布;已经发布过的版本只警告并跳过试发布 |
73
+ | `npm run release:publish` | 正式发布:工作区必须已提交、`npm` 已登录、四个包的该版本都未发布;通过同样的检查和试发布后,输入 `yes` 确认,再按第 4 节的顺序发布,最后用 `npm view` 核对。验证码由 npm 在终端里询问 |
74
+
75
+ 两个命令都可以加 `--allow-dirty`,允许工作区有未提交的改动,只用于演练。
@@ -88,7 +88,7 @@ C/C++ 扩展用哪个配置,只保存在它自己的工作区状态里,其
88
88
  - 指令与汇编指令不分大小写。
89
89
  - 标签定义要求冒号紧跟在名字后面,行首 `bne :+` 因此不会被当成标签。
90
90
  - 宏的调用与不在词表里的标识符不着色,因为单行匹配无法区分它们与符号。
91
- - 指令词表与 [指令参考](https://gitee.com/sungbin/fcdev/blob/master/vscode/src/shared/assembly/instruction-reference.ts)、[伪指令参考](https://gitee.com/sungbin/fcdev/blob/master/vscode/src/shared/assembly/directive-reference.ts) 的覆盖,由 `test/syntaxes/ca65-grammar.test.ts` 逐条检查。
91
+ - 指令词表与 `vscode/src/shared/assembly/instruction-reference.ts`、`vscode/src/shared/assembly/directive-reference.ts` 的覆盖,由 `test/syntaxes/ca65-grammar.test.ts` 逐条检查。
92
92
 
93
93
  ## 3. 项目信息的来源
94
94
 
@@ -211,7 +211,7 @@ fcdev run src # 构建,挂载镜像,在模拟器里运行
211
211
 
212
212
  ## 10. 示例程序
213
213
 
214
- 示例在仓库的 `examples/sb2000/` 下,每个是一个 fcdev 项目;在仓库根目录用 `node packages/fcdev/bin/fcdev.mjs build examples/sb2000/<名>` 构建。
214
+ 示例在仓库的 `apps/sb2000/examples/` 下,每个是一个 fcdev 项目;在仓库根目录用 `node packages/fcdev/bin/fcdev.mjs build apps/sb2000/examples/<名>` 构建。
215
215
 
216
216
  | 目录 | 作用 | 用法(在 DOS 提示符下) |
217
217
  | --- | --- | --- |
@@ -1,6 +1,6 @@
1
1
  # SB2000 硬件说明
2
2
 
3
- 本文是 SB2000(小霸王学生电脑)硬件行为的结论,来源是模拟器源码(fcdev 仓库 `virtuanes/VirtuaNES/NES/Mapper/MapperSB2K.cpp` 等)和实际运行观察。“已确认”指来自模拟器源码或实际运行,真机均未测试;程序接口见 [系统调用手册](02-系统调用手册.md)。
3
+ 本文是 SB2000(小霸王学生电脑)硬件行为的结论,来源是模拟器源码(`virtuanes/VirtuaNES/NES/Mapper/MapperSB2K.cpp` 等)和实际运行观察。“已确认”指来自模拟器源码或实际运行,真机均未测试;程序接口见 [系统调用手册](02-系统调用手册.md)。
4
4
 
5
5
  | 项目 | 结论 | 状态 |
6
6
  | --- | --- | --- |
@@ -7,7 +7,6 @@
7
7
  | 事项 | 说明 |
8
8
  | --- | --- |
9
9
  | 发布四个 npm 包 | 由用户登录 npm 后按 [09-发布](09-发布.md) 的顺序执行 |
10
- | `darwin-arm64`、`linux-x64` 平台包 | 构建脚本已写,需要在这些系统上运行并验证后再发布;模拟器只支持 Windows,不做这两个系统的模拟器包 |
11
10
 
12
11
  ## 2. VS Code 扩展
13
12
 
@@ -5,6 +5,6 @@
5
5
  | 编号 | 发现日期 | 缺陷 | 影响 | 状态 | 修复说明 |
6
6
  | --- | --- | --- | --- | --- | --- |
7
7
  | B001 | 2026-11-10 | 根 `.gitignore` 的 `build/` 规则把 `packages/fcdev/src/build/`(构建核心的 7 个源文件)排除在版本库之外,`git ls-files` 里没有它们 | 已提交的仓库缺少构建核心,别人克隆后无法使用 `fcdev build`;发布时因为 `files` 白名单仍会打进包,所以现有包内容不受影响 | 已修复 | 把 `.gitignore` 里的 `build/` 改为只忽略仓库根的 `/build/` 与各包根目录下的 `packages/*/build/`;修改后 `git check-ignore` 不再匹配 `packages/fcdev/src/build/`,该目录显示为未跟踪,需要用户自己暂存并提交 |
8
- | B002 | 2026-11-10 | [virtuanes/README.md](https://gitee.com/sungbin/fcdev/blob/master/virtuanes/README.md) 的目录图根写成 `emulator/`,一处链接指向不存在的文件 | 链接失效,目录图与实际不符 | 已修复 | 目录图改为 `virtuanes/`,删掉失效链接与不属于本仓库的说明 |
8
+ | B002 | 2026-11-10 | `virtuanes/README.md` 的目录图根写成 `emulator/`,一处链接指向不存在的文件 | 链接失效,目录图与实际不符 | 已修复 | 目录图改为 `virtuanes/`,删掉失效链接与不属于本仓库的说明 |
9
9
  | B003 | 2026-11-10 | `fcdev` 接受 `--verbose` 选项,但没有任何命令使用它 | 选项无效果;文档与帮助文字都没有提到它 | 待修复 | |
10
10
  | B004 | 2026-11-12 | `npm run check` 里需要启动模拟器的 SB2000 测试(`sb2000-library.test.mjs`)偶发失败:有时报“调试命令 run 300 超过 120000 毫秒没有应答”,有时报“等待调试服务就绪超时”,失败的用例每次不同;单独重跑通过 | 全量检查偶发 1 个失败,与代码改动无关 | 待修复 | |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "fcdev",
3
- "version": "0.3.1",
3
+ "version": "0.4.0",
4
4
  "description": "6502 兼容机(NES、学习机等)的开发工具:用 cc65 构建 C 与汇编程序",
5
5
  "license": "Apache-2.0",
6
6
  "author": "sungbin <sungbin@3578.cn>",
@@ -13,11 +13,6 @@
13
13
  "sb2000",
14
14
  "disassembler"
15
15
  ],
16
- "repository": {
17
- "type": "git",
18
- "url": "https://gitee.com/sungbin/fcdev.git",
19
- "directory": "packages/fcdev"
20
- },
21
16
  "type": "module",
22
17
  "engines": {
23
18
  "node": ">=22"
@@ -35,7 +30,7 @@
35
30
  "targets"
36
31
  ],
37
32
  "optionalDependencies": {
38
- "@rujianjs/fcdev-cc65-win32-x64": "0.3.1",
39
- "@rujianjs/fcdev-emulator-win32-x64": "0.3.1"
33
+ "@rujianjs/fcdev-cc65": "0.4.0",
34
+ "@rujianjs/fcdev-emulator": "0.4.0"
40
35
  }
41
36
  }
@@ -1,6 +1,6 @@
1
1
  // ------------------------------------------------------------------------
2
2
  // 名称:docs-command.mjs
3
- // 说明:docs 命令:列出开发文档的主题,查询某份文档的本机路径与在线地址。
3
+ // 说明:docs 命令:列出开发文档的主题,查询某份文档的本机路径。
4
4
  // 作者:sungbin
5
5
  // 邮箱:sungbin@3578.cn
6
6
  // 日期:2026-11-11
@@ -18,7 +18,7 @@ import { FcdevError } from '../../shared/index.mjs';
18
18
  export async function runDocsCommand({ positionals, options, context }) {
19
19
  const directory = docsDirectory();
20
20
  if (!existsSync(directory)) {
21
- throw new FcdevError(`找不到文档目录:${directory}`, { code: 'DOCS_MISSING', hint: '这份 fcdev 不带文档,请改读在线文档,地址见 package.json 的 repository' });
21
+ throw new FcdevError(`找不到文档目录:${directory}`, { code: 'DOCS_MISSING', hint: '这份 fcdev 不带文档,请升级到带文档的版本' });
22
22
  }
23
23
 
24
24
  const query = positionals.join(' ').trim();
@@ -31,7 +31,7 @@ export async function runDocsCommand({ positionals, options, context }) {
31
31
  const width = Math.max(...docs.map((doc) => doc.topic.length));
32
32
  const lines = [`fcdev 开发文档:${docs.length} 份`, `本机目录:${directory}`, ''];
33
33
  for (const doc of docs) lines.push(` ${doc.topic.padEnd(width)} ${doc.title}:${doc.summary}`);
34
- lines.push('', '查询:fcdev docs <主题>(本机路径与在线地址)、fcdev docs <词>(按主题、文件名、标题与说明搜索)');
34
+ lines.push('', '查询:fcdev docs <主题>(本机路径)、fcdev docs <词>(按主题、文件名、标题与说明搜索)');
35
35
  context.stdout.write(`${lines.join('\n')}\n`);
36
36
  return 0;
37
37
  }
@@ -46,13 +46,13 @@ export async function runDocsCommand({ positionals, options, context }) {
46
46
  }
47
47
  if (matches.length === 1) {
48
48
  const [doc] = matches;
49
- context.stdout.write(`${doc.title}(主题 ${doc.topic})\n说明:${doc.summary}\n本机:${doc.localPath}\n在线:${doc.onlineUrl}\n`);
49
+ context.stdout.write(`${doc.title}(主题 ${doc.topic})\n说明:${doc.summary}\n本机:${doc.localPath}\n`);
50
50
  return 0;
51
51
  }
52
52
  const width = Math.max(...matches.map((doc) => doc.topic.length));
53
53
  const lines = [`包含“${query}”的文档:${matches.length} 份(${kind === 'file' ? '按文件名' : '按关键词'})`];
54
54
  for (const doc of matches) lines.push(` ${doc.topic.padEnd(width)} ${doc.title}:${doc.summary}`);
55
- lines.push('', '用 fcdev docs <主题> 查看某份文档的本机路径与在线地址');
55
+ lines.push('', '用 fcdev docs <主题> 查看某份文档的本机路径');
56
56
  context.stdout.write(`${lines.join('\n')}\n`);
57
57
  return 0;
58
58
  }
package/src/cli/index.mjs CHANGED
@@ -54,7 +54,7 @@ const HELP_TEXT = `fcdev:6502 兼容机的开发工具
54
54
  sync 生成 IDE 的 C/C++ 配置
55
55
  info [--json] 显示目标、工具链与头文件目录
56
56
  api [词] [--json] 查询目标的 C 接口文档:函数名、模块名、$功能号或关键词;不带词列出全部模块
57
- docs [词] [--json] 查询开发文档:主题名或关键词,给出本机路径与在线地址;不带词列出全部主题
57
+ docs [词] [--json] 查询开发文档:主题名或关键词,给出本机路径;不带词列出全部主题
58
58
 
59
59
  选项:
60
60
  --target <名> 指定目标,覆盖 fcdev.json
@@ -1,19 +1,15 @@
1
1
  // ------------------------------------------------------------------------
2
2
  // 名称:doc-index.mjs
3
- // 说明:开发文档的查询:列出全部主题,按主题名、文件名或关键词查找,给出每份文档的本机路径与在线地址。
3
+ // 说明:开发文档的查询:列出全部主题,按主题名、文件名或关键词查找,给出每份文档的本机路径。
4
4
  // 作者:sungbin
5
5
  // 邮箱:sungbin@3578.cn
6
6
  // 日期:2026-11-11
7
- // 备注:文档随主包发布在包根的 docs 目录;在线地址由 package.json 的 repository 推出,分支固定为 master。
7
+ // 备注:文档随主包发布在包根的 docs 目录。
8
8
  // ------------------------------------------------------------------------
9
9
  import path from 'node:path';
10
10
  import { fileURLToPath } from 'node:url';
11
- import { FcdevError, readJsonFile } from '../shared/index.mjs';
12
11
  import { DOC_TOPICS } from './doc-topics.mjs';
13
12
 
14
- /** 在线文档所在的分支 */
15
- const ONLINE_BRANCH = 'master';
16
-
17
13
  /** 主包根目录 */
18
14
  const PACKAGE_DIR = fileURLToPath(new URL('../../', import.meta.url));
19
15
 
@@ -25,7 +21,6 @@ const PACKAGE_DIR = fileURLToPath(new URL('../../', import.meta.url));
25
21
  * @property {string} file 文件路径:相对 docs 目录,`inPackage` 为 true 时相对主包根目录
26
22
  * @property {boolean} [inPackage] 文件在主包根目录下的其他位置,不在 docs 目录里
27
23
  * @property {string} localPath 本机的绝对路径
28
- * @property {string} onlineUrl 在线地址
29
24
  */
30
25
 
31
26
  /**
@@ -37,32 +32,15 @@ export function docsDirectory() {
37
32
  }
38
33
 
39
34
  /**
40
- * 主包在线目录的地址,以 / 结尾。
41
- * @returns {string} 地址
42
- * @throws {FcdevError} package.json 里没有仓库地址
43
- */
44
- function onlineBase() {
45
- const { repository } = readJsonFile(path.join(PACKAGE_DIR, 'package.json'));
46
- if (!repository?.url) {
47
- throw new FcdevError('package.json 里没有 repository 地址,无法给出在线地址', { code: 'DOCS_NO_REPOSITORY' });
48
- }
49
- const repositoryUrl = repository.url.replace(/\.git$/, '');
50
- const directory = (repository.directory ?? '').replace(/^\/+|\/+$/g, '');
51
- return `${repositoryUrl}/blob/${ONLINE_BRANCH}/${directory ? `${directory}/` : ''}`;
52
- }
53
-
54
- /**
55
- * 把登记项补全成带路径与地址的文档信息。
35
+ * 把登记项补全成带本机路径的文档信息。
56
36
  * @param {import('./doc-topics.mjs').DocTopic} entry 登记项
57
- * @param {string} base 主包在线目录的地址
58
37
  * @returns {DocInfo} 文档信息
59
38
  */
60
- function describe(entry, base) {
39
+ function describe(entry) {
61
40
  const segments = entry.file.split('/');
62
41
  return {
63
42
  ...entry,
64
43
  localPath: path.join(entry.inPackage ? PACKAGE_DIR : docsDirectory(), ...segments),
65
- onlineUrl: base + (entry.inPackage ? '' : 'docs/') + segments.map(encodeURIComponent).join('/'),
66
44
  };
67
45
  }
68
46
 
@@ -71,8 +49,7 @@ function describe(entry, base) {
71
49
  * @returns {DocInfo[]} 按登记顺序
72
50
  */
73
51
  export function listDocs() {
74
- const base = onlineBase();
75
- return DOC_TOPICS.map((entry) => describe(entry, base));
52
+ return DOC_TOPICS.map((entry) => describe(entry));
76
53
  }
77
54
 
78
55
  /**
@@ -21,7 +21,7 @@ export const DOC_TOPICS = [
21
21
  { topic: 'architecture', file: '01-软件架构设计.md', title: '软件架构设计', summary: '包的划分、目录、分层规则、设计决策与文档清单' },
22
22
  { topic: 'build', file: '02-命令行与构建.md', title: '命令行与构建', summary: '命令、构建规则、配置文件 fcdev.json、构建流程' },
23
23
  { topic: 'targets', file: '03-目标规范.md', title: '目标规范', summary: '目标定义、打包器、新增机型的步骤' },
24
- { topic: 'toolchain', file: '04-cc65工具链.md', title: 'cc65 工具链', summary: 'cc65 源码、构建与平台包' },
24
+ { topic: 'toolchain', file: '04-cc65工具链.md', title: 'cc65 工具链', summary: 'cc65 源码、构建与工具链包' },
25
25
  { topic: 'emulator', file: '05-模拟器与调试.md', title: '模拟器与调试', summary: '运行方案、调试服务与命令表、模拟器包' },
26
26
  { topic: 'disasm', file: '06-反汇编.md', title: '反汇编', summary: '反汇编前端的流程、输入与限制' },
27
27
  { topic: 'create', file: '07-创建包与模板.md', title: '创建包与模板', summary: 'npm create fcdev 的命令、模板与生成内容' },
@@ -1,10 +1,10 @@
1
1
  // ------------------------------------------------------------------------
2
2
  // 名称:emulator-locator.mjs
3
- // 说明:定位模拟器程序:配置项、环境变量、平台包,按顺序查找。
3
+ // 说明:定位模拟器程序:配置项、环境变量、模拟器包,按顺序查找。
4
4
  // 作者:sungbin
5
5
  // 邮箱:sungbin@3578.cn
6
6
  // 日期:2026-11-10
7
- // 备注:模拟器只有 Windows 版;其他系统明确报错,不影响构建。
7
+ // 备注:无
8
8
  // ------------------------------------------------------------------------
9
9
  import { existsSync } from 'node:fs';
10
10
  import { createRequire } from 'node:module';
@@ -14,26 +14,19 @@ import { FcdevError } from '../shared/index.mjs';
14
14
  /** 环境变量:自备模拟器的路径 */
15
15
  export const EMULATOR_ENV_NAME = 'FCDEV_EMULATOR';
16
16
 
17
- /** 平台包里模拟器程序的相对路径 */
18
- const PACKAGE_EXECUTABLE = path.join('bin', 'VirtuaNES.exe');
17
+ /** 模拟器包的名称,放在 @rujianjs 作用域下 */
18
+ export const EMULATOR_PACKAGE_NAME = '@rujianjs/fcdev-emulator';
19
19
 
20
- /**
21
- * 模拟器平台包的名称,放在 @rujianjs 作用域下。
22
- * @param {string} [platform] 系统,默认当前系统
23
- * @param {string} [arch] 架构,默认当前架构
24
- * @returns {string} 包名
25
- */
26
- export function getEmulatorPackageName(platform = process.platform, arch = process.arch) {
27
- return `@rujianjs/fcdev-emulator-${platform}-${arch}`;
28
- }
20
+ /** 模拟器包里模拟器程序的相对路径 */
21
+ const PACKAGE_EXECUTABLE = path.join('bin', 'VirtuaNES.exe');
29
22
 
30
23
  /**
31
- * 按顺序定位模拟器:配置项 emulator、环境变量、平台包。
32
- * @param {{configured?: string, env?: NodeJS.ProcessEnv, platform?: string}} [options] configured 为配置里的绝对路径
24
+ * 按顺序定位模拟器:配置项 emulator、环境变量、模拟器包。
25
+ * @param {{configured?: string, env?: NodeJS.ProcessEnv}} [options] configured 为配置里的绝对路径
33
26
  * @returns {{executable: string, source: string}} 模拟器程序与来源
34
- * @throws {FcdevError} 系统不支持,或都找不到
27
+ * @throws {FcdevError} 都找不到
35
28
  */
36
- export function locateEmulator({ configured, env = process.env, platform = process.platform } = {}) {
29
+ export function locateEmulator({ configured, env = process.env } = {}) {
37
30
  const explicit = configured ? { executable: configured, source: 'config' } : env[EMULATOR_ENV_NAME] ? { executable: path.resolve(env[EMULATOR_ENV_NAME]), source: 'env' } : null;
38
31
  if (explicit) {
39
32
  if (!existsSync(explicit.executable)) {
@@ -41,22 +34,15 @@ export function locateEmulator({ configured, env = process.env, platform = proce
41
34
  }
42
35
  return explicit;
43
36
  }
44
- if (platform !== 'win32') {
45
- throw new FcdevError('模拟器只支持 Windows', {
46
- code: 'EMULATOR_UNSUPPORTED',
47
- hint: `其他系统可用 ${EMULATOR_ENV_NAME} 或 fcdev.json 的 emulator 指定自备的模拟器;构建不受影响`,
48
- });
49
- }
50
- const packageName = getEmulatorPackageName(platform);
51
37
  try {
52
- const packageJson = createRequire(import.meta.url).resolve(`${packageName}/package.json`);
38
+ const packageJson = createRequire(import.meta.url).resolve(`${EMULATOR_PACKAGE_NAME}/package.json`);
53
39
  const executable = path.join(path.dirname(packageJson), PACKAGE_EXECUTABLE);
54
40
  if (existsSync(executable)) return { executable, source: 'package' };
55
41
  } catch {
56
- // 平台包没有安装,落到下面统一的报错
42
+ // 模拟器包没有安装,落到下面统一的报错
57
43
  }
58
44
  throw new FcdevError('找不到模拟器', {
59
45
  code: 'EMULATOR_NOT_FOUND',
60
- hint: `任选一种:安装平台包 ${packageName};设置环境变量 ${EMULATOR_ENV_NAME} 指向模拟器程序;在 fcdev.json 里用 emulator 指定`,
46
+ hint: `任选一种:安装模拟器包 ${EMULATOR_PACKAGE_NAME};设置环境变量 ${EMULATOR_ENV_NAME} 指向模拟器程序;在 fcdev.json 里用 emulator 指定`,
61
47
  });
62
48
  }
@@ -8,4 +8,4 @@
8
8
  // ------------------------------------------------------------------------
9
9
  export { DEFAULT_DEBUG_PORT, DebugClient, parseReply } from './debug-client.mjs';
10
10
  export { assertPortFree, launchEmulator } from './emulator-launcher.mjs';
11
- export { EMULATOR_ENV_NAME, getEmulatorPackageName, locateEmulator } from './emulator-locator.mjs';
11
+ export { EMULATOR_ENV_NAME, EMULATOR_PACKAGE_NAME, locateEmulator } from './emulator-locator.mjs';
@@ -8,8 +8,8 @@
8
8
  // ------------------------------------------------------------------------
9
9
  export {
10
10
  TOOLCHAIN_ENV_NAME,
11
+ TOOLCHAIN_PACKAGE_NAME,
11
12
  getToolPath,
12
- getToolchainPackageName,
13
13
  getToolchainVersion,
14
14
  locateToolchain,
15
15
  runTool,
@@ -1,6 +1,6 @@
1
1
  // ------------------------------------------------------------------------
2
2
  // 名称:toolchain-locator.mjs
3
- // 说明:定位 cc65 工具链并启动其中的工具:配置项、环境变量、平台包,按顺序查找。
3
+ // 说明:定位 cc65 工具链并启动其中的工具:配置项、环境变量、工具链包,按顺序查找。
4
4
  // 作者:sungbin
5
5
  // 邮箱:sungbin@3578.cn
6
6
  // 日期:2026-11-10
@@ -23,15 +23,8 @@ const REQUIRED_TOOLS = ['cc65', 'ca65', 'ld65'];
23
23
  * @property {string} source 来源:config、env 或 package
24
24
  */
25
25
 
26
- /**
27
- * 工具链平台包的名称,放在 @rujianjs 作用域下。
28
- * @param {string} [platform] 系统,默认当前系统
29
- * @param {string} [arch] 架构,默认当前架构
30
- * @returns {string} 包名
31
- */
32
- export function getToolchainPackageName(platform = process.platform, arch = process.arch) {
33
- return `@rujianjs/fcdev-cc65-${platform}-${arch}`;
34
- }
26
+ /** 工具链包的名称,放在 @rujianjs 作用域下 */
27
+ export const TOOLCHAIN_PACKAGE_NAME = '@rujianjs/fcdev-cc65';
35
28
 
36
29
  /**
37
30
  * 工具程序的完整路径。
@@ -40,8 +33,7 @@ export function getToolchainPackageName(platform = process.platform, arch = proc
40
33
  * @returns {string} 可执行文件路径
41
34
  */
42
35
  export function getToolPath(toolchain, tool) {
43
- const fileName = process.platform === 'win32' ? `${tool}.exe` : tool;
44
- return path.join(toolchain.home, 'bin', fileName);
36
+ return path.join(toolchain.home, 'bin', `${tool}.exe`);
45
37
  }
46
38
 
47
39
  /**
@@ -54,7 +46,7 @@ function isToolchainHome(home) {
54
46
  }
55
47
 
56
48
  /**
57
- * 按顺序定位工具链:配置项 toolchain、环境变量、平台包。
49
+ * 按顺序定位工具链:配置项 toolchain、环境变量、工具链包。
58
50
  * @param {{configured?: string, env?: NodeJS.ProcessEnv}} [options] configured 为配置里的 toolchain 绝对路径
59
51
  * @returns {Toolchain} 工具链
60
52
  * @throws {FcdevError} 都找不到,或指定的目录不完整
@@ -67,17 +59,16 @@ export function locateToolchain({ configured, env = process.env } = {}) {
67
59
  }
68
60
  return explicit;
69
61
  }
70
- const packageName = getToolchainPackageName();
71
62
  try {
72
- const packageJson = createRequire(import.meta.url).resolve(`${packageName}/package.json`);
63
+ const packageJson = createRequire(import.meta.url).resolve(`${TOOLCHAIN_PACKAGE_NAME}/package.json`);
73
64
  const home = path.dirname(packageJson);
74
65
  if (isToolchainHome(home)) return { home, source: 'package' };
75
66
  } catch {
76
- // 平台包没有安装,落到下面统一的报错
67
+ // 工具链包没有安装,落到下面统一的报错
77
68
  }
78
69
  throw new FcdevError('找不到 cc65 工具链', {
79
70
  code: 'TOOLCHAIN_NOT_FOUND',
80
- hint: `任选一种:安装平台包 ${packageName};设置环境变量 ${TOOLCHAIN_ENV_NAME} 指向自备的 cc65 目录;在 fcdev.json 里用 toolchain 指定目录`,
71
+ hint: `任选一种:安装工具链包 ${TOOLCHAIN_PACKAGE_NAME};设置环境变量 ${TOOLCHAIN_ENV_NAME} 指向自备的 cc65 目录;在 fcdev.json 里用 toolchain 指定目录`,
81
72
  });
82
73
  }
83
74
 
Binary file
Binary file
Binary file
Binary file