Skip to content

Fix/php tools #421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/tools/phpcs.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,15 @@ PHPCS supports many coding standards including:
- **PEAR**: PEAR coding standard
- **Zend**: Zend Framework coding standard

## Configuration

PHPCS requires a configuration file to run. CodeRabbit will only run PHPCS if one of the following configuration files is found:

- `phpcs.xml` - XML configuration file
- `phpcs.xml.dist` - Distributed XML configuration file

CodeRabbit will not run PHPCS if no configuration file is found.

## Links

- [PHPCS GitHub Repository](https://github.com/squizlabs/PHP_CodeSniffer)
Expand Down
7 changes: 7 additions & 0 deletions docs/tools/phpmd.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,13 @@ PHPMD can detect various code quality issues including:
- **Unused Code Rules**: Detects unused variables, parameters, methods, and classes
- **Size Rules**: Identifies overly complex methods and classes

### Review Mode Behavior

CodeRabbit's review mode affects which PHPMD rules are applied:

- **Chill Mode**: Only checks for unused code (`unusedcode` rule set)
- **Nitpick Mode**: Checks all rule sets including clean code, code size, controversial rules, design issues, naming conventions, and unused code (`cleancode,codesize,controversial,design,naming,unusedcode`)

## Links

- [PHPMD Official Website](https://phpmd.org/)
Expand Down