A Vile plugin for identifying common style and maintainability issues in your PHP code (via PHPMD).
Currently, you need to have phpmd
installed manually.
For example, on Arch:
yaourt -Sa phpmd
npm i -D vile vile-phpmd
There should be (more or less) a one to one relationship
with the phpmd
cli.
phpmd:
config:
paths: "a/**" || [ "a/**", "b/**" ]
phpmd:
config:
rulesets: "codesize" || [ "codesize", "controversial" ]
phpmd:
config:
rulesets: .phpmd.xml
phpmd:
config:
exclude: "..." || [ "..." ]
phpmd:
config:
suffixes: "..." || [ "..." ]
phpmd:
config:
minimumpriority: 1
phpmd:
config:
strict: true
This project uses Semver.
This project is licensed under the MPL-2.0 license.
Any contributions made to this project are made under the current license.
Current list of Contributors.
Any contributions are welcome and appreciated!
All you need to do is submit a Pull Request.
- Please consider tests and code quality before submitting.
- Please try to keep commits clean, atomic and well explained (for others).
Current issue tracker is on GitHub.
Even if you are uncomfortable with code, an issue or question is welcome.
By participating in this project you agree to our Code of Conduct.
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 scriptssrc
is es6+ syntax compiled with Babellib
generated js library
cd vile-phpmd
npm install
# install phpmd cli globally
npm run dev
npm test