@nocobase/cli 2.1.0-alpha.16 → 2.1.0-alpha.17

package/src/commands/build.js

@@ -1,81 +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.
- */
-
-const { existsSync } = require('fs');
-const { resolve } = require('path');
-const { Command } = require('commander');
-const { run, nodeCheck, isPackageValid, buildIndexHtml } = require('../util');
-
-async function buildClientV2() {
-  const configPath = resolve(process.env.APP_PACKAGE_ROOT, 'client-v2/rsbuild.config.ts');
-  if (!existsSync(configPath)) {
-    console.log(`client-v2 config not found: ${configPath}`);
-    return;
-  }
-  await run('rsbuild', ['build', '--config', configPath], {
-    env: {
-      ...process.env,
-      APP_ENV: 'production',
-      NODE_ENV: 'production',
-      API_BASE_URL: process.env.API_BASE_URL || process.env.API_BASE_PATH,
-      API_CLIENT_STORAGE_PREFIX: process.env.API_CLIENT_STORAGE_PREFIX,
-      API_CLIENT_STORAGE_TYPE: process.env.API_CLIENT_STORAGE_TYPE,
-      API_CLIENT_SHARE_TOKEN: process.env.API_CLIENT_SHARE_TOKEN || 'false',
-      WEBSOCKET_URL: process.env.WEBSOCKET_URL || '',
-      WS_PATH: process.env.WS_PATH,
-      ESM_CDN_BASE_URL: process.env.ESM_CDN_BASE_URL || 'https://esm.sh',
-      ESM_CDN_SUFFIX: process.env.ESM_CDN_SUFFIX || '',
-    },
-  });
-}
-
-/**
- *
- * @param {Command} cli
- */
-module.exports = (cli) => {
-  cli
-    .command('build')
-    .allowUnknownOption()
-    .argument('[packages...]')
-    .option('-v, --version', 'print version')
-    .option('-c, --compile', 'compile the @nocobase/build package')
-    .option('-r, --retry', 'retry the last failed package')
-    .option('-w, --watch', 'watch compile the @nocobase/build package')
-    .option('-s, --sourcemap', 'generate sourcemap')
-    .option('--no-dts', 'not generate dts')
-    .option('--client-v2-only', 'build client-v2 shell only')
-    .action(async (pkgs, options) => {
-      nodeCheck();
-      process.env['VITE_CJS_IGNORE_WARNING'] = 'true';
-      process.env.APP_ENV = 'production';
-
-      if (options.clientV2Only) {
-        await buildClientV2();
-        return;
-      }
-
-      if (options.compile || options.watch || isPackageValid('@nocobase/build/src/index.ts')) {
-        await run('yarn', ['build', options.watch ? '--watch' : ''], {
-          cwd: resolve(process.cwd(), 'packages/core/build'),
-        });
-        if (options.watch) return;
-      }
-
-      await run('nocobase-build', [
-        ...pkgs,
-        options.version ? '--version' : '',
-        !options.dts ? '--no-dts' : '',
-        options.sourcemap ? '--sourcemap' : '',
-        options.retry ? '--retry' : '',
-      ]);
-      buildIndexHtml(true);
-      await buildClientV2();
-    });
-};

package/src/commands/clean.js

@@ -1,30 +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.
- */
-
-const chalk = require('chalk');
-const { Command } = require('commander');
-const { run, isDev } = require('../util');
-
-/**
- *
- * @param {Command} cli
- */
-module.exports = (cli) => {
-  cli
-    .command('clean')
-    .allowUnknownOption()
-    .action(() => {
-      if (!isDev()) {
-        return;
-      }
-      run('rimraf', ['-rf', './storage/app-dev']);
-      run('rimraf', ['-rf', 'packages/*/*/{lib,esm,es,dist,node_modules}']);
-      run('rimraf', ['-rf', 'packages/*/@*/*/{lib,esm,es,dist,node_modules}']);
-    });
-};

