cmyr-template-cli 1.32.2 → 1.33.0

package/dist/plopfile.js

@@ -148,7 +148,7 @@ const TEMPLATES_META_LIST = [
         language: 'typescript',
         runtime: 'nodejs',
         vueVersion: 0,
-        docker: false,
+        docker: true,
         priority: 0,
     },
     {
@@ -349,6 +349,28 @@ async function createGithubRepo(authToken, data) {
         return null;
     }
 }
+async function replaceGithubRepositoryTopics(authToken, data) {
+    try {
+        const { owner, repo, topics } = data;
+        const resp = await axios__default["default"]({
+            url: `/repos/${owner}/${repo}/topics`,
+            baseURL: GITHUB_API_URL,
+            method: 'PUT',
+            headers: {
+                Authorization: `Bearer ${authToken}`,
+                Accept: 'application/vnd.github+json',
+            },
+            data: {
+                names: topics,
+            },
+        });
+        return resp.data;
+    }
+    catch (error) {
+        console.error(error);
+        return null;
+    }
+}
 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) => {
@@ -433,7 +455,7 @@ async function initProject(answers) {
 }
 async function init(projectPath, answers) {
     var _a;
-    const { template, isOpenSource, isInitReadme, isInitContributing, isInitHusky, isInitSemanticRelease, isInitDocker, isInitJest } = answers;
+    const { template, isOpenSource, isInitReadme, isInitContributing, isInitHusky, isInitSemanticRelease, isInitDocker, isInitTest } = answers;
     try {
         const templateMeta = getTemplateMeta(template);
         await asyncExec('git --version', {
@@ -477,8 +499,8 @@ async function init(projectPath, answers) {
             await initTsconfig(projectPath, answers);
             await initEslint(projectPath, answers);
             await initStylelint(projectPath);
-            if (isInitJest) {
-                await initJest(projectPath);
+            if (isInitTest) {
+                await initTest(projectPath, answers);
             }
             await sortProjectJson(projectPath);
             await initYarn(projectPath, answers);
@@ -574,10 +596,11 @@ async function getGitUserName() {
     return username === null || username === void 0 ? void 0 : username.trim();
 }
 async function initRemoteGitRepo(projectPath, answers) {
-    var _a, _b;
+    var _a, _b, _c, _d, _e;
     const loading = ora__default["default"]('正在初始化远程 Git 仓库……').start();
     try {
-        const { name, description, gitRemoteUrl, isOpenSource, isInitRemoteRepo } = answers;
+        const { name, description, gitRemoteUrl, isOpenSource, isInitRemoteRepo, keywords, template } = answers;
+        const templateMeta = getTemplateMeta(template);
         if (!gitRemoteUrl) {
             loading.fail('未找到远程 Git 仓库地址，请自行初始化！');
             return;
@@ -613,6 +636,29 @@ async function initRemoteGitRepo(projectPath, answers) {
                 if ((resp === null || resp === void 0 ? void 0 : resp.status) >= 200) {
                     loading.succeed('远程 Git 仓库初始化成功！');
                     console.info(colors__default["default"].green(`远程 Git 仓库地址 ${(_a = resp.data) === null || _a === void 0 ? void 0 : _a.html_url}`));
+                    const owner = (_c = (_b = resp.data) === null || _b === void 0 ? void 0 : _b.owner) === null || _c === void 0 ? void 0 : _c.login;
+                    const repo = (_d = resp.data) === null || _d === void 0 ? void 0 : _d.name;
+                    if (owner && repo) {
+                        console.info(colors__default["default"].green('正在初始化仓库 topics ！'));
+                        if (templateMeta.docker) {
+                            keywords.push('docker');
+                        }
+                        if (templateMeta === null || templateMeta === void 0 ? void 0 : templateMeta.language) {
+                            keywords.push(templateMeta === null || templateMeta === void 0 ? void 0 : templateMeta.language);
+                        }
+                        if (templateMeta === null || templateMeta === void 0 ? void 0 : templateMeta.runtime) {
+                            keywords.push(templateMeta === null || templateMeta === void 0 ? void 0 : templateMeta.runtime);
+                        }
+                        if ((templateMeta === null || templateMeta === void 0 ? void 0 : templateMeta.vueVersion) === 3) {
+                            keywords.push('vue3');
+                        }
+                        await replaceGithubRepositoryTopics(authToken, {
+                            owner,
+                            repo,
+                            topics: lodash.uniq(keywords).map((e) => kebabCase(e)),
+                        });
+                        console.info(colors__default["default"].green('仓库 topics 初始化成功！'));
+                    }
                 }
                 else {
                     loading.fail('远程 Git 仓库初始化失败！');
@@ -633,7 +679,7 @@ async function initRemoteGitRepo(projectPath, answers) {
                 });
                 if ((resp === null || resp === void 0 ? void 0 : resp.status) >= 200) {
                     loading.succeed('远程 Git 仓库初始化成功！');
-                    console.info(colors__default["default"].green(`远程 Git 仓库地址 ${(_b = resp.data) === null || _b === void 0 ? void 0 : _b.html_url}`));
+                    console.info(colors__default["default"].green(`远程 Git 仓库地址 ${(_e = resp.data) === null || _e === void 0 ? void 0 : _e.html_url}`));
                 }
                 else {
                     loading.fail('远程 Git 仓库初始化失败！');
@@ -1300,7 +1346,7 @@ async function initDocker(projectPath, answers) {
     const loading = ora__default["default"]('正在初始化 Docker ……').start();
     try {
         const templateMeta = getTemplateMeta(answers.template);
-        const files = ['.dockerignore', 'docker-compose.yml'];
+        const files = ['.dockerignore', 'docker-compose.yml', '.github/workflows/docker.yml'];
         await copyFilesFromTemplates(projectPath, files);
         let dockerfile = 'Dockerfile';
         const newPath = path__default["default"].join(projectPath, 'Dockerfile');
@@ -1319,7 +1365,7 @@ async function initDocker(projectPath, answers) {
                 if (!await fs__default["default"].pathExists(scriptsDir)) {
                     await fs__default["default"].mkdir(scriptsDir);
                 }
-                await copyFilesFromTemplates(projectPath, ['scripts/minify-docker.js']);
+                await copyFilesFromTemplates(projectPath, ['scripts/minify-docker.cjs']);
             }
             const pkg = await getProjectJson(projectPath);
             const mainFile = pkg === null || pkg === void 0 ? void 0 : pkg.main;
@@ -1347,35 +1393,69 @@ async function initDocker(projectPath, answers) {
         loading.fail('Docker 初始化失败！');
     }
 }
-async function initJest(projectPath) {
-    const loading = ora__default["default"]('正在初始化 Jest ……').start();
+async function initTest(projectPath, answers) {
+    var _a, _b;
+    const loading = ora__default["default"]('正在初始化测试 ……').start();
     try {
-        const files = ['jest.config.ts'];
-        await copyFilesFromTemplates(projectPath, files);
-        const pkg = await getProjectJson(projectPath);
-        const devDependencies = {
-            '@types/jest': '^29.5.12',
-            jest: '^29.7.0',
-            'ts-jest': '^29.1.2',
-            'ts-node': '^10.9.2',
-        };
-        const newPkg = lodash.merge({}, pkg, {
-            scripts: {
-                test: 'jest --config jest.config.ts',
-                'test:coverage': 'jest --config jest.config.ts --coverage',
-                ...pkg === null || pkg === void 0 ? void 0 : pkg.scripts,
-            },
-            devDependencies: {
-                ...devDependencies,
-                ...pkg === null || pkg === void 0 ? void 0 : pkg.devDependencies,
-            },
-        });
-        newPkg.jest = undefined;
-        await saveProjectJson(projectPath, newPkg);
-        loading.succeed('Jest 初始化成功！');
+        if (answers.isInitTest === 'vitest') {
+            const files = ['vitest.config.ts'];
+            await copyFilesFromTemplates(projectPath, files);
+            const pkg = await getProjectJson(projectPath);
+            const devDependencies = {
+                vitest: '^2.1.6',
+            };
+            if (!((_a = pkg === null || pkg === void 0 ? void 0 : pkg.dependencies) === null || _a === void 0 ? void 0 : _a.vite) && !((_b = pkg === null || pkg === void 0 ? void 0 : pkg.devDependencies) === null || _b === void 0 ? void 0 : _b.vite)) {
+                devDependencies.vite = '^6.0.1';
+            }
+            const newPkg = lodash.merge({}, pkg, {
+                scripts: {
+                    test: 'vitest run',
+                    'test:coverage': 'vitest run --coverage',
+                    ...pkg === null || pkg === void 0 ? void 0 : pkg.scripts,
+                },
+                devDependencies: {
+                    ...devDependencies,
+                    ...pkg === null || pkg === void 0 ? void 0 : pkg.devDependencies,
+                },
+            });
+            await saveProjectJson(projectPath, newPkg);
+            loading.succeed('Vitest 初始化成功！');
+            return;
+        }
+        if (answers.isInitTest === 'jest') {
+            const files = ['jest.config.ts'];
+            await copyFilesFromTemplates(projectPath, files);
+            const pkg = await getProjectJson(projectPath);
+            const devDependencies = {
+                '@types/jest': '^29.5.12',
+                jest: '^29.7.0',
+                'ts-jest': '^29.1.2',
+                'ts-node': '^10.9.2',
+            };
+            const newPkg = lodash.merge({}, pkg, {
+                scripts: {
+                    test: 'jest --config jest.config.ts',
+                    'test:coverage': 'jest --config jest.config.ts --coverage',
+                    ...pkg === null || pkg === void 0 ? void 0 : pkg.scripts,
+                },
+                devDependencies: {
+                    ...devDependencies,
+                    ...pkg === null || pkg === void 0 ? void 0 : pkg.devDependencies,
+                },
+            });
+            newPkg.jest = undefined;
+            await saveProjectJson(projectPath, newPkg);
+            loading.succeed('Jest 初始化成功！');
+            return;
+        }
+        if (answers.isInitTest === 'none') {
+            loading.succeed('未选择测试框架，跳过测试初始化');
+            return;
+        }
+        loading.succeed('未选择测试框架，跳过测试初始化');
     }
     catch (error) {
-        loading.fail('Jest 初始化失败！');
+        loading.fail('测试初始化失败！');
     }
 }
 async function jsFileExtRename(projectPath) {
@@ -1693,7 +1773,11 @@ module.exports = function (plop) {
                     },
                     default(answers) {
                         const templateMeta = getTemplateMeta(answers.template);
-                        return ['nodejs'].includes(templateMeta === null || templateMeta === void 0 ? void 0 : templateMeta.runtime) ? 'cjs' : '';
+                        if (!['nodejs'].includes(templateMeta === null || templateMeta === void 0 ? void 0 : templateMeta.runtime)) {
+                            return '';
+                        }
+                        const nodeVersion = Number(process.version.split('.')[0].slice(1)) - 4;
+                        return nodeVersion >= 18 ? 'esm' : 'cjs';
                     },
                     when(answers) {
                         const templateMeta = getTemplateMeta(answers.template);
@@ -1840,11 +1924,14 @@ module.exports = function (plop) {
                     },
                 },
                 {
-                    type: 'confirm',
-                    name: 'isInitJest',
-                    message: '是否初始化 jest？',
+                    type: 'list',
+                    name: 'isInitTest',
+                    message: '请选择测试框架',
+                    choices() {
+                        return ['vitest', 'jest', 'none'];
+                    },
                     default(answers) {
-                        return answers.isPublishToNpm;
+                        return answers.isPublishToNpm ? 'vitest' : 'none';
                     },
                     when(answers) {
                         return answers.isOpenSource;

package/package.json

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

package/templates/.github/workflows/docker.yml

@@ -0,0 +1,108 @@
+name: Publish Docker Image
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+
+# 仅取消针对当前工作流正在进行的作业或运行
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: "latest"
+      - name: Setup Node.js@lts environment
+        uses: actions/setup-node@v4
+        with:
+          node-version: "lts/*"
+          cache: "pnpm"
+      - name: Cache Dependency
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.npm
+            ~/.yarn
+            ~/.cache/pnpm
+            ~/cache
+            !~/cache/exclude
+            **/node_modules
+          key: pnpm-${{ runner.os }}-${{ hashFiles('package.json') }}
+          restore-keys: pnpm-${{ runner.os }}
+      - run: pnpm i --frozen-lockfile
+      - run: pnpm run lint
+      - run: pnpm run build
+      - run: pnpm run test
+  build:
+    needs: test # 等待 test 执行成功
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    permissions:
+      packages: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      # - name: Login to Docker Hub
+      #   uses: docker/login-action@v3
+      #   with:
+      #     username: ${{ secrets.DOCKER_USERNAME }}
+      #     password: ${{ secrets.DOCKER_PASSWORD }}
+      # - name: Login to Alibaba Cloud Container Registry
+      #   uses: docker/login-action@v3
+      #   with:
+      #     registry: registry.cn-hangzhou.aliyuncs.com
+      #     username: ${{ secrets.ALIYUN_USERNAME }}
+      #     password: ${{ secrets.ALIYUN_PASSWORD }}
+      - name: Extract Docker metadata
+        id: metadata
+        uses: docker/metadata-action@v5
+        with:
+          # 发布到 docker.io / ghcr.io / registry.cn-hangzhou.aliyuncs.com
+          # registry.cn-hangzhou.aliyuncs.com/${{ github.repository }}
+          images: |
+            ${{ github.repository }}
+            ghcr.io/${{ github.repository }}
+          tags: |
+            type=raw,value=latest,enable=true
+            type=raw,value={{date 'YYYY-MM-DD' tz='Asia/Shanghai'}},enable=true
+            type=sha,format=short,prefix=sha-,enable=true
+          flavor: latest=false
+      - name: Build and push Docker images
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./Dockerfile
+          # 推送到 dockerhub
+          push: false
+          tags: ${{ steps.metadata.outputs.tags }}
+          labels: ${{ steps.metadata.outputs.labels }}
+          platforms: linux/amd64,linux/arm64
+      # - name: Docker Hub README & description sync
+      #   uses: meeDamian/sync-readme@v1.0.6
+      #   with:
+      #     user: ${{ secrets.DOCKER_USERNAME }}
+      #     pass: ${{ secrets.DOCKER_PASSWORD }}
+      #     slug: ${{ github.repository }}
+      #     description: "基于 Hono 和 TypeScript 的云函数模板"

package/templates/Dockerfile

@@ -1,7 +1,7 @@
 FROM caomeiyouren/alpine-nodejs:latest AS nodejs
 
-RUN npm config set registry https://registry.npmmirror.com && \
-    pnpm config set registry https://registry.npmmirror.com
+# RUN npm config set registry https://registry.npmmirror.com && \
+#     pnpm config set registry https://registry.npmmirror.com
 
 FROM caomeiyouren/alpine-nodejs-minimize:latest AS runtime
 
@@ -28,7 +28,7 @@ RUN pnpm add @vercel/nft@0.24.4 fs-extra@11.2.0 --save-prod
 COPY --from=builder /app /app
 
 RUN export PROJECT_ROOT=/app/ && \
-    node /app/scripts/minify-docker.js && \
+    node /app/scripts/minify-docker.cjs && \
     rm -rf /app/node_modules /app/scripts && \
     mv /app/app-minimal/node_modules /app/ && \
     rm -rf /app/app-minimal

package/templates/vitest.config.ts

@@ -0,0 +1,19 @@
+import path from 'path'
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+    test: {
+        globals: true,
+        environment: 'node',
+    },
+    resolve: {
+        alias: {
+            '@': path.resolve(__dirname, 'src'),
+        },
+    },
+    root: path.resolve('./'),
+    coverage: {
+        clean: true,
+        reportsDirectory: path.resolve('./coverage'),
+    },
+})