cmyr-template-cli 1.4.1 → 1.6.0

package/dist/index.js

@@ -13,8 +13,12 @@ var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
 
 const program = new commander.Command('ct')
     .description('草梅项目创建器');
-program.version(process.env.VERSION || '1.0.0', '-v, --version');
+program.version("1.5.2" , '-v, --version');
 const args = process.argv.slice(2);
+if (args.length === 0) {
+    args.push('create');
+    process.argv.push('create');
+}
 const argv = minimist__default["default"](args);
 program.option('-d, --debug', 'debug');
 const create = new commander.Command('create')
@@ -31,6 +35,7 @@ program.addCommand(create);
 program.parse(process.argv);
 const opts = program.opts();
 if (opts.debug) {
+    console.log(args);
     console.log(argv);
     console.log(opts);
 }

package/dist/plopfile.js

@@ -7,39 +7,67 @@ var ora = require('ora');
 var download = require('download-git-repo');
 var axios = require('axios');
 var child_process = require('child_process');
-var any = require('promise.any');
+var colors = require('colors');
+var ejs = require('ejs');
+var lodash = require('lodash');
+var core = require('@lint-md/core');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
+function _interopNamespace(e) {
+    if (e && e.__esModule) return e;
+    var n = Object.create(null);
+    if (e) {
+        Object.keys(e).forEach(function (k) {
+            if (k !== 'default') {
+                var d = Object.getOwnPropertyDescriptor(e, k);
+                Object.defineProperty(n, k, d.get ? d : {
+                    enumerable: true,
+                    get: function () { return e[k]; }
+                });
+            }
+        });
+    }
+    n["default"] = e;
+    return Object.freeze(n);
+}
+
 var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
 var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
 var ora__default = /*#__PURE__*/_interopDefaultLegacy(ora);
 var download__default = /*#__PURE__*/_interopDefaultLegacy(download);
 var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
-var any__default = /*#__PURE__*/_interopDefaultLegacy(any);
+var colors__default = /*#__PURE__*/_interopDefaultLegacy(colors);
+var ejs__default = /*#__PURE__*/_interopDefaultLegacy(ejs);
 
 process.env;
 const PACKAGE_MANAGER = 'pnpm';
 
+axios__default["default"].defaults.timeout = 10 * 1000;
 if (!Promise.any) {
-    Promise.any = any__default["default"];
+    Promise.resolve().then(function () { return /*#__PURE__*/_interopNamespace(require('promise.any')); }).then((any) => {
+        Promise.any = any.default;
+    });
 }
+const GITHUB_API_URL = 'https://api.github.com';
+const NODEJS_URL = 'https://nodejs.org/zh-cn/download/';
 const REMOTES = [
     'https://github.com',
     'https://hub.fastgit.org',
-    'https://gitclone.com',
     'https://github.com.cnpmjs.org',
+    'https://download.fastgit.org',
 ];
 async function downloadGitRepo(repository, destination, options = {}) {
     const fastRepo = await getFastGitRepo(repository);
-    const loading = ora__default["default"](`download - ${repository}`);
+    const loading = ora__default["default"](`正在下载模板 - ${repository}`);
     loading.start();
-    return new Promise((resolve, reject) => {
+    return new Promise((resolve) => {
         download__default["default"](fastRepo, destination, options, (err) => {
-            loading.stop();
             if (err) {
-                return reject(err);
+                loading.fail('下载模板失败！');
+                process.exit(1);
             }
+            loading.succeed(`成功下载模板 - ${repository}`);
             resolve(true);
         });
     });
@@ -56,15 +84,14 @@ async function getFastGitRepo(repository) {
                 timeout: 15 * 1000,
             });
         }));
+        loading.succeed(`成功选择了镜像源 - ${fast.config.url}`);
         return `direct:${fast.config.url}`;
     }
     catch (error) {
         console.error(error);
+        loading.fail('选择镜像源失败！');
         process.exit(1);
     }
