Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

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

オープン
#141 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
静か
技術スタック
typescript

調査の方向性

src/cli/index.ts から始めて、config loader、build フロー、dev-server のエントリーポイントをたどり、package.json でバージョンのソースを確認します。要求された各動作について完了条件を定義します: 診断フラグ、chronicle validate のチェック、package から導出されるバージョン、ポート競合の処理、バンドルサイズの報告。

索引モデルが issue の本文から書いたものです。

説明

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
主要言語
TypeScript
スター
2
フォーク
1
平均マージ
12分
マージ済み PR(30日)
1

環境構築

  • Dockerfile または Docker Compose ファイルあり
  • プルリクエストのテンプレートなし
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

raystack/chronicle のほかの issue

raystack/chronicle の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。