https://github.com/btcctb/phpmd-rulesets

DEPRECATED ! Extends phpmd with rules for BTC applications. Also add extra rules from clean code.
https://github.com/btcctb/phpmd-rulesets

deprecated phpmd-rulesets symfony3

Last synced: 3 months ago
JSON representation

DEPRECATED ! Extends phpmd with rules for BTC applications. Also add extra rules from clean code.

• Host: GitHub
• URL: https://github.com/btcctb/phpmd-rulesets
• Owner: BTCCTB
• Archived: true
• Created: 2017-01-20T11:11:20.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2019-05-29T08:34:02.000Z (over 5 years ago)
• Last Synced: 2024-09-29T16:22:27.797Z (3 months ago)
• Topics: deprecated, phpmd-rulesets, symfony3
• Language: PHP
• Homepage:
• Size: 14.6 KB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# DEPRECATED

This is no longer supported

# BTC\PHPMD-Rulesets

## Features

Extends phpmd with rules for BTC applications. Also add extra rules from clean code.

* 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:

```bash

composer require --dev btc/phpmd-rulesets

```

OR

Composer is used for installation. Add the following lines to your ```composer.jon``` file:

```json

"require-dev": {

  "btc/phpmd-rulesets": "^1.0"

}

```

## Usage

Use [grumphp](https://github.com/phpro/grumphp) and configure phpmd task with the following lines in your ```grumphp.yml```

```yaml

phpmd:

    exclude: ['vendor']

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

    triggered_by: [php]

```