-    finally {
-        loading.stop();
-    }
 }
 async function asyncExec(cmd, options) {
     return new Promise((resolve, reject) => {
@@ -80,8 +107,7 @@ async function asyncExec(cmd, options) {
     });
 }
 async function init(projectPath, answers) {
-    const loading = ora__default["default"]('正在安装依赖……');
-    const { name, author, description, isOpenSource, isRemoveDependabot } = answers;
+    const { isOpenSource, isRemoveDependabot, gitRemoteUrl, isInitReadme, isInitContributing } = answers;
     try {
         await asyncExec('git --version', {
             cwd: projectPath,
@@ -92,6 +118,12 @@ async function init(projectPath, answers) {
         await asyncExec('git init', {
             cwd: projectPath,
         });
+        if (gitRemoteUrl) {
+            await asyncExec(`git remote add origin ${gitRemoteUrl}`, {
+                cwd: projectPath,
+            });
+            console.info(colors__default["default"].green(`请在远程 Git 仓库初始化 ${gitRemoteUrl}`));
+        }
         const dependabotPath = path__default["default"].join(projectPath, '.github/dependabot.yml');
         const mergifyPath = path__default["default"].join(projectPath, '.github/mergify.yml');
         if (!isOpenSource || isRemoveDependabot) {
@@ -102,26 +134,34 @@ async function init(projectPath, answers) {
                 await fs__default["default"].remove(mergifyPath);
             }
         }
-        const pkgPath = path__default["default"].join(projectPath, 'package.json');
-        const pkg = await fs__default["default"].readJSON(pkgPath);
-        const pkgData = {
-            name,
-            author,
-            description,
-            private: !isOpenSource,
-        };
-        const newPkg = Object.assign({}, pkg, pkgData);
-        await fs__default["default"].writeFile(pkgPath, JSON.stringify(newPkg, null, 2));
+        await initProjectJson(projectPath, answers);
+        if (isOpenSource) {
+            const info = await getProjectInfo(projectPath, answers);
+            if (info) {
+                if (isInitReadme) {
+                    await initReadme(projectPath, info);
+                }
+                if (isInitContributing) {
+                    await initContributing(projectPath, info);
+                }
+            }
+        }
         await asyncExec('git add .', {
             cwd: projectPath,
         });
         await asyncExec('git commit -m "chore: init"', {
             cwd: projectPath,
         });
-        loading.start();
-        await asyncExec(`${PACKAGE_MANAGER} i`, {
-            cwd: projectPath,
-        });
+        const loading = ora__default["default"]('正在安装依赖……').start();
+        try {
+            await asyncExec(`${PACKAGE_MANAGER} i`, {
+                cwd: projectPath,
+            });
+            loading.succeed('依赖安装成功！');
+        }
+        catch (error) {
+            loading.fail('依赖安装失败！');
+        }
         await asyncExec('git add .', {
             cwd: projectPath,
         });
@@ -129,14 +169,214 @@ async function init(projectPath, answers) {
     catch (error) {
         console.error(error);
     }
-    finally {
-        loading.stop();
-    }
 }
 async function getGitUserName() {
     const username = (await asyncExec('git config user.name'));
     return username.trim();
 }
+async function initProjectJson(projectPath, answers) {
+    const loading = ora__default["default"]('正在初始化 package.json ……').start();
+    try {
+        const { name, author, description, isOpenSource, isPublishToNpm = false } = answers;
+        const repositoryUrl = `https://github.com/${author}/${name}`;
+        const homepage = `${repositoryUrl}#readme`;
+        const issuesUrl = `${repositoryUrl}/issues`;
+        const gitUrl = `git+${repositoryUrl}.git`;
+        const nodeVersion = await getLtsNodeVersion() || '12';
+        const node = Number(nodeVersion) - 4;
+        const pkgPath = path__default["default"].join(projectPath, 'package.json');
+        const pkg = await fs__default["default"].readJSON(pkgPath);
+        const pkgData = {
+            name,
+            author,
+            description,
+            private: !isPublishToNpm,
+            license: 'UNLICENSED',
+            engines: {
+                node: `>=${node}`,
+            },
+        };
+        let extData = {};
+        if (isOpenSource) {
+            extData = {
+                license: 'MIT',
+                homepage,
+                repository: {
+                    type: 'git',
+                    url: gitUrl,
+                },
+                bugs: {
+                    url: issuesUrl,
+                },
+            };
+        }
+        const newPkg = Object.assign({}, pkg, pkgData, extData);
+        await fs__default["default"].writeFile(pkgPath, JSON.stringify(newPkg, null, 2));
+        loading.succeed('package.json 初始化成功！');
+    }
+    catch (error) {
+        console.error(error);
+        loading.fail('package.json 初始化失败！');
+    }
+}
+const cleanText = (text) => text.replace(/-/g, '--').replace(/_/g, '__');
+async function getProjectInfo(projectPath, answers) {
+    var _a, _b, _c, _d, _e;
+    const loading = ora__default["default"]('正在获取项目信息 ……').start();
+    try {
+        const { name, author, description, isOpenSource, isPublishToNpm } = answers;
+        const packageManager = 'npm';
+        const pkgPath = path__default["default"].join(projectPath, 'package.json');
+        const pkg = await fs__default["default"].readJSON(pkgPath);
+        const engines = (pkg === null || pkg === void 0 ? void 0 : pkg.engines) || {};
+        const license = pkg === null || pkg === void 0 ? void 0 : pkg.license;
+        const version = pkg === null || pkg === void 0 ? void 0 : pkg.version;
+        const installCommand = isPublishToNpm ? `${packageManager} install ${name}` : `${packageManager} install`;
+        const startCommand = ((_a = pkg === null || pkg === void 0 ? void 0 : pkg.scripts) === null || _a === void 0 ? void 0 : _a.start) && `${packageManager} run start`;
+        const devCommand = ((_b = pkg === null || pkg === void 0 ? void 0 : pkg.scripts) === null || _b === void 0 ? void 0 : _b.dev) && `${packageManager} run dev`;
+        const buildCommand = ((_c = pkg === null || pkg === void 0 ? void 0 : pkg.scripts) === null || _c === void 0 ? void 0 : _c.build) && `${packageManager} run build`;
+        const testCommand = ((_d = pkg === null || pkg === void 0 ? void 0 : pkg.scripts) === null || _d === void 0 ? void 0 : _d.test) && `${packageManager} run test`;
+        const lintCommand = ((_e = pkg === null || pkg === void 0 ? void 0 : pkg.scripts) === null || _e === void 0 ? void 0 : _e.lint) && `${packageManager} run lint`;
+        const repositoryUrl = `https://github.com/${author}/${name}`;
+        const issuesUrl = `${repositoryUrl}/issues`;
+        const contributingUrl = `${repositoryUrl}/blob/master/CONTRIBUTING.md`;
+        const documentationUrl = `${repositoryUrl}#readme`;
+        const demoUrl = `${repositoryUrl}#readme`;
+        const homepage = documentationUrl;
+        const githubUsername = author;
+        const authorWebsite = await getAuthorWebsiteFromGithubAPI(githubUsername);
+        const licenseUrl = `${repositoryUrl}/blob/master/LICENSE`;
+        const discussionsUrl = `${repositoryUrl}/discussions`;
+        const pullRequestsUrl = `${repositoryUrl}/pulls`;
+        const projectInfos = {
+            currentYear: new Date().getFullYear(),
+            name,
+            description,
+            version,
+            author,
+            authorWebsite,
+            homepage,
+            demoUrl,
+            repositoryUrl,
+            issuesUrl,
+            contributingUrl,
+            githubUsername,
+            authorName: author,
+            authorGithubUsername: githubUsername,
+            engines,
+            licenseName: cleanText(license),
+            licenseUrl,
+            documentationUrl,
+            isGithubRepos: true,
+            installCommand,
+            startCommand,
+            usage: startCommand,
+            devCommand,
+            buildCommand,
+            testCommand,
+            lintCommand,
+            isJSProject: true,
+            packageManager,
+            isProjectOnNpm: isPublishToNpm,
+            isOpenSource,
+            projectName: name,
+            projectVersion: version,
+            projectDocumentationUrl: documentationUrl,
+            projectDescription: description,
+            projectHomepage: homepage,
+            projectDemoUrl: demoUrl,
+            projectPrerequisites: Object.keys(engines).map((key) => ({
+                name: key,
+                value: engines[key],
+            })),
+            discussionsUrl,
+            pullRequestsUrl,
+        };
+        loading.succeed('项目信息 初始化成功！');
+        return projectInfos;
+    }
+    catch (error) {
+        loading.fail('项目信息 初始化失败！');
+        console.error(error);
+        return null;
+    }
+}
+async function initReadme(projectPath, projectInfos) {
+    const loading = ora__default["default"]('正在初始化 README.md ……').start();
+    try {
+        const templatePath = path__default["default"].join(__dirname, '../templates/README.md');
+        const template = (await fs__default["default"].readFile(templatePath, 'utf8')).toString();
+        const newReadmePath = path__default["default"].join(projectPath, 'README.md');
+        const readmeContent = await ejs__default["default"].render(template, projectInfos, {
+            debug: false,
+            async: true,
+        });
+        if (await fs__default["default"].pathExists(newReadmePath)) {
+            await fs__default["default"].remove(newReadmePath);
+        }
+        await fs__default["default"].writeFile(newReadmePath, lintMd(lodash.unescape(readmeContent)));
+        loading.succeed('README.md 初始化成功！');
+    }
+    catch (error) {
+        loading.fail('README.md 初始化失败！');
+        console.error(error);
+    }
+}
+async function initContributing(projectPath, projectInfos) {
+    const loading = ora__default["default"]('正在初始化 贡献指南 ……').start();
+    try {
+        const templatePath = path__default["default"].join(__dirname, '../templates/CONTRIBUTING.md');
+        const template = (await fs__default["default"].readFile(templatePath, 'utf8')).toString();
+        const newReadmePath = path__default["default"].join(projectPath, 'CONTRIBUTING.md');
+        const readmeContent = await ejs__default["default"].render(template, projectInfos, {
+            debug: false,
+            async: true,
+        });
+        if (await fs__default["default"].pathExists(newReadmePath)) {
+            await fs__default["default"].remove(newReadmePath);
+        }
+        await fs__default["default"].writeFile(newReadmePath, lintMd(lodash.unescape(readmeContent)));
+        loading.succeed('贡献指南 初始化成功！');
+    }
+    catch (error) {
+        loading.fail('贡献指南 初始化失败！');
+        console.error(error);
+    }
+}
+async function getAuthorWebsiteFromGithubAPI(githubUsername) {
+    try {
+        const userData = (await axios__default["default"].get(`${GITHUB_API_URL}/users/${githubUsername}`)).data;
+        const authorWebsite = userData === null || userData === void 0 ? void 0 : userData.blog;
+        return authorWebsite || '';
+    }
+    catch (error) {
+        console.error(error);
+        return '';
+    }
+}
+async function getLtsNodeVersion() {
+    var _a, _b;
+    try {
+        const html = (await axios__default["default"].get(NODEJS_URL)).data;
+        const version = (_a = html.match(/<strong>(.*)<\/strong>/)) === null || _a === void 0 ? void 0 : _a[1];
+        return (_b = version.split('.')) === null || _b === void 0 ? void 0 : _b[0];
+    }
+    catch (error) {
+        console.error(error);
+        return '';
+    }
+}
+function lintMd(markdown) {
+    const rules = {
+        'no-empty-code': 0,
+        'no-trailing-punctuation': 0,
+        'no-long-code': 0,
+        'no-empty-code-lang': 0,
+        'no-empty-inlinecode': 0,
+    };
+    const fixed = core.fix(markdown, rules);
+    return fixed;
+}
 
 module.exports = function (plop) {
     plop.setActionType('initProject', async (answers) => {
@@ -164,9 +404,6 @@ module.exports = function (plop) {
                     type: 'input',
                     name: 'description',
                     message: '请输入项目简介',
-                    transformer(input) {
-                        return (input === null || input === void 0 ? void 0 : input.trim()) || '';
-                    },
                     default: '',
                     filter: (e) => e.trim(),
                 },
@@ -213,6 +450,58 @@ module.exports = function (plop) {
                     message: '是否开源？',
                     default: false,
                 },
+                {
+                    type: 'confirm',
+                    name: 'isInitRemoteRepo',
+                    message: '是否初始化远程 Git 仓库？',
+                    default: false,
+                },
+                {
+                    type: 'input',
+                    name: 'gitRemoteUrl',
+                    message: '请输入远程 Git 仓库 Url',
+                    validate(input) {
+                        return input.trim().length !== 0;
+                    },
+                    default(answers) {
+                        const { isOpenSource, name, author } = answers;
+                        if (isOpenSource) {
+                            return `git@github.com:${author}/${name}.git`;
+                        }
+                        return `git@gitee.com:caomeiyouren/${name}.git`;
+                    },
+                    filter: (e) => e.trim(),
+                    when(answers) {
+                        return answers.isInitRemoteRepo;
+                    },
+                },
+                {
+                    type: 'confirm',
+                    name: 'isPublishToNpm',
+                    message: '是否发布到 npm？',
+                    default: false,
+                    when(answers) {
+                        return answers.isOpenSource;
+                    },
+                },
+                {
+                    type: 'confirm',
+                    name: 'isInitReadme',
+                    message: '是否初始化 README.md ？',
+                    default: true,
+                    when(answers) {
+                        return answers.isOpenSource;
+                    },
+                },
+                {
+                    type: 'confirm',
+                    name: 'isInitContributing',
+                    message: '是否初始化 贡献指南(CONTRIBUTING.md) ？',
+                    default: true,
+                    when(answers) {
+                        return answers.isOpenSource;
+                    },
+                },
                 {
                     type: 'confirm',
                     name: 'isRemoveDependabot',

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "cmyr-template-cli",
-  "version": "1.4.1",
+  "version": "1.6.0",
   "description": "草梅友仁自制的项目模板创建器",
   "author": "CaoMeiYouRen",
   "license": "MIT",
   "main": "dist/index.js",
   "type": "commonjs",
   "files": [
-    "dist"
+    "dist",
+    "templates"
   ],
   "engines": {
     "node": ">=12"
@@ -39,9 +40,10 @@
     "@semantic-release/changelog": "^6.0.0",
     "@semantic-release/git": "^10.0.0",
     "@types/debug": "^4.1.5",
+    "@types/ejs": "^3.1.0",
     "@types/fs-extra": "^9.0.4",
     "@types/lodash": "^4.14.165",
-    "@types/node": "^16.9.6",
+    "@types/node": "^17.0.0",
     "@types/promise.any": "^2.0.0",
     "@typescript-eslint/eslint-plugin": "^4.9.0",
     "@typescript-eslint/parser": "^4.9.0",
@@ -52,10 +54,9 @@
     "cz-conventional-changelog": "^3.3.0",
     "debug": "^4.3.1",
     "eslint": "^7.14.0",
-    "eslint-config-cmyr": "^1.1.13",
+    "eslint-config-cmyr": "^1.1.14",
     "husky": "^7.0.2",
     "lint-staged": "^12.0.2",
-    "lodash": "^4.17.20",
     "rimraf": "^3.0.2",
     "rollup": "^2.33.3",
     "rollup-plugin-terser": "^7.0.2",
@@ -66,12 +67,15 @@
     "validate-commit-msg": "^2.14.0"
   },
   "dependencies": {
+    "@lint-md/core": "^0.2.1",
     "axios": "^0.24.0",
     "colors": "^1.4.0",
     "commander": "^8.2.0",
     "dayjs": "^1.9.6",
     "download-git-repo": "^3.0.2",
+    "ejs": "^3.1.6",
     "fs-extra": "^10.0.0",
+    "lodash": "^4.17.20",
     "minimist": "^1.2.5",
     "ora": "^5.4.1",
     "plop": "^2.7.6",

package/templates/CONTRIBUTING.md

@@ -0,0 +1,78 @@
+# 贡献指南
+
+在为此存储库做出贡献时，请首先通过 issue、电子邮件或任何其他方法与此存储库的所有者讨论您希望进行的更改，然后再进行更改。
+
+## 开发环境设置
+
+要设置开发环境，请按照以下步骤操作：
+
+1. Clone 本项目
+
+   ```sh
+   git clone <%= repositoryUrl %>
+   ```
+
+2.  安装依赖
+
+   ```sh
+   npm i
+   # 或 yarn
+   # 或 pnpm i
+   ```
+
+3.  运行开发环境
+
+<% if (devCommand) { -%>
+```sh
+<%= devCommand %>
+```
+<% } -%>
+
+## 问题和功能请求
+
+你在源代码中发现了一个错误，文档中有一个错误，或者你想要一个新功能？ 看看[GitHub 讨论](<%= discussionsUrl %>)看看它是否已经在讨论中。您可以通过[在 GitHub 上提交问题](<%= issuesUrl %>)来帮助我们。在创建问题之前，请确保搜索问题存档 - 您的问题可能已经得到解决！
+
+请尝试创建以下错误报告：
+
+- *可重现。*包括重现问题的步骤。
+- *具体的。*包括尽可能多的细节：哪个版本，什么环境等。
+- *独特的。*不要复制现有的已打开问题。
+- *范围仅限于单个错误。*每个报告一个错误。
+
+**更好的是：提交带有修复或新功能的拉取请求！**
+
+### 如何提交拉取请求
+
+1. 在我们的存储库中搜索 与您的提交相关的开放或关闭的 [Pull Requests](<%= pullRequestsUrl %>)。你不想重复努力。
+
+2. Fork 本项目
+
+3. 创建您的功能分支 ( `git checkout -b feat/your_feature`)
+
+4. 提交您的更改
+
+   本项目使用 [约定式提交](https://www.conventionalcommits.org/zh-hans/v1.0.0/)，因此请遵循提交消息中的规范。
+   
+   git commit 将用于自动化生成日志，所以请勿直接提交 git commit。
+   
+   非常建议使用 [commitizen](https://github.com/commitizen/cz-cli) 工具来生成 git commit，使用 husky 约束 git commit
+
+    ```sh
+    git add .
+    git cz # 使用 commitizen 提交！
+    git pull # 请合并最新代码并解决冲突后提交！
+    #请勿直接提交git commit
+    #若觉得修改太多也可分开提交。先 git add 一部分，执行 git cz 提交后再提交另外一部分
+    ```
+
+​	关于选项，参考 [semantic-release](https://github.com/semantic-release/semantic-release) 的文档
+
+-   若为 BUG 修复，则选择 `fix`
+-   若为新增功能，则选择 `feat`，新增音声可以按这个提交。
+-   若为移除某些功能，则选择 `perf`  或填写 `BREAKING CHANGE`
+    -    `perf` 和其他破坏性更新，若不是为了修复 BUG，原则上将拒绝该 PR
+
+
+5. 推送到分支 ( `git push origin feat/your_feature`)
+
+6. [打开一个新的 Pull Request](<%= repositoryUrl %>/compare?expand=1)

package/templates/README.md

@@ -0,0 +1,149 @@
+<h1 align="center"><%= projectName %> </h1>
+<p>
+<% if (isProjectOnNpm) { -%>
+  <a href="https://www.npmjs.com/package/<%= projectName %>" target="_blank">
+    <img alt="Version" src="https://img.shields.io/npm/v/<%= projectName %>.svg">
+  </a>
+<% } -%>
+<% if (projectVersion && !isProjectOnNpm) { -%>
+  <img alt="Version" src="https://img.shields.io/badge/version-<%= projectVersion %>-blue.svg?cacheSeconds=2592000" />
+<% } -%>
+<% if (isGithubRepos) { -%>
+  <a href="<%= repositoryUrl %>/actions?query=workflow%3ARelease" target="_blank">
+    <img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/<%= authorGithubUsername %>/<%= projectName %>/Release">
+  </a>
+<% } -%>
+<% if (projectPrerequisites) { -%>
+<% projectPrerequisites.map(({ name, value }) => { -%>
+  <img src="https://img.shields.io/badge/<%= name %>-<%= encodeURIComponent(value) %>-blue.svg" />
+<% }) -%>
+<% } -%>
+<% if (projectDocumentationUrl) { -%>
+  <a href="<%= projectDocumentationUrl %>" target="_blank">
+    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
+  </a>
+<% } -%>
+<% if (isGithubRepos) { -%>
+  <a href="<%= repositoryUrl %>/graphs/commit-activity" target="_blank">
+    <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
+  </a>
+<% } -%>
+<% if (licenseName) { -%>
+  <a href="<%= licenseUrl ? licenseUrl : '#' %>" target="_blank">
+    <img alt="License: <%= licenseName %>" src="https://img.shields.io/<%= `badge/License-${licenseName}-yellow.svg` %>" />
+  </a>
+<% } -%>
+</p>
+
+<% if (projectDescription) { -%>
+
+> <%= projectDescription %>
+<% } -%>
+<% if (projectHomepage) { -%>
+
+### 🏠 [主页](<%= projectHomepage %>)
+
+[<%= projectHomepage %>](<%= projectHomepage %>)
+
+<% } -%>
+<% if (projectDemoUrl) { -%>
+
+### ✨ [Demo](<%= projectDemoUrl %>)
+
+[<%= projectDemoUrl %>](<%= projectDemoUrl %>)
+
+<% } -%>
+<% if (projectPrerequisites && projectPrerequisites.length) { -%>
+
+## 依赖要求
+
+<% projectPrerequisites.map(({ name, value }) => { -%>
+- <%= name %> <%= value %>
+<% }) -%>
+<% } -%>
+<% if (installCommand) { -%>
+
+## 安装
+
+```sh
+<%= installCommand %>
+```
+<% } -%>
+<% if (usage) { -%>
+
+## 使用
+
+```sh
+<%= usage %>
+```
+<% } -%>
+<% if (devCommand) { -%>
+
+## 开发
+
+```sh
+<%= devCommand %>
+```
+<% } -%>
+<% if (buildCommand) { -%>
+
+## 编译
+
+```sh
+<%= buildCommand %>
+```
+<% } -%>
+<% if (testCommand) { -%>
+
+## 测试
+
+```sh
+<%= testCommand %>
+```
+<% } -%>
+<% if (lintCommand) { -%>
+
+## Lint
+
+```sh
+<%= lintCommand %>
+```
+<% } -%>
+
+<% if (authorName || authorGithubUsername) { -%>
+
+## 作者
+
+<% if (authorName) { %>
+👤 **<%= authorName %>**
+<% } %>
+<% if (authorWebsite) { -%>
+* Website: [<%= authorWebsite %>](<%= authorWebsite %>)
+<% } -%>
+<% if (authorGithubUsername) { -%>
+* GitHub: [@<%= authorGithubUsername %>](https://github.com/<%= authorGithubUsername %>)
+<% } -%>
+<% } %>
+<% if (issuesUrl) { -%>
+
+## 🤝贡献
+
+欢迎 贡献、提问或提出新功能！<br />如有问题请查看 [issues page](<%= issuesUrl %>). <br/><%= contributingUrl ? `贡献或提出新功能可以查看[contributing guide](${contributingUrl}).` : '' %>
+<% } -%>
+
+## 支持
+
+如果觉得这个项目有用的话请给一颗⭐️，非常感谢
+
+<% if (licenseName && licenseUrl) { -%>
+
+## 📝 License
+
+<% if (authorName && authorGithubUsername) { -%>
+Copyright © <%= currentYear %> [<%= authorName %>](https://github.com/<%= authorGithubUsername %>).<br />
+<% } -%>
+This project is [<%= licenseName %>](<%= licenseUrl %>) licensed.
+<% } -%>
+
+***
+_This README was generated with ❤️ by [cmyr-template-cli](https://github.com/CaoMeiYouRen/cmyr-template-cli)_