@nocobase/cli 2.1.0-alpha.2 → 2.1.0-alpha.20

package/src/commands/dev.js

@@ -1,200 +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, postCheck, nodeCheck, promptForTs, isPortReachable, 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('-i, --inspect [port]')
-    .allowUnknownOption()
-    .action(async (opts) => {
-      checkDBDialect();
-      await buildBundleStatusHtml();
-      let subprocess;
-      const runDevClient = () => {
-        console.log('starting client', 1 * clientPort);
-        subprocess = run('umi', ['dev'], {
-          env: {
-            ...process.env,
-            stdio: 'inherit',
-            shell: true,
-            PORT: clientPort,
-            APP_ROOT: `${APP_PACKAGE_ROOT}/client`,
-            WEBSOCKET_URL:
-              process.env.WEBSOCKET_URL ||
-              (serverPort ? `ws://localhost:${serverPort}${process.env.WS_PATH}` : undefined),
-            PROXY_TARGET_URL:
-              process.env.PROXY_TARGET_URL || (serverPort ? `http://127.0.0.1:${serverPort}` : undefined),
-          },
-        });
-      };
-      const watcher = chokidar.watch('./storage/plugins/**/*', {
-        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 (subprocess) {
-          console.log('client restarting...');
-          subprocess.cancel();
-          let i = 0;
-          while (true) {
-            ++i;
-            const result = await isPortReachable(clientPort);
-            if (!result) {
-              break;
-            }
-            await sleep(500);
-            if (i > 10) {
-              break;
-            }
-          }
-          runDevClient();
-          await fs.promises.writeFile(process.env.WATCH_FILE, `export const watchId = '${uid()}';`, 'utf-8');
-        }
-      }, 500);
-
-      watcher
-        .on('ready', () => {
-          isReady = true;
-        })
-        .on('addDir', async (pathname) => {
-          if (!isReady) return;
-          restartClient();
-        })
-        .on('unlinkDir', async (pathname) => {
-          if (!isReady) return;
-          restartClient();
-        });
-
-      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 } = opts;
-
-      if (port) {
-        process.env.APP_PORT = opts.port;
-      }
-
-      const { APP_PORT } = process.env;
-
-      let clientPort = APP_PORT;
-      let serverPort;
-
-      nodeCheck();
-
-      await postCheck(opts);
-
-      if (server) {
-        serverPort = APP_PORT;
-      } else if (!server && !client) {
-        serverPort = await getPortPromise({
-          port: 1 * clientPort + 1,
-        });
-      }
-
-      if (server || !client) {
-        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 (client || !server) {
-        runDevClient();
-      }
-    });
-};

package/src/commands/doc.js

@@ -1,76 +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 { Command } = require('commander');
-const { resolve, isAbsolute } = require('path');
-const { run, isDev } = require('../util');
-const fs = require('fs-extra');
-const glob = require('fast-glob');
-
-/**
- *
- * @param {Command} cli
- */
-module.exports = (cli) => {
-  cli
-    .command('doc')
-    .argument('[dev|build|serve]')
-    .argument('[packages]')
-    .option('--lang [lang]')
-    .allowUnknownOption()
-    .action((command, pkg, options) => {
-      if (!isDev()) {
-        return;
-      }
-
-      // 指定项目目录
-      let cwd = process.cwd();
-      if (command === undefined && pkg === undefined) {
-        command = 'dev';
-      } else if (!['dev', 'build', 'serve'].includes(command) && pkg === undefined) {
-        pkg = command;
-        command = 'dev';
-        cwd = resolve(process.cwd(), 'packages', pkg);
-      }
-      if (pkg !== undefined) {
-        process.env.APP_ROOT = `packages/${pkg}`;
-      }
-
-      // 删除 tmp 目录
-      const tmpDir = glob.sync(
-        ['.dumi/tmp', '.dumi/tmp-production', 'packages/*/*/.dumi/tmp', 'packages/*/*.dumi/tmp-production'],
-        {
-          cwd: process.cwd(),
-          onlyDirectories: true,
-        },
-      );
-      tmpDir.forEach((dir) => {
-        fs.removeSync(dir);
-      });
-
-      // 设置语言
-      process.env.DOC_LANG = options.lang || 'en-US';
-
-      if (command === 'serve') {
-        // 如果是多语言，则需要进入内部，如果不是多语言，则直接进入 docs/dist
-        let dir = resolve(cwd, 'docs/dist', process.env.DOC_LANG);
-        if (!fs.existsSync(dir)) {
-          dir = resolve(cwd, 'docs/dist');
-        }
-        run('serve', [dir]);
-      } else {
-        run('dumi', [command], {
-          env: {
-            APP_ROOT: process.env.APP_ROOT || './packages/core/client',
-            DOC_LANG: process.env.DOC_LANG,
-          },
-        });
-      }
-    });
-};

