nodebbs 0.0.2 → 0.0.4

package/dist/interactive.js

@@ -0,0 +1,171 @@
+import { Config } from '@oclif/core';
+import { select, Separator } from '@inquirer/prompts';
+import { fileURLToPath } from 'url';
+export async function runInteractive(root) {
+    // Config.load 需要文件路径而不是 URL
+    // 如果 root 是 import.meta.url，则进行转换
+    let rootPath = root.startsWith('file://') ? fileURLToPath(root) : root;
+    const config = await Config.load(rootPath);
+    // 构建命令树
+    const tree = { name: 'root', children: {} };
+    for (const cmd of config.commands) {
+        // 跳过隐藏命令
+        if (cmd.hidden)
+            continue;
+        const parts = cmd.id.split(':');
+        let currentNode = tree;
+        for (let i = 0; i < parts.length; i++) {
+            const part = parts[i];
+            if (!currentNode.children[part]) {
+                currentNode.children[part] = {
+                    name: part,
+                    children: {}
+                };
+            }
+            currentNode = currentNode.children[part];
+        }
+        // 将命令分配给叶节点
+        currentNode.command = cmd;
+    }
+    await navigate(tree, [], config);
+}
+async function navigate(node, breadcrumbs, config) {
+    const priorityOrder = ['start', 'rebuild', 'stop', 'restart', 'status', 'logs', 'shell', 'db'];
+    while (true) {
+        const keys = Object.keys(node.children).sort((a, b) => {
+            const indexA = priorityOrder.indexOf(a);
+            const indexB = priorityOrder.indexOf(b);
+            // If both are in priority list, sort by index
+            if (indexA !== -1 && indexB !== -1)
+                return indexA - indexB;
+            // If only A is in priority list, A comes first
+            if (indexA !== -1)
+                return -1;
+            // If only B is in priority list, B comes first
+            if (indexB !== -1)
+                return 1;
+            // Otherwise sort alphabetically
+            return a.localeCompare(b);
+        });
+        const choices = keys.map(key => {
+            const child = node.children[key];
+            const hasSubcommands = Object.keys(child.children).length > 0;
+            let label = key;
+            let description = '';
+            // 尝试获取命令描述
+            if (key === 'help') {
+                description = '显示帮助信息';
+            }
+            else if (child.command?.description) {
+                description = child.command.description;
+            }
+            // 或者获取主题描述
+            else if (hasSubcommands) {
+                const fullId = [...breadcrumbs, key].join(':');
+                const topic = config.topics.find(t => t.name === fullId);
+                if (topic) {
+                    description = topic.description || '';
+                }
+            }
+            if (description) {
+                const shortDesc = description.split('.')[0].substring(0, 50);
+                label = `${key.padEnd(12)}  ${shortDesc}`;
+            }
+            else {
+                label = key.padEnd(12);
+            }
+            if (hasSubcommands) {
+                label = `${label}  [+]`;
+            }
+            return {
+                name: label,
+                value: key,
+                short: key
+            };
+        });
+        // 添加导航选项
+        // 即使支持 Esc，保留显式选项也有助于发现性
+        if (breadcrumbs.length > 0) {
+            choices.push(new Separator());
+            choices.push({ name: '⬅️  返回', value: '__BACK__', short: '返回' });
+        }
+        choices.push({ name: '❌ 退出', value: '__EXIT__', short: '退出' });
+        const controller = new AbortController();
+        // 监听 Esc 键
+        const onKeypress = (_str, key) => {
+            if (key && key.name === 'escape') {
+                controller.abort();
+            }
+        };
+        // 确保 keypress 事件被触发（inquirer 内部也会这样做，但为了安全起见）
+        // 注意：process.stdin 可能已经是 raw mode，inquirer 会处理它
+        // 我们只需要监听
+        process.stdin.on('keypress', onKeypress);
+        try {
+            const selection = await select({
+                message: breadcrumbs.length ? `选择命令 (${breadcrumbs.join(' > ')}):` : '选择命令:',
+                choices,
+                pageSize: 15,
+                loop: true, // 允许循环导航
+                // @ts-ignore: prompt signal support might be strict on types
+                signal: controller.signal
+            });
+            if (selection === '__EXIT__') {
+                process.exit(0);
+            }
+            if (selection === '__BACK__') {
+                return;
+            }
+            const selectedNode = node.children[selection];
+            if (Object.keys(selectedNode.children).length > 0) {
+                // 有子命令，进入子菜单
+                await navigate(selectedNode, [...breadcrumbs, selection], config);
+            }
+            else if (selectedNode.command) {
+                // 可运行的命令
+                console.log(`正在运行: ${selectedNode.command.id}`);
+                try {
+                    await config.runCommand(selectedNode.command.id);
+                }
+                catch (error) {
+                    // Ctrl+C: 退出程序
+                    if (error.name === 'ExitPromptError') {
+                        console.log('\n用户退出。');
+                        process.exit(0);
+                    }
+                    // 手动取消: 返回菜单
+                    if (error.name === 'CancelError') {
+                        console.log('\n操作已取消。');
+                        continue;
+                    }
+                    console.error(error);
+                }
+                console.log('\n命令执行完成。');
+                // 动态导入 input 以保持轻量
+                const { input } = await import('@inquirer/prompts');
+                await input({ message: '按回车键继续...' });
+            }
+        }
+        catch (error) {
+            // 处理 AbortError (Esc)
+            if (error.name === 'AbortError' || error.message?.includes('aborted')) {
+                if (breadcrumbs.length > 0) {
+                    // 子菜单 -> 返回
+                    return;
+                }
+                else {
+                    // 顶级菜单 -> 退出
+                    process.exit(0);
+                }
+            }
+            // 处理 Ctrl+C (ExitPromptError)
+            if (error.name === 'ExitPromptError') {
+                process.exit(0);
+            }
+            throw error;
+        }
+        finally {
+            process.stdin.off('keypress', onKeypress);
+        }
+    }
+}

