@nocobase/cli 2.1.0-alpha.25 → 2.1.0-alpha.27

package/dist/commands/config/get.js

@@ -0,0 +1,29 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Args, Command } from '@oclif/core';
+import { assertSupportedCliConfigKey, getCliConfigValue } from '../../lib/cli-config.js';
+export default class ConfigGet extends Command {
+    static summary = 'Get the effective CLI configuration value for a key';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> license.pkg-url',
+        '<%= config.bin %> <%= command.id %> docker.network',
+        '<%= config.bin %> <%= command.id %> docker.container-prefix',
+    ];
+    static args = {
+        key: Args.string({
+            description: 'Configuration key',
+            required: true,
+        }),
+    };
+    async run() {
+        const { args } = await this.parse(ConfigGet);
+        const key = assertSupportedCliConfigKey(args.key);
+        this.log(await getCliConfigValue(key));
+    }
+}

package/dist/commands/config/index.js

@@ -0,0 +1,20 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Command, loadHelpClass } from '@oclif/core';
+export default class Config extends Command {
+    static summary = 'Manage CLI configuration defaults';
+    async run() {
+        await this.parse(Config);
+        const Help = await loadHelpClass(this.config);
+        await new Help(this.config, this.config.pjson.oclif.helpOptions ?? this.config.pjson.helpOptions).showHelp([
+            this.id ?? 'config',
+            ...this.argv,
+        ]);
+    }
+}

package/dist/commands/config/list.js

@@ -0,0 +1,29 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Command } from '@oclif/core';
+import { listExplicitCliConfigValues, SUPPORTED_CLI_CONFIG_KEYS } from '../../lib/cli-config.js';
+import { renderTable } from '../../lib/ui.js';
+export default class ConfigList extends Command {
+    static summary = 'List explicitly configured CLI settings';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+    ];
+    async run() {
+        await this.parse(ConfigList);
+        const values = await listExplicitCliConfigValues();
+        const rows = SUPPORTED_CLI_CONFIG_KEYS
+            .filter((key) => Boolean(values[key]))
+            .map((key) => [key, values[key] ?? '']);
+        if (!rows.length) {
+            this.log('No CLI config values are set.');
+            return;
+        }
+        this.log(renderTable(['Key', 'Value'], rows));
+    }
+}

package/dist/commands/config/set.js

@@ -0,0 +1,35 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Args, Command } from '@oclif/core';
+import { assertSupportedCliConfigKey, setCliConfigValue } from '../../lib/cli-config.js';
+export default class ConfigSet extends Command {
+    static summary = 'Set a CLI configuration value';
+    static description = 'Set a supported CLI configuration key. Supported keys: license.pkg-url, docker.network, docker.container-prefix.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> license.pkg-url https://pkg.nocobase.com/',
+        '<%= config.bin %> <%= command.id %> docker.network nocobase',
+        '<%= config.bin %> <%= command.id %> docker.container-prefix nb',
+    ];
+    static args = {
+        key: Args.string({
+            description: 'Configuration key',
+            required: true,
+        }),
+        value: Args.string({
+            description: 'Configuration value',
+            required: true,
+        }),
+    };
+    async run() {
+        const { args } = await this.parse(ConfigSet);
+        const key = assertSupportedCliConfigKey(args.key);
+        const value = await setCliConfigValue(key, args.value);
+        this.log(`${key}=${value}`);
+    }
+}

package/dist/commands/db/check.js

