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

Abierto
#143 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

@mentallyunstable-lab ya está trabajando en esto.

Desde el 11/11/2026.

  • #147 de @mentallyunstable-lab — abierto

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
bun, typescript

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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?
Lenguaje dominante
TypeScript
Estrellas
1
Forks
0
Merge medio
17 h 25 min
PR fusionados (30 d)
11

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de NanoForge-dev/Loader

Todos los issues de NanoForge-dev/Loader

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.