cmyr-template-cli 1.19.7 → 1.20.0

package/README.md

@@ -61,13 +61,31 @@ ct create
 ```json
 {
     "GITHUB_TOKEN": "",
-    "GITEE_TOKEN": ""
+    "GITEE_TOKEN": "",
+    "GITHUB_USERNAME": "",
+    "GITEE_USERNAME": "",
+    "AFDIAN_USERNAME": "",
+    "PATREON_USERNAME": "",
+    "WEIBO_USERNAME": "",
+    "TWITTER_USERNAME": ""
 }
 ```
 
-GITHUB_TOKEN 请参考： [创建用于命令行的个人访问令牌](https://help.github.com/cn/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)
+GITHUB_TOKEN：可空，默认值为空。请参考： [创建用于命令行的个人访问令牌](https://help.github.com/cn/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)
 
-GITEE_TOKEN 请参考：https://gitee.com/profile/personal_access_tokens
+GITEE_TOKEN：可空，默认值为空。请参考：https://gitee.com/profile/personal_access_tokens
+
+GITHUB_USERNAME：GitHub 用户名，可空，默认会使用 `git config user.name` 的用户名
+
+GITEE_USERNAME：码云用户名，可空，默认值为空
+
+AFDIAN_USERNAME：爱发电用户名，可空，默认值为空
+
+PATREON_USERNAME：Patreon 用户名，可空，默认值为空
+
+WEIBO_USERNAME：微博用户名，可空，默认值为空
+
+TWITTER_USERNAME：Twitter 用户名，可空，默认值为空
 
 **如果不使用自动初始化远程仓库功能，可以跳过该配置**
 

package/dist/plopfile.js

@@ -12,6 +12,7 @@ var ejs = require('ejs');
 var lodash = require('lodash');
 var core = require('@lint-md/core');
 var JSON5 = require('json5');
+var os = require('os');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -41,6 +42,7 @@ var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
 var colors__default = /*#__PURE__*/_interopDefaultLegacy(colors);
 var ejs__default = /*#__PURE__*/_interopDefaultLegacy(ejs);
 var JSON5__default = /*#__PURE__*/_interopDefaultLegacy(JSON5);
+var os__default = /*#__PURE__*/_interopDefaultLegacy(os);
 
 process.env;
 const PACKAGE_MANAGER = 'pnpm';
@@ -81,6 +83,7 @@ const COMMON_DEPENDENCIES = {
     dependencies: {
         axios: '^1.0.0',
         'cmyr-error-collection': '^1.5.0',
+        'cmyr-sign': '^1.1.0',
         dayjs: '^1.9.6',
         'fs-extra': '^10.0.0',
         'isomorphic-unfetch': '^3.1.0',
@@ -92,7 +95,6 @@ const COMMON_DEPENDENCIES = {
 const VUE_DEPENDENCIES = {
     devDependencies: {},
     dependencies: {
-        'vite-plugin-fast-cdn-import': '^1.1.0',
         'element-ui': '^2.15.7',
         vuetify: '^2.6.3',
     },
@@ -133,26 +135,29 @@ async function createGithubRepo(authToken, data) {
         return null;
     }
 }
-async function loadToken(type) {
-    const paths = [process.cwd(), process.env.HOME].map((e) => path__default["default"].join(e, '.ctrc'));
-    if (!['GITHUB_TOKEN', 'GITEE_TOKEN'].includes(type)) {
-        throw new Error(`无效的 token 类型：${type}`);
-    }
-    const CONFIG_KEY = type;
-    for await (const p of paths) {
+async function loadTemplateCliConfig() {
+    const paths = [process.cwd(), os__default["default"].homedir()].map((e) => path__default["default"].join(e, '.ctrc'));
+    const [local, home] = (await Promise.all(paths.map(async (p) => {
         try {
             if (await fs__default["default"].pathExists(p)) {
-                const config = await fs__default["default"].readJSON(p);
-                if (config === null || config === void 0 ? void 0 : config[CONFIG_KEY]) {
-                    return config[CONFIG_KEY];
-                }
+                return fs__default["default"].readJSON(p);
             }
+            return null;
         }
         catch (error) {
             console.error(error);
+            return null;
         }
-    }
-    return '';
+    }))).filter(Boolean);
+    return lodash.mergeWith(home, local, (objValue, srcValue) => {
+        if (typeof objValue === 'string' && srcValue === '') {
+            return objValue;
+        }
+        if (typeof srcValue !== 'undefined' && srcValue !== null) {
+            return srcValue;
+        }
+        return objValue;
+    });
 }
 async function downloadGitRepo(repository, destination, options = {}) {
     const fastRepo = await getFastGitRepo(repository);
@@ -211,7 +216,7 @@ async function initProject(answers) {
 }
 async function init(projectPath, answers) {
     var _a;
-    const { isOpenSource, gitRemoteUrl, isInitRemoteRepo, isInitReadme, isInitContributing, isInitHusky, isInitSemanticRelease, isInitDocker } = answers;
+    const { isOpenSource, isInitReadme, isInitContributing, isInitHusky, isInitSemanticRelease, isInitDocker } = answers;
     try {
         await asyncExec('git --version', {
             cwd: projectPath,
@@ -241,9 +246,7 @@ async function init(projectPath, answers) {
             }
             await initGithubWorkflows(projectPath, answers);
         }
-        if (isInitRemoteRepo && gitRemoteUrl) {
-            await initRemoteGitRepo(projectPath, answers);
-        }
+        await initRemoteGitRepo(projectPath, answers);
         if (isInitSemanticRelease) {
             await initSemanticRelease(projectPath);
         }
@@ -282,16 +285,25 @@ async function init(projectPath, answers) {
 }
 async function getGitUserName() {
     const username = (await asyncExec('git config user.name')) || '';
-    return username.trim();
+    return username === null || username === void 0 ? void 0 : username.trim();
 }
 async function initRemoteGitRepo(projectPath, answers) {
     var _a, _b;
     const loading = ora__default["default"]('正在初始化远程 Git 仓库……').start();
     try {
-        const { name, description, gitRemoteUrl, isOpenSource } = answers;
+        const { name, description, gitRemoteUrl, isOpenSource, isInitRemoteRepo } = answers;
+        if (!gitRemoteUrl) {
+            loading.fail('未找到远程 Git 仓库地址，请自行初始化！');
+            return;
+        }
         await asyncExec(`git remote add origin ${gitRemoteUrl}`, {
             cwd: projectPath,
         });
+        if (!isInitRemoteRepo) {
+            loading.stop();
+            console.info(colors__default["default"].green(`请自行在远程 Git 仓库初始化 ${gitRemoteUrl}`));
+            return;
+        }
         let type = '';
         if (/github\.com/.test(gitRemoteUrl)) {
             type = 'github';
@@ -299,9 +311,10 @@ async function initRemoteGitRepo(projectPath, answers) {
         else if (/gitee\.com/.test(gitRemoteUrl)) {
             type = 'gitee';
         }
+        const config = await loadTemplateCliConfig();
         switch (type) {
             case 'github': {
-                const authToken = await loadToken('GITHUB_TOKEN');
+                const authToken = config === null || config === void 0 ? void 0 : config.GITHUB_TOKEN;
                 if (!authToken) {
                     console.error(colors__default["default"].red(`未找到 ${type} token ！跳过初始化！`));
                     break;
@@ -321,7 +334,7 @@ async function initRemoteGitRepo(projectPath, answers) {
                 return;
             }
             case 'gitee': {
-                const access_token = await loadToken('GITEE_TOKEN');
+                const access_token = config === null || config === void 0 ? void 0 : config.GITEE_TOKEN;
                 if (!access_token) {
                     console.error(colors__default["default"].red(`未找到 ${type} token ！跳过初始化！`));
                     break;
@@ -342,11 +355,10 @@ async function initRemoteGitRepo(projectPath, answers) {
                 return;
             }
             default: {
-                break;
+                loading.stop();
+                console.info(colors__default["default"].green(`请在远程 Git 仓库初始化 ${gitRemoteUrl}`));
             }
         }
-        loading.stop();
-        console.info(colors__default["default"].green(`请在远程 Git 仓库初始化 ${gitRemoteUrl}`));
     }
     catch (error) {
         loading.fail('远程 Git 仓库初始化失败！');
@@ -520,6 +532,7 @@ async function getProjectInfo(projectPath, answers) {
     try {
         const { name, author, description, isOpenSource, isPublishToNpm } = answers;
         const packageManager = 'npm';
+        const config = await loadTemplateCliConfig();
         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;
@@ -537,11 +550,16 @@ async function getProjectInfo(projectPath, answers) {
         const documentationUrl = `${repositoryUrl}#readme`;
         const demoUrl = `${repositoryUrl}#readme`;
         const homepage = documentationUrl;
-        const githubUsername = author;
+        const githubUsername = (config === null || config === void 0 ? void 0 : config.GITHUB_USERNAME) || author;
         const authorWebsite = await getAuthorWebsiteFromGithubAPI(githubUsername);
         const licenseUrl = `${repositoryUrl}/blob/master/LICENSE`;
         const discussionsUrl = `${repositoryUrl}/discussions`;
         const pullRequestsUrl = `${repositoryUrl}/pulls`;
+        const giteeUsername = config === null || config === void 0 ? void 0 : config.GITEE_USERNAME;
+        const weiboUsername = config === null || config === void 0 ? void 0 : config.WEIBO_USERNAME;
+        const twitterUsername = config === null || config === void 0 ? void 0 : config.TWITTER_USERNAME;
+        const afdianUsername = config === null || config === void 0 ? void 0 : config.AFDIAN_USERNAME;
+        const patreonUsername = config === null || config === void 0 ? void 0 : config.PATREON_USERNAME;
         const projectInfos = {
             ...answers,
             currentYear: new Date().getFullYear(),
@@ -588,6 +606,11 @@ async function getProjectInfo(projectPath, answers) {
             })),
             discussionsUrl,
             pullRequestsUrl,
+            giteeUsername,
+            afdianUsername,
+            patreonUsername,
+            weiboUsername,
+            twitterUsername,
         };
         loading.succeed('项目信息 初始化成功！');
         return projectInfos;
@@ -1092,6 +1115,7 @@ module.exports = function (plop) {
     plop.setGenerator('create', {
         description: '草梅项目创建器',
         async prompts(inquirer) {
+            const config = await loadTemplateCliConfig();
             const questions = [
                 {
                     type: 'input',
@@ -1205,10 +1229,13 @@ module.exports = function (plop) {
                     },
                     default(answers) {
                         const { isOpenSource, name, author } = answers;
+                        const { GITHUB_USERNAME, GITEE_USERNAME } = config;
+                        const githubUsername = GITHUB_USERNAME || author;
+                        const giteeUsername = GITEE_USERNAME || author;
                         if (isOpenSource) {
-                            return `git@github.com:${author}/${name}.git`;
+                            return `git@github.com:${githubUsername}/${name}.git`;
                         }
-                        return `git@gitee.com:caomeiyouren/${name}.git`;
+                        return `git@gitee.com:${giteeUsername}/${name}.git`;
                     },
                     filter: (e) => e.trim(),
                     when(answers) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cmyr-template-cli",
-  "version": "1.19.7",
+  "version": "1.20.0",
   "description": "草梅友仁自制的项目模板创建器",
   "author": "CaoMeiYouRen",
   "license": "MIT",
@@ -46,8 +46,8 @@
     "@types/lodash": "^4.14.165",
     "@types/node": "^20.0.0",
     "@types/promise.any": "^2.0.0",
-    "@typescript-eslint/eslint-plugin": "6.5.0",
-    "@typescript-eslint/parser": "6.4.1",
+    "@typescript-eslint/eslint-plugin": "6.7.0",
+    "@typescript-eslint/parser": "6.7.0",
     "commitizen": "^4.2.2",
     "conventional-changelog-cli": "^4.0.0",
     "conventional-changelog-cmyr-config": "^2.1.0",

package/templates/README.md

@@ -113,21 +113,27 @@
 ```
 <% } -%>
 
-<% if (authorName || authorGithubUsername) { -%>
 
 ## 👤 作者
 
 <% if (authorName) { %>
- **<%= authorName %>**
-<% } %>
-<% if (authorWebsite) { -%>
+**<%= authorName %>**
+<% } -%>
 
+<% if (authorWebsite) { -%>
 * Website: [<%= authorWebsite %>](<%= authorWebsite %>)
+
 <% } -%>
 <% if (authorGithubUsername) { -%>
 * GitHub: [@<%= authorGithubUsername %>](https://github.com/<%= authorGithubUsername %>)
 <% } -%>
-<% } %>
+<% if (twitterUsername) { -%> 
+* Twitter: [@<%= twitterUsername %>](https://twitter.com/<%= twitterUsername %>)
+<% } -%>
+<% if (weiboUsername) { -%> 
+* Weibo: [@<%= weiboUsername %>](https://weibo.com/<%= weiboUsername %>)
+<% } -%>
+
 <% if (issuesUrl) { -%>
 
 ## 🤝 贡献
@@ -139,15 +145,16 @@
 
 如果觉得这个项目有用的话请给一颗⭐️，非常感谢
 <% if (isEnableSupport) { -%>
-
-<a href="https://afdian.net/@<%= authorName %>">
+<% if (afdianUsername) { -%>
+<a href="https://afdian.net/@<%= afdianUsername %>">
   <img src="https://cdn.jsdelivr.net/gh/CaoMeiYouRen/image-hosting-01@master/images/202306192324870.png" width="312px" height="78px" alt="在爱发电支持我">
 </a>
-
-<a href="https://patreon.com/<%= authorName %>">
+<% } -%>
+<% if (patreonUsername) { -%>
+<a href="https://patreon.com/<%= patreonUsername %>">
     <img src="https://cdn.jsdelivr.net/gh/CaoMeiYouRen/image-hosting-01@master/images/202306142054108.svg" width="312px" height="78px" alt="become a patreon"/>
 </a>
-
+<% } -%>
 <% } -%>
 <% if (isEnableStarHistory) { -%>