docs(loader-client,loader-server): the READMEs give --dir a default the code does not have

未关闭
#143 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

@mentallyunstable-lab 已经在做这个了。

开始于 2026年11月11日。

  • #147 来自 @mentallyunstable-lab —— 未关闭

评估

难度
1/5
预计耗时
1 小时以内
新手友好度
35/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
技术栈
bun, typescript
领域
documentation

调研方向

Read the option tables in the root README and the client and server READMEs at the cited locations. Compare the documented --dir behavior with the error in apps/client/src/server.ts and apps/server/src/server.ts; the issue leaves open whether to mark the option required or add a code default. Done means the documentation and CLI behavior agree, including correcting the server watcher description.

由索引模型根据 Issue 内容生成。

描述

app:client app:server documentation good first issue
What is the type of issue?

Documentation is incorrect

What is the issue?

The READMEs list .nanoforge/client and .nanoforge/server as defaults for -d, --dir. The code has no default and throws (client server.ts#L40, server server.ts#L29):

$ bun apps/client/dist/server.js
error: No game dir specified

The server README also says changes are "debounced to 100 ms", but the watcher acts on the first event and ignores the next 100 ms (see the watcher debounce issue).

Fix: mark --dir as required in the tables, or add the default in commander to match the docs.

Found during a read-only audit of main @ 044c766 (2026-11-11).

Where did you find it?
主要语言
TypeScript
星标
1
派生
0
平均合并
17 小时 25 分钟
30 天内合并 PR
11

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

NanoForge-dev/Loader 的其他 Issue

查看 NanoForge-dev/Loader 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。