listpage_cli 0.0.294 → 0.0.296

package/bin/services/release-project-service.js

@@ -0,0 +1,239 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runReleaseProjectFlow = runReleaseProjectFlow;
+const command_result_1 = require("../domain/command-result");
+const config_loader_1 = require("./config-loader");
+const command_runner_1 = require("./command-runner");
+const build_artifact_validator_1 = require("./build-artifact-validator");
+const config_value_utils_1 = require("./config-value-utils");
+const RELEASE_STAGE = "release";
+const CONFIG_ERROR_CODE_MAP = {
+    CONFIG_NOT_FOUND: "E_CONFIG_NOT_FOUND",
+    CONFIG_READ_FAILED: "E_CONFIG_READ_FAILED",
+    CONFIG_INVALID_JSON: "E_CONFIG_INVALID_JSON",
+    CONFIG_REQUIRED_FIELD_MISSING: "E_CONFIG_REQUIRED_FIELD_MISSING",
+};
+async function runReleaseProjectFlow(deps) {
+    const projectRoot = deps.fs.cwd();
+    const configPath = (0, config_loader_1.getDefaultConfigPath)(projectRoot, deps.fs.join);
+    let configResult;
+    try {
+        configResult = (0, config_loader_1.loadProjectConfig)({
+            readText: deps.fs.readText,
+        }, configPath);
+    }
+    catch (error) {
+        if (error instanceof config_loader_1.ConfigLoaderError) {
+            return (0, command_result_1.commandError)(error.message, CONFIG_ERROR_CODE_MAP[error.code], 1);
+        }
+        const message = error instanceof Error ? error.message : String(error);
+        return (0, command_result_1.commandError)(message, command_result_1.COMMAND_ERROR_CODES.invalidPath, 1);
+    }
+    let executionInput;
+    try {
+        executionInput = parseReleaseInput(projectRoot, configResult.config, deps.fs.resolve, deps.cliOverrides);
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : String(error);
+        return (0, command_result_1.commandError)(`[${RELEASE_STAGE}] 发布配置无效: ${message}`, "E_CONFIG_REQUIRED_FIELD_MISSING", 1);
+    }
+    const validator = (0, build_artifact_validator_1.createBuildArtifactValidator)({
+        resolve: deps.fs.resolve,
+        exists: deps.fs.exists,
+        isDirectory: deps.fs.isDirectory,
+        readDir: deps.fs.readDir,
+    });
+    const validationResult = validator({
+        outputDir: executionInput.outputDir,
+        requiredRelativePaths: collectRequiredArtifacts(configResult.config),
+    });
+    if (!validationResult.ok) {
+        const message = validationResult.issues.map((issue) => issue.message).join("; ");
+        return (0, command_result_1.commandError)(message, command_result_1.COMMAND_ERROR_CODES.executionFailed, 1);
+    }
+    if (deps.executeRelease) {
+        try {
+            const result = await deps.executeRelease({
+                projectRoot,
+                configPath: configResult.configPath,
+                config: configResult.config,
+                outputDir: executionInput.outputDir,
+                remoteImage: executionInput.remoteImage,
+                docker: executionInput.docker,
+            });
+            return normalizeReleaseResult(result);
+        }
+        catch (error) {
+            return (0, command_result_1.commandError)(formatReleaseThrownError(error), command_result_1.COMMAND_ERROR_CODES.executionFailed, getNonZeroExitCode(error));
+        }
+    }
+    const commandRunner = deps.createRunner
+        ? deps.createRunner()
+        : (0, command_runner_1.createCommandRunner)({ stage: RELEASE_STAGE });
+    return runDockerRelease(commandRunner, executionInput);
+}
+function parseReleaseInput(projectRoot, config, resolve, cliOverrides) {
+    const typedConfig = config;
+    const dockerRaw = (0, config_value_utils_1.asObject)(typedConfig.docker, "docker");
+    const registry = (0, config_value_utils_1.asObject)(dockerRaw.registry, "docker.registry");
+    const build = ((0, config_value_utils_1.asOptionalObject)(dockerRaw.build) ?? {});
+    const releaseProfiles = ((0, config_value_utils_1.asOptionalObject)(dockerRaw.releaseProfiles) ??
+        {});
+    const profile = cliOverrides?.profile?.trim() || "dev";
+    const profileConfig = (0, config_value_utils_1.asOptionalObject)(releaseProfiles[profile]);
+    const imageName = (0, config_value_utils_1.asRequiredString)(dockerRaw.imageName ?? dockerRaw.appName, "docker.imageName/appName");
+    const imageTag = resolveImageTag(cliOverrides?.tag, (0, config_value_utils_1.asOptionalString)(profileConfig?.tag), (0, config_value_utils_1.asOptionalString)(dockerRaw.imageTag));
+    const registryUrl = (0, config_value_utils_1.asRequiredString)(registry.url, "docker.registry.url");
+    const registryNamespace = (0, config_value_utils_1.asOptionalString)(registry.namespace);
+    const username = (0, config_value_utils_1.asRequiredString)(registry.username, "docker.registry.username");
+    const password = (0, config_value_utils_1.asOptionalString)(registry.password);
+    const profileBuild = ((0, config_value_utils_1.asOptionalObject)(profileConfig?.buildOverrides) ??
+        {});
+    const platform = cliOverrides?.platform ??
+        (0, config_value_utils_1.asOptionalString)(profileBuild.platform) ??
+        (0, config_value_utils_1.asOptionalString)(build.platform);
+    const outputDir = resolve(projectRoot, ".listpage", "output");
+    const repositoryPath = registryNamespace && registryNamespace !== ""
+        ? `${registryNamespace}/${imageName}`
+        : imageName;
+    return {
+        outputDir,
+        remoteImage: `${registryUrl}/${repositoryPath}:${imageTag}`,
+        docker: {
+            imageName,
+            imageTag,
+            registryUrl,
+            registryNamespace,
+            username,
+            password,
+            platform,
+        },
+    };
+}
+function resolveImageTag(cliTag, profileTag, fallbackTag) {
+    const normalizedCli = cliTag?.trim();
+    if (normalizedCli) {
+        return normalizedCli;
+    }
+    if (profileTag && profileTag.trim() !== "") {
+        return profileTag;
+    }
+    if (fallbackTag && fallbackTag.trim() !== "") {
+        return fallbackTag;
+    }
+    throw new Error("缺少字段: docker.releaseProfiles.<profile>.tag");
+}
+function collectRequiredArtifacts(config) {
+    const required = new Set(["Dockerfile"]);
+    const artifacts = (0, config_value_utils_1.asOptionalObject)(config.artifacts);
+    const frontend = artifacts?.frontend ?? config.frontend;
+    if (Array.isArray(frontend)) {
+        for (const item of frontend) {
+            if (!item || typeof item !== "object" || Array.isArray(item)) {
+                continue;
+            }
+            const record = item;
+            const packageSubDir = (0, config_value_utils_1.asOptionalString)(record.packageSubDir) ?? "public";
+            const artifactAlias = (0, config_value_utils_1.asOptionalString)(record.artifactAlias) ?? "dist";
+            required.add(`${packageSubDir}/${artifactAlias}`);
+        }
+    }
+    const backendRaw = artifacts?.backend ?? config.backend;
+    if (backendRaw && typeof backendRaw === "object" && !Array.isArray(backendRaw)) {
+        const backend = backendRaw;
+        const packageSubDir = (0, config_value_utils_1.asOptionalString)(backend.packageSubDir) ?? "server";
+        const artifactAlias = (0, config_value_utils_1.asOptionalString)(backend.artifactAlias) ?? "dist";
+        required.add(`${packageSubDir}/${artifactAlias}`);
+    }
+    return [...required];
+}
+async function runDockerRelease(runner, input) {
+    const { docker } = input;
+    const localImage = `${docker.imageName}:${docker.imageTag}`;
+    const loginArgs = docker.password
+        ? [
+            "login",
+            `--username=${docker.username}`,
+            `--password=${docker.password}`,
+            docker.registryUrl,
+        ]
+        : [
+            "login",
+            `--username=${docker.username}`,
+            "--password-stdin",
+            docker.registryUrl,
+        ];
+    const buildArgs = [
+        "buildx",
+        "build",
+        ...(docker.platform ? ["--platform", docker.platform] : []),
+        "-t",
+        localImage,
+        ".",
+    ];
+    const stageCommands = [
+        { stage: "login", args: loginArgs, cwd: input.outputDir },
+        { stage: "build", args: buildArgs, cwd: input.outputDir },
+        {
+            stage: "tag",
+            args: ["tag", localImage, input.remoteImage],
+            cwd: input.outputDir,
+        },
+        {
+            stage: "push",
+            args: ["push", input.remoteImage],
+            cwd: input.outputDir,
+        },
+    ];
+    try {
+        for (const command of stageCommands) {
+            const result = await runner({
+                command: "docker",
+                args: command.args,
+                cwd: command.cwd,
+            });
+            if (result.exitCode !== 0) {
+                return (0, command_result_1.commandError)(`[${RELEASE_STAGE}][${command.stage}] Docker 命令执行失败: docker ${command.args.join(" ")} (exit=${result.exitCode})`, command_result_1.COMMAND_ERROR_CODES.executionFailed, result.exitCode);
+            }
+        }
+    }
+    catch (error) {
+        if (error instanceof command_runner_1.ExecutionError) {
+            return (0, command_result_1.commandError)(`[${RELEASE_STAGE}] ${error.message}`, command_result_1.COMMAND_ERROR_CODES.executionFailed, error.exitCode);
+        }
+        const message = error instanceof Error ? error.message : String(error);
+        return (0, command_result_1.commandError)(`[${RELEASE_STAGE}] 发布命令执行异常: ${message}`, command_result_1.COMMAND_ERROR_CODES.executionFailed, 1);
+    }
+    return (0, command_result_1.commandOk)(`[${RELEASE_STAGE}] 发布完成: ${input.remoteImage}\n` +
+        `[${RELEASE_STAGE}] 运行示例: docker run -d -p 3000:3000 --name ${docker.imageName}-container ${input.remoteImage}`);
+}
+function normalizeReleaseResult(result) {
+    if (result.ok) {
+        if (result.exitCode === 0) {
+            return result;
+        }
+        return (0, command_result_1.commandError)(`[${RELEASE_STAGE}] 发布执行器返回成功但退出码非零 (exit=${result.exitCode})`, command_result_1.COMMAND_ERROR_CODES.executionFailed, result.exitCode);
+    }
+    if (result.exitCode !== 0) {
+        return result;
+    }
+    return (0, command_result_1.commandError)(result.message ??
+        `[${RELEASE_STAGE}] 发布执行器返回失败但退出码为 0`, result.errorCode ?? command_result_1.COMMAND_ERROR_CODES.executionFailed, 1);
+}
+function formatReleaseThrownError(error) {
+    const message = error instanceof Error ? error.message : String(error);
+    return `[${RELEASE_STAGE}] 发布执行异常: ${message}`;
+}
+function getNonZeroExitCode(error) {
+    if (!error || typeof error !== "object") {
+        return 1;
+    }
+    const candidate = error;
+    if (typeof candidate.exitCode === "number" && candidate.exitCode !== 0) {
+        return candidate.exitCode;
+    }
+    if (typeof candidate.status === "number" && candidate.status !== 0) {
+        return candidate.status;
+    }
+    return 1;
+}

