@nocobase/cli-v1 2.2.0-alpha.1 → 2.2.0-alpha.2

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "@nocobase/cli-v1",
-  "version": "2.2.0-alpha.1",
+  "version": "2.2.0-alpha.2",
   "description": "",
   "license": "Apache-2.0",
   "main": "./src/index.js",
   "bin": {
+    "nocobase": "./bin/index.js",
     "nocobase-v1": "./bin/index.js"
   },
   "dependencies": {
-    "@nocobase/cli": "2.2.0-alpha.1",
+    "@nocobase/cli": "2.2.0-alpha.2",
     "@nocobase/license-kit": "^0.3.8",
-    "@nocobase/utils": "2.2.0-alpha.1",
+    "@nocobase/utils": "2.2.0-alpha.2",
     "chalk": "^4.1.1",
     "commander": "^9.2.0",
     "deepmerge": "^4.3.1",
@@ -25,7 +26,6 @@
     "tree-kill": "^1.2.2"
   },
   "devDependencies": {
-    "@nocobase/devtools": "2.2.0-alpha.1",
     "@types/fs-extra": "^11.0.1"
   },
   "repository": {
@@ -33,5 +33,5 @@
     "url": "git+https://github.com/nocobase/nocobase.git",
     "directory": "packages/core/cli"
   },
-  "gitHead": "303663aba6c6eefa27e6a6435b4c0352074ec40f"
+  "gitHead": "9dd5224bb8f6c1ac12d766b9f175bdc29bddd845"
 }

package/src/__tests__/app-dev-utils.test.js

@@ -82,6 +82,7 @@ describe('cli-v1 app-dev utils', () => {
       }),
     ).toEqual([
       'watch',
+      '--clear-screen=false',
       `--ignore=${path.resolve(process.cwd(), 'storage/plugins')}/**`,
       '--tsconfig',
       './tsconfig.server.json',

package/src/__tests__/build-index-html.test.js

@@ -24,6 +24,8 @@ function createAppPackageRoot() {
     [
       "window['__nocobase_app_dev__'] = {{env.NOCOBASE_APP_DEV}};",
       "window['__nocobase_public_path__'] = '{{env.APP_PUBLIC_PATH}}';",
+      "window['__nocobase_modern_client_prefix__'] = '{{env.APP_MODERN_CLIENT_PREFIX}}';",
+      "window['__nocobase_app_client_entry_mode__'] = '{{env.APP_CLIENT_ENTRY_MODE}}';",
     ].join('\n'),
     'utf-8',
   );
@@ -73,11 +75,43 @@ describe('cli-v1 buildIndexHtml', () => {
     process.env.APP_PACKAGE_ROOT = appRoot;
     process.env.APP_PUBLIC_PATH = '/';
     process.env.NOCOBASE_APP_DEV = '';
+    process.env.APP_MODERN_CLIENT_PREFIX = 'console';
+    process.env.APP_CLIENT_ENTRY_MODE = 'modern-default';
 
     buildIndexHtml();
 
     const html = fs.readFileSync(path.join(appRoot, 'dist/client/index.html'), 'utf-8');
     expect(html).toContain("window['__nocobase_app_dev__'] = false;");
+    expect(html).toContain("window['__nocobase_modern_client_prefix__'] = 'console';");
+    expect(html).toContain("window['__nocobase_app_client_entry_mode__'] = 'modern-default';");
+    fs.removeSync(appRoot);
+  });
+
+  test('refreshes cached tpl when new runtime placeholders are missing', () => {
+    const appRoot = createAppPackageRoot();
+    const tplPath = path.join(appRoot, 'dist/client/index.html.tpl');
+    const indexPath = path.join(appRoot, 'dist/client/index.html');
+    fs.writeFileSync(tplPath, "window['__nocobase_public_path__'] = '{{env.APP_PUBLIC_PATH}}';", 'utf-8');
+    fs.writeFileSync(
+      indexPath,
+      [
+        "window['__nocobase_public_path__'] = '{{env.APP_PUBLIC_PATH}}';",
+        "window['__nocobase_modern_client_prefix__'] = '{{env.APP_MODERN_CLIENT_PREFIX}}';",
+        "window['__nocobase_app_client_entry_mode__'] = '{{env.APP_CLIENT_ENTRY_MODE}}';",
+      ].join('\n'),
+      'utf-8',
+    );
+    process.argv = ['node', 'nocobase-v1', 'start'];
+    process.env.APP_PACKAGE_ROOT = appRoot;
+    process.env.APP_PUBLIC_PATH = '/';
+    process.env.APP_MODERN_CLIENT_PREFIX = 'v';
+    process.env.APP_CLIENT_ENTRY_MODE = 'modern-only';
+
+    buildIndexHtml();
+
+    const tpl = fs.readFileSync(tplPath, 'utf-8');
+    expect(tpl).toContain('__nocobase_modern_client_prefix__');
+    expect(tpl).toContain('__nocobase_app_client_entry_mode__');
     fs.removeSync(appRoot);
   });
 });

