cmyr-template-cli 1.7.0 → 1.7.4

package/dist/index.js

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

package/dist/plopfile.js

@@ -115,7 +115,7 @@ async function initProject(answers) {
 }
 async function init(projectPath, answers) {
     var _a;
-    const { isOpenSource, isRemoveDependabot, gitRemoteUrl, isInitReadme, isInitContributing, isInitHusky } = answers;
+    const { isOpenSource, isRemoveDependabot, gitRemoteUrl, isInitReadme, isInitContributing, isInitHusky, isInitSemanticRelease } = answers;
     try {
         await asyncExec('git --version', {
             cwd: projectPath,
@@ -143,6 +143,12 @@ async function init(projectPath, answers) {
             }
         }
         const newPkg = await initProjectJson(projectPath, answers);
+        if (isInitSemanticRelease) {
+            await initSemanticRelease(projectPath);
+        }
+        if (isInitHusky) {
+            await initHusky(projectPath);
+        }
         if (isOpenSource) {
             const info = await getProjectInfo(projectPath, answers);
             if (info) {
@@ -155,13 +161,11 @@ async function init(projectPath, answers) {
                 if (info.licenseName === 'MIT') {
                     await initLicense(projectPath, info);
                 }
-                if (isInitHusky) {
-                    await initHusky(projectPath, info);
-                }
             }
-            await initGithubWorkflows(projectPath, info);
+            await initGithubWorkflows(projectPath, answers);
         }
         await initConfig(projectPath);
+        await sortProjectJson(projectPath);
         await asyncExec('git add .', {
             cwd: projectPath,
         });
@@ -209,8 +213,7 @@ async function initProjectJson(projectPath, answers) {
         const gitUrl = `git+${repositoryUrl}.git`;
         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);
+        const pkg = await getProjectJson(projectPath);
         const pkgData = {
             name,
             author,
@@ -218,8 +221,13 @@ async function initProjectJson(projectPath, answers) {
             private: !isPublishToNpm,
             license: 'UNLICENSED',
             engines: {
+                ...(pkg === null || pkg === void 0 ? void 0 : pkg.engines) || {},
                 node: `>=${node}`,
             },
+            devDependencies: {
+                ...pkg === null || pkg === void 0 ? void 0 : pkg.devDependencies,
+                'eslint-config-cmyr': `^${await getNpmPackageVersion('eslint-config-cmyr')}`,
+            },
         };
         let extData = {};
         if (isOpenSource) {
@@ -233,18 +241,13 @@ 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));
+        await saveProjectJson(projectPath, newPkg);
         loading.succeed('package.json 初始化成功！');
         return newPkg;
     }
@@ -255,13 +258,12 @@ async function initProjectJson(projectPath, answers) {
 }
 const cleanText = (text) => text.replace(/-/g, '--').replace(/_/g, '__');
 async function getProjectInfo(projectPath, answers) {
-    var _a, _b, _c, _d, _e;
+    var _a, _b, _c, _d, _e, _f;
     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 pkg = await getProjectJson(projectPath);
         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;
@@ -271,6 +273,7 @@ async function getProjectInfo(projectPath, answers) {
         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 commitCommand = ((_f = pkg === null || pkg === void 0 ? void 0 : pkg.scripts) === null || _f === void 0 ? void 0 : _f.commit) && `${packageManager} run commit`;
         const repositoryUrl = `https://github.com/${author}/${name}`;
         const issuesUrl = `${repositoryUrl}/issues`;
         const contributingUrl = `${repositoryUrl}/blob/master/CONTRIBUTING.md`;
@@ -310,6 +313,7 @@ async function getProjectInfo(projectPath, answers) {
             buildCommand,
             testCommand,
             lintCommand,
+            commitCommand,
             isJSProject: true,
             packageManager,
             isProjectOnNpm: isPublishToNpm,
@@ -415,22 +419,18 @@ async function initConfig(projectPath) {
         console.error(error);
     }
 }
-async function initGithubWorkflows(projectPath, projectInfos) {
+async function initGithubWorkflows(projectPath, answers) {
     const loading = ora__default["default"]('正在初始化 Github Workflows ……').start();
     try {
-        const { isPublishToNpm } = projectInfos;
+        const { isInitSemanticRelease } = answers;
         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) {
+        if (isInitSemanticRelease) {
             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);
@@ -438,6 +438,10 @@ async function initGithubWorkflows(projectPath, projectInfos) {
                 await fs__default["default"].remove(oldReleaseYml);
             }
         }
+        const oldReleaseYml = path__default["default"].join(projectPath, '.github/release.yml');
+        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);
@@ -453,7 +457,44 @@ async function initGithubWorkflows(projectPath, projectInfos) {
         console.error(error);
     }
 }
-async function initHusky(projectPath, projectInfos) {
+async function initSemanticRelease(projectPath) {
+    const loading = ora__default["default"]('正在初始化 semantic-release ……').start();
+    try {
+        const files = ['.releaserc.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);
+        });
+        const pkg = await getProjectJson(projectPath);
+        const devDependencies = {
+            '@semantic-release/changelog': '^6.0.1',
+            '@semantic-release/git': '^10.0.1',
+            'semantic-release': '^18.0.1',
+        };
+        const pkgData = {
+            scripts: {
+                release: 'semantic-release',
+                ...pkg === null || pkg === void 0 ? void 0 : pkg.scripts,
+            },
+            devDependencies: {
+                ...devDependencies,
+                ...pkg === null || pkg === void 0 ? void 0 : pkg.devDependencies,
+                'conventional-changelog-cmyr-config': `^${await getNpmPackageVersion('conventional-changelog-cmyr-config')}`,
+            },
+        };
+        await saveProjectJson(projectPath, pkgData);
+        loading.succeed('semantic-release 初始化成功！');
+    }
+    catch (error) {
+        loading.fail('semantic-release 初始化失败！');
+        console.error(error);
+    }
+}
+async function initHusky(projectPath) {
     var _a, _b;
     const loading = ora__default["default"]('正在初始化 husky ……').start();
     try {
@@ -471,8 +512,7 @@ async function initHusky(projectPath, projectInfos) {
             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);
+        const pkg = await getProjectJson(projectPath);
         if ((_a = pkg === null || pkg === void 0 ? void 0 : pkg.dependencies) === null || _a === void 0 ? void 0 : _a.vue) {
             extnames.push('vue');
         }
@@ -489,6 +529,11 @@ async function initHusky(projectPath, projectInfos) {
             'lint-staged': '^12.1.2',
         };
         const pkgData = {
+            scripts: {
+                commit: 'cz',
+                ...pkg === null || pkg === void 0 ? void 0 : pkg.scripts,
+                prepare: 'husky install',
+            },
             devDependencies: {
                 ...devDependencies,
                 ...pkg === null || pkg === void 0 ? void 0 : pkg.devDependencies,
@@ -506,8 +551,7 @@ async function initHusky(projectPath, projectInfos) {
                 ],
             },
         };
-        const newPkg = Object.assign({}, pkg, pkgData);
-        await fs__default["default"].writeFile(pkgPath, JSON.stringify(newPkg, null, 2));
+        await saveProjectJson(projectPath, pkgData);
         loading.succeed('husky 初始化成功！');
     }
     catch (error) {
@@ -515,6 +559,19 @@ async function initHusky(projectPath, projectInfos) {
         console.error(error);
     }
 }
+async function sortProjectJson(projectPath) {
+    try {
+        const pkg = await getProjectJson(projectPath);
+        const pkgData = {
+            dependencies: sortKey((pkg === null || pkg === void 0 ? void 0 : pkg.dependencies) || {}),
+            devDependencies: sortKey((pkg === null || pkg === void 0 ? void 0 : pkg.devDependencies) || {}),
+        };
+        await saveProjectJson(projectPath, pkgData);
+    }
+    catch (error) {
+        console.error(error);
+    }
+}
 async function getAuthorWebsiteFromGithubAPI(githubUsername) {
     try {
         const userData = (await axios__default["default"].get(`${GITHUB_API_URL}/users/${githubUsername}`)).data;
@@ -553,6 +610,25 @@ function lintMd(markdown) {
     const fixed = core.fix(markdown, rules);
     return fixed;
 }
+function sortKey(obj) {
+    const keys = Object.keys(obj).sort((a, b) => a.localeCompare(b));
+    const obj2 = {};
+    keys.forEach((e) => {
+        obj2[e] = obj[e];
+    });
+    return obj2;
+}
+async function getProjectJson(projectPath) {
+    const pkgPath = path__default["default"].join(projectPath, 'package.json');
+    const pkg = await fs__default["default"].readJSON(pkgPath);
+    return pkg;
+}
+async function saveProjectJson(projectPath, pkgData) {
+    const pkgPath = path__default["default"].join(projectPath, 'package.json');
+    const pkg = await getProjectJson(projectPath);
+    const newPkg = Object.assign({}, pkg, pkgData);
+    await fs__default["default"].writeFile(pkgPath, JSON.stringify(newPkg, null, 2));
+}
 
 module.exports = function (plop) {
     plop.setActionType('initProject', initProject);
@@ -654,11 +730,26 @@ module.exports = function (plop) {
                         return answers.isOpenSource;
                     },
                 },
+                {
+                    type: 'confirm',
+                    name: 'isInitSemanticRelease',
+                    message: '是否初始化 semantic-release？',
+                    default(answers) {
+                        const { isPublishToNpm } = answers;
+                        return isPublishToNpm;
+                    },
+                    when(answers) {
+                        return answers.isOpenSource;
+                    },
+                },
                 {
                     type: 'confirm',
                     name: 'isInitHusky',
                     message: '是否初始化 husky？',
-                    default: false,
+                    default(answers) {
+                        const { isPublishToNpm } = answers;
+                        return isPublishToNpm;
+                    },
                     when(answers) {
                         return answers.isOpenSource;
                     },
@@ -676,7 +767,10 @@ module.exports = function (plop) {
                     type: 'confirm',
                     name: 'isInitContributing',
                     message: '是否初始化 贡献指南(CONTRIBUTING.md) ？',
-                    default: true,
+                    default(answers) {
+                        const { isPublishToNpm } = answers;
+                        return isPublishToNpm;
+                    },
                     when(answers) {
                         return answers.isOpenSource;
                     },
@@ -690,6 +784,15 @@ module.exports = function (plop) {
                         return answers.isOpenSource;
                     },
                 },
+                {
+                    type: 'confirm',
+                    name: 'isEnableAfdian',
+                    message: '是否启用爱发电 ？',
+                    default: false,
+                    when(answers) {
+                        return answers.isOpenSource;
+                    },
+                },
             ];
             return inquirer.prompt(questions);
         },

package/package.json

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

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

@@ -10,7 +10,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: Setup Node.js environment
-        uses: actions/setup-node@v2.1.2
+        uses: actions/setup-node@v2
         with:
           node-version: "lts/*"
           cache: "yarn"

package/templates/.releaserc.js

@@ -0,0 +1,36 @@
+const { name } = require('./package.json')
+module.exports = {
+    plugins: [
+        [
+            "@semantic-release/commit-analyzer",
+            {
+                "config": "conventional-changelog-cmyr-config"
+            }
+        ],
+        [
+            "@semantic-release/release-notes-generator",
+            {
+                "config": "conventional-changelog-cmyr-config"
+            }
+        ],
+        [
+            "@semantic-release/changelog",
+            {
+                "changelogFile": "CHANGELOG.md",
+                "changelogTitle": "# " + name
+            }
+        ],
+        '@semantic-release/npm',
+        '@semantic-release/github',
+        [
+            "@semantic-release/git",
+            {
+                "assets": [
+                    "src",
+                    "CHANGELOG.md",
+                    "package.json"
+                ]
+            }
+        ]
+    ]
+}

package/templates/CONTRIBUTING.md

@@ -68,8 +68,8 @@
 
     -   若为 BUG 修复，则选择 `fix`
     -   若为新增功能，则选择 `feat`
-    -   若为移除某些功能，则选择 `perf`  或填写 `BREAKING CHANGE`
-        -    `perf` 和其他破坏性更新，若不是为了修复 BUG，原则上将拒绝该 PR
+    -   若为移除某些功能，则选择 `BREAKING CHANGE`
+        -    `BREAKING CHANGE` 和其他破坏性更新，若不是为了修复 BUG，原则上将拒绝该 PR
 
 
 5. 推送到分支 ( `git push origin feat/your_feature`)

package/templates/README.md

@@ -8,7 +8,7 @@
 <% if (projectVersion && !isProjectOnNpm) { -%>
   <img alt="Version" src="https://img.shields.io/badge/version-<%= projectVersion %>-blue.svg?cacheSeconds=2592000" />
 <% } -%>
-<% if (isGithubRepos) { -%>
+<% if (isGithubRepos && isInitSemanticRelease) { -%>
   <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>
@@ -58,6 +58,7 @@
 ## 依赖要求
 
 <% projectPrerequisites.map(({ name, value }) => { -%>
+
 - <%= name %> <%= value %>
 <% }) -%>
 <% } -%>
@@ -109,6 +110,14 @@
 <%= lintCommand %>
 ```
 <% } -%>
+<% if (commitCommand) { -%>
+
+## Commit
+
+```sh
+<%= commitCommand %>
+```
+<% } -%>
 
 <% if (authorName || authorGithubUsername) { -%>
 
@@ -131,10 +140,15 @@
 欢迎 贡献、提问或提出新功能！<br />如有问题请查看 [issues page](<%= issuesUrl %>). <br/><%= contributingUrl ? `贡献或提出新功能可以查看[contributing guide](${contributingUrl}).` : '' %>
 <% } -%>
 
-## 支持
+## 💰支持
 
 如果觉得这个项目有用的话请给一颗⭐️，非常感谢
+<% if (isEnableAfdian) { -%>
 
+<a href="https://afdian.net/@<%= authorName %>">
+  <img src="https://cdn.jsdelivr.net/gh/CaoMeiYouRen/image-hosting-01@master/images/202112181214695.png">
+</a>
+<% } -%>
 <% if (licenseName && licenseUrl) { -%>
 
 ## 📝 License