cmyr-template-cli 1.29.2 → 1.30.1

package/README.md

@@ -68,7 +68,8 @@ ct create
     "PATREON_USERNAME": "",
     "WEIBO_USERNAME": "",
     "TWITTER_USERNAME": "",
-    "NPM_USERNAME": ""
+    "NPM_USERNAME": "",
+    "DOCKER_USERNAME": ""
 }
 ```
 
@@ -90,6 +91,8 @@ TWITTER_USERNAME：Twitter 用户名，可空，默认值为空
 
 NPM_USERNAME：Npm 用户名，可空，默认会使用 `GITHUB_USERNAME` 的用户名
 
+DOCKER_USERNAME：Docker Hub 用户名，可空，默认会使用**小写的** `GITHUB_USERNAME` 的用户名
+
 **如果不使用自动初始化远程仓库功能，可以跳过该配置**
 
 ## 开发

package/dist/plopfile.js

@@ -14,6 +14,8 @@ var core = require('@lint-md/core');
 var JSON5 = require('json5');
 var os = require('os');
 var yaml = require('yaml');
+var acorn = require('acorn');
+var walk = require('acorn-walk');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -45,6 +47,8 @@ var ejs__default = /*#__PURE__*/_interopDefaultLegacy(ejs);
 var JSON5__default = /*#__PURE__*/_interopDefaultLegacy(JSON5);
 var os__default = /*#__PURE__*/_interopDefaultLegacy(os);
 var yaml__default = /*#__PURE__*/_interopDefaultLegacy(yaml);
+var acorn__default = /*#__PURE__*/_interopDefaultLegacy(acorn);
+var walk__default = /*#__PURE__*/_interopDefaultLegacy(walk);
 
 process.env;
 const PACKAGE_MANAGER = 'pnpm';
@@ -495,6 +499,7 @@ async function init(projectPath, answers) {
             }
             await sortProjectJson(projectPath);
             await initYarn(projectPath, answers);
+            await jsFileExtRename(projectPath);
             await asyncExec('git add .', {
                 cwd: projectPath,
             });
@@ -900,7 +905,8 @@ async function getProjectInfo(projectPath, answers) {
         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 npmUsername = (config === null || config === void 0 ? void 0 : config.NPM_USERNAME) || author;
+        const npmUsername = (config === null || config === void 0 ? void 0 : config.NPM_USERNAME) || githubUsername;
+        const dockerUsername = (config === null || config === void 0 ? void 0 : config.DOCKER_USERNAME) || (githubUsername === null || githubUsername === void 0 ? void 0 : githubUsername.toLowerCase());
         const repositoryUrl = `https://github.com/${githubUsername}/${projectName}`;
         const gitUrl = `git+${repositoryUrl}.git`;
         const issuesUrl = `${repositoryUrl}/issues`;
@@ -966,6 +972,7 @@ async function getProjectInfo(projectPath, answers) {
             weiboUsername,
             twitterUsername,
             npmUsername,
+            dockerUsername,
             templateMeta,
             mainFile,
         };
