feat(scaffold): provide scaffold.md

generators/app/handler/scaffold_info_th.js

@@ -0,0 +1,29 @@
+'use strict';
+
+const AbstractTemplateHandler = require('yo-power-generator').AbstractTemplateHandler;
+const _ = require('lodash')
+const fileUtils = require('yo-power-generator').FileUtils;
+const cp = require('child_process');
+const moment = require('moment');
+
+class DefaultTemplateHandler extends AbstractTemplateHandler {
+  _handle0 () {
+    const tpl = _.template(this.generator.fs.read(this.generator.templatePath(this.tmpl)));
+    const destTpl = _.template(fileUtils.tmplToFileName(this.tmpl));
+    this.generator.fs.write(
+      this.generator.destinationPath(destTpl(this.props)),
+      tpl(_.assignIn({
+        toolVersion: 'v' + this.props.version,
+        yoVersion: 'v' + cp.execSync('yo --version', { encoding: 'utf-8' }).replace('\r', '').replace('\n', ''),
+        nodeVersion: process.version,
+        date: moment().format('YYYY-MM-DD hh:mm:ss'),
+        propsJson: JSON.stringify(this.props)
+      }, this.props))
+    )
+  }
+}
+
+module.exports = {
+  key: 'scaffold_info',
+  cls: DefaultTemplateHandler
+};

generators/app/index.js

@@ -97,17 +97,46 @@ const obj = {
       }
     }
   },
-  configservice: {
-    prompting: {
-      type: 'list',
-      choices: [
-        'apollo',
-        'none'
-      ],
-      message: '请选择你的配置中心类型（TODO）'
-    },
-    option: { desc: '配置中心', type: String, default: 'none' }
-  },
+  // configservice: {
+  //   prompting: {
+  //     type: 'list',
+  //     choices: [
+  //       'apollo',
+  //       'none'
+  //     ],
+  //     message: '请选择你的配置中心类型（TODO）'
+  //   },
+  //   option: { desc: '配置中心', type: String, default: 'none' }
+  // },
+  // authentication: {
+  //   prompting: {
+  //     type: 'list',
+  //     choices: [
+  //       'token',
+  //       // 'session',
+  //       'none'
+  //     ],
+  //     message: '请选择你采用的认证机制类型'
+  //   },
+  //   option: { desc: '认证机制', type: String, default: 'token' },
+  //   child: {
+  //     token: {
+  //       prompting: {
+  //         type: 'list',
+  //         choices: [
+  //           'jwt'
+  //         ],
+  //         message: '请选择你使用的token类型'
+  //       },
+  //       option: { desc: 'token类型', type: String, default: 'jwt' },
+  //       callbacks: {
+  //         trigger (answers) {
+  //           return answers.authentication === 'token';
+  //         }
+  //       }
+  //     }
+  //   }
+  // },
   demo: {
     prompting: {
       type: 'confirm',
@@ -122,6 +151,9 @@ module.exports = require('yo-power-generator').getGenerator(obj, {
   handlerDir: path.join(__dirname, 'handler'),
   templateDir: path.join(__dirname, 'templates'),
   afterPropsSet (props) {
+    props.version = require('../../package.json').version
+    props.cli = `yo generator-deepexi-spring-cloud -c ${props.cli}`;
+
     if (!props.basePackage) {
       props.basePackage = props.groupId;
     }

generators/app/templates/scaffold.tmpl_scaffold_info.md

@@ -0,0 +1,31 @@
+# Scaffold参考文档
+
+此项目由[generator-deepexi-spring-cloud](https://github.com/deepexi/generator-deepexi-spring-cloud)生成。
+
+## 项目信息
+
+**工具版本**: ${toolVersion}
+**node版本**: ${nodeVersion}
+**yeoman版本**: ${yoVersion}
+**生成时间**: ${date}
+**生成方式**: ${mode==='command'?'命令模式':'交互模式'}
+**生成参数**: ${propsJson}
+**生成命令**: ${cli}
+
+## 项目参考
+
+### .gitkeep
+
+项目生成后，为了维持一些空文件夹的存在，会为这些空文件夹添加一个`.gitkeep`文件，如果不需要了，可以在项目目录下执行以下命令全部清除
+
+```bash
+$ find . -name '.gitkeep' | xargs rm
+```
+
+### demo
+
+可以通过以下指令清除所有带有Demo字样的文件
+
+```bash
+$ find . -name '*Demo*' | xargs rm
+```

generators/test/app/index.test.js

@@ -30,6 +30,7 @@ describe('generate app', () => {
       assert.file('Dockerfile')
       assert.file('LICENSE')
       assert.file('README.md')
+      assert.file('scaffold.md')
     })
 
     describe('api', () => {

package.json

@@ -11,6 +11,7 @@
   "dependencies": {
     "debug": "^4.1.1",
     "js-yaml": "^3.13.1",
+    "moment": "^2.24.0",
     "prettify-xml": "^1.2.0",
     "xml": "^1.0.1",
     "yeoman-generator": "^1.1.1",