package/src/__tests__/dev-command.test.js

@@ -0,0 +1,61 @@
+/**
+ * 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.
+ */
+
+/* eslint-env jest */
+
+const { buildAppDevForwardArgs, forwardDevToAppDev, resolveDevRuntimeMode } = require('../commands/dev')._test;
+
+describe('cli-v1 dev command', () => {
+  test('buildAppDevForwardArgs rewrites dev argv to app-dev while preserving extra args', () => {
+    expect(
+      buildAppDevForwardArgs(['node', 'nocobase-v1', 'dev', '--rsbuild', '--port', '13000', '--inspect=9229']),
+    ).toEqual(['app-dev', '--rsbuild', '--port', '13000', '--inspect=9229']);
+  });
+
+  test('forwardDevToAppDev delegates to nocobase-v1 app-dev for create-app projects', async () => {
+    const calls = [];
+    const runCommand = async (...args) => {
+      calls.push(args);
+    };
+
+    await forwardDevToAppDev({
+      argv: ['node', 'nocobase-v1', 'dev', '--port', '13000', '--db-sync'],
+      runCommand,
+    });
+
+    expect(calls).toEqual([['nocobase-v1', ['app-dev', '--port', '13000', '--db-sync']]]);
+  });
+
+  test('resolveDevRuntimeMode keeps both clients in legacy-default', () => {
+    expect(resolveDevRuntimeMode({ appClientEntryMode: 'legacy-default' })).toMatchObject({
+      useModernOnlyEntryMode: false,
+      shouldRunClient: true,
+      shouldRunClientV2: true,
+      shouldRunServer: true,
+    });
+  });
+
+  test('resolveDevRuntimeMode only runs v2 client and server in modern-only', () => {
+    expect(resolveDevRuntimeMode({ appClientEntryMode: 'modern-only' })).toMatchObject({
+      useModernOnlyEntryMode: true,
+      shouldRunClient: false,
+      shouldRunClientV2: true,
+      shouldRunServer: true,
+    });
+  });
+
+  test('resolveDevRuntimeMode preserves explicit client-v2-only flag behavior', () => {
+    expect(resolveDevRuntimeMode({ clientV2Only: true, appClientEntryMode: 'legacy-default' })).toMatchObject({
+      useModernOnlyEntryMode: false,
+      shouldRunClient: false,
+      shouldRunClientV2: true,
+      shouldRunServer: false,
+    });
+  });
+});

package/src/__tests__/util.test.js

@@ -0,0 +1,33 @@
+/**
+ * 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.
+ */
+
+/* eslint-env jest */
+
+const { colorizedDevLogEnv, createRunWithPrefixLabel } = require('../util')._test;
+
+describe('cli-v1 util helpers', () => {
+  test('colorizedDevLogEnv enables color for dev child output by default', () => {
+    expect(colorizedDevLogEnv({})).toEqual({ FORCE_COLOR: '1' });
+  });
+
+  test('colorizedDevLogEnv keeps explicit FORCE_COLOR', () => {
+    expect(colorizedDevLogEnv({ FORCE_COLOR: '3' })).toEqual({ FORCE_COLOR: '3' });
+  });
+
+  test('colorizedDevLogEnv removes inherited NO_COLOR so dev logs stay colored', () => {
+    expect(colorizedDevLogEnv({ NO_COLOR: '1', TERM: 'dumb' })).toEqual({
+      FORCE_COLOR: '1',
+      TERM: 'dumb',
+    });
+  });
+
+  test('createRunWithPrefixLabel colorizes prefixed output even when the parent disables colors', () => {
+    expect(createRunWithPrefixLabel('client', 'cyan')).toBe('\u001b[36m[client]\u001b[39m');
+  });
+});

package/src/commands/app-dev-utils.js

