@nocobase/cli 2.1.10 → 2.1.11-test.1

package/dist/commands/install.js

@@ -15,7 +15,7 @@ import { appendAppPublicPath } from '../lib/app-public-path.js';
 import { runPromptCatalog, } from "../lib/prompt-catalog.js";
 import { applyCliLocale, localeText, resolveCliLocale, translateCli } from "../lib/cli-locale.js";
 import { resolveConfiguredEnvPath, resolveDefaultConfigScope, resolveEnvRoot, resolveEnvRelativePath, } from '../lib/cli-home.js';
-import { defaultDockerContainerPrefix, defaultDockerNetworkName } from '../lib/app-runtime.js';
+import { defaultDockerContainerPrefix, defaultDockerNetworkName, managedAppLifecycleEnvVars, } from '../lib/app-runtime.js';
 import { resolveDefaultApiHost, resolveDockerContainerPrefix, resolveDockerNetworkName } from '../lib/cli-config.js';
 import { DEFAULT_DOCKER_VERSION, resolveDockerImageRef } from "../lib/docker-image.js";
 import { findAvailableTcpPort, validateAppPublicPath, validateAvailableTcpPort, validateTcpPort, validateEnvKey, } from "../lib/prompt-validators.js";
@@ -1960,7 +1960,7 @@ export default class Install extends Command {
     }
     static resolveAbsoluteStoragePath(envName, appResults) {
         const configuredStoragePath = resolveConfiguredStoragePathValue(appResults, envName);
-        return resolveConfiguredEnvPath(configuredStoragePath) ?? resolveEnvRelativePath(defaultInstallStoragePath(envName));
+        return (resolveConfiguredEnvPath(configuredStoragePath) ?? resolveEnvRelativePath(defaultInstallStoragePath(envName)));
     }
     async prepareHookScriptForInstall(params) {
         const appPath = Install.resolveAbsoluteAppPath(params.envName, params.appResults);
@@ -2057,7 +2057,9 @@ export default class Install extends Command {
         const dbDialect = String(params.dbResults.dbDialect ?? 'postgres').trim() || 'postgres';
         const appKey = Install.resolveManagedAppKey(params.appResults.appKey);
         const timeZone = Install.resolveManagedTimeZone(params.appResults.timeZone);
+        const lifecycleEnvVars = managedAppLifecycleEnvVars();
         const env = {
+            ...lifecycleEnvVars,
             STORAGE_PATH: storagePath,
             APP_PORT: String(params.appResults.appPort ?? DEFAULT_INSTALL_APP_PORT).trim() || DEFAULT_INSTALL_APP_PORT,
             APP_KEY: appKey,

package/dist/commands/self/update.js

@@ -26,7 +26,7 @@ function formatSkillsUpdateMessage(result, verbose) {
 }
 export default class SelfUpdate extends Command {
     static summary = 'Update the globally installed NocoBase CLI';
-    static description = 'Update the current NocoBase CLI install when it is managed by a standard global npm install.';
+    static description = 'Update the current NocoBase CLI install when it is managed by a standard global npm, pnpm, or yarn install.';
     static examples = [
         '<%= config.bin %> <%= command.id %>',
         '<%= config.bin %> <%= command.id %> --yes',

package/dist/commands/source/dev.js

@@ -8,8 +8,9 @@
  */
 import { Command, Flags } from '@oclif/core';
 import { ensureCrossEnvConfirmed, hasExplicitEnvSelection } from '../../lib/env-guard.js';
-import { ensureLocalPostinstall } from '../../lib/app-managed-resources.js';
+import { ensureLocalPostinstall, ensureNpmSourceDevDependencies } from '../../lib/app-managed-resources.js';
 import { formatMissingManagedAppEnvMessage, resolveManagedAppRuntime, runLocalNocoBaseCommand, } from '../../lib/app-runtime.js';
+import { findAvailableTcpPort } from '../../lib/prompt-validators.js';
 import { announceTargetEnv, failTask, printInfo, startTask, succeedTask } from '../../lib/ui.js';
 function formatUnsupportedRuntimeMessage(kind, envName) {
     if (kind === 'docker') {
@@ -129,10 +130,7 @@ export default class SourceDev extends Command {
             this.error(formatUnsupportedRuntimeMessage(runtime.kind, runtime.envName));
         }
         announceTargetEnv(runtime.envName);
-        const devPort = flags.port ||
-            (runtime.env.appPort !== undefined && runtime.env.appPort !== null
-                ? String(runtime.env.appPort).trim()
-                : undefined);
+        const devPort = flags.port?.trim() || (await findAvailableTcpPort());
         const appUrl = appUrlForPort(devPort);
         if (await isAppAlreadyRunning(appUrl)) {
             this.error([
@@ -160,6 +158,12 @@ export default class SourceDev extends Command {
         }
         printInfo(`Starting NocoBase dev mode for "${runtime.envName}" from ${runtime.projectRoot}. Press Ctrl+C to stop.`);
         try {
+            await ensureNpmSourceDevDependencies(runtime, {
+                onStartTask: startTask,
+                onSucceedTask: succeedTask,
+                onFailTask: failTask,
+                verbose: true,
+            });
             await ensureLocalPostinstall(runtime, {
                 onStartTask: startTask,
                 onSucceedTask: succeedTask,

package/dist/lib/app-managed-resources.js

@@ -6,7 +6,9 @@
  * 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 { mkdir, readdir } from 'node:fs/promises';
+import { existsSync } from 'node:fs';
+import path from 'node:path';
+import { mkdir, readFile, readdir, writeFile } from 'node:fs/promises';
 import { resolveAppPublicPath } from './app-public-path.js';
 import { dockerContainerExists, managedAppLifecycleEnvVars, runLocalNocoBaseCommand, startDockerContainer, } from './app-runtime.js';
 import { deriveBuiltinDbConnection, resolveBuiltinDbConnection } from './builtin-db.js';
@@ -91,6 +93,15 @@ function formatLocalPostinstallFailure(envName, message) {
         `Details: ${message}`,
     ].join('\n');
 }
+function formatNpmSourceDevDependenciesFailure(envName, projectRoot, message) {
+    return [
+        `Couldn't prepare source dev dependencies for "${envName}".`,
+        '`nb source dev` requires @nocobase/devtools in npm source envs.',
+        `Source directory: ${projectRoot}`,
+        `Run \`cd ${projectRoot} && yarn install\` after fixing package.json, then try again.`,
+        `Details: ${message}`,
+    ].join('\n');
+}
 function formatSavedDockerSettingsIncomplete(envName, missing) {
     return [
         `Can't start NocoBase for "${envName}" yet.`,
@@ -115,6 +126,45 @@ async function localProjectHasFiles(projectRoot) {
         return false;
     }
 }
+function isRecord(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}
+async function readPackageJson(projectRoot) {
+    const packageJsonPath = path.join(projectRoot, 'package.json');
+    const content = await readFile(packageJsonPath, 'utf-8');
+    const parsed = JSON.parse(content);
+    if (!isRecord(parsed)) {
+        throw new Error(`${packageJsonPath} must contain a JSON object.`);
+    }
+    return parsed;
+}
+function getStringDependency(packageJson, section, packageName) {
+    const dependencies = packageJson[section];
+    if (!isRecord(dependencies)) {
+        return undefined;
+    }
+    const version = dependencies[packageName];
+    return typeof version === 'string' && version.trim() ? version.trim() : undefined;
+}
+function ensureDevDependencies(packageJson) {
+    const devDependencies = packageJson.devDependencies;
+    if (devDependencies === undefined) {
+        const next = {};
+        packageJson.devDependencies = next;
+        return next;
+    }
+    if (!isRecord(devDependencies)) {
+        throw new Error('package.json devDependencies must be an object.');
+    }
+    return devDependencies;
+}
+function hasNpmSourceDevtools(projectRoot) {
+    return existsSync(path.join(projectRoot, 'node_modules', '@nocobase', 'devtools', 'package.json'));
+}
+function npmRegistryEnv(runtime) {
+    const npmRegistry = String(runtime.env.config?.npmRegistry ?? '').trim();
+    return npmRegistry ? { npm_config_registry: npmRegistry } : undefined;
+}
 export async function buildSavedDockerRunArgs(runtime, options) {
     const config = runtime.env.config ?? {};
     const storagePath = trimValue(resolveConfiguredStoragePath(config));
@@ -345,3 +395,43 @@ export async function ensureLocalPostinstall(runtime, options) {
         throw new Error(formatLocalPostinstallFailure(runtime.envName, error instanceof Error ? error.message : String(error)));
     }
 }
+export async function ensureNpmSourceDevDependencies(runtime, options) {
+    if (runtime.source !== 'npm') {
+        return;
+    }
+    let taskStarted = false;
+    try {
+        const packageJson = await readPackageJson(runtime.projectRoot);
+        const appVersion = getStringDependency(packageJson, 'dependencies', '@nocobase/app');
+        const devtoolsVersion = getStringDependency(packageJson, 'devDependencies', '@nocobase/devtools');
+        let updatedPackageJson = false;
+        if (!devtoolsVersion) {
+            if (!appVersion) {
+                throw new Error('Cannot determine @nocobase/devtools version because dependencies["@nocobase/app"] is missing.');
+            }
+            const devDependencies = ensureDevDependencies(packageJson);
+            devDependencies['@nocobase/devtools'] = appVersion;
+            updatedPackageJson = true;
+            await writeFile(path.join(runtime.projectRoot, 'package.json'), `${JSON.stringify(packageJson, null, 2)}\n`, 'utf-8');
+        }
+        const needsInstall = updatedPackageJson || !hasNpmSourceDevtools(runtime.projectRoot);
+        if (!needsInstall) {
+            return;
+        }
+        options?.onStartTask?.(`Preparing source dev dependencies for "${runtime.envName}"...`);
+        taskStarted = true;
+        await run('yarn', ['install'], {
+            cwd: runtime.projectRoot,
+            env: npmRegistryEnv(runtime),
+            errorName: 'yarn install',
+            stdio: commandStdio(options?.verbose),
+        });
+        options?.onSucceedTask?.(`Source dev dependencies are ready for "${runtime.envName}".`);
+    }
+    catch (error) {
+        if (taskStarted) {
+            options?.onFailTask?.(`Failed to prepare source dev dependencies for "${runtime.envName}".`);
+        }
+        throw new Error(formatNpmSourceDevDependenciesFailure(runtime.envName, runtime.projectRoot, error instanceof Error ? error.message : String(error)));
+    }
+}

package/dist/lib/auth-store.js

@@ -123,13 +123,19 @@ function normalizeAuthConfig(config) {
                     },
                 }
                 : {}),
-            ...(settings.bin?.docker || settings.bin?.caddy || settings.bin?.git || settings.bin?.nginx || settings.bin?.yarn
+            ...(settings.bin?.docker ||
+                settings.bin?.caddy ||
+                settings.bin?.git ||
+                settings.bin?.nginx ||
+                settings.bin?.pnpm ||
+                settings.bin?.yarn
                 ? {
                     bin: {
                         ...(settings.bin?.docker ? { docker: normalizeOptionalString(settings.bin.docker) } : {}),
                         ...(settings.bin?.caddy ? { caddy: normalizeOptionalString(settings.bin.caddy) } : {}),
                         ...(settings.bin?.git ? { git: normalizeOptionalString(settings.bin.git) } : {}),
                         ...(settings.bin?.nginx ? { nginx: normalizeOptionalString(settings.bin.nginx) } : {}),
+                        ...(settings.bin?.pnpm ? { pnpm: normalizeOptionalString(settings.bin.pnpm) } : {}),
                         ...(settings.bin?.yarn ? { yarn: normalizeOptionalString(settings.bin.yarn) } : {}),
                     },
                 }

package/dist/lib/cli-config.js

@@ -16,6 +16,7 @@ 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 DEFAULT_PNPM_BIN = 'pnpm';
 export const PROXY_PROVIDER_OPTIONS = ['nginx', 'caddy'];
 export const DEFAULT_PROXY_PROVIDER = 'nginx';
 export const NGINX_PROXY_DRIVER_OPTIONS = ['local', 'docker'];
@@ -40,6 +41,7 @@ export const SUPPORTED_CLI_CONFIG_KEYS = [
     'bin.caddy',
     'bin.git',
     'bin.nginx',
+    'bin.pnpm',
     'proxy.nb-cli-root',
     'proxy.caddy-driver',
     'proxy.nginx-driver',
@@ -136,6 +138,7 @@ function pruneSettings(config) {
         !trimValue(bin.caddy) &&
         !trimValue(bin.git) &&
         !trimValue(bin.nginx) &&
+        !trimValue(bin.pnpm) &&
         !trimValue(bin.yarn)) {
         delete config.settings?.bin;
     }
@@ -187,6 +190,8 @@ export function getExplicitCliConfigValue(config, key) {
             return trimValue(config.settings?.bin?.git);
         case 'bin.nginx':
             return trimValue(config.settings?.bin?.nginx);
+        case 'bin.pnpm':
+            return trimValue(config.settings?.bin?.pnpm);
         case 'proxy.nb-cli-root':
             return trimValue(config.settings?.proxy?.nbCliRoot);
         case 'proxy.caddy-driver':
@@ -233,6 +238,8 @@ export function getEffectiveCliConfigValue(config, key) {
             return DEFAULT_GIT_BIN;
         case 'bin.nginx':
             return DEFAULT_NGINX_BIN;
+        case 'bin.pnpm':
+            return DEFAULT_PNPM_BIN;
         case 'proxy.nb-cli-root':
             return explicit ?? resolveCliHomeRoot();
         case 'proxy.caddy-driver':
@@ -387,6 +394,12 @@ export async function setCliConfigValue(key, value, options = {}) {
                 nginx: normalized,
             };
             break;
+        case 'bin.pnpm':
+            config.settings.bin = {
+                ...(config.settings.bin ?? {}),
+                pnpm: normalized,
+            };
+            break;
         case 'proxy.nb-cli-root':
             config.settings.proxy = {
                 ...(config.settings.proxy ?? {}),
@@ -496,6 +509,11 @@ export async function deleteCliConfigValue(key, options = {}) {
                 delete config.settings.bin.nginx;
             }
             break;
+        case 'bin.pnpm':
+            if (config.settings.bin) {
+                delete config.settings.bin.pnpm;
+            }
+            break;
         case 'proxy.nb-cli-root':
             if (config.settings.proxy) {
                 delete config.settings.proxy.nbCliRoot;
@@ -556,6 +574,7 @@ const CONFIGURABLE_COMMAND_KEYS = {
     caddy: 'bin.caddy',
     git: 'bin.git',
     nginx: 'bin.nginx',
+    pnpm: 'bin.pnpm',
     yarn: 'bin.yarn',
 };
 export function isConfigurableCommandName(value) {

package/dist/lib/run-npm.js

@@ -44,6 +44,10 @@ const MISSING_COMMAND_SPECS = {
         displayName: 'Yarn',
         configKey: 'bin.yarn',
     },
+    pnpm: {
+        displayName: 'pnpm',
+        configKey: 'bin.pnpm',
+    },
 };
 const DOCKER_DAEMON_UNAVAILABLE_PATTERNS = [
     /cannot connect to the docker daemon/i,

package/dist/lib/self-manager.js

@@ -108,19 +108,34 @@ function readCurrentVersion(packageRoot) {
     const pkg = JSON.parse(content);
     return String(pkg.version ?? '').trim();
 }
-function detectInstallMethod(packageRoot, globalPrefix) {
+function detectInstallMethod(packageRoot, options = {}) {
     if (fs.existsSync(path.join(packageRoot, 'src'))
         && fs.existsSync(path.join(packageRoot, 'tsconfig.json'))) {
         return 'source';
     }
-    if (globalPrefix && isSubPath(globalPrefix, packageRoot)) {
+    if (options.globalPrefix && isSubPath(options.globalPrefix, packageRoot)) {
         return 'npm-global';
     }
+    if (options.yarnGlobalDir && isSubPath(options.yarnGlobalDir, packageRoot)) {
+        return 'yarn-global';
+    }
+    if (isPnpmGlobalPath(packageRoot)) {
+        return 'pnpm-global';
+    }
     if (packageRoot.includes(`${path.sep}node_modules${path.sep}`)) {
         return 'package-local';
     }
     return 'unknown';
 }
+function isPnpmGlobalPath(packageRoot) {
+    const normalized = normalizePath(packageRoot);
+    const segments = normalized.split(path.sep).filter(Boolean);
+    const globalIndex = segments.findIndex((segment, index) => segment === 'global' && segments[index - 1] === 'pnpm');
+    if (globalIndex === -1) {
+        return false;
+    }
+    return segments.slice(globalIndex + 2).includes('node_modules');
+}
 function getInstallMethodCacheFile() {
     return path.join(resolveCliHomeDir('global'), INSTALL_METHOD_CACHE_FILE);
 }
@@ -163,6 +178,16 @@ async function readGlobalPrefix(commandOutputFn) {
         return undefined;
     }
 }
+async function readYarnGlobalDir(commandOutputFn) {
+    try {
+        return (await commandOutputFn('yarn', ['global', 'dir'], {
+            errorName: 'yarn global dir',
+        })).trim();
+    }
+    catch {
+        return undefined;
+    }
+}
 async function readDistTags(packageName, commandOutputFn) {
     const output = await commandOutputFn('npm', ['view', packageName, 'dist-tags', '--json'], {
         errorName: 'npm view',
@@ -174,21 +199,21 @@ function getUnsupportedSelfUpdateReason(installMethod) {
     if (installMethod === 'source') {
         return [
             'This CLI is running from source in a repository checkout.',
-            'Automatic self-update is only supported for standard global npm installs.',
+            'Automatic self-update is only supported for standard global npm, pnpm, or yarn installs.',
             'Upgrade this checkout through your repo workflow instead.',
         ].join(' ');
     }
     if (installMethod === 'package-local') {
         return [
             'This CLI is installed from a local project dependency tree.',
-            'Automatic self-update is only supported for standard global npm installs.',
+            'Automatic self-update is only supported for standard global npm, pnpm, or yarn installs.',
             'Upgrade the parent project dependency that provides this CLI instead.',
         ].join(' ');
     }
     if (installMethod === 'unknown') {
         return [
-            'This CLI install could not be recognized as a standard global npm install.',
-            'Automatic self-update is only supported for standard global npm installs.',
+            'This CLI install could not be recognized as a standard global npm, pnpm, or yarn install.',
+            'Automatic self-update is only supported for standard global npm, pnpm, or yarn installs.',
         ].join(' ');
     }
     return undefined;
@@ -220,11 +245,17 @@ export async function inspectSelfInstall(options = {}) {
     const commandOutputFn = options.commandOutputFn ?? commandOutput;
     const cachedInstallMethod = await readCachedInstallMethod(packageRoot);
     const globalPrefix = cachedInstallMethod?.globalPrefix ?? await readGlobalPrefix(commandOutputFn);
-    const installMethod = cachedInstallMethod?.installMethod ?? detectInstallMethod(packageRoot, globalPrefix);
+    const yarnGlobalDir = cachedInstallMethod?.yarnGlobalDir ?? await readYarnGlobalDir(commandOutputFn);
+    const installMethod = cachedInstallMethod?.installMethod
+        ?? detectInstallMethod(packageRoot, {
+            globalPrefix,
+            yarnGlobalDir,
+        });
     if (!cachedInstallMethod) {
         await writeCachedInstallMethod(packageRoot, {
             installMethod,
             globalPrefix,
+            yarnGlobalDir,
         });
     }
     return {
@@ -261,7 +292,7 @@ export async function inspectSelfStatus(options = {}) {
         latestVersion,
         updateAvailable,
         installMethod,
-        updatable: installMethod === 'npm-global',
+        updatable: installMethod === 'npm-global' || installMethod === 'pnpm-global' || installMethod === 'yarn-global',
         updateBlockedReason: getUnsupportedSelfUpdateReason(installMethod),
         globalPrefix,
         registryError,
@@ -270,9 +301,30 @@ export async function inspectSelfStatus(options = {}) {
 export function formatUnsupportedSelfUpdateMessage(status) {
     return status.updateBlockedReason
         ?? [
-            'Automatic self-update is only supported for standard global npm installs.',
+            'Automatic self-update is only supported for standard global npm, pnpm, or yarn installs.',
         ].join('\n');
 }
+function resolveSelfUpdateInstallCommand(installMethod, packageSpec) {
+    if (installMethod === 'pnpm-global') {
+        return {
+            command: 'pnpm',
+            args: ['add', '-g', packageSpec],
+            errorName: 'pnpm add',
+        };
+    }
+    if (installMethod === 'yarn-global') {
+        return {
+            command: 'yarn',
+            args: ['global', 'add', packageSpec],
+            errorName: 'yarn global add',
+        };
+    }
+    return {
+        command: 'npm',
+        args: ['install', '-g', packageSpec],
+        errorName: 'npm install',
+    };
+}
 export async function updateSelf(options = {}) {
     const status = await inspectSelfStatus(options);
     if (!status.updatable) {
@@ -291,9 +343,10 @@ export async function updateSelf(options = {}) {
         };
     }
     const packageSpec = getSelfUpdatePackageSpec(status);
-    await (options.runFn ?? run)('npm', ['install', '-g', packageSpec], {
+    const installCommand = resolveSelfUpdateInstallCommand(status.installMethod, packageSpec);
+    await (options.runFn ?? run)(installCommand.command, installCommand.args, {
         stdio: options.verbose ? 'inherit' : 'ignore',
-        errorName: 'npm install',
+        errorName: installCommand.errorName,
     });
     return {
         action: 'updated',

package/dist/lib/startup-update.js

@@ -151,7 +151,7 @@ export async function shouldRunStartupUpdateCheck(argv, now = new Date()) {
     return readCurrentInstallLastCheckedDate(state) !== todayStamp(now);
 }
 export function shouldEnableStartupUpdateForInstallMethod(installMethod) {
-    return installMethod === 'npm-global';
+    return installMethod === 'npm-global' || installMethod === 'pnpm-global' || installMethod === 'yarn-global';
 }
 function hasPendingUpdates(selfStatus, skillsStatus) {
     return Boolean(selfStatus.updateAvailable || skillsStatus.updateAvailable === true);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/cli",
-  "version": "2.1.10",
+  "version": "2.1.11-test.1",
   "description": "NocoBase Command Line Tool",
   "type": "module",
   "main": "dist/generated/command-registry.js",
@@ -142,6 +142,5 @@
   "repository": {
     "type": "git",
     "url": "git+https://github.com/nocobase/nocobase.git"
-  },
-  "gitHead": "65d5bc38d72d5a6fca8bcf9798a0b976e382cac9"
+  }
 }