从无到有实现Lint增量扫描

Android

2023-11-06 19:58:22

Lint增量扫描

我今天要分享的是从无到有实现增量扫描的过程，有的时候实现一个方案从来不是重点，我们对于方案的认知程度才是我们自己真正的财富。

对于很多开发者来说，代码扫描已经老生常谈，业界方案一搜一大堆，有什么好讲的？大部人看到这篇文章的时候肯定这么想吧，但是注意，我今天要分享的不是全量扫描，我分享的是增量扫描。

为什么要做增量扫描？

举个例子：

我们有一个后台管理系统，有几十个微服务，每个微服务有上百万行代码，如果我们每次提交代码都做全量扫描，扫描一次需要几十分钟甚至几个小时，试想一下，如果我需要做一些小的改动，比如修改一个错别字，却需要等待几个小时的扫描结果，这显然是不合理的。

因此，我们需要一种增量扫描的方式，只扫描受影响的文件，这样就可以大大提高扫描效率。

如何实现增量扫描？

实现增量扫描需要解决两个问题：

如何确定受影响的文件？
如何只扫描受影响的文件？

确定受影响的文件

我们使用git diff来确定受影响的文件。git diff命令可以比较两个提交之间的差异，并输出受影响的文件列表。

只扫描受影响的文件

我们使用eslint --fix命令来只扫描受影响的文件。eslint --fix命令可以修复代码中的问题，并输出修复后的代码。

实现过程

我们使用node.js编写了一个脚本，来实现增量扫描。脚本的流程如下：

获取当前提交和上一次提交之间的差异。
确定受影响的文件。
只扫描受影响的文件。
输出扫描结果。

脚本代码

const execa = require('execa');

async function main() {
  // 获取当前提交和上一次提交之间的差异
  const diff = await execa('git', ['diff', '--name-only', 'HEAD^', 'HEAD']);

  // 确定受影响的文件
  const affectedFiles = diff.stdout.split('\n');

  // 只扫描受影响的文件
  const scanResults = await Promise.all(affectedFiles.map(async file => {
    const result = await execa('eslint', ['--fix', file]);
    return result.stdout;
  }));

  // 输出扫描结果
  console.log(scanResults.join('\n'));
}

main();