package/src/commands/client.js

@@ -1,168 +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.
- */
-
-const chalk = require('chalk');
-const { Command } = require('commander');
-const fs = require('fs-extra');
-const { resolve } = require('path');
-
-/**
- * 复制主应用客户端文件
- * @param {string} source - 源目录路径
- * @param {string} target - 目标目录路径
- */
-async function copyMainClient(source, target) {
-  if (!(await fs.exists(source))) {
-    console.log(chalk.yellow(`Source directory does not exist: ${source}`));
-    return;
-  }
-  // 确保目标目录存在且为空
-  await fs.ensureDir(target);
-  await fs.emptyDir(target);
-  await fs.copy(source, target, { recursive: true });
-  console.log(chalk.green(`Copied main client files from ${source} to ${target}`));
-}
-
-/**
- * 复制插件客户端文件
- * @param {string} pluginsBaseDir - 插件基础目录路径
- * @param {string} namespace - 命名空间（如 '@nocobase' 或 '@nocobase-example'）
- * @param {string} target - 目标目录
- */
-async function copyPluginClients(pluginsBaseDir, namespace, target) {
-  const pluginsDir = resolve(process.cwd(), pluginsBaseDir, namespace);
-  if (await fs.exists(pluginsDir)) {
-    const pluginNames = await fs.readdir(pluginsDir);
-    for (const pluginName of pluginNames) {
-      const pluginPath = resolve(pluginsDir, pluginName);
-      for (const lane of ['client', 'client-v2']) {
-        const pluginDistClient = resolve(pluginPath, `dist/${lane}`);
-        if (await fs.exists(pluginDistClient)) {
-          const pluginTarget = resolve(target, 'static/plugins', namespace, pluginName, 'dist', lane);
-          await fs.mkdir(resolve(pluginTarget, '..'), { recursive: true });
-          await fs.copy(pluginDistClient, pluginTarget, { recursive: true });
-          console.log(chalk.green(`Copied ${namespace}/${pluginName} ${lane} files`));
-        }
-      }
-    }
-  }
-}
-
-/**
- * 递归上传目录到 OSS
- * @param {Client} client - OSS 客户端实例
- * @param {string} localDir - 本地目录路径
- * @param {string} ossPrefix - OSS 对象前缀（目录路径）
- */
-async function uploadDirectoryToOSS(client, localDir, ossPrefix = '') {
-  if (!(await fs.exists(localDir))) {
-    console.log(chalk.yellow(`Directory does not exist: ${localDir}`));
-    return;
-  }
-
-  const stats = await fs.stat(localDir);
-  if (!stats.isDirectory()) {
-    throw new Error(`${localDir} is not a directory`);
-  }
-
-  const files = await fs.readdir(localDir);
-  let uploadedCount = 0;
-
-  for (const file of files) {
-    const filePath = resolve(localDir, file);
-    const fileStats = await fs.stat(filePath);
-
-    if (fileStats.isDirectory()) {
-      // 递归处理子目录
-      const subOssPrefix = ossPrefix ? `${ossPrefix}/${file}` : file;
-      const subCount = await uploadDirectoryToOSS(client, filePath, subOssPrefix);
-      uploadedCount += subCount;
-    } else {
-      // 上传文件
-      const ossKey = ossPrefix ? `${ossPrefix}/${file}` : file;
-      try {
-        await client.put(ossKey, filePath);
-        // console.log(chalk.green(`Uploaded: ${ossKey}`));
-        uploadedCount++;
-      } catch (error) {
-        console.error(chalk.red(`Failed to upload ${ossKey}:`), error.message);
-        throw error;
-      }
-    }
-  }
-
-  return uploadedCount;
-}
-
-/**
- *
- * @param {Command} cli
- */
-module.exports = (cli) => {
-  cli
-    .command('client:extract')
-    .allowUnknownOption()
-    .action(async () => {
-      const version = require('../../package.json').version;
-      const target = resolve(process.cwd(), 'storage/dist-client', version);
-      const mainClientSource = resolve(process.cwd(), 'node_modules/@nocobase/app/dist/client');
-      await copyMainClient(mainClientSource, target);
-      await copyPluginClients('packages/plugins', '@nocobase', target);
-      await copyPluginClients('packages/plugins', '@nocobase-example', target);
-      await copyPluginClients('packages/pro-plugins', '@nocobase', target);
-    });
-
-  cli
-    .command('client:upload')
-    .allowUnknownOption()
-    .action(async () => {
-      const version = require('../../package.json').version;
-      const target = resolve(process.cwd(), 'storage/dist-client', version);
-
-      // 检查必要的环境变量
-      if (
-        !process.env.CDN_ALI_OSS_ACCESS_KEY_ID ||
-        !process.env.CDN_ALI_OSS_ACCESS_KEY_SECRET ||
-        !process.env.CDN_ALI_OSS_BUCKET ||
-        !process.env.CDN_ALI_OSS_REGION
-      ) {
-        console.error(
-          chalk.red(
-            'Missing required environment variables: CDN_ALI_OSS_ACCESS_KEY_ID, CDN_ALI_OSS_ACCESS_KEY_SECRET, CDN_ALI_OSS_BUCKET, CDN_ALI_OSS_REGION',
-          ),
-        );
-        process.exit(1);
-      }
-
-      const Client = require('ali-oss');
-
-      const client = new Client({
-        accessKeyId: process.env.CDN_ALI_OSS_ACCESS_KEY_ID,
-        accessKeySecret: process.env.CDN_ALI_OSS_ACCESS_KEY_SECRET,
-        bucket: process.env.CDN_ALI_OSS_BUCKET,
-        region: process.env.CDN_ALI_OSS_REGION,
-      });
-
-      if (!(await fs.exists(target))) {
-        console.error(chalk.red(`Target directory does not exist: ${target}`));
-        console.log(chalk.yellow('Please run "client:extract" first to generate the client files.'));
-        process.exit(1);
-      }
-
-      console.log(chalk.blue(`Uploading directory ${target} to OSS...`));
-      const ossPrefix = `${version}`;
-      try {
-        const uploadedCount = await uploadDirectoryToOSS(client, target, ossPrefix);
-        console.log(chalk.green(`Successfully uploaded ${uploadedCount} files to OSS`));
-      } catch (error) {
-        console.error(chalk.red('Upload failed:'), error);
-        process.exit(1);
-      }
-    });
-};