package/dist/templates/env

@@ -0,0 +1,61 @@
+# ========================================
+# NodeBBS Docker Compose 环境变量配置
+# ========================================
+
+# 应用名称
+APP_NAME=nodebbs
+
+# ========================================
+# 数据库配置
+# ========================================
+POSTGRES_PASSWORD=your_secure_postgres_password_here
+POSTGRES_DB=nodebbs
+POSTGRES_PORT=5432
+
+# ========================================
+# Redis 配置
+# ========================================
+REDIS_PASSWORD=your_secure_redis_password_here
+REDIS_PORT=6379
+
+# ========================================
+# API 服务配置
+# ========================================
+API_PORT=7100
+
+# 用户缓存 TTL（秒）
+# 开发环境: 30-60, 生产环境: 120-300
+USER_CACHE_TTL=120
+
+# JWT 配置
+# 使用 `openssl rand -base64 32` 生成安全的密钥
+JWT_SECRET=change-this-to-a-secure-random-string-in-production
+JWT_ACCESS_TOKEN_EXPIRES_IN=1y
+
+# CORS 配置
+# 生产环境建议设置为具体的域名，例如: https://yourdomain.com
+CORS_ORIGIN=*
+
+# 应用 URL（OAuth 回调使用）
+APP_URL=http://localhost:3100
+
+# ========================================
+# Web 前端配置
+# ========================================
+WEB_PORT=3100
+
+# API 地址（公网访问地址）
+# 使用 docker 部署必须指定 IP 或域名（避免SSR跨容器通信问题）
+# 开发环境: http://192.168.0.100:7100
+# 生产环境: https://api.yourdomain.com
+NEXT_PUBLIC_API_URL=http://192.168.0.100:7100
+
+# 应用 URL（公网访问地址）
+# 开发环境: http://localhost:3100
+# 生产环境: https://yourdomain.com
+NEXT_PUBLIC_APP_URL=http://localhost:3100
+
+# ========================================
+# 时区配置
+# ========================================
+TZ=Asia/Shanghai

package/dist/utils/docker.js

@@ -3,27 +3,19 @@ import { logger } from './logger.js';
 import path from 'node:path';
 import { exists } from 'node:fs';
 import { promisify } from 'node:util';
