Merge pull request #4 from leviy/add-phpmd-config

Add a ruleset for PHP Mess Detector

Author: nicwortel

.travis.yml

@@ -10,4 +10,6 @@ cache:
 
 install: composer install
 
-script: vendor/bin/phpcs --standard=src/LEVIY/ruleset.xml --basepath=. --report-file=phpcs.log --report-width=120 tests/; diff tests/expected.log phpcs.log
+script:
+  - vendor/bin/phpmd src/ text phpmd.xml
+  - vendor/bin/phpcs --standard=src/LEVIY/ruleset.xml --basepath=. --report-file=phpcs.log --report-width=120 tests/; diff tests/expected.log phpcs.log

README.md

@@ -4,17 +4,21 @@
 [![Packagist version](https://img.shields.io/packagist/v/leviy/coding-standard.svg)](https://packagist.org/packages/leviy/coding-standard)
 [![PHP from Packagist](https://img.shields.io/packagist/php-v/leviy/coding-standard.svg)](https://github.com/leviy/php-coding-standard/blob/master/composer.json)
 
-The LEVIY coding standard for PHP code, including a PHPCS ruleset.
+The LEVIY coding standard for PHP code, with rulesets for
+[PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) and
+[PHP Mess Detector](https://phpmd.org/).
 
 ## Installation
 
-Install the coding standard using [Composer](https://getcomposer.org/):
+Install this package using [Composer](https://getcomposer.org/):
 
 ```bash
 composer require --dev leviy/coding-standard
 ```
 
-Create a `phpcs.xml` file containing the following bootstrap code sniffer configuration:  
+### Installing the PHP CodeSniffer ruleset
+
+Create a file `phpcs.xml` in the root of the project with the following contents:
 
 ```xml
 <?xml version="1.0"?>
@@ -31,30 +35,45 @@ Create a `phpcs.xml` file containing the following bootstrap code sniffer config
 </ruleset>
 ```
 
-An annotated `ruleset.xml` configuration file can be found [here](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml) 
-where you can see the complete range of features and configuration options that can be used to modify the configuration to your project needs.
+### Installing the PHP Mess Detector ruleset
 
-## Usage
+Create a file `phpmd.xml` in the root of the project with the following contents:
 
-Run the code sniffer and show both errors and warnings:
-
-    bin/phpcs --standard=phpcs.xml
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset xmlns="http://pmd.sf.net/ruleset/1.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"
+         name="Mess detector ruleset">
+    <description>Ruleset for PHP Mess Detector that enforces coding standards</description>
+
+    <rule ref="vendor/leviy/coding-standard/phpmd.xml"/>
+</ruleset>
+```
 
-Run the code sniffer and show only errors:
+## Configuration
 
-    bin/phpcs --standard=phpcs.xml --error-severity=0 --warning-severity=1
+### PHP CodeSniffer
 
-Run the code sniffer and show only warnings:
+An annotated `ruleset.xml` configuration file can be found [here](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml)
+where you can see the complete range of features and configuration options that can be used to modify the configuration to your project needs.
 
-    bin/phpcs --standard=phpcs.xml --error-severity=0 --warning-severity=1
+### PHP Mess Detector
 
-Run the code sniffer against a specific file or directory
+Documentation about tweaking the ruleset and exluding rules or changing settings
+can be found [here](https://phpmd.org/documentation/creating-a-ruleset.html).
 
-    bin/phpcs --standard=phpcs.xml src/path/to/file.php
+## Usage
         
-    bin/phpcs --standard=phpcs.xml src/path/to/file_1.php src/path/to/file_2.php
+Run `vendor/bin/phpcs` to run PHP CodeSniffer. If you have a file `phpcs.xml` or
+`phpcs.xml.dist` in root directory of the project, CodeSniffer will use it
+automatically. Add a path to run CodeSniffer only against that
+file or directory. See
+[Usage](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Usage) for more
+detailed usage instructions.
 
-    bin/phpcs --standard=phpcs.xml src/path/to/directory
+Run `vendor/bin/phpmd src/ text phpmd.xml` to run PHP Mess Detector against the
+`src` directory and print a report in the "text" format.
 
 ## PHPStorm code sniffer validation
 

composer.json

@@ -1,31 +1,32 @@
 {
-  "name": "leviy/coding-standard",
-  "type": "phpcodesniffer-standard",
-  "description": "LEVIY Coding Standard",
-  "license": "proprietary",
-  "authors": [
-    {
-      "name": "LEVIY B.V. (Netherlands)",
-      "email": "[email protected]"
+    "name": "leviy/coding-standard",
+    "type": "phpcodesniffer-standard",
+    "description": "LEVIY Coding Standard",
+    "license": "proprietary",
+    "authors": [
+        {
+            "name": "LEVIY B.V. (Netherlands)",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "php": "^7.1",
+        "dealerdirect/phpcodesniffer-composer-installer": "^0.4.4",
+        "escapestudios/symfony2-coding-standard": "^3.0",
+        "phpmd/phpmd": "^2.6",
+        "slevomat/coding-standard": "^4.3",
+        "squizlabs/php_codesniffer": "^3.0"
+    },
+    "require-dev": {
+        "liip/rmt": "^1.3"
+    },
+    "autoload": {
+        "psr-4": {
+            "": "src"
+        }
+    },
+    "minimum-stability": "stable",
+    "config": {
+        "sort-packages": true
     }
-  ],
-  "require": {
-    "php": "^7.1",
-    "dealerdirect/phpcodesniffer-composer-installer": "^0.4.4",
-    "escapestudios/symfony2-coding-standard": "^3.0",
-    "slevomat/coding-standard": "^4.3",
-    "squizlabs/php_codesniffer": "^3.0"
-  },
-  "require-dev": {
-    "liip/rmt": "^1.3"
-  },
-  "autoload": {
-    "psr-4": {
-      "": "src"
-    }
-  },
-  "minimum-stability": "stable",
-  "config": {
-    "sort-packages": true
-  }
 }