package/bin/shared/json-with-comments.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseJsonWithComments = parseJsonWithComments;
+function parseJsonWithComments(str) {
+    const noBlock = str.replace(/\/\*[\s\S]*?\*\//g, "");
+    const noLine = noBlock.replace(/(^|\s)\/\/.*$/gm, "");
+    const noTrailingComma = noLine.replace(/,\s*([}\]])/g, "$1");
+    return JSON.parse(noTrailingComma);
+}

package/bin/types/deploy-config.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "listpage_cli",
-  "version": "0.0.294",
+  "version": "0.0.296",
   "private": false,
   "bin": {
     "listpage_cli": "bin/cli.js"
@@ -10,7 +10,7 @@
     "build:tests": "tsc -p tsconfig.tests.json",
     "test:unit": "npm run build:tests && node --test .tmp-tests/tests/unit/**/*.test.js",
     "test:integration": "npm run build && npm run build:tests && node --test .tmp-tests/tests/integration/**/*.test.js",
-    "test:story-1-1": "npm run test:unit && npm run test:integration",
+    "test:integration:deploy-live": "npm run build && npm run build:tests && node --test .tmp-tests/tests/integration/deploy-project.live.integration.test.js",
     "prepublishOnly": "npm run build",
     "start": "node bin/cli.js init",
     "test": "node bin/cli.js --help"
@@ -20,10 +20,12 @@
     "templates"
   ],
   "devDependencies": {
-    "typescript": "^5.6.2",
-    "@types/node": "^22.8.6"
+    "@types/node": "^22.8.6",
+    "typescript": "^5.6.2"
   },
   "dependencies": {
+    "@types/dockerode": "^4.0.1",
+    "dockerode": "^4.0.9",
     "enquirer": "^2.4.1"
   }
 }

