elfiggo/brobdingnagian-detector

检测你的类和方法是否过大,并建议提取职责和协作者

0.2.0-alpha 2015-11-16 10:05 UTC

This package is not auto-updated.

Last update: 2024-09-29 01:02:56 UTC


README

Build Status

brobdingnagian-detector-phpspec-extension

检测你的类和方法是否过大,并建议提取职责和协作者

安装

     "require-dev": {
        "elfiggo/brobdingnagian-detector":"^0.1.0"
      }

启用扩展

将以下内容添加到你的 phpspec.yml 文件中的 extensions 部分

extensions:
    - Elfiggo\Brobdingnagian\Extension

如果你遇到问题,请参阅 PhpSpec 扩展文档

参数

brobdingnagian:
    class-size: 300
    method-size: 10
    number-of-methods: 5
    filter-methods:
       static: true
       public: true
       protected: true
       private: true
       abstract: true
       final: true
    dependencies: 4
    list-brob: true
    create-csv: false
    number-of-interfaces: 3
    number-of-traits: 1

使用方法

正常使用 phpspec,如果你想禁用 Brobdingnagian 的异常,并列出类、方法或依赖项,请传递以下标志,该标志优先于 phpspec.yml 参数。

phpspec r --list-brob=true (Turns Exceptions Off)
phpspec r --list-brob=false (Turns Exceptions On)

过滤方法

将方法设置为 false 来关闭对私有或最终方法的检查

你可以完全删除 filter-methods 参数

关闭 final 但不关闭 public 的方法在 finalpublic 的情况下仍将显示,因为它们符合 public 签名。

有关更多信息,请参阅 ReflectionClass::getMethods

支持的 PHP 版本

目前支持 PHP 5.5 及以上版本

遵循 php 安全支持 的发布周期,以确定最小支持的版本

待办事项 - Brobdingnagian

  1. 发货! (East Croydon)
  2. 添加建议的类名字典以供角色使用
  3. 发货! (Blackpool)
  4. 要求将类/方法拆分为辅助类
    • 创建具有当前类 Spec 模板的新辅助类
  5. 发货! (Derby)