简介
在前端开发中，我们经常需要重构代码以达到更好的可读性、可维护性、可扩展性。然而，如何评估我们的代码是否真正做到了这些目标呢？一种方法是使用代码覆盖率工具，比如 adana，它可以帮助我们统计代码覆盖率，找出代码中的冗余部分、重复代码等问题。但是，adana 的输出结果较为简略，不如 istanbul 那么直观，而且它并不能直接将结果展示为 HTML 报告。
为了解决这个问题，我们可以使用 adana-analyze 这个 npm 包，它通过对 adana 输出结果的加工与组合，可以生成更直观、更详细的代码覆盖率报告。
安装
首先，需要安装 adana-analyze 包，可以使用 npm 进行安装：
npm install adana-analyze --save-dev
使用
使用 adana-analyze 包需要以下两个步骤：
- 运行 adana，生成覆盖率数据文件
- 运行 adana-analyze，将数据文件解析为 HTML 报告
运行 adana
首先，使用 adana 运行我们的测试用例，生成覆盖率数据文件。先来看一个示例：
-- -------------------- ---- ------- ----- ---- - ---------------- ----- ------------ - -------------------------------------- ----- --------- - ----------------------- ------------------------------ ----- ----------- - ----------------------- ------------------- ----- -------- - ----------------------- ------------------------- ----- ------ - ----------------------- - ----------- -------------------- --------- --------- ------------ --- -------------------------------
其中，adana.config.json 是 adana 的配置文件，data.json 是覆盖率数据文件。adana 运行完成后，data.json 文件将包含我们需要的覆盖率数据。
运行 adana-analyze
接下来，我们需要将 data.json 文件解析为 HTML 报告。adana-analyze 包提供了一个命令行工具，可以很方便地完成这项工作。我们可以在 package.json 中添加一个脚本，如下所示：
{
"scripts": {
"coverage": "adana-analyze data.json -o coverage"
}
}然后，在命令行中执行 npm run coverage 命令，就可以生成代码覆盖率报告了。其中，data.json 表示覆盖率数据文件的路径，-o 选项表示输出目录，也可以使用 --out 参数指定。
报告解读
adana-analyze 生成的代码覆盖率报告包含以下几个部分：
- 概览页：包含各文件的代码覆盖率概况、总体覆盖率等信息；
- 文件页：展示文件的详细代码覆盖率信息；
- 代码页：展示具体代码的覆盖率信息。
下面，我们来看看每个部分具体的内容。
概览页
概览页展示的是整个项目的代码覆盖率概况。它包含以下信息：
- 总体覆盖率：所有文件的覆盖率总和；
- 文件列表：所有被测试的文件列表，每个文件的代码覆盖率信息；
- Code duplication：代码重复度，即代码重复的百分比；
- Complexity：代码复杂度，包括 Cyclomatic complexity、Halstead complexity 等指标；
- Metrics：关注点分析（Point of Interest Analysis），即确定代码的关注点。
其中，文件列表中的每个文件都包含以下信息：
- Name：文件名；
- Lines：行数；
- Statements：语句数；
- Branches：分支数；
- Functions：函数数；
- Coverage：覆盖率。
文件页
文件页展示的是单个文件的详细代码覆盖率信息。它包含以下信息：
- 文件名；
- 行数、注释数、可执行代码数；
- 精细的代码行覆盖率（sloc-by-sloc）信息，包括每行是否被执行、是否被覆盖；
- 代码覆盖率分析，包括分支覆盖率、函数覆盖率等。
代码页
代码页展示的是具体代码的覆盖率信息。它包含以下信息：
- 文件名、代码行数；
- 代码视图，包括代码、行号、标记覆盖情况的小圆点、代码块的覆盖率百分比；
- 覆盖率分析，包括分支覆盖率、函数覆盖率等。
总结
adana-analyze 是一个辅助前端开发者进行代码重构的工具包，它可以帮助我们评估我们的代码是否真正做到了可读性、可维护性、可扩展性等目标。它可以生成详细、直观、可定制化的代码覆盖率报告，让我们更好地了解自己的代码，找出其中的问题所在。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/66422