Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mansoorkhan96/php-cs-fixer
PHP CS Fixer extension for VS Code with zero config
https://github.com/mansoorkhan96/php-cs-fixer
php php-cs-fixer php8 php81 prettier prettier-php visual-studio visual-studio-code vscode vscode-extension
Last synced: 2 months ago
JSON representation
PHP CS Fixer extension for VS Code with zero config
- Host: GitHub
- URL: https://github.com/mansoorkhan96/php-cs-fixer
- Owner: mansoorkhan96
- License: mit
- Created: 2021-05-02T15:22:07.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-21T12:54:28.000Z (4 months ago)
- Last Synced: 2024-09-29T20:04:06.478Z (3 months ago)
- Topics: php, php-cs-fixer, php8, php81, prettier, prettier-php, visual-studio, visual-studio-code, vscode, vscode-extension
- Language: PHP
- Homepage: https://marketplace.visualstudio.com/items?itemName=mansoorkhan96.php-cs-fixer
- Size: 6.19 MB
- Stars: 12
- Watchers: 2
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
VsCode PHP CS Fixer
This extension requires almost zero configuration to format `.php` files. It uses `v3.62.0` of [cs.symfony.com](https://cs.symfony.com/) by default but that's easily replaceable. As long as PHP 7+ is installed on your system and in your PATH, the extension should work out of the box.
# Installation
Simply install the extension from marketplace and add it as the default formatter for PHP. In your settings.json file add/update following.
```json
"[php]": {
"editor.defaultFormatter": "mansoorkhan96.php-cs-fixer"
}
```
## Extension Optional Settings
This extension contributes the following settings:
- `php-cs-fixer.toolPath`: The path to the php-cs-fixer tool (default: "")
- `php-cs-fixer.useCache`: Use a cache file when fixing files (--using-cache) (default: true)
- `php-cs-fixer.allowRisky`: Determines whether risky rules are allowed (--allow-risky) (default: false)
- `php-cs-fixer.config`: Path to a config file (--config) (default: "WorkspaceFolder/.php-cs-fixer.php" OR "WorkspaceFolder/.php-cs-fixer.dist.php")
- `php-cs-fixer.fixOnSave`: Runs fix command on save (default: true)
- `php-cs-fixer.rules`: Rules to use when fixing files (--rules) (default: "@PSR12,@PSR1,@PSR2,@Symfony,-yoda_style")
- `php-cs-fixer.preset`: Use a preset from: laravel, PER, PSR12, symfony. You should remove it if you want to use a config file.
- `php-cs-fixer.phpCmd`: Specify path to PHP command (default: "php").
### Adding PHP CS Fixer from a composer dependency
You can require [PHP CS Fixer](https://packagist.org/packages/friendsofphp/php-cs-fixer) as composer dependency in your project and the extension will load it automatically for you.
If extension could not find/load the binary from `/vendor/bin/php-cs-fixer`, it would default to the binary included in extension.
### Manually adding PHP CS Fixer binary file?
[Download](https://cs.symfony.com/) the binary file and provide the file path to the extension.
Open `settings.json` file (Ctrl + Shift + P) and add the following setting:
```json
"php-cs-fixer.toolPath": "path\\php-cs-fixer.phar",
```
On Windows:
```json
"php-cs-fixer.toolPath": "C:\\Users\\username\\.vscode\\php-cs-fixer.phar",
```
### Config File
This extension formats `.php` files based on specified rules. Commonly these rules are defined in a `.php-cs-fixer.dist.php` OR `.php-cs-fixer.php` config file inside your project root path. The extension would try to pick a config file with above filenames, if not found it uses default rules.
You can also define a `global` config file which can be used accross all projects.
Open `settings.json` file (Ctrl + Shift + P) and add the following setting:
```json
"php-cs-fixer.config": "/full/config/file/path"
```
On Windows:
```json
"php-cs-fixer.config": "C:\\Users\\username\\.vscode\\.php-cs-fixer.php"
```
### Path to PHP Command
You can specify path to PHP Command using the config.
```json
"php-cs-fixer.phpCmd": "/Users/mansoor/Library/Application Support/Herd/bin/php",
```
#### Not sure which rules to add?
Try out following config rules. Try to remove a rule and observe the changes.
```php
setRules([
'@PSR12' => true,
'new_with_braces' => false,
'array_indentation' => true,
'array_syntax' => ['syntax' => 'short'],
'combine_consecutive_unsets' => true,
'multiline_whitespace_before_semicolons' => true,
'single_quote' => true,
'blank_line_before_statement' => true,
'braces' => [
'allow_single_line_closure' => true,
],
'concat_space' => ['spacing' => 'one'],
'declare_equal_normalize' => true,
'function_typehint_space' => true,
'include' => true,
'lowercase_cast' => true,
'no_multiline_whitespace_around_double_arrow' => true,
'no_spaces_around_offset' => true,
'no_unused_imports' => true,
'no_whitespace_before_comma_in_array' => true,
'no_whitespace_in_blank_line' => true,
'object_operator_without_whitespace' => true,
'single_blank_line_before_namespace' => true,
'ternary_operator_spaces' => true,
'trailing_comma_in_multiline' => true,
'trim_array_spaces' => true,
'unary_operator_spaces' => true,
'binary_operator_spaces' => true,
'whitespace_after_comma_in_array' => true,
'single_trait_insert_per_statement' => false,
])
->setLineEnding("\n");
```
You can find the complete rule set [here](https://github.com/FriendsOfPHP/PHP-CS-Fixer/blob/master/doc/ruleSets/index.rst)