Package Exports
- vize
- vize/config
- vize/pkl/vize.pkl
- vize/schemas/vize.config.schema.json
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 fmt --check # Check formatting
vize lint --fix # Auto-fix lint issues
vize check --strict # Strict type checkingAlternative Installation
If npm installation fails, you can install via Cargo:
cargo install vizeLicense
MIT