@vizejs/vite-plugin 0.0.1-alpha.9 → 0.0.1-alpha.98

package/README.md

@@ -30,11 +30,11 @@ yarn add @vizejs/vite-plugin
 ```ts
 // vite.config.ts
 import { defineConfig } from 'vite'
-import { vizeNative } from '@vizejs/vite-plugin'
+import vize from '@vizejs/vite-plugin'
 
 export default defineConfig({
   plugins: [
-    vizeNative({
+    vize({
       // options
     })
   ]
@@ -47,12 +47,12 @@ For Nuxt 3, add the plugin to your `nuxt.config.ts`:
 
 ```ts
 // nuxt.config.ts
-import { vizeNative } from '@vizejs/vite-plugin'
+import vize from '@vizejs/vite-plugin'
 
 export default defineNuxtConfig({
   vite: {
     plugins: [
-      vizeNative({
+      vize({
         // Exclude Nuxt's internal .vue files if needed
         exclude: [/node_modules/, /#/, /\.nuxt/]
       })
@@ -81,7 +81,7 @@ export default defineNuxtConfig({
   },
   vite: {
     plugins: [
-      vizeNative()
+      vize()
     ]
   }
 })

package/dist/index.d.ts

@@ -1,5 +1,498 @@
-import type { Plugin } from 'vite';
-import type { VizeOptions, CompiledModule } from './types.js';
-export type { VizeOptions, CompiledModule };
-export declare function vize(options?: VizeOptions): Plugin;
-export default vize;
+import { Plugin } from "vite";
+
+//#region ../vize/src/types.d.ts
+type MaybePromise<T> = T | Promise<T>;
+interface ConfigEnv {
+  mode: string;
+  command: "serve" | "build" | "check" | "lint" | "fmt";
+  isSsrBuild?: boolean;
+}
+type UserConfigExport = VizeConfig | ((env: ConfigEnv) => MaybePromise<VizeConfig>);
+type RuleSeverity = "off" | "warn" | "error";
+type RuleCategory = "correctness" | "suspicious" | "style" | "perf" | "a11y" | "security";
+/**
+ * Vize configuration options
+ */
+interface VizeConfig {
+  /**
+   * 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;
+}
+/**
+ * Compiler configuration
+ */
+interface CompilerConfig {
+  /**
+   * Compilation mode
+   * @default 'module'
+   */
+  mode?: "module" | "function";
+  /**
+   * Enable Vapor mode compilation
+   * @default false
+   */
+  vapor?: 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[];
+}
+/**
+ * Linter configuration
+ */
+interface LinterConfig {
+  /**
+   * Enable linting
+   */
+  enabled?: boolean;
+  /**
+   * Rules to enable/disable
+   */
+  rules?: Record<string, RuleSeverity>;
+  /**
+   * 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 tsgo binary
+   */
+  tsgoPath?: 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 true
+   */
+  enabled?: boolean;
+  /**
+   * Enable diagnostics
+   * @default true
+   */
+  diagnostics?: boolean;
+  /**
+   * Enable completions
+   * @default true
+   */
+  completion?: boolean;
+  /**
+   * Enable hover information
+   * @default true
+   */
+  hover?: boolean;
+  /**
+   * Enable go-to-definition
+   * @default true
+   */
+  definition?: boolean;
+  /**
+   * Enable formatting via LSP
+   * @default true
+   */
+  formatting?: boolean;
+  /**
+   * Enable code actions
+   * @default true
+   */
+  codeActions?: boolean;
+  /**
+   * Use tsgo for type checking in LSP
+   * @default false
+   */
+  tsgo?: boolean;
+}
+/**
+ * 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;
+}
+/**
+ * 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 src/types.d.ts
+interface VizeOptions {
+  /**
+   * 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;
+  /**
+   * 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;
+  /**
+   * Enable debug logging
+   * @default false
+   */
+  debug?: boolean;
+}
+interface CompiledModule {
+  code: string;
+  css?: string;
+  scopeId: string;
+  hasScoped: boolean;
+  templateHash?: string;
+  styleHash?: string;
+  scriptHash?: string;
+}
+
+//#endregion
+//#region src/index.d.ts
+/**
+ * Define a Vize configuration with type checking.
+ * Accepts a plain object or a function that receives ConfigEnv.
+ */
+declare function defineConfig(config: UserConfigExport): UserConfigExport;
+/**
+ * Load Vize configuration from file
+ */
+declare function loadConfig(root: string, options?: LoadConfigOptions): Promise<VizeConfig | null>;
+/**
+ * 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>;
+declare function vize(options?: VizeOptions): Plugin;
+
+//#endregion
+export { CompiledModule, LoadConfigOptions, VizeConfig, VizeOptions, vize as default, defineConfig, loadConfig, vize, vizeConfigStore };