@vizejs/vite-plugin 0.290.0 → 0.291.0

package/dist/types-x-lq08Y8.d.mts

@@ -0,0 +1,862 @@
+//#region ../../cli/src/types/generated.d.ts
+/**
+ * Host Vue runtime version for opt-in compatibility modes
+ */
+type VueVersion = "3" | "2.7" | "2" | "1" | "0.11" | "0.10";
+/**
+ * Configuration file for vize - High-performance Vue.js toolchain
+ */
+interface VizeConfig {
+  /**
+   * Human-readable entry name for inspect output and diagnostics
+   */
+  name?: string;
+  /**
+   * Directory used as the base for scoped file patterns and relative paths
+   */
+  basePath?: string;
+  /**
+   * Glob patterns this config applies to
+   */
+  files?: string[];
+  /**
+   * Glob patterns this config excludes
+   */
+  ignores?: string[];
+  /**
+   * Base config files or presets to compose
+   */
+  extends?: string | string[];
+  compiler?: CompilerConfig;
+  experimentals?: Record<string, boolean | Record<string, unknown> | null>;
+  vite?: VitePluginConfig;
+  linter?: LinterConfig;
+  typeChecker?: TypeCheckerConfig;
+  formatter?: FormatterConfig;
+  languageServer?: LanguageServerConfig;
+  lsp?: LanguageServerConfig;
+  musea?: MuseaConfig;
+  globalTypes?: GlobalTypesConfig;
+  /**
+   * Scoped config entries for monorepos and workspaces
+   */
+  entries?: VizeConfigEntry[];
+}
+/**
+ * Vue compiler options
+ */
+interface CompilerConfig {
+  /**
+   * Compilation mode
+   */
+  mode?: "module" | "function";
+  /**
+   * Enable Vapor mode compilation
+   */
+  vapor?: boolean;
+  /**
+   * Default output mode for .jsx/.tsx components without a "use vue:*" directive
+   */
+  jsxMode?: "vdom" | "vapor";
+  /**
+   * Treat lowercase non-HTML tags as custom renderer elements
+   */
+  customRenderer?: boolean;
+  /**
+   * Enable SSR mode
+   */
+  ssr?: boolean;
+  /**
+   * Template syntax compatibility mode
+   */
+  templateSyntax?: "standard" | "strict" | "quirks";
+  /**
+   * Enable source map generation
+   */
+  sourceMap?: boolean;
+  /**
+   * Prefix template identifiers with _ctx
+   */
+  prefixIdentifiers?: boolean;
+  /**
+   * Hoist static nodes
+   */
+  hoistStatic?: boolean;
+  /**
+   * Cache v-on handlers
+   */
+  cacheHandlers?: boolean;
+  /**
+   * Enable TypeScript parsing in <script> blocks
+   */
+  isTs?: boolean;
+  /**
+   * Script file extension for generated output
+   */
+  scriptExt?: "ts" | "js";
+  /**
+   * Module name for runtime imports
+   */
+  runtimeModuleName?: string;
+  /**
+   * Global variable name for runtime (IIFE builds)
+   */
+  runtimeGlobalName?: string;
+  compatibility?: CompilerCompatibilityConfig;
+}
+/**
+ * Opt-in compatibility features for unsupported host/runtime combinations
+ */
+interface CompilerCompatibilityConfig {
+  vueVersion?: VueVersion;
+  /**
+   * Delegate .vue compilation to the host Vue compiler for legacy Vue runtimes
+   */
+  hostCompiler?: boolean;
+  /**
+   * Enable <script setup> when emitting function-body output for CDN/global Vue usage
+   */
+  scriptSetupInStandalone?: boolean;
+  /**
+   * Allow Vapor output for Options API SFCs when Vapor mode is enabled
+   */
+  optionsApiVapor?: boolean;
+  /**
+   * Host Nuxt major version for compatibility bridges
+   */
+  nuxtVersion?: 2 | 3 | 4;
+  /**
+   * Host Webpack major version for compatibility bridges
+   */
+  webpackVersion?: 4 | 5;
+}
+interface VitePluginConfig {
+  /**
+   * Files to include in compilation (glob patterns or strings)
+   */
+  include?: string | RegExp | (string | RegExp)[];
+  /**
+   * Files to exclude from compilation (glob patterns or strings)
+   */
+  exclude?: string | RegExp | (string | RegExp)[];
+  /**
+   * Glob patterns to scan for .vue files during pre-compilation
+   */
+  scanPatterns?: string[];
+  /**
+   * Glob patterns to ignore during pre-compilation
+   */
+  ignorePatterns?: string[];
+}
+/**
+ * Linter options
+ */
+interface LinterConfig {
+  /**
+   * Enable linting
+   */
+  enabled?: boolean;
+  /** Built-in lint preset */
+  preset?: "happy-path" | "opinionated" | "essential" | "incremental" | "ecosystem" | "nuxt";
+  /** Enable native type-aware lint rules from the active lint configuration */
+  typeAware?: boolean;
+  /**
+   * Rules to enable/disable
+   */
+  rules?: {
+    [k: string]: "off" | "warn" | "error";
+  };
+  /**
+   * Category-level severity overrides
+   */
+  categories?: {
+    correctness?: "off" | "warn" | "error";
+    suspicious?: "off" | "warn" | "error";
+    style?: "off" | "warn" | "error";
+    perf?: "off" | "warn" | "error";
+    a11y?: "off" | "warn" | "error";
+    security?: "off" | "warn" | "error";
+  };
+}
+interface TypeCheckerConfig {
+  /**
+   * Enable type checking
+   */
+  enabled?: boolean;
+  /**
+   * Enable strict mode
+   */
+  strict?: boolean;
+  /**
+   * Check component props
+   */
+  checkProps?: boolean;
+  /**
+   * Check component emits
+   */
+  checkEmits?: boolean;
+  /**
+   * Check template bindings
+   */
+  checkTemplateBindings?: boolean;
+  /**
+   * Check reactivity loss patterns
+   */
+  checkReactivity?: boolean;
+  /**
+   * Check setup context violations
+   */
+  checkSetupContext?: boolean;
+  /**
+   * Check invalid exports in <script setup>
+   */
+  checkInvalidExports?: boolean;
+  /**
+   * Check fallthrough attrs on multi-root templates
+   */
+  checkFallthroughAttrs?: boolean;
+  /** Resolve Vue 3 Options API template bindings during type checking. */
+  optionsApi?: boolean;
+  /**
+   * Enable Vue 2.7 / Nuxt 2 Options API template binding support
+   */
+  legacyVue2?: boolean;
+  /**
+   * Opt-in type-checking of .jsx/.tsx Vue components (#1497). Default-off so mixed Vue/React repositories do not accidentally route React .tsx through the Vue JSX checker. Set to true to route .jsx/.tsx through the Vize JSX virtual-TS path.
+   */
+  jsxTypecheck?: boolean;
+  /**
+   * Path to tsconfig.json
+   */
+  tsconfig?: string;
+  /** Path to the Corsa executable. tsgoPath is kept as a compatibility alias. */
+  corsaPath?: string;
+  /**
+   * Deprecated alias for typeChecker.corsaPath
+   */
+  tsgoPath?: string;
+  /**
+   * Path to a .d.ts file that declares template globals
+   */
+  globalsFile?: string;
+  /**
+   * Reserved Corsa server count. The direct project-session runner currently supports only 1.
+   */
+  servers?: number;
+}
+/**
+ * Formatter options
+ */
+interface FormatterConfig {
+  /**
+   * Max line width
+   */
+  printWidth?: number;
+  /**
+   * Indentation width
+   */
+  tabWidth?: number;
+  /**
+   * Use tabs for indentation
+   */
+  useTabs?: boolean;
+  /**
+   * Print semicolons
+   */
+  semi?: boolean;
+  /**
+   * Use single quotes
+   */
+  singleQuote?: boolean;
+  /**
+   * Use single quotes in JSX
+   */
+  jsxSingleQuote?: boolean;
+  /**
+   * Trailing commas
+   */
+  trailingComma?: "all" | "none" | "es5";
+  /**
+   * Print spaces between brackets in object literals
+   */
+  bracketSpacing?: boolean;
+  /**
+   * Keep > on the last line of multiline tags
+   */
+  bracketSameLine?: boolean;
+  /**
+   * Arrow parens mode
+   */
+  arrowParens?: "always" | "avoid";
+  /**
+   * End-of-line mode
+   */
+  endOfLine?: "lf" | "crlf" | "cr" | "auto";
+  /**
+   * Object property quoting mode
+   */
+  quoteProps?: "as-needed" | "consistent" | "preserve";
+  /**
+   * Force one attribute per line
+   */
+  singleAttributePerLine?: boolean;
+  /**
+   * Indent script and style blocks
+   */
+  vueIndentScriptAndStyle?: boolean;
+  /**
+   * Sort attributes
+   */
+  sortAttributes?: boolean;
+  /**
+   * Attribute ordering strategy
+   */
+  attributeSortOrder?: "alphabetical" | "as-written";
+  /**
+   * Merge bind and non-bind attrs for sorting
+   */
+  mergeBindAndNonBindAttrs?: boolean;
+  /**
+   * Maximum attributes per line before wrapping
+   */
+  maxAttributesPerLine?: number;
+  /**
+   * Custom attribute groups
+   */
+  attributeGroups?: string[][];
+  /**
+   * Normalize directive shorthands
+   */
+  normalizeDirectiveShorthands?: boolean;
+  /**
+   * Sort SFC blocks in canonical order
+   */
+  sortBlocks?: boolean;
+}
+/**
+ * Language server options
+ */
+interface LanguageServerConfig {
+  /**
+   * Enable the language server
+   */
+  enabled?: boolean;
+  /**
+   * Enable lint diagnostics
+   */
+  lint?: boolean;
+  /**
+   * Deprecated alias for lint
+   */
+  diagnostics?: boolean;
+  /**
+   * Enable project type checking diagnostics
+   */
+  typecheck?: boolean;
+  /**
+   * Enable editor-oriented IDE features
+   */
+  editor?: boolean;
+  /**
+   * Enable Vue ecosystem lint and editor helpers
+   */
+  ecosystem?: boolean;
+  /**
+   * Enable Vue 2.7 / Nuxt 2 editor and type-checking compatibility
+   */
+  legacyVue2?: boolean;
+  /**
+   * Enable completions
+   */
+  completion?: boolean;
+  /**
+   * Enable hover information
+   */
+  hover?: boolean;
+  /**
+   * Enable go-to-definition
+   */
+  definition?: boolean;
+  /**
+   * Enable reference search
+   */
+  references?: boolean;
+  /**
+   * Enable document symbols
+   */
+  documentSymbols?: boolean;
+  /**
+   * Enable workspace symbols
+   */
+  workspaceSymbols?: boolean;
+  /**
+   * Enable formatting via the language server
+   */
+  formatting?: boolean;
+  /**
+   * Enable code actions
+   */
+  codeActions?: boolean;
+  /**
+   * Enable rename support
+   */
+  rename?: boolean;
+  /**
+   * Enable code lenses
+   */
+  codeLens?: boolean;
+  /**
+   * Enable semantic tokens
+   */
+  semanticTokens?: boolean;
+  /**
+   * Enable document links
+   */
+  documentLinks?: boolean;
+  /**
+   * Enable folding ranges
+   */
+  foldingRanges?: boolean;
+  /**
+   * Enable inlay hints
+   */
+  inlayHints?: boolean;
+  /**
+   * Enable file rename edits
+   */
+  fileRename?: boolean;
+  /**
+   * Enable Corsa-backed IDE features
+   */
+  corsa?: boolean;
+  /**
+   * Deprecated alias for corsa
+   */
+  tsgo?: boolean;
+}
+/**
+ * Musea component gallery options
+ */
+interface MuseaConfig {
+  /**
+   * Glob patterns for art files
+   */
+  include?: string[];
+  /**
+   * Glob patterns to exclude
+   */
+  exclude?: string[];
+  /**
+   * Base path for gallery
+   */
+  basePath?: string;
+  /**
+   * Enable Storybook compatibility
+   */
+  storybookCompat?: boolean;
+  /**
+   * Enable inline art detection in .vue files
+   */
+  inlineArt?: boolean;
+  vrt?: MuseaVrtConfig;
+  a11y?: MuseaA11yConfig;
+  autogen?: MuseaAutogenConfig;
+}
+/**
+ * VRT (Visual Regression Testing) configuration
+ */
+interface MuseaVrtConfig {
+  /**
+   * Threshold for pixel comparison (0-1)
+   */
+  threshold?: number;
+  /**
+   * Output directory for screenshots
+   */
+  outDir?: string;
+  /**
+   * Viewport sizes
+   */
+  viewports?: MuseaViewport[];
+}
+interface MuseaViewport {
+  /**
+   * Viewport width
+   */
+  width: number;
+  /**
+   * Viewport height
+   */
+  height: number;
+  /**
+   * Viewport name
+   */
+  name?: string;
+}
+/**
+ * A11y configuration
+ */
+interface MuseaA11yConfig {
+  /**
+   * Enable a11y checking
+   */
+  enabled?: boolean;
+  /**
+   * Axe-core rules to enable/disable
+   */
+  rules?: {
+    [k: string]: boolean;
+  };
+}
+/**
+ * Autogen configuration
+ */
+interface MuseaAutogenConfig {
+  /**
+   * Enable auto-generation of variants
+   */
+  enabled?: boolean;
+  /**
+   * Max variants to generate per component
+   */
+  maxVariants?: number;
+}
+/**
+ * Global type declarations
+ */
+interface GlobalTypesConfig {
+  [k: string]: string | GlobalTypeDeclaration;
+}
+/**
+ * Global type declaration
+ */
+interface GlobalTypeDeclaration {
+  /**
+   * TypeScript type string
+   */
+  type: string;
+  /**
+   * Default value
+   */
+  defaultValue?: string;
+}
+/**
+ * Scoped Vize config entry for monorepos and workspaces
+ */
+interface VizeConfigEntry {
+  /**
+   * Human-readable entry name for inspect output and diagnostics
+   */
+  name?: string;
+  /**
+   * Directory used as the base for scoped file patterns and relative paths
+   */
+  basePath?: string;
+  /**
+   * Glob patterns this entry applies to
+   */
+  files?: string[];
+  /**
+   * Glob patterns this entry excludes
+   */
+  ignores?: string[];
+  /**
+   * Base config files or presets to compose
+   */
+  extends?: string | string[];
+  compiler?: CompilerConfig;
+  experimentals?: Record<string, boolean | Record<string, unknown> | null>;
+  vite?: VitePluginConfig;
+  linter?: LinterConfig;
+  typeChecker?: TypeCheckerConfig;
+  formatter?: FormatterConfig;
+  languageServer?: LanguageServerConfig;
+  lsp?: LanguageServerConfig;
+  musea?: MuseaConfig;
+  globalTypes?: GlobalTypesConfig;
+}
+//#endregion
+//#region ../../cli/src/types/runtime.d.ts
+type MaybePromise<T> = T | Promise<T>;
+interface ConfigEnv {
+  mode: string;
+  command: "serve" | "build" | "check" | "lint" | "fmt";
+  isSsrBuild?: boolean;
+}
+type VueConfig = {
+  /**
+   * Vue dialect selected by the documented `vue.version` config key.
+   */
+  version?: VueVersion;
+};
+type UserConfigEntry = VizeConfigEntry & {
+  /**
+   * Shared Vue dialect section accepted by the Rust config model.
+   */
+  vue?: VueConfig;
+};
+type UserConfig = Omit<VizeConfig, "entries"> & {
+  /**
+   * Shared Vue dialect section accepted by the Rust config model.
+   */
+  vue?: VueConfig;
+  /**
+   * Legacy alias for `languageServer`.
+   * Prefer `languageServer`.
+   */
+  lsp?: LanguageServerConfig;
+  /**
+   * Scoped config entries for monorepos and workspaces.
+   */
+  entries?: UserConfigEntry[];
+};
+type UserConfigInput = UserConfig | UserConfigEntry[];
+type ResolvedVizeConfig = VizeConfig & {
+  /**
+   * Normalized flat entries. Plain object configs become one entry; array configs
+   * keep their order.
+   */
+  entries: VizeConfigEntry[];
+};
+type UserConfigExport = UserConfigInput | ((env: ConfigEnv) => MaybePromise<UserConfigInput>);
+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 src/experimental-options.d.ts
+type ExperimentalSwitch = boolean | null | Record<string, unknown>;
+interface ExperimentalOptions {
+  vapor?: ExperimentalSwitch;
+  jsxVapor?: ExperimentalSwitch;
+  intagComment?: ExperimentalSwitch;
+  inTagComment?: ExperimentalSwitch;
+  pattenedTemplate?: ExperimentalSwitch;
+  patternedTemplate?: ExperimentalSwitch;
+  serverScript?: ExperimentalSwitch;
+  "server script"?: ExperimentalSwitch;
+}
+interface ExperimentalCompileFlags {
+  experimentalInTagComments?: boolean;
+  experimentalPatternedTemplate?: boolean;
+  experimentalServerScript?: boolean;
+}
+interface ExperimentalPluginOptions extends ExperimentalCompileFlags {
+  /** Experimental RFC opt-ins. Values other than `false` or `null` enable keys. */
+  experimentals?: ExperimentalOptions;
+}
+//#endregion
+//#region src/types.d.ts
+interface MacroArtifact {
+  kind: string;
+  name: string;
+  source: string;
+  content: string;
+  moduleCode?: string;
+  start: number;
+  end: number;
+}
+type VizeVueVersion = 0.11 | 1 | 2 | "2.7" | 3 | "legacy";
+interface VizeCompatibilityOptions {
+  /**
+   * Host Vue version. Vue 0.11/1/2/2.7 opt into host-compiler compatibility.
+   */
+  vueVersion?: VizeVueVersion;
+  /**
+   * Keep .vue files on the existing Vue compiler for legacy Vue runtimes.
+   * @default true when vueVersion is 0.11, 1, 2, "2.7", or "legacy"
+   */
+  hostCompiler?: boolean;
+  /**
+   * Enable function-body output for CDN/global Vue evaluation.
+   */
+  scriptSetupInStandalone?: boolean;
+  /**
+   * Allow Vapor output for Options API SFCs when vapor is enabled.
+   */
+  optionsApiVapor?: boolean;
+  /**
+   * Override the host Nuxt major when this option object is shared with Nuxt.
+   */
+  nuxtVersion?: 2 | 3 | 4;
+  /**
+   * Override the host Webpack major when this option object is shared with unplugin.
+   */
+  webpackVersion?: 4 | 5;
+}
+interface VizeOptions extends ExperimentalPluginOptions {
+  /**
+   * Inline shared Vize config for Vite Plus-first projects.
+   * Direct plugin options still take precedence over these values.
+   */
+  config?: UserConfigExport;
+  /**
+   * Vue major version for the host project.
+   *
+   * Legacy Vue projects must keep their existing compiler plugin/loader in
+   * charge of SFC compilation. Set this to `0.11`, `1`, `2`, or `"legacy"` to
+   * make Vize a non-invasive compatibility plugin that does not intercept
+   * `.vue` requests or inject Vue 3 bundler defines.
+   *
+   * @default 3
+   */
+  vueVersion?: VizeVueVersion;
+  /**
+   * Opt-in compatibility features for unsupported host/runtime combinations.
+   */
+  compatibility?: VizeCompatibilityOptions;
+  /**
+   * Compilation output mode. Use "function" for CDN/global Vue evaluation.
+   * @default "module"
+   */
+  mode?: "module" | "function";
+  /**
+   * Module name for runtime imports.
+   * @default "vue"
+   */
+  runtimeModuleName?: string;
+  /**
+   * Global variable name for function/standalone output.
+   * @default "Vue"
+   */
+  runtimeGlobalName?: string;
+  /**
+   * 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;
+  ssr?: boolean;
+  /** Enable source map generation */
+  sourceMap?: boolean;
+  /**
+   * Enable Vapor mode compilation
+   * @default false
+   */
+  vapor?: boolean;
+  /**
+   * Default output mode for `.jsx`/`.tsx` components without a `"use vue:*"`
+   * directive. Distinct from `vapor` (which targets `.vue` SFCs): a project can
+   * keep SFCs on VDOM while defaulting JSX to Vapor, or vice versa. A
+   * per-component `"use vue:vapor"` / `"use vue:vdom"` directive overrides it.
+   * @default "vdom"
+   */
+  jsxMode?: "vdom" | "vapor";
+  /**
+   * Treat lowercase non-HTML tags as custom renderer elements instead of Vue components.
+   * Useful for TresJS and other custom renderers.
+   * @default false
+   */
+  customRenderer?: boolean;
+  /**
+   * Template syntax compatibility mode.
+   * @default "standard"
+   */
+  templateSyntax?: "standard" | "strict" | "quirks";
+  /**
+   * Root directory to scan for .vue files
+   * @default Vite's root
+   */
+  root?: string;
+  /**
+   * Glob patterns to scan for .vue files during pre-compilation
+   * Use an empty array to disable startup pre-compilation and compile on demand.
+   * @default ['**\/*.vue']
+   */
+  scanPatterns?: string[];
+  /**
+   * Maximum number of Vue files to compile in a single native batch during
+   * pre-compilation. Lower values reduce peak V8 heap usage in large apps.
+   * @default 128
+   */
+  precompileBatchSize?: number;
+  /**
+   * Glob patterns to ignore during pre-compilation
+   * @default ['node_modules/**', 'dist/**', '.git/**', '.nuxt/**', '.output/**', '.nitro/**', 'coverage/**']
+   */
+  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;
+  /** External source path from `<style src>`, when present */
+  src?: string | null;
+  /** 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;
+  /** Compile-time macro artifacts extracted from the source SFC */
+  macroArtifacts?: MacroArtifact[];
+  /** Per-block style metadata extracted from the source SFC */
+  styles?: StyleBlockInfo[];
+  /** Files loaded through SFC `src` imports */
+  dependencies?: string[];
+}
+//#endregion
+export { VizeVueVersion as a, ResolvedVizeConfig as c, VizeOptions as i, UserConfigExport as l, MacroArtifact as n, ConfigEnv as o, VizeCompatibilityOptions as r, LoadConfigOptions as s, CompiledModule as t, VizeConfig as u };