Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(common): nuxt.config.js and dynamic server options (latest process.env) #4208

Merged
merged 27 commits into from
Oct 27, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 7 additions & 26 deletions packages/cli/src/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ import { existsSync } from 'fs'
import consola from 'consola'
import esm from 'esm'
import wrapAnsi from 'wrap-ansi'
import defaultsDeep from 'lodash/defaultsDeep'
import { nuxtServerConfig } from '@nuxt/common'

const _require = esm(module, {
cache: false,
Expand All @@ -15,24 +17,6 @@ const _require = esm(module, {

const getRootDir = argv => path.resolve(argv._[0] || '.')
const getNuxtConfigFile = argv => path.resolve(getRootDir(argv), argv['config-file'])
const getLatestHost = (argv) => {
const port =
argv.port ||
process.env.NUXT_PORT ||
process.env.PORT ||
process.env.npm_package_config_nuxt_port
const host =
argv.hostname ||
process.env.NUXT_HOST ||
process.env.HOST ||
process.env.npm_package_config_nuxt_host
const socket =
argv['unix-socket'] ||
process.env.UNIX_SOCKET ||
process.env.npm_package_config_unix_socket

return { port, host, socket }
}

export async function loadNuxtConfig(argv) {
const rootDir = getRootDir(argv)
Expand Down Expand Up @@ -70,14 +54,11 @@ export async function loadNuxtConfig(argv) {
(argv.spa && 'spa') || (argv.universal && 'universal') || options.mode

// Server options
if (!options.server) {
options.server = {}
}

const { port, host, socket } = getLatestHost(argv)
options.server.port = port || options.server.port || 3000
options.server.host = host || options.server.host || 'localhost'
options.server.socket = socket || options.server.socket
options.server = defaultsDeep({
port: argv.port || undefined,
host: argv.hostname || undefined,
socket: argv['unix-socket'] || undefined
}, options.server || {}, nuxtServerConfig(process.env))

return options
}
Expand Down
24 changes: 10 additions & 14 deletions packages/cli/test/unit/utils.test.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { nuxtServerConfig } from '@nuxt/common'
import { consola } from '../utils'
import * as utils from '../../src/utils'

Expand Down Expand Up @@ -81,24 +82,19 @@ describe('cli/utils', () => {
expect(consola.fatal).toHaveBeenCalledWith('Error while fetching async configuration')
})

test('loadNuxtConfig: server env', async () => {
const env = process.env

process.env.HOST = 'env-host'
process.env.PORT = 3003
process.env.UNIX_SOCKET = '/var/run/env.sock'

const argv = {
_: [__dirname],
'config-file': '../fixtures/nuxt.config.js'
test('nuxtServerConfig: server env', () => {
const options = {
server: nuxtServerConfig({
...process.env,
HOST: 'env-host',
PORT: 3003,
UNIX_SOCKET: '/var/run/env.sock'
})
}

const options = await utils.loadNuxtConfig(argv)
expect(options.server.host).toBe('env-host')
expect(options.server.port).toBe('3003')
expect(options.server.port).toBe(3003)
expect(options.server.socket).toBe('/var/run/env.sock')

process.env = env
})

test('indent', () => {
Expand Down
112 changes: 112 additions & 0 deletions packages/common/src/config/build.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
import env from 'std-env'

export default {
quiet: Boolean(env.ci || env.test),
analyze: false,
profile: process.argv.includes('--profile'),
extractCSS: false,
cssSourceMap: undefined,
ssr: undefined,
parallel: false,
cache: false,
publicPath: '/_nuxt/',
filenames: {
// { isDev, isClient, isServer }
app: ({ isDev }) => isDev ? '[name].js' : '[chunkhash].js',
chunk: ({ isDev }) => isDev ? '[name].js' : '[chunkhash].js',
css: ({ isDev }) => isDev ? '[name].css' : '[contenthash].css',
img: ({ isDev }) => isDev ? '[path][name].[ext]' : 'img/[hash:7].[ext]',
font: ({ isDev }) => isDev ? '[path][name].[ext]' : 'fonts/[hash:7].[ext]',
video: ({ isDev }) => isDev ? '[path][name].[ext]' : 'videos/[hash:7].[ext]'
},
loaders: {
file: {},
fontUrl: { limit: 1000 },
imgUrl: { limit: 1000 },
pugPlain: {},
vue: {
transformAssetUrls: {
video: 'src',
source: 'src',
object: 'src',
embed: 'src'
}
},
css: {},
cssModules: {
localIdentName: '[local]_[hash:base64:5]'
},
less: {},
sass: {
indentedSyntax: true
},
scss: {},
stylus: {},
vueStyle: {}
},
styleResources: {},
plugins: [],
terser: {},
optimizeCSS: undefined,
optimization: {
runtimeChunk: 'single',
minimize: undefined,
minimizer: undefined,
splitChunks: {
chunks: 'all',
automaticNameDelimiter: '.',
name: undefined,
cacheGroups: {}
}
},
splitChunks: {
layouts: false,
pages: true,
commons: true
},
babel: {
babelrc: false,
cacheDirectory: undefined
},
transpile: [], // Name of NPM packages to be transpiled
postcss: {
preset: {
// https://cssdb.org/#staging-process
stage: 2
}
},
html: {
minify: {
collapseBooleanAttributes: true,
decodeEntities: true,
minifyCSS: true,
minifyJS: true,
processConditionalComments: true,
removeEmptyAttributes: true,
removeRedundantAttributes: true,
trimCustomFragments: true,
useShortDoctype: true
}
},

template: undefined,
templates: [],

watch: [],
devMiddleware: {},
hotMiddleware: {},

stats: {
chunks: false,
children: false,
modules: false,
colors: true,
warnings: true,
errors: true,
excludeAssets: [
/.map$/,
/index\..+\.html$/,
/vue-ssr-client-manifest.json/
]
}
}
128 changes: 128 additions & 0 deletions packages/common/src/config/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
import path from 'path'
import fs from 'fs'
import capitalize from 'lodash/capitalize'
import env from 'std-env'

import render from './render'
import build from './build'
import router from './router'
import messages from './messages'
import server from './server'

const nuxtDir = fs.existsSync(path.resolve(__dirname, '..', '..', 'package.js'))
? path.resolve(__dirname, '..', '..') // src
: path.resolve(__dirname, '..') // dist

export default {
// Information about running environment
dev: Boolean(env.dev),
test: Boolean(env.test),
debug: undefined, // = dev

// Mode
mode: 'universal',

// Global name
globalName: `nuxt`,
globals: {
id: globalName => `__${globalName}`,
nuxt: globalName => `$${globalName}`,
context: globalName => `__${globalName.toUpperCase()}__`,
pluginPrefix: globalName => globalName,
readyCallback: globalName => `on${capitalize(globalName)}Ready`,
loadedCallback: globalName => `_on${capitalize(globalName)}Loaded`
},

render,
build,
router,
messages,

// Server options
server: server(process.env),

// Dirs
srcDir: undefined,
buildDir: '.nuxt',
nuxtDir,
modulesDir: [
'node_modules'
],

// Ignore
ignorePrefix: '-',
ignore: [
'**/*.test.*',
'**/*.spec.*'
],

extensions: [],

generate: {
dir: 'dist',
routes: [],
concurrency: 500,
interval: 0,
subFolders: true,
fallback: '200.html'
},
env: {},
head: {
meta: [],
link: [],
style: [],
script: []
},
plugins: [],
css: [],
modules: [],
layouts: {},
serverMiddleware: [],
ErrorPage: null,
loading: {
color: 'black',
failedColor: 'red',
height: '2px',
throttle: 200,
duration: 5000,
rtl: false
},
loadingIndicator: 'default',
transition: {
name: 'page',
mode: 'out-in',
appear: false,
appearClass: 'appear',
appearActiveClass: 'appear-active',
appearToClass: 'appear-to'
},
layoutTransition: {
name: 'layout',
mode: 'out-in'
},
dir: {
assets: 'assets',
layouts: 'layouts',
middleware: 'middleware',
pages: 'pages',
static: 'static',
store: 'store'
},
vue: {
config: {
silent: undefined, // = !dev
performance: undefined // = dev
}
},

// User-defined changes
watch: [],
watchers: {
webpack: {},
chokidar: {
ignoreInitial: true
}
},
editor: undefined,
hooks: null
}
12 changes: 12 additions & 0 deletions packages/common/src/config/messages.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
export default {
loading: 'Loading...',
error_404: 'This page could not be found',
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.'
}
27 changes: 27 additions & 0 deletions packages/common/src/config/render.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
export default {
bundleRenderer: {
shouldPrefetch: () => false
},
resourceHints: true,
ssr: undefined,
http2: {
push: false,
shouldPush: null
},
static: {
prefix: true
},
compressor: {
threshold: 0
},
etag: {
weak: false
},
csp: false,
dist: {
// Don't serve index.html template
index: false,
// 1 year in production
maxAge: '1y'
}
}
13 changes: 13 additions & 0 deletions packages/common/src/config/router.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
export default {
mode: 'history',
base: '/',
routes: [],
middleware: [],
linkActiveClass: 'nuxt-link-active',
linkExactActiveClass: 'nuxt-link-exact-active',
extendRoutes: null,
scrollBehavior: null,
parseQuery: false,
stringifyQuery: false,
fallback: false
}
Loading