1963 lines
61 KiB
TypeScript
1963 lines
61 KiB
TypeScript
import { TransitionProps, KeepAliveProps } from 'vue';
|
||
import { RouterOptions as RouterOptions$1, RouterHistory } from 'vue-router';
|
||
import { UnimportOptions, InlinePreset, Import } from 'unimport';
|
||
import { CompilerOptions } from '@vue/compiler-core';
|
||
import { Hookable } from 'hookable';
|
||
import { Ignore } from 'ignore';
|
||
import { TSConfig, readPackageJSON } from 'pkg-types';
|
||
import { Server } from 'node:http';
|
||
import { Server as Server$1 } from 'node:https';
|
||
import { InlineConfig, ViteDevServer, UserConfig, ServerOptions } from 'vite';
|
||
import { Manifest } from 'vue-bundle-renderer';
|
||
import { EventHandler } from 'h3';
|
||
import { Configuration, Compiler, Stats, WebpackError } from 'webpack';
|
||
import { NitroConfig, Nitro, NitroEventHandler, NitroDevEventHandler } from 'nitropack';
|
||
import { BundleAnalyzerPlugin } from 'webpack-bundle-analyzer';
|
||
import { PluginVisualizerOptions } from 'rollup-plugin-visualizer';
|
||
import { PluginOptions } from 'mini-css-extract-plugin';
|
||
import { BasePluginOptions, DefinedDefaultMinimizerAndOptions } from 'terser-webpack-plugin';
|
||
import { BasePluginOptions as BasePluginOptions$1, DefinedDefaultMinimizerAndOptions as DefinedDefaultMinimizerAndOptions$1 } from 'css-minimizer-webpack-plugin';
|
||
import { Options } from 'webpack-dev-middleware';
|
||
import { IncomingMessage, ServerResponse } from 'http';
|
||
import { MiddlewareOptions, ClientOptions } from 'webpack-hot-middleware';
|
||
import { Options as Options$1 } from '@vitejs/plugin-vue';
|
||
import { MergeHead, Head } from '@unhead/schema';
|
||
import * as untyped from 'untyped';
|
||
|
||
/**
|
||
* Reference: https://github.com/vitejs/vite/blob/main/packages/vite/types/importMeta.d.ts
|
||
*/
|
||
interface ViteHot {
|
||
readonly data: any;
|
||
accept(): void;
|
||
accept(cb: (mod: any) => void): void;
|
||
accept(dep: string, cb: (mod: any) => void): void;
|
||
accept(deps: readonly string[], cb: (mods: any[]) => void): void;
|
||
dispose(cb: (data: any) => void): void;
|
||
decline(): void;
|
||
invalidate(): void;
|
||
on(event: any, cb: (payload: any) => void): void;
|
||
send(event: any, data?: any): void;
|
||
}
|
||
interface ViteGlobOptions {
|
||
as?: string;
|
||
eager?: boolean;
|
||
import?: string;
|
||
query?: string | Record<string, string | number | boolean>;
|
||
exhaustive?: boolean;
|
||
}
|
||
interface ViteImportMeta {
|
||
/** Vite client HMR API - see https://vitejs.dev/guide/api-hmr.html */
|
||
readonly hot?: ViteHot;
|
||
/** vite glob import utility - https://vitejs.dev/guide/features.html#glob-import */
|
||
glob(glob: string | string[], options?: ViteGlobOptions): Record<string, () => Promise<Record<string, any>>>;
|
||
}
|
||
|
||
/**
|
||
* Reference: https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/webpack-env/index.d.ts
|
||
*/
|
||
type WebpackModuleId = string | number;
|
||
interface HotNotifierInfo {
|
||
type: 'self-declined' | 'declined' | 'unaccepted' | 'accepted' | 'disposed' | 'accept-errored' | 'self-accept-errored' | 'self-accept-error-handler-errored';
|
||
/**
|
||
* The module in question.
|
||
*/
|
||
moduleId: number;
|
||
/**
|
||
* For errors: the module id owning the accept handler.
|
||
*/
|
||
dependencyId?: number | undefined;
|
||
/**
|
||
* For declined/accepted/unaccepted: the chain from where the update was propagated.
|
||
*/
|
||
chain?: number[] | undefined;
|
||
/**
|
||
* For declined: the module id of the declining parent
|
||
*/
|
||
parentId?: number | undefined;
|
||
/**
|
||
* For accepted: the modules that are outdated and will be disposed
|
||
*/
|
||
outdatedModules?: number[] | undefined;
|
||
/**
|
||
* For accepted: The location of accept handlers that will handle the update
|
||
*/
|
||
outdatedDependencies?: {
|
||
[dependencyId: number]: number[];
|
||
} | undefined;
|
||
/**
|
||
* For errors: the thrown error
|
||
*/
|
||
error?: Error | undefined;
|
||
/**
|
||
* For self-accept-error-handler-errored: the error thrown by the module
|
||
* before the error handler tried to handle it.
|
||
*/
|
||
originalError?: Error | undefined;
|
||
}
|
||
interface AcceptOptions {
|
||
/**
|
||
* If true the update process continues even if some modules are not accepted (and would bubble to the entry point).
|
||
*/
|
||
ignoreUnaccepted?: boolean | undefined;
|
||
/**
|
||
* Ignore changes made to declined modules.
|
||
*/
|
||
ignoreDeclined?: boolean | undefined;
|
||
/**
|
||
* Ignore errors throw in accept handlers, error handlers and while reevaluating module.
|
||
*/
|
||
ignoreErrored?: boolean | undefined;
|
||
/**
|
||
* Notifier for declined modules.
|
||
*/
|
||
onDeclined?: ((info: HotNotifierInfo) => void) | undefined;
|
||
/**
|
||
* Notifier for unaccepted modules.
|
||
*/
|
||
onUnaccepted?: ((info: HotNotifierInfo) => void) | undefined;
|
||
/**
|
||
* Notifier for accepted modules.
|
||
*/
|
||
onAccepted?: ((info: HotNotifierInfo) => void) | undefined;
|
||
/**
|
||
* Notifier for disposed modules.
|
||
*/
|
||
onDisposed?: ((info: HotNotifierInfo) => void) | undefined;
|
||
/**
|
||
* Notifier for errors.
|
||
*/
|
||
onErrored?: ((info: HotNotifierInfo) => void) | undefined;
|
||
/**
|
||
* Indicates that apply() is automatically called by check function
|
||
*/
|
||
autoApply?: boolean | undefined;
|
||
}
|
||
interface WebpackHot {
|
||
/**
|
||
* Accept code updates for the specified dependencies. The callback is called when dependencies were replaced.
|
||
*
|
||
* @param dependencies
|
||
* @param callback
|
||
* @param errorHandler
|
||
*/
|
||
accept(dependencies: string[], callback?: (updatedDependencies: WebpackModuleId[]) => void, errorHandler?: (err: Error) => void): void;
|
||
/**
|
||
* Accept code updates for the specified dependencies. The callback is called when dependencies were replaced.
|
||
*
|
||
* @param dependency
|
||
* @param callback
|
||
* @param errorHandler
|
||
*/
|
||
accept(dependency: string, callback?: () => void, errorHandler?: (err: Error) => void): void;
|
||
/**
|
||
* Accept code updates for this module without notification of parents.
|
||
* This should only be used if the module doesn’t export anything.
|
||
* The errHandler can be used to handle errors that occur while loading the updated module.
|
||
*
|
||
* @param errHandler
|
||
*/
|
||
accept(errHandler?: (err: Error) => void): void;
|
||
/**
|
||
* Do not accept updates for the specified dependencies. If any dependencies is updated, the code update fails with code "decline".
|
||
*/
|
||
decline(dependencies: string[]): void;
|
||
/**
|
||
* Do not accept updates for the specified dependencies. If any dependencies is updated, the code update fails with code "decline".
|
||
*/
|
||
decline(dependency: string): void;
|
||
/**
|
||
* Flag the current module as not update-able. If updated the update code would fail with code "decline".
|
||
*/
|
||
decline(): void;
|
||
/**
|
||
* Add a one time handler, which is executed when the current module code is replaced.
|
||
* Here you should destroy/remove any persistent resource you have claimed/created.
|
||
* If you want to transfer state to the new module, add it to data object.
|
||
* The data will be available at module.hot.data on the new module.
|
||
*
|
||
* @param callback
|
||
*/
|
||
dispose(callback: (data: any) => void): void;
|
||
dispose(callback: <T>(data: T) => void): void;
|
||
/**
|
||
* Add a one time handler, which is executed when the current module code is replaced.
|
||
* Here you should destroy/remove any persistent resource you have claimed/created.
|
||
* If you want to transfer state to the new module, add it to data object.
|
||
* The data will be available at module.hot.data on the new module.
|
||
*
|
||
* @param callback
|
||
*/
|
||
addDisposeHandler(callback: (data: any) => void): void;
|
||
addDisposeHandler<T>(callback: (data: T) => void): void;
|
||
/**
|
||
* Remove a handler.
|
||
* This can useful to add a temporary dispose handler. You could i. e. replace code while in the middle of a multi-step async function.
|
||
*
|
||
* @param callback
|
||
*/
|
||
removeDisposeHandler(callback: (data: any) => void): void;
|
||
removeDisposeHandler<T>(callback: (data: T) => void): void;
|
||
/**
|
||
* Throws an exceptions if status() is not idle.
|
||
* Check all currently loaded modules for updates and apply updates if found.
|
||
* If no update was found, the callback is called with null.
|
||
* If autoApply is truthy the callback will be called with all modules that were disposed.
|
||
* apply() is automatically called with autoApply as options parameter.
|
||
* If autoApply is not set the callback will be called with all modules that will be disposed on apply().
|
||
*
|
||
* @param autoApply
|
||
* @param callback
|
||
*/
|
||
check(autoApply: boolean, callback: (err: Error, outdatedModules: WebpackModuleId[]) => void): void;
|
||
/**
|
||
* Throws an exceptions if status() is not idle.
|
||
* Check all currently loaded modules for updates and apply updates if found.
|
||
* If no update was found, the callback is called with null.
|
||
* The callback will be called with all modules that will be disposed on apply().
|
||
*
|
||
* @param callback
|
||
*/
|
||
check(callback: (err: Error, outdatedModules: WebpackModuleId[]) => void): void;
|
||
/**
|
||
* If status() != "ready" it throws an error.
|
||
* Continue the update process.
|
||
*
|
||
* @param options
|
||
* @param callback
|
||
*/
|
||
apply(options: AcceptOptions, callback: (err: Error, outdatedModules: WebpackModuleId[]) => void): void;
|
||
/**
|
||
* If status() != "ready" it throws an error.
|
||
* Continue the update process.
|
||
*
|
||
* @param callback
|
||
*/
|
||
apply(callback: (err: Error, outdatedModules: WebpackModuleId[]) => void): void;
|
||
/**
|
||
* Return one of idle, check, watch, watch-delay, prepare, ready, dispose, apply, abort or fail.
|
||
*/
|
||
status(): string;
|
||
/** Register a callback on status change. */
|
||
status(callback: (status: string) => void): void;
|
||
/** Register a callback on status change. */
|
||
addStatusHandler(callback: (status: string) => void): void;
|
||
/**
|
||
* Remove a registered status change handler.
|
||
*
|
||
* @param callback
|
||
*/
|
||
removeStatusHandler(callback: (status: string) => void): void;
|
||
active: boolean;
|
||
data: any;
|
||
}
|
||
interface WebpackImportMeta {
|
||
/** an alias for `module.hot` - see https://webpack.js.org/api/hot-module-replacement/ */
|
||
webpackHot?: WebpackHot | undefined;
|
||
/** the webpack major version as number */
|
||
webpack?: number;
|
||
}
|
||
|
||
type BundlerImportMeta = ViteImportMeta & WebpackImportMeta;
|
||
declare global {
|
||
interface ImportMeta extends BundlerImportMeta {
|
||
/** the `file:` url of the current file (similar to `__filename` but as file url) */
|
||
url: string;
|
||
readonly env: Record<string, string | boolean | undefined>;
|
||
}
|
||
}
|
||
|
||
interface NuxtCompatibility {
|
||
/**
|
||
* Required nuxt version in semver format.
|
||
*
|
||
* @example `^2.14.0` or `>=3.0.0-27219851.6e49637`.
|
||
*
|
||
*/
|
||
nuxt?: string;
|
||
/**
|
||
* Bridge constraint for Nuxt 2 support.
|
||
*
|
||
* - `true`: When using Nuxt 2, using bridge module is required.
|
||
* - `false`: When using Nuxt 2, using bridge module is not supported.
|
||
*/
|
||
bridge?: boolean;
|
||
}
|
||
interface NuxtCompatibilityIssue {
|
||
name: string;
|
||
message: string;
|
||
}
|
||
interface NuxtCompatibilityIssues extends Array<NuxtCompatibilityIssue> {
|
||
/**
|
||
* Return formatted error message.
|
||
*/
|
||
toString(): string;
|
||
}
|
||
|
||
interface Component {
|
||
pascalName: string;
|
||
kebabName: string;
|
||
export: string;
|
||
filePath: string;
|
||
shortPath: string;
|
||
chunkName: string;
|
||
prefetch: boolean;
|
||
preload: boolean;
|
||
global?: boolean;
|
||
mode?: 'client' | 'server' | 'all';
|
||
}
|
||
interface ScanDir {
|
||
/**
|
||
* Path (absolute or relative) to the directory containing your components.
|
||
* You can use Nuxt aliases (~ or @) to refer to directories inside project or directly use an npm package path similar to require.
|
||
*/
|
||
path: string;
|
||
/**
|
||
* Accept Pattern that will be run against specified path.
|
||
*/
|
||
pattern?: string | string[];
|
||
/**
|
||
* Ignore patterns that will be run against specified path.
|
||
*/
|
||
ignore?: string[];
|
||
/**
|
||
* Prefix all matched components.
|
||
*/
|
||
prefix?: string;
|
||
/**
|
||
* Prefix component name by its path.
|
||
*/
|
||
pathPrefix?: boolean;
|
||
/**
|
||
* Ignore scanning this directory if set to `true`
|
||
*/
|
||
enabled?: boolean;
|
||
/**
|
||
* These properties (prefetch/preload) are used in production to configure how components with Lazy prefix are handled by Webpack via its magic comments.
|
||
* Learn more on Webpack documentation: https://webpack.js.org/api/module-methods/#magic-comments
|
||
*/
|
||
prefetch?: boolean;
|
||
/**
|
||
* These properties (prefetch/preload) are used in production to configure how components with Lazy prefix are handled by Webpack via its magic comments.
|
||
* Learn more on Webpack documentation: https://webpack.js.org/api/module-methods/#magic-comments
|
||
*/
|
||
preload?: boolean;
|
||
/**
|
||
* This flag indicates, component should be loaded async (with a separate chunk) regardless of using Lazy prefix or not.
|
||
*/
|
||
isAsync?: boolean;
|
||
extendComponent?: (component: Component) => Promise<Component | void> | (Component | void);
|
||
/**
|
||
* If enabled, registers components to be globally available.
|
||
*
|
||
*/
|
||
global?: boolean;
|
||
}
|
||
interface ComponentsDir extends ScanDir {
|
||
/**
|
||
* Watch specified path for changes, including file additions and file deletions.
|
||
*/
|
||
watch?: boolean;
|
||
/**
|
||
* Extensions supported by Nuxt builder.
|
||
*/
|
||
extensions?: string[];
|
||
/**
|
||
* Transpile specified path using build.transpile.
|
||
* By default ('auto') it will set transpile: true if node_modules/ is in path.
|
||
*/
|
||
transpile?: 'auto' | boolean;
|
||
}
|
||
interface ComponentsOptions {
|
||
dirs: (string | ComponentsDir)[];
|
||
/**
|
||
* The default value for whether to globally register components.
|
||
*
|
||
* When components are registered globally, they will still be directly imported where used,
|
||
* but they can also be used dynamically, for example `<component :is="`icon-${myIcon}`">`.
|
||
*
|
||
* This can be overridden by an individual component directory entry.
|
||
*
|
||
* @default false
|
||
*/
|
||
global?: boolean;
|
||
loader?: boolean;
|
||
transform?: {
|
||
exclude?: RegExp[];
|
||
include?: RegExp[];
|
||
};
|
||
}
|
||
|
||
type RouterOptions = Partial<Omit<RouterOptions$1, 'history' | 'routes'>> & {
|
||
history?: (baseURL?: string) => RouterHistory;
|
||
routes?: (_routes: RouterOptions$1['routes']) => RouterOptions$1['routes'];
|
||
hashMode?: boolean;
|
||
};
|
||
type RouterConfig = RouterOptions;
|
||
/**
|
||
* Only JSON serializable router options are configurable from nuxt config
|
||
*/
|
||
type RouterConfigSerializable = Pick<RouterConfig, 'linkActiveClass' | 'linkExactActiveClass' | 'end' | 'sensitive' | 'strict' | 'hashMode'>;
|
||
|
||
interface ImportsOptions extends UnimportOptions {
|
||
/**
|
||
* Enable implicit auto import from Vue, Nuxt and module contributed utilities.
|
||
* Generate global TypeScript definitions.
|
||
*
|
||
* @default true
|
||
*/
|
||
autoImport?: boolean;
|
||
/**
|
||
* Directories to scan for auto imports.
|
||
*
|
||
* @see https://v3.nuxtjs.org/guide/directory-structure/composables/#how-files-are-scanned
|
||
* @default ['./composables', './utils']
|
||
*/
|
||
dirs?: string[];
|
||
/**
|
||
* Assign auto imported utilities to `globalThis` instead of using built time transformation.
|
||
*
|
||
* @default false
|
||
*/
|
||
global?: boolean;
|
||
transform?: {
|
||
exclude?: RegExp[];
|
||
include?: RegExp[];
|
||
};
|
||
}
|
||
|
||
type HookResult = Promise<void> | void;
|
||
type TSReference = {
|
||
types: string;
|
||
} | {
|
||
path: string;
|
||
};
|
||
type WatchEvent = 'add' | 'addDir' | 'change' | 'unlink' | 'unlinkDir';
|
||
type NuxtPage = {
|
||
name?: string;
|
||
path: string;
|
||
file: string;
|
||
meta?: Record<string, any>;
|
||
alias?: string[] | string;
|
||
redirect?: string;
|
||
children?: NuxtPage[];
|
||
};
|
||
type NuxtMiddleware = {
|
||
name: string;
|
||
path: string;
|
||
global?: boolean;
|
||
};
|
||
type NuxtLayout = {
|
||
name: string;
|
||
file: string;
|
||
};
|
||
interface ImportPresetWithDeprecation extends InlinePreset {
|
||
}
|
||
interface GenerateAppOptions {
|
||
filter?: (template: ResolvedNuxtTemplate<any>) => boolean;
|
||
}
|
||
interface NuxtHooks {
|
||
'kit:compatibility': (compatibility: NuxtCompatibility, issues: NuxtCompatibilityIssues) => HookResult;
|
||
'ready': (nuxt: Nuxt) => HookResult;
|
||
'close': (nuxt: Nuxt) => HookResult;
|
||
'modules:before': () => HookResult;
|
||
'modules:done': () => HookResult;
|
||
'app:resolve': (app: NuxtApp) => HookResult;
|
||
'app:templates': (app: NuxtApp) => HookResult;
|
||
'app:templatesGenerated': (app: NuxtApp) => HookResult;
|
||
'build:before': () => HookResult;
|
||
'build:done': () => HookResult;
|
||
'build:manifest': (manifest: Manifest) => HookResult;
|
||
'builder:generateApp': (options?: GenerateAppOptions) => HookResult;
|
||
'builder:watch': (event: WatchEvent, path: string) => HookResult;
|
||
'pages:extend': (pages: NuxtPage[]) => HookResult;
|
||
'server:devHandler': (handler: EventHandler) => HookResult;
|
||
'imports:sources': (presets: ImportPresetWithDeprecation[]) => HookResult;
|
||
'imports:extend': (imports: Import[]) => HookResult;
|
||
'imports:dirs': (dirs: string[]) => HookResult;
|
||
'components:dirs': (dirs: ComponentsOptions['dirs']) => HookResult;
|
||
'components:extend': (components: Component[]) => HookResult;
|
||
'nitro:config': (nitroConfig: NitroConfig) => HookResult;
|
||
'nitro:init': (nitro: Nitro) => HookResult;
|
||
'nitro:build:before': (nitro: Nitro) => HookResult;
|
||
'prerender:routes': (ctx: {
|
||
routes: Set<string>;
|
||
}) => HookResult;
|
||
'build:error': (error: Error) => HookResult;
|
||
'prepare:types': (options: {
|
||
references: TSReference[];
|
||
declarations: string[];
|
||
tsConfig: TSConfig;
|
||
}) => HookResult;
|
||
'listen': (listenerServer: Server | Server$1, listener: any) => HookResult;
|
||
'vite:extend': (viteBuildContext: {
|
||
nuxt: Nuxt;
|
||
config: InlineConfig;
|
||
}) => HookResult;
|
||
'vite:extendConfig': (viteInlineConfig: InlineConfig, env: {
|
||
isClient: boolean;
|
||
isServer: boolean;
|
||
}) => HookResult;
|
||
'vite:serverCreated': (viteServer: ViteDevServer, env: {
|
||
isClient: boolean;
|
||
isServer: boolean;
|
||
}) => HookResult;
|
||
'vite:compiled': () => HookResult;
|
||
'webpack:config': (webpackConfigs: Configuration[]) => HookResult;
|
||
'webpack:compile': (options: {
|
||
name: string;
|
||
compiler: Compiler;
|
||
}) => HookResult;
|
||
'webpack:compiled': (options: {
|
||
name: string;
|
||
compiler: Compiler;
|
||
stats: Stats;
|
||
}) => HookResult;
|
||
'webpack:change': (shortPath: string) => void;
|
||
'webpack:error': () => void;
|
||
'webpack:done': () => void;
|
||
'webpack:progress': (statesArray: any[]) => void;
|
||
}
|
||
type NuxtHookName = keyof NuxtHooks;
|
||
|
||
interface Nuxt {
|
||
_version: string;
|
||
_ignore?: Ignore;
|
||
/** The resolved Nuxt configuration. */
|
||
options: NuxtOptions;
|
||
hooks: Hookable<NuxtHooks>;
|
||
hook: Nuxt['hooks']['hook'];
|
||
callHook: Nuxt['hooks']['callHook'];
|
||
addHooks: Nuxt['hooks']['addHooks'];
|
||
ready: () => Promise<void>;
|
||
close: () => Promise<void>;
|
||
/** The production or development server. */
|
||
server?: any;
|
||
vfs: Record<string, string>;
|
||
}
|
||
interface NuxtTemplate<Options = Record<string, any>> {
|
||
/** resolved output file path (generated) */
|
||
dst?: string;
|
||
/** The target filename once the template is copied into the Nuxt buildDir */
|
||
filename?: string;
|
||
/** An options object that will be accessible within the template via `<% options %>` */
|
||
options?: Options;
|
||
/** The resolved path to the source file to be template */
|
||
src?: string;
|
||
/** Provided compile option instead of src */
|
||
getContents?: (data: Options) => string | Promise<string>;
|
||
/** Write to filesystem */
|
||
write?: boolean;
|
||
}
|
||
interface ResolvedNuxtTemplate<Options = Record<string, any>> extends NuxtTemplate<Options> {
|
||
filename: string;
|
||
dst: string;
|
||
}
|
||
interface NuxtPlugin {
|
||
/** @deprecated use mode */
|
||
ssr?: boolean;
|
||
src: string;
|
||
mode?: 'all' | 'server' | 'client';
|
||
}
|
||
interface NuxtApp {
|
||
mainComponent?: string | null;
|
||
rootComponent?: string | null;
|
||
errorComponent?: string | null;
|
||
dir: string;
|
||
extensions: string[];
|
||
plugins: NuxtPlugin[];
|
||
layouts: Record<string, NuxtLayout>;
|
||
middleware: NuxtMiddleware[];
|
||
templates: NuxtTemplate[];
|
||
configs: string[];
|
||
}
|
||
type _TemplatePlugin<Options> = Omit<NuxtPlugin, 'src'> & NuxtTemplate<Options>;
|
||
interface NuxtPluginTemplate<Options = Record<string, any>> extends _TemplatePlugin<Options> {
|
||
}
|
||
|
||
interface ModuleMeta {
|
||
/** Module name. */
|
||
name?: string;
|
||
/** Module version. */
|
||
version?: string;
|
||
/**
|
||
* The configuration key used within `nuxt.config` for this module's options.
|
||
* For example, `@nuxtjs/axios` uses `axios`.
|
||
*/
|
||
configKey?: string;
|
||
/**
|
||
* Constraints for the versions of Nuxt or features this module requires.
|
||
*/
|
||
compatibility?: NuxtCompatibility;
|
||
[key: string]: any;
|
||
}
|
||
/** The options received. */
|
||
type ModuleOptions = Record<string, any>;
|
||
/** Input module passed to defineNuxtModule. */
|
||
interface ModuleDefinition<T extends ModuleOptions = ModuleOptions> {
|
||
meta?: ModuleMeta;
|
||
defaults?: T | ((nuxt: Nuxt) => T);
|
||
schema?: T;
|
||
hooks?: Partial<NuxtHooks>;
|
||
setup?: (this: void, resolvedOptions: T, nuxt: Nuxt) => void | Promise<void>;
|
||
}
|
||
/** Nuxt modules are always a simple function. */
|
||
interface NuxtModule<T extends ModuleOptions = ModuleOptions> {
|
||
(this: void, inlineOptions: T, nuxt: Nuxt): void | Promise<void>;
|
||
getOptions?: (inlineOptions?: T, nuxt?: Nuxt) => Promise<T>;
|
||
getMeta?: () => Promise<ModuleMeta>;
|
||
}
|
||
|
||
interface ConfigSchema {
|
||
/**
|
||
* Configure Nuxt component auto-registration.
|
||
* Any components in the directories configured here can be used throughout your pages, layouts (and other components) without needing to explicitly import them.
|
||
*
|
||
* @default {{ dirs: [`~/components`] }}
|
||
*
|
||
* @see https://v3.nuxtjs.org/guide/directory-structure/components
|
||
*/
|
||
components: boolean | ComponentsOptions | ComponentsOptions['dirs'],
|
||
|
||
/**
|
||
* Configure how Nuxt auto-imports composables into your application.
|
||
*
|
||
* @see [Nuxt 3 documentation](https://v3.nuxtjs.org/guide/directory-structure/composables)
|
||
*/
|
||
imports: ImportsOptions,
|
||
|
||
/** Whether to use the vue-router integration in Nuxt 3. If you do not provide a value it will be enabled if you have a `pages/` directory in your source folder. */
|
||
pages: boolean,
|
||
|
||
/**
|
||
* Manually disable nuxt telemetry.
|
||
*
|
||
* @see [Nuxt Telemetry](https://github.com/nuxt/telemetry) for more information.
|
||
*/
|
||
telemetry: boolean,
|
||
|
||
/** Vue.js config */
|
||
vue: {
|
||
/**
|
||
* Options for the Vue compiler that will be passed at build time.
|
||
*
|
||
* @see [documentation](https://vuejs.org/api/application.html#app-config-compileroptions)
|
||
*/
|
||
compilerOptions: CompilerOptions,
|
||
},
|
||
|
||
/** Nuxt App configuration. */
|
||
app: {
|
||
/**
|
||
* The base path of your Nuxt application.
|
||
* This can be set at runtime by setting the NUXT_APP_BASE_URL environment variable.
|
||
* @default "/"
|
||
*
|
||
* @example
|
||
* ```bash
|
||
* NUXT_APP_BASE_URL=/prefix/ node .output/server/index.mjs
|
||
* ```
|
||
*/
|
||
baseURL: string,
|
||
|
||
/**
|
||
* The folder name for the built site assets, relative to `baseURL` (or `cdnURL` if set). This is set at build time and should not be customized at runtime.
|
||
* @default "/_nuxt/"
|
||
*/
|
||
buildAssetsDir: string,
|
||
|
||
/**
|
||
* An absolute URL to serve the public folder from (production-only).
|
||
* This can be set to a different value at runtime by setting the `NUXT_APP_CDN_URL` environment variable.
|
||
* @default ""
|
||
*
|
||
* @example
|
||
* ```bash
|
||
* NUXT_APP_CDN_URL=https://mycdn.org/ node .output/server/index.mjs
|
||
* ```
|
||
*/
|
||
cdnURL: string,
|
||
|
||
/**
|
||
* Set default configuration for `<head>` on every page.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* 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://myawesome-lib.js"></script>
|
||
* { src: 'https://awesome-lib.js' }
|
||
* ],
|
||
* link: [
|
||
* // <link rel="stylesheet" href="https://myawesome-lib.css">
|
||
* { rel: 'stylesheet', href: 'https://awesome-lib.css' }
|
||
* ],
|
||
* // please note that this is an area that is likely to change
|
||
* 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' }
|
||
* ]
|
||
* }
|
||
* }
|
||
* ```
|
||
*/
|
||
head: NuxtAppConfig['head'],
|
||
|
||
/**
|
||
* Default values for layout transitions.
|
||
* This can be overridden with `definePageMeta` on an individual page. Only JSON-serializable values are allowed.
|
||
* @default false
|
||
*
|
||
* @see https://vuejs.org/api/built-in-components.html#transition
|
||
*/
|
||
layoutTransition: NuxtAppConfig['layoutTransition'],
|
||
|
||
/**
|
||
* Default values for page transitions.
|
||
* This can be overridden with `definePageMeta` on an individual page. Only JSON-serializable values are allowed.
|
||
* @default false
|
||
*
|
||
* @see https://vuejs.org/api/built-in-components.html#transition
|
||
*/
|
||
pageTransition: NuxtAppConfig['pageTransition'],
|
||
|
||
/**
|
||
* Default values for KeepAlive configuration between pages.
|
||
* This can be overridden with `definePageMeta` on an individual page. Only JSON-serializable values are allowed.
|
||
* @default false
|
||
*
|
||
* @see https://vuejs.org/api/built-in-components.html#keepalive
|
||
*/
|
||
keepalive: NuxtAppConfig['keepalive'],
|
||
|
||
/**
|
||
* Customize Nuxt root element id.
|
||
* @default "__nuxt"
|
||
*/
|
||
rootId: string,
|
||
|
||
/**
|
||
* Customize Nuxt root element tag.
|
||
* @default "div"
|
||
*/
|
||
rootTag: string,
|
||
},
|
||
|
||
/**
|
||
* An array of nuxt app plugins.
|
||
* Each plugin can be a string (which can be an absolute or relative path to a file). If it ends with `.client` or `.server` then it will be automatically loaded only in the appropriate context.
|
||
* It can also be an object with `src` and `mode` keys.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* plugins: [
|
||
* '~/plugins/foo.client.js', // only in client side
|
||
* '~/plugins/bar.server.js', // only in server side
|
||
* '~/plugins/baz.js', // both client & server
|
||
* { src: '~/plugins/both-sides.js' },
|
||
* { src: '~/plugins/client-only.js', mode: 'client' }, // only on client side
|
||
* { src: '~/plugins/server-only.js', mode: 'server' } // only on server side
|
||
* ]
|
||
* ```
|
||
*/
|
||
plugins: (NuxtPlugin | string)[],
|
||
|
||
/**
|
||
* You can define the CSS files/modules/libraries you want to set globally (included in every page).
|
||
* Nuxt will automatically guess the file type by its extension and use the appropriate pre-processor. You will still need to install the required loader if you need to use them.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* css: [
|
||
* // Load a Node.js module directly (here it's a Sass file).
|
||
* 'bulma',
|
||
* // CSS file in the project
|
||
* '@/assets/css/main.css',
|
||
* // SCSS file in the project
|
||
* '@/assets/css/main.scss'
|
||
* ]
|
||
* ```
|
||
*/
|
||
css: string[],
|
||
|
||
/**
|
||
* The builder to use for bundling the Vue part of your application.
|
||
* @default "@nuxt/vite-builder"
|
||
*/
|
||
builder: 'vite' | 'webpack' | { bundle: (nuxt: Nuxt) => Promise<void> },
|
||
|
||
/** Whether to generate sourcemaps. */
|
||
sourcemap: boolean | { server?: boolean, client?: boolean },
|
||
|
||
/** Shared build configuration. */
|
||
build: {
|
||
/**
|
||
* If you want to transpile specific dependencies with Babel, you can add them here. Each item in transpile can be a package name, a function, a string or regex object matching the dependency's file name.
|
||
* You can also use a function to conditionally transpile. The function will receive an object ({ isDev, isServer, isClient, isModern, isLegacy }).
|
||
*
|
||
* @example
|
||
* ```js
|
||
* transpile: [({ isLegacy }) => isLegacy && 'ky']
|
||
* ```
|
||
*/
|
||
transpile: Array<string | RegExp | Function>,
|
||
|
||
/**
|
||
* You can provide your own templates which will be rendered based on Nuxt configuration. This feature is specially useful for using with modules.
|
||
* Templates are rendered using [`lodash.template`](https://lodash.com/docs/4.17.15#template).
|
||
*
|
||
* @example
|
||
* ```js
|
||
* templates: [
|
||
* {
|
||
* src: '~/modules/support/plugin.js', // `src` can be absolute or relative
|
||
* dst: 'support.js', // `dst` is relative to project `.nuxt` dir
|
||
* options: {
|
||
* // Options are provided to template as `options` key
|
||
* live_chat: false
|
||
* }
|
||
* }
|
||
* ]
|
||
* ```
|
||
*/
|
||
templates: Array<any>,
|
||
|
||
/**
|
||
* Nuxt uses `webpack-bundle-analyzer` to visualize your bundles and how to optimize them.
|
||
* Set to `true` to enable bundle analysis, or pass an object with options: [for webpack](https://github.com/webpack-contrib/webpack-bundle-analyzer#options-for-plugin) or [for vite](https://github.com/btd/rollup-plugin-visualizer#options).
|
||
* @default false
|
||
*
|
||
* @example
|
||
* ```js
|
||
* analyze: {
|
||
* analyzerMode: 'static'
|
||
* }
|
||
* ```
|
||
*/
|
||
analyze: boolean | BundleAnalyzerPlugin.Options | PluginVisualizerOptions,
|
||
},
|
||
|
||
/**
|
||
* Extend project from multiple local or remote sources.
|
||
* Value should be either a string or array of strings pointing to source directories or config path relative to current config.
|
||
* You can use `github:`, `gitlab:`, `bitbucket:` or `https://` to extend from a remote git repository.
|
||
*/
|
||
extends: string|string[],
|
||
|
||
/**
|
||
* Extend project from a local or remote source.
|
||
* Value should be a string pointing to source directory or config path relative to current config.
|
||
* You can use `github:`, `gitlab:`, `bitbucket:` or `https://` to extend from a remote git repository.
|
||
* @default null
|
||
*/
|
||
theme: string,
|
||
|
||
/**
|
||
* Define the root directory of your application.
|
||
* This property can be overwritten (for example, running `nuxt ./my-app/` will set the `rootDir` to the absolute path of `./my-app/` from the current/working directory.
|
||
* It is normally not needed to configure this option.
|
||
* @default "/<rootDir>"
|
||
*/
|
||
rootDir: string,
|
||
|
||
/**
|
||
* Define the workspace directory of your application.
|
||
* Often this is used when in a monorepo setup. Nuxt will attempt to detect your workspace directory automatically, but you can override it here.
|
||
* It is normally not needed to configure this option.
|
||
* @default "/<rootDir>"
|
||
*/
|
||
workspaceDir: string,
|
||
|
||
/**
|
||
* Define the source directory of your Nuxt application.
|
||
* If a relative path is specified, it will be relative to the `rootDir`.
|
||
* @default "/<rootDir>"
|
||
*
|
||
* @example
|
||
* ```js
|
||
* export default {
|
||
* srcDir: 'src/'
|
||
* }
|
||
* ```
|
||
* This would work with the following folder structure:
|
||
* ```bash
|
||
* -| app/
|
||
* ---| node_modules/
|
||
* ---| nuxt.config.js
|
||
* ---| package.json
|
||
* ---| src/
|
||
* ------| assets/
|
||
* ------| components/
|
||
* ------| layouts/
|
||
* ------| middleware/
|
||
* ------| pages/
|
||
* ------| plugins/
|
||
* ------| static/
|
||
* ------| store/
|
||
* ------| server/
|
||
* ```
|
||
*/
|
||
srcDir: string,
|
||
|
||
/**
|
||
* Define the server directory of your Nuxt application, where Nitro routes, middleware and plugins are kept.
|
||
* If a relative path is specified, it will be relative to your `rootDir`.
|
||
* @default "/<rootDir>/server"
|
||
*/
|
||
serverDir: string,
|
||
|
||
/**
|
||
* Define the directory where your built Nuxt files will be placed.
|
||
* Many tools assume that `.nuxt` is a hidden directory (because it starts with a `.`). If that is a problem, you can use this option to prevent that.
|
||
* @default "/<rootDir>/.nuxt"
|
||
*
|
||
* @example
|
||
* ```js
|
||
* export default {
|
||
* buildDir: 'nuxt-build'
|
||
* }
|
||
* ```
|
||
*/
|
||
buildDir: string,
|
||
|
||
/**
|
||
* Used to set the modules directories for path resolving (for example, webpack's `resolveLoading`, `nodeExternals` and `postcss`).
|
||
* The configuration path is relative to `options.rootDir` (default is current working directory).
|
||
* Setting this field may be necessary if your project is organized as a yarn workspace-styled mono-repository.
|
||
* @default ["/<rootDir>/node_modules","/Users/pooya/Code/framework/packages/schema/node_modules"]
|
||
*
|
||
* @example
|
||
* ```js
|
||
* export default {
|
||
* modulesDir: ['../../node_modules']
|
||
* }
|
||
* ```
|
||
*/
|
||
modulesDir: Array<string>,
|
||
|
||
/**
|
||
* Whether Nuxt is running in development mode.
|
||
* Normally, you should not need to set this.
|
||
* @default false
|
||
*/
|
||
dev: boolean,
|
||
|
||
/**
|
||
* Whether your app is being unit tested.
|
||
* @default false
|
||
*/
|
||
test: boolean,
|
||
|
||
/**
|
||
* Set to `true` to enable debug mode.
|
||
* At the moment, it prints out hook names and timings on the server, and logs hook arguments as well in the browser.
|
||
* @default false
|
||
*/
|
||
debug: boolean,
|
||
|
||
/**
|
||
* Whether to enable rendering of HTML - either dynamically (in server mode) or at generate time. If set to `false` and combined with `static` target, generated pages will simply display a loading screen with no content.
|
||
* @default true
|
||
*/
|
||
ssr: boolean,
|
||
|
||
/**
|
||
* Modules are Nuxt extensions which can extend its core functionality and add endless integrations.
|
||
* Each module is either a string (which can refer to a package, or be a path to a file), a tuple with the module as first string and the options as a second object, or an inline module function.
|
||
* Nuxt tries to resolve each item in the modules array using node require path (in `node_modules`) and then will be resolved from project `srcDir` if `~` alias is used.
|
||
*
|
||
* @note Modules are executed sequentially so the order is important.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* modules: [
|
||
* // Using package name
|
||
* '@nuxtjs/axios',
|
||
* // Relative to your project srcDir
|
||
* '~/modules/awesome.js',
|
||
* // Providing options
|
||
* ['@nuxtjs/google-analytics', { ua: 'X1234567' }],
|
||
* // Inline definition
|
||
* function () {}
|
||
* ]
|
||
* ```
|
||
*/
|
||
modules: (NuxtModule | string | [NuxtModule | string, Record<string, any>])[],
|
||
|
||
/**
|
||
* Customize default directory structure used by Nuxt.
|
||
* It is better to stick with defaults unless needed.
|
||
*/
|
||
dir: {
|
||
/**
|
||
* The assets directory (aliased as `~assets` in your build).
|
||
* @default "assets"
|
||
*/
|
||
assets: string,
|
||
|
||
/**
|
||
* The layouts directory, each file of which will be auto-registered as a Nuxt layout.
|
||
* @default "layouts"
|
||
*/
|
||
layouts: string,
|
||
|
||
/**
|
||
* The middleware directory, each file of which will be auto-registered as a Nuxt middleware.
|
||
* @default "middleware"
|
||
*/
|
||
middleware: string,
|
||
|
||
/**
|
||
* The directory which will be processed to auto-generate your application page routes.
|
||
* @default "pages"
|
||
*/
|
||
pages: string,
|
||
|
||
/**
|
||
* The plugins directory, each file of which will be auto-registered as a Nuxt plugin.
|
||
* @default "plugins"
|
||
*/
|
||
plugins: string,
|
||
|
||
/**
|
||
* The directory containing your static files, which will be directly accessible via the Nuxt server and copied across into your `dist` folder when your app is generated.
|
||
* @default "public"
|
||
*/
|
||
public: string,
|
||
|
||
/**
|
||
* @default "public"
|
||
*
|
||
* @deprecated use `dir.public` option instead
|
||
*/
|
||
static: string,
|
||
},
|
||
|
||
/**
|
||
* The extensions that should be resolved by the Nuxt resolver.
|
||
* @default [".js",".jsx",".mjs",".ts",".tsx",".vue"]
|
||
*/
|
||
extensions: Array<string>,
|
||
|
||
/**
|
||
* You can improve your DX by defining additional aliases to access custom directories within your JavaScript and CSS.
|
||
*
|
||
* @note Within a webpack context (image sources, CSS - but not JavaScript) you _must_ access
|
||
* your alias by prefixing it with `~`.
|
||
*
|
||
* @note These aliases will be automatically added to the generated `.nuxt/tsconfig.json` so you can get full
|
||
* type support and path auto-complete. In case you need to extend options provided by `./.nuxt/tsconfig.json`
|
||
* further, make sure to add them here or within the `typescript.tsConfig` property in `nuxt.config`.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* export default {
|
||
* alias: {
|
||
* 'images': fileURLToPath(new URL('./assets/images', import.meta.url)),
|
||
* 'style': fileURLToPath(new URL('./assets/style', import.meta.url)),
|
||
* 'data': fileURLToPath(new URL('./assets/other/data', import.meta.url))
|
||
* }
|
||
* }
|
||
* ```
|
||
*
|
||
* ```html
|
||
* <template>
|
||
* <img src="~images/main-bg.jpg">
|
||
* </template>
|
||
*
|
||
* <script>
|
||
* import data from 'data/test.json'
|
||
* </script>
|
||
*
|
||
* <style>
|
||
* // Uncomment the below
|
||
* //@import '~style/variables.scss';
|
||
* //@import '~style/utils.scss';
|
||
* //@import '~style/base.scss';
|
||
* body {
|
||
* background-image: url('~images/main-bg.jpg');
|
||
* }
|
||
* </style>
|
||
* ```
|
||
*/
|
||
alias: Record<string, string>,
|
||
|
||
/**
|
||
* Pass options directly to `node-ignore` (which is used by Nuxt to ignore files).
|
||
*
|
||
* @see [node-ignore](https://github.com/kaelzhang/node-ignore)
|
||
*
|
||
* @example
|
||
* ```js
|
||
* ignoreOptions: {
|
||
* ignorecase: false
|
||
* }
|
||
* ```
|
||
*/
|
||
ignoreOptions: any,
|
||
|
||
/**
|
||
* Any file in `pages/`, `layouts/`, `middleware/` or `store/` will be ignored during building if its filename starts with the prefix specified by `ignorePrefix`.
|
||
* @default "-"
|
||
*/
|
||
ignorePrefix: string,
|
||
|
||
/**
|
||
* More customizable than `ignorePrefix`: all files matching glob patterns specified inside the `ignore` array will be ignored in building.
|
||
* @default ["**\/*.stories.{js,ts,jsx,tsx}","**\/*.{spec,test}.{js,ts,jsx,tsx}","**\/*.d.ts",".output","**\/-*.*"]
|
||
*/
|
||
ignore: Array<string>,
|
||
|
||
/** The watchers property lets you overwrite watchers configuration in your `nuxt.config`. */
|
||
watchers: {
|
||
/** An array of event types, which, when received, will cause the watcher to restart. */
|
||
rewatchOnRawEvents: any,
|
||
|
||
/**
|
||
* `watchOptions` to pass directly to webpack.
|
||
*
|
||
* @see [webpack@4 watch options](https://v4.webpack.js.org/configuration/watch/#watchoptions).
|
||
*/
|
||
webpack: {
|
||
/** @default 1000 */
|
||
aggregateTimeout: number,
|
||
},
|
||
|
||
/**
|
||
* Options to pass directly to `chokidar`.
|
||
*
|
||
* @see [chokidar](https://github.com/paulmillr/chokidar#api)
|
||
*/
|
||
chokidar: {
|
||
/** @default true */
|
||
ignoreInitial: boolean,
|
||
},
|
||
},
|
||
|
||
/**
|
||
* Hooks are listeners to Nuxt events that are typically used in modules, but are also available in `nuxt.config`.
|
||
* Internally, hooks follow a naming pattern using colons (e.g., build:done).
|
||
* For ease of configuration, you can also structure them as an hierarchical object in `nuxt.config` (as below).
|
||
*
|
||
* @example
|
||
* ```js'node:fs'
|
||
* import fs from 'node:fs'
|
||
* import path from 'node:path'
|
||
* export default {
|
||
* hooks: {
|
||
* build: {
|
||
* done(builder) {
|
||
* const extraFilePath = path.join(
|
||
* builder.nuxt.options.buildDir,
|
||
* 'extra-file'
|
||
* )
|
||
* fs.writeFileSync(extraFilePath, 'Something extra')
|
||
* }
|
||
* }
|
||
* }
|
||
* }
|
||
* ```
|
||
*/
|
||
hooks: NuxtHooks,
|
||
|
||
/**
|
||
* Runtime config allows passing dynamic config and environment variables to the Nuxt app context.
|
||
* The value of this object is accessible from server only using `useRuntimeConfig`.
|
||
* It mainly should hold _private_ configuration which is not exposed on the frontend. This could include a reference to your API secret tokens.
|
||
* Anything under `public` and `app` will be exposed to the frontend as well.
|
||
* Values are automatically replaced by matching env variables at runtime, e.g. setting an environment variable `NUXT_API_KEY=my-api-key NUXT_PUBLIC_BASE_URL=/foo/` would overwrite the two values in the example below.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* export default {
|
||
* runtimeConfig: {
|
||
* apiKey: '' // Default to an empty string, automatically set at runtime using process.env.NUXT_API_KEY
|
||
* public: {
|
||
* baseURL: '' // Exposed to the frontend as well.
|
||
* }
|
||
* }
|
||
* }
|
||
* ```
|
||
*/
|
||
runtimeConfig: RuntimeConfig,
|
||
|
||
/**
|
||
* Additional app configuration
|
||
* For programmatic usage and type support, you can directly provide app config with this option. It will be merged with `app.config` file as default value.
|
||
*/
|
||
appConfig: AppConfig,
|
||
|
||
devServer: {
|
||
/**
|
||
* Whether to enable HTTPS.
|
||
* @default false
|
||
*
|
||
* @example
|
||
* ```
|
||
* import { fileURLToPath } from 'node:url'
|
||
* export default {
|
||
* server: {
|
||
* https: {
|
||
* key: fs.readFileSync(fileURLToPath(new URL('./server.key', import.meta.url))),
|
||
* cert: fs.readFileSync(fileURLToPath(new URL('./server.crt', import.meta.url)))
|
||
* }
|
||
* }
|
||
* }
|
||
* ```
|
||
*/
|
||
https: false | { key: string; cert: string },
|
||
|
||
/**
|
||
* Dev server listening port
|
||
* @default 3000
|
||
*/
|
||
port: number,
|
||
|
||
/**
|
||
* Dev server listening host
|
||
* @default "localhost"
|
||
*/
|
||
host: string,
|
||
|
||
/**
|
||
* Listening dev server url
|
||
* @default "http://localhost:3000"
|
||
*/
|
||
url: string,
|
||
},
|
||
|
||
experimental: {
|
||
/**
|
||
* Set to true to generate an async entry point for the Vue bundle (for module federation support).
|
||
* @default false
|
||
*/
|
||
asyncEntry: boolean,
|
||
|
||
/**
|
||
* Enable Vue's reactivity transform
|
||
* @default false
|
||
*
|
||
* @see https://vuejs.org/guide/extras/reactivity-transform.html
|
||
*/
|
||
reactivityTransform: boolean,
|
||
|
||
/**
|
||
* Externalize `vue`, `@vue/*` and `vue-router` when building.
|
||
* @default true
|
||
*
|
||
* @see https://github.com/nuxt/framework/issues/4084
|
||
*/
|
||
externalVue: boolean,
|
||
|
||
/**
|
||
* Tree shakes contents of client-only components from server bundle.
|
||
* @default true
|
||
*
|
||
* @see https://github.com/nuxt/framework/pull/5750
|
||
*/
|
||
treeshakeClientOnly: boolean,
|
||
|
||
/**
|
||
* Use vite-node for on-demand server chunk loading
|
||
* @default true
|
||
*
|
||
* @deprecated use `vite.devBundler: 'vite-node'`
|
||
*/
|
||
viteNode: boolean,
|
||
|
||
/**
|
||
* Split server bundle into multiple chunks and dynamically import them.
|
||
* @default true
|
||
*
|
||
* @see https://github.com/nuxt/framework/issues/6432
|
||
*/
|
||
viteServerDynamicImports: boolean,
|
||
|
||
/**
|
||
* Inline styles when rendering HTML (currently vite only).
|
||
* You can also pass a function that receives the path of a Vue component and returns a boolean indicating whether to inline the styles for that component.
|
||
* @default true
|
||
*/
|
||
inlineSSRStyles: boolean | ((id?: string) => boolean),
|
||
|
||
/**
|
||
* Turn off rendering of Nuxt scripts and JS resource hints.
|
||
* @default false
|
||
*/
|
||
noScripts: boolean,
|
||
|
||
/**
|
||
* When this option is enabled (by default) payload of pages generated with `nuxt generate` are extracted
|
||
* @default false
|
||
*/
|
||
payloadExtraction: boolean,
|
||
|
||
/**
|
||
* Enable cross-origin prefetch using the Speculation Rules API.
|
||
* @default false
|
||
*/
|
||
crossOriginPrefetch: boolean,
|
||
|
||
/**
|
||
* Write early hints when using node server.
|
||
* @default false
|
||
*
|
||
* @note nginx does not support 103 Early hints in the current version.
|
||
*/
|
||
writeEarlyHints: boolean,
|
||
},
|
||
|
||
generate: {
|
||
/**
|
||
* The routes to generate.
|
||
* If you are using the crawler, this will be only the starting point for route generation. This is often necessary when using dynamic routes.
|
||
* It can be an array or a function.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* routes: ['/users/1', '/users/2', '/users/3']
|
||
* ```
|
||
*
|
||
* You can pass a function that returns a promise or a function that takes a callback. It should
|
||
* return an array of strings or objects with `route` and (optional) `payload` keys.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* export default {
|
||
* generate: {
|
||
* async routes() {
|
||
* const res = await axios.get('https://my-api/users')
|
||
* return res.data.map(user => ({ route: '/users/' + user.id, payload: user }))
|
||
* }
|
||
* }
|
||
* }
|
||
* ```
|
||
* Or instead:
|
||
* ```js
|
||
* export default {
|
||
* generate: {
|
||
* routes(callback) {
|
||
* axios
|
||
* .get('https://my-api/users')
|
||
* .then(res => {
|
||
* const routes = res.data.map(user => '/users/' + user.id)
|
||
* callback(null, routes)
|
||
* })
|
||
* .catch(callback)
|
||
* }
|
||
* }
|
||
* }
|
||
* ```
|
||
*
|
||
* If `routes()` returns a payload, it can be accessed from the Nuxt context.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* export default {
|
||
* async useAsyncData ({ params, error, payload }) {
|
||
* if (payload) return { user: payload }
|
||
* else return { user: await backend.fetchUser(params.id) }
|
||
* }
|
||
* }
|
||
* ```
|
||
*/
|
||
routes: Array<any>,
|
||
|
||
/** An array of string or regular expressions that will prevent generation of routes matching them. The routes will still be accessible when `fallback` is set. */
|
||
exclude: Array<any>,
|
||
},
|
||
|
||
/**
|
||
* @default 3
|
||
*
|
||
* @private
|
||
*/
|
||
_majorVersion: number,
|
||
|
||
/**
|
||
* @default false
|
||
*
|
||
* @private
|
||
*/
|
||
_legacyGenerate: boolean,
|
||
|
||
/**
|
||
* @default false
|
||
*
|
||
* @private
|
||
*/
|
||
_start: boolean,
|
||
|
||
/**
|
||
* @default false
|
||
*
|
||
* @private
|
||
*/
|
||
_build: boolean,
|
||
|
||
/**
|
||
* @default false
|
||
*
|
||
* @private
|
||
*/
|
||
_generate: boolean,
|
||
|
||
/**
|
||
* @default false
|
||
*
|
||
* @private
|
||
*/
|
||
_prepare: boolean,
|
||
|
||
/**
|
||
* @default false
|
||
*
|
||
* @private
|
||
*/
|
||
_cli: boolean,
|
||
|
||
/**
|
||
*
|
||
* @private
|
||
*/
|
||
_requiredModules: any,
|
||
|
||
/**
|
||
*
|
||
* @private
|
||
*/
|
||
_nuxtConfigFile: any,
|
||
|
||
/**
|
||
*
|
||
* @private
|
||
*/
|
||
_nuxtConfigFiles: Array<any>,
|
||
|
||
/**
|
||
* @default ""
|
||
*
|
||
* @private
|
||
*/
|
||
appDir: string,
|
||
|
||
/**
|
||
*
|
||
* @private
|
||
*/
|
||
_installedModules: Array<any>,
|
||
|
||
/**
|
||
*
|
||
* @private
|
||
*/
|
||
_modules: Array<any>,
|
||
|
||
/**
|
||
* Configuration for Nitro.
|
||
*
|
||
* @see https://nitro.unjs.io/config/
|
||
*/
|
||
nitro: NitroConfig,
|
||
|
||
/**
|
||
* Global route options applied to matching server routes.
|
||
*
|
||
* @experimental This is an experimental feature and API may change in the future.
|
||
*
|
||
* @see https://nitro.unjs.io/config/#routes
|
||
*/
|
||
routeRules: NitroConfig['routeRules'],
|
||
|
||
/**
|
||
* Nitro server handlers.
|
||
* Each handler accepts the following options: - handler: The path to the file defining the handler. - route: The route under which the handler is available. This follows the conventions of https://github.com/unjs/radix3. - method: The HTTP method of requests that should be handled. - middleware: Specifies whether it is a middleware handler. - lazy: Specifies whether to use lazy loading to import the handler.
|
||
*
|
||
* @see https://v3.nuxtjs.org/guide/features/server-routes
|
||
*
|
||
* @note Files from `server/api`, `server/middleware` and `server/routes` will be automatically registered by Nuxt.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* serverHandlers: [
|
||
* { route: '/path/foo/**:name', handler: '~/server/foohandler.ts' }
|
||
* ]
|
||
* ```
|
||
*/
|
||
serverHandlers: NitroEventHandler[],
|
||
|
||
/**
|
||
* Nitro development-only server handlers.
|
||
*
|
||
* @see https://nitro.unjs.io/guide/introduction/routing
|
||
*/
|
||
devServerHandlers: NitroDevEventHandler[],
|
||
|
||
postcss: {
|
||
/**
|
||
* Path to postcss config file.
|
||
* @default false
|
||
*/
|
||
config: boolean,
|
||
|
||
/**
|
||
* Options for configuring PostCSS plugins.
|
||
* https://postcss.org/
|
||
*/
|
||
plugins: Record<string, any>,
|
||
},
|
||
|
||
router: {
|
||
/**
|
||
* Additional options passed to `vue-router`.
|
||
* Note: Only JSON serializable options should be passed by nuxt config.
|
||
* For more control, you can use `app/router.options.ts` file.
|
||
*
|
||
* @see [documentation](https://router.vuejs.org/api/interfaces/routeroptions.html).
|
||
*/
|
||
options: RouterConfigSerializable,
|
||
},
|
||
|
||
/** Configuration for Nuxt's TypeScript integration. */
|
||
typescript: {
|
||
/**
|
||
* TypeScript comes with certain checks to give you more safety and analysis of your program. Once you’ve converted your codebase to TypeScript, you can start enabling these checks for greater safety. [Read More](https://www.typescriptlang.org/docs/handbook/migrating-from-javascript.html#getting-stricter-checks)
|
||
* @default true
|
||
*/
|
||
strict: boolean,
|
||
|
||
/**
|
||
* Include parent workspace in the Nuxt project. Mostly useful for themes and module authors.
|
||
* @default false
|
||
*/
|
||
includeWorkspace: boolean,
|
||
|
||
/**
|
||
* Enable build-time type checking.
|
||
* If set to true, this will type check in development. You can restrict this to build-time type checking by setting it to `build`. Requires to install `typescript` and `vue-tsc` as dev dependencies.
|
||
* @default false
|
||
*
|
||
* @see https://v3.nuxtjs.org/guide/concepts/typescript#type-checking
|
||
*/
|
||
typeCheck: boolean | 'build',
|
||
|
||
/** You can extend generated `.nuxt/tsconfig.json` using this option. */
|
||
tsConfig: readPackageJSON,
|
||
|
||
/**
|
||
* Generate a `*.vue` shim.
|
||
* We recommend instead either enabling [**Take Over Mode**](https://vuejs.org/guide/typescript/overview.html#volar-takeover-mode) or adding TypeScript Vue Plugin (Volar)** 👉 [[Download](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin)].
|
||
* @default true
|
||
*/
|
||
shim: boolean,
|
||
},
|
||
|
||
/**
|
||
* Configuration that will be passed directly to Vite.
|
||
* See https://vitejs.dev/config for more information. Please note that not all vite options are supported in Nuxt.
|
||
*/
|
||
vite: ViteConfig,
|
||
|
||
webpack: {
|
||
/**
|
||
* Nuxt uses `webpack-bundle-analyzer` to visualize your bundles and how to optimize them.
|
||
* Set to `true` to enable bundle analysis, or pass an object with options: [for webpack](https://github.com/webpack-contrib/webpack-bundle-analyzer#options-for-plugin) or [for vite](https://github.com/btd/rollup-plugin-visualizer#options).
|
||
* @default false
|
||
*
|
||
* @example
|
||
* ```js
|
||
* analyze: {
|
||
* analyzerMode: 'static'
|
||
* }
|
||
* ```
|
||
*/
|
||
analyze: boolean | BundleAnalyzerPlugin.Options,
|
||
|
||
/**
|
||
* Enable the profiler in webpackbar.
|
||
* It is normally enabled by CLI argument `--profile`.
|
||
* @default false
|
||
*
|
||
* @see [webpackbar](https://github.com/unjs/webpackbar#profile).
|
||
*/
|
||
profile: boolean,
|
||
|
||
/**
|
||
* Enables Common CSS Extraction using [Vue Server Renderer guidelines](https://ssr.vuejs.org/guide/css.html).
|
||
* Using [extract-css-chunks-webpack-plugin](https://github.com/faceyspacey/extract-css-chunks-webpack-plugin/) under the hood, your CSS will be extracted into separate files, usually one per component. This allows caching your CSS and JavaScript separately and is worth trying if you have a lot of global or shared CSS.
|
||
* @default true
|
||
*
|
||
* @example
|
||
* ```js
|
||
* export default {
|
||
* webpack: {
|
||
* extractCSS: true,
|
||
* // or
|
||
* extractCSS: {
|
||
* ignoreOrder: true
|
||
* }
|
||
* }
|
||
* }
|
||
* ```
|
||
*
|
||
* If you want to extract all your CSS to a single file, there is a workaround for this.
|
||
* However, note that it is not recommended to extract everything into a single file.
|
||
* Extracting into multiple CSS files is better for caching and preload isolation. It
|
||
* can also improve page performance by downloading and resolving only those resources
|
||
* that are needed.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* export default {
|
||
* webpack: {
|
||
* extractCSS: true,
|
||
* optimization: {
|
||
* splitChunks: {
|
||
* cacheGroups: {
|
||
* styles: {
|
||
* name: 'styles',
|
||
* test: /\.(css|vue)$/,
|
||
* chunks: 'all',
|
||
* enforce: true
|
||
* }
|
||
* }
|
||
* }
|
||
* }
|
||
* }
|
||
* }
|
||
* ```
|
||
*/
|
||
extractCSS: boolean | PluginOptions,
|
||
|
||
/**
|
||
* Enables CSS source map support (defaults to `true` in development).
|
||
* @default false
|
||
*/
|
||
cssSourceMap: boolean,
|
||
|
||
/**
|
||
* The polyfill library to load to provide URL and URLSearchParams.
|
||
* Defaults to `'url'` ([see package](https://www.npmjs.com/package/url)).
|
||
* @default "url"
|
||
*/
|
||
serverURLPolyfill: string,
|
||
|
||
/**
|
||
* Customize bundle filenames.
|
||
* To understand a bit more about the use of manifests, take a look at [this webpack documentation](https://webpack.js.org/guides/code-splitting/).
|
||
*
|
||
* @note Be careful when using non-hashed based filenames in production
|
||
* as most browsers will cache the asset and not detect the changes on first load.
|
||
*
|
||
* This example changes fancy chunk names to numerical ids:
|
||
*
|
||
* @example
|
||
* ```js
|
||
* filenames: {
|
||
* chunk: ({ isDev }) => (isDev ? '[name].js' : '[id].[contenthash].js')
|
||
* }
|
||
* ```
|
||
*/
|
||
filenames: {
|
||
app: () => any,
|
||
|
||
chunk: () => any,
|
||
|
||
css: () => any,
|
||
|
||
img: () => any,
|
||
|
||
font: () => any,
|
||
|
||
video: () => any,
|
||
},
|
||
|
||
/** Customize the options of Nuxt's integrated webpack loaders. */
|
||
loaders: {
|
||
file: {
|
||
/** @default false */
|
||
esModule: boolean,
|
||
},
|
||
|
||
fontUrl: {
|
||
/** @default false */
|
||
esModule: boolean,
|
||
|
||
/** @default 1000 */
|
||
limit: number,
|
||
},
|
||
|
||
imgUrl: {
|
||
/** @default false */
|
||
esModule: boolean,
|
||
|
||
/** @default 1000 */
|
||
limit: number,
|
||
},
|
||
|
||
pugPlain: any,
|
||
|
||
vue: {
|
||
/** @default true */
|
||
productionMode: boolean,
|
||
|
||
transformAssetUrls: {
|
||
/** @default "src" */
|
||
video: string,
|
||
|
||
/** @default "src" */
|
||
source: string,
|
||
|
||
/** @default "src" */
|
||
object: string,
|
||
|
||
/** @default "src" */
|
||
embed: string,
|
||
},
|
||
|
||
compilerOptions: {
|
||
[key: string]: any
|
||
},
|
||
},
|
||
|
||
css: {
|
||
/** @default 0 */
|
||
importLoaders: number,
|
||
|
||
url: {
|
||
filter: () => any,
|
||
},
|
||
|
||
/** @default false */
|
||
esModule: boolean,
|
||
},
|
||
|
||
cssModules: {
|
||
/** @default 0 */
|
||
importLoaders: number,
|
||
|
||
url: {
|
||
filter: () => any,
|
||
},
|
||
|
||
/** @default false */
|
||
esModule: boolean,
|
||
|
||
modules: {
|
||
/** @default "[local]_[hash:base64:5]" */
|
||
localIdentName: string,
|
||
},
|
||
},
|
||
|
||
less: any,
|
||
|
||
sass: {
|
||
sassOptions: {
|
||
/** @default true */
|
||
indentedSyntax: boolean,
|
||
},
|
||
},
|
||
|
||
scss: any,
|
||
|
||
stylus: any,
|
||
|
||
vueStyle: any,
|
||
},
|
||
|
||
/**
|
||
* Add webpack plugins.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* import webpack from 'webpack'
|
||
* import { version } from './package.json'
|
||
* // ...
|
||
* plugins: [
|
||
* new webpack.DefinePlugin({
|
||
* 'process.VERSION': version
|
||
* })
|
||
* ]
|
||
* ```
|
||
*/
|
||
plugins: Array<any>,
|
||
|
||
/**
|
||
* Terser plugin options.
|
||
* Set to false to disable this plugin, or pass an object of options.
|
||
*
|
||
* @see [terser-webpack-plugin documentation](https://github.com/webpack-contrib/terser-webpack-plugin).
|
||
*
|
||
* @note Enabling sourceMap will leave `//# sourceMappingURL` linking comment at
|
||
* the end of each output file if webpack `config.devtool` is set to `source-map`.
|
||
*/
|
||
terser: false | BasePluginOptions & DefinedDefaultMinimizerAndOptions<any>,
|
||
|
||
/**
|
||
* Hard-replaces `typeof process`, `typeof window` and `typeof document` to tree-shake bundle.
|
||
* @default false
|
||
*/
|
||
aggressiveCodeRemoval: boolean,
|
||
|
||
/**
|
||
* OptimizeCSSAssets plugin options.
|
||
* Defaults to true when `extractCSS` is enabled.
|
||
* @default false
|
||
*
|
||
* @see [css-minimizer-webpack-plugin documentation](https://github.com/webpack-contrib/css-minimizer-webpack-plugin).
|
||
*/
|
||
optimizeCSS: false | BasePluginOptions$1 & DefinedDefaultMinimizerAndOptions$1<any>,
|
||
|
||
/** Configure [webpack optimization](https://webpack.js.org/configuration/optimization/). */
|
||
optimization: false | Configuration['optimization'],
|
||
|
||
/** Customize PostCSS Loader. Same options as https://github.com/webpack-contrib/postcss-loader#options */
|
||
postcss: {
|
||
execute: any,
|
||
|
||
postcssOptions: {
|
||
/** @default false */
|
||
config: boolean,
|
||
|
||
plugins: {
|
||
[key: string]: any
|
||
},
|
||
},
|
||
|
||
sourceMap: any,
|
||
|
||
implementation: any,
|
||
|
||
/** @default "" */
|
||
order: string,
|
||
},
|
||
|
||
/** See [webpack-dev-middleware](https://github.com/webpack/webpack-dev-middleware) for available options. */
|
||
devMiddleware: Options<IncomingMessage, ServerResponse>,
|
||
|
||
/** See [webpack-hot-middleware](https://github.com/webpack-contrib/webpack-hot-middleware) for available options. */
|
||
hotMiddleware: MiddlewareOptions & { client?: ClientOptions },
|
||
|
||
/**
|
||
* Set to `false` to disable the overlay provided by [FriendlyErrorsWebpackPlugin](https://github.com/nuxt/friendly-errors-webpack-plugin).
|
||
* @default true
|
||
*/
|
||
friendlyErrors: boolean,
|
||
|
||
/** Filters to hide build warnings. */
|
||
warningIgnoreFilters: Array<(warn: WebpackError) => boolean>,
|
||
},
|
||
}
|
||
|
||
interface HeadAugmentations extends MergeHead {
|
||
base?: {};
|
||
link?: {};
|
||
meta?: {};
|
||
style?: {};
|
||
script?: {};
|
||
noscript?: {};
|
||
htmlAttrs?: {};
|
||
bodyAttrs?: {};
|
||
}
|
||
type MetaObjectRaw = Head<HeadAugmentations>;
|
||
type MetaObject = MetaObjectRaw;
|
||
type AppHeadMetaObject = MetaObjectRaw & {
|
||
/**
|
||
* The character encoding in which the document is encoded => `<meta charset="<value>" />`
|
||
*
|
||
* @default `'utf-8'`
|
||
*/
|
||
charset?: string;
|
||
/**
|
||
* Configuration of the viewport (the area of the window in which web content can be seen),
|
||
* mapped to => `<meta name="viewport" content="<value>" />`
|
||
*
|
||
* @default `'width=device-width, initial-scale=1'`
|
||
*/
|
||
viewport?: string;
|
||
};
|
||
|
||
type DeepPartial<T> = T extends Function ? T : T extends Record<string, any> ? {
|
||
[P in keyof T]?: DeepPartial<T[P]>;
|
||
} : T;
|
||
/** User configuration in `nuxt.config` file */
|
||
interface NuxtConfig extends DeepPartial<Omit<ConfigSchema, 'vite'>> {
|
||
vite?: ConfigSchema['vite'];
|
||
}
|
||
interface ConfigLayer<T> {
|
||
config: T;
|
||
cwd: string;
|
||
configFile: string;
|
||
}
|
||
type NuxtConfigLayer = ConfigLayer<NuxtConfig & {
|
||
srcDir: ConfigSchema['srcDir'];
|
||
rootDir: ConfigSchema['rootDir'];
|
||
}>;
|
||
/** Normalized Nuxt options available as `nuxt.options.*` */
|
||
interface NuxtOptions extends Omit<ConfigSchema, 'builder'> {
|
||
sourcemap: Required<Exclude<ConfigSchema['sourcemap'], boolean>>;
|
||
builder: '@nuxt/vite-builder' | '@nuxt/webpack-builder' | {
|
||
bundle: (nuxt: Nuxt) => Promise<void>;
|
||
};
|
||
_layers: NuxtConfigLayer[];
|
||
}
|
||
interface ViteConfig extends UserConfig {
|
||
/**
|
||
* Options passed to @vitejs/plugin-vue
|
||
* @see https://github.com/vitejs/vite/tree/main/packages/plugin-vue
|
||
*/
|
||
vue?: Options$1;
|
||
/**
|
||
* Bundler for dev time server-side rendering.
|
||
* @default 'vite-node'
|
||
*/
|
||
devBundler?: 'vite-node' | 'legacy';
|
||
/**
|
||
* Warmup vite entrypoint caches on dev startup.
|
||
*/
|
||
warmupEntry?: boolean;
|
||
/**
|
||
* Use environment variables or top level `server` options to configure Nuxt server.
|
||
*/
|
||
server?: Omit<ServerOptions, 'port' | 'host'>;
|
||
}
|
||
type RuntimeConfigNamespace = Record<string, any>;
|
||
interface PublicRuntimeConfig extends RuntimeConfigNamespace {
|
||
}
|
||
interface RuntimeConfig extends RuntimeConfigNamespace {
|
||
public: PublicRuntimeConfig;
|
||
}
|
||
interface AppConfigInput extends Record<string, any> {
|
||
/** @deprecated reserved */
|
||
private?: never;
|
||
/** @deprecated reserved */
|
||
nuxt?: never;
|
||
/** @deprecated reserved */
|
||
nitro?: never;
|
||
/** @deprecated reserved */
|
||
server?: never;
|
||
}
|
||
interface NuxtAppConfig {
|
||
head: AppHeadMetaObject;
|
||
layoutTransition: boolean | TransitionProps;
|
||
pageTransition: boolean | TransitionProps;
|
||
keepalive: boolean | KeepAliveProps;
|
||
}
|
||
interface AppConfig {
|
||
}
|
||
|
||
declare const _default: {
|
||
[x: string]: untyped.SchemaDefinition | untyped.JSValue | untyped.InputObject;
|
||
};
|
||
|
||
export { AppConfig, AppConfigInput, AppHeadMetaObject, Component, ComponentsDir, ComponentsOptions, GenerateAppOptions, HeadAugmentations, HookResult, ImportPresetWithDeprecation, ImportsOptions, MetaObject, MetaObjectRaw, ModuleDefinition, ModuleMeta, ModuleOptions, Nuxt, NuxtApp, NuxtAppConfig, NuxtCompatibility, NuxtCompatibilityIssue, NuxtCompatibilityIssues, NuxtConfig, NuxtConfigLayer, _default as NuxtConfigSchema, NuxtHookName, NuxtHooks, NuxtLayout, NuxtMiddleware, NuxtModule, NuxtOptions, NuxtPage, NuxtPlugin, NuxtPluginTemplate, NuxtTemplate, PublicRuntimeConfig, ResolvedNuxtTemplate, RouterConfig, RouterConfigSerializable, RouterOptions, RuntimeConfig, ScanDir, TSReference, ViteConfig, WatchEvent };
|