如何通过脚本识别项目所用测试框架并执行对应运行命令

核心逻辑 #

通过识别项目中各测试框架的标志性配置文件或package.json中的依赖/配置字段，自动判断当前项目使用的测试框架，再执行对应框架的专属测试命令。

常见测试框架的识别规则 #

• Cypress：项目根目录存在cypress.config.js/cypress.config.ts或cypress.json
• Jest：存在jest.config.js/jest.config.ts，或package.json中包含jest配置字段
• Mocha：存在mocha.config.js/.mocharc.json，或test目录下有mocha.opts
• Playwright：存在playwright.config.js/playwright.config.ts
• Vitest：存在vitest.config.js/vitest.config.ts，或package.json中包含vitest依赖

Node.js脚本实现示例 #

const fs = require('fs');
const { exec } = require('child_process');
const path = require('path');

// 检测当前项目的测试框架
function detectTestFramework() {
  const rootDir = process.cwd();
  const packageJsonPath = path.join(rootDir, 'package.json');
  let packageJson = {};

  if (fs.existsSync(packageJsonPath)) {
    packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
  }

  // 按优先级检测各框架
  if (fs.existsSync(path.join(rootDir, 'cypress.config.js')) || fs.existsSync(path.join(rootDir, 'cypress.config.ts')) || fs.existsSync(path.join(rootDir, 'cypress.json'))) {
    return 'cypress';
  } else if (fs.existsSync(path.join(rootDir, 'playwright.config.js')) || fs.existsSync(path.join(rootDir, 'playwright.config.ts'))) {
    return 'playwright';
  } else if (fs.existsSync(path.join(rootDir, 'vitest.config.js')) || fs.existsSync(path.join(rootDir, 'vitest.config.ts')) || packageJson.devDependencies?.vitest) {
    return 'vitest';
  } else if (fs.existsSync(path.join(rootDir, 'jest.config.js')) || fs.existsSync(path.join(rootDir, 'jest.config.ts')) || packageJson.jest) {
    return 'jest';
  } else if (fs.existsSync(path.join(rootDir, 'mocha.config.js')) || fs.existsSync(path.join(rootDir, '.mocharc.json')) || fs.existsSync(path.join(rootDir, 'test', 'mocha.opts'))) {
    return 'mocha';
  }

  return null;
}

// 执行对应框架的测试命令
function runTests(framework) {
  let command;
  switch (framework) {
    case 'cypress':
      // 若需直接调用Cypress API而非命令行，可替换为下方注释的代码
      command = 'npx cypress run';
      /*
      const cypress = require('cypress');
      cypress.run().then(results => {
        console.log('Cypress测试结果:', results);
        process.exit(results.totalFailed ? 1 : 0);
      }).catch(err => {
        console.error('Cypress执行失败:', err);
        process.exit(1);
      });
      return;
      */
      break;
    case 'jest':
      command = 'npx jest';
      break;
    case 'mocha':
      command = 'npx mocha';
      break;
    case 'playwright':
      command = 'npx playwright test';
      break;
    case 'vitest':
      command = 'npx vitest run';
      break;
    default:
      console.error('未检测到支持的测试框架');
      process.exit(1);
  }

  console.log(`检测到${framework}，执行测试命令：${command}`);
  exec(command, (error, stdout, stderr) => {
    if (error) {
      console.error(`测试执行失败：${error.message}`);
      return;
    }
    if (stderr) {
      console.error(`测试输出错误：${stderr}`);
      return;
    }
    console.log(`测试执行结果：\n${stdout}`);
  });
}

// 主执行流程
const framework = detectTestFramework();
if (framework) {
  runTests(framework);
} else {
  console.error('无法识别当前项目的测试框架，请手动指定');
  process.exit(1);
}

扩展说明 #

• 可根据需求添加更多框架的检测规则，比如Cucumber（检测cucumber.js配置文件）、React Testing Library（结合Jest的依赖判断）等
• 若项目使用自定义配置文件路径，需调整检测逻辑中的文件路径判断
• 对于已全局安装的框架，可去掉命令中的npx直接执行框架命令

内容的提问来源于stack exchange，提问作者Hashir Azam