vize
v0.46.0
Published
Vize - High-performance Vue.js toolchain in Rust
Downloads
1,750
Maintainers
Readme
Vize
High-performance Vue.js toolchain in Rust.
Installation
# Install globally
npm install -g vize
# Or add it to a project
npm install -D vize
# Or install from GitHub
npm install -g github:ubugeeei/vizeIf you use @vizejs/vite-plugin and want one shared config for both the plugin and the vize
CLI, install both packages in the project and put your config in vize.config.*.
Usage
vize [COMMAND] [OPTIONS]| Command | Description |
| ------- | ------------------------------------- |
| build | Compile Vue SFC files (default) |
| fmt | Format Vue SFC files |
| lint | Lint Vue SFC files |
| check | Type check Vue SFC files |
| musea | Start component gallery server |
| lsp | Start Language Server Protocol server |
vize --help # Show help
vize <command> --help # Show command-specific helpConfig
vize looks for these files in the project root:
vize.config.tsvize.config.jsvize.config.mjsvize.config.pklvize.config.json
TypeScript config:
import { defineConfig } from "vize";
export default defineConfig({
linter: {
preset: "opinionated",
},
});PKL config:
amends "node_modules/vize/pkl/vize.pkl"
linter {
preset = "opinionated"
}JSON config with schema:
{
"$schema": "./node_modules/vize/schemas/vize.config.schema.json",
"linter": {
"preset": "opinionated"
}
}The npm CLI currently applies shared config to the lint command. You can override discovery with
vize lint --config path/to/vize.config.ts or skip config loading with vize lint --no-config.
Examples
vize # Compile ./**/*.vue to ./dist
vize build src/**/*.vue -o out # Custom input/output
vize build --ssr # SSR mode
vize build --profile # Parse, transform, codegen, and I/O profile
vize fmt --check # Check formatting
vize fmt --check --profile # Formatter timing profile
vize lint --fix # Auto-fix lint issues
vize lint --profile # Rule hook, Croquis, and type-aware timing profile
vize check --strict # Strict type checking
vize check --profile src # Virtual TS, Croquis, and Corsa timing profileProfile output includes hot files and internal operation timings, so compiler, linter, typecheck, Croquis, and Corsa costs are visible in the same report style.
Alternative Installation
If npm installation fails, you can install via Cargo:
cargo install vizeLicense
MIT