package/templates/backend-template/package.json.tmpl

@@ -25,7 +25,7 @@
     "class-transformer": "^0.5.1",
     "class-validator": "~0.14.2",
     "rxjs": "^7.8.1",
-    "listpage-next-nest": "~0.0.294"
+    "listpage-next-nest": "~0.0.296"
   },
   "devDependencies": {
     "@nestjs/schematics": "^11.0.0",

package/templates/backend-template/tsconfig.build.json

@@ -1,4 +1,14 @@
 {
   "extends": "./tsconfig.json",
-  "exclude": ["node_modules", "test", "dist", "**/*spec.ts"]
-}
+  "compilerOptions": {
+    "rootDir": "src",
+    "incremental": false
+  },
+  "exclude": [
+    "node_modules",
+    "test",
+    "**/*spec.ts",
+    "prisma",
+    "prisma.config.ts"
+  ]
+}

package/templates/frontend-template/package.json.tmpl

@@ -12,7 +12,7 @@
   "dependencies": {
     "react": "^19.2.0",
     "react-dom": "^19.2.0",
-    "listpage-next": "~0.0.294",
+    "listpage-next": "~0.0.296",
     "react-router-dom": ">=6.0.0",
     "@ant-design/v5-patch-for-react-19": "~1.0.3",
     "ahooks": "^3.9.5",
@@ -23,7 +23,7 @@
     "styled-components": "^6.1.19",
     "mobx": "~6.15.0",
     "@ant-design/icons": "~6.0.2",
-    "listpage-components": "~0.0.294",
+    "listpage-components": "~0.0.296",
     "lucide-react": "~0.575.0"
     "mobx-react-lite": "~4.1.1"
   },

