cmyr-template-cli 1.24.2 → 1.25.0

package/dist/plopfile.js

@@ -424,7 +424,7 @@ async function downloadGitRepo(repository, destination, options = {}) {
                 resolve(true);
             });
         }),
-        new Promise((resolve, reject) => setTimeout(reject, 60 * 1000)),
+        new Promise((_resolve, reject) => setTimeout(reject, 60 * 1000)),
     ]);
 }
 async function getFastGitRepo(repository) {
@@ -485,12 +485,12 @@ async function init(projectPath, answers) {
             await asyncExec(`${PACKAGE_MANAGER} -v`, {
                 cwd: projectPath,
             });
-            const newPkg = await initProjectJson(projectPath, answers);
             await initConfig(projectPath);
             await initCommitizen(projectPath);
             if (isOpenSource) {
                 const info = await getProjectInfo(projectPath, answers);
                 if (info) {
+                    await initProjectJson(projectPath, info);
                     if (isInitReadme) {
                         await initReadme(projectPath, info);
                     }
@@ -520,7 +520,8 @@ async function init(projectPath, answers) {
             await asyncExec('git add .', {
                 cwd: projectPath,
             });
-            if ((_a = newPkg === null || newPkg === void 0 ? void 0 : newPkg.scripts) === null || _a === void 0 ? void 0 : _a.lint) {
+            const pkg = await getProjectJson(projectPath);
+            if ((_a = pkg === null || pkg === void 0 ? void 0 : pkg.scripts) === null || _a === void 0 ? void 0 : _a.lint) {
                 await asyncExec(`${PACKAGE_MANAGER} run lint`, {
                     cwd: projectPath,
                 });
@@ -811,36 +812,24 @@ async function initTsconfig(projectPath) {
         console.error(error);
     }
 }
-async function initProjectJson(projectPath, answers) {
+async function initProjectJson(projectPath, projectInfos) {
     const loading = ora__default["default"]('正在初始化 package.json ……').start();
     try {
-        const { name, author, description, keywords = [], 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 nodeVersion = await getLtsNodeVersion() || '18';
-        const node = Number(nodeVersion) - 4;
+        const { packageName, engines, license, homepage, issuesUrl, gitUrl, author, description, keywords = [], isOpenSource, isPublishToNpm = false } = projectInfos;
         const pkg = await getProjectJson(projectPath);
         const pkgData = {
-            name,
+            name: packageName,
             author,
             description,
             keywords,
             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,
-            },
+            engines,
         };
         let extData = {};
         if (isOpenSource) {
             extData = {
-                license: 'MIT',
+                license,
                 homepage,
                 repository: {
                     type: 'git',
@@ -849,9 +838,6 @@ async function initProjectJson(projectPath, answers) {
                 bugs: {
                     url: issuesUrl,
                 },
-                changelog: {
-                    language: 'zh',
-                },
             };
         }
         if (isPublishToNpm) {
@@ -859,7 +845,7 @@ async function initProjectJson(projectPath, answers) {
                 access: 'public',
             };
         }
-        const newPkg = Object.assign({}, pkg, pkgData, extData);
+        const newPkg = lodash.merge({}, pkg, pkgData, extData);
         await saveProjectJson(projectPath, newPkg);
         loading.succeed('package.json 初始化成功！');
         return newPkg;
@@ -874,36 +860,42 @@ async function getProjectInfo(projectPath, answers) {
     var _a, _b, _c, _d, _e, _f;
     const loading = ora__default["default"]('正在获取项目信息 ……').start();
     try {
-        const { name, author, description, isOpenSource, isPublishToNpm, license } = answers;
+        const { name, author, description, template, isOpenSource, isPublishToNpm, license, isPrivateScopePackage, scopeName } = answers;
+        const templateMeta = getTemplateMeta(template);
+        const projectName = name;
         const packageManager = 'npm';
         const config = await loadTemplateCliConfig();
         const pkg = await getProjectJson(projectPath);
-        const packageName = name;
-        const engines = (pkg === null || pkg === void 0 ? void 0 : pkg.engines) || {};
+        const nodeVersion = await getLtsNodeVersion() || '20';
+        const node = Number(nodeVersion) - 4;
+        const packageName = isPrivateScopePackage ? `@${scopeName}/${name}` : name;
+        const engines = lodash.merge({}, pkg === null || pkg === void 0 ? void 0 : pkg.engines, { node: `>=${node}` });
         const version = (pkg === null || pkg === void 0 ? void 0 : pkg.version) || '0.1.0';
-        const installCommand = isPublishToNpm ? `${packageManager} install ${name}` : `${packageManager} install`;
+        const installCommand = isPublishToNpm ? `${packageManager} install ${packageName}` : `${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 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 githubUsername = (config === null || config === void 0 ? void 0 : config.GITHUB_USERNAME) || author;
+        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 npmUsername = config === null || config === void 0 ? void 0 : config.NPM_USERNAME;
+        const repositoryUrl = `https://github.com/${githubUsername}/${projectName}`;
+        const gitUrl = `git+${repositoryUrl}.git`;
         const issuesUrl = `${repositoryUrl}/issues`;
         const contributingUrl = `${repositoryUrl}/blob/master/CONTRIBUTING.md`;
         const documentationUrl = `${repositoryUrl}#readme`;
         const demoUrl = `${repositoryUrl}#readme`;
         const homepage = documentationUrl;
-        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 authorWebsite = await getAuthorWebsiteFromGithubAPI(githubUsername);
         const projectInfos = {
             ...answers,
             currentYear: new Date().getFullYear(),
@@ -914,6 +906,7 @@ async function getProjectInfo(projectPath, answers) {
             authorWebsite,
             homepage,
             demoUrl,
+            gitUrl,
             repositoryUrl,
             issuesUrl,
             contributingUrl,
@@ -925,7 +918,7 @@ async function getProjectInfo(projectPath, answers) {
             licenseName: cleanText(license),
             licenseUrl,
             documentationUrl,
-            isGithubRepos: true,
+            isGithubRepos: isOpenSource,
             installCommand,
             startCommand,
             usage: startCommand,
@@ -934,12 +927,12 @@ async function getProjectInfo(projectPath, answers) {
             testCommand,
             lintCommand,
             commitCommand,
-            isJSProject: true,
+            isJSProject: ['nodejs', 'browser'].includes(templateMeta === null || templateMeta === void 0 ? void 0 : templateMeta.runtime),
             packageManager,
             isProjectOnNpm: isPublishToNpm,
             isOpenSource,
             packageName,
-            projectName: name,
+            projectName,
             projectVersion: version,
             projectDocumentationUrl: documentationUrl,
             projectDescription: description,
@@ -956,6 +949,8 @@ async function getProjectInfo(projectPath, answers) {
             patreonUsername,
             weiboUsername,
             twitterUsername,
+            npmUsername,
+            templateMeta,
         };
         loading.succeed('项目信息 初始化成功！');
         return projectInfos;
@@ -1092,6 +1087,9 @@ async function initSemanticRelease(projectPath) {
                 'conventional-changelog-cmyr-config': `^${await getNpmPackageVersion('conventional-changelog-cmyr-config')}`,
                 'semantic-release': devDependencies['semantic-release'],
             },
+            changelog: {
+                language: 'zh',
+            },
         };
         await saveProjectJson(projectPath, pkgData);
         loading.succeed('semantic-release 初始化成功！');
@@ -1288,7 +1286,7 @@ async function initCommitizen(projectPath) {
             config: {
                 ...pkg === null || pkg === void 0 ? void 0 : pkg.config,
                 commitizen: {
-                    path: './node_modules/cz-conventional-changelog-cmyr',
+                    path: 'cz-conventional-changelog-cmyr',
                 },
             },
         };
@@ -1528,9 +1526,9 @@ module.exports = function (plop) {
                 {
                     type: 'input',
                     name: 'keywords',
-                    message: '请输入项目关键词(用空格分割)',
+                    message: '请输入项目关键词(用,分割)',
                     default: '',
-                    filter: (e) => e.trim().split(' ').filter(Boolean),
+                    filter: (e) => e.trim().split(',').filter(Boolean),
                 },
                 {
                     type: 'list',
@@ -1634,6 +1632,25 @@ module.exports = function (plop) {
                         return answers.isOpenSource && templateMeta.npm;
                     },
                 },
+                {
+                    type: 'confirm',
+                    name: 'isPrivateScopePackage',
+                    message: '是否为私域包？',
+                    default: false,
+                    when(answers) {
+                        return answers.isPublishToNpm;
+                    },
+                },
+                {
+                    type: 'input',
+                    name: 'scopeName',
+                    message: '请输入私域名称',
+                    default: config.NPM_USERNAME,
+                    when(answers) {
+                        return answers.isPrivateScopePackage;
+                    },
+                    filter: (e) => e.trim(),
+                },
                 {
                     type: 'confirm',
                     name: 'isInitSemanticRelease',

package/package.json

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

package/templates/CONTRIBUTING.md

@@ -52,7 +52,7 @@
 
 ### 如何提交拉取请求
 
-1. 在我们的存储库中搜索 与您的提交相关的开放或关闭的 [Pull Requests](<%= pullRequestsUrl %>)。你不想重复努力。
+1. 在我们的存储库中搜索 与您的提交相关的开放或关闭的 [Pull Requests](<%= pullRequestsUrl %>)，如果你不想重复努力。
 
 2. Fork 本项目
 

package/templates/README.md

@@ -1,8 +1,8 @@
-<h1 align="center"><%= projectName %> </h1>
+<h1 align="center"><%= packageName %> </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 href="https://www.npmjs.com/package/<%= packageName %>" target="_blank">
+    <img alt="Version" src="https://img.shields.io/npm/v/<%= packageName %>.svg">
   </a>
 <% } -%>
 <% if (projectVersion && !isProjectOnNpm) { -%>
@@ -121,10 +121,9 @@
 
 <% if (authorWebsite) { -%>
 * Website: [<%= authorWebsite %>](<%= authorWebsite %>)
-
 <% } -%>
-<% if (authorGithubUsername) { -%>
-* GitHub: [@<%= authorGithubUsername %>](https://github.com/<%= authorGithubUsername %>)
+<% if (githubUsername) { -%>
+* GitHub: [@<%= githubUsername %>](https://github.com/<%= githubUsername %>)
 <% } -%>
 <% if (twitterUsername) { -%> 
 * Twitter: [@<%= twitterUsername %>](https://twitter.com/<%= twitterUsername %>)

package/templates/scripts/minify-docker.js

@@ -1,15 +1,26 @@
 /* eslint-disable no-console, @typescript-eslint/no-var-requires */
 const fs = require('fs-extra')
 const path = require('path')
-const { nodeFileTrace } = require('@vercel/nft')
+const { nodeFileTrace } = require('@vercel/nft');
 // !!! if any new dependencies are added, update the Dockerfile !!!
 
-const projectRoot = path.resolve(process.env.PROJECT_ROOT || path.join(__dirname, '../'))
-const resultFolder = path.join(projectRoot, 'app-minimal') // no need to resolve, ProjectRoot is always absolute
-const pkg = fs.readJSONSync(path.join(projectRoot, 'package.json'))
-const files = [pkg.main || 'dist/index.js'].map((file) => path.join(projectRoot, file));
-
 (async () => {
+    const projectRoot = path.resolve(process.env.PROJECT_ROOT || path.join(__dirname, '../'))
+    const resultFolder = path.join(projectRoot, 'app-minimal') // no need to resolve, ProjectRoot is always absolute
+    const pkg = await fs.readJSON(path.join(projectRoot, 'package.json'))
+
+    let mainPath = ''
+    const mainPaths = [pkg.main, 'dist/index.js', 'dist/main.js']
+    for (const key of mainPaths) {
+        const fullPath = path.join(projectRoot, key)
+        if (await fs.pathExists(fullPath)) {
+            mainPath = fullPath
+        }
+    }
+    if (!mainPath) {
+        process.exit(1)
+    }
+    const files = [mainPath]
     console.log('Start analyzing, project root:', projectRoot)
     const { fileList: fileSet } = await nodeFileTrace(files, {
         base: projectRoot,