@dtwo/schema 3.0.0-rc.13

package/schema/config.md

@@ -0,0 +1,1221 @@
+ 
+
+# `components`
+
+# `imports`
+
+## `global`
+- **Type**: `boolean`
+- **Default**: `false`
+
+
+## `dirs`
+- **Type**: `array`
+- **Default**: `[]`
+
+
+# `pages`
+- **Type**: `boolean`
+- **Default**: `undefined`
+
+> Whether to use the kdu-router integration in Dtwo 3. If you do not provide a value it will be enabled if you have a `pages/` directory in your source folder.
+
+
+# `telemetry`
+- **Type**: `boolean`
+- **Default**: `undefined`
+
+> Manually disable dtwo telemetry.
+
+
+# `kdu`
+
+## `compilerOptions`
+- **Type**: `@kdujsCompilerCoreCompilerOptions`
+- **Default**: `{}`
+
+> Options for the Kdu compiler that will be passed at build time.
+
+
+# `app`
+
+## `baseURL`
+- **Type**: `string`
+- **Default**: `"/"`
+
+> The base path of your Dtwo application.
+
+
+This can be set at runtime by setting the DTWO_APP_BASE_URL environment variable.
+
+
+## `buildAssetsDir`
+- **Type**: `string`
+- **Default**: `"/_dtwo/"`
+
+> 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.
+
+
+## `cdnURL`
+- **Type**: `string`
+- **Default**: `""`
+
+> An absolute URL to serve the public folder from (production-only).
+
+
+This can be set to a different value at runtime by setting the `DTWO_APP_CDN_URL` environment variable.
+
+
+## `head`
+
+## `layoutTransition`
+- **Type**: `SrcTypesConfigDtwoAppConfig['layoutTransition']`
+- **Default**: `false`
+
+> Default values for layout transitions.
+
+
+This can be overridden with `definePageMeta` on an individual page. Only JSON-serializable values are allowed.
+
+
+## `pageTransition`
+- **Type**: `SrcTypesConfigDtwoAppConfig['pageTransition']`
+- **Default**: `false`
+
+> Default values for page transitions.
+
+
+This can be overridden with `definePageMeta` on an individual page. Only JSON-serializable values are allowed.
+
+
+## `keepalive`
+- **Type**: `SrcTypesConfigDtwoAppConfig['keepalive']`
+- **Default**: `false`
+
+> Default values for KeepAlive configuration between pages.
+
+
+This can be overridden with `definePageMeta` on an individual page. Only JSON-serializable values are allowed.
+
+
+## `rootId`
+- **Type**: `string`
+- **Default**: `"__dtwo"`
+
+> Customize Dtwo root element id.
+
+
+## `rootTag`
+- **Type**: `string`
+- **Default**: `"div"`
+
+> Customize Dtwo root element tag.
+
+
+# `plugins`
+- **Type**: `(SrcTypesDtwoDtwoPlugin | string)[]`
+- **Default**: `[]`
+
+> An array of dtwo 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.
+
+
+# `css`
+- **Type**: `string[]`
+- **Default**: `[]`
+
+> You can define the CSS files/modules/libraries you want to set globally (included in every page).
+
+
+Dtwo 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.
+
+
+# `builder`
+- **Type**: `'wite' | 'webpack' | { bundle: (dtwo: SrcTypesDtwoDtwo) => Promise<void> }`
+- **Default**: `"@dtwo/wite-builder"`
+
+> The builder to use for bundling the Kdu part of your application.
+
+
+# `sourcemap`
+
+# `build`
+
+## `transpile`
+- **Type**: `Array<string | RegExp | Function>`
+- **Default**: `[]`
+
+> 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 }).
+
+
+## `templates`
+- **Type**: `array`
+- **Default**: `[]`
+
+> You can provide your own templates which will be rendered based on Dtwo configuration. This feature is specially useful for using with modules.
+
+
+Templates are rendered using [`lodash.template`](https://lodash.com/docs/4.17.15#template).
+
+
+## `analyze`
+- **Type**: `boolean | WebpackBundleAnalyzerBundleAnalyzerPluginOptions | RollupPluginVisualizerPluginVisualizerOptions`
+- **Default**: `false`
+
+> Dtwo 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 wite](https://github.com/btd/rollup-plugin-visualizer#options).
+
+
+# `extends`
+- **Type**: `string|string[]`
+- **Default**: `null`
+
+> 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.
+
+
+# `theme`
+- **Type**: `string`
+- **Default**: `null`
+
+> 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.
+
+
+# `rootDir`
+- **Type**: `string`
+- **Default**: `"/<rootDir>"`
+
+> Define the root directory of your application.
+
+
+This property can be overwritten (for example, running `dtwo ./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.
+
+
+# `workspaceDir`
+- **Type**: `string`
+- **Default**: `"/<rootDir>"`
+
+> Define the workspace directory of your application.
+
+
+Often this is used when in a monorepo setup. Dtwo will attempt to detect your workspace directory automatically, but you can override it here.
+It is normally not needed to configure this option.
+
+
+# `srcDir`
+- **Type**: `string`
+- **Default**: `"/<rootDir>"`
+
+> Define the source directory of your Dtwo application.
+
+
+If a relative path is specified, it will be relative to the `rootDir`.
+
+
+# `serverDir`
+- **Type**: `string`
+- **Default**: `"/<rootDir>/server"`
+
+> Define the server directory of your Dtwo application, where Hole routes, middleware and plugins are kept.
+
+
+If a relative path is specified, it will be relative to your `rootDir`.
+
+
+# `buildDir`
+- **Type**: `string`
+- **Default**: `"/<rootDir>/.dtwo"`
+
+> Define the directory where your built Dtwo files will be placed.
+
+
+Many tools assume that `.dtwo` is a hidden directory (because it starts with a `.`). If that is a problem, you can use this option to prevent that.
+
+
+# `modulesDir`
+- **Type**: `array`
+- **Default**: `["/<rootDir>/node_modules","D:/Workspace/ORGs/d2js/dtwo/packages/schema/node_modules"]`
+
+> 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.
+
+
+# `dev`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Whether Dtwo is running in development mode.
+
+
+Normally, you should not need to set this.
+
+
+# `test`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Whether your app is being unit tested.
+
+
+# `debug`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> 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.
+
+
+# `ssr`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> 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.
+
+
+# `modules`
+- **Type**: `(SrcTypesModuleDtwoModule | string | [SrcTypesModuleDtwoModule | string, Record<string, any>])[]`
+- **Default**: `[]`
+
+> Modules are Dtwo 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.
+Dtwo 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.
+
+
+# `dir`
+
+## `assets`
+- **Type**: `string`
+- **Default**: `"assets"`
+
+> The assets directory (aliased as `~assets` in your build).
+
+
+## `layouts`
+- **Type**: `string`
+- **Default**: `"layouts"`
+
+> The layouts directory, each file of which will be auto-registered as a Dtwo layout.
+
+
+## `middleware`
+- **Type**: `string`
+- **Default**: `"middleware"`
+
+> The middleware directory, each file of which will be auto-registered as a Dtwo middleware.
+
+
+## `pages`
+- **Type**: `string`
+- **Default**: `"pages"`
+
+> The directory which will be processed to auto-generate your application page routes.
+
+
+## `plugins`
+- **Type**: `string`
+- **Default**: `"plugins"`
+
+> The plugins directory, each file of which will be auto-registered as a Dtwo plugin.
+
+
+## `public`
+- **Type**: `string`
+- **Default**: `"public"`
+
+> The directory containing your static files, which will be directly accessible via the Dtwo server and copied across into your `dist` folder when your app is generated.
+
+
+## `static`
+- **Type**: `string`
+- **Default**: `"public"`
+
+
+# `extensions`
+- **Type**: `array`
+- **Default**: `[".js",".jsx",".mjs",".ts",".tsx",".kdu"]`
+
+> The extensions that should be resolved by the Dtwo resolver.
+
+
+# `alias`
+
+# `ignoreOptions`
+- **Type**: `any`
+- **Default**: `{}`
+
+> Pass options directly to `node-ignore` (which is used by Dtwo to ignore files).
+
+
+# `ignorePrefix`
+- **Type**: `string`
+- **Default**: `"-"`
+
+> Any file in `pages/`, `layouts/`, `middleware/` or `store/` will be ignored during building if its filename starts with the prefix specified by `ignorePrefix`.
+
+
+# `ignore`
+- **Type**: `array`
+- **Default**: `["**/*.stories.{js,ts,jsx,tsx}","**/*.{spec,test}.{js,ts,jsx,tsx}","**/*.d.ts",".output","**/-*.*"]`
+
+> More customizable than `ignorePrefix`: all files matching glob patterns specified inside the `ignore` array will be ignored in building.
+
+
+# `watchers`
+
+## `rewatchOnRawEvents`
+- **Type**: `any`
+- **Default**: `{}`
+
+> An array of event types, which, when received, will cause the watcher to restart.
+
+
+## `webpack`
+
+### `aggregateTimeout`
+- **Type**: `number`
+- **Default**: `1000`
+
+
+## `chokidar`
+
+### `ignoreInitial`
+- **Type**: `boolean`
+- **Default**: `true`
+
+
+# `hooks`
+- **Type**: `SrcTypesHooksDtwoHooks`
+- **Default**: `null`
+
+> Hooks are listeners to Dtwo events that are typically used in modules, but are also available in `dtwo.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 `dtwo.config` (as below).
+
+
+# `runtimeConfig`
+
+# `appConfig`
+- **Type**: `SrcTypesConfigAppConfig`
+- **Default**: `{}`
+
+> 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.
+
+
+# `devServer`
+
+## `https`
+- **Type**: `false | { key: string; cert: string }`
+- **Default**: `false`
+
+> Whether to enable HTTPS.
+
+
+## `port`
+- **Type**: `number`
+- **Default**: `3000`
+
+> Dev server listening port
+
+
+## `host`
+- **Type**: `string`
+- **Default**: `"localhost"`
+
+> Dev server listening host
+
+
+## `url`
+- **Type**: `string`
+- **Default**: `"http://localhost:3000"`
+
+> Listening dev server url
+
+
+# `experimental`
+
+## `asyncEntry`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Set to true to generate an async entry point for the Kdu bundle (for module federation support).
+
+
+## `reactivityTransform`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Enable Kdu's reactivity transform
+
+
+## `externalKdu`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Externalize `kdu`, `@kdujs/*` and `kdu-router` when building.
+
+
+## `treeshakeClientOnly`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Tree shakes contents of client-only components from server bundle.
+
+
+## `witeNode`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Use wite-node for on-demand server chunk loading
+
+
+## `witeServerDynamicImports`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Split server bundle into multiple chunks and dynamically import them.
+
+
+## `inlineSSRStyles`
+- **Type**: `boolean | ((id?: string) => boolean)`
+- **Default**: `true`
+
+> Inline styles when rendering HTML (currently wite only).
+
+
+You can also pass a function that receives the path of a Kdu component and returns a boolean indicating whether to inline the styles for that component.
+
+
+## `noScripts`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Turn off rendering of Dtwo scripts and JS resource hints.
+
+
+## `payloadExtraction`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> When this option is enabled (by default) payload of pages generated with `dtwo generate` are extracted
+
+
+## `crossOriginPrefetch`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Enable cross-origin prefetch using the Speculation Rules API.
+
+
+## `writeEarlyHints`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Write early hints when using node server.
+
+
+# `generate`
+
+## `routes`
+- **Type**: `array`
+- **Default**: `[]`
+
+> 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.
+
+
+## `exclude`
+- **Type**: `array`
+- **Default**: `[]`
+
+> 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.
+
+
+# `_majorVersion`
+- **Type**: `number`
+- **Default**: `3`
+
+
+# `_legacyGenerate`
+- **Type**: `boolean`
+- **Default**: `false`
+
+
+# `_start`
+- **Type**: `boolean`
+- **Default**: `false`
+
+
+# `_build`
+- **Type**: `boolean`
+- **Default**: `false`
+
+
+# `_generate`
+- **Type**: `boolean`
+- **Default**: `false`
+
+
+# `_prepare`
+- **Type**: `boolean`
+- **Default**: `false`
+
+
+# `_cli`
+- **Type**: `boolean`
+- **Default**: `false`
+
+
+# `_requiredModules`
+- **Type**: `any`
+- **Default**: `{}`
+
+
+# `_dtwoConfigFile`
+- **Type**: `any`
+- **Default**: `{}`
+
+
+# `_dtwoConfigFiles`
+- **Type**: `array`
+- **Default**: `[]`
+
+
+# `appDir`
+- **Type**: `string`
+- **Default**: `""`
+
+
+# `_installedModules`
+- **Type**: `array`
+- **Default**: `[]`
+
+
+# `_modules`
+- **Type**: `array`
+- **Default**: `[]`
+
+
+# `hole`
+
+## `routeRules`
+
+# `routeRules`
+- **Type**: `HolepackHoleConfig['routeRules']`
+- **Default**: `{}`
+
+> Global route options applied to matching server routes.
+
+
+# `serverHandlers`
+- **Type**: `HolepackHoleEventHandler[]`
+- **Default**: `[]`
+
+> Hole 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.
+
+
+# `devServerHandlers`
+- **Type**: `HolepackHoleDevEventHandler[]`
+- **Default**: `[]`
+
+> Hole development-only server handlers.
+
+
+# `postcss`
+
+## `config`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Path to postcss config file.
+
+
+## `plugins`
+
+### `postcss-import`
+
+### `postcss-url`
+- **Type**: `any`
+- **Default**: `{}`
+
+> https://github.com/postcss/postcss-url
+
+
+### `autoprefixer`
+- **Type**: `any`
+- **Default**: `{}`
+
+> https://github.com/postcss/autoprefixer
+
+
+### `cssnano`
+- **Type**: `boolean`
+- **Default**: `true`
+
+
+# `router`
+
+## `options`
+- **Type**: `SrcTypesRouterRouterConfigSerializable`
+- **Default**: `{}`
+
+> Additional options passed to `kdu-router`.
+
+
+Note: Only JSON serializable options should be passed by dtwo config.
+For more control, you can use `app/router.options.ts` file.
+
+
+# `typescript`
+
+## `strict`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> 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)
+
+
+## `includeWorkspace`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Include parent workspace in the Dtwo project. Mostly useful for themes and module authors.
+
+
+## `typeCheck`
+- **Type**: `boolean | 'build'`
+- **Default**: `false`
+
+> 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 `kdu-tsc` as dev dependencies.
+
+
+## `tsConfig`
+- **Type**: `PkgTypesReadPackageJSON`
+- **Default**: `{}`
+
+> You can extend generated `.dtwo/tsconfig.json` using this option.
+
+
+## `shim`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Generate a `*.kdu` shim.
+
+
+We recommend instead either enabling [**Take Over Mode**](https://kdu-js.web.app/guide/typescript/overview.html#kocan-takeover-mode) or adding TypeScript Kdu Plugin (Kocan)** 👉 [[Download](https://marketplace.visualstudio.com/items?itemName=Kdu-Code.vscode-typescript-kdu-plugin)].
+
+
+# `wite`
+
+## `root`
+- **Type**: `string`
+- **Default**: `"/<rootDir>"`
+
+
+## `mode`
+- **Type**: `string`
+- **Default**: `"production"`
+
+
+## `logLevel`
+- **Type**: `string`
+- **Default**: `"warn"`
+
+
+## `define`
+
+## `resolve`
+
+### `extensions`
+- **Type**: `array`
+- **Default**: `[".mjs",".js",".ts",".jsx",".tsx",".json",".kdu"]`
+
+
+## `publicDir`
+- **Type**: `string`
+- **Default**: `"/<rootDir>/public"`
+
+
+## `kdu`
+
+### `isProduction`
+- **Type**: `boolean`
+- **Default**: `true`
+
+
+### `template`
+
+#### `compilerOptions`
+
+## `optimizeDeps`
+
+### `exclude`
+- **Type**: `array`
+- **Default**: `["kdu-demi"]`
+
+
+## `esbuild`
+
+### `jsxFactory`
+- **Type**: `string`
+- **Default**: `"h"`
+
+
+### `jsxFragment`
+- **Type**: `string`
+- **Default**: `"Fragment"`
+
+
+### `tsconfigRaw`
+- **Type**: `string`
+- **Default**: `"{}"`
+
+
+## `clearScreen`
+- **Type**: `boolean`
+- **Default**: `false`
+
+
+## `build`
+
+### `assetsDir`
+- **Type**: `string`
+- **Default**: `"_dtwo/"`
+
+
+### `emptyOutDir`
+- **Type**: `boolean`
+- **Default**: `false`
+
+
+## `server`
+
+### `fs`
+
+#### `allow`
+- **Type**: `array`
+- **Default**: `["/<rootDir>/.dtwo","/<rootDir>","/<rootDir>","/<rootDir>","/<rootDir>/node_modules","D:/Workspace/ORGs/d2js/dtwo/packages/schema/node_modules"]`
+
+
+# `webpack`
+
+## `analyze`
+- **Type**: `boolean | WebpackBundleAnalyzerBundleAnalyzerPluginOptions`
+- **Default**: `false`
+
+> Dtwo 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 wite](https://github.com/btd/rollup-plugin-visualizer#options).
+
+
+## `profile`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Enable the profiler in webpackbar.
+
+
+It is normally enabled by CLI argument `--profile`.
+
+
+## `extractCSS`
+- **Type**: `boolean | MiniCssExtractPluginPluginOptions`
+- **Default**: `true`
+
+> Enables Common CSS Extraction using [Kdu Server Renderer guidelines](https://kdujs-ssr.web.app/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.
+
+
+## `cssSourceMap`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Enables CSS source map support (defaults to `true` in development).
+
+
+## `serverURLPolyfill`
+- **Type**: `string`
+- **Default**: `"url"`
+
+> The polyfill library to load to provide URL and URLSearchParams.
+
+
+Defaults to `'url'` ([see package](https://www.npmjs.com/package/url)).
+
+
+## `filenames`
+
+### `app`
+- **Type**: `function`
+- **Default**: `undefined`
+
+```ts
+() => any
+```
+
+
+### `chunk`
+- **Type**: `function`
+- **Default**: `undefined`
+
+```ts
+() => any
+```
+
+
+### `css`
+- **Type**: `function`
+- **Default**: `undefined`
+
+```ts
+() => any
+```
+
+
+### `img`
+- **Type**: `function`
+- **Default**: `undefined`
+
+```ts
+() => any
+```
+
+
+### `font`
+- **Type**: `function`
+- **Default**: `undefined`
+
+```ts
+() => any
+```
+
+
+### `video`
+- **Type**: `function`
+- **Default**: `undefined`
+
+```ts
+() => any
+```
+
+
+## `loaders`
+
+### `file`
+
+#### `esModule`
+- **Type**: `boolean`
+- **Default**: `false`
+
+
+### `fontUrl`
+
+#### `esModule`
+- **Type**: `boolean`
+- **Default**: `false`
+
+
+#### `limit`
+- **Type**: `number`
+- **Default**: `1000`
+
+
+### `imgUrl`
+
+#### `esModule`
+- **Type**: `boolean`
+- **Default**: `false`
+
+
+#### `limit`
+- **Type**: `number`
+- **Default**: `1000`
+
+
+### `pugPlain`
+- **Type**: `any`
+- **Default**: `{}`
+
+
+### `kdu`
+
+#### `productionMode`
+- **Type**: `boolean`
+- **Default**: `true`
+
+
+#### `transformAssetUrls`
+
+##### `video`
+- **Type**: `string`
+- **Default**: `"src"`
+
+
+##### `source`
+- **Type**: `string`
+- **Default**: `"src"`
+
+
+##### `object`
+- **Type**: `string`
+- **Default**: `"src"`
+
+
+##### `embed`
+- **Type**: `string`
+- **Default**: `"src"`
+
+
+#### `compilerOptions`
+
+### `css`
+
+#### `importLoaders`
+- **Type**: `number`
+- **Default**: `0`
+
+
+#### `url`
+
+##### `filter`
+- **Type**: `function`
+- **Default**: `undefined`
+
+```ts
+() => any
+```
+
+
+#### `esModule`
+- **Type**: `boolean`
+- **Default**: `false`
+
+
+### `cssModules`
+
+#### `importLoaders`
+- **Type**: `number`
+- **Default**: `0`
+
+
+#### `url`
+
+##### `filter`
+- **Type**: `function`
+- **Default**: `undefined`
+
+```ts
+() => any
+```
+
+
+#### `esModule`
+- **Type**: `boolean`
+- **Default**: `false`
+
+
+#### `modules`
+
+##### `localIdentName`
+- **Type**: `string`
+- **Default**: `"[local]_[hash:base64:5]"`
+
+
+### `less`
+- **Type**: `any`
+- **Default**: `{"sourceMap":false}`
+
+
+### `sass`
+
+#### `sassOptions`
+
+##### `indentedSyntax`
+- **Type**: `boolean`
+- **Default**: `true`
+
+
+### `scss`
+- **Type**: `any`
+- **Default**: `{"sourceMap":false}`
+
+
+### `stylus`
+- **Type**: `any`
+- **Default**: `{"sourceMap":false}`
+
+
+### `kduStyle`
+- **Type**: `any`
+- **Default**: `{"sourceMap":false}`
+
+
+## `plugins`
+- **Type**: `array`
+- **Default**: `[]`
+
+> Add webpack plugins.
+
+
+## `terser`
+- **Type**: `false | TerserWebpackPluginBasePluginOptions & TerserWebpackPluginDefinedDefaultMinimizerAndOptions<any>`
+- **Default**: `{}`
+
+> Terser plugin options.
+
+
+Set to false to disable this plugin, or pass an object of options.
+
+
+## `aggressiveCodeRemoval`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Hard-replaces `typeof process`, `typeof window` and `typeof document` to tree-shake bundle.
+
+
+## `optimizeCSS`
+- **Type**: `false | CssMinimizerWebpackPluginBasePluginOptions & CssMinimizerWebpackPluginDefinedDefaultMinimizerAndOptions<any>`
+- **Default**: `false`
+
+> OptimizeCSSAssets plugin options.
+
+
+Defaults to true when `extractCSS` is enabled.
+
+
+## `optimization`
+
+### `runtimeChunk`
+- **Type**: `string`
+- **Default**: `"single"`
+
+
+### `minimize`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Set minimize to `false` to disable all minimizers. (It is disabled in development by default).
+
+
+### `minimizer`
+- **Type**: `any`
+- **Default**: `{}`
+
+> You can set minimizer to a customized array of plugins.
+
+
+### `splitChunks`
+
+#### `chunks`
+- **Type**: `string`
+- **Default**: `"all"`
+
+
+#### `automaticNameDelimiter`
+- **Type**: `string`
+- **Default**: `"/"`
+
+
+#### `cacheGroups`
+- **Type**: `any`
+- **Default**: `{}`
+
+
+## `postcss`
+
+### `execute`
+- **Type**: `undefined`
+- **Default**: `undefined`
+
+
+### `postcssOptions`
+
+#### `config`
+- **Type**: `boolean`
+- **Default**: `false`
+
+
+#### `plugins`
+
+### `sourceMap`
+- **Type**: `undefined`
+- **Default**: `undefined`
+
+
+### `implementation`
+- **Type**: `undefined`
+- **Default**: `undefined`
+
+
+### `order`
+- **Type**: `string`
+- **Default**: `""`
+
+
+## `devMiddleware`
+
+### `stats`
+- **Type**: `string`
+- **Default**: `"none"`
+
+
+## `hotMiddleware`
+- **Type**: `WebpackHotMiddlewareMiddlewareOptions & { client?: WebpackHotMiddlewareClientOptions }`
+- **Default**: `{}`
+
+> See [webpack-hot-middleware](https://github.com/webpack-contrib/webpack-hot-middleware) for available options.
+
+
+## `friendlyErrors`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Set to `false` to disable the overlay provided by [FriendlyErrorsWebpackPlugin](https://www.npmjs.com/package/@d2js/friendly-errors-webpack-plugin).
+
+
+## `warningIgnoreFilters`
+- **Type**: `Array<(warn: WebpackWebpackError) => boolean>`
+- **Default**: `[]`
+
+> Filters to hide build warnings.