@vixt/core 0.10.1 → 0.11.0

package/dist/node/index.d.mts

@@ -4,21 +4,35 @@ import { HtmlTagDescriptor, InlineConfig, LogLevel, PluginOption, ServerOptions,
 import Legacy from "@vitejs/plugin-legacy";
 import Analyzer from "vite-bundle-analyzer";
 import Ssl from "@vitejs/plugin-basic-ssl";
+import AutoImport from "unplugin-auto-import/vite";
+import { NitroPluginConfig } from "nitro/vite";
 import Checker from "vite-plugin-checker";
 import { RawVueCompilerOptions } from "@vue/language-core";
 import { TSConfig } from "pkg-types";
 
-//#region src/node/vixt.d.ts
+//#region src/node/types/layer.d.ts
+interface VixtConfigLayerMeta extends ConfigLayerMeta {
+  /** layer name */
+  name?: string;
+  /** layer alias */
+  alias?: string;
+}
+interface VixtConfigLayer extends ConfigLayer<VixtOptions, VixtConfigLayerMeta> {
+  /** when layer is in node_modules, layer will copy to `<buildLayersDir>/<layerName>`, and change cwd */
+  cwd?: string;
+}
+interface LoadVixtConfigOptions extends LoadConfigOptions<VixtOptions, VixtConfigLayerMeta> {}
+interface ResolvedVixtConfig extends ResolvedConfig<VixtOptions, VixtConfigLayerMeta> {}
+//#endregion
+//#region src/node/types/vixt.d.ts
 interface Vixt {
   options: VixtOptions;
   _layers: VixtConfigLayer[];
   _modules: VixtModule[];
 }
-declare function loadVixt(opts?: LoadConfigOptions<VixtOptions>): Promise<Vixt>;
-declare function createVixtPlugin(loadOptions: LoadConfigOptions<VixtOptions>): (options?: VixtOptions | undefined) => _$vite.PluginOption;
-//#endregion
-//#region src/node/module.d.ts
 type ExtractPluginOptions<Options = any> = (Options extends ((...args: any[]) => any) ? Parameters<Options>[0] : Options);
+//#endregion
+//#region src/node/types/module.d.ts
 type ModuleOptions = Record<string, any>;
 interface ModuleMeta extends Record<string, any> {
   name?: string;
@@ -34,119 +48,10 @@ interface VixtModule<T extends ModuleOptions = ModuleOptions> {
   getOptions?: (inlineOptions: Partial<T>, Vixt: Vixt) => T;
   getMeta?: () => ModuleMeta;
 }
-declare function defineVitePlugin<Options = any>(pluginFn: (options?: Options) => PluginOption): (options?: Options) => PluginOption;
-declare function defineVixtModule<T extends ModuleOptions>(definition: ModuleDefinition<T> | VixtModule<T>): VixtModule<T>;
-declare function installModule<T extends ModuleOptions = ModuleOptions>(module: VixtModule<T>, inlineOptions: any, vixt: Vixt): PluginOption;
-declare function applyLayerModules({
-  config,
-  layers
-}: ResolvedVixtConfig): Promise<VixtModule[]>;
 //#endregion
-//#region src/node/config.d.ts
-interface VixtOptions {
-  /**
-   * Vixt App configuration.
-   */
-  app?: AppOptions;
-  /**
-   * Shared build configuration.
-   */
-  build?: BuildOptions;
-  /**
-   * Define the root directory of your application.
-   * @default process.cwd()
-   */
-  rootDir?: string;
-  /**
-   * Define the monorepo workspace directory of your application.
-   */
-  workspaceDir?: string;
-  /**
-   * Define the source directory of your application.
-   * @default '<rootDir>/src'
-   */
-  srcDir?: string;
-  /**
-   * Define the server directory of your application.
-   * @default '<rootDir>/server'
-   */
-  serverDir?: string;
-  /**
-   * Define the directory where your built files will be placed.
-   * @default '<rootDir>/.vixt'
-   */
-  buildDir?: string;
-  /**
-   * @default '<buildDir>/types'
-   */
-  buildTypesDir?: string;
-  /**
-   * @default '<buildDir>/layers'
-   */
-  buildLayersDir?: string;
-  /**
-   * @default '<buildDir>/imports'
-   */
-  buildImportsDir?: string;
-  /**
-   * Define the directory of your Vixt modules.
-   * @default '<srcDir>/modules'
-   */
-  modulesDir?: string;
-  /**
-   * Define the directory of your Vixt plugins.
-   * @default '<srcDir>/plugins'
-   */
-  pluginsDir?: string;
-  /**
-   * Whether your app is running in development mode.
-   * @default false
-   */
-  dev?: boolean;
-  /**
-   * Whether your app is being unit tested.
-   * @default false
-   */
-  test?: boolean;
-  /**
-   * Set to `true` to enable debug mode.
-   * @default false
-   */
-  debug?: boolean;
-  /**
-   * Whether to enable rendering of HTML.
-   * @default false
-   */
-  ssr?: boolean;
-  /**
-   * You can improve your DX by defining additional aliases to access custom directories within your JavaScript and CSS.
-   */
-  alias?: AliasOptions;
-  /**
-   * Configuration that will be passed directly to Vite.
-   */
-  appConfig?: Record<string, any>;
-  devServer?: DevServerOptions;
-  /** Vite config input */
-  vite?: Omit<UserConfig, 'plugins'>;
-  /** layer meta */
-  meta?: VixtConfigLayerMeta;
-  /** layers */
-  extends?: string[];
-  /** modules */
-  modules?: VixtModule[];
-  /** plugins */
-  plugins?: string[];
-  /** typescript */
-  typescript?: TypescriptOptions;
-  /**
-   * Whether to copy layers from `node_modules` to `.vixt/layers`
-   * @default true
-   * @experimental
-   */
-  copyLayers?: boolean;
-  /** custom options */
-  [key: string]: any;
+//#region src/node/types/options.d.ts
+interface AliasOptions {
+  [find: string]: string;
 }
 interface AppHeadAttrs {
   children?: string;
@@ -163,35 +68,88 @@ interface AppHead {
 }
 interface AppOptions {
   /**
-   * The base path of your Nuxt application.
+   * The base path of your Vixt application.
    * @default '/'
+   * @example
+   * ```ts
+   * export default defineVixtConfig({
+   *   app: {
+   *     baseURL: '/prefix/',
+   *   },
+   * })
+   * ```
    */
   baseURL?: string;
   /**
    * You can define the CSS files/modules/libraries you want to set globally.
+   * @example
+   * ```ts
+   * export default defineVixtConfig({
+   *   css: [
+   *     // CSS file in the project
+   *     '~/styles/main.css',
+   *     // SCSS file in the project
+   *     '~/styles/main.scss',
+   *   ],
+   * })
+   * ```
    */
   css?: string[];
   /**
-   * The entry file relative to <srcDir>
-   * @default 'main.ts'(vue)
-   * @default 'main.tsx'(react)
-   * @example 'entry.ts'(relative to '/<srcDir>/entry.ts')
+   * The entry file relative to `<srcDir>`
+   * @default
+   * 'main.ts' // in vue
+   * 'main.tsx' // in react
+   * 'index.ts' // in vitepress
+   * @example 'entry.ts' // relative to '/<srcDir>/entry.ts'
    */
   entryFile?: string;
   /** The default entry code */
   entryCode?: string;
-  /**
-   * Whether to enable generate and transform entry file
-   * @default true
-   */
-  transformEntryFile?: boolean;
-  /**
-   * Whether to enable transform and transform index.html
-   * @default true
-   */
-  transformIndexHtml?: boolean;
   /**
    * Set default configuration for `<head>`.
+   * @default
+   * ```json
+   * {
+   *   "meta": [
+   *     { "charset": "utf-8" },
+   *     { "name": "viewport", "content": "width=device-width, initial-scale=1" }
+   *   ]
+   * }
+   * ```
+   * @example
+   * ```ts
+   * export default defineVixtConfig({
+   *   app: {
+   *     head: {
+   *       meta: [
+   *         // <meta name="viewport" content="width=device-width, initial-scale=1">
+   *         { name: 'viewport', content: 'width=device-width, initial-scale=1' }
+   *       ],
+   *       script: [
+   *         // <script src="https://awesome-lib.js"></script>
+   *         { src: 'https://awesome-lib.js' }
+   *       ],
+   *       link: [
+   *         // <link rel="stylesheet" href="https://awesome-lib.css">
+   *         { rel: 'stylesheet', href: 'https://awesome-lib.css' }
+   *       ],
+   *       style: [
+   *         // <style type="text/css">:root { color: red }</style>
+   *         { children: ':root { color: red }', type: 'text/css' }
+   *       ],
+   *       noscript: [
+   *         // <noscript>JavaScript is required</noscript>
+   *         { children: 'JavaScript is required' }
+   *       ],
+   *       title: [
+   *         // <title>Website Title</title>
+   *         { children: 'Website Title' }
+   *       ]
+   *     }
+   *   }
+   * })
+   * ```
    */
   head?: AppHead;
   /**
@@ -209,12 +167,36 @@ interface AppOptions {
    * @default 'div'
    */
   rootTag?: string;
+  /**
+   * Whether to enable generate and transform entry file
+   * @default true
+   */
+  transformEntryFile?: boolean;
+  /**
+   * Whether to enable transform and transform index.html
+   * @default true
+   */
+  transformIndexHtml?: boolean;
 }
-interface AliasOptions {
-  [find: string]: string;
+interface BuildOptions {
+  /**
+   * Set to true to enable bundle analysis, or pass an object with `enabled: true` and options: [vite-bundle-analyzer](https://github.com/nonzzz/vite-bundle-analyzer)
+   */
+  analyze?: boolean | ExtractPluginOptions<typeof Analyzer> & {
+    enabled?: boolean;
+  };
+  /**
+   * Set to true to enable legacy mode, or pass an object with `enabled: true` and options: [@vitejs/plugin-legacy](https://github.com/vitejs/vite/tree/main/packages/plugin-legacy)
+   */
+  legacy?: boolean | ExtractPluginOptions<typeof Legacy> & {
+    enabled?: boolean;
+  };
 }
 interface DevServerOptions extends Pick<ServerOptions, 'port' | 'host' | 'cors'> {
-  /** https://github.com/vitejs/vite-plugin-basic-ssl */
+  /**
+   * Whether to enable HTTPS by using [@vitejs/plugin-basic-ssl](https://github.com/vitejs/vite-plugin-basic-ssl).
+   * @default false
+   */
   https?: boolean | ExtractPluginOptions<typeof Ssl> & {
     enabled?: boolean;
   };
@@ -223,25 +205,41 @@ interface DevServerOptions extends Pick<ServerOptions, 'port' | 'host' | 'cors'>
    */
   watch?: string[];
 }
-interface BuildOptions {
-  /** https://github.com/nonzzz/vite-bundle-analyzer */
-  analyze?: boolean | ExtractPluginOptions<typeof Analyzer> & {
-    enabled?: boolean;
-  };
-  /** https://github.com/vitejs/vite/tree/main/packages/plugin-legacy */
-  legacy?: boolean | ExtractPluginOptions<typeof Legacy> & {
-    enabled?: boolean;
-  };
+interface ImportsOptions extends ExtractPluginOptions<typeof AutoImport> {}
+interface NitroOptions extends Omit<NitroPluginConfig, 'serverDir'> {
+  enabled?: boolean;
+  serverDir?: Exclude<NitroPluginConfig['serverDir'], boolean>;
 }
 interface TypescriptOptions {
   references?: (string | {
     path?: string;
     content?: string;
   })[];
+  /**
+   * You can extend the generated TypeScript configurations (.vixt/tsconfig.json) using this option.
+   */
   tsConfig?: TSConfig & {
+    /**
+     * @default '@vue/tsconfig/tsconfig.dom.json'
+     */
+    extends?: string | string[];
     vueCompilerOptions?: RawVueCompilerOptions;
   };
-  /** https://github.com/fi3ework/vite-plugin-checker */
+  /**
+   * Enable build-time or dev-server type checking.
+   * @see https://github.com/fi3ework/vite-plugin-checker
+   * @example
+   * ```ts
+   * export default defineVixtConfig({
+   *   typescript: {
+   *     typeCheck: {
+   *       vueTsc: true // for Vue
+   *       typescript: true // for React
+   *     },
+   *   },
+   * })
+   * ```
+   */
   typeCheck?: ExtractPluginOptions<typeof Checker>;
   /**
    * Generate a `*.vue` shim
@@ -249,18 +247,157 @@ interface TypescriptOptions {
    */
   shim?: boolean;
 }
-interface VixtConfigLayerMeta extends ConfigLayerMeta {
-  /** layer name */
-  name?: string;
-  /** layer alias */
-  alias?: string;
+//#endregion
+//#region src/node/types/config.d.ts
+interface VixtConfig {
+  /**
+   * You can improve your DX by defining additional aliases to access custom directories within your JavaScript and CSS.
+   * @default
+   * ```json
+   * {
+   *   "@": "/<rootDir>/<srcDir>",
+   *   "~": "/<rootDir>/<srcDir>",
+   *   "~~": "/<rootDir>",
+   *   "@@": "/<rootDir>",
+   *   "#": "/<rootDir>/<buildDir>"
+   * }
+   * ```
+   */
+  alias?: AliasOptions;
+  /**
+   * Vixt App configuration.
+   */
+  app?: AppOptions;
+  /**
+   * Additional app configuration.
+   */
+  appConfig?: Record<string, any>;
+  /**
+   * Shared build configuration.
+   */
+  build?: BuildOptions;
+  /**
+   * Define the directory where your built files will be placed.
+   * @default '<rootDir>/.vixt'
+   */
+  buildDir?: string;
+  /**
+   * @default '<buildDir>/types'
+   */
+  buildTypesDir?: string;
+  /**
+   * @default '<buildDir>/layers'
+   */
+  buildLayersDir?: string;
+  /**
+   * Whether to copy layers from `node_modules` to `.vixt/layers`
+   * @default true
+   * @experimental
+   */
+  copyLayers?: boolean;
+  /**
+   * Set to `true` to enable debug mode.
+   * @default false
+   */
+  debug?: boolean;
+  /**
+   * Whether your app is running in development mode.
+   * @default false
+   */
+  dev?: boolean;
+  /**
+   * Set CORS options for the dev server, the `port`, `host`, `cors` options will be passed to `vite.server`
+   */
+  devServer?: DevServerOptions;
+  /**
+   * Extend project from multiple local or remote sources.
+   */
+  extends?: string[];
+  /**
+   * Configure how Vixt auto-imports composables into your application.
+   */
+  imports?: ImportsOptions;
+  /**
+   * Custom meta for layer.
+   */
+  meta?: VixtConfigLayerMeta;
+  /**
+   * Modules are Vixt extensions which can extend its core functionality and add endless integrations.
+   */
+  modules?: VixtModule[];
+  /**
+   * Define the directory of your Vixt modules.
+   * @default '<srcDir>/modules'
+   */
+  modulesDir?: string;
+  /**
+   * Configuration for Nitro.
+   */
+  nitro?: NitroOptions;
+  /**
+   * An array of vixt app plugins.
+   */
+  plugins?: string[];
+  /**
+   * Define the directory of your Vixt plugins.
+   * @default '<srcDir>/plugins'
+   */
+  pluginsDir?: string;
+  /**
+   * Define the root directory of your application.
+   * @default process.cwd()
+   */
+  rootDir?: string;
+  /**
+   * Whether to enable rendering of HTML.
+   */
+  ssr?: boolean;
+  /**
+   * Define the source directory of your application.
+   * @default '<rootDir>/src'
+   */
+  srcDir?: string;
+  /**
+   * Whether your app is being unit tested.
+   * @default false
+   */
+  test?: boolean;
+  /**
+   * Configuration for TypeScript integration.
+   */
+  typescript?: TypescriptOptions;
+  /**
+   * Configuration that will be passed directly to Vite.
+   */
+  vite?: Omit<UserConfig, 'plugins'>;
+  /**
+   * Define the monorepo workspace directory of your application.
+   */
+  workspaceDir?: string;
 }
-interface VixtConfigLayer extends ConfigLayer<VixtOptions, VixtConfigLayerMeta> {
-  /** when layer is in node_modules, layer will copy to `<buildLayersDir>/<layerName>`, and change cwd */
-  cwd?: string;
+/**
+ * This is a global declared interface for module `@vixt/core`,
+ * it includes some properties that declared in `VueVixtOptions`, `ReactVixtOptions`, etc.,
+ * see {@link VixtConfig} to view the common options.
+ */
+interface VixtOptions extends VixtConfig {
+  /** custom options */
+  [key: string]: any;
 }
-interface LoadVixtConfigOptions extends LoadConfigOptions<VixtOptions, VixtConfigLayerMeta> {}
-interface ResolvedVixtConfig extends ResolvedConfig<VixtOptions, VixtConfigLayerMeta> {}
+//#endregion
+//#region src/node/config.d.ts
+/**
+ * Define the Vixt config.
+ * @example
+ * ```ts
+ * // vixt.config.ts
+ * import { defineVixtConfig } from 'vixt'
+ *
+ * export default defineVixtConfig({
+ *   // Vixt配置
+ * })
+ * ```
+ */
 declare function defineVixtConfig(input: VixtOptions): VixtOptions;
 declare function loadVixtConfig(opts?: LoadVixtConfigOptions): Promise<ResolvedVixtConfig>;
 declare function applyLayers({
@@ -269,10 +406,9 @@ declare function applyLayers({
 }: ResolvedVixtConfig): VixtConfigLayer[];
 declare function isSamePath(a: string, b: string): boolean;
 declare function resolveLayersDirs(layers?: VixtConfigLayer[]): Record<string, string[] | undefined>;
-declare const VixtClientAutoImports: Record<string, string[]>;
 //#endregion
 //#region src/node/env.d.ts
-/** https://github.com/vitejs/vite/blob/v8.0.0-beta.3/packages/vite/src/node/cli.ts */
+/** https://github.com/vitejs/vite/blob/main/packages/vite/src/node/cli.ts */
 interface GlobalCLIOptions {
   '--'?: string[];
   'c'?: boolean | string;
@@ -306,12 +442,79 @@ declare function findUpWorkspaceDir(): string | undefined;
  */
 declare function loadWorkspaceEnv(mode?: string, prefixes?: string | string[]): Record<string, string>;
 //#endregion
+//#region src/node/module.d.ts
+/**
+ * A helper function for creating Vite plugins.
+ * @example
+ * ```ts
+ * import { defineVitePlugin } from 'vixt'
+ *
+ * interface PluginOptions {
+ *   enabled?: boolean
+ * }
+ *
+ * export const myVitePlugin = defineVitePlugin<PluginOptions>((options) => {
+ *   console.log(options)
+ *   return {
+ *     name: 'my-vite-plugin',
+ *     configResolved(config) {
+ *       console.log(config)
+ *     }
+ *   }
+ * })
+ * ```
+ */
+declare function defineVitePlugin<Options = any>(pluginFn: (options?: Options) => PluginOption): (options?: Options) => PluginOption;
+/**
+ * Define a Vixt module.
+ * @example
+ * ```ts
+ * // src/modules/my-module.ts
+ * import { defineVixtModule } from 'vixt'
+ *
+ * interface ModuleOptions {
+ *   enabled?: boolean
+ * }
+ *
+ * declare module 'vixt' {
+ *   interface VixtOptions {
+ *     myModuleOptions?: ModuleOptions
+ *   }
+ * }
+ *
+ * const name = 'my-module'
+ * export default defineVixtModule<ModuleOptions>({
+ *   meta: { name },
+ *   defaults: { enabled: true },
+ *   setup(options, vixt) {
+ *     console.log(options) // { enabled: true }
+ *     return {
+ *       name,
+ *       configResolved(config) {
+ *         console.log(config)
+ *       }
+ *     } // return one or more vite plugins
+ *   }
+ * })
+ * ```
+ */
+declare function defineVixtModule<T extends ModuleOptions = ModuleOptions>(definition: ModuleDefinition<T> | VixtModule<T>): VixtModule<T>;
+declare function installModule<T extends ModuleOptions = ModuleOptions>(module: VixtModule<T>, inlineOptions: any, vixt: Vixt): PluginOption;
+declare function applyLayerModules({
+  config,
+  layers
+}: ResolvedVixtConfig): Promise<VixtModule[]>;
+//#endregion
 //#region src/node/modules/index.d.ts
 declare const virtualModuleIds: {
-  css: string | undefined;
   appConfig: string | undefined;
+  css: string | undefined;
   plugins: string | undefined;
 };
-declare const builtinModules: (VixtModule<ModuleOptions> | VixtModule<AliasOptions> | VixtModule<AppOptions> | VixtModule<BuildOptions> | VixtModule<DevServerOptions> | VixtModule<TypescriptOptions>)[];
+declare const builtinModules: (VixtModule<ModuleOptions> | VixtModule<AliasOptions> | VixtModule<AppOptions> | VixtModule<BuildOptions> | VixtModule<DevServerOptions> | VixtModule<ImportsOptions> | VixtModule<NitroOptions> | VixtModule<TypescriptOptions>)[];
+//#endregion
+//#region src/node/vixt.d.ts
+declare function loadVixt(opts?: LoadConfigOptions<VixtOptions>): Promise<Vixt>;
+declare function createVixtPlugin(loadOptions: LoadConfigOptions<VixtOptions>): (options?: VixtOptions | undefined) => _$vite.PluginOption;
 //#endregion
-export { AliasOptions, AppHead, AppHeadAttrs, AppOptions, BuildOptions, DevServerOptions, ExtractPluginOptions, GlobalCLIOptions, LoadVixtConfigOptions, ModuleDefinition, ModuleMeta, ModuleOptions, ResolvedVixtConfig, TypescriptOptions, Vixt, VixtClientAutoImports, VixtConfigLayer, VixtConfigLayerMeta, VixtModule, VixtOptions, applyLayerModules, applyLayers, builtinModules, createVixtPlugin, defineVitePlugin, defineVixtConfig, defineVixtModule, findUpWorkspaceDir, installModule, isSamePath, loadCLIOptions, loadEnv, loadMode, loadVixt, loadVixtConfig, loadWorkspaceEnv, resolveLayersDirs, virtualModuleIds };
+export { AliasOptions, AppHead, AppHeadAttrs, AppOptions, BuildOptions, DevServerOptions, ExtractPluginOptions, GlobalCLIOptions, ImportsOptions, LoadVixtConfigOptions, ModuleDefinition, ModuleMeta, ModuleOptions, NitroOptions, ResolvedVixtConfig, TypescriptOptions, Vixt, VixtConfig, VixtConfigLayer, VixtConfigLayerMeta, VixtModule, VixtOptions, applyLayerModules, applyLayers, builtinModules, createVixtPlugin, defineVitePlugin, defineVixtConfig, defineVixtModule, findUpWorkspaceDir, installModule, isSamePath, loadCLIOptions, loadEnv, loadMode, loadVixt, loadVixtConfig, loadWorkspaceEnv, resolveLayersDirs, virtualModuleIds };