feat: Generating README.md (vuejs#1717)

arthurdenner · Akryum · commit 278e992fbf10 · 2018-07-04T13:16:49.000+02:00
* feat: Generating README.md based on the package.json

* refactor: Adding missing scripts, changing descriptions and improving code

* chore: Moving stopSpinner to correct position and adding comment

* chore: Changing description to script test:e2e

* refactor: Removing unnecessary `if`
diff --git a/packages/@vue/cli/lib/Creator.js b/packages/@vue/cli/lib/Creator.js
@@ -15,6 +15,7 @@ const PromptModuleAPI = require('./PromptModuleAPI')
 const writeFileTree = require('./util/writeFileTree')
 const { formatFeatures } = require('./util/features')
 const fetchRemotePreset = require('./util/fetchRemotePreset')
+const generateReadme = require('./util/generateReadme')
 
 const {
   defaults,
@@ -184,6 +185,14 @@ module.exports = class Creator extends EventEmitter {
       }
     }
 
+    // generate README.md
+    stopSpinner()
+    log()
+    logWithSpinner('📄', 'Generating README.md...')
+    await writeFileTree(context, {
+      'README.md': generateReadme(generator.pkg, packageManager)
+    })
+
     // log instructions
     stopSpinner()
     log()
diff --git a/packages/@vue/cli/lib/util/generateReadme.js b/packages/@vue/cli/lib/util/generateReadme.js
@@ -0,0 +1,26 @@
+const descriptions = {
+  build: 'Compiles and minifies for production',
+  serve: 'Compiles and hot-reloads for development',
+  lint: 'Lints and fixes files',
+  test: 'Run your tests',
+  'test:e2e': 'Run your end-to-end tests',
+  'test:unit': 'Run your unit tests'
+}
+
+function printScripts (pkg, packageManager) {
+  return Object.keys(pkg.scripts).map(key => {
+    return [
+      `\n### ${descriptions[key]}`,
+      `${packageManager} run ${key}\n`
+    ].join('\n')
+  }).join('')
+}
+
+module.exports = function generateReadme (pkg, packageManager) {
+  return [
+    `# ${pkg.name}\n`,
+    '## Project setup',
+    `${packageManager} install`,
+    printScripts(pkg, packageManager)
+  ].join('\n')
+}
