CLI リファレンス

⚠️ 進行中の作業:Vize は活発に開発中であり、CLI サーフェスはまだ進化中です。

ほとんどのアプリケーション ワークフローでは、vize npm パッケージをインストールし、package.json を通じて実行する必要があります。 スクリプト。このページでは、LSP、IDE管理、 check-server、プロファイリング、およびその他の直接 CLI ワークフロー。 npm パッケージは共有構成を公開します ヘルパーと、NAPI サポートの build、fmt、lint、check、clean、ready、および upgrade コマンド。

分析パイプラインのより高度な説明については、静的分析を参照してください。

アプリケーション パッケージ スクリプト

アプリの場合は、npm からインストールし、安定したコマンドをプロジェクト スクリプトに接続します。

vp install -D vize

{
  "scripts": {
    "vize:build": "vize build src",
    "vize:fmt": "vize fmt --write src",
    "vize:lint": "vize lint --preset happy-path src",
    "vize:check": "vize check src",
    "vize:ready": "vize ready src"
  }
}

vp run vize:lint
vp run vize:check
vp run vize:ready

1 回限りのローカル デバッグには vp exec vize ... を使用しますが、文書化するには名前付きスクリプトを優先します。 ワークフローとCI。

Rust バイナリのインストール

v1 アルファの場合は、事前に構築された GitHub リリース バイナリまたは Nix エントリ ポイントを使用します。 Rust CLI は crates.io インストール チャネルはまだサポートされていません。

nix run github:ubugeeei-prod/vize#vize -- --help

プラットフォーム固有のバイナリを次からダウンロードすることもできます。 GitHub リリース。

このリポジトリ内のローカル開発の場合は、ワークスペース ビルドをインストールします。

cargo install --path crates/vize --force --locked

npm パッケージ スクリプトと Rust CLI の比較

コマンド

vize [COMMAND]

コマンドなしで呼び出された場合、vize はデフォルトで build になります。

すべての --profile ターミナル レポートは、ローカル専用の vize_curator クレートによってレンダリングされます。の インストルメンテーション フックは vize_carton に残りますが、管理者は CLI レポート シェイプと並行して所有します。 検査官とエージェント向けのアーティファクト。

建てる

vize build src/**/*.vue
vize build --ssr
vize build --profile src

主なオプション:

フォーマット

vize fmt --check src
vize fmt --write src

主なオプション:

糸くず

vize lint src
vize lint --preset opinionated src
vize lint --help-level short src

主なオプション:

プリセットは段階的な導入を目的としています。

例:

vize lint --preset essential --max-warnings 0 src
vize lint --preset opinionated --help-level short src
vize lint --cross-file --cross-file-tree src
vize lint --strict-reactivity src
vize lint --format ansi src
vize lint --format plain src
vize lint --format agent src
vize lint --format markdown src

チェック

vize check
vize check src
vize check --tsconfig tsconfig.app.json
vize check --profile src

vize check は、vize_canon と corsa-bind を通じて公開された Corsa プロジェクト セッションによってサポートされています。 Vize は、Vue SFC 用の仮想 TypeScript を生成し、ネイティブ パスでプロジェクト診断を実行し、結果を元のソースの場所にマッピングします。

明示的なパスが指定されていない場合、vize check は tsconfig.json files / include / を使用します。 利用可能な場合は、exclude。明示的な入力はファイル、ディレクトリ、またはグロブであり、.vue を含めることができます。 .ts、.tsx、および .d.ts。

主なオプション:

Vize の開発中またはテスト中にカスタム Corsa 実行可能ファイルを固定したい場合は、--corsa-path を使用します。 ローカル corsa-bind チェックアウト。共有構成キーは typeChecker.corsaPath です。 typeChecker.tsgoPath は互換性エイリアスとしてのみ保持されます。

便利なパターン:

vize check --tsconfig tsconfig.app.json src
vize check --show-virtual-ts src/components/App.vue
vize check --profile src
vize check --declaration --declaration-dir dist/types

