add advanced dependency checking (fixes vuejs#81) (vuejs#83)

paulpflug · yyx990803 · commit 7683c39b5d2f · 2016-05-05T15:54:43.000-04:00
* added advanced dependency checking for babel as an example

* fixes

* fixed babel-runtime require

* replaced peerDependencies with checks &amp; warning for missing modules

* bugfix

* spelling

* added test for missing dependencies
diff --git a/lib/compiler.js b/lib/compiler.js
@@ -12,6 +12,7 @@ var chalk = require('chalk')
 var assign = require('object-assign')
 var deindent = require('de-indent')
 var Emitter = require('events').EventEmitter
+var ensureRequire = require('./ensure-require.js')
 
 var htmlMinifyOptions = {
   collapseWhitespace: true,
@@ -110,6 +111,7 @@ compiler.compile = function (content, filePath, cb) {
     // styles
     var style = extract(parts, 'style')
     if (style) {
+      ensureRequire('styles','vueify-insert-css')
       style = JSON.stringify(style)
       output +=
         'var __vueify_style__ = require("vueify-insert-css").insert(' + style + ')\n'
@@ -132,6 +134,7 @@ compiler.compile = function (content, filePath, cb) {
     }
     // hot reload
     if (process.env.NODE_ENV !== 'production' && !process.env.VUEIFY_TEST) {
+      ensureRequire('hot-reload','vue-hot-reload-api')
       output +=
         'if (module.hot) {(function () {' +
         '  module.hot.accept()\n' +
diff --git a/lib/compilers/babel.js b/lib/compilers/babel.js
@@ -1,6 +1,8 @@
 var options = require('./options')
+var ensureRequire = require('../ensure-require.js')
 
 module.exports = function (raw, cb) {
+  ensureRequire('babel',['babel-core','babel-preset-es2015','babel-plugin-transform-runtime',['babel-runtime/core-js.js','babel-runtime']])
   try {
     var babel = require('babel-core')
     var res = babel.transform(raw, options.babel || {})
diff --git a/lib/compilers/coffee.js b/lib/compilers/coffee.js
@@ -1,11 +1,9 @@
 var options = require('./options')
+var ensureRequire = require('../ensure-require.js')
 
 module.exports = function (raw, cb) {
-  try {
-    var coffee = require('coffee-script')
-  } catch (err) {
-    return cb(err)
-  }
+  ensureRequire('coffee',['coffee-script'])
+  var coffee = require('coffee-script')
   try {
     var js = coffee.compile(raw, options.coffee || {})
   } catch (err) {
diff --git a/lib/compilers/jade.js b/lib/compilers/jade.js
@@ -1,11 +1,9 @@
 var options = require('./options')
+var ensureRequire = require('../ensure-require.js')
 
 module.exports = function (raw, cb) {
-  try {
-    var jade = require('jade')
-  } catch (err) {
-    return cb(err)
-  }
+  ensureRequire('jade','jade')
+  var jade = require('jade')
   try {
     var html = jade.compile(raw, options.jade || {})()
   } catch (err) {
diff --git a/lib/compilers/less.js b/lib/compilers/less.js
@@ -1,13 +1,11 @@
 var options = require('./options')
 var assign = require('object-assign')
 var path = require('path')
+var ensureRequire = require('../ensure-require.js')
 
 module.exports = function (raw, cb, compiler, filePath) {
-  try {
-    var less = require('less')
-  } catch (err) {
-    return cb(err)
-  }
+  ensureRequire('less','less')
+  var less = require('less')
 
   var opts = assign({
     filename: path.basename(filePath)
diff --git a/lib/compilers/pug.js b/lib/compilers/pug.js
@@ -1,11 +1,9 @@
 var options = require('./options')
+var ensureRequire = require('../ensure-require.js')
 
 module.exports = function (raw, cb) {
-  try {
-    var pug = require('pug')
-  } catch (err) {
-    return cb(err)
-  }
+  ensureRequire('pug','pug')
+  var pug = require('pug')
   try {
     var html = pug.compile(raw, options.pug || {})()
   } catch (err) {
diff --git a/lib/compilers/sass.js b/lib/compilers/sass.js
@@ -1,13 +1,11 @@
 var options = require('./options')
 var assign = require('object-assign')
 var path = require('path')
+var ensureRequire = require('../ensure-require.js')
 
 module.exports = function (raw, cb, compiler, filePath) {
-  try {
-    var sass = require('node-sass')
-  } catch (err) {
-    return cb(err)
-  }
+  ensureRequire('sass','node-sass')
+  var sass = require('node-sass')
 
   var sassOptions = assign({
     data: raw,
diff --git a/lib/compilers/stylus.js b/lib/compilers/stylus.js
@@ -1,13 +1,11 @@
 var options = require('./options')
 var assign = require('object-assign')
 var path = require('path')
+var ensureRequire = require('../ensure-require.js')
 
 module.exports = function (raw, cb, compiler, filePath) {
-  try {
-    var stylus = require('stylus')
-  } catch (err) {
-    return cb(err)
-  }
+  ensureRequire('stylus','stylus')
+  var stylus = require('stylus')
 
   var opts = assign({
     filename: path.basename(filePath)
diff --git a/lib/ensure-require.js b/lib/ensure-require.js
@@ -0,0 +1,32 @@
+module.exports = function(name,deps) {
+  var i,len,missing=[];
+  if (typeof deps === "string") {
+    deps = [deps]
+  }
+  for (i = 0, len = deps.length; i < len; i++) {
+    var mis, req = deps[i]
+    if (typeof req === "string") {
+      mis = req
+    } else {
+      mis = req[1]
+      req = req[0]
+    }
+    try {
+      require.resolve(req)
+    } catch (e) {
+      missing.push(mis)
+    }
+  }
+  if (missing.length > 0) {
+    var message = 'You are trying to use "'+name+'". '
+    var npmInstall = 'npm install --save-dev '+missing.join(" ")
+    if (missing.length > 1) {
+      var last = missing.pop()
+      message += missing.join(', ') + ' and ' +last + ' are '
+    } else {
+      message += missing[0] + ' is '
+    }
+    message += 'missing.\n\nTo install run:\n'+npmInstall
+    throw new Error(message)
+  }
+}
diff --git a/package.json b/package.json
@@ -36,25 +36,18 @@
     "through": "^2.3.6",
     "vue-template-validator": "^1.0.1"
   },
-  "peerDependencies": {
-    "babel-core": "^6.8.0",
-    "babel-runtime": "^6.0.0",
-    "babel-preset-es2015": "^6.6.0",
-    "babel-plugin-transform-runtime": "^6.8.0",
-    "vue-hot-reload-api": "^1.2.0",
-    "vueify-insert-css": "^1.0.0"
-  },
   "devDependencies": {
     "babel-core": "^6.8.0",
-    "babel-runtime": "^6.0.0",
-    "babel-preset-es2015": "^6.6.0",
     "babel-plugin-transform-runtime": "^6.6.1",
+    "babel-preset-es2015": "^6.6.0",
+    "babel-runtime": "^6.0.0",
     "coffee-script": "^1.10.0",
     "jade": "^1.11.0",
     "less": "^2.5.1",
     "mocha": "^2.3.3",
     "node-sass": "^3.3.3",
     "pug": "^2.0.0-alpha6",
+    "rewire": "^2.5.1",
     "stylus": "^0.52.4",
     "vue-hot-reload-api": "^1.2.0",
     "vueify-insert-css": "^1.0.0"
diff --git a/test/test.js b/test/test.js
@@ -72,4 +72,15 @@ describe('Vueify compiler', function () {
     .forEach(function (file) {
       test(path.basename(file, '.js'))
     })
+  it('missing dependencies', function(done) {
+    var rewire = require('rewire')
+    var ensureRequire = rewire('../lib/ensure-require.js')
+    ensureRequire.__set__('require.resolve',function(){throw new Error()})
+    compiler = rewire('../lib/compiler')
+    compiler.__set__('ensureRequire',ensureRequire)
+    compiler.compile('<template></template><script></script><style>a{font-size:20px}</style>', function (err,result) {
+      assert.equal(err.message,'You are trying to use "styles". vueify-insert-css is missing.\n\nTo install run:\nnpm install --save-dev vueify-insert-css')
+      done()
+    })
+  })
 })
