Nuxt/lib/core/nuxt.js

234 lines
5.6 KiB
JavaScript
Raw Normal View History

const Debug = require('debug')
const enableDestroy = require('server-destroy')
const Module = require('module')
const { isPlainObject } = require('lodash')
const chalk = require('chalk')
const { existsSync } = require('fs-extra')
const { Options } = require('../common')
2018-01-11 15:13:52 +00:00
const { sequence, printError, printWarn } = require('../common/utils')
2018-01-11 19:43:34 +00:00
const { resolve, join } = require('path')
const { version } = require('../../package.json')
const ModuleContainer = require('./module')
const Renderer = require('./renderer')
2017-06-20 11:44:47 +00:00
const debug = Debug('nuxt:')
debug.color = 5
2017-06-15 22:19:53 +00:00
module.exports = class Nuxt {
2017-10-30 17:41:22 +00:00
constructor(options = {}) {
this.options = Options.from(options)
this.initialized = false
2018-01-11 16:11:50 +00:00
this.onError = this.onError.bind(this)
2017-12-13 01:09:38 +00:00
2017-10-30 21:39:08 +00:00
// Hooks
this._hooks = {}
this.hook = this.hook.bind(this)
2017-06-11 14:17:36 +00:00
// Create instance of core components
2017-06-16 12:42:45 +00:00
this.moduleContainer = new ModuleContainer(this)
this.renderer = new Renderer(this)
2017-06-11 14:17:36 +00:00
// Backward compatibility
2018-01-11 16:11:50 +00:00
this.errorHandler = this.onError
this.render = this.renderer.app
2017-06-11 14:17:36 +00:00
this.renderRoute = this.renderer.renderRoute.bind(this.renderer)
2018-01-11 13:28:45 +00:00
this.renderAndGetWindow = this.renderer.renderAndGetWindow.bind(
this.renderer
)
2017-06-11 14:17:36 +00:00
2018-01-11 16:11:50 +00:00
this._ready = this.ready().catch(err => this.onError(err))
2017-06-11 14:17:36 +00:00
}
2017-11-30 10:24:06 +00:00
static get version() {
return version
2017-11-30 10:24:06 +00:00
}
2017-10-30 17:41:22 +00:00
async ready() {
2017-06-15 14:59:26 +00:00
if (this._ready) {
return this._ready
}
2017-06-13 22:09:03 +00:00
2017-10-31 11:33:15 +00:00
// Add hooks
if (isPlainObject(this.options.hooks)) {
this.addObjectHooks(this.options.hooks)
} else if (typeof this.options.hooks === 'function') {
2017-10-30 21:39:08 +00:00
this.options.hooks(this.hook)
}
2018-01-11 13:28:45 +00:00
// Await for modules
2017-10-30 17:41:22 +00:00
await this.moduleContainer.ready()
2018-01-11 13:28:45 +00:00
// Await for renderer to be ready
2017-10-30 17:41:22 +00:00
await this.renderer.ready()
2017-06-13 22:09:03 +00:00
2017-06-14 18:51:14 +00:00
this.initialized = true
2018-01-11 13:28:45 +00:00
// Call ready hook
2017-10-30 21:39:08 +00:00
await this.callHook('ready', this)
return this
2016-11-07 01:34:58 +00:00
}
plugin(name, fn) {
// A tiny backward compatibility util
2018-01-11 15:13:52 +00:00
const hook = {
2018-01-11 13:28:45 +00:00
ready: 'ready',
close: 'close',
listen: 'listen',
built: 'build:done'
2018-01-11 15:13:52 +00:00
}[name]
2018-01-11 15:13:52 +00:00
if (hook) {
this.hook(hook, fn)
printWarn(
`nuxt.plugin('${name}',..) is deprecated. Use new hooks system.`
)
} else {
throw new Error(
`nuxt.plugin('${name}',..) is not supported. Use new hooks system.`
)
}
// Always return nuxt class which has plugin() for two level hooks
return this
}
2017-10-30 21:39:08 +00:00
hook(name, fn) {
2017-10-31 11:33:15 +00:00
if (!name || typeof fn !== 'function') {
return
}
2017-10-30 21:39:08 +00:00
this._hooks[name] = this._hooks[name] || []
this._hooks[name].push(fn)
}
2018-01-11 16:11:50 +00:00
onError(err, from = 'Nuxt error') {
// Log error to the console if there is not any error listener
if (!this._hooks['error']) {
printError(err, from)
return
}
// Call error hooks
this.callHook('error', err, from)
}
2017-10-30 21:39:08 +00:00
async callHook(name, ...args) {
if (!this._hooks[name]) {
return
}
debug(`Call ${name} hooks (${this._hooks[name].length})`)
try {
2018-01-11 13:28:45 +00:00
await sequence(this._hooks[name], fn => fn(...args))
} catch (err) {
2018-01-11 16:11:50 +00:00
this.onError(err, name)
}
2017-10-30 21:39:08 +00:00
}
2017-10-31 11:33:15 +00:00
addObjectHooks(hooksObj) {
2018-01-11 13:28:45 +00:00
Object.keys(hooksObj).forEach(name => {
2017-10-31 11:33:15 +00:00
let hooks = hooksObj[name]
2018-01-11 13:28:45 +00:00
hooks = Array.isArray(hooks) ? hooks : [hooks]
2017-10-31 11:33:15 +00:00
2018-01-11 13:28:45 +00:00
hooks.forEach(hook => {
2017-10-31 11:33:15 +00:00
this.hook(name, hook)
})
})
}
2017-10-30 17:41:22 +00:00
listen(port = 3000, host = 'localhost') {
2017-06-20 11:44:47 +00:00
return new Promise((resolve, reject) => {
2018-01-11 13:28:45 +00:00
const server = this.renderer.app.listen(
{ port, host, exclusive: false },
err => {
/* istanbul ignore if */
if (err) {
return reject(err)
}
const _host = host === '0.0.0.0' ? 'localhost' : host
// eslint-disable-next-line no-console
console.log(
'\n' +
chalk.bgGreen.black(' OPEN ') +
chalk.green(` http://${_host}:${port}\n`)
)
// Close server on nuxt close
this.hook(
'close',
() =>
new Promise((resolve, reject) => {
// Destroy server by forcing every connection to be closed
server.destroy(err => {
debug('server closed')
/* istanbul ignore if */
if (err) {
return reject(err)
}
resolve()
})
})
)
this.callHook('listen', server, { port, host }).then(resolve)
2017-06-20 11:44:47 +00:00
}
2018-01-11 13:28:45 +00:00
)
2017-07-17 19:26:41 +00:00
2017-06-20 13:07:38 +00:00
// Add server.destroy(cb) method
enableDestroy(server)
2017-06-20 11:44:47 +00:00
})
}
2018-01-11 19:43:34 +00:00
resolveAlias(path) {
if (path.indexOf('@@') === 0 || path.indexOf('~~') === 0) {
return join(this.options.rootDir, path.substr(2))
}
if (path.indexOf('@') === 0 || path.indexOf('~') === 0) {
return join(this.options.srcDir, path.substr(1))
}
return resolve(this.options.srcDir, path)
}
2017-10-30 17:41:22 +00:00
resolvePath(path) {
// Try to resolve using NPM resolve path first
try {
const resolvedPath = Module._resolveFilename(path, {
2018-01-11 13:28:45 +00:00
paths: this.options.modulesDir
})
return resolvedPath
} catch (error) {
if (error.code === 'MODULE_NOT_FOUND') {
// Continue to try other methods
} else {
throw error
}
}
2018-01-11 13:28:45 +00:00
2018-01-11 19:43:34 +00:00
let _path = this.resolveAlias(path)
if (existsSync(_path)) {
return _path
}
2018-01-11 13:28:45 +00:00
2018-01-11 19:43:34 +00:00
for (let ext of this.options.extensions) {
if (existsSync(_path + '.' + ext)) {
return _path + '.' + ext
}
}
2018-01-11 19:43:34 +00:00
throw new Error(`Cannot resolve "${path}" from "${_path}"`)
}
2017-10-30 17:41:22 +00:00
async close(callback) {
2017-10-30 21:39:08 +00:00
await this.callHook('close', this)
2017-06-20 13:12:33 +00:00
/* istanbul ignore if */
2017-06-15 22:19:53 +00:00
if (typeof callback === 'function') {
2017-06-16 12:42:45 +00:00
await callback()
2017-06-15 22:19:53 +00:00
}
2016-11-07 01:34:58 +00:00
}
}