@gadmin2n/cli 0.0.105 → 0.0.107

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+## [Unreleased]
+
+### BREAKING CHANGES
+
+- `gadmin2 update` 改造为 git-merge 风格三方合并：
+  - base 由 `.gadmin/.meta.json` 中记录的 `@gadmin2n/schematics` npm 版本号唯一标识，单次 update 时 `npm pack` 物化到 `os.tmpdir()`，结束即清理；不再写入 `.gadmin/template-base/` 目录
+  - 删除 4 个 Smart Merger 与逐文件 inquirer prompt
+  - `gadmin-cli.json` 中 `templateUpdate.policies` / `templateUpdate.mergers` 字段已下线，存在则启动报错
+  - 新增 `gadmin2 update status` 子命令、`--ours` / `--theirs` flag
+  - `gadmin2 update diff` 升级为三方展示
+- `gadmin2 update` 现在每次执行都需要访问 npm registry（用于物化 base 对应版本的 schematics 包）；CI 环境请预热 npm 缓存或配置内网 registry。
+
+### Migration
+
+- 老实例首次跑新 CLI 时会进入"首次接入"分支：写入 `.gadmin/.meta.json`（含 `schematicsVersion`）、`.gadmin/README.md`，退出。无数据风险。
+- 含废弃字段的 `gadmin-cli.json` 必须先删除字段才能继续。
+- 之前版本生成的 `.gadmin/template-base/` 目录现在已被忽略，可安全删除并 commit。

package/actions/new.action.js