package/templates/rush-template/listpage.config.json.tmpl

@@ -0,0 +1,89 @@
+{
+	"artifacts": {
+		"frontend": [
+			{
+				"projectDir": "apps/__FRONTEND_NAME__",
+				"packageSubDir": "public",
+				"buildArtifactDirName": "dist",
+				"artifactAlias": "__APP_NAME__"
+			}
+		],
+		"backend": {
+			"projectDir": "servers/__BACKEND_NAME__",
+			"packageSubDir": ".",
+			"buildArtifactDirName": "dist",
+			"artifactAlias": "dist"
+		},
+		"copyFiles": [
+			{
+				"source": "servers/__BACKEND_NAME__/prisma",
+				"dest": "prisma"
+			},
+			{
+				"source": "servers/__BACKEND_NAME__/Dockerfile",
+				"dest": "Dockerfile"
+			},
+			{
+				"source": "servers/__BACKEND_NAME__/package.json",
+				"dest": "package.json"
+			}
+		]
+	},
+	"docker": {
+		"imageName": "__APP_NAME__",
+		"registry": {
+			"url": "registry.cn-hangzhou.aliyuncs.com",
+			"namespace": "",
+			"username": "",
+			"password": ""
+		},
+		"build": {
+			"platform": "linux/amd64"
+		},
+		"releaseProfiles": {
+			"dev": {
+				"tag": "0.0.1",
+				"envFile": "env/.dev"
+			},
+			"test": {
+				"tag": "0.0.1-test",
+				"containerOverrides": {
+					"env": {
+						"NODE_ENV": "test"
+					}
+				}
+			},
+			"online": {
+				"tag": "0.0.1-prod",
+				"buildOverrides": {
+					"platform": "linux/amd64"
+				},
+				"containerOverrides": {
+					"env": {
+						"NODE_ENV": "production"
+					}
+				}
+			}
+		},
+		"remote": {
+			"socketPath": "/var/run/docker.sock",
+			"host": "localhost",
+			"port": 2376,
+			"protocol": "https",
+			"tls": {
+				"ca": "",
+				"cert": "",
+				"key": ""
+			}
+		},
+		"container": {
+			"name": "__APP_NAME__",
+			"ports": ["3000:3000/tcp"],
+			"envFile": "env/.dev",
+			"env": {
+				"NODE_ENV": "development"
+			},
+			"volumes": []
+		}
+	}
+}

