f6fac6c4bc
Fix bin/publish: use correct .env path for rspade_system Fix bin/publish script: prevent grep exit code 1 from terminating script 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
89 lines
3.1 KiB
Markdown
Executable File
89 lines
3.1 KiB
Markdown
Executable File
<p align="center">
|
|
<a href="https://cs.symfony.com">
|
|
<img src="./logo.png" title="PHP CS Fixer" alt="PHP CS Fixer logo">
|
|
</a>
|
|
</p>
|
|
|
|
# PHP Coding Standards Fixer
|
|
|
|
The PHP Coding Standards Fixer (PHP CS Fixer) tool fixes your code to follow standards;
|
|
whether you want to follow PHP coding standards as defined in the PSR-1, PSR-2, etc.,
|
|
or other community driven ones like the Symfony one.
|
|
You can **also** define your (team's) style through configuration.
|
|
|
|
It can modernize your code (like converting the ``pow`` function to the ``**`` operator on PHP 5.6)
|
|
and (micro) optimize it.
|
|
|
|
If you are already using a linter to identify coding standards problems in your
|
|
code, you know that fixing them by hand is tedious, especially on large
|
|
projects. This tool does not only detect them, but also fixes them for you.
|
|
|
|
## Supported PHP Versions
|
|
|
|
* PHP 7.4
|
|
* PHP 8.0
|
|
* PHP 8.1
|
|
* PHP 8.2
|
|
* PHP 8.3
|
|
* PHP 8.4
|
|
|
|
> **Note**
|
|
> Each new PHP version requires a huge effort to support the new syntax.
|
|
> That's why the latest PHP version might not be supported yet. If you need it,
|
|
> please, consider supporting the project in any convenient way, for example
|
|
> with code contribution or reviewing existing PRs. To run PHP CS Fixer on yet
|
|
> unsupported versions "at your own risk" - use `--allow-unsupported-php-version=yes` option.
|
|
|
|
## Documentation
|
|
|
|
### Installation
|
|
|
|
The recommended way to install PHP CS Fixer is to use [Composer](https://getcomposer.org/download/):
|
|
|
|
```console
|
|
composer require --dev friendsofphp/php-cs-fixer
|
|
## or when facing conflicts in dependencies:
|
|
composer require --dev php-cs-fixer/shim
|
|
```
|
|
|
|
For more details and other installation methods (also with Docker or behind CI), see
|
|
[installation instructions](./doc/installation.rst).
|
|
|
|
### Usage
|
|
|
|
Assuming you installed PHP CS Fixer as instructed above, you can run the
|
|
following command to fix the PHP files in the `src` directory:
|
|
|
|
```console
|
|
./vendor/bin/php-cs-fixer fix src
|
|
```
|
|
|
|
See [usage](./doc/usage.rst), list of [built-in rules](./doc/rules/index.rst), list of [rule sets](./doc/ruleSets/index.rst)
|
|
and [configuration file](./doc/config.rst) documentation for more details.
|
|
|
|
If you need to apply code styles that are not supported by the tool, you can
|
|
[create custom rules](./doc/custom_rules.rst).
|
|
|
|
## Editor Integration
|
|
|
|
Dedicated plugins exist for:
|
|
|
|
* [NetBeans](https://plugins.netbeans.apache.org/catalogue/?id=36)
|
|
* [PhpStorm](https://www.jetbrains.com/help/phpstorm/using-php-cs-fixer.html)
|
|
* [Sublime Text](https://github.com/benmatselby/sublime-phpcs)
|
|
* [Vim](https://github.com/stephpy/vim-php-cs-fixer)
|
|
* [VS Code](https://github.com/junstyle/vscode-php-cs-fixer)
|
|
|
|
## Community
|
|
|
|
The PHP CS Fixer is maintained on GitHub at <https://github.com/PHP-CS-Fixer/PHP-CS-Fixer>.
|
|
Bug reports and ideas about new features are welcome there.
|
|
|
|
You can reach us in the [GitHub Discussions](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/discussions/) regarding the
|
|
project, configuration, possible improvements, ideas and questions. Please visit us there!
|
|
|
|
## Contribute
|
|
|
|
The tool comes with quite a few built-in fixers, but everyone is more than
|
|
welcome to [contribute](CONTRIBUTING.md) more of them.
|