tldr/pages/common/phpmd.md

33 lines
1.2 KiB
Markdown
Raw Normal View History

2018-11-26 12:39:32 +00:00
# phpmd
> A PHP mess detector that checks for common potential problems.
2019-05-29 14:53:49 +01:00
> More information: <https://github.com/phpmd/phpmd>.
2018-11-26 12:39:32 +00:00
- Display a list of available rulesets and formats:
`phpmd`
- Scan a file or directory for problems using comma-separated rulesets:
`phpmd {{path/to/file_or_directory}} {{xml|text|html}} {{ruleset1,ruleset2,...}}`
2018-11-26 12:39:32 +00:00
- Specify the minimum priority threshold for rules:
`phpmd {{path/to/file_or_directory}} {{xml|text|html}} {{ruleset1,ruleset2,...}} --minimumpriority {{priority}}`
2018-11-26 12:39:32 +00:00
- Include only the specified extensions in analysis:
`phpmd {{path/to/file_or_directory}} {{xml|text|html}} {{ruleset1,ruleset2,...}} --suffixes {{extensions}}`
2018-11-26 12:39:32 +00:00
- Exclude the specified comma-separated directories:
`phpmd {{path/to/file_or_directory1,path/to/file_or_directory2,...}} {{xml|text|html}} {{ruleset1,ruleset2,...}} --exclude {{directory_patterns}}`
2018-11-26 12:39:32 +00:00
- Output the results to a file instead of `stdout`:
2018-11-26 12:39:32 +00:00
`phpmd {{path/to/file_or_directory}} {{xml|text|html}} {{ruleset1,ruleset2,...}} --reportfile {{path/to/report_file}}`
2018-11-26 12:39:32 +00:00
- Ignore the use of warning-suppressive PHPDoc comments:
2018-11-26 12:39:32 +00:00
`phpmd {{path/to/file_or_directory}} {{xml|text|html}} {{ruleset1,ruleset2,...}} --strict`