cmyr-template-cli 1.7.6 → 1.9.0

package/README.md

@@ -1,6 +1,40 @@
-# cmyr-template-cli
+<h1 align="center">cmyr-template-cli </h1>
+<p>
+  <a href="https://www.npmjs.com/package/cmyr-template-cli" target="_blank">
+    <img alt="Version" src="https://img.shields.io/npm/v/cmyr-template-cli.svg">
+  </a>
+  <a href="https://github.com/CaoMeiYouRen/cmyr-template-cli/actions?query=workflow%3ARelease" target="_blank">
+    <img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/CaoMeiYouRen/cmyr-template-cli/Release">
+  </a>
+  <img src="https://img.shields.io/badge/node-%3E%3D12-blue.svg" />
+  <a href="https://github.com/CaoMeiYouRen/cmyr-template-cli#readme" target="_blank">
+    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
+  </a>
+  <a href="https://github.com/CaoMeiYouRen/cmyr-template-cli/graphs/commit-activity" target="_blank">
+    <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
+  </a>
+  <a href="https://github.com/CaoMeiYouRen/cmyr-template-cli/blob/master/LICENSE" target="_blank">
+    <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
+  </a>
+</p>
 
-草梅友仁自制的项目模板创建器
+
+> 草梅友仁自制的项目模板创建器
+
+### 🏠 [主页](https://github.com/CaoMeiYouRen/cmyr-template-cli#readme)
+
+[https://github.com/CaoMeiYouRen/cmyr-template-cli#readme](https://github.com/CaoMeiYouRen/cmyr-template-cli#readme)
+
+
+### ✨ [Demo](https://github.com/CaoMeiYouRen/cmyr-template-cli#readme)
+
+[https://github.com/CaoMeiYouRen/cmyr-template-cli#readme](https://github.com/CaoMeiYouRen/cmyr-template-cli#readme)
+
+
+## 依赖要求
+
+
+- node >=12
 
 ## 安装
 
@@ -11,13 +45,60 @@ npm i -g cmyr-template-cli
 # 或者 pnpm i -g cmyr-template-cli
 ```
 
+## 使用
 
+```sh
+ct
+# 或 
+ct create
+```
 
+## 开发
 
-## 使用
+```sh
+npm run dev
+```
 
+## 编译
 
-``` sh
-ct create
+```sh
+npm run build
 ```
 
+## Lint
+
+```sh
+npm run lint
+```
+
+## Commit
+
+```sh
+npm run commit
+```
+
+
+## 作者
+
+
+👤 **CaoMeiYouRen**
+
+* Website: [https://blog.cmyr.ltd/](https://blog.cmyr.ltd/)
+* GitHub: [@CaoMeiYouRen](https://github.com/CaoMeiYouRen)
+
+
+## 🤝贡献
+
+欢迎 贡献、提问或提出新功能！<br />如有问题请查看 [issues page](https://github.com/CaoMeiYouRen/cmyr-template-cli/issues). <br/>贡献或提出新功能可以查看[contributing guide](https://github.com/CaoMeiYouRen/cmyr-template-cli/blob/master/CONTRIBUTING.md).
+
+## 💰支持
+
+如果觉得这个项目有用的话请给一颗⭐️，非常感谢
+
+## 📝 License
+
+Copyright © 2021 [CaoMeiYouRen](https://github.com/CaoMeiYouRen).<br />
+This project is [MIT](https://github.com/CaoMeiYouRen/cmyr-template-cli/blob/master/LICENSE) licensed.
+
+***
+_This README was generated with ❤️ by [cmyr-template-cli](https://github.com/CaoMeiYouRen/cmyr-template-cli)_

package/dist/index.js

@@ -13,7 +13,7 @@ var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
 
 const program = new commander.Command('ct')
     .description('草梅项目创建器');
-program.version("1.7.5" , '-v, --version');
+program.version("1.8.2" , '-v, --version');
 const args = process.argv.slice(2);
 if (args.length === 0) {
     args.push('create');

package/dist/plopfile.js

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 'use strict';
 
+var lodash = require('lodash');
 var fs = require('fs-extra');
 var path = require('path');
 var ora = require('ora');
@@ -9,7 +10,6 @@ var axios = require('axios');
 var child_process = require('child_process');
 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 }; }
@@ -115,7 +115,7 @@ async function initProject(answers) {
 }
 async function init(projectPath, answers) {
     var _a;
-    const { isOpenSource, isRemoveDependabot, gitRemoteUrl, isInitReadme, isInitContributing, isInitHusky, isInitSemanticRelease } = answers;
+    const { isOpenSource, gitRemoteUrl, isInitReadme, isInitContributing, isInitHusky, isInitSemanticRelease } = answers;
     try {
         await asyncExec('git --version', {
             cwd: projectPath,
@@ -132,16 +132,8 @@ async function init(projectPath, answers) {
             });
             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) {
-            if (await fs__default["default"].pathExists(dependabotPath)) {
-                await fs__default["default"].remove(dependabotPath);
-            }
-            if (await fs__default["default"].pathExists(mergifyPath)) {
-                await fs__default["default"].remove(mergifyPath);
-            }
-        }
+        await initDependabot(projectPath, answers);
+        await initYarn(projectPath, answers);
         const newPkg = await initProjectJson(projectPath, answers);
         if (isInitSemanticRelease) {
             await initSemanticRelease(projectPath);
@@ -158,9 +150,7 @@ async function init(projectPath, answers) {
                 if (isInitContributing) {
                     await initContributing(projectPath, info);
                 }
-                if (info.licenseName === 'MIT') {
-                    await initLicense(projectPath, info);
-                }
+                await initLicense(projectPath, info);
             }
             await initGithubWorkflows(projectPath, answers);
         }
@@ -204,6 +194,38 @@ async function getGitUserName() {
     const username = (await asyncExec('git config user.name')) || '';
     return username.trim();
 }
+async function initDependabot(projectPath, answers) {
+    try {
+        const { isOpenSource, isRemoveDependabot } = answers;
+        const dependabotPath = path__default["default"].join(projectPath, '.github/dependabot.yml');
+        const mergifyPath = path__default["default"].join(projectPath, '.github/mergify.yml');
+        if (!isOpenSource || isRemoveDependabot) {
+            if (await fs__default["default"].pathExists(dependabotPath)) {
+                await fs__default["default"].remove(dependabotPath);
+            }
+            if (await fs__default["default"].pathExists(mergifyPath)) {
+                await fs__default["default"].remove(mergifyPath);
+            }
+        }
+    }
+    catch (error) {
+        console.error(error);
+    }
+}
+async function initYarn(projectPath, answers) {
+    try {
+        const { isRemoveYarn } = answers;
+        const yarnPath = path__default["default"].join(projectPath, 'yarn.lock');
+        if (isRemoveYarn) {
+            if (await fs__default["default"].pathExists(yarnPath)) {
+                await fs__default["default"].remove(yarnPath);
+            }
+        }
+    }
+    catch (error) {
+        console.error(error);
+    }
+}
 async function initProjectJson(projectPath, answers) {
     const loading = ora__default["default"]('正在初始化 package.json ……').start();
     try {
@@ -247,6 +269,11 @@ async function initProjectJson(projectPath, answers) {
                 },
             };
         }
+        if (isPublishToNpm) {
+            extData.publishConfig = {
+                access: 'public',
+            };
+        }
         const newPkg = Object.assign({}, pkg, pkgData, extData);
         await saveProjectJson(projectPath, newPkg);
         loading.succeed('package.json 初始化成功！');
@@ -303,6 +330,7 @@ async function getProjectInfo(projectPath, answers) {
             authorName: author,
             authorGithubUsername: githubUsername,
             engines,
+            license,
             licenseName: cleanText(license),
             licenseUrl,
             documentationUrl,
@@ -386,7 +414,14 @@ async function initContributing(projectPath, projectInfos) {
 async function initLicense(projectPath, projectInfos) {
     const loading = ora__default["default"]('正在初始化 LICENSE ……').start();
     try {
-        const templatePath = path__default["default"].join(__dirname, '../templates/LICENSE');
+        let templatePath = '';
+        if (projectInfos.licenseName === 'MIT') {
+            templatePath = path__default["default"].join(__dirname, '../templates/licenses/MIT');
+        }
+        if (!templatePath) {
+            loading.fail('无效的 LICENSE Name');
+            return;
+        }
         const template = (await fs__default["default"].readFile(templatePath, 'utf8')).toString();
         const newReadmePath = path__default["default"].join(projectPath, 'LICENSE');
         const readmeContent = await ejs__default["default"].render(template, projectInfos, {
@@ -669,7 +704,7 @@ module.exports = function (plop) {
                         return input.trim().length !== 0;
                     },
                     default: '',
-                    filter: (e) => e.trim(),
+                    filter: (e) => lodash.kebabCase(e.trim()),
                 },
                 {
                     type: 'input',
@@ -809,6 +844,15 @@ module.exports = function (plop) {
                         return answers.isOpenSource;
                     },
                 },
+                {
+                    type: 'confirm',
+                    name: 'isRemoveYarn',
+                    message: '是否移除 yarn ？',
+                    default: false,
+                    when(answers) {
+                        return answers.isOpenSource;
+                    },
+                },
                 {
                     type: 'confirm',
                     name: 'isEnableAfdian',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cmyr-template-cli",
-  "version": "1.7.6",
+  "version": "1.9.0",
   "description": "草梅友仁自制的项目模板创建器",
   "author": "CaoMeiYouRen",
   "license": "MIT",
@@ -49,7 +49,7 @@
     "@typescript-eslint/parser": "^4.9.0",
     "commitizen": "^4.2.2",
     "conventional-changelog-cli": "^2.1.1",
-    "conventional-changelog-cmyr-config": "^1.2.3",
+    "conventional-changelog-cmyr-config": "^2.0.2",
     "cross-env": "^7.0.2",
     "cz-conventional-changelog": "^3.3.0",
     "cz-conventional-changelog-cmyr": "^1.0.0",

package/templates/.github/workflows/release.yml

@@ -13,7 +13,7 @@ jobs:
         uses: actions/setup-node@v2
         with:
           node-version: "lts/*"
-          cache: "yarn"
+          # cache: "yarn"
       - name: Cache multiple paths
         uses: actions/cache@v2
         with:
@@ -24,9 +24,9 @@ jobs:
             **/node_modules
           key: npm-${{ runner.os }}-${{ hashFiles('package.json') }}
       - run: yarn
-      - run: npm run lint
-      - run: npm run build
+      - run: yarn run lint
+      - run: yarn run build
       - env:
           GH_TOKEN: ${{ secrets.GH_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: npm run release
+        run: yarn run release

package/templates/.github/workflows/test.yml

@@ -10,7 +10,7 @@ jobs:
         uses: actions/setup-node@v2
         with:
           node-version: "lts/*"
-          cache: "yarn"
+          # cache: "yarn"
       - name: Cache multiple paths
         uses: actions/cache@v2
         with:
@@ -21,5 +21,5 @@ jobs:
             **/node_modules
           key: npm-${{ runner.os }}-${{ hashFiles('package.json') }}
       - run: yarn
-      - run: npm run lint
-      - run: npm run build
+      - run: yarn run lint
+      - run: yarn run build

package/templates/CONTRIBUTING.md

@@ -2,6 +2,12 @@
 
 在为此存储库做出贡献时，请首先通过 issue、电子邮件或任何其他方法与此存储库的所有者讨论您希望进行的更改，然后再进行更改。
 
+**注意**:
+
+- 提问之前请三思，不要浪费我们的时间
+- 不要问那些你自己就能搞清楚的问题
+- 不要问在文档中提过的问题
+
 ## 开发环境设置
 
 要设置开发环境，请按照以下步骤操作：
@@ -29,7 +35,7 @@
 
 ## 问题和功能请求
 
-你在源代码中发现了一个错误，文档中有一个错误，或者你想要一个新功能？ 看看[GitHub 讨论](<%= discussionsUrl %>)看看它是否已经在讨论中。您可以通过[在 GitHub 上提交问题](<%= issuesUrl %>)来帮助我们。在创建问题之前，请确保搜索问题存档 - 您的问题可能已经得到解决！
+你在源代码中发现了一个错误，文档中有一个错误，或者你想要一个新功能？ 看看[GitHub 讨论](<%= discussionsUrl %>)看看它是否已经在讨论中。您可以通过[在 GitHub 上提交问题](<%= issuesUrl %>)来帮助我们。在创建问题之前，请确保搜索[问题存档](<%= issuesUrl %>?q=is%3Aissue+is%3Aclosed) - 您的问题可能已经得到解决！
 
 请尝试创建以下错误报告：
 
@@ -68,6 +74,7 @@
 
     -   若为 BUG 修复，则选择 `fix`
     -   若为新增功能，则选择 `feat`
+    -   若为性能优化，则选择 `perf`
     -   若为移除某些功能，则选择 `BREAKING CHANGE`
         -    `BREAKING CHANGE` 和其他破坏性更新，若不是为了修复 BUG，原则上将拒绝该 PR
 
@@ -75,3 +82,6 @@
 5. 推送到分支 ( `git push origin feat/your_feature`)
 
 6. [打开一个新的 Pull Request](<%= repositoryUrl %>/compare?expand=1)
+
+***
+_This CONTRIBUTING was generated with ❤️ by [cmyr-template-cli](https://github.com/CaoMeiYouRen/cmyr-template-cli)_