如何使用eslint/prettier不修改文件仅校验外部文件是否符合代码风格指南

所有实现均不需要调用子进程执行命令，直接导入对应包调用官方公开API即可实现，仅校验不修改文件，可自由传入任意路径的外部文件。

1. ESLint实现方案 #

前置依赖 #

安装ESLint包：npm install eslint

代码示例 #

const { ESLint } = require('eslint');

async function lintExternalFile(filePath, teamConfig) {
  // 初始化ESLint实例，关闭自动修复
  const eslint = new ESLint({
    fix: false, // 核心配置：禁止修改文件
    overrideConfig: teamConfig, // 可直接传入团队规则对象，也可通过overrideConfigPath指定配置文件路径
    useEslintrc: false, // 如果不使用当前项目的.eslintrc，可设为false，仅用传入的配置
  });

  // 传入任意外部文件路径，支持传单个路径或路径数组
  const results = await eslint.lintFiles(filePath);

  // 解析校验结果，获取违规位置、规则id、错误说明
  const violations = results.map(result => ({
    filePath: result.filePath,
    errorCount: result.errorCount,
    warningCount: result.warningCount,
    messages: result.messages.map(msg => ({
      line: msg.line,
      column: msg.column,
      ruleId: msg.ruleId,
      message: msg.message,
      severity: msg.severity === 2 ? 'error' : 'warning'
    }))
  }));

  return violations;
}

// 调用示例：传入外部文件路径和团队规则
lintExternalFile('/path/to/your/external/file.js', {
  rules: {
    semi: ['error', 'always'],
    quotes: ['error', 'single']
    // 其他团队规则
  }
}).then(console.log);

2. Prettier实现方案 #

前置依赖 #

安装Prettier包：npm install prettier

代码示例 #

const prettier = require('prettier');
const fs = require('fs/promises');

async function checkPrettierConformance(filePath, teamConfig) {
  // 读取外部文件内容
  const fileContent = await fs.readFile(filePath, 'utf8');
  // 获取文件对应的Prettier解析器，也可以手动指定
  const fileInfo = await prettier.getFileInfo(filePath);
  if (fileInfo.ignored || fileInfo.inferredParser === null) {
    return { isConform: true, violations: [] };
  }

  // 仅校验是否符合规则，不修改文件
  const isConform = await prettier.check(fileContent, {
    ...teamConfig,
    parser: fileInfo.inferredParser,
  });

  // 如果不符合，可通过格式化后对比得到具体差异位置
  let violations = [];
  if (!isConform) {
    const formatted = await prettier.format(fileContent, {
      ...teamConfig,
      parser: fileInfo.inferredParser,
    });
    // 逐行对比得到差异行号，也可引入diff工具库获取更精准的位置
    const originalLines = fileContent.split('\n');
    const formattedLines = formatted.split('\n');
    originalLines.forEach((line, index) => {
      if (line !== formattedLines[index]) {
        violations.push({
          line: index + 1,
          expected: formattedLines[index],
          actual: line
        });
      }
    });
  }

  return {
    filePath,
    isConform,
    violations
  };
}

// 调用示例
checkPrettierConformance('/path/to/your/external/file.js', {
  semi: true,
  singleQuote: true,
  tabWidth: 2
  // 其他团队Prettier规则
}).then(console.log);

注意事项 #

• 如果需要复用项目内已有的配置文件，可分别通过ESLint的overrideConfigPath参数、Prettier的resolveConfig方法加载指定路径的配置文件，不需要将配置硬编码在代码中。
• 两种方案均支持传入内存中的代码字符串进行校验，不需要将内容写入本地文件，适配命令行、接口上传等多种输入场景。

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