package/src/commands/create-nginx-conf.js

@@ -1,53 +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.
- */
-
-const { resolve, posix } = require('path');
-const { Command } = require('commander');
-const { readFileSync, writeFileSync } = require('fs');
-const { resolvePublicPath, resolveV2PublicPath } = require('../util');
-
-/**
- *
- * @param {Command} cli
- */
-module.exports = (cli) => {
-  cli.command('create-nginx-conf').action(async (name, options) => {
-    const rawAppPublicPath = process.env.APP_PUBLIC_PATH || '/';
-    const appPublicPath = resolvePublicPath(rawAppPublicPath);
-    const v2PublicPath = resolveV2PublicPath(rawAppPublicPath);
-    const appPublicPathWithoutTrailingSlash = appPublicPath.replace(/\/$/, '');
-    const v2PublicPathWithoutTrailingSlash = v2PublicPath.replace(/\/$/, '');
-    const file = resolve(__dirname, '../../nocobase.conf.tpl');
-    const data = readFileSync(file, 'utf-8');
-    let otherLocation = '';
-    if (appPublicPath !== '/') {
-      otherLocation = `location = /v2 {
-        return 302 ${v2PublicPath}$is_args$args;
-    }
-
-    location /v2/ {
-        return 302 ${appPublicPathWithoutTrailingSlash}$uri$is_args$args;
-    }
-
-    location / {
-        alias ${posix.resolve(process.cwd())}/node_modules/@nocobase/app/dist/client/;
-        try_files $uri $uri/ /index.html;
-    }`;
-    }
-    const replaced = data
-      .replace(/\{\{cwd\}\}/g, posix.resolve(process.cwd()))
-      .replace(/\{\{publicPath\}\}/g, appPublicPath)
-      .replace(/\{\{v2PublicPath\}\}/g, v2PublicPath)
-      .replace(/\{\{v2PublicPathNoTrailingSlash\}\}/g, v2PublicPathWithoutTrailingSlash)
-      .replace(/\{\{apiPort\}\}/g, process.env.APP_PORT)
-      .replace(/\{\{otherLocation\}\}/g, otherLocation);
-    const targetFile = resolve(process.cwd(), 'storage', 'nocobase.conf');
-    writeFileSync(targetFile, replaced);
-  });
-};

