Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

dx: add --verbose/--debug CLI flags and config validation command

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

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
typescript

Línea de trabajo

Comienza en src/cli/index.ts y sigue el config loader, el flujo de build y los puntos de entrada del dev-server; inspecciona package.json para localizar el origen de la versión. Define la finalización para cada comportamiento solicitado: flags de diagnóstico, comprobaciones de chronicle validate, versión derivada del paquete, gestión de conflictos de puertos e informe del tamaño del bundle.

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

Descripción

Problem

Several developer experience gaps in the CLI:

  1. No `--verbose`/`--debug` flags — when builds fail or config is wrong, there's no way to get detailed output. Config parse errors are silently swallowed by `loadConfig()`.
  2. No `chronicle validate` command — no way to check config validity without starting the server. Useful in CI pipelines.
  3. CLI version hardcoded to `'0.1.0'` in `src/cli/index.ts` — should be read from `package.json`.
  4. Dev server doesn't check port conflicts — starts without warning if the port is already in use.
  5. Build doesn't report bundle size — no output size summary or warnings for large bundles.

Suggested Fix

  • Add `--verbose` global flag that enables debug logging throughout the config loader, build, and dev server
  • Add a `chronicle validate` command that parses config, checks content dirs exist, validates API spec files are readable, and reports issues
  • Read version from `package.json` at build time
  • Check port availability before starting dev server, suggest next available port
Lenguaje dominante
TypeScript
Estrellas
2
Forks
1
Merge medio
12 min
PR fusionados (30 d)
1

Preparar el entorno

  • Incluye un Dockerfile o un archivo de Docker Compose
  • Sin plantilla de pull request
  • Sin guía de contribución

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 raystack/chronicle

Todos los issues de raystack/chronicle

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.