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

Đang mở
#143 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@mentallyunstable-lab đang làm issue này rồi.

Từ ngày 11/11/2026.

  • #147 của @mentallyunstable-lab — đang mở

Đánh giá

Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
bun, typescript
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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?
Ngôn ngữ chính
TypeScript
Star
1
Fork
0
Merge trung bình
17 giờ 25 phút
Pull request đã merge (30 ngày)
11

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của NanoForge-dev/Loader

Tất cả issue của NanoForge-dev/Loader

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.