@nextcloud/vite-config
    Preparing search index...

    Interface LibraryOptions

    SPDX-FileCopyrightText: 2023 Ferdinand Thiessen opensource@fthiessen.de

    SPDX-License-Identifier: AGPL-3.0-or-later

    interface LibraryOptions {
        assetFileNames?: (chunkInfo: PreRenderedAsset) => string;
        config?: UserConfigExport;
        coreJS?: CoreJSPluginOptions;
        cssFileName?: string;
        DTSPluginOptions?: false | PluginOptions;
        inlineCSS?: boolean;
        libraryFormats?: LibraryFormats[];
        minify?: boolean;
        nodeExternalsOptions?: ExternalsOptions;
        nodePolyfills?: boolean | PolyfillOptions;
        replace?: Record<string, string>;
        thirdPartyLicense?: string | false;
    }

    Hierarchy (View Summary)

    Index

    Properties

    assetFileNames? config? coreJS? cssFileName? DTSPluginOptions? inlineCSS? libraryFormats? minify? nodeExternalsOptions? nodePolyfills? replace? thirdPartyLicense?

    Properties

    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.

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

    Vite config to override or extend the base config

    coreJS?: CoreJSPluginOptions

    Enable and adjust settings for core-js polyfills

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

    cssFileName?: string

    Filename of the css output when a single CSS file should be extracted (inlineCSS: false) Note this only works with Vite 6.

    style.css

    DTSPluginOptions?: false | PluginOptions

    Options for the Vite DTS plugin

    This plugin allows to create .d.ts files for your library including the .vue files Pass false to disable the plugin

    inlineCSS?: boolean

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

    false
    libraryFormats?: LibraryFormats[]

    Formats you like your library to be built

    ['es']
    minify?: boolean

    Whether to minify the output

    false For libraries the code is not minified by default for better DX. Usually it is not needed: a library will be minified as a part of an app bundling.
    nodeExternalsOptions?: ExternalsOptions

    Options for the rollup node externals plugin

    By default all dependencies and peerDependencies are marked as external. And node builtins prefix (node:) is stripped to make the library compatible with webpack and node-polyfill-webpack-plugin.

    Note: If you use dependencies @nextcloud/vue/dist/Components/NcButton.js and what them to be externalized too, you need to set an include pattern: { include: [ /^@nextcloud/vue/ ]}

    nodePolyfills?: boolean | PolyfillOptions

    Inject polyfills for node packages

    false Disabled to reduce buildtime
    replace?: Record<string, string>

    Strings to replace within your code

    thirdPartyLicense?: string | false

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

    'dist/vendor.LICENSE.txt'

    Settings

    Member Visibility

    On This Page

    Properties