nexus-prompt-cli
v1.0.2
Published
CLI for nexus-prompt: fmt and lint helpers
Downloads
18
Maintainers
Readme
nexus-prompt CLI
TypeScript と Vite で構築された、フォーマット(fmt)とリント(lint)のヘルパーを提供する CLI です。
インストール
- ローカル(推奨):
- npm:
npm i -D nexus-prompt-cli - pnpm:
pnpm add -D nexus-prompt-cli - yarn:
yarn add -D nexus-prompt-cli
- npm:
これにより nexus-prompt コマンドが利用可能になります。
使い方
Markdown の YAML フロントマターのみ整形(dumpYamlStable):
npx nexus-prompt fmt [--check] [paths...]- 例:
npx nexus-prompt fmt .npx nexus-prompt fmt --check .(CI向け: 変更が必要なら非0終了)npx nexus-prompt fmt src tests
Prompt DSL の YAML フロントマターをリント:
npx nexus-prompt lint [paths...](省略時は.)- 例:
npx nexus-prompt lint .npx nexus-prompt lint src docs
動作概要
fmtは.mdを走査し、先頭の YAML フロントマターのみをdumpYamlStableで安定整形します(本文は変更しません)。--checkを付けると書き込みせず差分の有無だけを判定し、必要があれば非0終了します(CI向け)。
lintは.mdを対象に、先頭の YAML フロントマターを Prompt DSL としてパースし、以下を検査します。- フロントマターの構文・スキーマが妥当であること(v1 は自動的に v2 として扱います)。
template内で使用されている変数がinputsに存在すること(欠落はエラー)。inputsに存在するがtemplateで未使用の項目(警告)。framework-*.mdはスキップします。
ビルド
- Vite(Rollup)でビルドし、
dist/cli.cjsにシバン付きの Node 向け CJS バイナリを出力します。 - スクリプト:
npm run build
注意事項
fmt/lintはnode_modules、.git、dist、build、coverageをスキップします。lintの対象は.mdかつファイル名がframework-で始まらないものです。- フロントマターが存在しない
.mdはlintの対象外として無視します。
ローカルインストール(macOS)
クイックオプション
- npm link(開発に最適): グローバルへシンボリックリンクして即時動作を確認。
- npm pack + install: tarball を作成し、グローバルまたはプロジェクトにインストール。
- ローカルパスからインストール: フォルダを直接指定してインストール。
事前準備
- まずビルド:
npm run build(dist/cli.cjsを生成)。 - PATH: グローバル npm の bin(例:
$(npm bin -g)または$(npm prefix -g)/bin)がシェルのPATHに通っていることを確認してください。
オプション1 — npm link(グローバルシンボリックリンク)
- プロジェクトルートで:
npm link - 確認:
nexus-prompt --help - 解除:
npm unlink -g nexus-prompt-cli
オプション2 — tarball を作成してインストール
- ビルド:
npm run build(prepackでも実行されます)。 - tarball 作成:
npm pack→nexus-prompt-cli-<version>.tgzが生成されます。 - グローバルにインストール:
npm i -g ./nexus-prompt-cli-<version>.tgz - 利用:
nexus-prompt --help
オプション3 — ローカルフォルダからインストール
- グローバルにインストール:
npm i -g /absolute/path/to/nexus-prompt-cli- インストール時に
prepareが走り、ビルドされます。
- インストール時に
- または特定のプロジェクトへインストール:
- 対象プロジェクトで:
npm i -D /absolute/path/to/nexus-prompt-cli - 実行:
npx nexus-prompt fmt .
- 対象プロジェクトで:
備考
- package.json の
binはnexus-prompt→dist/cli.cjsをマッピングし、インストール時に実行権限が付与されます。 prepackは毎回ビルドを実行するため、npm packで常に最新のdistが含まれます。
