@nocobase/cli 2.1.0-alpha.45 → 2.1.0-alpha.47

package/dist/lib/cli-config.js

@@ -7,22 +7,40 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 import { loadExactAuthConfig, saveAuthConfig } from './auth-store.js';
-import { resolveDefaultConfigScope } from './cli-home.js';
+import { resolveCliHomeRoot, resolveDefaultConfigScope } from './cli-home.js';
 import { CLI_LOCALE_FLAG_OPTIONS, normalizeCliLocale, resolveCliLocale } from './cli-locale.js';
 export const DEFAULT_LICENSE_PKG_URL = 'https://pkg.nocobase.com/';
 export const DEFAULT_DOCKER_NETWORK = 'nocobase';
 export const DEFAULT_DOCKER_CONTAINER_PREFIX = 'nb';
 export const DEFAULT_DOCKER_BIN = 'docker';
+export const DEFAULT_CADDY_BIN = 'caddy';
 export const DEFAULT_GIT_BIN = 'git';
+export const DEFAULT_NGINX_BIN = 'nginx';
+export const PROXY_PROVIDER_OPTIONS = ['nginx', 'caddy'];
+export const DEFAULT_PROXY_PROVIDER = 'nginx';
+export const DEFAULT_PROXY_HOST = '127.0.0.1';
 export const DEFAULT_YARN_BIN = 'yarn';
+export const DEFAULT_LOG_RETENTION_DAYS = 14;
+export const DEFAULT_LOG_ENABLED = true;
+export const CLI_UPDATE_POLICY_OPTIONS = ['prompt', 'auto', 'off'];
+export const DEFAULT_UPDATE_POLICY = 'prompt';
 export const SUPPORTED_CLI_CONFIG_KEYS = [
     'locale',
+    'default-ui-host',
+    'default-api-host',
+    'update.policy',
     'license.pkg-url',
     'docker.network',
     'docker.container-prefix',
     'bin.docker',
+    'bin.caddy',
     'bin.git',
+    'bin.nginx',
+    'proxy.nb-cli-root',
+    'proxy.upstream-host',
     'bin.yarn',
+    'log.enabled',
+    'log.retention-days',
 ];
 function trimValue(value) {
     const text = String(value ?? '').trim();
@@ -42,18 +60,44 @@ export function assertSupportedCliConfigKey(value) {
     }
     return value;
 }
