Interface AppOptions

interface AppOptions {
    appName?: string;
    assetFileNames?: ((chunkInfo: PreRenderedAsset) => string);
    assetsPrefix?: string;
    config?: UserConfigExport;
    coreJS?: CoreJSPluginOptions;
    createEmptyCSSEntryPoints?: boolean;
    emptyOutputDirectory?: boolean | EmptyJSDirPluginOptions;
    extractLicenseInformation?: true | REUSELicensesPluginOptions;
    inlineCSS?: boolean | PluginConfiguration;
    minify?: boolean;
    nodePolyfills?: boolean | PolyfillOptions;
    replace?: Record<string, string>;
    thirdPartyLicense?: string | false;
}

Hierarchy

Properties

appName? assetFileNames? assetsPrefix? config? coreJS? createEmptyCSSEntryPoints? emptyOutputDirectory? extractLicenseInformation? inlineCSS? minify? nodePolyfills? replace? thirdPartyLicense?

Properties

OptionalappName

appName?: string

Override the appName, by default the name from the appinfo/info.xml and if not found the name from package.json is used. But if that name differs from the app id used for the Nextcloud app you need to override it.

OptionalassetFileNames

assetFileNames?: ((chunkInfo: PreRenderedAsset) => string)

Customize the asset file names. Similar to output.assetFileNames in rollup config, but if returns undefined, then this config defaults is be used.

Example

Move CSS styles to `styles/style.css` instead of the default `css/[entrypoint-name].css`:
         (chunkInfo) => chunkInfo.name.endsWith('.css') ? 'styles/style.css' : undefined

OptionalassetsPrefix

assetsPrefix?: string

Prefix to use for assets and chunks

Default

'{appName}-'

Optionalconfig

config?: UserConfigExport

Vite config to override or extend the base config

OptionalcoreJS

coreJS?: CoreJSPluginOptions

Enable and adjust settings for core-js polyfills

By default disabled as Nextcloud core already includes the core-js/stable polyfills globally

OptionalcreateEmptyCSSEntryPoints

createEmptyCSSEntryPoints?: boolean

When not using inline css and using cssCodeSplit this option allows to create one CSS entry file for each JS entry point instead of only one for each JS entry point with styles.

Default

false

OptionalemptyOutputDirectory

emptyOutputDirectory?: boolean | EmptyJSDirPluginOptions

Whether to empty the 'js' directory Pass false to disable clearing the directory, it is also possible to pass options to the plugin.

Default

true

OptionalextractLicenseInformation

extractLicenseInformation?: true | REUSELicensesPluginOptions

Extract license information from built assets into .license files This is needed to be REUSE complient

OptionalinlineCSS

inlineCSS?: boolean | PluginConfiguration

Inject all styles inside the javascript bundle instead of emitting a .css file

Default

false

Optionalminify

minify?: boolean

Whether to minify the output

Default

isProduction Minify on production, do not on development

OptionalnodePolyfills

nodePolyfills?: boolean | PolyfillOptions

Inject polyfills for node packages By default all node core modules are polyfilled, including prefixed with node: protocol

Default

'{ protocolImports: true }'

Optionalreplace

replace?: Record<string, string>

Strings to replace within your code

OptionalthirdPartyLicense

thirdPartyLicense?: string | false

Location of license summary file of third party dependencies Pass false to disable generating a license file.

Default

'js/vendor.LICENSE.txt'

Settings

Member Visibility

On This Page

Properties