package/src/commands/e2e.js

@@ -1,265 +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 { Command } = require('commander');
-const { run, isPortReachable, checkDBDialect } = require('../util');
-const { execSync } = require('node:child_process');
-const axios = require('axios');
-const { pTest } = require('./p-test');
-const os = require('os');
-const treeKill = require('tree-kill');
-const chalk = require('chalk');
-
-/**
- * 检查服务是否启动成功
- */
-const checkServer = async (duration = 1000, max = 60 * 10) => {
-  return new Promise((resolve, reject) => {
-    let count = 0;
-    const timer = setInterval(async () => {
-      if (count++ > max) {
-        clearInterval(timer);
-        return reject(new Error('Server start timeout.'));
-      }
-
-      // if (!(await checkPort(PORT))) {
-      //   return;
-      // }
-
-      const url = `${process.env.APP_BASE_URL}/api/__health_check`;
-      // console.log('url', url);
-
-      axios
-        .get(url)
-        .then((response) => {
-          if (response.status === 200) {
-            clearInterval(timer);
-            resolve(true);
-          }
-        })
-        .catch((error) => {
-          console.error('Request error:', error?.response?.data?.error);
-        });
-    }, duration);
-  });
-};
-
-/**
- * 检查 UI 是否启动成功
- * @param duration
- */
-const checkUI = async (duration = 1000, max = 60 * 10) => {
-  return new Promise((resolve, reject) => {
-    let count = 0;
-    const timer = setInterval(async () => {
-      if (count++ > max) {
-        clearInterval(timer);
-        return reject(new Error('UI start timeout.'));
-      }
-
-      axios
-        .get(`${process.env.APP_BASE_URL}/__umi/api/bundle-status`)
-        .then((response) => {
-          if (response.data === 'ok') {
-            clearInterval(timer);
-            resolve(true);
-            return;
-          }
-          if (response.data.bundleStatus.done) {
-            clearInterval(timer);
-            resolve(true);
-          }
-        })
-        .catch((error) => {
-          console.error('Request error:', error.message);
-        });
-    }, duration);
-  });
-};
-
-async function appReady() {
-  console.log('check server...');
-  await checkServer();
-  console.log('server is ready, check UI...');
-  await checkUI();
-  console.log('UI is ready.');
-}
-
-async function runApp(options = {}) {
-  console.log('installing...');
-  await run('nocobase', ['install', '-f']);
-  await run('nocobase', ['pm', 'enable-all']);
-  if (await isPortReachable(process.env.APP_PORT)) {
-    console.log('app started');
-    return;
-  }
-  console.log('starting...');
-  run('nocobase', [process.env.APP_ENV === 'production' ? 'start' : 'dev'], options);
-}
-
-process.on('SIGINT', async () => {
-  treeKill(process.pid, (error) => {
-    if (error) {
-      console.error(error);
-    } else {
-      console.log(chalk.yellow('Force killing...'));
-    }
-    process.exit();
-  });
-});
-
-const commonConfig = {
-  stdio: 'inherit',
-};
-
-const runCodegenSync = () => {
-  try {
-    execSync(
-      `npx playwright codegen --load-storage=storage/playwright/.auth/codegen.auth.json ${process.env.APP_BASE_URL} --save-storage=storage/playwright/.auth/codegen.auth.json`,
-      commonConfig,
-    );
-  } catch (err) {
-    if (err.message.includes('auth.json')) {
-      execSync(
-        `npx playwright codegen ${process.env.APP_BASE_URL} --save-storage=storage/playwright/.auth/codegen.auth.json`,
-        commonConfig,
-      );
-    } else {
-      console.error(err);
-    }
-  }
-};
-
-const filterArgv = () => {
-  const arr = process.argv.slice(4);
-  const argv = [];
-  for (let index = 0; index < arr.length; index++) {
-    const element = arr[index];
-    if (element === '--url') {
-      index++;
-      continue;
-    }
-    if (element.startsWith('--url=')) {
-      continue;
-    }
-    if (element === '--build') {
-      continue;
-    }
-    if (element === '--production') {
-      continue;
-    }
-    argv.push(element);
-  }
-  return argv;
-};
-
-/**
- *
- * @param {Command} cli
- */
-module.exports = (cli) => {
-  const e2e = cli.command('e2e').hook('preAction', () => {
-    checkDBDialect();
-    if (process.env.APP_BASE_URL) {
-      process.env.APP_BASE_URL = process.env.APP_BASE_URL.replace('localhost', '127.0.0.1');
-      console.log('APP_BASE_URL:', process.env.APP_BASE_URL);
-    }
-  });
-
-  e2e
-    .command('test')
-    .allowUnknownOption()
-    .option('--url [url]')
-    .option('--build')
-    .option('--production')
-    .action(async (options) => {
-      process.env.__E2E__ = true;
-      if (options.production) {
-        process.env.APP_ENV = 'production';
-      }
-      if (options.build) {
-        process.env.APP_ENV = 'production';
-        await run('yarn', ['build']);
-      }
-      if (options.url) {
-        process.env.APP_BASE_URL = options.url.replace('localhost', '127.0.0.1');
-      } else {
-        await runApp({
-          stdio: 'ignore',
-        });
-      }
-      await appReady();
-      await run('npx', ['playwright', 'test', ...filterArgv()]);
-      process.exit();
-    });
-
-  e2e
-    .command('codegen')
-    .allowUnknownOption()
-    .option('--url [url]')
-    .action(async (options) => {
-      if (options.url) {
-        process.env.APP_BASE_URL = options.url.replace('localhost', '127.0.0.1');
-      } else {
-        await runApp({
-          stdio: 'ignore',
-        });
-      }
-      await appReady();
-      runCodegenSync();
-    });
-
-  e2e
-    .command('start-app')
-    .option('--production')
-    .option('--build')
-    .option('--port [port]')
-    .action(async (options) => {
-      process.env.__E2E__ = true;
-      if (options.build) {
-        await run('yarn', ['build']);
-      }
-      if (options.production) {
-        process.env.APP_ENV = 'production';
-      }
-      if (options.port) {
-        process.env.APP_PORT = options.port;
-      }
-      runApp();
-    });
-
-  e2e.command('reinstall-app').action(async (options) => {
-    await run('nocobase', ['install', '-f'], options);
-    await run('nocobase', ['pm2', 'enable-all']);
-  });
-
-  e2e.command('install-deps').action(async () => {
-    await run('npx', ['playwright', 'install', '--with-deps']);
-  });
-
-  e2e
-    .command('p-test')
-    .option('--stop-on-error')
-    .option('--build')
-    .option('--concurrency [concurrency]', '', os.cpus().length)
-    .option(
-      '--match [match]',
-      'Only the files matching one of these patterns are executed as test files. Matching is performed against the absolute file path. Strings are treated as glob patterns.',
-      'packages/**/__e2e__/**/*.test.ts',
-    )
-    .option('--ignore [ignore]', 'Skip tests that match the pattern. Strings are treated as glob patterns.', undefined)
-    .action(async (options) => {
-      process.env.__E2E__ = true;
-      if (options.build) {
-        process.env.APP_ENV = 'production';
-        await run('yarn', ['build']);
-      }
-      await pTest({ ...options, concurrency: 1 * options.concurrency });
-    });
-};