package/bin/copy.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.copyRushTemplate = copyRushTemplate;
-exports.updateRushJsonProjects = updateRushJsonProjects;
-exports.copyFrontendTemplate = copyFrontendTemplate;
-exports.copyBackendTemplate = copyBackendTemplate;
-exports.copyDeployScriptTemplate = copyDeployScriptTemplate;
-exports.ensureDir = ensureDir;
-exports.isDirEmpty = isDirEmpty;
-exports.copySkillDir = copySkillDir;
-const node_fs_adapter_1 = require("./adapters/node-fs-adapter");
-const filesystem_capability_service_1 = require("./services/filesystem-capability-service");
-const fsAdapter = (0, node_fs_adapter_1.createNodeFsAdapter)();
-const filesystemCapability = (0, filesystem_capability_service_1.createFilesystemCapabilityService)(fsAdapter, {
-    templateRootDir: fsAdapter.resolve(__dirname, "..", "templates"),
-});
-function copyRushTemplate(targetDir, vars) {
-    filesystemCapability.copyRushTemplate(targetDir, vars);
-}
-function updateRushJsonProjects(filepath, feAppName, beAppName) {
-    filesystemCapability.updateRushJsonProjects(filepath, feAppName, beAppName);
-}
-function copyFrontendTemplate(targetDir, vars) {
-    filesystemCapability.copyFrontendTemplate(targetDir, vars);
-}
-function copyBackendTemplate(targetDir, vars) {
-    filesystemCapability.copyBackendTemplate(targetDir, vars);
-}
-function copyDeployScriptTemplate(targetDir, vars) {
-    filesystemCapability.copyDeployScriptTemplate(targetDir, vars);
-}
-function ensureDir(dir) {
-    fsAdapter.ensureDir(dir);
-}
-function isDirEmpty(dir) {
-    return filesystemCapability.isDirEmpty(dir);
-}
-function copySkillDir(sourceDir, targetDir) {
-    filesystemCapability.copySkillDir(sourceDir, targetDir);
-}

package/templates/package-app-template/.gitignore.tmpl

@@ -1,28 +0,0 @@
-# Dependencies
-node_modules/
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# Build outputs
-dist/
-build/
-temp/
-output/
-
-# Package files
-*.zip
-*.tar.gz
-
-# IDE
-.vscode/
-.idea/
-*.swp
-*.swo
-
-# OS
-.DS_Store
-Thumbs.db
-
-# Logs
-*.log

package/templates/package-app-template/README.md