@@ -0,0 +1,230 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Command, Flags } from '@oclif/core';
+import { formatMissingManagedAppEnvMessage, resolveManagedAppRuntime } from '../../lib/app-runtime.js';
+import { checkExternalDbConnection, formatDbCheckAddress, readExternalDbConnectionConfig, } from "../../lib/db-connection-check.js";
+import { commandOutput } from '../../lib/run-npm.js';
+import { validateTcpPort } from "../../lib/prompt-validators.js";
+const DEFAULT_DOCKER_REGISTRY = 'nocobase/nocobase';
+const DEFAULT_DOCKER_VERSION = 'alpha';
+function trimValue(value) {
+    const text = String(value ?? '').trim();
+    return text || undefined;
+}
+function resolveRequiredDbField(flagValue, envValue) {
+    return trimValue(flagValue) ?? trimValue(envValue);
+}
+function normalizeDockerPlatform(value) {
+    const text = trimValue(value);
+    if (!text || text === 'auto') {
+        return undefined;
+    }
+    if (text === 'linux/amd64' || text === 'linux/arm64') {
+        return text;
+    }
+    return undefined;
+}
+function formatMissingFieldsMessage(missing, hasEnv) {
+    return [
+        'Missing database settings for connectivity check.',
+        `Required: ${missing.join(', ')}.`,
+        hasEnv
+            ? 'Pass `--env <name>` to reuse a saved env, or provide the missing `--db-*` flags explicitly.'
+            : 'Provide all required `--db-*` flags explicitly, or pass `--env <name>` to reuse a saved env.',
+    ].join('\n');
+}
+function resolveDbConfigFromFlags(flags, envConfig) {
+    return {
+        builtinDb: false,
+        dbDialect: resolveRequiredDbField(flags['db-dialect'], envConfig?.dbDialect),
+        dbHost: resolveRequiredDbField(flags['db-host'], envConfig?.dbHost),
+        dbPort: resolveRequiredDbField(flags['db-port'], envConfig?.dbPort),
+        dbDatabase: resolveRequiredDbField(flags['db-database'], envConfig?.dbDatabase),
+        dbUser: resolveRequiredDbField(flags['db-user'], envConfig?.dbUser),
+        dbPassword: flags['db-password'] !== undefined
+            ? String(flags['db-password'] ?? '')
+            : envConfig?.dbPassword !== undefined
+                ? String(envConfig.dbPassword ?? '')
+                : undefined,
+    };
+}
+function validateDbConfigOrThrow(command, dbConfig, hasEnv) {
+    const missing = [];
+    if (!dbConfig.dbDialect) {
+        missing.push('--db-dialect');
+    }
+    if (!dbConfig.dbHost) {
+        missing.push('--db-host');
+    }
+    if (!dbConfig.dbPort) {
+        missing.push('--db-port');
+    }
+    if (!dbConfig.dbDatabase) {
+        missing.push('--db-database');
+    }
+    if (!dbConfig.dbUser) {
+        missing.push('--db-user');
+    }
+    if (!dbConfig.dbPassword) {
+        missing.push('--db-password');
+    }
+    if (missing.length > 0) {
+        command.error(formatMissingFieldsMessage(missing, hasEnv));
+    }
+    const portError = validateTcpPort(dbConfig.dbPort);
+    if (portError) {
+        command.error(portError);
+    }
+}
+async function resolveDbCheckInput(command, flags) {
+    const envName = flags.env?.trim() || undefined;
+    if (!envName) {
+        const dbConfig = resolveDbConfigFromFlags(flags);
+        validateDbConfigOrThrow(command, dbConfig, false);
+        return {
+            dbConfig,
+        };
+    }
+    const runtime = await resolveManagedAppRuntime(envName);
+    if (!runtime) {
+        command.error(formatMissingManagedAppEnvMessage(envName));
+    }
+    const dbConfig = resolveDbConfigFromFlags(flags, runtime.env.config);
+    validateDbConfigOrThrow(command, dbConfig, true);
+    return {
+        envName: runtime.envName,
+        kind: runtime.kind,
+        runtime: runtime,
+        dbConfig,
+    };
+}
+function buildConnectionConfigOrThrow(command, dbConfig) {
+    const connectionConfig = readExternalDbConnectionConfig(dbConfig);
+    if (!connectionConfig) {
+        command.error('Unsupported or incomplete database settings for connectivity check.');
+    }
+    return connectionConfig;
+}
+async function runExplicitDbCheck(command, dbConfig) {
+    const connectionConfig = buildConnectionConfigOrThrow(command, dbConfig);
+    const address = formatDbCheckAddress(connectionConfig);
+    const validationError = await checkExternalDbConnection(connectionConfig);
+    return {
+        ok: !validationError,
+        dialect: connectionConfig.dialect,
+        address,
+        error: validationError ?? null,
+    };
+}
+async function runDockerDbCheck(command, runtime, dbConfig) {
+    const connectionConfig = buildConnectionConfigOrThrow(command, dbConfig);
+    const config = runtime.env.config ?? {};
+    const imageRef = `${trimValue(config.dockerRegistry) || DEFAULT_DOCKER_REGISTRY}:${trimValue(config.downloadVersion) || DEFAULT_DOCKER_VERSION}`;
+    const args = [
+        'run',
+        '--rm',
+        '--network',
+        runtime.dockerNetworkName || runtime.workspaceName,
+    ];
+    const dockerPlatform = normalizeDockerPlatform(config.dockerPlatform);
+    if (dockerPlatform) {
+        args.push('--platform', dockerPlatform);
+    }
+    args.push('--entrypoint', 'nb', imageRef, 'db', 'check', '--db-dialect', connectionConfig.dialect, '--db-host', connectionConfig.host, '--db-port', String(connectionConfig.port), '--db-database', connectionConfig.database, '--db-user', connectionConfig.user, '--db-password', connectionConfig.password, '--json');
+    const output = await commandOutput('docker', args, {
+        errorName: 'docker run',
+    });
+    let payload;
+    try {
+        payload = JSON.parse(output);
+    }
+    catch {
+        command.error(`Failed to parse database check response from Docker: ${output}`);
+    }
+    const ok = Boolean(payload.ok);
+    const dialect = trimValue(payload.dialect) || connectionConfig.dialect;
+    const address = trimValue(payload.address) || formatDbCheckAddress(connectionConfig);
+    const error = trimValue(payload.error) || null;
+    return {
+        ok,
+        dialect,
+        address,
+        error,
+    };
+}
+async function runDbCheckForRuntime(command, runtime, dbConfig) {
+    if (runtime.kind === 'docker') {
+        return await runDockerDbCheck(command, runtime, dbConfig);
+    }
+    if (runtime.kind === 'local') {
+        return await runExplicitDbCheck(command, dbConfig);
+    }
+    command.error(`Env "${runtime.envName}" does not support automatic database connectivity checks.`);
+}
+export default class DbCheck extends Command {
+    static description = 'Check whether a database is reachable using the selected env settings or explicit `--db-*` flags.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %> --env app1',
+        '<%= config.bin %> <%= command.id %> --env app1 --db-password new-secret --json',
+        '<%= config.bin %> <%= command.id %> --db-dialect postgres --db-host 127.0.0.1 --db-port 5432 --db-database nocobase --db-user nocobase --db-password secret',
+    ];
+    static flags = {
+        env: Flags.string({
+            char: 'e',
+            description: 'CLI env name to read saved database settings from. Defaults to the current env when omitted.',
+        }),
+        'db-dialect': Flags.string({
+            description: 'Database dialect: postgres, kingbase, mysql, or mariadb.',
+            options: ['postgres', 'kingbase', 'mysql', 'mariadb'],
+        }),
+        'db-host': Flags.string({
+            description: 'Database host name or IP address.',
+        }),
+        'db-port': Flags.string({
+            description: 'Database TCP port.',
+        }),
+        'db-database': Flags.string({
+            description: 'Database name.',
+        }),
+        'db-user': Flags.string({
+            description: 'Database username.',
+        }),
+        'db-password': Flags.string({
+            description: 'Database password.',
+        }),
+        json: Flags.boolean({
+            description: 'Output the check result as JSON.',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(DbCheck);
+        const input = await resolveDbCheckInput(this, flags);
+        const result = input.runtime
+            ? await runDbCheckForRuntime(this, input.runtime, input.dbConfig)
+            : await runExplicitDbCheck(this, input.dbConfig);
+        if (flags.json) {
+            this.log(JSON.stringify({
+                ok: result.ok,
+                env: input.envName,
+                kind: input.kind,
+                dialect: result.dialect,
+                address: result.address,
+                error: result.error,
+            }, null, 2));
+            return;
+        }
+        if (!result.ok) {
+            this.error(result.error ?? 'Database check failed.');
+        }
+        this.log(input.envName
+            ? `Database check passed for env "${input.envName}" (${result.dialect} ${result.address}).`
+            : `Database check passed (${result.dialect} ${result.address}).`);
+    }
+}

package/dist/commands/db/shared.js

@@ -23,7 +23,7 @@ export async function resolveDbRuntime(envName) {
     const source = runtime.kind === 'http' || runtime.kind === 'ssh' ? runtime.kind : runtime.source;
     const dbDialect = String(runtime.env.config.dbDialect ?? 'postgres').trim() || 'postgres';
     if ((runtime.kind === 'local' || runtime.kind === 'docker') && runtime.env.config.builtinDb) {
-        const containerName = buildDockerDbContainerName(runtime.envName, dbDialect, runtime.workspaceName);
+        const containerName = buildDockerDbContainerName(runtime.envName, dbDialect, runtime.dockerContainerPrefix || runtime.workspaceName);
         return {
             kind: 'builtin',
             envName: runtime.envName,

package/dist/commands/dev.js

@@ -6,151 +6,7 @@
  * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
-import { Command, Flags } from '@oclif/core';
-import { formatMissingManagedAppEnvMessage, resolveManagedAppRuntime, runLocalNocoBaseCommand, } from '../lib/app-runtime.js';
-import { printInfo } from '../lib/ui.js';
-function formatUnsupportedRuntimeMessage(kind, envName) {
-    if (kind === 'docker') {
-        return [
-            `Can't run dev mode for "${envName}".`,
-            'This env is managed by Docker, but `nb dev` requires a local npm or Git source directory.',
-            `Use \`nb logs --env ${envName}\` to inspect the Docker app, or create a source-based env with \`nb init --env ${envName} --source git\`.`,
-        ].join('\n');
-    }
-    if (kind === 'ssh') {
-        return [
-            `Can't run dev mode for "${envName}" yet.`,
-            'SSH env support is reserved but not implemented yet.',
-            `Create a source-based env with \`nb init --env ${envName} --source git\` if you want local development mode right now.`,
-        ].join('\n');
-    }
-    return [
-        `Can't run dev mode for "${envName}".`,
-        'This env only has an API connection, but `nb dev` requires a local npm or Git source directory.',
-        `Create a source-based env with \`nb init --env ${envName} --source git\` if you want local development mode.`,
-    ].join('\n');
-}
-function appUrlForPort(port) {
-    const value = String(port ?? '').trim();
-    if (!value) {
-        return undefined;
-    }
-    return `http://127.0.0.1:${value}`;
-}
-async function isAppAlreadyRunning(appUrl) {
-    if (!appUrl) {
-        return false;
-    }
-    const controller = new AbortController();
-    const timeout = setTimeout(() => controller.abort(), 1500);
-    try {
-        const response = await fetch(`${appUrl}/api/__health_check`, {
-            signal: controller.signal,
-        });
-        const text = await response.text();
-        return response.ok && text.trim().toLowerCase() === 'ok';
-    }
-    catch (_error) {
-        return false;
-    }
-    finally {
-        clearTimeout(timeout);
-    }
-}
-export default class Dev extends Command {
-    static description = 'Run NocoBase in local development mode for an npm or Git source env.';
-    static examples = [
-        '<%= config.bin %> <%= command.id %>',
-        '<%= config.bin %> <%= command.id %> --env app1',
-        '<%= config.bin %> <%= command.id %> --env app1 --db-sync',
-        '<%= config.bin %> <%= command.id %> --env app1 --port 12000',
-        '<%= config.bin %> <%= command.id %> --env app1 --client',
-        '<%= config.bin %> <%= command.id %> --env app1 --server',
-        '<%= config.bin %> <%= command.id %> --env app1 --inspect 9229',
-    ];
-    static flags = {
-        env: Flags.string({
-            char: 'e',
-            description: 'CLI env name for dev mode. Defaults to the current env when omitted',
-            required: false,
-        }),
-        'db-sync': Flags.boolean({
-            description: 'Synchronize the database before starting dev mode',
-            required: false,
-        }),
-        port: Flags.string({
-            description: 'Development server port',
-            char: 'p',
-            required: false,
-        }),
-        client: Flags.boolean({
-            description: 'Run client dev mode only',
-            char: 'c',
-            required: false,
-        }),
-        server: Flags.boolean({
-            description: 'Run server dev mode only',
-            char: 's',
-            required: false,
-        }),
-        inspect: Flags.string({
-            description: 'Node.js inspect port for server debugging',
-            char: 'i',
-            required: false,
-        }),
-    };
-    async run() {
-        const { flags } = await this.parse(Dev);
-        const requestedEnv = flags.env?.trim() || undefined;
-        const runtime = await resolveManagedAppRuntime(requestedEnv);
-        if (!runtime) {
-            this.error(formatMissingManagedAppEnvMessage(requestedEnv));
-        }
-        if (runtime.kind === 'docker' || runtime.kind === 'http' || runtime.kind === 'ssh') {
-            this.error(formatUnsupportedRuntimeMessage(runtime.kind, runtime.envName));
-        }
-        const devPort = flags.port
-            || (runtime.env.appPort !== undefined && runtime.env.appPort !== null
-                ? String(runtime.env.appPort).trim()
-                : undefined);
-        const appUrl = appUrlForPort(devPort);
-        if (await isAppAlreadyRunning(appUrl)) {
-            this.error([
-                `NocoBase is already running for "${runtime.envName}"${appUrl ? ` at ${appUrl}` : ''}.`,
-                flags.port
-                    ? `Choose another dev port with --port, or stop the running app with \`nb stop --env ${runtime.envName}\` first.`
-                    : `Run \`nb stop --env ${runtime.envName}\` before starting dev mode, or choose another dev port with --port.`,
-            ].join('\n'));
-        }
-        const npmArgs = ['dev', '--rsbuild'];
-        if (flags['db-sync']) {
-            npmArgs.push('--db-sync');
-        }
-        if (devPort) {
-            npmArgs.push('--port', devPort);
-        }
-        if (flags.client) {
-            npmArgs.push('--client');
-        }
-        if (flags.server) {
-            npmArgs.push('--server');
-        }
-        if (flags.inspect) {
-            npmArgs.push('--inspect', flags.inspect);
-        }
-        printInfo(`Starting NocoBase dev mode for "${runtime.envName}" from ${runtime.projectRoot}. Press Ctrl+C to stop.`);
-        try {
-            await runLocalNocoBaseCommand(runtime, npmArgs, {
-                stdio: 'inherit',
-            });
-        }
-        catch (error) {
-            const message = error instanceof Error ? error.message : String(error);
-            this.error([
-                `Couldn't start dev mode for "${runtime.envName}".`,
-                'Check that dependencies are installed and the saved env settings are valid, then try again.',
-                `Details: ${message}`,
-            ].join('\n'));
-        }
-    }
+import SourceDev from './source/dev.js';
+export default class Dev extends SourceDev {
+    static hidden = true;
 }