swift-code-metrics

项目概述

swift-code-metrics 是一个用于 Swift 项目的代码度量分析工具。这个工具的主要目标是通过扫描项目的多个模块，为用户提供有关软件架构状态的见解，帮助开发者更好地理解和评估其 Swift 项目的质量和设计。

背景

swift-code-metrics 的灵感来源于 Robert C. Martin 的书籍《Clean Architecture》。通过对项目中的不同组件进行识别，该软件可以评估软件行业中几种常见的代码度量指标。这些指标包括：

• 确定项目中具体类和接口的总数。
• 框架的不稳定性和抽象度。
• 距离主序列的距离。
• 代码行数（LOC）。
• 注释数量（NOC）。
• 注释百分比（POC）。
• 方法数量（NOM）。
• 具体类和结构体的数量。
• 测试数量（NOT）。
• 导入数量（NOI）。
• 框架依赖关系图（内部和外部依赖关系的数量）。

使用要求

swift-code-metrics 是一个基于 Python 3 的脚本，它依赖于以下库：matplotlib、adjustText、pyfunctional 和 pygraphviz。其中 pygraphviz 需要依赖 Graphviz 二进制文件，该文件需要在运行此工具前安装。例如，在 Mac 环境，可以使用 Homebrew 来安装：brew install graphviz。

如何使用

该工具可以通过 pip 获取，只需运行以下命令进行安装：pip3 install swift-code-metrics。

使用的基本语法为：

swift-code-metrics --source <path-to-swift-project> --artifacts <output-directory> --exclude <excluded-folders> --tests-paths <test-paths> --generate-graphs

参数说明：

• --source：Xcode 主项目或工作区所在文件夹的路径。
• --artifacts：生成 output.json 报告的存储文件夹路径。
• --exclude：可选，用空格分隔的路径字符串，用于排除分析的文件夹（例如，Tests 将忽略所有包含 Tests 的文件/文件夹）。
• --tests-paths：路径字符串的空格分隔列表，用于匹配测试类（默认：Test Tests）。
• --generate-graphs：可选，若指定，将生成与分析相关的图表并保存在 artifacts 文件夹中。

开发者指南

运行 ./install.sh 和 ./build_and_test.sh 可以安装依赖并进行测试。此项目已为 VS Code 预设了调试和测试的配置。

文档

探索项目并上手使用的具体示例可以参考项目文档。

当前局限

• 该工具专为中大型代码库设计，且需要不同框架的结合。
• 对文件层级结构有一定的依赖，除非通过项目路径覆盖文件进行指定。
• 不支持使用 Swift Package Manager 构建的库。
• 框架名称以目录结构推断，根目录文件则使用默认框架名称。
• 目前不支持计算属性列表的方法。
• 不支持内联注释。
• 仅支持 XCTest 测试框架。

未来计划

• 代码改进。
• 其他建议。

联系方式

项目作者为 Mattia Campolese。