package/src/commands/global.js

@@ -1,43 +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 { Command } = require('commander');
-const { run, isDev, isProd, promptForTs, downloadPro, checkDBDialect } = require('../util');
-
-/**
- *
- * @param {Command} cli
- */
-module.exports = (cli) => {
-  const { APP_PACKAGE_ROOT, SERVER_TSCONFIG_PATH } = process.env;
-  cli
-    .allowUnknownOption()
-    .option('-h, --help')
-    .option('--ts-node-dev')
-    .action(async (options) => {
-      checkDBDialect();
-      const cmd = process.argv.slice(2)?.[0];
-      if (cmd === 'install') {
-        await downloadPro();
-      }
-      if (isDev()) {
-        promptForTs();
-        await run('tsx', [
-          '--tsconfig',
-          SERVER_TSCONFIG_PATH,
-          '-r',
-          'tsconfig-paths/register',
-          `${APP_PACKAGE_ROOT}/src/index.ts`,
-          ...process.argv.slice(2),
-        ]);
-      } else if (isProd()) {
-        await run('node', [`${APP_PACKAGE_ROOT}/lib/index.js`, ...process.argv.slice(2)]);
-      }
-    });
-};

package/src/commands/index.js

@@ -1,45 +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 { Command } = require('commander');
-const { isPackageValid, generateAppDir } = require('../util');
-
-/**
- *
- * @param {Command} cli
- */
-module.exports = (cli) => {
-  generateAppDir();
-  require('./global')(cli);
-  require('./create-nginx-conf')(cli);
-  require('./locale')(cli);
-  require('./build')(cli);
-  require('./tar')(cli);
-  require('./dev')(cli);
-  require('./start')(cli);
-  require('./e2e')(cli);
-  require('./perf')(cli);
-  require('./clean')(cli);
-  require('./doc')(cli);
-  require('./pm2')(cli);
-  require('./test')(cli);
-  require('./test-coverage')(cli);
-  require('./benchmark')(cli);
-  require('./umi')(cli);
-  require('./update-deps')(cli);
-  require('./upgrade')(cli);
-  require('./postinstall')(cli);
-  require('./pkg')(cli);
-  require('./instance-id')(cli);
-  require('./view-license-key')(cli);
-  require('./client')(cli);
-  if (isPackageValid('@umijs/utils')) {
-    require('./create-plugin')(cli);
-  }
-};

