# Configuration

vue-up uses JoyCon (opens new window) to load configuration file.

These is config files that will be loaded in vue-up:

  • vue-up.config.js
  • vue-up.config.json
  • vue-up.config.yaml
  • vue-up.config.yml
  • vue-up.config.ts

.yaml, .yml are loaded by joycon-yaml-loader (opens new window)
.ts is loaded by joycon-ts-loader (opens new window)

# entry Required

Type: string

Bundle's entry point.

# libraryName Required

Type: string

Library's name.

# fileName

Type: string

Name of output bundled files (without extension).

TIP

If it isn't provided, vue-up will generate file name from libraryName by slugify (opens new window).

# outDir

Type: string
Default: dist

Output directory.

# cleanOutDir

Type: boolean
Default: true

Clean output directory before bundling.

# alias

Type: { [key: string]: string }

Alias to path.

TIP

vue-up provides @ as alias to your ./src directory out of the box.

# define

Type: { [key: string]: any }

Define global constants to apply at compile time.

TIP

process.env.NODE_ENV is automatically defined to production.

# sourceMap

Type: boolean
Default: true

Use source map?

# externals

Type: { module: ExternalOption, web: ExternalOption }
Default: { module: nodeExternals(), web: ['vue'] }

External dependencies. (Rollup's external (opens new window))

module is the external dependencies for CommonJS, ES module and SSR bundles.
web is the external dependencies for web bundles.

TIP

nodeExternals is an internal vue-up's function that create a function to exclude dependencies in node_modules directory from bundle.

TIP

web will always include 'vue' even though you haven't added it.

# globals

Type: { [key: string]: string }

Global variables of external dependencies. (Rollup's output.globals (opens new window))

# dev

Type: DevOptions

Options for development server.