cmyr-template-cli 1.4.0 → 1.5.2

package/dist/plopfile.js

@@ -7,23 +7,48 @@ var ora = require('ora');
 var download = require('download-git-repo');
 var axios = require('axios');
 var child_process = require('child_process');
-var any = require('promise.any');
+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 }; }
 
+function _interopNamespace(e) {
+    if (e && e.__esModule) return e;
+    var n = Object.create(null);
+    if (e) {
+        Object.keys(e).forEach(function (k) {
+            if (k !== 'default') {
+                var d = Object.getOwnPropertyDescriptor(e, k);
+                Object.defineProperty(n, k, d.get ? d : {
+                    enumerable: true,
+                    get: function () { return e[k]; }
+                });
+            }
+        });
+    }
+    n["default"] = e;
+    return Object.freeze(n);
+}
+
 var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
 var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
 var ora__default = /*#__PURE__*/_interopDefaultLegacy(ora);
 var download__default = /*#__PURE__*/_interopDefaultLegacy(download);
 var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
-var any__default = /*#__PURE__*/_interopDefaultLegacy(any);
+var colors__default = /*#__PURE__*/_interopDefaultLegacy(colors);
+var ejs__default = /*#__PURE__*/_interopDefaultLegacy(ejs);
 
 process.env;
 const PACKAGE_MANAGER = 'pnpm';
 
 if (!Promise.any) {
-    Promise.any = any__default["default"];
+    Promise.resolve().then(function () { return /*#__PURE__*/_interopNamespace(require('promise.any')); }).then((any) => {
+        Promise.any = any.default;
+    });
 }
+const GITHUB_API_URL = 'https://api.github.com';
 const REMOTES = [
     'https://github.com',
     'https://hub.fastgit.org',
@@ -32,14 +57,15 @@ const REMOTES = [
 ];
 async function downloadGitRepo(repository, destination, options = {}) {
     const fastRepo = await getFastGitRepo(repository);
-    const loading = ora__default["default"](`download - ${repository}`);
+    const loading = ora__default["default"](`正在下载模板 - ${repository}`);
     loading.start();
-    return new Promise((resolve, reject) => {
+    return new Promise((resolve) => {
         download__default["default"](fastRepo, destination, options, (err) => {
-            loading.stop();
             if (err) {
-                return reject(err);
+                loading.fail('下载模板失败！');
+                process.exit(1);
             }
+            loading.succeed(`成功下载模板 - ${repository}`);
             resolve(true);
         });
     });
@@ -56,15 +82,14 @@ async function getFastGitRepo(repository) {
                 timeout: 15 * 1000,
             });
         }));
+        loading.succeed(`成功选择了镜像源 - ${fast.config.url}`);
         return `direct:${fast.config.url}`;
     }
     catch (error) {
         console.error(error);
+        loading.fail('选择镜像源失败！');
         process.exit(1);
     }
