btc/phpmd-rulesets

Exetnded mess detection rules from phpmd for BTC applications.

DEPRECATED

This is no longer supported, _(*1)

BTC\PHPMD-Rulesets

Features

Extends phpmd with rules for BTC applications. Also add extra rules from clean code., _(*2)

• Clean Code
  • ClassNameSingleResponsibility
  • MethodOneTryCatch
  • SuperfluousComment
  • InlineIf
  • MeaninglessMethodName
  • TraitPublicMethod
  • SwitchStatement
• Symfony
  • ControllerMethodName
  • EntitySimpleGetterSetter
  • EntityConstants
  • ConstructorNewOperator

Installation

Open a command console, enter your project directory and execute the following command to download the latest stable version:, _(*3)

composer require --dev btc/phpmd-rulesets

OR, _(*4)

Composer is used for installation. Add the following lines to your composer.jon file:, _(*5)

"require-dev": {
  "btc/phpmd-rulesets": "^1.0"
}

Usage

Use grumphp and configure phpmd task with the following lines in your grumphp.yml, _(*6)

phpmd:
    exclude: ['vendor']
    ruleset: ['/vendor/btc/phpmd-rulesets/Rulesets/symfony.xml', '/vendor/btc/phpmd-rulesets/Rulesets/cleancode.xml']
    triggered_by: [php]