cmyr-template-cli 1.6.0 → 1.7.0

package/dist/index.js

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

package/dist/plopfile.js

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 'use strict';
 
-var path = require('path');
 var fs = require('fs-extra');
+var path = require('path');
 var ora = require('ora');
 var download = require('download-git-repo');
 var axios = require('axios');
@@ -32,8 +32,8 @@ function _interopNamespace(e) {
     return Object.freeze(n);
 }
 
-var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
 var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
+var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
 var ora__default = /*#__PURE__*/_interopDefaultLegacy(ora);
 var download__default = /*#__PURE__*/_interopDefaultLegacy(download);
 var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
@@ -106,8 +106,16 @@ async function asyncExec(cmd, options) {
         });
     });
 }
+async function initProject(answers) {
+    const { name, template } = answers;
+    const projectPath = path__default["default"].join(process.cwd(), name);
+    await downloadGitRepo(`CaoMeiYouRen/${template}`, projectPath);
+    await init(projectPath, answers);
+    return '- 下载项目模板成功！';
+}
 async function init(projectPath, answers) {
-    const { isOpenSource, isRemoveDependabot, gitRemoteUrl, isInitReadme, isInitContributing } = answers;
+    var _a;
+    const { isOpenSource, isRemoveDependabot, gitRemoteUrl, isInitReadme, isInitContributing, isInitHusky } = answers;
     try {
         await asyncExec('git --version', {
             cwd: projectPath,
@@ -134,7 +142,7 @@ async function init(projectPath, answers) {
                 await fs__default["default"].remove(mergifyPath);
             }
         }
-        await initProjectJson(projectPath, answers);
+        const newPkg = await initProjectJson(projectPath, answers);
         if (isOpenSource) {
             const info = await getProjectInfo(projectPath, answers);
             if (info) {
@@ -144,14 +152,19 @@ async function init(projectPath, answers) {
                 if (isInitContributing) {
                     await initContributing(projectPath, info);
                 }
+                if (info.licenseName === 'MIT') {
+                    await initLicense(projectPath, info);
+                }
+                if (isInitHusky) {
+                    await initHusky(projectPath, info);
+                }
             }
+            await initGithubWorkflows(projectPath, info);
         }
+        await initConfig(projectPath);
         await asyncExec('git add .', {
             cwd: projectPath,
         });
-        await asyncExec('git commit -m "chore: init"', {
-            cwd: projectPath,
-        });
         const loading = ora__default["default"]('正在安装依赖……').start();
         try {
             await asyncExec(`${PACKAGE_MANAGER} i`, {
@@ -161,17 +174,29 @@ async function init(projectPath, answers) {
         }
         catch (error) {
             loading.fail('依赖安装失败！');
+            process.exit(1);
+        }
+        await asyncExec('git add .', {
+            cwd: projectPath,
+        });
+        if ((_a = newPkg === null || newPkg === void 0 ? void 0 : newPkg.scripts) === null || _a === void 0 ? void 0 : _a.lint) {
+            await asyncExec(`${PACKAGE_MANAGER} run lint`, {
+                cwd: projectPath,
+            });
         }
         await asyncExec('git add .', {
             cwd: projectPath,
         });
+        await asyncExec('git commit -m "chore: init"', {
+            cwd: projectPath,
+        });
     }
     catch (error) {
         console.error(error);
     }
 }
 async function getGitUserName() {
-    const username = (await asyncExec('git config user.name'));
+    const username = (await asyncExec('git config user.name')) || '';
     return username.trim();
 }
 async function initProjectJson(projectPath, answers) {
@@ -182,7 +207,7 @@ async function initProjectJson(projectPath, answers) {
         const homepage = `${repositoryUrl}#readme`;
         const issuesUrl = `${repositoryUrl}/issues`;
         const gitUrl = `git+${repositoryUrl}.git`;
-        const nodeVersion = await getLtsNodeVersion() || '12';
+        const nodeVersion = await getLtsNodeVersion() || '16';
         const node = Number(nodeVersion) - 4;
         const pkgPath = path__default["default"].join(projectPath, 'package.json');
         const pkg = await fs__default["default"].readJSON(pkgPath);
@@ -208,11 +233,20 @@ async function initProjectJson(projectPath, answers) {
                 bugs: {
                     url: issuesUrl,
                 },
+                devDependencies: {
+                    'conventional-changelog-cli': '^2.1.1',
+                    'conventional-changelog-cmyr-config': `^${await getNpmPackageVersion('conventional-changelog-cmyr-config')}`,
+                    ...pkg === null || pkg === void 0 ? void 0 : pkg.devDependencies,
+                },
+                changelog: {
+                    language: 'zh',
+                },
             };
         }
         const newPkg = Object.assign({}, pkg, pkgData, extData);
         await fs__default["default"].writeFile(pkgPath, JSON.stringify(newPkg, null, 2));
         loading.succeed('package.json 初始化成功！');
+        return newPkg;
     }
     catch (error) {
         console.error(error);
@@ -249,6 +283,7 @@ async function getProjectInfo(projectPath, answers) {
         const discussionsUrl = `${repositoryUrl}/discussions`;
         const pullRequestsUrl = `${repositoryUrl}/pulls`;
         const projectInfos = {
+            ...answers,
             currentYear: new Date().getFullYear(),
             name,
             description,
@@ -343,6 +378,143 @@ async function initContributing(projectPath, projectInfos) {
         console.error(error);
     }
 }
+async function initLicense(projectPath, projectInfos) {
+    const loading = ora__default["default"]('正在初始化 LICENSE ……').start();
+    try {
+        const templatePath = path__default["default"].join(__dirname, '../templates/LICENSE');
+        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, {
+            debug: false,
+            async: true,
+        });
+        if (await fs__default["default"].pathExists(newReadmePath)) {
+            await fs__default["default"].remove(newReadmePath);
+        }
+        await fs__default["default"].writeFile(newReadmePath, lodash.unescape(readmeContent));
+        loading.succeed('LICENSE 初始化成功！');
+    }
+    catch (error) {
+        loading.fail('LICENSE 初始化失败！');
+        console.error(error);
+    }
+}
+async function initConfig(projectPath) {
+    try {
+        const files = ['.editorconfig', 'commitlint.config.js'];
+        files.forEach(async (file) => {
+            const templatePath = path__default["default"].join(__dirname, '../templates/', file);
+            const newPath = path__default["default"].join(projectPath, file);
+            if (await fs__default["default"].pathExists(newPath)) {
+                await fs__default["default"].remove(newPath);
+            }
+            await fs__default["default"].copyFile(templatePath, newPath);
+        });
+    }
+    catch (error) {
+        console.error(error);
+    }
+}
+async function initGithubWorkflows(projectPath, projectInfos) {
+    const loading = ora__default["default"]('正在初始化 Github Workflows ……').start();
+    try {
+        const { isPublishToNpm } = projectInfos;
+        const files = ['.github/workflows/test.yml'];
+        const dir = path__default["default"].join(projectPath, '.github/workflows');
+        if (!await fs__default["default"].pathExists(dir)) {
+            await fs__default["default"].mkdirp(dir);
+        }
+        const releaseYml = '.github/workflows/release.yml';
+        if (isPublishToNpm) {
+            files.push(releaseYml);
+            const oldReleaseYml = path__default["default"].join(projectPath, '.github/release.yml');
+            if (await fs__default["default"].pathExists(oldReleaseYml)) {
+                await fs__default["default"].remove(oldReleaseYml);
+            }
+        }
+        else {
+            const oldReleaseYml = path__default["default"].join(projectPath, releaseYml);
+            if (await fs__default["default"].pathExists(oldReleaseYml)) {
+                await fs__default["default"].remove(oldReleaseYml);
+            }
+        }
+        files.forEach(async (file) => {
+            const templatePath = path__default["default"].join(__dirname, '../templates/', file);
+            const newPath = path__default["default"].join(projectPath, file);
+            if (await fs__default["default"].pathExists(newPath)) {
+                await fs__default["default"].remove(newPath);
+            }
+            await fs__default["default"].copyFile(templatePath, newPath);
+        });
+        loading.succeed('Github Workflows 初始化成功！');
+    }
+    catch (error) {
+        loading.fail('Github Workflows 初始化失败！');
+        console.error(error);
+    }
+}
+async function initHusky(projectPath, projectInfos) {
+    var _a, _b;
+    const loading = ora__default["default"]('正在初始化 husky ……').start();
+    try {
+        const files = ['.husky/commit-msg', '.husky/pre-commit'];
+        const dir = path__default["default"].join(projectPath, '.husky');
+        if (!await fs__default["default"].pathExists(dir)) {
+            await fs__default["default"].mkdirp(dir);
+        }
+        files.forEach(async (file) => {
+            const templatePath = path__default["default"].join(__dirname, '../templates/', file);
+            const newPath = path__default["default"].join(projectPath, file);
+            if (await fs__default["default"].pathExists(newPath)) {
+                await fs__default["default"].remove(newPath);
+            }
+            await fs__default["default"].copyFile(templatePath, newPath);
+        });
+        const extnames = ['js', 'ts'];
+        const pkgPath = path__default["default"].join(projectPath, 'package.json');
+        const pkg = await fs__default["default"].readJSON(pkgPath);
+        if ((_a = pkg === null || pkg === void 0 ? void 0 : pkg.dependencies) === null || _a === void 0 ? void 0 : _a.vue) {
+            extnames.push('vue');
+        }
+        if ((_b = pkg === null || pkg === void 0 ? void 0 : pkg.dependencies) === null || _b === void 0 ? void 0 : _b.react) {
+            extnames.push('jsx', 'tsx');
+        }
+        const keyname = `*.{${extnames.join(',')}}`;
+        const devDependencies = {
+            '@commitlint/cli': '^15.0.0',
+            '@commitlint/config-conventional': '^15.0.0',
+            commitizen: '^4.2.3',
+            'cz-conventional-changelog': '^3.3.0',
+            husky: '^7.0.4',
+            'lint-staged': '^12.1.2',
+        };
+        const pkgData = {
+            devDependencies: {
+                ...devDependencies,
+                ...pkg === null || pkg === void 0 ? void 0 : pkg.devDependencies,
+            },
+            husky: undefined,
+            config: {
+                commitizen: {
+                    path: 'cz-conventional-changelog',
+                },
+            },
+            'lint-staged': {
+                [keyname]: [
+                    'npm run lint',
+                    'git add',
+                ],
+            },
+        };
+        const newPkg = Object.assign({}, pkg, pkgData);
+        await fs__default["default"].writeFile(pkgPath, JSON.stringify(newPkg, null, 2));
+        loading.succeed('husky 初始化成功！');
+    }
+    catch (error) {
+        loading.fail('husky 初始化失败！');
+        console.error(error);
+    }
+}
 async function getAuthorWebsiteFromGithubAPI(githubUsername) {
     try {
         const userData = (await axios__default["default"].get(`${GITHUB_API_URL}/users/${githubUsername}`)).data;
@@ -366,6 +538,10 @@ async function getLtsNodeVersion() {
         return '';
     }
 }
+async function getNpmPackageVersion(name) {
+    const version = (await asyncExec(`${PACKAGE_MANAGER} view ${name} version`)) || '';
+    return version.trim();
+}
 function lintMd(markdown) {
     const rules = {
         'no-empty-code': 0,
@@ -379,13 +555,7 @@ function lintMd(markdown) {
 }
 
 module.exports = function (plop) {
-    plop.setActionType('initProject', async (answers) => {
-        const { name, template } = answers;
-        const projectPath = path__default["default"].join(process.cwd(), name);
-        await downloadGitRepo(`CaoMeiYouRen/${template}`, projectPath);
-        await init(projectPath, answers);
-        return '- 下载项目模板成功！';
-    });
+    plop.setActionType('initProject', initProject);
     plop.setGenerator('create', {
         description: '草梅项目创建器',
         async prompts(inquirer) {
@@ -484,6 +654,15 @@ module.exports = function (plop) {
                         return answers.isOpenSource;
                     },
                 },
+                {
+                    type: 'confirm',
+                    name: 'isInitHusky',
+                    message: '是否初始化 husky？',
+                    default: false,
+                    when(answers) {
+                        return answers.isOpenSource;
+                    },
+                },
                 {
                     type: 'confirm',
                     name: 'isInitReadme',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cmyr-template-cli",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "草梅友仁自制的项目模板创建器",
   "author": "CaoMeiYouRen",
   "license": "MIT",

package/templates/.editorconfig

@@ -0,0 +1,26 @@
+# http://editorconfig.org
+#启用编辑器配置
+root = true
+# 对所有文件生效
+[*]
+#编码方式
+charset = utf-8
+#缩进格式
+indent_style = space
+indent_size = 4
+#换行符
+end_of_line = lf
+#插入最终换行符
+insert_final_newline = true
+#修剪尾随空格
+trim_trailing_whitespace = true
+# 对后缀名为 md 的文件生效
+[*.md]
+trim_trailing_whitespace = false
+[*.sh]
+#换行符
+end_of_line = lf
+[package.json]
+indent_size = 2
+[*.yml]
+indent_size = 2

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

@@ -0,0 +1,32 @@
+name: Release
+on:
+  push:
+    branches:
+      - master
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v2.1.2
+        with:
+          node-version: "lts/*"
+          cache: "yarn"
+      - name: Cache multiple paths
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.npm
+            ~/cache
+            !~/cache/exclude
+            **/node_modules
+          key: npm-${{ runner.os }}-${{ hashFiles('package.json') }}
+      - run: yarn
+      - run: npm run lint
+      - run: npm run build
+      - env:
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm run release

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

@@ -0,0 +1,25 @@
+name: Test
+on: [push, pull_request]
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Node.js@lts environment
+        uses: actions/setup-node@v2
+        with:
+          node-version: "lts/*"
+          cache: "yarn"
+      - name: Cache multiple paths
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.npm
+            ~/cache
+            !~/cache/exclude
+            **/node_modules
+          key: npm-${{ runner.os }}-${{ hashFiles('package.json') }}
+      - run: yarn
+      - run: npm run lint
+      - run: npm run build

package/templates/.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no-install commitlint --edit "$1"

package/templates/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no-install lint-staged

package/templates/CONTRIBUTING.md

@@ -9,7 +9,7 @@
 1. Clone 本项目
 
    ```sh
-   git clone <%= repositoryUrl %>
+   git clone <%= repositoryUrl %>.git
    ```
 
 2.  安装依赖
@@ -19,10 +19,9 @@
    # 或 yarn
    # 或 pnpm i
    ```
-
+<% if (devCommand) { -%>
 3.  运行开发环境
 
-<% if (devCommand) { -%>
 ```sh
 <%= devCommand %>
 ```
@@ -34,12 +33,12 @@
 
 请尝试创建以下错误报告：
 
-- *可重现。*包括重现问题的步骤。
-- *具体的。*包括尽可能多的细节：哪个版本，什么环境等。
-- *独特的。*不要复制现有的已打开问题。
-- *范围仅限于单个错误。*每个报告一个错误。
+- *可重现*。包括重现问题的步骤。
+- *具体的*。包括尽可能多的细节：哪个版本，什么环境等。
+- *独特的*。不要复制现有的已打开问题。
+- *范围仅限于单个错误*。每个报告一个错误。
 
-**更好的是：提交带有修复或新功能的拉取请求！**
+**更好的是：提交带有修复或新功能的 Pull Requests！**
 
 ### 如何提交拉取请求
 
@@ -65,14 +64,14 @@
     #若觉得修改太多也可分开提交。先 git add 一部分，执行 git cz 提交后再提交另外一部分
     ```
 
-​	关于选项，参考 [semantic-release](https://github.com/semantic-release/semantic-release) 的文档
+    关于选项，参考 [semantic-release](https://github.com/semantic-release/semantic-release) 的文档
 
--   若为 BUG 修复，则选择 `fix`
--   若为新增功能，则选择 `feat`，新增音声可以按这个提交。
--   若为移除某些功能，则选择 `perf`  或填写 `BREAKING CHANGE`
-    -    `perf` 和其他破坏性更新，若不是为了修复 BUG，原则上将拒绝该 PR
+    -   若为 BUG 修复，则选择 `fix`
+    -   若为新增功能，则选择 `feat`
+    -   若为移除某些功能，则选择 `perf`  或填写 `BREAKING CHANGE`
+        -    `perf` 和其他破坏性更新，若不是为了修复 BUG，原则上将拒绝该 PR
 
 
 5. 推送到分支 ( `git push origin feat/your_feature`)
 
-6. [打开一个新的 Pull Request](<%= repositoryUrl %>/compare?expand=1)
+6. [打开一个新的 Pull Request](<%= repositoryUrl %>/compare?expand=1)

package/templates/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) <%= currentYear %> <%= authorName %>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/templates/commitlint.config.js

@@ -0,0 +1,20 @@
+module.exports = {
+    extends: ['@commitlint/config-conventional'],
+    rules: {
+        'type-enum': [2, 'always', [
+            'feat',
+            'fix',
+            'docs',
+            'style',
+            'refactor',
+            'perf',
+            'test',
+            'build',
+            'ci',
+            'chore',
+            'revert',
+        ]],
+        'subject-full-stop': [0, 'never'],
+        'subject-case': [0, 'never'],
+    },
+}