@@ -1043,14 +1050,7 @@ async function initLicense(projectPath, projectInfos) {
 async function initConfig(projectPath) {
     try {
         await removeFiles(projectPath, ['commitlint.config.cjs', 'commitlint.config.js']);
-        const pkg = await getProjectJson(projectPath);
-        const files = ['.editorconfig'];
-        if (pkg.type === 'module') {
-            files.push('commitlint.config.cjs');
-        }
-        else {
-            files.push('commitlint.config.js');
-        }
+        const files = ['.editorconfig', 'commitlint.config.js'];
         await copyFilesFromTemplates(projectPath, files);
     }
     catch (error) {
@@ -1088,12 +1088,7 @@ async function initSemanticRelease(projectPath) {
         const pkg = await getProjectJson(projectPath);
         const files = ['.releaserc.js', '.releaserc.cjs'];
         await removeFiles(projectPath, files);
-        if (pkg.type === 'module') {
-            await copyFilesFromTemplates(projectPath, ['.releaserc.cjs']);
-        }
-        else {
-            await copyFilesFromTemplates(projectPath, ['.releaserc.js']);
-        }
+        await copyFilesFromTemplates(projectPath, ['.releaserc.js']);
         const devDependencies = {
             '@semantic-release/changelog': '^6.0.3',
             '@semantic-release/git': '^10.0.1',
@@ -1224,18 +1219,7 @@ async function initEslint(projectPath, answers) {
 }`;
         const cjsPath = path__default["default"].join(projectPath, '.eslintrc.cjs');
         const jsPath = path__default["default"].join(projectPath, '.eslintrc.js');
-        if (pkg.type === 'module') {
-            await removeFiles(projectPath, ['.eslintrc.js']);
-            if (!await fs__default["default"].pathExists(cjsPath)) {
-                if (await fs__default["default"].pathExists(jsPath)) {
-                    await fs__default["default"].rename(jsPath, cjsPath);
-                }
-                else {
-                    await fs__default["default"].writeFile(cjsPath, eslintrc);
-                }
-            }
-        }
-        else if (!await fs__default["default"].pathExists(jsPath)) {
+        if (!await fs__default["default"].pathExists(cjsPath) && !await fs__default["default"].pathExists(jsPath)) {
             await fs__default["default"].writeFile(jsPath, eslintrc);
         }
         loading.succeed('eslint 初始化成功！');
@@ -1263,13 +1247,8 @@ async function initStylelint(projectPath) {
             });
             return;
         }
-        const files = ['.stylelintignore'];
-        if (pkg.type === 'module') {
-            files.push('.stylelintrc.cjs');
-        }
-        else {
-            files.push('.stylelintrc.js');
-        }
+        const files = ['.stylelintignore', '.stylelintrc.js'];
+        await removeFiles(projectPath, ['.stylelintrc.js', '.stylelintrc.cjs']);
         await copyFilesFromTemplates(projectPath, files);
         const devDependencies = {
             'postcss-html': '^1.5.0',
@@ -1415,6 +1394,96 @@ async function initJest(projectPath) {
         loading.fail('Jest 初始化失败！');
     }
 }
+async function jsFileExtRename(projectPath) {
+    const loading = ora__default["default"]('正在重命名 js 后缀名 ……').start();
+    try {
+        const jsFiles = (await fs__default["default"].readdir(projectPath)).filter((file) => /\.js$/.test(file)).map((file) => path__default["default"].join(projectPath, file));
+        const pkg = await getProjectJson(projectPath);
+        if (pkg.type === 'module') {
+            for await (const filepath of jsFiles) {
+                const fileContent = await fs__default["default"].readFile(filepath, 'utf-8');
+                const moduleType = getJsModuleType(fileContent);
+                console.log(`正在判断文件：${filepath} 的模块类型`);
+                if (moduleType === 'CommonJS') {
+                    const dirpath = path__default["default"].dirname(filepath);
+                    const extname = path__default["default"].extname(filepath);
+                    const basename = `${path__default["default"].basename(filepath, extname)}.cjs`;
+                    const newPath = path__default["default"].join(dirpath, basename);
+                    await fs__default["default"].rename(filepath, newPath);
+                }
+            }
+        }
+        else if (pkg.type === 'commonjs') {
+            for await (const filepath of jsFiles) {
+                const fileContent = await fs__default["default"].readFile(filepath, 'utf-8');
+                const moduleType = getJsModuleType(fileContent);
+                console.log(`正在判断文件：${filepath} 的模块类型`);
+                if (moduleType === 'EsModule') {
+                    const dirpath = path__default["default"].dirname(filepath);
+                    const extname = path__default["default"].extname(filepath);
+                    const basename = `${path__default["default"].basename(filepath, extname)}.mjs`;
+                    const newPath = path__default["default"].join(dirpath, basename);
+                    await fs__default["default"].rename(filepath, newPath);
+                }
+            }
+        }
+        loading.succeed('重命名 js 后缀名成功！');
+    }
+    catch (error) {
+        loading.fail('重命名 js 后缀名失败！');
+        console.error(error);
+    }
+}
+function getJsModuleType(fileContent) {
+    try {
+        const ast = acorn__default["default"].parse(fileContent, {
+            sourceType: 'module',
+            ecmaVersion: 'latest',
+        });
+        let isCommonJS = false;
+        let isESModule = false;
+        walk__default["default"].simple(ast, {
+            AssignmentExpression(node) {
+                var _a, _b, _c, _d;
+                if (((_b = (_a = node.left) === null || _a === void 0 ? void 0 : _a.object) === null || _b === void 0 ? void 0 : _b.name) === 'module' && ((_d = (_c = node.left) === null || _c === void 0 ? void 0 : _c.property) === null || _d === void 0 ? void 0 : _d.name) === 'exports') {
+                    isCommonJS = true;
+                }
+            },
+            CallExpression(node) {
+                var _a;
+                if (((_a = node.callee) === null || _a === void 0 ? void 0 : _a.name) === 'require') {
+                    isCommonJS = true;
+                }
+            },
+            ImportDeclaration(node) {
+                isESModule = true;
+            },
+            ExportAllDeclaration(node) {
+                isESModule = true;
+            },
+            ExportDefaultDeclaration(node) {
+                isESModule = true;
+            },
+            ExportNamedDeclaration(node) {
+                isESModule = true;
+            },
+            ExportSpecifier(node) {
+                isESModule = true;
+            },
+        });
+        if (isESModule) {
+            return 'EsModule';
+        }
+        if (isCommonJS) {
+            return 'CommonJS';
+        }
+        return 'Unknown';
+    }
+    catch (error) {
+        console.error(error);
+        return 'Unknown';
+    }
+}
 async function sortProjectJson(projectPath) {
     try {
         const pkg = await getProjectJson(projectPath);
@@ -1822,7 +1891,7 @@ module.exports = function (plop) {
                     type: 'confirm',
                     name: 'isRemoveYarn',
                     message: '是否移除 yarn ？',
-                    default: false,
+                    default: true,
                     when(answers) {
                         return answers.isOpenSource;
                     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cmyr-template-cli",
-  "version": "1.29.2",
+  "version": "1.30.1",
   "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": "7.15.0",
-    "@typescript-eslint/parser": "7.15.0",
+    "@typescript-eslint/eslint-plugin": "7.16.1",
+    "@typescript-eslint/parser": "7.16.1",
     "commitizen": "^4.2.2",
     "conventional-changelog-cli": "^5.0.0",
     "conventional-changelog-cmyr-config": "^2.1.1",
@@ -58,7 +58,7 @@
     "eslint-config-cmyr": "^1.1.27",
     "husky": "^9.0.5",
     "lint-staged": "^15.0.1",
-    "rimraf": "^5.0.0",
+    "rimraf": "^6.0.0",
     "rollup": "^2.79.0",
     "rollup-plugin-terser": "^7.0.2",
     "semantic-release": "21.1.2",
@@ -68,6 +68,8 @@
   },
   "dependencies": {
     "@lint-md/core": "^2.0.0",
+    "acorn": "^8.12.1",
+    "acorn-walk": "^8.3.3",
     "axios": "^1.0.0",
     "colors": "^1.4.0",
     "commander": "^12.0.0",

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

@@ -13,7 +13,10 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 10
     permissions:
+      packages: write
       contents: write
+      issues: write
+      pull-requests: write
     steps:
       - uses: actions/checkout@v4
         with:

package/templates/README.md

@@ -4,10 +4,18 @@
   <a href="https://www.npmjs.com/package/<%= packageName %>" target="_blank">
     <img alt="Version" src="https://img.shields.io/npm/v/<%= packageName %>.svg">
   </a>
+  <a href="https://www.npmjs.com/package/<%= packageName %>" target="_blank">
+    <img alt="npm downloads" src="https://img.shields.io/npm/dt/<%= packageName %>?label=npm%20downloads&color=yellow">
+  </a>
 <% } -%>
 <% if (projectVersion && isJSProject) { -%>
   <img alt="Version" src="https://img.shields.io/github/package-json/v/<%= authorGithubUsername %>/<%= packageName %>.svg" />
 <% } -%>
+<% if (isOpenSource && isInitDocker) { -%>
+  <a href="https://hub.docker.com/r/<%= dockerUsername %>/<%= projectName %>" target="_blank">
+    <img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/<%= dockerUsername %>/<%= projectName %>">
+  </a>
+<% } -%>
 <% if (isGithubRepos && isInitSemanticRelease) { -%>
   <a href="<%= repositoryUrl %>/actions?query=workflow%3ARelease" target="_blank">
     <img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/<%= authorGithubUsername %>/<%= projectName %>/release.yml?branch=master">

package/templates/commitlint.config.cjs

@@ -17,5 +17,6 @@ module.exports = {
         'subject-full-stop': [0, 'never'],
         'subject-case': [0, 'never'],
         'body-max-line-length': [0, 'never'],
+        'footer-max-line-length': [0, 'never'],
     },
 }

package/templates/commitlint.config.js

@@ -17,5 +17,6 @@ module.exports = {
         'subject-full-stop': [0, 'never'],
         'subject-case': [0, 'never'],
         'body-max-line-length': [0, 'never'],
+        'footer-max-line-length': [0, 'never'],
     },
 }