@vizejs/vite-plugin 0.58.0 → 0.60.0

package/README.md

@@ -12,15 +12,10 @@ High-performance native Vite plugin for Vue SFC compilation powered by [Vize](ht
 
 ## Installation
 
-```bash
-# npm
-npm install @vizejs/vite-plugin vize
-
-# pnpm
-pnpm add @vizejs/vite-plugin vize
+Install `vp` once from the [Vite+ install guide](https://viteplus.dev/guide/install), then add the packages:
 
-# yarn
-yarn add @vizejs/vite-plugin vize
+```bash
+vp install -D @vizejs/vite-plugin vize
 ```
 
 ## Usage

package/dist/index.d.mts

@@ -0,0 +1,634 @@
+import { defineConfig, loadConfig } from "vize";
+import { Plugin } from "vite";
+
+//#region ../vize/src/types/compiler.d.ts
+/**
+ * Compiler configuration
+ */
+interface CompilerConfig {
+  /**
+   * Compilation mode
+   * @default 'module'
+   */
+  mode?: "module" | "function";
+  /**
+   * Enable Vapor mode compilation
+   * @default false
+   */
+  vapor?: boolean;
+  /**
+   * Treat lowercase non-HTML tags as custom renderer elements instead of Vue components.
+   * Useful for TresJS and other custom renderers.
+   * @default false
+   */
+  customRenderer?: boolean;
+  /**
+   * Enable SSR mode
+   * @default false
+   */
+  ssr?: boolean;
+  /**
+   * Enable source map generation
+   * @default true in development, false in production
+   */
+  sourceMap?: boolean;
+  /**
+   * Prefix template identifiers with _ctx
+   * @default false
+   */
+  prefixIdentifiers?: boolean;
+  /**
+   * Hoist static nodes
+   * @default true
+   */
+  hoistStatic?: boolean;
+  /**
+   * Cache v-on handlers
+   * @default true
+   */
+  cacheHandlers?: boolean;
+  /**
+   * Enable TypeScript parsing in <script> blocks
+   * @default true
+   */
+  isTs?: boolean;
+  /**
+   * Script file extension for generated output
+   * @default 'ts'
+   */
+  scriptExt?: "ts" | "js";
+  /**
+   * Module name for runtime imports
+   * @default 'vue'
+   */
+  runtimeModuleName?: string;
+  /**
+   * Global variable name for runtime (IIFE builds)
+   * @default 'Vue'
+   */
+  runtimeGlobalName?: string;
+}
+/**
+ * Vite plugin configuration
+ */
+interface VitePluginConfig {
+  /**
+   * Files to include in compilation
+   * @default /\.vue$/
+   */
+  include?: string | RegExp | (string | RegExp)[];
+  /**
+   * Files to exclude from compilation
+   * @default /node_modules/
+   */
+  exclude?: string | RegExp | (string | RegExp)[];
+  /**
+   * Glob patterns to scan for .vue files during pre-compilation
+   * @default ['**\/*.vue']
+   */
+  scanPatterns?: string[];
+  /**
+   * Glob patterns to ignore during pre-compilation
+   * @default ['node_modules/**', 'dist/**', '.git/**']
+   */
+  ignorePatterns?: string[];
+}
+//#endregion
+//#region ../vize/src/types/rules.d.ts
+declare const LINT_RULE_NAMES: readonly ["a11y/alt-text", "a11y/anchor-has-content", "a11y/anchor-is-valid", "a11y/aria-props", "a11y/aria-role", "a11y/aria-unsupported-elements", "a11y/click-events-have-key-events", "a11y/form-control-has-label", "a11y/heading-has-content", "a11y/heading-levels", "a11y/iframe-has-title", "a11y/img-alt", "a11y/interactive-supports-focus", "a11y/label-has-for", "a11y/landmark-roles", "a11y/media-has-caption", "a11y/mouse-events-have-key-events", "a11y/no-access-key", "a11y/no-aria-hidden-on-focusable", "a11y/no-autofocus", "a11y/no-distracting-elements", "a11y/no-i-for-icon", "a11y/no-redundant-roles", "a11y/no-refer-to-non-existent-id", "a11y/no-role-presentation-on-focusable", "a11y/no-static-element-interactions", "a11y/placeholder-label-option", "a11y/role-has-required-aria-props", "a11y/tabindex-no-positive", "a11y/use-list", "html/deprecated-attr", "html/deprecated-element", "html/id-duplication", "html/no-consecutive-br", "html/no-duplicate-dt", "html/no-empty-palpable-content", "html/require-datetime", "script/no-get-current-instance", "script/no-next-tick", "script/no-options-api", "ssr/no-browser-globals-in-ssr", "ssr/no-hydration-mismatch", "type/no-floating-promises", "type/no-unsafe-template-binding", "type/require-typed-emits", "type/require-typed-props", "vapor/no-inline-template", "vapor/no-suspense", "vapor/no-vue-lifecycle-events", "vapor/prefer-static-class", "vapor/require-vapor-attribute", "vue/attribute-hyphenation", "vue/attribute-order", "vue/component-definition-name-casing", "vue/component-name-in-template-casing", "vue/html-quotes", "vue/html-self-closing", "vue/multi-word-component-names", "vue/mustache-interpolation-spacing", "vue/no-boolean-attr-value", "vue/no-child-content", "vue/no-dupe-v-else-if", "vue/no-duplicate-attributes", "vue/no-inline-style", "vue/no-lone-template", "vue/no-multi-spaces", "vue/no-mutating-props", "vue/no-preprocessor-lang", "vue/no-reserved-component-names", "vue/no-script-non-standard-lang", "vue/no-src-attribute", "vue/no-template-key", "vue/no-template-lang", "vue/no-template-shadow", "vue/no-textarea-mustache", "vue/no-unsafe-url", "vue/no-unused-components", "vue/no-unused-properties", "vue/no-unused-vars", "vue/no-use-v-if-with-v-for", "vue/no-useless-template-attributes", "vue/no-v-html", "vue/no-v-text-v-html-on-component", "vue/permitted-contents", "vue/prefer-props-shorthand", "vue/prop-name-casing", "vue/require-component-is", "vue/require-component-registration", "vue/require-scoped-style", "vue/require-v-for-key", "vue/scoped-event-names", "vue/sfc-element-order", "vue/single-style-block", "vue/use-unique-element-ids", "vue/use-v-on-exact", "vue/v-bind-style", "vue/v-on-style", "vue/v-slot-style", "vue/valid-attribute-name", "vue/valid-v-bind", "vue/valid-v-else", "vue/valid-v-for", "vue/valid-v-if", "vue/valid-v-memo", "vue/valid-v-model", "vue/valid-v-on", "vue/valid-v-show", "vue/valid-v-slot", "vue/warn-custom-block", "vue/warn-custom-directive"];
+type LintRuleName = (typeof LINT_RULE_NAMES)[number];
+type LintRulesConfig = Partial<Record<LintRuleName, RuleSeverity>>;
+//#endregion
+//#region ../vize/src/types/tools.d.ts
+/**
+ * Linter configuration
+ */
+interface LinterConfig {
+  /**
+   * Enable linting
+   */
+  enabled?: boolean;
+  /**
+   * Built-in lint preset
+   * @default 'happy-path'
+   */
+  preset?: LintPreset;
+  /**
+   * Rules to enable/disable
+   */
+  rules?: LintRulesConfig;
+  /**
+   * Category-level severity overrides
+   */
+  categories?: Partial<Record<RuleCategory, RuleSeverity>>;
+}
+/**
+ * Type checker configuration
+ */
+interface TypeCheckerConfig {
+  /**
+   * Enable type checking
+   * @default false
+   */
+  enabled?: boolean;
+  /**
+   * Enable strict mode
+   * @default false
+   */
+  strict?: boolean;
+  /**
+   * Check component props
+   * @default true
+   */
+  checkProps?: boolean;
+  /**
+   * Check component emits
+   * @default true
+   */
+  checkEmits?: boolean;
+  /**
+   * Check template bindings
+   * @default true
+   */
+  checkTemplateBindings?: boolean;
+  /**
+   * Path to tsconfig.json
+   * @default auto-detected
+   */
+  tsconfig?: string;
+  /**
+   * Path to the Corsa binary
+   */
+  corsaPath?: string;
+}
+/**
+ * Formatter configuration
+ */
+interface FormatterConfig {
+  /**
+   * Max line width
+   * @default 80
+   */
+  printWidth?: number;
+  /**
+   * Indentation width
+   * @default 2
+   */
+  tabWidth?: number;
+  /**
+   * Use tabs for indentation
+   * @default false
+   */
+  useTabs?: boolean;
+  /**
+   * Print semicolons
+   * @default true
+   */
+  semi?: boolean;
+  /**
+   * Use single quotes
+   * @default false
+   */
+  singleQuote?: boolean;
+  /**
+   * Trailing commas
+   * @default 'all'
+   */
+  trailingComma?: "all" | "none" | "es5";
+}
+/**
+ * LSP configuration
+ */
+interface LspConfig {
+  /**
+   * Enable LSP
+   * @default false
+   */
+  enabled?: boolean;
+  /**
+   * Enable linter diagnostics.
+   * Prefer this over `diagnostics` for new configs.
+   * @default false
+   */
+  lint?: boolean;
+  /**
+   * Enable linter diagnostics.
+   * @deprecated Use `lint` instead.
+   * @default false
+   */
+  diagnostics?: boolean;
+  /**
+   * Enable type checking diagnostics and type-aware LSP features.
+   * @default false
+   */
+  typecheck?: boolean;
+  /**
+   * Enable the editor assistance bundle: completion, hover, navigation,
+   * symbols, rename, code lens, semantic tokens, links, folding, inlay hints,
+   * and file rename handling. Formatting stays separately opt-in.
+   * @default false
+   */
+  editor?: boolean;
+  /**
+   * Enable completions.
+   * @default false
+   */
+  completion?: boolean;
+  /**
+   * Enable hover information
+   * @default false
+   */
+  hover?: boolean;
+  /**
+   * Enable go-to-definition
+   * @default false
+   */
+  definition?: boolean;
+  /**
+   * Enable find references
+   * @default false
+   */
+  references?: boolean;
+  /**
+   * Enable document symbols
+   * @default false
+   */
+  documentSymbols?: boolean;
+  /**
+   * Enable workspace symbols
+   * @default false
+   */
+  workspaceSymbols?: boolean;
+  /**
+   * Enable formatting via LSP
+   * @default false
+   */
+  formatting?: boolean;
+  /**
+   * Enable code actions
+   * @default false
+   */
+  codeActions?: boolean;
+  /**
+   * Enable rename
+   * @default false
+   */
+  rename?: boolean;
+  /**
+   * Enable code lens
+   * @default false
+   */
+  codeLens?: boolean;
+  /**
+   * Enable semantic tokens
+   * @default false
+   */
+  semanticTokens?: boolean;
+  /**
+   * Enable document links
+   * @default false
+   */
+  documentLinks?: boolean;
+  /**
+   * Enable folding ranges
+   * @default false
+   */
+  foldingRanges?: boolean;
+  /**
+   * Enable inlay hints
+   * @default false
+   */
+  inlayHints?: boolean;
+  /**
+   * Enable file rename edits
+   * @default false
+   */
+  fileRename?: boolean;
+  /**
+   * Use Corsa for type checking in LSP
+   * @default false
+   */
+  corsa?: boolean;
+}
+//#endregion
+//#region ../vize/src/types/musea.d.ts
+/**
+ * VRT (Visual Regression Testing) configuration for Musea
+ */
+interface MuseaVrtConfig {
+  /**
+   * Threshold for pixel comparison (0-1)
+   * @default 0.1
+   */
+  threshold?: number;
+  /**
+   * Output directory for screenshots
+   * @default '__musea_snapshots__'
+   */
+  outDir?: string;
+  /**
+   * Viewport sizes
+   */
+  viewports?: Array<{
+    width: number;
+    height: number;
+    name?: string;
+  }>;
+}
+/**
+ * A11y configuration for Musea
+ */
+interface MuseaA11yConfig {
+  /**
+   * Enable a11y checking
+   * @default false
+   */
+  enabled?: boolean;
+  /**
+   * Axe-core rules to enable/disable
+   */
+  rules?: Record<string, boolean>;
+}
+/**
+ * Autogen configuration for Musea
+ */
+interface MuseaAutogenConfig {
+  /**
+   * Enable auto-generation of variants
+   * @default false
+   */
+  enabled?: boolean;
+  /**
+   * Max variants to generate per component
+   * @default 10
+   */
+  maxVariants?: number;
+}
+/**
+ * Musea component gallery configuration
+ */
+interface MuseaConfig {
+  /**
+   * Glob patterns for art files
+   * @default ['**\/*.art.vue']
+   */
+  include?: string[];
+  /**
+   * Glob patterns to exclude
+   * @default ['node_modules/**', 'dist/**']
+   */
+  exclude?: string[];
+  /**
+   * Base path for gallery
+   * @default '/__musea__'
+   */
+  basePath?: string;
+  /**
+   * Enable Storybook compatibility
+   * @default false
+   */
+  storybookCompat?: boolean;
+  /**
+   * Enable inline art detection in .vue files
+   * @default false
+   */
+  inlineArt?: boolean;
+  /**
+   * VRT configuration
+   */
+  vrt?: MuseaVrtConfig;
+  /**
+   * A11y configuration
+   */
+  a11y?: MuseaA11yConfig;
+  /**
+   * Autogen configuration
+   */
+  autogen?: MuseaAutogenConfig;
+}
+//#endregion
+//#region ../vize/src/types/loader.d.ts
+/**
+ * Global type declaration
+ */
+interface GlobalTypeDeclaration {
+  /**
+   * TypeScript type string
+   */
+  type: string;
+  /**
+   * Default value
+   */
+  defaultValue?: string;
+}
+/**
+ * Global types configuration
+ */
+type GlobalTypesConfig = Record<string, GlobalTypeDeclaration | string>;
+/**
+ * Options for loading vize.config file
+ */
+interface LoadConfigOptions {
+  /**
+   * Config file search mode
+   * - 'root': Search only in the specified root directory
+   * - 'auto': Search from cwd upward until finding a config file
+   * - 'none': Don't load config file
+   * @default 'root'
+   */
+  mode?: "root" | "auto" | "none";
+  /**
+   * Custom config file path (overrides automatic search)
+   */
+  configFile?: string;
+  /**
+   * Config environment for dynamic config resolution
+   */
+  env?: ConfigEnv;
+}
+//#endregion
+//#region ../vize/src/types/core.d.ts
+interface ConfigEnv {
+  mode: string;
+  command: "serve" | "build" | "check" | "lint" | "fmt";
+  isSsrBuild?: boolean;
+}
+type RuleSeverity = "off" | "warn" | "error";
+type RuleCategory = "correctness" | "suspicious" | "style" | "perf" | "a11y" | "security";
+type LintPreset = "happy-path" | "opinionated" | "essential" | "nuxt";
+/**
+ * Vize configuration options
+ */
+interface VizeConfig {
+  /**
+   * JSON Schema reference for editor autocompletion.
+   */
+  $schema?: string;
+  /**
+   * Vue compiler options
+   */
+  compiler?: CompilerConfig;
+  /**
+   * Vite plugin options
+   */
+  vite?: VitePluginConfig;
+  /**
+   * Linter options
+   */
+  linter?: LinterConfig;
+  /**
+   * Type checker options
+   */
+  typeChecker?: TypeCheckerConfig;
+  /**
+   * Formatter options
+   */
+  formatter?: FormatterConfig;
+  /**
+   * LSP options
+   */
+  lsp?: LspConfig;
+  /**
+   * Musea component gallery options
+   */
+  musea?: MuseaConfig;
+  /**
+   * Global type declarations
+   */
+  globalTypes?: GlobalTypesConfig;
+}
+//#endregion
+//#region src/types.d.ts
+interface VizeOptions {
+  /**
+   * Override the public base used for dev-time asset URLs such as /@fs paths.
+   * Useful for frameworks like Nuxt that serve Vite from a subpath (e.g. /_nuxt/).
+   */
+  devUrlBase?: string;
+  /**
+   * Files to include in compilation
+   * @default /\.vue$/
+   */
+  include?: string | RegExp | (string | RegExp)[];
+  /**
+   * Files to exclude from compilation
+   * @default /node_modules/
+   */
+  exclude?: string | RegExp | (string | RegExp)[];
+  /**
+   * Force production mode
+   * @default auto-detected from Vite config
+   */
+  isProduction?: boolean;
+  /**
+   * Enable SSR mode
+   * @default false
+   */
+  ssr?: boolean;
+  /**
+   * Enable source map generation
+   * @default true in development, false in production
+   */
+  sourceMap?: boolean;
+  /**
+   * Enable Vapor mode compilation
+   * @default false
+   */
+  vapor?: boolean;
+  /**
+   * Treat lowercase non-HTML tags as custom renderer elements instead of Vue components.
+   * Useful for TresJS and other custom renderers.
+   * @default false
+   */
+  customRenderer?: boolean;
+  /**
+   * Root directory to scan for .vue files
+   * @default Vite's root
+   */
+  root?: string;
+  /**
+   * Glob patterns to scan for .vue files during pre-compilation
+   * @default ['**\/*.vue']
+   */
+  scanPatterns?: string[];
+  /**
+   * Glob patterns to ignore during pre-compilation
+   * @default ['node_modules/**', 'dist/**', '.git/**']
+   */
+  ignorePatterns?: string[];
+  /**
+   * Config file search mode
+   * - 'root': Search only in the project root directory
+   * - 'auto': Search from cwd upward until finding a config file
+   * - false: Disable config file loading
+   * @default 'root'
+   */
+  configMode?: "root" | "auto" | false;
+  /**
+   * Custom config file path (overrides automatic search)
+   */
+  configFile?: string;
+  /**
+   * Handle .vue files in node_modules (on-demand compilation).
+   * When true, vize will compile .vue files from node_modules that other plugins
+   * (like vite-plugin-vue-inspector) may import directly.
+   * Set to false if another Vue plugin (e.g. Nuxt) handles node_modules .vue files.
+   * @default true
+   */
+  handleNodeModulesVue?: boolean;
+  /**
+   * Enable debug logging
+   * @default false
+   */
+  debug?: boolean;
+}
+interface StyleBlockInfo {
+  /** Raw style content (uncompiled for preprocessor langs) */
+  content: string;
+  /** Language of the style block (e.g., "css", "scss", "less", "sass", "stylus") */
+  lang: string | null;
+  /** Whether the style block has the scoped attribute */
+  scoped: boolean;
+  /** CSS Modules: true for unnamed `module`, or the binding name for `module="name"` */
+  module: boolean | string;
+  /** Index of this style block in the SFC */
+  index: number;
+}
+interface CompiledModule {
+  code: string;
+  css?: string;
+  scopeId: string;
+  hasScoped: boolean;
+  templateHash?: string;
+  styleHash?: string;
+  scriptHash?: string;
+  /** Per-block style metadata extracted from the source SFC */
+  styles?: StyleBlockInfo[];
+}
+//#endregion
+//#region src/virtual.d.ts
+interface DynamicImportAliasRule {
+  fromPrefix: string;
+  toPrefix: string;
+}
+//#endregion
+//#region src/transform.d.ts
+declare function rewriteStaticAssetUrls(code: string, aliasRules: DynamicImportAliasRule[]): string;
+//#endregion
+//#region src/plugin/index.d.ts
+declare function vize(options?: VizeOptions): Plugin[];
+//#endregion
+//#region src/config.d.ts
+/**
+ * Shared config store for inter-plugin communication.
+ * Key = project root, Value = resolved VizeConfig.
+ * Used by musea() and other plugins to access the unified config.
+ */
+declare const vizeConfigStore: Map<string, VizeConfig>;
+//#endregion
+//#region src/index.d.ts
+declare const __internal: {
+  rewriteStaticAssetUrls: typeof rewriteStaticAssetUrls;
+};
+//#endregion
+export { type CompiledModule, type LoadConfigOptions, type VizeConfig, type VizeOptions, __internal, rewriteStaticAssetUrls as __internal_rewriteStaticAssetUrls, vize as default, vize, defineConfig, loadConfig, vizeConfigStore };