Nuxt/lib/common/options.js

342 lines
9.3 KiB
JavaScript
Raw Normal View History

import _ from 'lodash'
import Debug from 'debug'
import { join, resolve } from 'path'
import { existsSync } from 'fs'
2017-08-15 01:06:56 +00:00
import { isUrl, isPureObject } from 'utils'
const debug = Debug('nuxt:build')
debug.color = 2 // Force green color
const Options = {}
export default Options
Options.from = function (_options) {
// Clone options to prevent unwanted side-effects
const options = Object.assign({}, _options)
// Normalize options
if (options.loading === true) {
delete options.loading
}
if (options.router && options.router.middleware && !Array.isArray(options.router.middleware)) {
options.router.middleware = [options.router.middleware]
}
if (options.router && typeof options.router.base === 'string') {
options._routerBaseSpecified = true
}
if (typeof options.transition === 'string') {
options.transition = { name: options.transition }
}
2017-09-08 10:42:00 +00:00
if (typeof options.layoutTransition === 'string') {
options.layoutTransition = { name: options.layoutTransition }
}
const hasValue = v => typeof v === 'string' && v
options.rootDir = hasValue(options.rootDir) ? options.rootDir : process.cwd()
// Apply defaults by ${buildDir}/dist/build.config.js
const buildDir = options.buildDir || Options.defaults.buildDir
const buildConfig = resolve(options.rootDir, buildDir, 'build.config.js')
if (existsSync(buildConfig)) {
_.defaultsDeep(options, require(buildConfig))
}
// Apply defaults
2017-07-30 12:20:58 +00:00
_.defaultsDeep(options, Options.defaults)
// Resolve dirs
options.srcDir = hasValue(options.srcDir) ? resolve(options.rootDir, options.srcDir) : options.rootDir
options.buildDir = resolve(options.rootDir, options.buildDir)
options.cacheDir = resolve(options.rootDir, options.cacheDir)
2017-11-24 09:40:01 +00:00
// Normalize modulesDir
2017-11-24 15:44:07 +00:00
/* istanbul ignore if */
if (!options.modulesDir) {
2017-11-24 09:40:01 +00:00
options.modulesDir = ['node_modules']
}
if (!Array.isArray(options.modulesDir)) {
options.modulesDir = [options.modulesDir]
}
2017-11-24 09:40:01 +00:00
options.modulesDir = options.modulesDir.filter(dir => hasValue(dir)).map(dir => resolve(options.rootDir, dir))
2017-11-24 09:16:17 +00:00
// If app.html is defined, set the template path to the user template
2017-06-16 12:42:45 +00:00
options.appTemplatePath = resolve(options.buildDir, 'views/app.template.html')
if (existsSync(join(options.srcDir, 'app.html'))) {
options.appTemplatePath = join(options.srcDir, 'app.html')
}
2017-06-14 17:32:25 +00:00
// Ignore publicPath on dev
2017-06-19 15:47:31 +00:00
/* istanbul ignore if */
2017-06-14 17:32:25 +00:00
if (options.dev && isUrl(options.build.publicPath)) {
2017-07-30 12:20:58 +00:00
options.build.publicPath = Options.defaults.build.publicPath
2017-06-14 17:32:25 +00:00
}
// If store defined, update store options to true unless explicitly disabled
if (options.store !== false && existsSync(join(options.srcDir, 'store'))) {
2017-06-14 17:38:07 +00:00
options.store = true
2017-06-14 17:32:25 +00:00
}
2017-08-18 10:26:19 +00:00
// Normalize loadingIndicator
if (!isPureObject(options.loadingIndicator)) {
options.loadingIndicator = { name: options.loadingIndicator }
}
// Apply defaults to loadingIndicator
options.loadingIndicator = Object.assign({
name: 'pulse',
2017-09-02 20:03:48 +00:00
color: '#dbe1ec',
2017-08-18 10:26:19 +00:00
background: 'white'
}, options.loadingIndicator)
2017-08-20 08:38:38 +00:00
// cssSourceMap
if (options.build.cssSourceMap === undefined) {
options.build.cssSourceMap = options.dev
}
2017-08-15 01:06:56 +00:00
// Postcss
// 1. Check if it is explicitly disabled by false value
// ... Disable all postcss loaders
// 2. Check if any standard source of postcss config exists
// ... Make postcss = { config: { path } }
2017-08-15 01:06:56 +00:00
// 3. Else (Easy Usage)
// ... Auto merge it with defaults
if (options.build.postcss !== false) {
// Detect postcss config existence
// https://github.com/michael-ciniawsky/postcss-load-config
let postcssConfigPath
2017-08-15 01:06:56 +00:00
for (let dir of [options.srcDir, options.rootDir]) {
for (let file of ['postcss.config.js', '.postcssrc.js', '.postcssrc', '.postcssrc.json', '.postcssrc.yaml']) {
if (existsSync(resolve(dir, file))) {
postcssConfigPath = resolve(dir, file)
2017-08-15 01:06:56 +00:00
break
}
}
if (postcssConfigPath) break
2017-08-15 01:06:56 +00:00
}
// Default postcss options
if (postcssConfigPath) {
debug(`Using PostCSS config file: ${postcssConfigPath}`)
options.build.postcss = {
2017-08-15 01:06:56 +00:00
sourceMap: options.build.cssSourceMap,
// https://github.com/postcss/postcss-loader/blob/master/lib/index.js#L79
config: {
path: postcssConfigPath
2017-08-15 01:06:56 +00:00
}
}
} else {
if (Object.keys(options.build.postcss).length) {
debug('Using PostCSS config from `build.postcss`')
}
// Normalize & Apply default plugins
if (Array.isArray(options.build.postcss)) {
options.build.postcss = { plugins: options.build.postcss }
}
if (isPureObject(options.build.postcss)) {
options.build.postcss = Object.assign({
sourceMap: options.build.cssSourceMap,
plugins: {
// https://github.com/postcss/postcss-import
'postcss-import': {
root: options.rootDir,
path: [
options.srcDir,
options.rootDir,
2017-11-24 09:16:17 +00:00
...options.modulesDir
]
},
// https://github.com/postcss/postcss-url
'postcss-url': {},
// http://cssnext.io/postcss
'postcss-cssnext': {}
}
}, options.build.postcss)
}
2017-08-15 01:06:56 +00:00
}
2017-08-14 21:13:08 +00:00
}
// Debug errors
if (options.debug === undefined) {
options.debug = options.dev
}
2017-08-19 13:22:53 +00:00
// Apply mode preset
let modePreset = Options.modes[options.mode || 'universal'] || Options.modes['universal']
_.defaultsDeep(options, modePreset)
2017-07-11 00:24:39 +00:00
2017-08-18 13:44:34 +00:00
// If no server-side rendering, add appear true transition
2017-11-24 15:44:07 +00:00
/* istanbul ignore if */
if (options.render.ssr === false && options.transition) {
2017-08-18 13:44:34 +00:00
options.transition.appear = true
}
return options
}
2017-07-30 12:20:58 +00:00
Options.modes = {
2017-07-11 00:24:39 +00:00
universal: {
build: {
ssr: true
},
render: {
ssr: true
}
},
spa: {
build: {
ssr: false
},
render: {
ssr: false
}
}
}
Options.unsafeKeys = [
'rootDir', 'srcDir', 'buildDir', 'modulesDir', 'cacheDir', 'nuxtDir',
'nuxtAppDir', 'build', 'generate', 'router.routes', 'appTemplatePath'
]
2017-07-30 12:20:58 +00:00
Options.defaults = {
2017-07-11 00:24:39 +00:00
mode: 'universal',
dev: process.env.NODE_ENV !== 'production',
debug: undefined, // Will be equal to dev if not provided
2017-06-11 14:17:36 +00:00
buildDir: '.nuxt',
cacheDir: '.cache',
nuxtDir: resolve(__dirname, '..'), // Relative to dist
2017-06-18 13:48:25 +00:00
nuxtAppDir: resolve(__dirname, '../lib/app/'), // Relative to dist
2017-06-11 14:17:36 +00:00
build: {
analyze: false,
dll: false,
scopeHoisting: false,
2017-06-11 14:17:36 +00:00
extractCSS: false,
cssSourceMap: undefined,
2017-07-11 00:24:39 +00:00
ssr: undefined,
2017-11-24 15:32:05 +00:00
uglify: {},
2017-06-11 14:17:36 +00:00
publicPath: '/_nuxt/',
filenames: {
css: 'vendor.[contenthash].css',
2017-06-11 14:17:36 +00:00
manifest: 'manifest.[hash].js',
vendor: 'vendor.[chunkhash].js',
2017-08-16 10:36:27 +00:00
app: 'app.[chunkhash].js',
chunk: '[name].[chunkhash].js'
2017-06-11 14:17:36 +00:00
},
vendor: [],
plugins: [],
babel: {},
2017-08-15 01:06:56 +00:00
postcss: {},
2017-06-11 14:17:36 +00:00
templates: [],
watch: [],
devMiddleware: {},
hotMiddleware: {}
2017-06-11 14:17:36 +00:00
},
generate: {
dir: 'dist',
routes: [],
2017-07-09 10:00:08 +00:00
concurrency: 500,
2017-06-11 14:17:36 +00:00
interval: 0,
2017-11-06 07:36:28 +00:00
subFolders: true,
2017-06-11 14:17:36 +00:00
minify: {
collapseBooleanAttributes: true,
collapseWhitespace: false,
2017-06-11 14:17:36 +00:00
decodeEntities: true,
minifyCSS: true,
minifyJS: true,
processConditionalComments: true,
removeAttributeQuotes: false,
removeComments: false,
removeEmptyAttributes: true,
removeOptionalTags: true,
removeRedundantAttributes: true,
removeScriptTypeAttributes: false,
removeStyleLinkTypeAttributes: false,
removeTagWhitespace: false,
sortAttributes: true,
sortClassName: false,
2017-06-11 14:17:36 +00:00
trimCustomFragments: true,
useShortDoctype: true
}
},
env: {},
head: {
meta: [],
link: [],
style: [],
script: []
},
plugins: [],
css: [],
modules: [],
layouts: {},
serverMiddleware: [],
ErrorPage: null,
loading: {
color: 'black',
failedColor: 'red',
height: '2px',
2017-08-29 11:58:45 +00:00
duration: 5000,
rtl: false
2017-06-11 14:17:36 +00:00
},
2017-08-18 10:29:37 +00:00
loadingIndicator: {},
2017-06-11 14:17:36 +00:00
transition: {
name: 'page',
2017-08-18 13:44:34 +00:00
mode: 'out-in',
2017-08-18 14:47:01 +00:00
appear: false,
appearClass: 'appear',
appearActiveClass: 'appear-active',
appearToClass: 'appear-to'
2017-06-11 14:17:36 +00:00
},
2017-09-08 10:42:00 +00:00
layoutTransition: {
name: 'layout',
mode: 'out-in'
},
2017-06-11 14:17:36 +00:00
router: {
mode: 'history',
base: '/',
2017-06-13 17:58:04 +00:00
routes: [],
2017-06-11 14:17:36 +00:00
middleware: [],
linkActiveClass: 'nuxt-link-active',
linkExactActiveClass: 'nuxt-link-exact-active',
extendRoutes: null,
2017-07-04 16:30:01 +00:00
scrollBehavior: null,
parseQuery: false,
stringifyQuery: false,
2017-07-04 16:30:01 +00:00
fallback: false
2017-06-11 14:17:36 +00:00
},
render: {
2017-07-04 21:50:43 +00:00
bundleRenderer: {},
2017-06-20 12:48:25 +00:00
resourceHints: true,
2017-07-11 00:24:39 +00:00
ssr: undefined,
2017-06-11 14:17:36 +00:00
http2: {
push: false
},
static: {},
gzip: {
threshold: 0
},
etag: {
weak: true // Faster for responses > 5KB
}
},
watchers: {
webpack: {
ignored: /-dll/
},
2017-06-11 14:17:36 +00:00
chokidar: {}
},
2017-09-09 20:21:51 +00:00
editor: {
editor: 'code'
},
2017-10-31 11:33:15 +00:00
hooks: null,
messages: {
2017-09-01 16:40:01 +00:00
error_404: 'This page could not be found',
2017-09-01 16:30:49 +00:00
server_error: 'Server error',
nuxtjs: 'Nuxt.js',
back_to_home: 'Back to the home page',
server_error_details: 'An error occurred in the application and your page could not be served. If you are the application owner, check your logs for details.',
client_error: 'Error',
client_error_details: 'An error occurred while rendering the page. Check developer tools console for details.',
redirect: 'Redirecting to external page.'
2017-06-11 14:17:36 +00:00
}
}