README

PHPMD sweetened with ease 🍒

SugaredRim\PHPMD takes an opinionated view of code style checking with PHPMD, it is preconfigured to get you up and running as quickly as possible.

Install

$ composer require --dev sugared-rim/phpmd

Usage

Instead of running phpmd with all its options, just run sugared-rim-phpmd - that's it:

{
    ...
    "require-dev": {
        "sugared-rim/phpmd": ...
    },
    "scripts": {
        "lint": "sugared-rim/phpmd"
    }
}

Configuration

You may overwrite some options by putting it in your composer.json.

Some of the default settings:

{
    ...
    "scripts": {
        "lint": "sugared-rim/phpmd"
    },
    "extra": {
        "sugared-rim/phpmd": {
            "inputPath": "src,tests",
            "reportFormat": "text",
            "ruleSets": "cleancode,codesize,controversial,design,naming,unusedcode"
        }
    }
}

License

MIT © Michael Mayer