package/src/commands/instance-id.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.
- */
-
-const chalk = require('chalk');
-const { Command } = require('commander');
-const { run, isDev } = require('../util');
-const { getInstanceIdAsync } = require('@nocobase/license-kit');
-const path = require('path');
-const fs = require('fs');
-const { logger } = require('../logger');
-
-/**
- *
- * @param {Command} cli
- */
-module.exports = (cli) => {
-  cli
-    .command('generate-instance-id')
-    .description('Generate InstanceID')
-    .option('--force', 'Force generate InstanceID')
-    .action(async (options) => {
-      logger.info('Generating InstanceID...');
-      const dir = path.resolve(process.cwd(), 'storage/.license');
-      const filePath = path.resolve(dir, 'instance-id');
-      if (fs.existsSync(filePath) && !options.force) {
-        logger.info('InstanceID already exists at ' + filePath);
-        return;
-      } else {
-        if (!fs.existsSync(dir)) {
-          fs.mkdirSync(dir, { recursive: true });
-        }
-        try {
-          const instanceId = await getInstanceIdAsync();
-          fs.writeFileSync(filePath, instanceId + '\n');
-          logger.info(`InstanceID saved to ${filePath}`);
-        } catch (e) {
-          logger.error('Failed to generate InstanceID', e.message || e);
-        }
-      }
-    });
-};