package/src/commands/create-plugin.js

@@ -1,33 +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.
- */
-
-const { resolve } = require('path');
-const { Command } = require('commander');
-const { PluginGenerator } = require('../plugin-generator');
-
-/**
- *
- * @param {Command} cli
- */
-module.exports = (cli) => {
-  cli
-    .command('create-plugin')
-    .argument('<name>')
-    .allowUnknownOption()
-    .action(async (name, options) => {
-      const generator = new PluginGenerator({
-        cwd: resolve(process.cwd(), name),
-        args: options,
-        context: {
-          name,
-        },
-      });
-      await generator.run();
-    });
-};

package/src/commands/dev.js

@@ -1,290 +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.
- */
-const _ = require('lodash');
-const { Command } = require('commander');
-const {
-  generatePlugins,
-  run,
-  runWithPrefix,
-  postCheck,
-  nodeCheck,
-  promptForTs,
-  isPortReachable,
-  buildWSURL,
-  checkDBDialect,
-} = require('../util');
-const { getPortPromise } = require('portfinder');
-const chokidar = require('chokidar');
-const { uid } = require('@formily/shared');
-const path = require('path');
-const fs = require('fs');
-
-function sleep(ms = 1000) {
-  return new Promise((resolve) => {
-    setTimeout(resolve, ms);
-  });
-}
-
-async function buildBundleStatusHtml() {
-  const data = await fs.promises.readFile(path.resolve(__dirname, '../../templates/bundle-status.html'), 'utf-8');
-  await fs.promises.writeFile(
-    path.resolve(process.cwd(), 'node_modules/@umijs/preset-umi/assets/bundle-status.html'),
-    data,
-    'utf-8',
-  );
-}
-
-/**
- *
- * @param {Command} cli
- */
-module.exports = (cli) => {
-  const { APP_PACKAGE_ROOT } = process.env;
-  cli
-    .command('dev')
-    .option('-p, --port [port]')
-    .option('-c, --client')
-    .option('-s, --server')
-    .option('--db-sync')
-    .option('--rsbuild')
-    .option('--client-v2-only')
-    .option('-i, --inspect [port]')
-    .allowUnknownOption()
-    .action(async (opts) => {
-      checkDBDialect();
-      await buildBundleStatusHtml();
-
-      promptForTs();
-      const { SERVER_TSCONFIG_PATH } = process.env;
-      process.env.IS_DEV_CMD = true;
-
-      if (process.argv.includes('-h') || process.argv.includes('--help')) {
-        run('ts-node', [
-          '-P',
-          SERVER_TSCONFIG_PATH,
-          '-r',
-          'tsconfig-paths/register',
-          `${APP_PACKAGE_ROOT}/src/index.ts`,
-          ...process.argv.slice(2),
-        ]);
-        return;
-      }
-
-      const { port, client, server, inspect, clientV2Only, rsbuild } = opts;
-
-      if (port) {
-        process.env.APP_PORT = opts.port;
-      }
-
-      const APP_PORT = Number(process.env.APP_PORT);
-
-      let clientPort = APP_PORT;
-      let serverPort;
-      let clientV2Port = APP_PORT;
-
-      nodeCheck();
-      await postCheck(opts);
-
-      const shouldRunClientV2 = clientV2Only || client || !server;
-      const shouldRunClient = !clientV2Only && (client || !server);
-      const shouldRunServer = !clientV2Only && (server || !client);
-      const shouldRunClientWithRsbuild = shouldRunClient && !!rsbuild;
-
-      if (shouldRunServer && server) {
-        serverPort = APP_PORT;
-      } else if (shouldRunServer) {
-        serverPort = await getPortPromise({
-          port: 1 * clientPort + 1,
-        });
-      }
-
-      if (shouldRunClientV2 && !clientV2Only) {
-        clientV2Port = await getPortPromise({
-          port: 1 * clientPort + 2,
-        });
-      }
-
-      let subprocessClient;
-      let subprocessClientV2;
-
-      const runDevClientV2 = () => {
-        console.log('starting client-v2', 1 * clientV2Port);
-        subprocessClientV2 = runWithPrefix(
-          'rsbuild',
-          ['dev', '--config', `${APP_PACKAGE_ROOT}/client-v2/rsbuild.config.ts`],
-          {
-            prefix: 'client-v2',
-            color: 'magenta',
-            env: {
-              ...process.env,
-              APP_V2_PORT: `${clientV2Port}`,
-              NODE_ENV: 'development',
-              RSPACK_HMR_CLIENT_PORT: `${clientV2Only ? clientV2Port : clientPort}`,
-              API_BASE_URL: process.env.API_BASE_URL || process.env.API_BASE_PATH,
-              API_CLIENT_STORAGE_PREFIX: process.env.API_CLIENT_STORAGE_PREFIX,
-              API_CLIENT_STORAGE_TYPE: process.env.API_CLIENT_STORAGE_TYPE,
-              API_CLIENT_SHARE_TOKEN: process.env.API_CLIENT_SHARE_TOKEN || 'false',
-              WEBSOCKET_URL: process.env.WEBSOCKET_URL || buildWSURL(process.env.API_BASE_URL, serverPort),
-              WS_PATH: process.env.WS_PATH,
-              ESM_CDN_BASE_URL: process.env.ESM_CDN_BASE_URL || 'https://esm.sh',
-              ESM_CDN_SUFFIX: process.env.ESM_CDN_SUFFIX || '',
-              PROXY_TARGET_URL:
-                process.env.PROXY_TARGET_URL || (serverPort ? `http://127.0.0.1:${serverPort}` : undefined),
-            },
-          },
-        );
-      };
-
-      if (clientV2Only) {
-        runDevClientV2();
-        return;
-      }
-
-      const runDevClient = () => {
-        console.log('starting client', 1 * clientPort);
-        const command = shouldRunClientWithRsbuild ? 'rsbuild' : 'umi';
-        const args = shouldRunClientWithRsbuild
-          ? ['dev', '--config', `${APP_PACKAGE_ROOT}/client/rsbuild.config.ts`]
-          : ['dev'];
-        subprocessClient = runWithPrefix(command, args, {
-          prefix: 'client',
-          color: 'cyan',
-          env: {
-            ...process.env,
-            stdio: 'inherit',
-            shell: true,
-            PORT: clientPort,
-            APP_PORT: `${clientPort}`,
-            APP_ROOT: `${APP_PACKAGE_ROOT}/client`,
-            APP_V2_PORT: `${clientV2Port}`,
-            NODE_ENV: 'development',
-            RSPACK_HMR_CLIENT_PORT: `${clientPort}`,
-            API_BASE_URL: process.env.API_BASE_URL || process.env.API_BASE_PATH,
-            API_CLIENT_STORAGE_PREFIX: process.env.API_CLIENT_STORAGE_PREFIX,
-            API_CLIENT_STORAGE_TYPE: process.env.API_CLIENT_STORAGE_TYPE,
-            API_CLIENT_SHARE_TOKEN: process.env.API_CLIENT_SHARE_TOKEN || 'false',
-            WEBSOCKET_URL: process.env.WEBSOCKET_URL || buildWSURL(process.env.API_BASE_URL, serverPort),
-            PROXY_TARGET_URL:
-              process.env.PROXY_TARGET_URL || (serverPort ? `http://127.0.0.1:${serverPort}` : undefined),
-          },
-        });
-      };
-
-      const restartSubprocess = async (subprocessRef, port, start) => {
-        if (!subprocessRef) {
-          start();
-          return;
-        }
-        subprocessRef.cancel();
-        let i = 0;
-        while (true) {
-          ++i;
-          const result = await isPortReachable(port);
-          if (!result) {
-            break;
-          }
-          await sleep(500);
-          if (i > 10) {
-            break;
-          }
-        }
-        start();
-      };
-
-      if (shouldRunClient) {
-        const storagePluginPath = path.resolve(process.cwd(), 'storage/plugins');
-        const watcher = chokidar.watch(`${storagePluginPath}/**/*`, {
-          cwd: process.cwd(),
-          ignored: /(^|[\/\\])\../, // 忽略隐藏文件
-          persistent: true,
-          depth: 1, // 只监听第一层目录
-        });
-
-        await fs.promises.mkdir(path.dirname(process.env.WATCH_FILE), { recursive: true });
-        let isReady = false;
-
-        const restartClient = _.debounce(async () => {
-          if (!isReady) return;
-          generatePlugins();
-          if (shouldRunClient) {
-            await restartSubprocess(subprocessClient, clientPort, runDevClient);
-          }
-          if (shouldRunClientV2) {
-            await restartSubprocess(subprocessClientV2, clientV2Port, runDevClientV2);
-          }
-          await fs.promises.writeFile(process.env.WATCH_FILE, `export const watchId = '${uid()}';`, 'utf-8');
-        }, 500);
-
-        watcher
-          .on('ready', () => {
-            console.log('watching plugin folder changes...');
-            isReady = true;
-          })
-          .on('addDir', async () => {
-            if (!isReady) return;
-            restartClient();
-          })
-          .on('unlinkDir', async () => {
-            if (!isReady) return;
-            restartClient();
-          });
-      }
-
-      if (shouldRunServer) {
-        console.log('starting server', serverPort);
-
-        const filteredArgs = process.argv.filter(
-          (item, i) => !item.startsWith('--inspect') && !(process.argv[i - 1] === '--inspect' && Number.parseInt(item)),
-        );
-
-        const argv = [
-          'watch',
-          ...(inspect ? [`--inspect=${inspect === true ? 9229 : inspect}`] : []),
-          '--ignore=./storage/plugins/**',
-          '--tsconfig',
-          SERVER_TSCONFIG_PATH,
-          '-r',
-          'tsconfig-paths/register',
-          `${APP_PACKAGE_ROOT}/src/index.ts`,
-          'start',
-          ...filteredArgs.slice(3),
-          `--port=${serverPort}`,
-        ];
-
-        if (opts.dbSync) {
-          argv.push('--db-sync');
-        }
-
-        const runDevServer = () => {
-          run('tsx', argv, {
-            env: {
-              APP_PORT: serverPort,
-            },
-          }).catch((err) => {
-            if (err.exitCode == 100) {
-              console.log('Restarting server...');
-              runDevServer();
-            } else {
-              console.error(err);
-            }
-          });
-        };
-
-        runDevServer();
-      }
-
-      if (shouldRunClient) {
-        runDevClient();
-      }
-
-      if (shouldRunClientV2) {
-        runDevClientV2();
-      }
-    });
-};