Référence CLI

⚠️ Travaux en cours : Vize est en développement actif et la surface du CLI est encore en évolution.

La plupart des flux de travail applicatifs devraient installer le paquet vize npm et le faire passer à travers package.json scripts. Cette page décrit le vize binaire Rust-native de bas niveau pour LSP, gestion IDE, check-server, profilage et autres flux de travail directs de CLI. Le package npm expose des assistants de configuration partagés ainsi que des commandes build, fmt, lint, check, clean, readyet upgrade soutenues par NAPI.

Pour une explication plus large du pipeline d’analyse, voir Static Analysis.

Scripts de paquets d’application

Pour les applications, installez depuis npm et connectez les commandes stables dans les scripts de projet :

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

Utilisez vp exec vize ... pour un débogage local ponctuel, mais privilégiez les scripts nommés pour les flux de travail documentés et les CI.

Installation binaire de rouille

Pour l’alpha v1, utilisez les binaires de version GitHub préconstruits ou le point d’entrée Nix. Le CLI Rust n’est pas encore un canal crates.io pris en charge.

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

Vous pouvez également télécharger des binaires spécifiques à la plateforme depuis GitHub Releases.

Pour le développement local dans ce dépôt, installez la construction workspace :

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

Scripts de paquets npm vs Rust CLI

Commandements

vize [COMMAND]

Lorsqu’il est invoqué sans commande, vize passe par défaut à build.

Tous les rapports --profile terminaux sont effectués par la caisse vize_curator locale uniquement. Les crochets d’instrumentation restent en vize_carton, tandis que le conservateur possède la forme du rapport CLI aux côtés artefacts faisant face à l’inspecteur et à l’agent.

Build

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

Options clés :

Format

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

Options clés :

Peluches

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

Options clés :

Les préréglages sont destinés à une adoption progressive :

Exemples :

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

Vérifié

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

vize check est soutenu par vize_canon et des sessions de projets Corsa exposées via corsa-bind. Vize génère un TypeScript virtuel pour les SFC Vue, exécute des diagnostics de projet sur un chemin natif, et mappe les résultats vers les emplacements sources d’origine.

Lorsque aucun chemin explicite n’est donné, vize check utilise tsconfig.json files / include / exclude si disponible. Les entrées explicites peuvent être des fichiers, des répertoires ou des globules et peuvent inclure .vue, .ts, .tsxet .d.ts.

Options clés :

Utilisez---corsa-path lorsque vous souhaitez épingler un exécutable Corsa personnalisé lors du développement de Vize ou en testant un corsa-bind local de vérification. La clé de configuration partagée est typeChecker.corsaPath; typeChecker.tsgoPath est conservé uniquement comme alias de compatibilité.

Motifs utiles :

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

Les valeurs de gabarit à l’échelle du projet et les types d’ambiance Vue doivent être visibles via la configuration projet TypeScript. Incluez des fichiers générés tels que auto-imports.d.ts, components.d.tsou vos propres déclarations Vue dans tsconfig.json, puis sélectionnez ce projet avec --tsconfig lorsque nécessaire :

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

Inspecteur

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 emballe un ou plusieurs fichiers .vue dans la charge utile consommée par le playground l’inspecteur du compilateur. Le navigateur inspecte ensuite la sortie Vue, la sortie Vize, Virtual TS, VIR, ainsi que le graphique croisé, puis produit un permalien ainsi qu’un lien pull request prérempli.

Utilisez --format agent quand un autre outil local ou un agent IA a besoin du même repro, sans ouvrir le navigateur . Le rapport contient la charge utile exacte, l’URL du playground, les métriques de résumé et le graphique d’importation. Les métadonnées de charge utile, graphe et différentiel de ligne sont construites par la caisse de vize_curator locale uniquement afin que inspection CLI et de terrain de jeu restent alignées.

Options clés :

Voir Compiler Inspector pour le flux de travail des contributeurs.

Clean

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 supprime les artefacts locaux connus appartenant à Vize pour la racine du projet sélectionné, puis supprime .vize vides et node_modules/.vize parents. La liste d’artefacts gérés couvre les sorties de profil, rapports/snapshots/tokens Musea, sessions Patina, schémas de configuration, journaux LSP, restes de sockets, dumps de OXC, fichiers de contournement Oxlint et fichiers de projets Corsa matérialisés. Les entrées inconnues sous .vize sont préservées par défaut ; Utilisez---force uniquement lorsque la racine de l’artefact sélectionnée doit être retirée en gros. --dry-run imprime les chemins d’artefacts qui seraient supprimés. Utilisez --scope node-modules ou --scope project lorsque seule une racine d’artefact doit être nettoyée.

Prêt

vize ready src
vize ready --output dist src

vize ready s’exécute fmt --write, lint, checket build dans l’ordre. La commande s’arrête à la première étape ratée.

Options clés :

Mise à niveau

vize upgrade
vize upgrade --dry-run

Par défaut, vize upgrade met à jour le package npm via Vite+ :

vp install -D vize@latest

Utilisez --source cargo uniquement pour des installations locales explicites de Cargo.

Musea

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

Le sous-commandement musea se concentre actuellement sur l’échafaudage et les points d’entrée expérimentaux. Pour le développement quotidien de galeries, le flux de travail recommandé aujourd’hui est @vizejs/vite-plugin-musea.

Le package npm expose également une commande vize musea pratique qui exécute Vite avec le plugin Musea installé dans votre projet :

vp exec vize musea
vp exec vize musea --build

LSP et IDE

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

vize lsp lance directement le serveur de langue. vize ide ajoute des commandes d’installation et de gestion spécifiques à l’éditeur pour les intégrations VS Code et Zed .

Options mondiales

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