@@ -37,105 +37,107 @@ class NewAction extends abstract_action_1.AbstractAction {
             const shouldSkipInstall = options.some((option) => option.name === 'skip-install' && option.value === true);
             const shouldSkipGit = options.some((option) => option.name === 'skip-git' && option.value === true);
             const projectDirectory = getProjectDirectory(getApplicationNameInput(inputs), directoryOption);
+            // 落盘用户提供的环境配置(dry-run 模式跳过,因为目录可能未实际生成)
+            if (!isDryRunEnabled) {
+                yield applyEnvConfig(projectDirectory, options).catch((err) => {
+                    console.error(chalk.yellow(`[warn] Failed to apply env config: ${err && err.message ? err.message : err}`));
+                });
+            }
             if (!shouldSkipInstall) {
-                if (options.find(option => option.name === 'server-framework' && option.value === 'nest')) {
-                    console.info('Begin to install server dependence ...');
-                    yield installPackages(options, isDryRunEnabled, (0, path_1.join)(projectDirectory, 'server'));
-                    console.info();
-                }
-                if (options.find(option => option.name === 'with-web' && option.value === true)) {
-                    console.info('Begin to install web dependence ...');
-                    yield installPackages(options, isDryRunEnabled, (0, path_1.join)(projectDirectory, 'web'));
-                    console.info();
-                }
+                console.info('Begin to install server dependence ...');
+                yield installPackages(options, isDryRunEnabled, (0, path_1.join)(projectDirectory, 'server'));
+                console.info();
+                console.info('Begin to install web dependence ...');
+                yield installPackages(options, isDryRunEnabled, (0, path_1.join)(projectDirectory, 'web'));
+                console.info();
             }
             if (!isDryRunEnabled) {
                 if (!shouldSkipGit) {
                     yield initializeGitRepository(projectDirectory);
                     yield createGitIgnoreFile(projectDirectory);
                 }
-                const inputPackageManager = (options.find((option) => option.name === 'package-manager').value || 'yarn').toLowerCase();
+                const inputPackageManager = (options.find((option) => option.name === 'package-manager')
+                    .value || 'yarn').toLowerCase();
+                // 收集仍未填写、需要在引导中提示用户处理的环境变量
+                const viteAgentId = getOptionByName(options, 'vite-agent-id') || '';
+                const taihuToken = getOptionByName(options, 'taihu-app-token') || '';
+                const databaseUrl = getOptionByName(options, 'database-url') || '';
+                const missingEnv = [];
+                if (!viteAgentId) {
+                    missingEnv.push({
+                        var: 'VITE_AGENT_ID',
+                        file: 'web/.env.local',
+                        desc: 'knot Agent ID',
+                    });
+                }
+                if (!taihuToken) {
+                    missingEnv.push({
+                        var: 'TAIHU_APP_TOKEN',
+                        file: 'server/.env',
+                        desc: '太湖应用 ID — 替换 TAIHU_APP_TOKEN= 后的 token',
+                    });
+                }
+                if (!databaseUrl) {
+                    missingEnv.push({
+                        var: 'DATABASE_URL',
+                        file: 'server/.env.local',
+                        desc: 'PostgreSQL 连接串',
+                    });
+                }
                 console.info();
                 console.info(ui_1.MESSAGES.PACKAGE_MANAGER_INSTALLATION_SUCCEED(projectDirectory));
                 console.info(ui_1.MESSAGES.GET_STARTED_INFORMATION);
                 console.info();
                 console.info(chalk.gray(ui_1.MESSAGES.CHANGE_DIR_COMMAND(projectDirectory)));
+                let step = 1;
+                // Step: Install dependencies (only if user skipped install)
                 if (shouldSkipInstall) {
-                    console.info('#Install dependence: ');
-                    if (options.find(option => option.name === 'server-framework' && option.value === 'nest')) {
-                        if (inputPackageManager === 'yarn') {
-                            if (options.find(option => option.name === 'with-web' && option.value === true)) {
-                                console.info(chalk.gray(`cd server && ${inputPackageManager}; cd ../web && ${inputPackageManager}; cd ..`));
-                            }
-                            else {
-                                console.info(chalk.gray(`cd server && ${inputPackageManager}; cd ..`));
-                            }
-                        }
-                        else {
-                            if (options.find(option => option.name === 'with-web' && option.value === true)) {
-                                console.info(chalk.gray(`cd server && ${inputPackageManager} install; cd ../web && ${inputPackageManager} install; cd ..`));
-                            }
-                            else {
-                                console.info(chalk.gray(`cd server && ${inputPackageManager} install; cd ..`));
-                            }
-                        }
+                    console.info(chalk.bold(`# ${step}. Install dependencies:`));
+                    if (inputPackageManager === 'yarn') {
+                        console.info(chalk.gray(`  cd server && ${inputPackageManager}; cd ../web && ${inputPackageManager}; cd ..`));
                     }
-                    else { // go iris
-                        if (inputPackageManager === 'yarn') {
-                            if (options.find(option => option.name === 'with-web' && option.value === true)) {
-                                console.info(chalk.gray(`cd server && go get && cd bin/prisma-parse && ${inputPackageManager}; cd ../../web && ${inputPackageManager}; cd ..`));
-                            }
-                            else {
-                                console.info(chalk.gray(`cd server && go get && cd bin/prisma-parse && ${inputPackageManager}; cd ../..`));
-                            }
-                        }
-                        else {
-                            if (options.find(option => option.name === 'with-web' && option.value === true)) {
-                                console.info(chalk.gray(`cd server && go get && cd bin/prisma-parse && ${inputPackageManager} install; cd ../../web && ${inputPackageManager} install; cd ..`));
-                            }
-                            else {
-                                console.info(chalk.gray(`cd server && go get && cd bin/prisma-parse && ${inputPackageManager} install; cd ../..`));
-                            }
-                        }
+                    else {
+                        console.info(chalk.gray(`  cd server && ${inputPackageManager} install; cd ../web && ${inputPackageManager} install; cd ..`));
                     }
                     console.info();
+                    step++;
                 }
-                if (options.find(option => option.name === 'with-web' && option.value === true)) {
-                    console.info("#Change dev's coding agent(knot Agent) id:");
-                    console.info(chalk.gray("vi web/.env.local"));
+                // Step: Configure environment variables (only items the user skipped)
+                if (missingEnv.length > 0) {
+                    console.info(chalk.bold(`# ${step}. Configure environment variables:`));
+                    for (const m of missingEnv) {
+                        console.info(`  - ${chalk.cyan(m.var)} (${m.desc})`);
+                        console.info(chalk.gray(`      vi ${m.file}`));
+                    }
                     console.info();
+                    step++;
                 }
-                console.info("#Change dev's env database config:");
-                console.info(chalk.gray("vi server/.env.local"));
+                // Step: Generate code from prisma schema
+                console.info(chalk.bold(`# ${step}. Generate code from prisma schema:`));
+                console.info(chalk.gray('  gadmin2 g prisma:dev'));
                 console.info();
-                console.info("#Generate code by config/schema.prisma:");
-                console.info(chalk.gray("gadmin2 g prisma:dev"));
-                console.info();
-                if (options.find(option => option.name === 'server-framework' && option.value === 'nest')) {
-                    console.info('#Start server devServer:');
-                    console.info(chalk.gray('cd server'));
-                    if (inputPackageManager === 'yarn') {
-                        console.info(chalk.gray(`${inputPackageManager} seed    (only run once)`));
-                        console.info(chalk.gray(`${inputPackageManager} start:dev`));
-                    }
-                    else {
-                        console.info(chalk.gray(`${inputPackageManager} run seed    (only run once)`));
-                        console.info(chalk.gray(`${inputPackageManager} run start:dev`));
-                    }
+                step++;
+                // Step: Start server (nest)
+                console.info(chalk.bold(`# ${step}. Start server (terminal 1):`));
+                console.info(chalk.gray('  cd server'));
+                if (inputPackageManager === 'yarn') {
+                    console.info(chalk.gray(`  ${inputPackageManager} seed    (only run once)`));
+                    console.info(chalk.gray(`  ${inputPackageManager} start:dev`));
                 }
                 else {
-                    console.info(chalk.gray(`swag init -g main.go && go run main.go`));
+                    console.info(chalk.gray(`  ${inputPackageManager} run seed    (only run once)`));
+                    console.info(chalk.gray(`  ${inputPackageManager} run start:dev`));
                 }
-                if (options.find(option => option.name === 'with-web' && option.value === true)) {
-                    console.info();
-                    console.info('#Start web devServer (In anthor terminal): ');
-                    console.info(chalk.gray('cd web'));
-                    if (inputPackageManager === 'yarn') {
-                        console.info(chalk.gray(`${inputPackageManager} dev`));
-                    }
-                    else {
-                        console.info(chalk.gray(`${inputPackageManager} run dev`));
-                    }
+                console.info();
+                step++;
+                // Step: Start web (always, since web is now mandatory)
+                console.info(chalk.bold(`# ${step}. Start web (terminal 2):`));
+                console.info(chalk.gray('  cd web'));
+                if (inputPackageManager === 'yarn') {
+                    console.info(chalk.gray(`  ${inputPackageManager} dev`));
+                }
+                else {
+                    console.info(chalk.gray(`  ${inputPackageManager} run dev`));
                 }
                 printCollective();
             }
@@ -161,24 +163,23 @@ const askForMissingInformation = (inputs, options) => __awaiter(void 0, void 0,
         const answers = yield prompt(questions);
         replaceInputMissingInformation(inputs, answers);
     }
-    // 默认使用 gadmin2-game-angle-demo 模板、nest + react(antd) 技术栈
-    replaceInputMissingInformation(options, { 'template': commands_1.Template.GameAngle });
-    replaceInputMissingInformation(options, { 'server-framework': 'nest' });
-    if (getOptionByName(options, 'with-web') === undefined) {
-        const answers = yield askForWithWeb();
-        answers['with-web'] = answers['with-web'] === 'yes';
-        replaceInputMissingInformation(options, answers);
-    }
+    // 默认使用 gadmin2-game-angle-demo 模板;server-framework 由 new.command.ts 固定为 'nest'
+    replaceInputMissingInformation(options, { template: commands_1.Template.GameAngle });
+    // 收集环境配置(支持空字符串跳过)
+    yield promptIfMissing(options, 'vite-agent-id', 'VITE_AGENT_ID (knot Agent ID, leave blank to skip):');
+    yield promptIfMissing(options, 'taihu-app-token', 'TAIHU_APP_TOKEN (太湖应用 ID, leave blank to skip):');
+    yield promptIfMissing(options, 'database-url', 'DATABASE_URL (postgresql://user:pwd@host:port/db?schema=public, leave blank to skip):');
 });
-const askForWithWeb = () => __awaiter(void 0, void 0, void 0, function* () {
-    const questions = [
-        (0, questions_1.generateSelect)('with-web')(ui_1.MESSAGES.WITH_WEB_QUESTION)([
-            commands_1.WithWeb.Yes,
-            commands_1.WithWeb.No,
-        ]),
-    ];
+/**
+ * 仅当 CLI 未提供该 option 时弹出 inquirer 提问。
+ * 用户直接回车则填入空字符串,后续逻辑会把空串视为"跳过"。
+ */
+const promptIfMissing = (options, name, message) => __awaiter(void 0, void 0, void 0, function* () {
+    if (getOptionByName(options, name) !== undefined)
+        return;
     const prompt = inquirer.createPromptModule();
-    return yield prompt(questions);
+    const answers = yield prompt([(0, questions_1.generateInput)(name, message)('')]);
+    replaceInputMissingInformation(options, answers);
 });
 const replaceInputMissingInformation = (inputs, answers) => {
     return inputs.map((input) => (input.value =
@@ -194,12 +195,57 @@ const generateApplicationFiles = (args, options) => __awaiter(void 0, void 0, vo
 const mapSchematicOptions = (options) => {
     return options.reduce((schematicOptions, option) => {
         if (option.name !== 'skip-install' &&
-            option.value !== 'package-manager') {
+            option.value !== 'package-manager' &&
+            option.name !== 'vite-agent-id' &&
+            option.name !== 'taihu-app-token' &&
+            option.name !== 'database-url') {
             schematicOptions.push(new schematics_1.SchematicOption(option.name, option.value));
         }
         return schematicOptions;
     }, []);
 };
+/**
+ * 在项目生成完毕后,把用户提供的环境配置写入对应文件。
+ *  - VITE_AGENT_ID  → web/.env.local       (始终创建,含注释模板)
+ *  - DATABASE_URL   → server/.env.local    (始终创建,含注释模板)
+ *  - TAIHU_APP_TOKEN→ server/.env          (仅当用户提供时才正则替换)
+ */
+const applyEnvConfig = (projectDirectory, options) => __awaiter(void 0, void 0, void 0, function* () {
+    const viteAgentId = getOptionByName(options, 'vite-agent-id') || '';
+    const taihuToken = getOptionByName(options, 'taihu-app-token') || '';
+    const databaseUrl = getOptionByName(options, 'database-url') || '';
+    const writeFile = (0, util_1.promisify)(fs.writeFile);
+    const readFile = (0, util_1.promisify)(fs.readFile);
+    // (1) web/.env.local
+    const webEnvLocal = (0, path_1.join)(process.cwd(), projectDirectory, 'web', '.env.local');
+    const webContent = [
+        '# Local overrides for web/.env (do not commit)',
+        '# knot Agent ID — see https://knot.woa.com',
+        viteAgentId ? `VITE_AGENT_ID=${viteAgentId}` : '# VITE_AGENT_ID=',
+    ].join('\n') + '\n';
+    if (fs.existsSync((0, path_1.join)(process.cwd(), projectDirectory, 'web'))) {
+        yield writeFile(webEnvLocal, webContent);
+    }
+    // (2) server/.env.local
+    const serverEnvLocal = (0, path_1.join)(process.cwd(), projectDirectory, 'server', '.env.local');
+    const serverContent = [
+        '# Local overrides for server/.env (do not commit)',
+        '# PostgreSQL: postgresql://user:password@ip:port/db_name?schema=public',
+        databaseUrl ? `DATABASE_URL=${databaseUrl}` : '# DATABASE_URL=',
+    ].join('\n') + '\n';
+    if (fs.existsSync((0, path_1.join)(process.cwd(), projectDirectory, 'server'))) {
+        yield writeFile(serverEnvLocal, serverContent);
+    }
+    // (3) server/.env — sed 替换 TAIHU_APP_TOKEN=token 那行的 token
+    if (taihuToken) {
+        const serverEnv = (0, path_1.join)(process.cwd(), projectDirectory, 'server', '.env');
+        if (fs.existsSync(serverEnv)) {
+            const original = yield readFile(serverEnv, 'utf8');
+            const replaced = original.replace(/^TAIHU_APP_TOKEN=.*$/m, `TAIHU_APP_TOKEN=${taihuToken}`);
+            yield writeFile(serverEnv, replaced);
+        }
+    }
+});
 const installPackages = (options, dryRunMode, installDirectory) => __awaiter(void 0, void 0, void 0, function* () {
     const inputPackageManager = options.find((option) => option.name === 'package-manager').value;
     let packageManager;
@@ -277,7 +323,7 @@ const printCollective = () => {
 };
 const print = (color = null) => (str = '') => {
     const terminalCols = (0, exports.retrieveCols)();
-    const strLength = str.replace(/\u001b\[[0-9]{2}m/g, '').length;
+    const strLength = str.replace(/\[[0-9]{2}m/g, '').length;
     const leftPaddingLength = Math.floor((terminalCols - strLength) / 2);
     const leftPadding = ' '.repeat(Math.max(leftPaddingLength, 0));
     if (color) {

package/actions/update.action.d.ts

@@ -3,5 +3,6 @@ import { AbstractAction } from './abstract.action';
 export declare class UpdateAction extends AbstractAction {
     handle(inputs: Input[], options: Input[]): Promise<void>;
     private handleDiff;
+    private handleStatus;
     private handleUpdate;
 }