conditional file generation

Author: yyx990803

lib/filter.js

@@ -0,0 +1,30 @@
+var match = require('minimatch')
+var chalk = require('chalk')
+
+module.exports = function (files, filters, data, done) {
+  if (!filters) {
+    return done()
+  }
+  var fileNames = Object.keys(files)
+  Object.keys(filters).forEach(function (glob) {
+    fileNames.forEach(function (file) {
+      if (match(file, glob)) {
+        var condition = filters[glob]
+        if (!evalualte(condition, data)) {
+          delete files[file]
+        }
+      }
+    })
+  })
+  done()
+}
+
+function evalualte (exp, data) {
+  /* eslint-disable no-new-func */
+  var fn = new Function('data', 'with (data) { return ' + exp + '}')
+  try {
+    return fn(data)
+  } catch (e) {
+    console.error(chalk.red('Error when evaluating filter condition: ' + exp))
+  }
+}

lib/generate.js

@@ -3,7 +3,8 @@ var async = require('async')
 var render = require('consolidate').handlebars.render
 var path = require('path')
 var getOptions = require('./options')
-var askQuestions = require('./ask')
+var ask = require('./ask')
+var filter = require('./filter')
 
 /**
  * Generate a template given a `src` and `dest`.
@@ -17,9 +18,8 @@ var askQuestions = require('./ask')
 module.exports = function generate (name, src, dest, done) {
   var opts = getOptions(name, src)
   Metalsmith(path.join(src, 'template'))
-    .use(function (files, metalsmith, done) {
-      askQuestions(opts.schema, metalsmith.metadata(), done)
-    })
+    .use(askQuestions(opts.schema))
+    .use(filterFiles(opts.filters))
     .use(renderTemplateFiles)
     .clean(false)
     .source('.') // start from template root instead of `./src` which is Metalsmith's default for `source`
@@ -30,6 +30,32 @@ module.exports = function generate (name, src, dest, done) {
     })
 }
 
+/**
+ * Create a middleware for asking questions.
+ *
+ * @param {Object} schema
+ * @return {Function}
+ */
+
+function askQuestions (schema) {
+  return function (files, metalsmith, done) {
+    ask(schema, metalsmith.metadata(), done)
+  }
+}
+
+/**
+ * Create a middleware for filtering files.
+ *
+ * @param {Object} filters
+ * @return {Function}
+ */
+
+function filterFiles (filters) {
+  return function (files, metalsmith, done) {
+    filter(files, filters, metalsmith.metadata(), done)
+  }
+}
+
 /**
  * Template in place plugin.
  *
@@ -41,7 +67,7 @@ module.exports = function generate (name, src, dest, done) {
 function renderTemplateFiles (files, metalsmith, done) {
   var keys = Object.keys(files)
   var metalsmithMetadata = metalsmith.metadata()
-
+  metalsmithMetadata.noEscape = true
   async.each(keys, function (file, next) {
     var str = files[file].contents.toString()
     // do not attempt to render files that do not have mustaches

package.json

@@ -24,7 +24,7 @@
   "main": "lib/index.js",
   "scripts": {
     "test": "npm run lint && npm run e2e",
-    "lint": "eslint test lib bin/* --env mocha",
+    "lint": "eslint test/test.js lib bin/* --env mocha",
     "e2e": "rimraf test/e2e/mock-template-build/*.* && BABEL_ENV=development mocha test/e2e/test.js --slow 1000 --compilers js:babel-core/register"
   },
   "dependencies": {
@@ -36,6 +36,7 @@
     "handlebars": "^4.0.5",
     "inquirer": "^0.12.0",
     "metalsmith": "^2.1.0",
+    "minimatch": "^3.0.0",
     "ora": "^0.2.1",
     "read-metadata": "^1.0.0",
     "request": "^2.67.0",

test/e2e/mock-template-repo/meta.json

@@ -26,6 +26,17 @@
         "less",
         "sass"
       ]
+    },
+    "pick": {
+      "type": "list",
+      "choices": [
+        "yes",
+        "no"
+      ]
     }
+  },
+  "filters": {
+    "src/*.js": "pick === 'yes'",
+    "**/*.vue": "pick === 'no'"
   }
 }

test/e2e/mock-template-repo/template/src/no.js

@@ -0,0 +1 @@
+console.log('no.')

test/e2e/mock-template-repo/template/src/yes.vue

@@ -0,0 +1,3 @@
+<template>
+  \{{yes}} {{pick}}
+</template>

test/e2e/test.js

@@ -6,6 +6,7 @@ const exists = require('fs').existsSync
 const crypto = require('crypto')
 const render = require('consolidate').handlebars.render
 const inquirer = require('inquirer')
+const async = require('async')
 const generate = require('../../lib/generate')
 
 const MOCK_TEMPLATE_REPO_PATH = './test/e2e/mock-template-repo'
@@ -19,7 +20,8 @@ describe('vue-cli', () => {
     preprocessor: {
       less: true,
       sass: true
-    }
+    },
+    pick: 'no'
   }
 
   // monkey patch inquirer
@@ -32,18 +34,24 @@ describe('vue-cli', () => {
 
   it('template generation', done => {
     generate('test', MOCK_TEMPLATE_REPO_PATH, MOCK_TEMPLATE_BUILD_PATH, err => {
-      if (err) done()
+      if (err) done(err)
 
-      const handlebarsPackageJsonFile = fs.readFileSync(`${MOCK_TEMPLATE_REPO_PATH}/template/package.json`, 'utf8')
-      const generatedPackageJsonFile = fs.readFileSync(`${MOCK_TEMPLATE_BUILD_PATH}/package.json`, 'utf8')
+      expect(exists(`${MOCK_TEMPLATE_BUILD_PATH}/src/yes.vue`)).to.equal(true)
+      expect(exists(`${MOCK_TEMPLATE_BUILD_PATH}/src/no.js`)).to.equal(false)
 
-      render(handlebarsPackageJsonFile, answers, (err, res) => {
-        if (err) return done(err)
+      async.eachSeries([
+        'package.json',
+        'src/yes.vue'
+      ], function (file, next) {
+        const template = fs.readFileSync(`${MOCK_TEMPLATE_REPO_PATH}/template/${file}`, 'utf8')
+        const generated = fs.readFileSync(`${MOCK_TEMPLATE_BUILD_PATH}/${file}`, 'utf8')
 
-        // compare if vue-cli generate returns same as passing options directly to handlebars
-        expect(res).to.equal(generatedPackageJsonFile)
-        done()
-      })
+        render(template, answers, (err, res) => {
+          if (err) return next(err)
+          expect(res).to.equal(generated)
+          next()
+        })
+      }, done)
     })
   })
 
@@ -54,7 +62,7 @@ describe('vue-cli', () => {
     wstream.end()
 
     generate('test', MOCK_TEMPLATE_REPO_PATH, MOCK_TEMPLATE_BUILD_PATH, err => {
-      if (err) done()
+      if (err) done(err)
 
       const handlebarsPackageJsonFile = fs.readFileSync(`${MOCK_TEMPLATE_REPO_PATH}/template/package.json`, 'utf8')
       const generatedPackageJsonFile = fs.readFileSync(`${MOCK_TEMPLATE_BUILD_PATH}/package.json`, 'utf8')