Nuxt/lib/module.js

136 lines
3.6 KiB
JavaScript
Raw Normal View History

2017-05-11 10:04:15 +00:00
'use strict'
2017-05-11 10:59:08 +00:00
import path from 'path'
import fs from 'fs'
import {uniq} from 'lodash'
import hash from 'hash-sum'
2017-05-12 07:57:24 +00:00
import {chainFn} from './utils'
2017-05-11 10:59:08 +00:00
2017-05-11 10:04:15 +00:00
class Module {
constructor (nuxt) {
this.nuxt = nuxt
2017-05-11 10:59:08 +00:00
this.options = nuxt.options
this.modules = []
2017-05-11 10:59:08 +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))
}
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)) {
// eslint-disable-next-line no-console
console.warn('[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
}
addPlugin (template) {
const {dst} = this.addTemplate(template)
// Add to nuxt plugins
this.options.plugins.push({
src: '~/.nuxt/' + dst,
ssr: template.ssr
})
2017-05-11 10:59:08 +00:00
}
addServerMiddleware (middleware) {
2017-05-19 09:14:24 +00:00
this.options.serverMiddleware.push(middleware)
}
2017-05-12 07:57:24 +00:00
extendBuild (fn) {
this.options.build.extend = chainFn(this.options.build.extend, fn)
}
extendRoutes (fn) {
this.options.router.extendRoutes = chainFn(this.options.router.extendRoutes, fn)
2017-05-11 10:59:08 +00:00
}
requireModule (moduleOpts) {
if (this.modules.indexOf(moduleOpts) !== -1 || this.modules.indexOf(moduleOpts.src) !== -1) {
2017-05-20 09:17:14 +00:00
return false
}
2017-05-21 16:12:28 +00:00
this.modules.push(moduleOpts.src || moduleOpts)
2017-05-20 09:17:14 +00:00
return this.addModule(moduleOpts)
}
addModule (moduleOpts) {
2017-05-14 23:01:41 +00:00
/* istanbul ignore if */
2017-05-11 10:59:08 +00:00
if (!moduleOpts) {
return
}
// Allows passing runtime options to each module
const options = moduleOpts.options || {}
const originalSrc = moduleOpts.src || moduleOpts
let src = originalSrc
2017-05-11 10:59:08 +00:00
// Resolve module
let module
try {
if (typeof src === 'string') {
// Using ~ or ./ shorthand modules are resolved from project srcDir
if (src.indexOf('~') === 0 || src.indexOf('./') === 0) {
src = path.join(this.options.srcDir, src.substr(1))
2017-05-11 10:59:08 +00:00
}
2017-05-11 11:58:20 +00:00
// eslint-disable-next-line no-eval
module = eval('require')(src)
2017-05-11 10:59:08 +00:00
}
2017-05-14 23:01:41 +00:00
} catch (e) /* istanbul ignore next */ {
2017-05-11 10:59:08 +00:00
// eslint-disable-next-line no-console
console.error('[nuxt] Unable to resolve module', src)
2017-05-11 10:59:08 +00:00
// eslint-disable-next-line no-console
console.error(e)
2017-05-21 15:41:00 +00:00
process.exit(0)
2017-05-11 10:59:08 +00:00
}
// Validate module
2017-05-14 22:33:31 +00:00
/* istanbul ignore if */
2017-05-11 10:59:08 +00:00
if (!(module instanceof Function)) {
// eslint-disable-next-line no-console
console.error(`[nuxt] Module [${originalSrc}] should export a function`)
process.exit(1)
2017-05-11 10:59:08 +00:00
}
// Call module with `this` context and pass options
return new Promise((resolve, reject) => {
2017-05-11 19:04:50 +00:00
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)
}
resolve(module)
})
// 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) {
return resolve(module)
}
2017-05-11 10:59:08 +00:00
})
2017-05-11 10:04:15 +00:00
}
}
export default Module