Merge pull request vuejs#156 from vuejs/in-place

zigomir · web-flow · commit 435ceb6eabd7 · 2016-08-28T18:19:02.000-07:00
Add and document `inPlace` property.
diff --git a/README.md b/README.md
@@ -163,6 +163,24 @@ Files under `test` will only be generated if the user answered yes to the prompt
 
 Note that the `dot` option for minimatch is set to `true` so glob patterns would also match dotfiles by default.
 
+#### Additional data available in meta.{js,json}
+
+- `destDirName` - destination directory name
+
+```json
+{
+  "completeMessage": "To get started:\n\n  cd {{destDirName}}\n  npm install\n  npm run dev"
+}
+```
+
+- `inPlace` - generating template into current directory
+
+```json
+{
+  "completeMessage": "{{#inPlace}}To get started:\n\n  npm install\n  npm run dev.{{else}}To get started:\n\n  cd {{destDirName}}\n  npm install\n  npm run dev.{{/inPlace}}"
+}
+```
+
 ### License
 
 [MIT](http://opensource.org/licenses/MIT)
diff --git a/lib/generate.js b/lib/generate.js
@@ -34,6 +34,7 @@ module.exports = function generate (name, src, dest, done) {
   var metalsmith = Metalsmith(path.join(src, 'template'))
   var data = Object.assign(metalsmith.metadata(), {
     destDirName: name,
+    inPlace: dest === process.cwd(),
     noEscape: true
   })
   opts.helpers && Object.keys(opts.helpers).map(function (key) {
@@ -50,6 +51,8 @@ module.exports = function generate (name, src, dest, done) {
       done(err)
       logMessage(opts.completeMessage, data)
     })
+
+  return data
 }
 
 /**
@@ -108,7 +111,6 @@ function renderTemplateFiles (files, metalsmith, done) {
  *
  * @param {String} message
  * @param {Object} data
- * @param {Function} cb
  */
 
 function logMessage (message, data) {
diff --git a/test/e2e/mock-meta-json/meta.json b/test/e2e/mock-meta-json/meta.json
@@ -0,0 +1,3 @@
+{
+  "completeMessage": "{{#inPlace}}To get started:\n\n  npm install\n  npm run dev.{{else}}To get started:\n\n  cd {{destDirName}}\n  npm install\n  npm run dev.{{/inPlace}}"
+}
diff --git a/test/e2e/mock-metadata-repo-js/meta.js b/test/e2e/mock-metadata-repo-js/meta.js
@@ -1,4 +1,3 @@
-
 module.exports = {
   prompts: {
     description: {
@@ -12,4 +11,4 @@ module.exports = {
       return str.toUpperCase()
     }
   }
-}
+}
diff --git a/test/e2e/test.js b/test/e2e/test.js
@@ -11,6 +11,7 @@ const extend = Object.assign || require('util')._extend
 const generate = require('../../lib/generate')
 const metadata = require('../../lib/options')
 
+const MOCK_META_JSON_PATH = './test/e2e/mock-meta-json'
 const MOCK_TEMPLATE_REPO_PATH = './test/e2e/mock-template-repo'
 const MOCK_TEMPLATE_BUILD_PATH = path.resolve('./test/e2e/mock-template-build')
 const MOCK_METADATA_REPO_JS_PATH = './test/e2e/mock-metadata-repo-js'
@@ -43,18 +44,16 @@ describe('vue-cli', () => {
     noEscape: true
   }
 
-  it('read metadata from json', done => {
+  it('read metadata from json', () => {
     const meta = metadata('test-pkg', MOCK_TEMPLATE_REPO_PATH)
     expect(meta).to.be.an('object')
     expect(meta.prompts).to.have.property('description')
-    done()
   })
 
-  it('read metadata from js', done => {
+  it('read metadata from js', () => {
     const meta = metadata('test-pkg', MOCK_METADATA_REPO_JS_PATH)
     expect(meta).to.be.an('object')
     expect(meta.prompts).to.have.property('description')
-    done()
   })
 
   it('helpers', done => {
@@ -67,6 +66,21 @@ describe('vue-cli', () => {
     })
   })
 
+  it('adds additional data to meta data', () => {
+    const data = generate('test', MOCK_META_JSON_PATH, MOCK_TEMPLATE_BUILD_PATH)
+    expect(data.destDirName).to.equal('test')
+    expect(data.inPlace).to.equal(false)
+  })
+
+  it('sets `inPlace` to true when generating in same directory', () => {
+    const currentDir = process.cwd()
+    process.chdir(MOCK_TEMPLATE_BUILD_PATH)
+    const data = generate('test', MOCK_META_JSON_PATH, MOCK_TEMPLATE_BUILD_PATH)
+    expect(data.destDirName).to.equal('test')
+    expect(data.inPlace).to.equal(true)
+    process.chdir(currentDir)
+  })
+
   it('template generation', done => {
     monkeyPatchInquirer(answers)
     generate('test', MOCK_TEMPLATE_REPO_PATH, MOCK_TEMPLATE_BUILD_PATH, err => {

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "completeMessage": "{{#inPlace}}To get started:\n\n npm install\n npm run dev.{{else}}To get started:\n\n cd {{destDirName}}\n npm install\n npm run dev.{{/inPlace}}"`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-`
`2`	`1`	`module.exports = {`
`3`	`2`	`prompts: {`
`4`	`3`	`description: {`
`@@ -12,4 +11,4 @@ module.exports = {`
`12`	`11`	`return str.toUpperCase()`
`13`	`12`	`}`
`14`	`13`	`}`
`15`		`-}`
	`14`	`+}`