[Request] Automated help/man page generation
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 技術スタック
- typescript
- 領域
- cli
調査の方向性
まず Clack の command API と type API を読み、次に設定済みの commands がどのように引数を公開するかを追跡します。プレーンテキストのヘルプ出力に含めるべき内容と、caller がそれをどのように要求するかを定義します。強い型付けがされた command が、完全な CLI セットアップを強制せずに引数の有用な説明を生成できれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Most other CLI packages use type systems to automate the creation of --help or man-page-like output for configured commands. I haven't found any way to do this for Clack commands.
This doesn't need to be a full, opinionated CLI setup — in fact it shouldn't be as that's clearly out of scope for this package. Rather I'm just looking for a way to turn a strongly typed Clack command into a string of text documenting what arguments it takes. To my mind that's the last primitive needed to rapidly build CLIs with Clack.
Describe the solution you'd like
Ability to generate plaintext descriptions of Clack commands and their arguments.
Describe alternatives you've considered
- Manually documenting each command.
- Maybe there's a third-party package that can do this and works with Clack, but I've looked and not found anything that appears to have concensus.
Additional context
I'm very surprised that I haven't found anyone else asking for this yet, so it makes me feel like I'm missing something here. Maybe there is somehow a giant hole in my mental model for this package, apologies if so!
I am very impressed with Clack and was looking forward to using it, but I don't see how I can build a CLI around this without an answer for auto-generating help docs based on the command code. Are people just using other CLI library tools but driving the input interfaces with Clack instead of using the built-in setups? That just feels like putting a hat on a hat to me.
- 主要言語
- TypeScript
- スター
- 8.1k
- フォーク
- 218
- 平均マージ
- 1日 23時間
- マージ済み PR（30日）
- 6
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
bombshell-dev/clack のほかの issue
-
難易度 3/5 1〜2日 初心者へのやさしさ 70/100
bombshell-dev/clack#613 · コメント 4 件 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 30/100
bombshell-dev/clack#597 ·
-
rfc: accessible modeオープンenhancement
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
bombshell-dev/clack#585 · コメント 1 件 · リアクション 1 件 ·
-
[Bug] Spinner does not run `onCancel` function on `Ctrl + C`対応中かも @cyphercodes が 101 日前に担当しました。 オープンbug
難易度 3/5 1〜2日 初心者へのやさしさ 68/100
bombshell-dev/clack#573 · コメント 1 件 · リアクション 2 件 ·
-
enhancement
難易度 3/5 1〜2日 初心者へのやさしさ 62/100
bombshell-dev/clack#565 · コメント 1 件 · リアクション 1 件 ·
bombshell-dev/clack の issue をすべて見る
似ている issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
supadata-ai/mcp#27 ·
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
capricorn86/happy-dom#2485 ·
メンテナーはふだん 2 日以内に返信
-
优化导入 OCR 模型选择文件的按钮样式オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
siyuan-note/siyuan#20430 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
Albert-Weasker/niubigeo#194 ·
メンテナーはふだん 1 日以内に返信