プロジェクト全体のテンプレート値と Vue アンビエント タイプは、TypeScript プロジェクトを通じて表示される必要があります 構成。 auto-imports.d.ts、components.d.ts などの生成されたファイル、または独自のファイルを含めます。 tsconfig.json で Vue 宣言を行い、必要に応じて --tsconfig でそのプロジェクトを選択します。

{
  "include": ["src/**/*.ts", "src/**/*.tsx", "src/**/*.vue", "src/**/*.d.ts"]
}

// src/types/vue-app.d.ts
declare module "vue" {
  interface ComponentCustomProperties {
    $t: (key: string) => string;
  }
}

検査官

vize inspector src/App.vue
vize inspector "src/**/*.vue" --target ssr
vize inspector src --format json --output inspector-payload.json
vize inspector src --format agent --output inspector-agent.json

vize inspector は、プレイグラウンドによって消費されるペイロードに 1 つ以上の .vue ファイルをパッケージ化します。 コンパイラインスペクタ。次に、ブラウザは Vue 出力、Vize 出力、仮想 TS、VIR、および ファイル間のグラフを作成し、パーマリンクと事前入力されたプル リクエスト リンクを生成します。

別のローカル ツールまたは AI エージェントが同じ再現を必要とする場合、 ブラウザ。レポートには、正確なペイロード、プレイグラウンド URL、概要メトリクス、インポート グラフが含まれます。 ペイロード、グラフ、および行の差分メタデータは、ローカル専用の vize_curator クレートによって構築されるため、CLI および 遊び場の検査は調整を続けます。

主なオプション:

コントリビューターのワークフローについては、Compiler Inspector を参照してください。

クリーン

vize clean
vize clean --dry-run
vize clean --scope node-modules
vize clean --scope project
vize clean --force
vize clean path/to/project

vize clean は、選択したプロジェクト ルートの既知の Vize 所有のローカル アーティファクトを削除してから、 空の .vize および node_modules/.vize の親。管理対象アーティファクト リストにはプロファイル出力が含まれます。 Musea レポート/スナップショット/トークン、Patina セッション、構成スキーマ、LSP ログ、ソケットの残り物、OXC ダンプ、Oxlint 回避策ファイル、具体化された Corsa プロジェクト ファイル。 .vize の下の不明なエントリ デフォルトで保存されます。選択したアーティファクト ルートを削除する必要がある場合にのみ、--force を使用します。 卸売り。 --dry-run は、削除されるアーティファクト パスを出力します。 --scope node-modulesを使用してください または、1 つのアーティファクト ルートのみをクリーンアップする必要がある場合は、--scope project。

準備ができて

vize ready src
vize ready --output dist src

vize ready は、fmt --write、lint、check、build を順番に実行します。コマンドは次の時点で停止します。 最初の失敗ステップ。

主なオプション:

アップグレード

vize upgrade
vize upgrade --dry-run

デフォルトでは、vize upgrade は Vite+ を通じて npm パッケージを更新します。

vp install -D vize@latest

--source cargo は、明示的なローカル Cargo インストールの場合にのみ使用してください。

美術館

vize musea --help
vize musea serve --port 6006
vize musea new

musea サブコマンドは現在、スキャフォールディングと実験的なエントリ ポイントに重点を置いています。 日々のギャラリー開発において、現在推奨されるワークフローは次のとおりです。 @vizejs/vite-plugin-musea。

npm パッケージは、Musea で Vite を実行する便利な vize musea コマンドも公開します。 プロジェクトにインストールされているプラグイン:

vp exec vize musea
vp exec vize musea --build

LSP と IDE

vize lsp
vize lsp --port 9527
vize ide vscode
vize ide zed

vize lsp は言語サーバーを直接起動します。 vize ide は、VS Code および Zed 用のエディター固有のインストールおよび管理コマンドを追加します 統合。

グローバル オプション

vize --help
vize --version
vize <command> --help