@nocobase/cli 3.0.0-alpha.5 → 3.0.0-alpha.6

package/dist/lib/portal-source.js

@@ -15,9 +15,11 @@ import * as tar from 'tar';
 import { executeApiRequest } from './api-client.js';
 import { translateCli } from './cli-locale.js';
 import { ensurePortalBuildHtmlReadsEnvOnly } from './portal-build-html.js';
-import { buildPortalConfig, buildPortalConfigFromOptions, DEFAULT_PORTAL_GIT_PATH, readPortalConfig, syncPortalConfigToRemote, writePortalConfig, } from './portal-config.js';
+import { buildPortalConfig, buildPortalConfigFromOptions, DEFAULT_PORTAL_GIT_PATH, } from './portal-config.js';
 import { buildPortalCommandEnv } from './portal-command-env.js';
-import { buildPortalBasePath, resolvePortalAppContext, resolvePortalStoragePath, validatePortalSlug, } from './portal-create.js';
+import { canReplacePortalDirectory } from './portal-path-safety.js';
+import { updatePortalEnvFiles } from './portal-env-files.js';
+import { buildPortalBasePath, resolvePortalAppContext, resolvePortalDeployPath, resolvePortalSourcePath, resolveSavedPortalSourcePath, resolvePortalStoragePath, validatePortalSlug, } from './portal-create.js';
 import { listPortalWorkspaces } from './portal-list.js';
 import { findPortalListItem } from './portal-info.js';
 import { resolvePnpmInstallCommand, run, runPnpmInstallCommand } from './run-npm.js';
