@nocobase/cli 2.1.0-beta.44 → 2.1.0-beta.44.test.2

package/dist/lib/cli-config.js

@@ -1,309 +0,0 @@
-/**
- * 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 { loadExactAuthConfig, saveAuthConfig } from './auth-store.js';
-import { 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_GIT_BIN = 'git';
-export const DEFAULT_YARN_BIN = 'yarn';
-export const CLI_UPDATE_POLICY_OPTIONS = ['prompt', 'auto', 'off'];
-export const DEFAULT_UPDATE_POLICY = 'prompt';
-export const SUPPORTED_CLI_CONFIG_KEYS = [
-    'locale',
-    'update.policy',
-    'license.pkg-url',
-    'docker.network',
-    'docker.container-prefix',
-    'bin.docker',
-    'bin.git',
-    'bin.yarn',
-];
-function trimValue(value) {
-    const text = String(value ?? '').trim();
-    return text || undefined;
-}
-function resolveScope(options = {}) {
-    return {
-        scope: options.scope ?? resolveDefaultConfigScope(),
-    };
-}
-export function isSupportedCliConfigKey(value) {
-    return SUPPORTED_CLI_CONFIG_KEYS.includes(value);
-}
-export function assertSupportedCliConfigKey(value) {
-    if (!isSupportedCliConfigKey(value)) {
-        throw new Error(`Unsupported config key "${value}". Supported keys: ${SUPPORTED_CLI_CONFIG_KEYS.join(', ')}`);
-    }
-    return value;
-}
-export function normalizeCliUpdatePolicy(value) {
-    const normalized = trimValue(value);
-    if (!normalized) {
-        return undefined;
-    }
-    return CLI_UPDATE_POLICY_OPTIONS.includes(normalized) ? normalized : undefined;
-}
-function cloneSettings(config) {
-    return {
-        ...(config.settings?.locale ? { locale: trimValue(config.settings.locale) } : {}),
-        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,
-    };
-}
-function pruneSettings(config) {
-    if (config.settings && !trimValue(config.settings.locale)) {
-        delete config.settings.locale;
-    }
-    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;
-    }
-    const docker = config.settings?.docker;
-    if (docker && !trimValue(docker.network) && !trimValue(docker.containerPrefix)) {
-        delete config.settings?.docker;
-    }
-    const bin = config.settings?.bin;
-    if (bin && !trimValue(bin.docker) && !trimValue(bin.git) && !trimValue(bin.yarn)) {
-        delete config.settings?.bin;
-    }
-    if (config.settings &&
-        !config.settings.locale &&
-        !config.settings.update &&
-        !config.settings.license &&
-        !config.settings.docker &&
-        !config.settings.bin) {
-        delete config.settings;
-    }
-}
-export function getExplicitCliConfigValue(config, key) {
-    switch (key) {
-        case 'locale':
-            return trimValue(config.settings?.locale);
-        case 'update.policy':
-            return normalizeCliUpdatePolicy(config.settings?.update?.policy);
-        case 'license.pkg-url':
-            return trimValue(config.settings?.license?.pkgUrl);
-        case 'docker.network':
-            return trimValue(config.settings?.docker?.network);
-        case 'docker.container-prefix':
-            return trimValue(config.settings?.docker?.containerPrefix);
-        case 'bin.docker':
-            return trimValue(config.settings?.bin?.docker);
-        case 'bin.git':
-            return trimValue(config.settings?.bin?.git);
-        case 'bin.yarn':
-            return trimValue(config.settings?.bin?.yarn);
-    }
-}
-export function getEffectiveCliConfigValue(config, key) {
-    const explicit = getExplicitCliConfigValue(config, key);
-    if (explicit && key !== 'locale') {
-        return explicit;
-    }
-    switch (key) {
-        case 'locale':
-            return resolveCliLocale(undefined, { configuredLocale: trimValue(config.settings?.locale) });
-        case 'update.policy':
-            return explicit ?? DEFAULT_UPDATE_POLICY;
-        case 'license.pkg-url':
-            return DEFAULT_LICENSE_PKG_URL;
-        case 'docker.network':
-            return trimValue(config.name) || DEFAULT_DOCKER_NETWORK;
-        case 'docker.container-prefix':
-            return trimValue(config.name) || DEFAULT_DOCKER_CONTAINER_PREFIX;
-        case 'bin.docker':
-            return DEFAULT_DOCKER_BIN;
-        case 'bin.git':
-            return DEFAULT_GIT_BIN;
-        case 'bin.yarn':
-            return DEFAULT_YARN_BIN;
-    }
-}
-export function normalizeCliConfigValue(key, value) {
-    const normalized = value.trim();
-    if (!normalized) {
-        throw new Error(`Config key "${key}" requires a non-empty value.`);
-    }
-    if (key === 'license.pkg-url') {
-        return normalized.replace(/\/+$/, '') + '/';
-    }
-    if (key === 'locale') {
-        const locale = normalizeCliLocale(normalized);
-        if (!locale) {
-            throw new Error(`Config key "${key}" must be one of: ${CLI_LOCALE_FLAG_OPTIONS.join(', ')}`);
-        }
-        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;
-    }
-    return normalized;
-}
-export async function loadCliConfig(options = {}) {
-    return await loadExactAuthConfig(resolveScope(options));
-}
-export async function getCliConfigValue(key, options = {}) {
-    const config = await loadCliConfig(options);
-    return getEffectiveCliConfigValue(config, key);
-}
-export async function listExplicitCliConfigValues(options = {}) {
-    const config = await loadCliConfig(options);
-    const out = {};
-    for (const key of SUPPORTED_CLI_CONFIG_KEYS) {
-        const value = getExplicitCliConfigValue(config, key);
-        if (value) {
-            out[key] = value;
-        }
-    }
-    return out;
-}
-export async function setCliConfigValue(key, value, options = {}) {
-    const scope = resolveScope(options);
-    const config = await loadExactAuthConfig(scope);
-    const normalized = normalizeCliConfigValue(key, value);
-    config.settings = cloneSettings(config);
-    switch (key) {
-        case 'locale':
-            config.settings.locale = normalized;
-            break;
-        case 'update.policy':
-            config.settings.update = {
-                ...(config.settings.update ?? {}),
-                policy: normalized,
-            };
-            break;
-        case 'license.pkg-url':
-            config.settings.license = {
-                ...(config.settings.license ?? {}),
-                pkgUrl: normalized,
-            };
-            break;
-        case 'docker.network':
-            config.settings.docker = {
-                ...(config.settings.docker ?? {}),
-                network: normalized,
-            };
-            break;
-        case 'docker.container-prefix':
-            config.settings.docker = {
-                ...(config.settings.docker ?? {}),
-                containerPrefix: normalized,
-            };
-            break;
-        case 'bin.docker':
-            config.settings.bin = {
-                ...(config.settings.bin ?? {}),
-                docker: normalized,
-            };
-            break;
-        case 'bin.git':
-            config.settings.bin = {
-                ...(config.settings.bin ?? {}),
-                git: normalized,
-            };
-            break;
-        case 'bin.yarn':
-            config.settings.bin = {
-                ...(config.settings.bin ?? {}),
-                yarn: normalized,
-            };
-            break;
-    }
-    pruneSettings(config);
-    await saveAuthConfig(config, scope);
-    return normalized;
-}
-export async function deleteCliConfigValue(key, options = {}) {
-    const scope = resolveScope(options);
-    const config = await loadExactAuthConfig(scope);
-    const hadValue = Boolean(getExplicitCliConfigValue(config, key));
-    if (!hadValue) {
-        return false;
-    }
-    config.settings = cloneSettings(config);
-    switch (key) {
-        case 'locale':
-            delete config.settings.locale;
-            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;
-            }
-            break;
-        case 'docker.network':
-            if (config.settings.docker) {
-                delete config.settings.docker.network;
-            }
-            break;
-        case 'docker.container-prefix':
-            if (config.settings.docker) {
-                delete config.settings.docker.containerPrefix;
-            }
-            break;
-        case 'bin.docker':
-            if (config.settings.bin) {
-                delete config.settings.bin.docker;
-            }
-            break;
-        case 'bin.git':
-            if (config.settings.bin) {
-                delete config.settings.bin.git;
-            }
-            break;
-        case 'bin.yarn':
-            if (config.settings.bin) {
-                delete config.settings.bin.yarn;
-            }
-            break;
-    }
-    pruneSettings(config);
-    await saveAuthConfig(config, scope);
-    return true;
-}
-export async function resolveDockerNetworkName(options = {}) {
-    return await getCliConfigValue('docker.network', options);
-}
-export async function resolveDockerContainerPrefix(options = {}) {
-    return await getCliConfigValue('docker.container-prefix', options);
-}
-export async function resolveLicensePkgUrlFromConfig(options = {}) {
-    return await getCliConfigValue('license.pkg-url', options);
-}
-const CONFIGURABLE_COMMAND_KEYS = {
-    docker: 'bin.docker',
-    git: 'bin.git',
-    yarn: 'bin.yarn',
-};
-export function isConfigurableCommandName(value) {
-    return Object.prototype.hasOwnProperty.call(CONFIGURABLE_COMMAND_KEYS, value);
-}
-export async function resolveConfiguredCommandName(commandName, options = {}) {
-    if (!isConfigurableCommandName(commandName)) {
-        return commandName;
-    }
-    return await getCliConfigValue(CONFIGURABLE_COMMAND_KEYS[commandName], options);
-}

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

@@ -1,44 +0,0 @@
-/**
- * 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');
-}

package/dist/lib/cli-home.js

@@ -1,47 +0,0 @@
-/**
- * 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 os from 'node:os';
-import path from 'node:path';
-export const CLI_HOME_DIRNAME = '.nocobase';
-export const NB_CLI_ROOT_ENV = 'NB_CLI_ROOT';
-export function resolveDefaultConfigScope() {
-    return 'global';
-}
-function readConfiguredPath(name) {
-    const value = String(process.env[name] ?? '').trim();
-    return value || undefined;
-}
-function resolveGlobalCliHomeRoot() {
-    return readConfiguredPath(NB_CLI_ROOT_ENV) ?? os.homedir();
-}
-export function resolveCliHomeRoot(scope = resolveDefaultConfigScope()) {
-    void scope;
-    return resolveGlobalCliHomeRoot();
-}
-export function resolveCliHomeDir(scope = resolveDefaultConfigScope()) {
-    return path.join(resolveCliHomeRoot(scope), CLI_HOME_DIRNAME);
-}
-export function resolveEnvRoot(scope = resolveDefaultConfigScope()) {
-    void scope;
-    return resolveCliHomeRoot();
-}
-export function resolveEnvRelativePath(relativePath, scope = resolveDefaultConfigScope()) {
-    return path.resolve(resolveEnvRoot(scope), relativePath);
-}
-export function resolveConfiguredEnvPath(value, scope = resolveDefaultConfigScope()) {
-    const text = String(value ?? '').trim();
-    if (!text) {
-        return undefined;
-    }
-    return path.isAbsolute(text) ? text : resolveEnvRelativePath(text, scope);
-}
-export function formatCliHomeScope(scope) {
-    void scope;
-    return 'global';
-}

package/dist/lib/cli-locale.js

@@ -1,141 +0,0 @@
-/**
- * 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 { readFileSync } from 'node:fs';
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-import { resolveCliHomeDir } from './cli-home.js';
-export const SUPPORTED_CLI_LOCALES = ['en-US', 'zh-CN'];
-export const CLI_LOCALE_FLAG_OPTIONS = [...SUPPORTED_CLI_LOCALES];
-export const CLI_LOCALE_FLAG_DESCRIPTION = 'Language for CLI prompts and the local setup UI.';
-const DEFAULT_CLI_LOCALE = 'en-US';
-const localeCache = {};
-export function normalizeCliLocale(value) {
-    const raw = String(value ?? '').trim();
-    if (!raw) {
-        return undefined;
-    }
-    const normalized = raw.replace(/\..*$/, '').replace(/_/g, '-').toLowerCase();
-    if (normalized === 'zh' || normalized.startsWith('zh-')) {
-        return 'zh-CN';
-    }
-    if (normalized === 'en' || normalized.startsWith('en-')) {
-        return 'en-US';
-    }
-    return undefined;
-}
-function readConfiguredCliLocale() {
-    try {
-        const configPath = path.join(resolveCliHomeDir(), 'config.json');
-        const content = readFileSync(configPath, 'utf8');
-        const parsed = JSON.parse(content);
-        return normalizeCliLocale(parsed.settings?.locale === undefined ? undefined : String(parsed.settings.locale));
-    }
-    catch {
-        return undefined;
-    }
-}
-function loadLocaleMessages(locale) {
-    if (localeCache[locale]) {
-        return localeCache[locale];
-    }
-    const moduleDir = path.dirname(fileURLToPath(import.meta.url));
-    const fallbackPath = path.resolve(moduleDir, '..', 'locale', `${locale}.json`);
-    const fileUrl = new URL(`../locale/${locale}.json`, import.meta.url);
-    let parsed;
-    try {
-        parsed = JSON.parse(readFileSync(fileUrl, 'utf8'));
-    }
-    catch (error) {
-        const code = error && typeof error === 'object' && 'code' in error ? String(error.code) : '';
-        if (code !== 'ENOENT') {
-            throw error;
-        }
-        parsed = JSON.parse(readFileSync(fallbackPath, 'utf8'));
-    }
-    localeCache[locale] = parsed;
-    return parsed;
-}
-function getPathValue(input, path) {
-    let current = input;
-    for (const part of path.split('.')) {
-        if (!current || typeof current !== 'object' || !Object.prototype.hasOwnProperty.call(current, part)) {
-            return undefined;
-        }
-        current = current[part];
-    }
-    return current;
-}
-function interpolateTemplate(template, values) {
-    return template.replace(/{{\s*([\w.]+)\s*}}/g, (_match, key) => {
-        const value = getPathValue(values, key);
-        return value === undefined || value === null ? '' : String(value);
-    });
-}
-export function detectCliLocale(configuredLocale) {
-    const resolvedConfiguredLocale = configuredLocale ?? readConfiguredCliLocale();
-    const candidates = [
-        process.env.NB_LOCALE,
-        resolvedConfiguredLocale,
-        process.env.LC_ALL,
-        process.env.LC_MESSAGES,
-        process.env.LANG,
-        Intl.DateTimeFormat().resolvedOptions().locale,
-    ];
-    for (const candidate of candidates) {
-        const locale = normalizeCliLocale(candidate);
-        if (locale) {
-            return locale;
-        }
-    }
-    return DEFAULT_CLI_LOCALE;
-}
-export function resolveCliLocale(preferred, options) {
-    return normalizeCliLocale(preferred) ?? detectCliLocale(options?.configuredLocale);
-}
-export function applyCliLocale(preferred) {
-    const locale = resolveCliLocale(preferred);
-    process.env.NB_LOCALE = locale;
-    return locale;
-}
-export function createCliTranslate(preferred) {
-    const locale = resolveCliLocale(preferred);
-    return (key, values, fallback) => {
-        const messages = loadLocaleMessages(locale);
-        const template = getPathValue(messages, key);
-        if (typeof template !== 'string') {
-            return interpolateTemplate(fallback ?? key, values);
-        }
-        return interpolateTemplate(template, values);
-    };
-}
-export function translateCli(key, values, options) {
-    return createCliTranslate(options?.locale)(key, values, options?.fallback);
-}
-export function localeText(key, values, fallback) {
-    return {
-        key,
-        ...(values ? { values } : {}),
-        ...(fallback ? { fallback } : {}),
-    };
-}
-export function isLocalizedTextDef(value) {
-    return Boolean(value && typeof value === 'object' && typeof value.key === 'string');
-}
-export function resolveLocalizedText(text, options) {
-    if (text === undefined) {
-        return options?.fallback ?? '';
-    }
-    if (typeof text === 'string') {
-        return text;
-    }
-    return translateCli(text.key, text.values, {
-        locale: options?.locale,
-        fallback: text.fallback ?? options?.fallback,
-    });
-}

package/dist/lib/command-discovery.js

@@ -1,39 +0,0 @@
-/**
- * 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 { readdir } from 'node:fs/promises';
-import { join } from 'node:path';
-/**
- * Recursively collect command module paths under `commandsRoot` (e.g. `dist/commands` → `.js`, `src/commands` → `.ts`).
- */
-export async function collectCommandModulePaths(commandsRoot, extension) {
-    const entries = await readdir(commandsRoot, { withFileTypes: true });
-    const files = [];
-    for (const ent of entries) {
-        const full = join(commandsRoot, ent.name);
-        if (ent.isDirectory()) {
-            files.push(...(await collectCommandModulePaths(full, extension)));
-        }
-        else if (ent.isFile() && ent.name.endsWith(extension)) {
-            files.push(full);
-        }
-    }
-    return files.sort();
-}
-/**
- * Map a path relative to `commands/` with `.js` / `.ts` to an oclif explicit-registry key.
- * `api/resource/foo.js` → `api:resource:foo`; trailing `index` maps to the parent command.
- */
-export function commandRelativePathToRegistryKey(relativePath) {
-    const normalized = relativePath.replace(/\\/g, '/').replace(/\.(js|ts)$/i, '');
-    const segments = normalized.split('/').filter(Boolean);
-    if (segments.at(-1) === 'index') {
-        segments.pop();
-    }
-    return segments.join(':');
-}