Referência CLI

⚠️ Trabalho em andamento: Vize está em desenvolvimento ativo e a superfície CLI ainda está evoluindo.

A maioria dos fluxos de trabalho de aplicativos deve instalar o pacote vize npm e executá-lo por scripts package.json . Esta página descreve o binário vize nativo de Rust de nível inferior para LSP, gerenciamento de IDE, check-server, perfilamento e outros fluxos de trabalho diretos de CLI. O pacote npm expõe ajudantes de configuração compartilhados, além de comandos build, fmt, lint, check, clean, readye upgrade respaldados por NAPI.

Para uma explicação de nível mais alto do pipeline de análise, veja Static Analysis.

Scripts de Pacotes de Aplicação

Para aplicativos, instale a partir do npm e conecte comandos Stable para scripts de projeto:

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

Use vp exec vize ... para depuração local única, mas prefira scripts nomeados para fluxos de trabalho documentados e CI.

Instalação Binária de Ferrugem

Para a alpha v1, use os binários pré-construídos de release do GitHub ou o ponto de entrada do Nix. A CLI do Rust ainda não é um canal crates.io de instalação suportado.

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

Você também pode baixar binários específicos da plataforma de GitHub Releases.

Para desenvolvimento local dentro deste repositório, instale a build do workspace:

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

Scripts de Pacote npm vs CLI Rust

Comandos

vize [COMMAND]

Quando invocado sem um comando, vize por padrão é build.

Todos os relatórios --profile terminais são feitos pela caixa de vize_curator apenas local. Os ganchos de instrumentação permanecem em vize_carton, enquanto o curador possui a forma do relatório CLI ao lado artefatos voltados para o inspetor e para o agente.

Build

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

Principais opções:

Formato

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

Principais opções:

Fiapos

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

Principais opções:

Presets são destinados à adoção em etapas:

Exemplos:

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

Confere

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

vize check é respaldado por sessões de projetos vize_canon e Corsa expostas por meio de corsa-bind. O Vize gera TypeScript virtual para SFCs do Vue, executa diagnósticos de projeto em um caminho nativo e mapeia os resultados de volta para as localizações originais.

Quando não há caminhos explícitos, vize check usa tsconfig.json files / include / exclude se disponível. Entradas explícitas podem ser arquivos, diretórios ou globos e podem incluir .vue, .ts, .tsxe .d.ts.

Principais opções:

Use --corsa-path quando quiser fixar um executável Corsa personalizado enquanto desenvolve o Vize ou testa um corsa-bind local de verificação. A chave de configuração compartilhada é typeChecker.corsaPath; typeChecker.tsgoPath é mantido apenas como um alias de compatibilidade.

Padrões úteis:

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

Os valores do modelo em todo o projeto e os tipos de ambiente do Vue devem ser visíveis através da configuração do projeto TypeScript. Inclua arquivos gerados como auto-imports.d.ts, components.d.tsou suas próprias declarações Vue em tsconfig.json, e selecione esse projeto com --tsconfig quando necessário:

{
  "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;
  }
}

Inspetor

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 empacota um ou mais arquivos .vue no payload consumido pelo playground inspetor do compilador. O navegador então inspeciona a saída do Vue, a saída do Vize, Virtual TS, VIR e o grafo cruzado de arquivos , depois produz um permalink mais um link de pull request pré-preenchido.

Use --format agent quando outra ferramenta local ou agente de IA precisar da mesma reprodução sem abrir o navegador . O relatório contém a carga útil exata, URL do playground, métricas resumo e gráfico de importação. Metadados de carga útil, gráfico e diferencial de linha são construídos pela caixa de vize_curator local exclusiva para que a CLI e inspeção do playground permaneçam alinhadas.

Principais opções:

Veja Compiler Inspector para o fluxo de trabalho dos colaboradores.

Limpo

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 remove artefatos locais conhecidos pertencentes ao Vize para a raiz do projeto selecionado, depois remove .vize vazio e node_modules/.vize pais. A lista de artefatos gerenciados abrange saídas de perfis, relatórios/snapshots/tokens Musea, sessões Patina, esquemas de configuração, logs LSP, restos de sockets, dumps de OXC, arquivos de solução alternativa Oxlint e arquivos de projetos Corsa materializados. Entradas desconhecidas sob .vize são preservadas por padrão; Use --force apenas quando a raiz do artefato selecionada deve ser removida por completo. --dry-run imprime os caminhos dos artefatos que seriam removidos. Use --scope node-modules ou --scope project quando apenas uma raiz de artefato deve ser limpa.

Pronto

vize ready src
vize ready --output dist src

vize ready executa fmt --write, lint, checke build em ordem. O comando para no primeiro passo que falha.

Principais opções:

Atualização

vize upgrade
vize upgrade --dry-run

Por padrão, vize upgrade atualiza o pacote npm via Vite+:

vp install -D vize@latest

Use --source cargo apenas para instalações explícitas de carga locais.

Musea

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

O subcomando musea atualmente foca em andaimes e pontos de entrada experimentais. Para o desenvolvimento diário de galerias, o fluxo de trabalho recomendado hoje é @vizejs/vite-plugin-musea.

O pacote npm também expõe um comando de vize musea de conveniência que roda o Vite com o plugin Musea instalado no seu projeto:

vp exec vize musea
vp exec vize musea --build

LSP e IDE

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

vize lsp inicia o servidor de idiomas diretamente. vize ide adiciona comandos de instalação e gerenciamento específicos do editor para as integrações VS Code e Zed .

Opções Globais

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