nodebbs 0.0.8 → 0.0.9

package/dist/commands/clean/index.d.ts

@@ -5,6 +5,7 @@ export default class Clean extends Command {
         all: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         cache: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         images: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        env: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
     run(): Promise<void>;

package/dist/commands/clean/index.js

@@ -2,12 +2,13 @@ import { Command, Flags } from '@oclif/core';
 import { checkbox, confirm } from '@inquirer/prompts';
 import { logger } from '../../utils/logger.js';
 import { execa } from 'execa';
+import { clearStoredEnv } from '../../utils/selection.js';
 export default class Clean extends Command {
     static description = '清理 Docker 缓存和残留资源';
     static flags = {
         all: Flags.boolean({
             char: 'a',
-            description: '清理所有 (构建缓存、无用镜像、网络)',
+            description: '清理所有 (构建缓存、无用镜像、网络、环境锁定)',
             default: false,
         }),
         cache: Flags.boolean({
@@ -18,6 +19,10 @@ export default class Clean extends Command {
             description: '清理无用镜像 (dangling)',
             default: false,
         }),
+        env: Flags.boolean({
+            description: '清理环境锁定 (Environment Lock)',
+            default: false,
+        }),
         force: Flags.boolean({
             char: 'f',
             description: '跳过确认提示',
@@ -29,13 +34,15 @@ export default class Clean extends Command {
         let targets = [];
         // 根据标志确定清理目标
         if (flags.all) {
-            targets = ['cache', 'images', 'networks'];
+            targets = ['cache', 'images', 'networks', 'env'];
         }
         else {
             if (flags.cache)
                 targets.push('cache');
             if (flags.images)
                 targets.push('images');
+            if (flags.env)
+                targets.push('env');
         }
         // 如果未提供标志，进行交互式选择
         if (targets.length === 0) {
@@ -45,6 +52,7 @@ export default class Clean extends Command {
                     { name: '构建缓存 (Build Cache)', value: 'cache' },
                     { name: '无用镜像 (Dangling Images)', value: 'images' },
                     { name: '无用网络 (Unused Networks)', value: 'networks' },
+                    { name: '环境锁定 (Environment Lock)', value: 'env' },
                 ],
             });
         }
@@ -81,6 +89,11 @@ export default class Clean extends Command {
                 await execa('docker', ['network', 'prune', '-f'], { stdio: 'inherit' });
                 logger.success('无用网络已清理');
             }
+            if (targets.includes('env')) {
+                logger.info('正在清除环境锁定...');
+                await clearStoredEnv();
+                logger.success('环境锁定已移除');
+            }
         }
         catch (error) {
             logger.error('清理过程中发生错误');

package/dist/commands/pack/index.js

@@ -4,6 +4,7 @@ import * as fs from 'fs';
 import * as path from 'path';
 import * as os from 'os';
 import { getTemplatePath } from '../../utils/template.js';
+import { checkDocker } from '../../utils/docker.js';
 export default class Pack extends Command {
     static description = '生成离线部署包';
     static flags = {
@@ -13,12 +14,7 @@ export default class Pack extends Command {
         const { flags } = await this.parse(Pack);
         const outputPath = path.resolve(flags.output);
         // 检查 docker 是否可用
-        try {
-            await execa('docker', ['--version']);
-        }
-        catch {
-            this.error('无法执行 docker 命令，请确保 Docker 已安装并运行。');
-        }
+        await checkDocker();
         // 1. 准备临时目录
         const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'nodebbs-pack-'));
         this.log(`正在准备构建环境: ${tmpDir}`);
@@ -30,7 +26,6 @@ export default class Pack extends Command {
             // 但既然是打包，通常是想把当前开发好的代码打包。
             // 所以我们假设在项目根目录运行。
             if (!fs.existsSync('docker-compose.yml')) {
-                this.warn('当前目录未找到 docker-compose.yml，将使用内置模板。');
                 // TODO: 从 templates 复制 (简化起见，我们假设用户在项目根目录，或者我们强制要求)
                 // 如果没找到，我们实际上无法 build api/web，因为 build context 需要源码。
                 // 所以必须要求在项目根目录运行。

package/dist/commands/restart/index.js

@@ -1,7 +1,7 @@
 import { Command } from '@oclif/core';
 import { runCompose, getComposeFiles } from '../../utils/docker.js';
 import { logger } from '../../utils/logger.js';
-import { EnvFlag, selectEnvironment, setStoredEnv } from '../../utils/selection.js';
+import { EnvFlag, selectEnvironment } from '../../utils/selection.js';
 export default class Restart extends Command {
     static description = '重启所有服务 (up --force-recreate)';
     static flags = {
@@ -11,7 +11,6 @@ export default class Restart extends Command {
         const { flags } = await this.parse(Restart);
         // 1. 选择环境
         const env = await selectEnvironment(flags.env);
-        await setStoredEnv(env);
         const { files, isBuiltIn } = await getComposeFiles(env);
         logger.info('正在重启服务 (使用现有镜像)...');
         logger.info('环境: ' + env);

package/dist/commands/start/index.js

@@ -4,7 +4,7 @@ import { checkDocker, runCompose, waitForHealth, execCompose, getComposeFiles }
 import { initEnv, checkEnv } from '../../utils/env.js';
 import { logger } from '../../utils/logger.js';
 import dotenv from 'dotenv';
-import { EnvFlag, selectEnvironment, setStoredEnv } from '../../utils/selection.js';
+import { EnvFlag, selectEnvironment } from '../../utils/selection.js';
 export default class Start extends Command {
     static description = '开始部署';
     static flags = {
@@ -25,7 +25,6 @@ export default class Start extends Command {
         }
         // 1. 选择环境
         const env = await selectEnvironment(flags.env);
-        await setStoredEnv(env);
         // 2. 获取 Compose 文件
         const { files: composeFiles, isBuiltIn } = await getComposeFiles(env);
         if (isBuiltIn) {

package/dist/commands/stop/index.js

@@ -2,7 +2,7 @@ import { Command, Flags } from '@oclif/core';
 import { runCompose, getComposeFiles } from '../../utils/docker.js';
 import { logger } from '../../utils/logger.js';
 import { confirm } from '@inquirer/prompts';
-import { EnvFlag, selectEnvironment, clearStoredEnv } from '../../utils/selection.js';
+import { EnvFlag, selectEnvironment } from '../../utils/selection.js';
 export default class Stop extends Command {
     static description = '停止服务';
     static flags = {
@@ -32,13 +32,11 @@ export default class Stop extends Command {
             }
             logger.info('正在停止服务并删除数据卷...');
             await runCompose(files, ['down', '-v'], isBuiltIn);
-            await clearStoredEnv();
             logger.success('服务已停止，数据卷已删除');
         }
         else {
             logger.info('正在停止服务...');
             await runCompose(files, ['down'], isBuiltIn);
-            await clearStoredEnv();
             logger.success('服务已停止');
         }
     }

package/dist/interactive.js

@@ -147,7 +147,7 @@ async function navigate(node, breadcrumbs, config) {
                         console.log('\n操作已取消。');
                         continue;
                     }
-                    console.error(error);
+                    console.error(error.message);
                 }
                 console.log('\n命令执行完成。');
                 // 动态导入 input 以保持轻量
@@ -178,7 +178,7 @@ async function navigate(node, breadcrumbs, config) {
                         console.log('\n操作已取消。');
                         continue;
                     }
-                    console.error(error);
+                    console.error(error.message);
                 }
                 console.log('\n命令执行完成。');
                 // 动态导入 input 以保持轻量

package/dist/utils/docker.d.ts

@@ -1,8 +1,55 @@
+/**
+ * 获取 Docker Compose 文件路径配置
+ *
+ * 自动检测当前目录是否存在 `docker-compose.yml`。
+ * - 如果存在，则优先使用项目根目录的配置。
+ * - 如果不存在，则使用 CLI 内置的模板文件。
+ *
+ * @param env - 运行环境 ('production' | 'lowmem' | 'basic')
+ * @returns 对象包含文件路径数组和是否使用内置模板的标志
+ */
 export declare function getComposeFiles(env: string): Promise<{
     files: string[];
     isBuiltIn: boolean;
 }>;
+/**
+ * 检查 Docker 环境是否可用
+ *
+ * 验证 `docker` 和 `docker compose` 命令是否已安装并能正常响应。
+ * 如果检查失败，会抛出错误并提示用户安装。
+ */
 export declare function checkDocker(): Promise<void>;
+/**
+ * 执行 Docker Compose 管理命令 (Lifecycle Commands)
+ *
+ * 用于执行如 `up`, `down`, `logs`, `build` 等管理整个服务堆栈的命令。
+ * 如果使用的是内置模板，会自动注入必要的环境变量（如数据库初始化脚本路径）。
+ *
+ * @param files - Docker Compose 文件路径数组
+ * @param args - 传递给 docker compose 的参数列表 (e.g. `['up', '-d']`)
+ * @param isBuiltIn - 是否使用内置模板 (决定是否注入额外环境变量)
+ */
 export declare function runCompose(files: string[], args: string[], isBuiltIn?: boolean): Promise<void>;
+/**
+ * 在容器内执行命令 (Exec)
+ *
+ * 相当于执行 `docker compose exec [service] [command]`。
+ * 用于在正在运行的容器中运行脚本或命令（例如数据库迁移、种子数据填充）。
+ *
+ * @param files - Docker Compose 文件路径数组
+ * @param service - 目标服务名称 (e.g. 'api', 'postgres')
+ * @param command - 要执行的命令数组 (e.g. `['npm', 'run', 'seed']`)
+ * @param isBuiltIn - 是否使用内置模板
+ */
 export declare function execCompose(files: string[], service: string, command: string[], isBuiltIn?: boolean): Promise<void>;
+/**
+ * 等待服务健康检查通过
+ *
+ * 轮询关键服务 (PostgreSQL, Redis, API) 直到它们准备就绪或超时。
+ * - PostgreSQL: 使用 `pg_isready` 检查
+ * - Redis & API: 使用简单的延时等待 (后续可优化为端口/API探测)
+ *
+ * @param files - Docker Compose 文件路径数组
+ * @param isBuiltIn - 是否使用内置模板
+ */
 export declare function waitForHealth(files: string[], isBuiltIn?: boolean): Promise<void>;

package/dist/utils/docker.js

@@ -5,6 +5,16 @@ import { exists } from 'node:fs';
 import { promisify } from 'node:util';
 import { getTemplateDir, getTemplatePath } from './template.js';
 const fileExists = promisify(exists);
+/**
+ * 获取 Docker Compose 文件路径配置
+ *
+ * 自动检测当前目录是否存在 `docker-compose.yml`。
+ * - 如果存在，则优先使用项目根目录的配置。
+ * - 如果不存在，则使用 CLI 内置的模板文件。
+ *
+ * @param env - 运行环境 ('production' | 'lowmem' | 'basic')
+ * @returns 对象包含文件路径数组和是否使用内置模板的标志
+ */
 export async function getComposeFiles(env) {
     const workDir = process.cwd();
     let isBuiltIn = false;
@@ -26,6 +36,12 @@ export async function getComposeFiles(env) {
     }
     return { files, isBuiltIn };
 }
+/**
+ * 检查 Docker 环境是否可用
+ *
+ * 验证 `docker` 和 `docker compose` 命令是否已安装并能正常响应。
+ * 如果检查失败，会抛出错误并提示用户安装。
+ */
 export async function checkDocker() {
     logger.info('正在检查 Docker 环境...');
     try {
@@ -38,6 +54,16 @@ export async function checkDocker() {
         throw error;
     }
 }
+/**
+ * 执行 Docker Compose 管理命令 (Lifecycle Commands)
+ *
+ * 用于执行如 `up`, `down`, `logs`, `build` 等管理整个服务堆栈的命令。
+ * 如果使用的是内置模板，会自动注入必要的环境变量（如数据库初始化脚本路径）。
+ *
+ * @param files - Docker Compose 文件路径数组
+ * @param args - 传递给 docker compose 的参数列表 (e.g. `['up', '-d']`)
+ * @param isBuiltIn - 是否使用内置模板 (决定是否注入额外环境变量)
+ */
 export async function runCompose(files, args, isBuiltIn = false) {
     const composeArgs = files.flatMap(f => ['-f', f]);
     if (isBuiltIn) {
@@ -48,16 +74,44 @@ export async function runCompose(files, args, isBuiltIn = false) {
     }
     composeArgs.push(...args);
     // 使用 stdio: 'inherit' 实时显示输出
-    await execa('docker', ['compose', ...composeArgs], { stdio: 'inherit' });
+    // 设置 COMPOSE_LOG_LEVEL=ERROR 抑制变量未设置的警告
+    await execa('docker', ['compose', ...composeArgs], {
+        stdio: 'inherit',
+        env: { ...process.env, COMPOSE_LOG_LEVEL: 'ERROR' }
+    });
 }
+/**
+ * 在容器内执行命令 (Exec)
+ *
+ * 相当于执行 `docker compose exec [service] [command]`。
+ * 用于在正在运行的容器中运行脚本或命令（例如数据库迁移、种子数据填充）。
+ *
+ * @param files - Docker Compose 文件路径数组
+ * @param service - 目标服务名称 (e.g. 'api', 'postgres')
+ * @param command - 要执行的命令数组 (e.g. `['npm', 'run', 'seed']`)
+ * @param isBuiltIn - 是否使用内置模板
+ */
 export async function execCompose(files, service, command, isBuiltIn = false) {
     const composeArgs = files.flatMap(f => ['-f', f]);
     if (isBuiltIn) {
         composeArgs.push('--project-directory', process.cwd());
     }
     composeArgs.push('exec', service, ...command);
-    await execa('docker', ['compose', ...composeArgs], { stdio: 'inherit' });
+    await execa('docker', ['compose', ...composeArgs], {
+        stdio: 'inherit',
+        env: { ...process.env, COMPOSE_LOG_LEVEL: 'ERROR' }
+    });
 }
+/**
+ * 等待服务健康检查通过
+ *
+ * 轮询关键服务 (PostgreSQL, Redis, API) 直到它们准备就绪或超时。
+ * - PostgreSQL: 使用 `pg_isready` 检查
+ * - Redis & API: 使用简单的延时等待 (后续可优化为端口/API探测)
+ *
+ * @param files - Docker Compose 文件路径数组
+ * @param isBuiltIn - 是否使用内置模板
+ */
 export async function waitForHealth(files, isBuiltIn = false) {
     logger.info('正在等待服务就绪...');
     // 等待 Postgres

package/dist/utils/env.js

@@ -12,39 +12,121 @@ export async function initEnv() {
         return;
     }
     logger.info('正在创建 .env 文件...');
+    // 检查模板文件
+    let templateContent = '';
     let sourceFile = '';
-    let isBuiltIn = false;
     if (await fileExists('.env.docker.example')) {
         sourceFile = '.env.docker.example';
+        templateContent = await fs.readFile(sourceFile, 'utf-8');
     }
     else {
         // 使用内置模板
         sourceFile = getTemplatePath('env');
-        isBuiltIn = true;
+        templateContent = await fs.readFile(sourceFile, 'utf-8');
     }
-    if (sourceFile) {
-        await fs.copyFile(sourceFile, '.env');
-        if (isBuiltIn) {
-            logger.success('已使用内置模板创建 .env');
+    const { input, password } = await import('@inquirer/prompts');
+    const crypto = await import('node:crypto');
+    function generateSecret(length = 32) {
+        return crypto.randomBytes(length).toString('base64').replace(/[^a-zA-Z0-9]/g, '').substring(0, length);
+    }
+    console.log('\n请配置环境变量（按 Enter 使用默认值或自动生成）：\n');
+    // 1. 收集用户输入
+    const postgresPassword = await password({
+        message: '设置 POSTGRES_PASSWORD (数据库密码) [空值自动生成]:',
+        mask: '*',
+        validate: (value) => true, // 允许为空以自动生成
+    }) || generateSecret();
+    const redisPassword = await password({
+        message: '设置 REDIS_PASSWORD (Redis 密码) [空值自动生成]:',
+        mask: '*',
+        validate: (value) => true,
+    }) || generateSecret();
+    const jwtSecret = await password({
+        message: '设置 JWT_SECRET (JWT 密钥) [空值自动生成]:',
+        mask: '*',
+        validate: (value) => true,
+    }) || generateSecret(64);
+    const webPort = await input({
+        message: '设置 WEB_PORT (前端端口):',
+        default: '3100'
+    });
+    const apiPort = await input({
+        message: '设置 API_PORT (后端端口):',
+        default: '7100'
+    });
+    const defaultApiUrl = `http://localhost:${apiPort}`;
+    const nextPublicApiUrl = await input({
+        message: '设置 NEXT_PUBLIC_API_URL (前端访问后端的地址):',
+        default: defaultApiUrl
+    });
+    const defaultAppUrl = `http://localhost:${webPort}`;
+    const nextPublicAppUrl = await input({
+        message: '设置 NEXT_PUBLIC_APP_URL (应用访问地址):',
+        default: defaultAppUrl
+    });
+    const corsOrigin = await input({
+        message: '设置 CORS_ORIGIN (允许跨域的域名):',
+        default: '*'
+    });
+    // 2. 显示配置预览
+    console.log('\n================ 配置预览 ================');
+    console.log(`POSTGRES_PASSWORD: ${postgresPassword.substring(0, 3)}******`);
+    console.log(`REDIS_PASSWORD:    ${redisPassword.substring(0, 3)}******`);
+    console.log(`JWT_SECRET:        ${jwtSecret.substring(0, 3)}******`);
+    console.log(`WEB_PORT:          ${webPort}`);
+    console.log(`API_PORT:          ${apiPort}`);
+    console.log(`NEXT_PUBLIC_API_URL: ${nextPublicApiUrl}`);
+    console.log(`NEXT_PUBLIC_APP_URL: ${nextPublicAppUrl}`);
+    console.log(`CORS_ORIGIN:       ${corsOrigin}`);
+    console.log('==========================================\n');
+    // 3. 确认生成
+    const confirmed = await confirm({
+        message: '确认生成 .env 文件？',
+        default: true
+    });
+    if (!confirmed) {
+        logger.info('已取消生成 .env 文件。');
+        process.exit(0);
+    }
+    // 4. 替换模板内容
+    // 为了保留注释，我们使用简单的字符串替换，而不是 dotenv 解析
+    // 注意：这里假设模板中的 key 遵循 standard env format (KEY=value)
+    let newEnv = templateContent;
+    const replacements = {
+        'POSTGRES_PASSWORD': postgresPassword,
+        'REDIS_PASSWORD': redisPassword,
+        'JWT_SECRET': jwtSecret,
+        'WEB_PORT': webPort,
+        'API_PORT': apiPort,
+        'NEXT_PUBLIC_API_URL': nextPublicApiUrl,
+        'NEXT_PUBLIC_APP_URL': nextPublicAppUrl,
+        'CORS_ORIGIN': corsOrigin,
+        // 如果 API_PORT 变了，模板里可能还需要联动修改 APP_URL 用于 OAuth 回调，这里简单处理
+        'APP_URL': nextPublicAppUrl
+    };
+    // 针对每个 Key 进行替换。
+    // 策略：查找 `KEY=...` 并替换为 `KEY=newValue`
+    for (const [key, value] of Object.entries(replacements)) {
+        // 匹配 KEY=任意非换行字符
+        const regex = new RegExp(`^${key}=.*`, 'gm');
+        if (regex.test(newEnv)) {
+            newEnv = newEnv.replace(regex, `${key}=${value}`);
         }
         else {
-            logger.success(`已从 ${sourceFile} 复制 .env`);
-        }
-        logger.warning('请编辑 .env 文件并修改以下配置：');
-        logger.warning('  - POSTGRES_PASSWORD (数据库密码)');
-        logger.warning('  - REDIS_PASSWORD (Redis 密码)');
-        logger.warning('  - JWT_SECRET (JWT 密钥)');
-        const edit = await confirm({
-            message: '是否现在编辑 .env 文件？',
-            default: false
-        });
-        if (edit) {
-            logger.info('请手动编辑 .env 文件后再次运行命令。');
-            process.exit(0);
+            // 如果模板里没这个 key，追加到末尾（虽然理论上模板应该有）
+            newEnv += `\n${key}=${value}`;
         }
     }
+    // 5. 写入文件
+    await fs.writeFile('.env', newEnv, 'utf-8');
+    // isBuiltIn is not defined in the new logic, need to determine it
+    // based on whether sourceFile was .env.docker.example or a template path
+    const isBuiltIn = sourceFile === getTemplatePath('env');
+    if (isBuiltIn) {
+        logger.success('已使用内置模板并填充配置生成 .env');
+    }
     else {
-        logger.warning('未找到 .env.docker.example 或内置模板！跳过 .env 创建。');
+        logger.success(`已从 ${sourceFile} 复制并填充配置生成 .env`);
     }
 }
 export async function checkEnv(envType) {

package/dist/utils/selection.js

@@ -3,7 +3,7 @@ import { select } from '@inquirer/prompts';
 import { logger } from './logger.js';
 import fs from 'node:fs/promises';
 import path from 'node:path';
-const ENV_MARKER_FILE = '.nodebbs-env';
+const ENV_MARKER_FILE = '.env.lock';
 export const EnvFlag = Flags.string({
     char: 'e',
     description: '部署环境 (production, lowmem, basic)',
@@ -64,5 +64,6 @@ export async function selectEnvironment(env, options = {}) {
         throw error;
     }
     logger.info(`已选择环境: ${selected}`);
+    await setStoredEnv(selected);
     return selected;
 }

package/oclif.manifest.json

@@ -7,7 +7,7 @@
       "flags": {
         "all": {
           "char": "a",
-          "description": "清理所有 (构建缓存、无用镜像、网络)",
+          "description": "清理所有 (构建缓存、无用镜像、网络、环境锁定)",
           "name": "all",
           "allowNo": false,
           "type": "boolean"
@@ -24,6 +24,12 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "env": {
+          "description": "清理环境锁定 (Environment Lock)",
+          "name": "env",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "force": {
           "char": "f",
           "description": "跳过确认提示",
@@ -718,5 +724,5 @@
       ]
     }
   },
-  "version": "0.0.8"
+  "version": "0.0.9"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "nodebbs",
   "description": "NodeBBS 论坛系统专业运维工具",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "author": "wengqianshan",
   "bin": {
     "nodebbs": "./bin/run.js"