Feat: php-cs-fixer #154
Feat: php-cs-fixer #154
Conversation
.php-cs-fixer.php
Outdated
| $optionalRules = [ | ||
| 'array_indentation' => true, | ||
| 'array_syntax' => ['syntax' => 'short'], | ||
| 'binary_operator_spaces' => ['default' => 'align_single_space_minimal'], | ||
| 'blank_line_after_namespace' => true, | ||
| 'blank_line_after_opening_tag' => true, | ||
| 'blank_line_before_statement' => ['statements' => ['return']], | ||
| 'braces' => ['allow_single_line_closure' => true], | ||
| 'cast_spaces' => ['space' => 'single'], | ||
| 'class_attributes_separation' => ['elements' => ['method' => 'one']], | ||
| 'concat_space' => ['spacing' => 'one'], | ||
| 'declare_equal_normalize' => ['space' => 'single'], | ||
| 'function_typehint_space' => true, | ||
| 'lowercase_cast' => true, | ||
| 'no_whitespace_in_blank_line' => true, | ||
| 'single_blank_line_at_eof' => true, | ||
| 'single_quote' => true, | ||
| 'space_after_semicolon' => true, | ||
| 'trailing_comma_in_multiline' => ['elements' => ['arrays']], | ||
| 'trim_array_spaces' => true, | ||
| 'unary_operator_spaces' => true, | ||
| 'whitespace_after_comma_in_array' => true, | ||
| ]; |
There was a problem hiding this comment.
I am not against some strict rules, but I guess that almost every PR will require an additional commit to fix CS violations.
Did you talk about it with the other developers?
There was a problem hiding this comment.
No, but that's also the goal of this PR. Since NEWS doesn't have any other PRs in progress, it's being used as a test case ;)
.php-cs-fixer.php
Outdated
| /** | ||
| * Read excluded paths from .gitignore | ||
| * | ||
| * @param string $dir | ||
| * | ||
| * @return string[] | ||
| */ | ||
| function getGitignorePaths(string $dir): array | ||
| { | ||
| $gitignoreFile = $dir . '/.gitignore'; | ||
| $paths = []; | ||
|
|
||
| if (!file_exists($gitignoreFile)) { | ||
| return $paths; | ||
| } | ||
|
|
||
| $lines = file($gitignoreFile, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES); | ||
| if (!empty($lines)) { | ||
| foreach ($lines as $line) { | ||
| // Ignore comments and empty lines | ||
| if (strpos($line, '#') === 0 || trim($line) === '') { | ||
| continue; | ||
| } | ||
| // Add relative paths | ||
| $paths[] = trim($line); | ||
| } | ||
| } | ||
|
|
||
| return $paths; | ||
| } |
There was a problem hiding this comment.
According to the documentation:
Default finder ignores DIR . "/vendor" dir, “hidden” paths (ones starting with a dot) and VCS paths (e.g. .git), and filter only for *.php files.
What kind of files do you want to exclude with this function ? Most of the time, the defaut exclusions will do the job, and manually adding a specific dir is probably simplier than maintaining this function.
There was a problem hiding this comment.
I initially intended to create a generic configuration that could be identical across each plugin, allowing for simple copy-and-paste. However, it might not be optimal, so I will remove it.
|
Can I remove |
Sure. |
|
|
||
| $rules = [ | ||
| '@PER-CS2.0' => true, | ||
| 'trailing_comma_in_multiline' => ['elements' => ['arguments', 'array_destructuring', 'arrays']], // For PHP 7.4 compatibility |
There was a problem hiding this comment.
The PER 2.0 is an extension of the PER 1.0 (the new name of the PSR 12) and its specifications are not compatible on some points with PHP 7.x.
There are 2 solutions for this:
- Use the PSR 12 right now and move to the PER 2.0 later.
- Use the PER 2.0 right now with some overriden rules, and remove these overrides later.
Both are OK to me, but I guess that the current solution will be less subject to conflicts and is therefore preferable.
Add php-cs-fixer