Nuxt/lib/core/module.js

149 lines
3.8 KiB
JavaScript
Raw Normal View History

2017-05-11 10:59:08 +00:00
import path from 'path'
import fs from 'fs'
2017-06-05 08:57:41 +00:00
import { uniq } from 'lodash'
import hash from 'hash-sum'
2017-06-16 12:42:45 +00:00
import { chainFn, sequence } from 'utils'
2017-06-18 09:35:00 +00:00
import Debug from 'debug'
2017-06-18 09:35:00 +00:00
const debug = Debug('nuxt:module')
2017-05-11 10:59:08 +00:00
2017-10-30 21:39:08 +00:00
export default class ModuleContainer {
2017-10-30 17:41:22 +00:00
constructor(nuxt) {
2017-05-11 10:04:15 +00:00
this.nuxt = nuxt
2017-05-11 10:59:08 +00:00
this.options = nuxt.options
2017-06-05 08:52:02 +00:00
this.requiredModules = []
2017-07-17 19:26:41 +00:00
}
2017-10-30 17:41:22 +00:00
async ready() {
2017-10-31 11:45:32 +00:00
await this.nuxt.callHook('modules:before', this, this.options.modules)
2017-10-30 17:41:22 +00:00
// Load every module in sequence
2017-07-17 19:26:41 +00:00
await sequence(this.options.modules, this.addModule.bind(this))
2017-10-30 21:39:08 +00:00
// Call done hook
await this.nuxt.callHook('modules:done', this)
2017-05-11 10:59:08 +00:00
}
2017-10-30 17:41:22 +00:00
addVendor(vendor) {
2017-05-14 23:01:41 +00:00
/* istanbul ignore if */
2017-05-11 10:59:08 +00:00
if (!vendor) {
return
}
this.options.build.vendor = uniq(this.options.build.vendor.concat(vendor))
}
2017-10-30 17:41:22 +00:00
addTemplate(template) {
2017-05-14 23:01:41 +00:00
/* istanbul ignore if */
if (!template) {
2017-05-11 10:59:08 +00:00
return
}
// Validate & parse source
const src = template.src || template
const srcPath = path.parse(src)
2017-05-14 22:33:31 +00:00
/* istanbul ignore if */
2017-05-11 10:59:08 +00:00
if (!src || typeof src !== 'string' || !fs.existsSync(src)) {
2017-06-19 15:47:31 +00:00
/* istanbul ignore next */
debug('[nuxt] invalid template', template)
2017-05-11 10:59:08 +00:00
return
}
// Generate unique and human readable dst filename
const dst = template.fileName ||
(path.basename(srcPath.dir) + '.' + srcPath.name + '.' + hash(src) + srcPath.ext)
// Add to templates list
const templateObj = {
src,
dst,
options: template.options
2017-05-11 10:59:08 +00:00
}
2017-05-11 18:47:53 +00:00
this.options.build.templates.push(templateObj)
return templateObj
}
2017-10-30 17:41:22 +00:00
addPlugin(template) {
2017-06-11 14:17:36 +00:00
const { dst } = this.addTemplate(template)
// Add to nuxt plugins
this.options.plugins.unshift({
2017-06-11 14:17:36 +00:00
src: path.join(this.options.buildDir, dst),
ssr: template.ssr
})
2017-05-11 10:59:08 +00:00
}
2017-10-30 17:41:22 +00:00
addServerMiddleware(middleware) {
2017-05-19 09:14:24 +00:00
this.options.serverMiddleware.push(middleware)
}
2017-10-30 17:41:22 +00:00
extendBuild(fn) {
2017-05-12 07:57:24 +00:00
this.options.build.extend = chainFn(this.options.build.extend, fn)
}
2017-10-30 17:41:22 +00:00
extendRoutes(fn) {
2017-05-12 07:57:24 +00:00
this.options.router.extendRoutes = chainFn(this.options.router.extendRoutes, fn)
2017-05-11 10:59:08 +00:00
}
2017-10-30 17:41:22 +00:00
requireModule(moduleOpts) {
2017-06-05 08:52:02 +00:00
// Require once
return this.addModule(moduleOpts, true)
}
2017-10-30 17:41:22 +00:00
async addModule(moduleOpts, requireOnce) {
2017-05-14 23:01:41 +00:00
/* istanbul ignore if */
2017-05-11 10:59:08 +00:00
if (!moduleOpts) {
return
}
2017-07-03 11:11:40 +00:00
// Allow using babel style array options
2017-05-31 14:58:36 +00:00
if (Array.isArray(moduleOpts)) {
moduleOpts = {
src: moduleOpts[0],
options: moduleOpts[1]
}
}
2017-07-03 11:11:40 +00:00
2017-05-11 10:59:08 +00:00
// Allows passing runtime options to each module
const options = moduleOpts.options || (typeof moduleOpts === 'object' ? moduleOpts : {})
2017-10-30 21:39:08 +00:00
const src = moduleOpts.src || moduleOpts
2017-07-03 11:11:40 +00:00
2017-05-11 10:59:08 +00:00
// Resolve module
2017-10-30 21:39:08 +00:00
let module
if (typeof src === 'string') {
module = require(this.nuxt.resolvePath(src))
2017-05-11 10:59:08 +00:00
}
2017-06-13 22:09:03 +00:00
2017-05-11 10:59:08 +00:00
// Validate module
2017-05-14 22:33:31 +00:00
/* istanbul ignore if */
2017-05-24 13:02:33 +00:00
if (typeof module !== 'function') {
2017-10-30 21:39:08 +00:00
throw new Error(`[nuxt] Module ${JSON.stringify(src)} should export a function`)
2017-05-11 10:59:08 +00:00
}
2017-07-03 11:11:40 +00:00
2017-06-05 08:52:02 +00:00
// Module meta
2017-10-30 21:39:08 +00:00
module.meta = module.meta || {}
let name = module.meta.name || module.name
// If requireOnce specified & module from NPM or with specified name
if (requireOnce && name) {
const alreadyRequired = this.requiredModules.indexOf(name) !== -1
if (alreadyRequired) {
2017-06-05 08:52:02 +00:00
return
}
this.requiredModules.push(name)
2017-06-05 08:52:02 +00:00
}
2017-07-03 11:11:40 +00:00
2017-05-11 10:59:08 +00:00
// Call module with `this` context and pass options
2017-10-30 21:39:08 +00:00
await new Promise((resolve, reject) => {
const result = module.call(this, options, (err) => {
2017-05-14 23:17:13 +00:00
/* istanbul ignore if */
2017-05-11 10:59:08 +00:00
if (err) {
return reject(err)
}
2017-10-30 21:39:08 +00:00
resolve()
2017-05-11 10:59:08 +00:00
})
// If module send back a promise
2017-05-11 19:04:50 +00:00
if (result && result.then instanceof Function) {
return result.then(resolve)
}
// If not expecting a callback but returns no promise (=synchronous)
if (module.length < 2) {
2017-10-30 21:39:08 +00:00
return resolve()
}
2017-05-11 10:59:08 +00:00
})
2017-05-11 10:04:15 +00:00
}
}