@@ -1,33 +0,0 @@
-## 内网部署方案
-
-### 步骤一：源码构建
-
-`npm run build`
-
-此时会将前后端的代码打包在`output`目录下
-
-### 步骤二：修改 prisma 连接 url
-
-修改`output/prisma/schema.prisma`文件中的`datasource db`的`url`为内网的 url
-
-### 步骤三：内网环境仿真
-
-修改 dockerfile 中的基础镜像
-
-### 步骤四：带依赖的源码导出
-
-`npm run package`
-
-此时会根据 dockerfile 中的基础镜像，将`output`目录下的代码和依赖导出到`output`目录下，比如 `docker-app-xxxxxx.tar.gz`
-
-### 步骤五：内网部署
-
-将导出的`docker-app-xxxxxx.tar.gz`文件上传到内网的服务器上，比如 `/opt/docker-app-xxxxxx.tar.gz`
-
-然后解压源码：
-
-`tar -zxvf docker-app-xxxxxx.tar.gz`
-
-### 步骤六：启动服务
-
-进入到 dist 目录下， node main.js

package/templates/package-app-template/package.json

@@ -1,27 +0,0 @@
-{
-  "name": "package-app",
-  "version": "1.0.0",
-  "description": "",
-  "main": "dist/build.js",
-  "scripts": {
-    "build": "ts-node src/build.ts",
-    "package": "ts-node src/package.ts",
-    "publish": "ts-node src/publish.ts"
-  },
-  "dependencies": {
-    "listpage-next-deploy": "0.0.294"
-  },
-  "devDependencies": {
-    "@types/node": "^20.0.0",
-    "@types/archiver": "^6.0.0",
-    "typescript": "^5.0.0",
-    "ts-node": "^10.9.0"
-  },
-  "keywords": [
-    "packaging",
-    "build",
-    "typescript"
-  ],
-  "author": "",
-  "license": "MIT"
-}

package/templates/package-app-template/src/build.ts

@@ -1,6 +0,0 @@
-import { Builder } from "listpage-next-deploy";
-import { config } from "./config";
-
-const builder = new Builder(config);
-
-builder.run();

package/templates/package-app-template/src/config.ts.tmpl

@@ -1,45 +0,0 @@
-import { Config } from "listpage-next-deploy";
-import path from "path";
-
-export const config = new Config({
-  root: path.join(__dirname, "../../../../"),
-  clean: true,
-  outputBaseDir: "common/scripts/package-app/output",
-  frontend: [
-    {
-      source: "apps/__FRONTEND_NAME__",
-      output: "public/",
-      outputName: "dist",
-      outputNewName: "__APP_NAME__",
-    },
-  ],
-  backend: {
-    source: "servers/__BACKEND_NAME__",
-    output: ".",
-    outputName: "dist",
-    outputNewName: "dist",
-  },
-  copyFiles: [
-    {
-      source: "servers/__BACKEND_NAME__/prisma",
-      dest: "common/scripts/package-app/output/prisma",
-    },
-    {
-      source: "servers/__BACKEND_NAME__/Dockerfile",
-      dest: "common/scripts/package-app/output/Dockerfile",
-    },
-  ],
-  docker: {
-    imageName: "__APP_NAME__",
-    imageTag: "0.0.1",
-    containerName: "__APP_NAME__",
-    // 需要和 dockerfile 中定义的 app 目录保持一致
-    appName: "__APP_NAME__",
-    registry: {
-      url: "registry.cn-hangzhou.aliyuncs.com",
-      namespace: "",
-      username: "",
-      password: "",
-    },
-  },
-});

package/templates/package-app-template/src/package.ts

@@ -1,5 +0,0 @@
-import { Packager } from "listpage-next-deploy";
-import { config } from "./config";
-
-const packager = new Packager(config);
-packager.run();

package/templates/package-app-template/src/publish.ts

@@ -1,6 +0,0 @@
-import { Deployer } from "listpage-next-deploy";
-import { config } from "./config";
-
-const deployer = new Deployer(config);
-
-deployer.run();

package/templates/package-app-template/tsconfig.json

@@ -1,25 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2020",
-    "module": "commonjs",
-    "lib": ["ES2020"],
-    "types": ["node"],
-    "outDir": "./dist",
-    "rootDir": "./src",
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "resolveJsonModule": true,
-    "declaration": true,
-    "declarationMap": true,
-    "sourceMap": true
-  },
-  "include": [
-    "src/**/*"
-  ],
-  "exclude": [
-    "node_modules",
-    "dist"
-  ]
-}