-    finally {
-        loading.stop();
-    }
 }
 async function asyncExec(cmd, options) {
     return new Promise((resolve, reject) => {
@@ -80,8 +105,7 @@ async function asyncExec(cmd, options) {
     });
 }
 async function init(projectPath, answers) {
-    const loading = ora__default["default"]('正在安装依赖……');
-    const { name, author, isOpenSource, isRemoveDependabot } = answers;
+    const { isOpenSource, isRemoveDependabot, gitRemoteUrl } = answers;
     try {
         await asyncExec('git --version', {
             cwd: projectPath,
@@ -92,6 +116,12 @@ async function init(projectPath, answers) {
         await asyncExec('git init', {
             cwd: projectPath,
         });
+        if (gitRemoteUrl) {
+            await asyncExec(`git remote add origin ${gitRemoteUrl}`, {
+                cwd: projectPath,
+            });
+            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) {
@@ -102,25 +132,26 @@ async function init(projectPath, answers) {
                 await fs__default["default"].remove(mergifyPath);
             }
         }
-        const pkgPath = path__default["default"].join(projectPath, 'package.json');
-        const pkg = await fs__default["default"].readJSON(pkgPath);
-        const pkgData = {
-            name,
-            author,
-            private: !isOpenSource,
-        };
-        const newPkg = Object.assign({}, pkg, pkgData);
-        await fs__default["default"].writeFile(pkgPath, JSON.stringify(newPkg, null, 2));
+        await initProjectJson(projectPath, answers);
+        if (isOpenSource) {
+            await initReadme(projectPath, answers);
+        }
         await asyncExec('git add .', {
             cwd: projectPath,
         });
         await asyncExec('git commit -m "chore: init"', {
             cwd: projectPath,
         });
-        loading.start();
-        await asyncExec(`${PACKAGE_MANAGER} i`, {
-            cwd: projectPath,
-        });
+        const loading = ora__default["default"]('正在安装依赖……').start();
+        try {
+            await asyncExec(`${PACKAGE_MANAGER} i`, {
+                cwd: projectPath,
+            });
+            loading.succeed('依赖安装成功！');
+        }
+        catch (error) {
+            loading.fail('依赖安装失败！');
+        }
         await asyncExec('git add .', {
             cwd: projectPath,
         });
@@ -128,14 +159,164 @@ async function init(projectPath, answers) {
     catch (error) {
         console.error(error);
     }
-    finally {
-        loading.stop();
-    }
 }
 async function getGitUserName() {
     const username = (await asyncExec('git config user.name'));
     return username.trim();
 }
+async function initProjectJson(projectPath, answers) {
+    const loading = ora__default["default"]('正在初始化 package.json ……').start();
+    try {
+        const { name, author, description, isOpenSource, isPublishToNpm = false } = answers;
+        const repositoryUrl = `https://github.com/${author}/${name}`;
+        const homepage = `${repositoryUrl}#readme`;
+        const issuesUrl = `${repositoryUrl}/issues`;
+        const gitUrl = `git+${repositoryUrl}.git`;
+        const pkgPath = path__default["default"].join(projectPath, 'package.json');
+        const pkg = await fs__default["default"].readJSON(pkgPath);
+        const pkgData = {
+            name,
+            author,
+            description,
+            private: !isPublishToNpm,
+            license: 'UNLICENSED',
+            engines: {
+                node: '>=12',
+            },
+        };
+        let extData = {};
+        if (isOpenSource) {
+            extData = {
+                license: 'MIT',
+                homepage,
+                repository: {
+                    type: 'git',
+                    url: gitUrl,
+                },
+                bugs: {
+                    url: issuesUrl,
+                },
+            };
+        }
+        const newPkg = Object.assign({}, pkg, pkgData, extData);
+        await fs__default["default"].writeFile(pkgPath, JSON.stringify(newPkg, null, 2));
+        loading.succeed('package.json 初始化成功！');
+    }
+    catch (error) {
+        console.error(error);
+        loading.fail('package.json 初始化失败！');
+    }
+}
+const cleanText = (text) => text.replace(/-/g, '--').replace(/_/g, '__');
+async function initReadme(projectPath, answers) {
+    var _a, _b, _c, _d, _e;
+    const loading = ora__default["default"]('正在初始化 README.md ……').start();
+    try {
+        const { name, author, description, isOpenSource, isPublishToNpm } = answers;
+        const packageManager = 'npm';
+        const templatePath = path__default["default"].join(__dirname, '../templates/README.md');
+        const template = (await fs__default["default"].readFile(templatePath, 'utf8')).toString();
+        const newReadmePath = path__default["default"].join(projectPath, 'README.md');
+        const pkgPath = path__default["default"].join(projectPath, 'package.json');
+        const pkg = await fs__default["default"].readJSON(pkgPath);
+        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;
+        const installCommand = isPublishToNpm ? `${packageManager} install ${name}` : `${packageManager} install`;
+        const startCommand = ((_a = pkg === null || pkg === void 0 ? void 0 : pkg.scripts) === null || _a === void 0 ? void 0 : _a.start) && `${packageManager} run start`;
+        const devCommand = ((_b = pkg === null || pkg === void 0 ? void 0 : pkg.scripts) === null || _b === void 0 ? void 0 : _b.dev) && `${packageManager} run dev`;
+        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 repositoryUrl = `https://github.com/${author}/${name}`;
+        const issuesUrl = `${repositoryUrl}/issues`;
+        const contributingUrl = `${repositoryUrl}/blob/master/CONTRIBUTING.md`;
+        const documentationUrl = `${repositoryUrl}#readme`;
+        const demoUrl = `${repositoryUrl}#readme`;
+        const homepage = documentationUrl;
+        const githubUsername = author;
+        const authorWebsite = isOpenSource ? await getAuthorWebsiteFromGithubAPI(githubUsername) : '';
+        const licenseUrl = `${repositoryUrl}/blob/master/LICENSE`;
+        const projectInfos = {
+            filename: templatePath,
+            currentYear: new Date().getFullYear(),
+            name,
+            description,
+            version,
+            author,
+            authorWebsite,
+            homepage,
+            demoUrl,
+            repositoryUrl,
+            issuesUrl,
+            contributingUrl,
+            githubUsername,
+            authorName: author,
+            authorGithubUsername: githubUsername,
+            engines,
+            licenseName: cleanText(license),
+            licenseUrl,
+            documentationUrl,
+            isGithubRepos: true,
+            installCommand,
+            startCommand,
+            usage: startCommand,
+            devCommand,
+            buildCommand,
+            testCommand,
+            lintCommand,
+            isJSProject: true,
+            packageManager,
+            isProjectOnNpm: isPublishToNpm,
+            isOpenSource,
+            projectName: name,
+            projectVersion: version,
+            projectDocumentationUrl: documentationUrl,
+            projectDescription: description,
+            projectHomepage: homepage,
+            projectDemoUrl: demoUrl,
+            projectPrerequisites: Object.keys(engines).map((key) => ({
+                name: key,
+                value: engines[key],
+            })),
+        };
+        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, lintMd(lodash.unescape(readmeContent)));
+        loading.succeed('README.md 初始化成功！');
+    }
+    catch (error) {
+        loading.fail('README.md 初始化失败！');
+        console.error(error);
+    }
+}
+async function getAuthorWebsiteFromGithubAPI(githubUsername) {
+    try {
+        const userData = (await axios__default["default"].get(`${GITHUB_API_URL}/users/${githubUsername}`)).data;
+        const authorWebsite = userData === null || userData === void 0 ? void 0 : userData.blog;
+        return authorWebsite || '';
+    }
+    catch (error) {
+        console.error(error);
+        return '';
+    }
+}
+function lintMd(markdown) {
+    const rules = {
+        'no-empty-code': 0,
+        'no-trailing-punctuation': 0,
+        'no-long-code': 0,
+        'no-empty-code-lang': 0,
+        'no-empty-inlinecode': 0,
+    };
+    const fixed = core.fix(markdown, rules);
+    return fixed;
+}
 
 module.exports = function (plop) {
     plop.setActionType('initProject', async (answers) => {
@@ -159,6 +340,13 @@ module.exports = function (plop) {
                     default: '',
                     filter: (e) => e.trim(),
                 },
+                {
+                    type: 'input',
+                    name: 'description',
+                    message: '请输入项目简介',
+                    default: '',
+                    filter: (e) => e.trim(),
+                },
                 {
                     type: 'input',
                     name: 'author',
@@ -202,6 +390,49 @@ module.exports = function (plop) {
                     message: '是否开源？',
                     default: false,
                 },
+                {
+                    type: 'confirm',
+                    name: 'isInitRemoteRepo',
+                    message: '是否初始化远程 Git 仓库？',
+                    default: false,
+                },
+                {
+                    type: 'input',
+                    name: 'gitRemoteUrl',
+                    message: '请输入远程 Git 仓库 Url',
+                    validate(input) {
+                        return input.trim().length !== 0;
+                    },
+                    default(answers) {
+                        const { isOpenSource, name, author } = answers;
+                        if (isOpenSource) {
+                            return `git@github.com:${author}/${name}.git`;
+                        }
+                        return `git@gitee.com:caomeiyouren/${name}.git`;
+                    },
+                    filter: (e) => e.trim(),
+                    when(answers) {
+                        return answers.isInitRemoteRepo;
+                    },
+                },
+                {
+                    type: 'confirm',
+                    name: 'isPublishToNpm',
+                    message: '是否发布到 npm？',
+                    default: false,
+                    when(answers) {
+                        return answers.isOpenSource;
+                    },
+                },
+                {
+                    type: 'confirm',
+                    name: 'isInitReadme',
+                    message: '是否初始化 README.md ？',
+                    default: true,
+                    when(answers) {
+                        return answers.isOpenSource;
+                    },
+                },
                 {
                     type: 'confirm',
                     name: 'isRemoveDependabot',

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "cmyr-template-cli",
-  "version": "1.4.0",
+  "version": "1.5.2",
   "description": "草梅友仁自制的项目模板创建器",
   "author": "CaoMeiYouRen",
   "license": "MIT",
   "main": "dist/index.js",
   "type": "commonjs",
   "files": [
-    "dist"
+    "dist",
+    "templates"
   ],
   "engines": {
     "node": ">=12"
@@ -39,6 +40,7 @@
     "@semantic-release/changelog": "^6.0.0",
     "@semantic-release/git": "^10.0.0",
     "@types/debug": "^4.1.5",
+    "@types/ejs": "^3.1.0",
     "@types/fs-extra": "^9.0.4",
     "@types/lodash": "^4.14.165",
     "@types/node": "^16.9.6",
@@ -52,10 +54,9 @@
     "cz-conventional-changelog": "^3.3.0",
     "debug": "^4.3.1",
     "eslint": "^7.14.0",
-    "eslint-config-cmyr": "^1.1.13",
+    "eslint-config-cmyr": "^1.1.14",
     "husky": "^7.0.2",
     "lint-staged": "^12.0.2",
-    "lodash": "^4.17.20",
     "rimraf": "^3.0.2",
     "rollup": "^2.33.3",
     "rollup-plugin-terser": "^7.0.2",
@@ -66,12 +67,15 @@
     "validate-commit-msg": "^2.14.0"
   },
   "dependencies": {
+    "@lint-md/core": "^0.2.1",
     "axios": "^0.24.0",
     "colors": "^1.4.0",
     "commander": "^8.2.0",
     "dayjs": "^1.9.6",
     "download-git-repo": "^3.0.2",
+    "ejs": "^3.1.6",
     "fs-extra": "^10.0.0",
+    "lodash": "^4.17.20",
     "minimist": "^1.2.5",
     "ora": "^5.4.1",
     "plop": "^2.7.6",

package/templates/README.md

@@ -0,0 +1,144 @@
+<h1 align="center"><%= projectName %> </h1>
+<p>
+<% if (isProjectOnNpm) { -%>
+  <a href="https://www.npmjs.com/package/<%= projectName %>" target="_blank">
+    <img alt="Version" src="https://img.shields.io/npm/v/<%= projectName %>.svg">
+  </a>
+<% } -%>
+<% if (projectVersion && !isProjectOnNpm) { -%>
+  <img alt="Version" src="https://img.shields.io/badge/version-<%= projectVersion %>-blue.svg?cacheSeconds=2592000" />
+<% } -%>
+<% if (projectPrerequisites) { -%>
+<% projectPrerequisites.map(({ name, value }) => { -%>
+  <img src="https://img.shields.io/badge/<%= name %>-<%= encodeURIComponent(value) %>-blue.svg" />
+<% }) -%>
+<% } -%>
+<% if (projectDocumentationUrl) { -%>
+  <a href="<%= projectDocumentationUrl %>" target="_blank">
+    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
+  </a>
+<% } -%>
+<% if (isGithubRepos) { -%>
+  <a href="<%= repositoryUrl %>/graphs/commit-activity" target="_blank">
+    <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
+  </a>
+<% } -%>
+<% if (licenseName) { -%>
+  <a href="<%= licenseUrl ? licenseUrl : '#' %>" target="_blank">
+    <img alt="License: <%= licenseName %>" src="https://img.shields.io/<%= `badge/License-${licenseName}-yellow.svg` %>" />
+  </a>
+<% } -%>
+</p>
+
+<% if (projectDescription) { -%>
+
+> <%= projectDescription %>
+<% } -%>
+<% if (projectHomepage) { -%>
+
+### 🏠 [主页](<%= projectHomepage %>)
+
+[<%= projectHomepage %>](<%= projectHomepage %>)
+
+<% } -%>
+<% if (projectDemoUrl) { -%>
+
+### ✨ [Demo](<%= projectDemoUrl %>)
+
+[<%= projectDemoUrl %>](<%= projectDemoUrl %>)
+
+<% } -%>
+<% if (projectPrerequisites && projectPrerequisites.length) { -%>
+
+## 依赖要求
+
+<% projectPrerequisites.map(({ name, value }) => { -%>
+- <%= name %> <%= value %>
+<% }) -%>
+<% } -%>
+<% if (installCommand) { -%>
+
+## 安装
+
+```sh
+<%= installCommand %>
+```
+<% } -%>
+<% if (usage) { -%>
+
+## 使用
+
+```sh
+<%= usage %>
+```
+<% } -%>
+<% if (devCommand) { -%>
+
+## 开发
+
+```sh
+<%= devCommand %>
+```
+<% } -%>
+<% if (buildCommand) { -%>
+
+## 编译
+
+```sh
+<%= buildCommand %>
+```
+<% } -%>
+<% if (testCommand) { -%>
+
+## 测试
+
+```sh
+<%= testCommand %>
+```
+<% } -%>
+<% if (lintCommand) { -%>
+
+## Lint
+
+```sh
+<%= lintCommand %>
+```
+<% } -%>
+
+<% if (authorName || authorGithubUsername) { -%>
+
+## 作者
+
+<% if (authorName) { %>
+👤 **<%= authorName %>**
+<% } %>
+<% if (authorWebsite) { -%>
+* Website: [<%= authorWebsite %>](<%= authorWebsite %>)
+<% } -%>
+<% if (authorGithubUsername) { -%>
+* GitHub: [@<%= authorGithubUsername %>](https://github.com/<%= authorGithubUsername %>)
+<% } -%>
+<% } %>
+<% if (issuesUrl) { -%>
+
+## 🤝贡献
+
+欢迎 Contributions, issues and feature!<br />如有问题请查看 [issues page](<%= issuesUrl %>). <%= contributingUrl ? `您还可以查看[contributing guide](${contributingUrl}).` : '' %>
+<% } -%>
+
+## 支持
+
+如果觉得这个项目有用的话请给一颗⭐️，非常感谢
+
+<% if (licenseName && licenseUrl) { -%>
+
+## 📝 License
+
+<% if (authorName && authorGithubUsername) { -%>
+Copyright © <%= currentYear %> [<%= authorName %>](https://github.com/<%= authorGithubUsername %>).<br />
+<% } -%>
+This project is [<%= licenseName %>](<%= licenseUrl %>) licensed.
+<% } -%>
+
+***
+_This README was generated with ❤️ by [cmyr-template-cli](https://github.com/CaoMeiYouRen/cmyr-template-cli)_