cauditor/分析器

生成并提交 cauditor.org 的指标

1.2.8 2016-04-21 19:40 UTC

This package is not auto-updated.

Last update: 2024-09-12 00:24:23 UTC


README

Build status Code coverage Code quality Latest version Downloads total

Pretty stats

设置它是一个荒谬的简单两步过程

安装

1. Composer

如果您使用 Composer 来管理项目的依赖关系,只需在您的 composer.json 文件中添加 cauditor/analyzer 依赖

composer require cauditor/analyzer --dev

这将使此库在您的 CI 服务器中可用。

2. CI 构建

将此添加到您的 .travis.ymlafter_success 语句中

.travis.yml

after_success:
  - vendor/bin/cauditor

这将指示 Travis CI 生成指标并将其提交到 cauditor.org

这应该也适用于其他 CI 提供商,只要您确保运行了 composer install --dev 以安装此客户端。

3. 看看那些漂亮的指标!

将您的浏览器指向 https://www.cauditor.org/you/your-project 并查看结果!

配置

在您的项目根目录中添加一个 .cauditor.yml 文件。可用的配置选项(及其默认值)包括

.cauditor.yml

# path where metrics data will be exported to
build_path: build/cauditor
# folders to be excluded when analyzing code
exclude_folders: [tests, vendor]

请注意,除了配置之外,'vendors'、'.git' 和 '.svn' 文件夹始终被排除。