raystack / raystack/chronicle

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

Open
#141 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
2
Forks
1
Avg merge
12h 29m
Merged PRs (30d)
12

Description

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

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at src/cli/index.ts and trace the config loader, build flow, and dev-server entry points; inspect package.json for the version source. Define completion against each requested behavior: diagnostic flags, chronicle validate checks, package-derived version, port-conflict handling, and bundle-size reporting.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
build-system, cli, developer-experience
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.