+export function normalizeCliUpdatePolicy(value) {
+    const normalized = trimValue(value);
+    if (!normalized) {
+        return undefined;
+    }
+    return CLI_UPDATE_POLICY_OPTIONS.includes(normalized) ? normalized : undefined;
+}
+export function normalizeProxyProvider(value) {
+    const normalized = trimValue(value);
+    if (!normalized) {
+        return undefined;
+    }
+    return PROXY_PROVIDER_OPTIONS.includes(normalized) ? normalized : undefined;
+}
 function cloneSettings(config) {
     return {
         ...(config.settings?.locale ? { locale: trimValue(config.settings.locale) } : {}),
+        init: config.settings?.init ? { ...config.settings.init } : undefined,
+        update: config.settings?.update ? { ...config.settings.update } : undefined,
         license: config.settings?.license ? { ...config.settings.license } : undefined,
         docker: config.settings?.docker ? { ...config.settings.docker } : undefined,
         bin: config.settings?.bin ? { ...config.settings.bin } : undefined,
+        proxy: config.settings?.proxy ? { ...config.settings.proxy } : undefined,
+        log: config.settings?.log ? { ...config.settings.log } : undefined,
     };
 }
 function pruneSettings(config) {
     if (config.settings && !trimValue(config.settings.locale)) {
         delete config.settings.locale;
     }
+    const init = config.settings?.init;
+    if (init && !trimValue(init.defaultUiHost) && !trimValue(init.defaultApiHost)) {
+        delete config.settings?.init;
+    }
+    const update = config.settings?.update;
+    if (update && !normalizeCliUpdatePolicy(update.policy)) {
+        delete config.settings?.update;
+    }
     const license = config.settings?.license;
     if (license && !trimValue(license.pkgUrl)) {
         delete config.settings?.license;
@@ -63,14 +107,31 @@ function pruneSettings(config) {
         delete config.settings?.docker;
     }
     const bin = config.settings?.bin;
-    if (bin && !trimValue(bin.docker) && !trimValue(bin.git) && !trimValue(bin.yarn)) {
+    if (bin &&
+        !trimValue(bin.docker) &&
+        !trimValue(bin.caddy) &&
+        !trimValue(bin.git) &&
+        !trimValue(bin.nginx) &&
+        !trimValue(bin.yarn)) {
         delete config.settings?.bin;
     }
+    const proxy = config.settings?.proxy;
+    if (proxy && !trimValue(proxy.nbCliRoot) && !trimValue(proxy.upstreamHost)) {
+        delete config.settings?.proxy;
+    }
+    const log = config.settings?.log;
+    if (log && typeof log.enabled !== 'boolean' && (!Number.isInteger(log.retentionDays) || log.retentionDays < 0)) {
+        delete config.settings?.log;
+    }
     if (config.settings &&
         !config.settings.locale &&
+        !config.settings.init &&
+        !config.settings.update &&
         !config.settings.license &&
         !config.settings.docker &&
-        !config.settings.bin) {
+        !config.settings.bin &&
+        !config.settings.proxy &&
+        !config.settings.log) {
         delete config.settings;
     }
 }
@@ -78,6 +139,12 @@ export function getExplicitCliConfigValue(config, key) {
     switch (key) {
         case 'locale':
             return trimValue(config.settings?.locale);
+        case 'default-ui-host':
+            return trimValue(config.settings?.init?.defaultUiHost);
+        case 'default-api-host':
+            return trimValue(config.settings?.init?.defaultApiHost);
+        case 'update.policy':
+            return normalizeCliUpdatePolicy(config.settings?.update?.policy);
         case 'license.pkg-url':
             return trimValue(config.settings?.license?.pkgUrl);
         case 'docker.network':
@@ -86,10 +153,24 @@ export function getExplicitCliConfigValue(config, key) {
             return trimValue(config.settings?.docker?.containerPrefix);
         case 'bin.docker':
             return trimValue(config.settings?.bin?.docker);
+        case 'bin.caddy':
+            return trimValue(config.settings?.bin?.caddy);
         case 'bin.git':
             return trimValue(config.settings?.bin?.git);
+        case 'bin.nginx':
+            return trimValue(config.settings?.bin?.nginx);
+        case 'proxy.nb-cli-root':
+            return trimValue(config.settings?.proxy?.nbCliRoot);
+        case 'proxy.upstream-host':
+            return trimValue(config.settings?.proxy?.upstreamHost);
         case 'bin.yarn':
             return trimValue(config.settings?.bin?.yarn);
+        case 'log.enabled':
+            return typeof config.settings?.log?.enabled === 'boolean' ? String(config.settings?.log?.enabled) : undefined;
+        case 'log.retention-days':
+            return Number.isInteger(config.settings?.log?.retentionDays)
+                ? String(config.settings?.log?.retentionDays)
+                : undefined;
     }
 }
 export function getEffectiveCliConfigValue(config, key) {
@@ -100,6 +181,12 @@ export function getEffectiveCliConfigValue(config, key) {
     switch (key) {
         case 'locale':
             return resolveCliLocale(undefined, { configuredLocale: trimValue(config.settings?.locale) });
+        case 'default-ui-host':
+            return '127.0.0.1';
+        case 'default-api-host':
+            return '127.0.0.1';
+        case 'update.policy':
+            return explicit ?? DEFAULT_UPDATE_POLICY;
         case 'license.pkg-url':
             return DEFAULT_LICENSE_PKG_URL;
         case 'docker.network':
@@ -108,10 +195,22 @@ export function getEffectiveCliConfigValue(config, key) {
             return trimValue(config.name) || DEFAULT_DOCKER_CONTAINER_PREFIX;
         case 'bin.docker':
             return DEFAULT_DOCKER_BIN;
+        case 'bin.caddy':
+            return DEFAULT_CADDY_BIN;
         case 'bin.git':
             return DEFAULT_GIT_BIN;
+        case 'bin.nginx':
+            return DEFAULT_NGINX_BIN;
+        case 'proxy.nb-cli-root':
+            return explicit ?? resolveCliHomeRoot();
+        case 'proxy.upstream-host':
+            return explicit ?? DEFAULT_PROXY_HOST;
         case 'bin.yarn':
             return DEFAULT_YARN_BIN;
+        case 'log.enabled':
+            return explicit ?? String(DEFAULT_LOG_ENABLED);
+        case 'log.retention-days':
+            return explicit ?? String(DEFAULT_LOG_RETENTION_DAYS);
     }
 }
 export function normalizeCliConfigValue(key, value) {
@@ -129,6 +228,26 @@ export function normalizeCliConfigValue(key, value) {
         }
         return locale;
     }
+    if (key === 'update.policy') {
+        const policy = normalizeCliUpdatePolicy(normalized);
+        if (!policy) {
+            throw new Error(`Config key "${key}" must be one of: ${CLI_UPDATE_POLICY_OPTIONS.join(', ')}`);
+        }
+        return policy;
+    }
+    if (key === 'log.retention-days') {
+        const retentionDays = Number.parseInt(normalized, 10);
+        if (!Number.isInteger(retentionDays) || retentionDays < 0) {
+            throw new Error(`Config key "${key}" must be a non-negative integer.`);
+        }
+        return String(retentionDays);
+    }
+    if (key === 'log.enabled') {
+        if (normalized !== 'true' && normalized !== 'false') {
+            throw new Error(`Config key "${key}" must be either "true" or "false".`);
+        }
+        return normalized;
+    }
     return normalized;
 }
 export async function loadCliConfig(options = {}) {
@@ -158,6 +277,24 @@ export async function setCliConfigValue(key, value, options = {}) {
         case 'locale':
             config.settings.locale = normalized;
             break;
+        case 'default-ui-host':
+            config.settings.init = {
+                ...(config.settings.init ?? {}),
+                defaultUiHost: normalized,
+            };
+            break;
+        case 'default-api-host':
+            config.settings.init = {
+                ...(config.settings.init ?? {}),
+                defaultApiHost: normalized,
+            };
+            break;
+        case 'update.policy':
+            config.settings.update = {
+                ...(config.settings.update ?? {}),
+                policy: normalized,
+            };
+            break;
         case 'license.pkg-url':
             config.settings.license = {
                 ...(config.settings.license ?? {}),
@@ -182,18 +319,54 @@ export async function setCliConfigValue(key, value, options = {}) {
                 docker: normalized,
             };
             break;
+        case 'bin.caddy':
+            config.settings.bin = {
+                ...(config.settings.bin ?? {}),
+                caddy: normalized,
+            };
+            break;
         case 'bin.git':
             config.settings.bin = {
                 ...(config.settings.bin ?? {}),
                 git: normalized,
             };
             break;
+        case 'bin.nginx':
+            config.settings.bin = {
+                ...(config.settings.bin ?? {}),
+                nginx: normalized,
+            };
+            break;
+        case 'proxy.nb-cli-root':
+            config.settings.proxy = {
+                ...(config.settings.proxy ?? {}),
+                nbCliRoot: normalized,
+            };
+            break;
+        case 'proxy.upstream-host':
+            config.settings.proxy = {
+                ...(config.settings.proxy ?? {}),
+                upstreamHost: normalized,
+            };
+            break;
         case 'bin.yarn':
             config.settings.bin = {
                 ...(config.settings.bin ?? {}),
                 yarn: normalized,
             };
             break;
+        case 'log.enabled':
+            config.settings.log = {
+                ...(config.settings.log ?? {}),
+                enabled: normalized === 'true',
+            };
+            break;
+        case 'log.retention-days':
+            config.settings.log = {
+                ...(config.settings.log ?? {}),
+                retentionDays: Number.parseInt(normalized, 10),
+            };
+            break;
     }
     pruneSettings(config);
     await saveAuthConfig(config, scope);
@@ -211,6 +384,21 @@ export async function deleteCliConfigValue(key, options = {}) {
         case 'locale':
             delete config.settings.locale;
             break;
+        case 'default-ui-host':
+            if (config.settings.init) {
+                delete config.settings.init.defaultUiHost;
+            }
+            break;
+        case 'default-api-host':
+            if (config.settings.init) {
+                delete config.settings.init.defaultApiHost;
+            }
+            break;
+        case 'update.policy':
+            if (config.settings.update) {
+                delete config.settings.update.policy;
+            }
+            break;
         case 'license.pkg-url':
             if (config.settings.license) {
                 delete config.settings.license.pkgUrl;
@@ -231,16 +419,46 @@ export async function deleteCliConfigValue(key, options = {}) {
                 delete config.settings.bin.docker;
             }
             break;
+        case 'bin.caddy':
+            if (config.settings.bin) {
+                delete config.settings.bin.caddy;
+            }
+            break;
         case 'bin.git':
             if (config.settings.bin) {
                 delete config.settings.bin.git;
             }
             break;
+        case 'bin.nginx':
+            if (config.settings.bin) {
+                delete config.settings.bin.nginx;
+            }
+            break;
+        case 'proxy.nb-cli-root':
+            if (config.settings.proxy) {
+                delete config.settings.proxy.nbCliRoot;
+            }
+            break;
+        case 'proxy.upstream-host':
+            if (config.settings.proxy) {
+                delete config.settings.proxy.upstreamHost;
+            }
+            break;
         case 'bin.yarn':
             if (config.settings.bin) {
                 delete config.settings.bin.yarn;
             }
             break;
+        case 'log.enabled':
+            if (config.settings.log) {
+                delete config.settings.log.enabled;
+            }
+            break;
+        case 'log.retention-days':
+            if (config.settings.log) {
+                delete config.settings.log.retentionDays;
+            }
+            break;
     }
     pruneSettings(config);
     await saveAuthConfig(config, scope);
@@ -249,6 +467,12 @@ export async function deleteCliConfigValue(key, options = {}) {
 export async function resolveDockerNetworkName(options = {}) {
     return await getCliConfigValue('docker.network', options);
 }
+export async function resolveDefaultUiHost(options = {}) {
+    return await getCliConfigValue('default-ui-host', options);
+}
+export async function resolveDefaultApiHost(options = {}) {
+    return await getCliConfigValue('default-api-host', options);
+}
 export async function resolveDockerContainerPrefix(options = {}) {
     return await getCliConfigValue('docker.container-prefix', options);
 }
@@ -257,7 +481,9 @@ export async function resolveLicensePkgUrlFromConfig(options = {}) {
 }
 const CONFIGURABLE_COMMAND_KEYS = {
     docker: 'bin.docker',
+    caddy: 'bin.caddy',
     git: 'bin.git',
+    nginx: 'bin.nginx',
     yarn: 'bin.yarn',
 };
 export function isConfigurableCommandName(value) {

package/dist/lib/cli-entry-error.js

@@ -0,0 +1,52 @@
+/**
+ * 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.
+ */
+export function getCommandPathTokens(argv) {
+    const tokens = [];
+    for (const token of argv) {
+        if (!token) {
+            continue;
+        }
+        if (token.startsWith('-')) {
+            break;
+        }
+        tokens.push(token);
+    }
+    return tokens;
+}
+export function formatCliEntryError(error, argv) {
+    const message = error instanceof Error ? error.message : String(error);
+    const missingCommandMatch = message.match(/^Command (.+) not found\.$/);
+    if (!missingCommandMatch) {
+        return message;
+    }
+    const commandPathTokens = getCommandPathTokens(argv);
+    const attemptedCommand = commandPathTokens.join(' ') || missingCommandMatch[1];
+    const isApiCommand = commandPathTokens[0] === 'api';
+    if (isApiCommand) {
+        const helpCommandTokens = commandPathTokens.length > 2 ? commandPathTokens.slice(0, -1) : ['api'];
+        const helpCommand = `nb ${helpCommandTokens.join(' ')} --help`;
+        return [
+            `Unknown command: \`${attemptedCommand}\`.`,
+            `If this is a built-in command or a typo, run \`${helpCommand}\` to inspect the commands available under that API group.`,
+        ].join('\n');
+    }
+    return [
+        `Unknown command: \`${attemptedCommand}\`.`,
+        'If this is a built-in command or a typo, run `nb --help` to inspect available commands.',
+        `If \`${attemptedCommand}\` should be a runtime command from your NocoBase app, check whether the connected app exposes it, then retry the command.`,
+    ].join('\n');
+}
+export function appendDiagnosticLogPath(message, logFile) {
+    const normalizedMessage = String(message ?? '').trim();
+    const normalizedLogFile = String(logFile ?? '').trim();
+    if (!normalizedLogFile) {
+        return normalizedMessage;
+    }
+    return [normalizedMessage, `Diagnostic log: ${normalizedLogFile}`].filter(Boolean).join('\n\n');
+}