Vixt

vixt / core / VixtConfig

VixtConfig ​

Extended by ​

Properties ​

_cli? ​

optional _cli?: boolean

Internal

Whether your app is running in with vixt-cli.

_prepare? ​

optional _prepare?: boolean

Internal

alias? ​

optional alias?: AliasOptions

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>"
}

app? ​

optional app?: AppOptions

Vixt App configuration.

appConfig? ​

optional appConfig?: Record<string, any>

Additional app configuration.

build? ​

optional build?: BuildOptions

Shared build configuration.

buildDir? ​

optional buildDir?: string

Define the directory where your built files will be placed.

Default ​

ts
'<rootDir>/.vixt'

buildLayersDir? ​

optional buildLayersDir?: string

Default ​

ts
'<buildDir>/layers'

buildTypesDir? ​

optional buildTypesDir?: string

Default ​

ts
'<buildDir>/types'

copyLayers? ​

optional copyLayers?: boolean

Experimental

Whether to copy layers from node_modules to .vixt/layers

Default ​

ts
true
@experimental

debug? ​

optional debug?: boolean

Set to true to enable debug mode.

Default ​

ts
false

dev? ​

optional dev?: boolean

Whether your app is running in development mode.

Default ​

ts
false

devServer? ​

optional devServer?: DevServerOptions

Set CORS options for the dev server, the port, host, cors options will be passed to vite.server

extends? ​

optional extends?: string[]

Extend project from multiple local or remote sources.

imports? ​

optional imports?: ImportsOptions

Configure how Vixt auto-imports composables into your application.

meta? ​

optional meta?: VixtConfigLayerMeta

Custom meta for layer.

modules? ​

optional modules?: VixtModule<ModuleOptions>[]

Modules are Vixt extensions which can extend its core functionality and add endless integrations.

modulesDir? ​

optional modulesDir?: string

Define the directory of your Vixt modules.

Default ​

ts
'<srcDir>/modules'

nitro? ​

optional nitro?: NitroOptions

Configuration for Nitro.

plugins? ​

optional plugins?: string[]

An array of vixt app plugins.

pluginsDir? ​

optional pluginsDir?: string

Define the directory of your Vixt plugins.

Default ​

ts
'<srcDir>/plugins'

rootDir? ​

optional rootDir?: string

Define the root directory of your application.

Default ​

ts
process.cwd()

srcDir? ​

optional srcDir?: string

Define the source directory of your application.

Default ​

ts
'<rootDir>/src'

ssr? ​

optional ssr?: boolean

Whether to enable rendering of HTML.

test? ​

optional test?: boolean

Whether your app is being unit tested.

Default ​

ts
false

typescript? ​

optional typescript?: TypescriptOptions

Configuration for TypeScript integration.

vite? ​

optional vite?: Omit<UserConfig, "plugins">

Configuration that will be passed directly to Vite.

workspaceDir? ​

optional workspaceDir?: string

Define the monorepo workspace directory of your application.