@@ -144,10 +146,10 @@ async function replaceExistingPortalDirectory(params) {
     await rm(params.sourceDir, { recursive: true, force: true });
 }
 async function replacePortalSourceFromArchive(params) {
-    const targetExists = await pathExists(params.portalDir);
-    if (targetExists && !params.force) {
-        throw new Error(portalSourceText('errors.workspaceExists', { portalDir: params.portalDir }, `Portal already exists: ${params.portalDir}\nPass --force to delete it and pull again.`));
-    }
+    const targetExists = await assertPortalDirectoryCanBeReplaced({
+        portalDir: params.portalDir,
+        force: params.force,
+    });
     const parentDir = path.dirname(params.portalDir);
     const tempDir = await mkdtemp(path.join(parentDir, `.${path.basename(params.portalDir)}-pull-`));
     try {
@@ -172,10 +174,10 @@ async function replacePortalSourceFromArchive(params) {
     }
 }
 async function replacePortalSourceFromDirectory(params) {
-    const targetExists = await pathExists(params.portalDir);
-    if (targetExists && !params.force) {
-        throw new Error(portalSourceText('errors.workspaceExists', { portalDir: params.portalDir }, `Portal already exists: ${params.portalDir}\nPass --force to delete it and pull again.`));
-    }
+    const targetExists = await assertPortalDirectoryCanBeReplaced({
+        portalDir: params.portalDir,
+        force: params.force,
+    });
     const parentDir = path.dirname(params.portalDir);
     const tempDir = await mkdtemp(path.join(parentDir, `.${path.basename(params.portalDir)}-pull-`));
     try {
@@ -202,6 +204,9 @@ async function assertPortalDirectoryCanBeReplaced(params) {
     if (targetExists && !params.force) {
         throw new Error(portalSourceText('errors.workspaceExists', { portalDir: params.portalDir }, `Portal already exists: ${params.portalDir}\nPass --force to delete it and pull again.`));
     }
+    if (targetExists && params.force && !(await canReplacePortalDirectory(params.portalDir))) {
+        throw new Error(portalSourceText('errors.workspaceNotReplaceable', { portalDir: params.portalDir }, `Refusing to replace a non-portal directory: ${params.portalDir}`));
+    }
     return targetExists;
 }
 async function runGit(args, cwd) {
@@ -265,7 +270,11 @@ async function resolvePortalSourceContext(options) {
     const mode = options.env.kind;
     const appContext = await resolvePortalAppContext(options);
     const { app, appPublicPath, portalBaseApp } = appContext;
-    const portalDir = path.join(storagePath, 'portals', app, portal);
+    const portalDeployDir = resolvePortalDeployPath({ storagePath, app, portal });
+    const portalDir = options.sourcePath
+        ? resolvePortalSourcePath(portal, options.sourcePath)
+        : resolveSavedPortalSourcePath(options.env, portal) ??
+            (options.defaultSourcePath ? resolvePortalSourcePath(portal) : portalDeployDir);
     const portalBase = buildPortalBasePath({ app: portalBaseApp ?? app, appPublicPath, portal });
     if (mode !== 'local' && mode !== 'docker' && mode !== 'http') {
         throw new Error(portalSourceText('errors.unsupportedEnvKind', { kind: mode }, `Cannot sync portal source for ${mode} envs in the first version.`));
@@ -286,6 +295,7 @@ async function resolvePortalSourceContext(options) {
         portal,
         portalDir,
         portalBase,
+        apiBaseUrl,
         mode,
         sourceStorage: item.sourceStorage || 'nocobase',
         gitRepo: item.gitRepo,
@@ -316,6 +326,25 @@ function applyPortalConfigToContext(context, config) {
         gitPath: config.git?.path ?? DEFAULT_PORTAL_GIT_PATH,
     };
 }
+function getTemporaryGitPortalConfig(options) {
+    const gitRepo = trimValue(options.gitRepo);
+    if (!gitRepo) {
+        if (trimValue(options.gitBranch) || trimValue(options.gitPath)) {
+            throw new Error(portalSourceText('errors.gitRepoRequiredForTemporaryPull', undefined, [
+                '--git-branch and --git-path require --git-repo for a temporary Git pull.',
+                'To update the portal configuration, use `nb portal config`.',
+            ].join(' ')));
+        }
+        return undefined;
+    }
+    return buildPortalConfig({
+        portal: options.portal,
+        sourceStorage: 'git',
+        gitRepo,
+        gitBranch: options.gitBranch,
+        gitPath: options.gitPath,
+    });
+}
 function assertGitSourceConfig(context) {
     if (!context.gitRepo) {
         throw new Error(portalSourceText('errors.gitRepoMissing', { portal: context.portal }, `Portal "${context.portal}" uses Git source storage, but gitRepo is missing.`));
@@ -495,8 +524,11 @@ async function pushGitPortalSource(params) {
     }
 }
 export async function pullPortalSource(options) {
-    const context = await resolvePortalSourceContext(options);
-    const portalConfig = buildPortalConfigFromContext(context);
+    const context = await resolvePortalSourceContext({
+        ...options,
+        defaultSourcePath: true,
+    });
+    const portalConfig = getTemporaryGitPortalConfig(options) ?? buildPortalConfigFromContext(context);
     const sourceContext = applyPortalConfigToContext(context, portalConfig);
     if (sourceContext.sourceStorage === 'git') {
         await pullGitPortalSource({
@@ -504,7 +536,11 @@ export async function pullPortalSource(options) {
             force: options.force,
         });
         await ensurePortalBuildHtmlReadsEnvOnly(sourceContext.portalDir);
-        await writePortalConfig(sourceContext.portalDir, portalConfig);
+        await updatePortalEnvFiles({
+            portalDir: sourceContext.portalDir,
+            apiBaseUrl: sourceContext.apiBaseUrl,
+            portalBase: sourceContext.portalBase,
+        });
         const installResult = await installPortalDependencies({
             portalDir: sourceContext.portalDir,
             installDependencies: options.installDependencies,
@@ -519,15 +555,6 @@ export async function pullPortalSource(options) {
     if (sourceContext.sourceStorage !== 'nocobase') {
         throw new Error(portalSourceText('errors.unsupportedSourceStorage', { sourceStorage: sourceContext.sourceStorage }, `Unsupported portal source storage: ${sourceContext.sourceStorage}`));
     }
-    if (sourceContext.mode === 'local' || sourceContext.mode === 'docker') {
-        return {
-            ...sourceContext,
-            changed: false,
-            noopReason: sourceContext.mode === 'local'
-                ? portalSourceText('messages.localPullNoop', undefined, 'Portal source is already local.')
-                : portalSourceText('messages.dockerPullNoop', undefined, 'Portal source is already available through the Docker volume.'),
-        };
-    }
     const tempDir = await mkdtemp(path.join(os.tmpdir(), 'nocobase-cli-portal-pull-'));
     const archivePath = path.join(tempDir, 'source.tar.gz');
     const apiRequest = options.apiRequest ?? executeApiRequest;
@@ -552,7 +579,11 @@ export async function pullPortalSource(options) {
             force: options.force,
         });
         await ensurePortalBuildHtmlReadsEnvOnly(sourceContext.portalDir);
-        await writePortalConfig(sourceContext.portalDir, portalConfig);
+        await updatePortalEnvFiles({
+            portalDir: sourceContext.portalDir,
+            apiBaseUrl: sourceContext.apiBaseUrl,
+            portalBase: sourceContext.portalBase,
+        });
         const installResult = await installPortalDependencies({
             portalDir: sourceContext.portalDir,
             installDependencies: options.installDependencies,
@@ -569,19 +600,14 @@ export async function pullPortalSource(options) {
     }
 }
 export async function pushPortalSource(options) {
-    const context = await resolvePortalSourceContext(options);
+    const context = await resolvePortalSourceContext({
+        ...options,
+        defaultSourcePath: true,
+    });
     if (!(await pathExists(context.portalDir))) {
         throw new Error(portalSourceText('errors.workspaceMissing', { portalDir: context.portalDir, portal: context.portal }, `Portal does not exist: ${context.portalDir}\nRun \`nb portal create ${context.portal}\` first.`));
     }
-    const portalConfig = await readPortalConfig(context.portalDir);
-    await syncPortalConfigToRemote({
-        portal: context.portal,
-        config: portalConfig,
-        currentOptions: context.options,
-        envName: options.envName,
-        cliVersion: options.cliVersion,
-        apiRequest: options.apiRequest,
-    });
+    const portalConfig = buildPortalConfigFromContext(context);
     const sourceContext = applyPortalConfigToContext(context, portalConfig);
     if (sourceContext.sourceStorage === 'git') {
         const revision = await pushGitPortalSource({
@@ -600,15 +626,6 @@ export async function pushPortalSource(options) {
     if (sourceContext.sourceStorage !== 'nocobase') {
         throw new Error(portalSourceText('errors.unsupportedSourceStorage', { sourceStorage: sourceContext.sourceStorage }, `Unsupported portal source storage: ${sourceContext.sourceStorage}`));
     }
-    if (sourceContext.mode === 'local' || sourceContext.mode === 'docker') {
-        return {
-            ...sourceContext,
-            changed: false,
-            noopReason: sourceContext.mode === 'local'
-                ? portalSourceText('messages.localPushNoop', undefined, 'Portal source is already local.')
-                : portalSourceText('messages.dockerPushNoop', undefined, 'Portal source is already available through the Docker volume.'),
-        };
-    }
     const archive = await packPortalSource(sourceContext.portalDir);
     const apiRequest = options.apiRequest ?? executeApiRequest;
     try {

package/dist/locale/en-US.json

@@ -89,6 +89,9 @@
       "lowerCaseTableNamesRequiresUnderscored": "MySQL lower_case_table_names=1 requires DB_UNDERSCORED=true."
     }
   },
+  "apiClient": {
+    "authRequiredHint": "Authentication failed or the saved session has expired. Run `{{command}}` to sign in again."
+  },
   "commands": {
     "envAdd": {
       "prompts": {
@@ -185,11 +188,12 @@
         "missingApiBaseUrl": "Cannot create a portal because the selected env has no apiBaseUrl.",
         "outsideParent": "Refusing to modify a portal outside {{parentDir}}: {{portalDir}}",
         "sshUnsupported": "Cannot create a portal for ssh envs in the first version.",
-        "workspaceExists": "Portal already exists: {{portalDir}}\nPass --force to delete it and create a new portal."
+        "workspaceExists": "Portal already exists: {{portalDir}}\nPass --force to delete it and create a new portal.",
+        "workspaceNotReplaceable": "Refusing to replace a non-portal directory: {{portalDir}}\nThe target directory must be empty or contain package.json with a nocobase field."
       },
       "messages": {
         "skipInstall": "Skipped pnpm install because package.json was not found in {{portalDir}}.",
-        "created": "Portal \"{{portal}}\" created at {{portalDir}}.",
+        "created": "Portal \"{{portal}}\" created at {{portalDir}}",
         "app": "App: {{app}}",
         "base": "Base: {{base}}",
         "sourceStorage": "Source storage: {{sourceStorage}}",
@@ -210,11 +214,12 @@
       "errors": {
         "envNotConfigured": "Env \"{{envName}}\" is not configured. Run `nb env add {{envName}} --api-base-url <url>` first.",
         "noEnvConfigured": "No NocoBase env is configured yet. Run `nb init --ui` to create one first.",
-        "noChanges": "No portal configuration changes were provided. Pass --source-storage or a --git-* flag.",
-        "workspaceMissing": "Portal does not exist: {{portalDir}}\nRun `nb portal create {{portal}}` or `nb portal pull {{portal}}` first."
+        "noChanges": "No portal configuration changes were provided. Pass --path, --source-storage, or a --git-* flag.",
+        "notFound": "Portal \"{{portal}}\" was not found. Run `nb portal list` to see available portals."
       },
       "messages": {
-        "updated": "Portal \"{{portal}}\" configuration updated at {{portalDir}}/portal.config.json.",
+        "updated": "Portal \"{{portal}}\" configuration updated.",
+        "pathUpdated": "Development path: {{portalDir}}",
         "remoteSynced": "Remote portal record: synced",
         "remoteSkipped": "Remote portal record: not found; local config only"
       }
@@ -255,22 +260,28 @@
         "name": "Name",
         "url": "URL",
         "portalType": "Portal type",
-        "path": "Local path",
+        "path": "Development path",
         "enabled": "Enabled",
-        "localSynced": "Local synced"
+        "default": "Default"
       }
     },
     "portalPull": {
       "errors": {
         "envNotConfigured": "Env \"{{envName}}\" is not configured. Run `nb env add {{envName}} --api-base-url <url>` first.",
-        "noEnvConfigured": "No NocoBase env is configured yet. Run `nb init --ui` to create one first."
+        "noEnvConfigured": "No NocoBase env is configured yet. Run `nb init --ui` to create one first.",
+        "gitRepoRequiredForTemporaryPull": "--git-branch and --git-path require --git-repo for a temporary Git pull. To update the portal configuration, use `nb portal config`."
       },
       "messages": {
         "noop": "No pull is needed.",
-        "pulled": "Pulled portal source \"{{portal}}\" into {{portalDir}}.",
+        "pulled": "Pulled portal source \"{{portal}}\" into {{portalDir}}",
         "installFailed": "Dependency installation did not finish successfully. Run `pnpm install` manually in {{portalDir}}."
       }
     },
+    "portalSource": {
+      "errors": {
+        "workspaceNotReplaceable": "Refusing to replace a non-portal directory: {{portalDir}}\nThe target directory must be empty or contain package.json with a nocobase field."
+      }
+    },
     "swagger": {
       "errors": {
         "pluginDisabled": "The API documentation plugin is not enabled. Enable it before requesting Swagger documents.",
@@ -307,9 +318,9 @@
         "name": "Name",
         "url": "URL",
         "portalType": "Portal type",
-        "path": "Local path",
-        "enabled": "Enabled",
-        "localSynced": "Local synced"
+        "developmentPath": "Development path",
+        "deploymentPath": "Deployment path",
+        "enabled": "Enabled"
       }
     },
     "portalDestroy": {
@@ -318,12 +329,18 @@
         "noEnvConfigured": "No NocoBase env is configured yet. Run `nb init --ui` to create one first.",
         "confirmationRequired": "Refusing to destroy a portal in non-interactive mode without --yes.",
         "outsideParent": "Refusing to delete a portal outside {{parentDir}}: {{portalDir}}",
-        "workspaceMissing": "Portal does not exist: {{portalDir}}\nPass --force to ignore missing local files.",
+        "workspaceMissing": "Portal deployment path does not exist: {{portalDir}}\nPass --force to ignore missing deployment files.",
         "unsupportedEnvKind": "Cannot destroy a portal for {{kind}} envs in the first version.",
+        "unsafeDevelopmentPath": "Refusing to delete an unsafe portal development path: {{portalDir}}",
         "recordDestroyFailed": "Portal record destroy failed with status {{status}}\n{{details}}"
       },
       "prompts": {
-        "confirm": "Destroy portal \"{{portal}}\" and delete its storage directory?"
+        "confirm": "Destroy portal \"{{portal}}\" and delete its deployment directory?"
+      },
+      "statuses": {
+        "deleted": "deleted",
+        "missing": "missing",
+        "retained": "retained"
       },
       "messages": {
         "destroyed": "Portal \"{{portal}}\" destroyed.",
@@ -331,7 +348,9 @@
         "app": "App: {{app}}",
         "base": "Base: {{base}}",
         "record": "Record: {{status}}",
-        "workspace": "Portal files: {{status}} ({{dir}})"
+        "deploymentPath": "Deployment path: {{status}} ({{dir}})",
+        "developmentPath": "Development path: {{status}} ({{dir}})",
+        "developmentPathMissing": "Development path: missing"
       }
     },
     "portalDev": {

package/dist/locale/zh-CN.json

@@ -89,6 +89,9 @@
       "lowerCaseTableNamesRequiresUnderscored": "当 MySQL 的 lower_case_table_names=1 时，必须设置 DB_UNDERSCORED=true。"
     }
   },
+  "apiClient": {
+    "authRequiredHint": "认证失败或已保存的登录状态已过期。请运行 `{{command}}` 重新认证。"
+  },
   "commands": {
     "envAdd": {
       "prompts": {
@@ -185,11 +188,12 @@
         "missingApiBaseUrl": "无法创建 Portal，因为当前 env 没有 apiBaseUrl。",
         "outsideParent": "拒绝修改 {{parentDir}} 之外的 Portal：{{portalDir}}",
         "sshUnsupported": "第一版暂不支持为 ssh env 创建 Portal。",
-        "workspaceExists": "Portal 已存在：{{portalDir}}\n如需删除并重新创建，请追加 --force。"
+        "workspaceExists": "Portal 已存在：{{portalDir}}\n如需删除并重新创建，请追加 --force。",
+        "workspaceNotReplaceable": "拒绝替换非 Portal 目录：{{portalDir}}\n目标目录必须为空，或包含带 nocobase 字段的 package.json。"
       },
       "messages": {
         "skipInstall": "未找到 {{portalDir}}/package.json，已跳过 pnpm install。",
-        "created": "Portal \"{{portal}}\" 已创建：{{portalDir}}。",
+        "created": "Portal \"{{portal}}\" 已创建：{{portalDir}}",
         "app": "App：{{app}}",
         "base": "Base：{{base}}",
         "sourceStorage": "源码存储：{{sourceStorage}}",
@@ -210,11 +214,12 @@
       "errors": {
         "envNotConfigured": "env \"{{envName}}\" 尚未配置。请先运行 `nb env add {{envName}} --api-base-url <url>`。",
         "noEnvConfigured": "还没有配置 NocoBase env。请先运行 `nb init --ui` 创建一个。",
-        "noChanges": "没有提供 Portal 配置变更。请传入 --source-storage 或 --git-* 参数。",
-        "workspaceMissing": "Portal 不存在：{{portalDir}}\n请先运行 `nb portal create {{portal}}` 或 `nb portal pull {{portal}}`。"
+        "noChanges": "没有提供 Portal 配置变更。请传入 --path、--source-storage 或 --git-* 参数。",
+        "notFound": "Portal \"{{portal}}\" 不存在。请运行 `nb portal list` 查看可用 Portal。"
       },
       "messages": {
-        "updated": "Portal \"{{portal}}\" 配置已更新：{{portalDir}}/portal.config.json。",
+        "updated": "Portal \"{{portal}}\" 配置已更新。",
+        "pathUpdated": "开发路径：{{portalDir}}",
         "remoteSynced": "远端 Portal 记录：已同步",
         "remoteSkipped": "远端 Portal 记录：未找到，仅更新本地配置"
       }
@@ -255,22 +260,28 @@
         "name": "名称",
         "url": "访问 URL",
         "portalType": "Portal 类型",
-        "path": "本地路径",
+        "path": "开发路径",
         "enabled": "启用",
-        "localSynced": "本地已同步"
+        "default": "默认"
       }
     },
     "portalPull": {
       "errors": {
         "envNotConfigured": "env \"{{envName}}\" 尚未配置。请先运行 `nb env add {{envName}} --api-base-url <url>`。",
-        "noEnvConfigured": "还没有配置 NocoBase env。请先运行 `nb init --ui` 创建一个。"
+        "noEnvConfigured": "还没有配置 NocoBase env。请先运行 `nb init --ui` 创建一个。",
+        "gitRepoRequiredForTemporaryPull": "--git-branch 和 --git-path 作为临时 Git pull 参数时必须同时提供 --git-repo。如需更新 Portal 配置，请使用 `nb portal config`。"
       },
       "messages": {
         "noop": "无需执行 pull。",
-        "pulled": "Portal 源码 \"{{portal}}\" 已拉取到 {{portalDir}}。",
+        "pulled": "Portal 源码 \"{{portal}}\" 已拉取到 {{portalDir}}",
         "installFailed": "依赖安装没有成功完成。请在 {{portalDir}} 中手动运行 `pnpm install`。"
       }
     },
+    "portalSource": {
+      "errors": {
+        "workspaceNotReplaceable": "拒绝替换非 Portal 目录：{{portalDir}}\n目标目录必须为空，或包含带 nocobase 字段的 package.json。"
+      }
+    },
     "swagger": {
       "errors": {
         "pluginDisabled": "API 文档插件尚未启用。请先启用该插件，再获取 Swagger 文档。",
@@ -307,9 +318,9 @@
         "name": "名称",
         "url": "访问 URL",
         "portalType": "Portal 类型",
-        "path": "本地路径",
-        "enabled": "启用",
-        "localSynced": "本地已同步"
+        "developmentPath": "开发路径",
+        "deploymentPath": "部署路径",
+        "enabled": "启用"
       }
     },
     "portalDestroy": {
@@ -318,12 +329,18 @@
         "noEnvConfigured": "还没有配置 NocoBase env。请先运行 `nb init --ui` 创建一个。",
         "confirmationRequired": "非交互模式下拒绝删除 Portal。请追加 --yes 后重试。",
         "outsideParent": "拒绝删除 {{parentDir}} 之外的 Portal：{{portalDir}}",
-        "workspaceMissing": "Portal 不存在：{{portalDir}}\n如需忽略本地文件缺失，请追加 --force。",
+        "workspaceMissing": "Portal 部署路径不存在：{{portalDir}}\n如需忽略部署文件缺失，请追加 --force。",
         "unsupportedEnvKind": "第一版暂不支持为 {{kind}} env 删除 Portal。",
+        "unsafeDevelopmentPath": "拒绝删除不安全的 Portal 开发路径：{{portalDir}}",
         "recordDestroyFailed": "Portal 记录删除失败，状态码 {{status}}\n{{details}}"
       },
       "prompts": {
-        "confirm": "删除 Portal \"{{portal}}\" 并移除它的 storage 目录？"
+        "confirm": "删除 Portal \"{{portal}}\" 并移除它的部署目录？"
+      },
+      "statuses": {
+        "deleted": "已删除",
+        "missing": "缺失",
+        "retained": "已保留"
       },
       "messages": {
         "destroyed": "Portal \"{{portal}}\" 已删除。",
@@ -331,7 +348,9 @@
         "app": "App：{{app}}",
         "base": "Base：{{base}}",
         "record": "记录：{{status}}",
-        "workspace": "Portal：{{status}}（{{dir}}）"
+        "deploymentPath": "部署路径：{{status}}（{{dir}}）",
+        "developmentPath": "开发路径：{{status}}（{{dir}}）",
+        "developmentPathMissing": "开发路径：缺失"
       }
     },
     "portalDev": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/cli",
-  "version": "3.0.0-alpha.5",
+  "version": "3.0.0-alpha.6",
   "description": "NocoBase Command Line Tool",
   "type": "module",
   "main": "dist/generated/command-registry.js",
@@ -147,5 +147,5 @@
     "type": "git",
     "url": "git+https://github.com/nocobase/nocobase.git"
   },
-  "gitHead": "82c7ed1cdb2f247c190582e34ee37f154cac0968"
+  "gitHead": "3508eabe683b9a47a28d0f3425098eb58873a9d7"
 }