cmyr-template-cli 1.7.3 → 1.8.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.7.2" , '-v, --version');
+program.version("1.7.6" , '-v, --version');
 const args = process.argv.slice(2);
 if (args.length === 0) {
     args.push('create');

package/dist/plopfile.js

@@ -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);
@@ -165,6 +157,7 @@ async function init(projectPath, answers) {
             await initGithubWorkflows(projectPath, answers);
         }
         await initConfig(projectPath);
+        await initCommitizen(projectPath);
         await sortProjectJson(projectPath);
         await asyncExec('git add .', {
             cwd: projectPath,
@@ -203,6 +196,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 {
@@ -213,8 +238,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,
@@ -248,7 +272,7 @@ async function initProjectJson(projectPath, answers) {
             };
         }
         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;
     }
@@ -264,8 +288,7 @@ async function getProjectInfo(projectPath, answers) {
     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;
@@ -471,12 +494,10 @@ async function initSemanticRelease(projectPath) {
             }
             await fs__default["default"].copyFile(templatePath, newPath);
         });
-        const pkgPath = path__default["default"].join(projectPath, 'package.json');
-        const pkg = await fs__default["default"].readJSON(pkgPath);
+        const pkg = await getProjectJson(projectPath);
         const devDependencies = {
             '@semantic-release/changelog': '^6.0.1',
             '@semantic-release/git': '^10.0.1',
-            'conventional-changelog-cli': '^2.1.1',
             'semantic-release': '^18.0.1',
         };
         const pkgData = {
@@ -490,8 +511,7 @@ async function initSemanticRelease(projectPath) {
                 'conventional-changelog-cmyr-config': `^${await getNpmPackageVersion('conventional-changelog-cmyr-config')}`,
             },
         };
-        const newPkg = Object.assign({}, pkg, pkgData);
-        await fs__default["default"].writeFile(pkgPath, JSON.stringify(newPkg, null, 2));
+        await saveProjectJson(projectPath, pkgData);
         loading.succeed('semantic-release 初始化成功！');
     }
     catch (error) {
@@ -517,8 +537,7 @@ async function initHusky(projectPath) {
             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');
         }
@@ -529,14 +548,11 @@ async function initHusky(projectPath) {
         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 = {
             scripts: {
-                commit: 'cz',
                 ...pkg === null || pkg === void 0 ? void 0 : pkg.scripts,
                 prepare: 'husky install',
             },
@@ -545,11 +561,6 @@ async function initHusky(projectPath) {
                 ...pkg === null || pkg === void 0 ? void 0 : pkg.devDependencies,
             },
             husky: undefined,
-            config: {
-                commitizen: {
-                    path: 'cz-conventional-changelog',
-                },
-            },
             'lint-staged': {
                 [keyname]: [
                     'npm run lint',
@@ -557,8 +568,7 @@ async function initHusky(projectPath) {
                 ],
             },
         };
-        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) {
@@ -566,16 +576,46 @@ async function initHusky(projectPath) {
         console.error(error);
     }
 }
+async function initCommitizen(projectPath) {
+    const loading = ora__default["default"]('正在初始化 commitizen ……').start();
+    try {
+        const pkg = await getProjectJson(projectPath);
+        const devDependencies = {
+            commitizen: '^4.2.3',
+            'cz-conventional-changelog-cmyr': `^${await getNpmPackageVersion('cz-conventional-changelog-cmyr')}`,
+        };
+        const pkgData = {
+            scripts: {
+                ...pkg === null || pkg === void 0 ? void 0 : pkg.scripts,
+                commit: 'cz',
+            },
+            devDependencies: {
+                ...devDependencies,
+                ...pkg === null || pkg === void 0 ? void 0 : pkg.devDependencies,
+            },
+            config: {
+                ...pkg === null || pkg === void 0 ? void 0 : pkg.config,
+                commitizen: {
+                    path: './node_modules/cz-conventional-changelog-cmyr',
+                },
+            },
+        };
+        await saveProjectJson(projectPath, pkgData);
+        loading.succeed('commitizen 初始化成功！');
+    }
+    catch (error) {
+        console.error(error);
+        loading.fail('commitizen 初始化失败！');
+    }
+}
 async function sortProjectJson(projectPath) {
     try {
-        const pkgPath = path__default["default"].join(projectPath, 'package.json');
-        const pkg = await fs__default["default"].readJSON(pkgPath);
+        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) || {}),
         };
-        const newPkg = Object.assign({}, pkg, pkgData);
-        await fs__default["default"].writeFile(pkgPath, JSON.stringify(newPkg, null, 2));
+        await saveProjectJson(projectPath, pkgData);
     }
     catch (error) {
         console.error(error);
@@ -627,6 +667,17 @@ function sortKey(obj) {
     });
     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);
@@ -782,6 +833,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.3",
+  "version": "1.8.0",
   "description": "草梅友仁自制的项目模板创建器",
   "author": "CaoMeiYouRen",
   "license": "MIT",
@@ -26,7 +26,7 @@
     "rm": "rimraf node_modules",
     "start": "node ./dist/index",
     "release": "semantic-release",
-    "commit": "git add . && git cz",
+    "commit": "cz",
     "create": "ct create",
     "build:dev": "rimraf dist && cross-env NODE_ENV=development rollup -c && rimraf temp && cross-env NODE_ENV=development ct create",
     "build:prod": "npm run build && rimraf temp && cross-env NODE_ENV=production ct create"
@@ -49,9 +49,10 @@
     "@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.0",
     "cross-env": "^7.0.2",
     "cz-conventional-changelog": "^3.3.0",
+    "cz-conventional-changelog-cmyr": "^1.0.0",
     "debug": "^4.3.1",
     "eslint": "^7.14.0",
     "eslint-config-cmyr": "^1.1.14",
@@ -83,7 +84,7 @@
   },
   "config": {
     "commitizen": {
-      "path": "cz-conventional-changelog"
+      "path": "./node_modules/cz-conventional-changelog-cmyr"
     }
   },
   "changelog": {

package/templates/.releaserc.js

@@ -7,10 +7,12 @@ module.exports = {
                 "config": "conventional-changelog-cmyr-config"
             }
         ],
-        ["@semantic-release/release-notes-generator",
+        [
+            "@semantic-release/release-notes-generator",
             {
                 "config": "conventional-changelog-cmyr-config"
-            }],
+            }
+        ],
         [
             "@semantic-release/changelog",
             {
@@ -31,4 +33,4 @@ module.exports = {
             }
         ]
     ]
-}
+}

package/templates/CONTRIBUTING.md

@@ -68,10 +68,14 @@
 
     -   若为 BUG 修复，则选择 `fix`
     -   若为新增功能，则选择 `feat`
-    -   若为移除某些功能，则选择 `perf`  或填写 `BREAKING CHANGE`
-        -    `perf` 和其他破坏性更新，若不是为了修复 BUG，原则上将拒绝该 PR
+    -   若为性能优化，则选择 `perf`
+    -   若为移除某些功能，则选择 `BREAKING CHANGE`
+        -    `BREAKING CHANGE` 和其他破坏性更新，若不是为了修复 BUG，原则上将拒绝该 PR
 
 
 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)_