vile-phpmd     

A Vile plugin for identifying common style and
maintainability issues in your PHP code (via PHPMD).

Requirements

- Node.js
- PHP

Installation

Currently, you need to have phpmd installed manually.

For example, on Arch:

yaourt -Sa phpmd
npm i -D vile vile-phpmd

Config

There should be (more or less) a one to one relationship
with the phpmd cli.

$3

``yaml
phpmd:
config:
paths: "a/" || [ "a/", "b/**" ]
`

$3

`yaml
phpmd:
config:
rulesets: "codesize" || [ "codesize", "controversial" ]
`

$3

`yaml
phpmd:
config:
rulesets: .phpmd.xml
`

$3

`yaml
phpmd:
config:
exclude: "..." || [ "..." ]
`

$3

`yaml
phpmd:
config:
suffixes: "..." || [ "..." ]
`

$3

`yaml
phpmd:
config:
minimumpriority: 1
`

$3

`yaml
phpmd:
config:
strict: true
`

Versioning

This project uses Semver.

Licensing

This project is licensed under the MPL-2.0 license.

Any contributions made to this project are made under the current license.

Contributions

Current list of Contributors.

Any contributions are welcome and appreciated!

All you need to do is submit a Pull Request.

1. Please consider tests and code quality before submitting.
2. Please try to keep commits clean, atomic and well explained (for others).

$3

Current issue tracker is on GitHub.

Even if you are uncomfortable with code, an issue or question is welcome.

$3

By participating in this project you agree to our Code of Conduct.

Architecture

This project is currently written in JavaScript. PHPMD provides
an XML CLI output that is currently used until a more ideal
option is implemented.

- bin houses any shell based scripts
- src is es6+ syntax compiled with Babel
- lib` generated js library

Developing

cd vile-phpmd
npm install
# install phpmd cli globally
npm run dev
npm test