语言与代码行数 (Open Source)

DefectDojo 可以显示某个产品的编程语言构成和代码行数明细,这些数据通过 API 导入 cloc(Count Lines of Code)工具生成的报告来填充。

Generating the cloc Report

对您的代码库运行 cloc,并使用 --json 标志以生成格式正确的 JSON 文件:

cloc --json /path/to/your/project > cloc-report.json

Importing via the API

通过 API 将该 JSON 报告上传到 DefectDojo。导入时,该产品现有的所有语言数据都会被新文件的内容替换。

该导入端点的文档参见 DefectDojo API v2 文档

Viewing Results

导入完成后,语言构成明细会显示在产品详情页面的左侧,展示每种语言及其代码行数。每种语言的颜色由 Language_Type 表中的条目定义,该表预先填充了来自 GitHub 的数据。

Updating Language Colors

随着新语言的出现,GitHub 会定期更新语言颜色。要拉取最新的颜色数据,请运行以下管理命令:

./manage.py import_github_languages

该命令会从 ozh/github-colors 读取数据,并添加新语言或更新现有颜色。