@@ -150,7 +150,7 @@ function buildAppDevServerArgs({
   argv = process.argv,
   serverTsconfigPath = process.env.SERVER_TSCONFIG_PATH,
 } = {}) {
-  const args = ['watch', `--ignore=${resolvePluginStoragePath()}/**`];
+  const args = ['watch', '--clear-screen=false', `--ignore=${resolvePluginStoragePath()}/**`];
 
   if (serverTsconfigPath) {
     args.push('--tsconfig', serverTsconfigPath);

package/src/commands/dev.js

@@ -10,14 +10,17 @@ const _ = require('lodash');
 const { Command } = require('commander');
 const {
   generatePlugins,
+  hasCorePackages,
   run,
   runWithPrefix,
+  colorizedDevLogEnv,
   postCheck,
   nodeCheck,
   promptForTs,
   isPortReachable,
   buildWSURL,
   checkDBDialect,
+  resolveAppClientEntryMode,
 } = require('../util');
 const { getPortPromise } = require('portfinder');
 const chokidar = require('chokidar');
@@ -41,6 +44,33 @@ async function buildBundleStatusHtml() {
   );
 }
 
+function buildAppDevForwardArgs(argv = process.argv) {
+  return ['app-dev', ...argv.slice(3)];
+}
+
+function resolveDevRuntimeMode(opts = {}) {
+  const appClientEntryMode = opts.appClientEntryMode || resolveAppClientEntryMode();
+  const useModernOnlyEntryMode = appClientEntryMode === 'modern-only';
+  const clientV2Only = !!opts.clientV2Only;
+  const forceClient = !!opts.client;
+  const forceServer = !!opts.server;
+  const shouldRunClientV2 = clientV2Only || useModernOnlyEntryMode || forceClient || !forceServer;
+  const shouldRunClient = !clientV2Only && !useModernOnlyEntryMode && (forceClient || !forceServer);
+  const shouldRunServer = !clientV2Only && (forceServer || !forceClient || useModernOnlyEntryMode);
+
+  return {
+    appClientEntryMode,
+    useModernOnlyEntryMode,
+    shouldRunClientV2,
+    shouldRunClient,
+    shouldRunServer,
+  };
+}
+
+async function forwardDevToAppDev({ argv = process.argv, runCommand = run } = {}) {
+  await runCommand('nocobase-v1', buildAppDevForwardArgs(argv));
+}
+
 /**
  *
  * @param {Command} cli
@@ -58,6 +88,11 @@ module.exports = (cli) => {
     .option('-i, --inspect [port]')
     .allowUnknownOption()
     .action(async (opts) => {
+      if (!hasCorePackages()) {
+        await forwardDevToAppDev();
+        return;
+      }
+
       checkDBDialect();
       await buildBundleStatusHtml();
 
@@ -92,9 +127,9 @@ module.exports = (cli) => {
       nodeCheck();
       await postCheck(opts);
 
-      const shouldRunClientV2 = clientV2Only || client || !server;
-      const shouldRunClient = !clientV2Only && (client || !server);
-      const shouldRunServer = !clientV2Only && (server || !client);
+      const { useModernOnlyEntryMode, shouldRunClientV2, shouldRunClient, shouldRunServer } = resolveDevRuntimeMode(
+        opts,
+      );
       const shouldRunClientWithRsbuild = shouldRunClient && !!rsbuild;
 
       if (shouldRunServer && server) {
@@ -105,12 +140,16 @@ module.exports = (cli) => {
         });
       }
 
-      if (shouldRunClientV2 && !clientV2Only) {
+      if (shouldRunClientV2 && !clientV2Only && !useModernOnlyEntryMode) {
         clientV2Port = await getPortPromise({
           port: 1 * clientPort + 2,
         });
       }
 
+      if (useModernOnlyEntryMode) {
+        clientV2Port = APP_PORT;
+      }
+
       let subprocessClient;
       let subprocessClientV2;
 
@@ -184,16 +223,13 @@ module.exports = (cli) => {
         }
         subprocessRef.cancel();
         let i = 0;
-        while (true) {
+        while (i <= 10) {
           ++i;
           const result = await isPortReachable(port);
           if (!result) {
             break;
           }
           await sleep(500);
-          if (i > 10) {
-            break;
-          }
         }
         start();
       };
@@ -202,7 +238,7 @@ module.exports = (cli) => {
         const storagePluginPath = resolvePluginStoragePath();
         const watcher = chokidar.watch(`${storagePluginPath}/**/*`, {
           cwd: process.cwd(),
-          ignored: /(^|[\/\\])\../, // 忽略隐藏文件
+          ignored: /(^|[/\\])\../, // 忽略隐藏文件
           persistent: true,
           depth: 1, // 只监听第一层目录
         });
@@ -246,6 +282,7 @@ module.exports = (cli) => {
 
         const argv = [
           'watch',
+          '--clear-screen=false',
           ...(inspect ? [`--inspect=${inspect === true ? 9229 : inspect}`] : []),
           `--ignore=${resolvePluginStoragePath()}/**`,
           '--tsconfig',
@@ -264,9 +301,9 @@ module.exports = (cli) => {
 
         const runDevServer = () => {
           run('tsx', argv, {
-            env: {
+            env: colorizedDevLogEnv(process.env, {
               APP_PORT: serverPort,
-            },
+            }),
           }).catch((err) => {
             if (err.exitCode == 100) {
               console.log('Restarting server...');
@@ -289,3 +326,9 @@ module.exports = (cli) => {
       }
     });
 };
+
+module.exports._test = {
+  buildAppDevForwardArgs,
+  forwardDevToAppDev,
+  resolveDevRuntimeMode,
+};

package/src/commands/update-deps.js

@@ -68,6 +68,14 @@ module.exports = (cli) => {
       if (descJson['dependencies']?.['@nocobase/app']) {
         descJson['dependencies']['@nocobase/app'] = stdout;
       }
+      descJson['scripts']['dev'] = 'nocobase app-dev';
+      if (descJson['dependencies']?.['@nocobase/cli']) {
+        descJson['dependencies']['@nocobase/app'] = stdout;
+        console.log(
+          chalk.yellow('The @nocobase/cli package is no longer needed, it will be removed from dependencies.'),
+        );
+        delete descJson['dependencies']['@nocobase/cli'];
+      }
       if (descJson['devDependencies']?.['@nocobase/devtools']) {
         descJson['devDependencies']['@nocobase/devtools'] = stdout;
       }

package/src/util.js

@@ -84,6 +84,24 @@ exports.run = (command, args, options = {}) => {
   });
 };
 
+function colorizedDevLogEnv(env = process.env, overrides = {}) {
+  const nextEnv = {
+    ...env,
+    ...overrides,
+  };
+  delete nextEnv.NO_COLOR;
+  if (!nextEnv.FORCE_COLOR) {
+    nextEnv.FORCE_COLOR = '1';
+  }
+  return nextEnv;
+}
+
+function createRunWithPrefixLabel(prefix, color) {
+  const forcedChalk = new chalk.Instance({ level: 1 });
+  const colorize = forcedChalk[color] || forcedChalk.cyan;
+  return colorize(`[${prefix}]`);
+}
+
 exports.runWithPrefix = (command, args, options = {}) => {
   if (command === 'tsx') {
     command = 'node';
@@ -92,15 +110,12 @@ exports.runWithPrefix = (command, args, options = {}) => {
 
   const prefix = options.prefix || 'process';
   const color = options.color || 'cyan';
-  const label = chalk[color](`[${prefix}]`);
+  const label = createRunWithPrefixLabel(prefix, color);
   const subprocess = execa(command, args, {
     shell: true,
     stdio: 'pipe',
     ...options,
-    env: {
-      ...process.env,
-      ...options.env,
-    },
+    env: colorizedDevLogEnv(process.env, options.env),
   });
 
   const writePrefixed = (chunk, writer) => {
@@ -122,6 +137,13 @@ exports.runWithPrefix = (command, args, options = {}) => {
   return subprocess;
 };
 
+exports._test = {
+  createRunWithPrefixLabel,
+  colorizedDevLogEnv,
+};
+
+exports.colorizedDevLogEnv = colorizedDevLogEnv;
+
 exports.isPortReachable = async (port, { timeout = 1000, host } = {}) => {
   const promise = new Promise((resolve, reject) => {
     const socket = new net.Socket();
@@ -410,6 +432,30 @@ const DEFAULT_MODERN_CLIENT_PREFIX = 'v';
 
 exports.DEFAULT_MODERN_CLIENT_PREFIX = DEFAULT_MODERN_CLIENT_PREFIX;
 
+const DEFAULT_APP_CLIENT_ENTRY_MODE = 'legacy-default';
+const APP_CLIENT_ENTRY_MODES = new Set(['legacy-default', 'modern-default', 'modern-only']);
+
+exports.DEFAULT_APP_CLIENT_ENTRY_MODE = DEFAULT_APP_CLIENT_ENTRY_MODE;
+
+function isAppClientEntryMode(value) {
+  return APP_CLIENT_ENTRY_MODES.has(String(value || '').trim());
+}
+
+exports.isAppClientEntryMode = isAppClientEntryMode;
+
+function normalizeAppClientEntryMode(value) {
+  const normalized = String(value || '').trim();
+  return isAppClientEntryMode(normalized) ? normalized : DEFAULT_APP_CLIENT_ENTRY_MODE;
+}
+
+exports.normalizeAppClientEntryMode = normalizeAppClientEntryMode;
+
+function resolveAppClientEntryMode() {
+  return normalizeAppClientEntryMode(process.env.APP_CLIENT_ENTRY_MODE);
+}
+
+exports.resolveAppClientEntryMode = resolveAppClientEntryMode;
+
 // Normalize APP_MODERN_CLIENT_PREFIX (accepts `v`, `/v`, `/v/`)
 // down to a bare segment like `v`.
 function normalizeModernClientPrefix(value) {
@@ -433,6 +479,13 @@ function isAppDevHtml() {
   return process.argv[2] === 'app-dev' || process.env.NOCOBASE_APP_DEV === 'true';
 }
 
+function shouldRefreshLegacyIndexTemplate(data = '') {
+  return (
+    !data.includes("window['__nocobase_modern_client_prefix__']") ||
+    !data.includes("window['__nocobase_app_client_entry_mode__']")
+  );
+}
+
 function buildIndexHtml(force = false) {
   const file = `${process.env.APP_PACKAGE_ROOT}/dist/client/index.html`;
   if (!fs.existsSync(file)) {
@@ -444,11 +497,15 @@ function buildIndexHtml(force = false) {
   }
   if (!fs.existsSync(tpl)) {
     fs.copyFileSync(file, tpl);
+  } else if (shouldRefreshLegacyIndexTemplate(fs.readFileSync(tpl, 'utf-8'))) {
+    fs.copyFileSync(file, tpl);
   }
   const data = fs.readFileSync(tpl, 'utf-8');
   let replacedData = data
     .replace(/\{\{env.CDN_BASE_URL\}\}/g, process.env.CDN_BASE_URL)
     .replace(/\{\{env.APP_PUBLIC_PATH\}\}/g, process.env.APP_PUBLIC_PATH)
+    .replace(/\{\{env.APP_MODERN_CLIENT_PREFIX\}\}/g, normalizeModernClientPrefix(process.env.APP_MODERN_CLIENT_PREFIX))
+    .replace(/\{\{env.APP_CLIENT_ENTRY_MODE\}\}/g, resolveAppClientEntryMode())
     .replace(/\{\{env.API_CLIENT_SHARE_TOKEN\}\}/g, process.env.API_CLIENT_SHARE_TOKEN || 'false')
     .replace(/\{\{env.API_CLIENT_STORAGE_TYPE\}\}/g, process.env.API_CLIENT_STORAGE_TYPE)
     .replace(/\{\{env.API_CLIENT_STORAGE_PREFIX\}\}/g, process.env.API_CLIENT_STORAGE_PREFIX)
@@ -589,6 +646,7 @@ exports.initEnv = function initEnv() {
     CDN_BASE_URL: '',
     APP_PUBLIC_PATH: '/',
     APP_MODERN_CLIENT_PREFIX: DEFAULT_MODERN_CLIENT_PREFIX,
+    APP_CLIENT_ENTRY_MODE: DEFAULT_APP_CLIENT_ENTRY_MODE,
     ESM_CDN_BASE_URL: 'https://esm.sh',
     ESM_CDN_SUFFIX: '',
   };
@@ -640,6 +698,14 @@ exports.initEnv = function initEnv() {
     }
   }
 
+  const rawAppClientEntryMode = String(process.env.APP_CLIENT_ENTRY_MODE || '').trim();
+  if (rawAppClientEntryMode && !isAppClientEntryMode(rawAppClientEntryMode)) {
+    console.warn(
+      `Unknown APP_CLIENT_ENTRY_MODE "${rawAppClientEntryMode}", falling back to ${DEFAULT_APP_CLIENT_ENTRY_MODE}.`,
+    );
+  }
+  process.env.APP_CLIENT_ENTRY_MODE = normalizeAppClientEntryMode(rawAppClientEntryMode);
+
   if (!process.env.__env_modified__ && process.env.APP_PUBLIC_PATH) {
     const publicPath = process.env.APP_PUBLIC_PATH.replace(/\/$/g, '');
     const keys = ['API_BASE_PATH', 'WS_PATH', 'PLUGIN_STATICS_PATH'];