Package Exports
- vize
- vize/config
- vize/pkl/vize.pkl
- vize/schemas/vize.config.schema.json
Readme
Vize
The vize npm package provides:
- shared config utilities (
defineConfig,loadConfig) - the native
vize buildcommand - the native
vize fmtcommand - the native
vize lintcommand - the native
vize checkcommand for package scripts vize readyforfmt --write -> lint -> check -> buildvize upgradefor updating the npm package
For Vite integration, pair it with @vizejs/vite-plugin.
For the full Rust-native CLI (lsp, ide, project-backed check, and check-server), install
the Rust vize binary with cargo install vize.
Need vp first? Install Vite+ once from the Vite+ install guide.
Installation
vp install -D vizeCLI
The npm CLI exposes the common package-script commands:
vp exec vize build src
vp exec vize fmt --write src
vp exec vize lint src
vp exec vize check
vp exec vize ready src
vp exec vize upgradeShared config discovery is supported for the npm CLI:
vize.config.tsvize.config.jsvize.config.mjsvize.config.pklvize.config.json
import { defineConfig } from "vize";
export default defineConfig({
linter: {
preset: "opinionated",
},
typeChecker: {
strict: true,
},
});Override config discovery with --config, or disable it with --no-config.
vize check in the npm package uses the packaged NAPI checker so it can run from package.json
scripts after installing vize. Add --declaration --declaration-dir dist/types to emit Vue
component .d.ts files. Use the Rust CLI when you need Corsa project diagnostics across Vue, TS,
TSX, and .d.ts inputs.
vize ready runs fmt --write, lint, check, and build in that order.
Programmatic Config Helpers
import { defineConfig, loadConfig } from "vize";
export default defineConfig({
linter: {
preset: "happy-path",
},
});
const config = await loadConfig(process.cwd());Related Packages
@vizejs/vite-plugin@vizejs/native@vizejs/wasm@vizejs/nuxt@vizejs/vite-plugin-musea
License
MIT