-import { fileURLToPath } from 'node:url';
+import { getTemplateDir, getTemplatePath } from './template.js';
 const fileExists = promisify(exists);
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
 export async function getComposeFiles(env) {
     const workDir = process.cwd();
     let isBuiltIn = false;
-    // Check current directory for docker-compose.yml
+    // 检查当前目录是否存在 docker-compose.yml
     let baseFile = path.join(workDir, 'docker-compose.yml');
     let templateDir = workDir;
     if (!await fileExists(baseFile)) {
-        // Use built-in templates
+        // 使用内置模板
         isBuiltIn = true;
-        // In production (dist/utils/docker.js), templates are in dist/templates
-        // __dirname is dist/utils, so ../templates points to dist/templates
-        templateDir = path.join(__dirname, '..', 'templates');
-        baseFile = path.join(templateDir, 'docker-compose.yml');
-        // Verify the built-in template exists
-        if (!await fileExists(baseFile)) {
-            logger.error('内置模板未找到，请确保 CLI 正确安装。');
-            throw new Error('Built-in templates not found');
-        }
+        templateDir = getTemplateDir();
+        baseFile = getTemplatePath('docker-compose.yml');
     }
     const files = [baseFile];
     if (env === 'production') {
@@ -50,12 +42,12 @@ export async function runCompose(files, args, isBuiltIn = false) {
     const composeArgs = files.flatMap(f => ['-f', f]);
     if (isBuiltIn) {
         composeArgs.push('--project-directory', process.cwd());
-        // Set INIT_DB_PATH to the built-in sql file
+        // 将 INIT_DB_PATH 设置为内置 sql 文件
         const templateDir = path.dirname(files[0]);
         process.env.INIT_DB_PATH = path.join(templateDir, 'init-db.sql');
     }
     composeArgs.push(...args);
-    // Use stdio: 'inherit' to show output in real-time
+    // 使用 stdio: 'inherit' 实时显示输出
     await execa('docker', ['compose', ...composeArgs], { stdio: 'inherit' });
 }
 export async function execCompose(files, service, command, isBuiltIn = false) {
@@ -68,7 +60,7 @@ export async function execCompose(files, service, command, isBuiltIn = false) {
 }
 export async function waitForHealth(files, isBuiltIn = false) {
     logger.info('正在等待服务就绪...');
-    // Wait for Postgres
+    // 等待 Postgres
     logger.info('等待 PostgreSQL...');
     const composeArgs = files.flatMap(f => ['-f', f]);
     if (isBuiltIn) {
@@ -90,11 +82,11 @@ export async function waitForHealth(files, isBuiltIn = false) {
     if (retries === 0) {
         logger.warning('PostgreSQL 可能尚未就绪');
     }
-    // Wait for Redis
+    // 等待 Redis
     logger.info('等待 Redis...');
     await new Promise(resolve => setTimeout(resolve, 5000));
     logger.success('Redis 已就绪');
-    // Wait for API
+    // 等待 API
     logger.info('等待 API 服务...');
     await new Promise(resolve => setTimeout(resolve, 10000));
     logger.success('API 服务已就绪');

package/dist/utils/env.js

@@ -4,6 +4,7 @@ import { promisify } from 'node:util';
 import { logger } from './logger.js';
 import { confirm } from '@inquirer/prompts';
 import dotenv from 'dotenv';
+import { getTemplatePath } from './template.js';
 const fileExists = promisify(exists);
 export async function initEnv() {
     if (await fileExists('.env')) {
@@ -11,8 +12,24 @@ export async function initEnv() {
         return;
     }
     logger.info('正在创建 .env 文件...');
+    let sourceFile = '';
+    let isBuiltIn = false;
     if (await fileExists('.env.docker.example')) {
-        await fs.copyFile('.env.docker.example', '.env');
+        sourceFile = '.env.docker.example';
+    }
+    else {
+        // 使用内置模板
+        sourceFile = getTemplatePath('env');
+        isBuiltIn = true;
+    }
+    if (sourceFile) {
+        await fs.copyFile(sourceFile, '.env');
+        if (isBuiltIn) {
+            logger.success('已使用内置模板创建 .env');
+        }
+        else {
+            logger.success(`已从 ${sourceFile} 复制 .env`);
+        }
         logger.warning('请编辑 .env 文件并修改以下配置：');
         logger.warning('  - POSTGRES_PASSWORD (数据库密码)');
         logger.warning('  - REDIS_PASSWORD (Redis 密码)');
@@ -27,19 +44,12 @@ export async function initEnv() {
         }
     }
     else {
-        // If .env.docker.example doesn't exist, maybe we are in the wrong directory or need to look in project/
-        if (await fileExists('project/.env.docker.example')) {
-            await fs.copyFile('project/.env.docker.example', '.env');
-            logger.success('已从 project/.env.docker.example 复制 .env');
-        }
-        else {
-            logger.warning('未找到 .env.docker.example！跳过 .env 创建。');
-        }
+        logger.warning('未找到 .env.docker.example 或内置模板！跳过 .env 创建。');
     }
 }
 export async function checkEnv(envType) {
     logger.info('正在检查环境配置...');
-    // Load .env
+    // 加载 .env
     const envConfig = dotenv.config().parsed || {};
     let warnings = 0;
     let errors = 0;

package/dist/utils/selection.d.ts

@@ -0,0 +1,7 @@
+export type EnvType = 'production' | 'lowmem' | 'basic';
+export declare const EnvFlag: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+export declare function setStoredEnv(env: EnvType): Promise<void>;
+export declare function clearStoredEnv(): Promise<void>;
+export declare function selectEnvironment(env?: string, options?: {
+    prompt?: string;
+}): Promise<EnvType>;

package/dist/utils/selection.js

@@ -0,0 +1,68 @@
+import { Flags } from '@oclif/core';
+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';
+export const EnvFlag = Flags.string({
+    char: 'e',
+    description: '部署环境 (production, lowmem, basic)',
+    options: ['production', 'lowmem', 'basic'],
+});
+async function getStoredEnv() {
+    try {
+        const content = await fs.readFile(path.resolve(process.cwd(), ENV_MARKER_FILE), 'utf-8');
+        const env = content.trim();
+        if (['production', 'lowmem', 'basic'].includes(env)) {
+            return env;
+        }
+    }
+    catch { }
+    return null;
+}
+export async function setStoredEnv(env) {
+    try {
+        await fs.writeFile(path.resolve(process.cwd(), ENV_MARKER_FILE), env, 'utf-8');
+    }
+    catch (error) {
+        logger.warning(`无法保存环境标记: ${error}`);
+    }
+}
+export async function clearStoredEnv() {
+    try {
+        const filepath = path.resolve(process.cwd(), ENV_MARKER_FILE);
+        await fs.rm(filepath, { force: true });
+    }
+    catch (error) {
+        logger.warning(`无法清除环境标记: ${error}`);
+    }
+}
+export async function selectEnvironment(env, options = {}) {
+    if (env) {
+        // oclif 选项验证会处理有效值，但仍需类型转换
+        return env;
+    }
+    // 检查已存储的环境配置
+    const storedEnv = await getStoredEnv();
+    if (storedEnv) {
+        logger.info(`检测到运行环境: ${storedEnv}`);
+        return storedEnv;
+    }
+    const selected = await select({
+        message: options.prompt || '请选择运行环境：',
+        choices: [
+            { name: '标准生产环境 (2C4G+) [推荐]', value: 'production' },
+            { name: '低配环境 (1C1G/1C2G)', value: 'lowmem' },
+            { name: '基础环境 (仅用于测试)', value: 'basic' },
+            { name: '❌ 取消', value: '__CANCEL__' },
+        ],
+        loop: true,
+    });
+    if (selected === '__CANCEL__') {
+        const error = new Error('用户取消操作');
+        error.name = 'CancelError';
+        throw error;
+    }
+    logger.info(`已选择环境: ${selected}`);
+    return selected;
+}

package/dist/utils/template.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 获取模板目录的绝对路径。
+ * 在生产环境 (dist/utils) 中，模板位于 dist/templates。
+ * 在开发环境 (src/utils) 中，模板位于 src/templates。
+ */
+export declare function getTemplateDir(): string;
+/**
+ * 获取特定模板文件的绝对路径。
+ * @param fileName 模板文件名称 (例如 'env', 'docker-compose.yml')
+ */
+export declare function getTemplatePath(fileName: string): string;

package/dist/utils/template.js

@@ -0,0 +1,18 @@
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+/**
+ * 获取模板目录的绝对路径。
+ * 在生产环境 (dist/utils) 中，模板位于 dist/templates。
+ * 在开发环境 (src/utils) 中，模板位于 src/templates。
+ */
+export function getTemplateDir() {
+    return path.join(__dirname, '..', 'templates');
+}
+/**
+ * 获取特定模板文件的绝对路径。
+ * @param fileName 模板文件名称 (例如 'env', 'docker-compose.yml')
+ */
+export function getTemplatePath(fileName) {
+    return path.join(getTemplateDir(), fileName);
+}