PHP CS Fixer Symfony 和 PSR2 规则不存在
PHP CS Fixer Symfony & PSR2 rule do not exist
我在提交之前使用 grumphp 检查我的代码，它告诉我：
F [UnexpectedValueException]
Rule "symfony" does not exist.
Exception trace:
() at /Users/foo/projects/bar/app/vendor/friendsofphp/php-cs-fixer/src/FixerFactory.php:181
PhpCsFixer\FixerFactory->useRuleSet() at /Users/foo/projects/bar/app/vendor/friendsofphp/php-cs-fixer/src/Console/ConfigurationResolver.php:264
PhpCsFixer\Console\ConfigurationResolver->getFixers() at /Users/foo/projects/bar/app/vendor/friendsofphp/php-cs-fixer/src/Console/Command/FixCommand.php:164
PhpCsFixer\Console\Command\FixCommand->execute() at /Users/foo/projects/bar/app/vendor/symfony/console/Command/Command.php:261
Symfony\Component\Console\Command\Command->run() at /Users/foo/projects/bar/app/vendor/symfony/console/Application.php:817
Symfony\Component\Console\Application->doRunCommand() at /Users/foo/projects/bar/app/vendor/symfony/console/Application.php:185
Symfony\Component\Console\Application->doRun() at /Users/foo/projects/bar/app/vendor/symfony/console/Application.php:116
Symfony\Component\Console\Application->run() at /Users/foo/projects/bar/app/vendor/friendsofphp/php-cs-fixer/php-cs-fixer:45
尝试手动执行它，它告诉我同样的结果。
所以我开始研究代码
我可以看到有一个规则集，修复器工厂正在调用 $ruleset->getRules() 但它只返回 symfony 的规则名称，而不是 91 个数组键：
array:1 [
0 => "symfony"
]
rule_set 是
'@Symfony' => array(
'@PSR2' => true,
'binary_operator_spaces' => array(
'align_double_arrow' => false,
'align_equals' => false,
),
'blank_line_after_opening_tag' => true,
'blank_line_before_return' => true,
'cast_spaces' => true,
'class_definition' => array('singleLine' => true),
'concat_space' => array('spacing' => 'none'),
'declare_equal_normalize' => true,
'function_typehint_space' => true,
'hash_to_slash_comment' => true,
'heredoc_to_nowdoc' => true,
'include' => true,
'lowercase_cast' => true,
'method_separation' => true,
'native_function_casing' => true,
'new_with_braces' => true,
'no_alias_functions' => true,
'no_blank_lines_after_class_opening' => true,
'no_blank_lines_after_phpdoc' => true,
'no_empty_comment' => true,
'no_empty_phpdoc' => true,
'no_empty_statement' => true,
'no_extra_consecutive_blank_lines' => array(
'curly_brace_block',
'extra',
'parenthesis_brace_block',
'square_brace_block',
'throw',
'use',
),
'no_leading_import_slash' => true,
'no_leading_namespace_whitespace' => true,
'no_mixed_echo_print' => array('use' => 'echo'),
'no_multiline_whitespace_around_double_arrow' => true,
'no_short_bool_cast' => true,
'no_singleline_whitespace_before_semicolons' => true,
'no_spaces_around_offset' => true,
'no_trailing_comma_in_list_call' => true,
'no_trailing_comma_in_singleline_array' => true,
'no_unneeded_control_parentheses' => true,
'no_unreachable_default_argument_value' => true,
'no_unused_imports' => true,
'no_whitespace_before_comma_in_array' => true,
'no_whitespace_in_blank_line' => true,
'normalize_index_brace' => true,
'object_operator_without_whitespace' => true,
'php_unit_fqcn_annotation' => true,
'phpdoc_align' => true,
'phpdoc_annotation_without_dot' => true,
'phpdoc_indent' => true,
'phpdoc_inline_tag' => true,
'phpdoc_no_access' => true,
'phpdoc_no_alias_tag' => true,
'phpdoc_no_empty_return' => true,
'phpdoc_no_package' => true,
'phpdoc_scalar' => true,
'phpdoc_separation' => true,
'phpdoc_single_line_var_spacing' => true,
'phpdoc_summary' => true,
'phpdoc_to_comment' => true,
'phpdoc_trim' => true,
'phpdoc_types' => true,
'phpdoc_var_without_name' => true,
'pre_increment' => true,
'return_type_declaration' => true,
'self_accessor' => true,
'short_scalar_cast' => true,
'single_blank_line_before_namespace' => true,
'single_class_element_per_statement' => true,
'single_quote' => true,
'space_after_semicolon' => true,
'standardize_not_equals' => true,
'ternary_operator_spaces' => true,
'trailing_comma_in_multiline_array' => true,
'trim_array_spaces' => true,
'unary_operator_spaces' => true,
'whitespace_after_comma_in_array' => true,
),
最后崩溃了：
public function useRuleSet(RuleSetInterface $ruleSet)
{
$fixers = array();
$fixersByName = array();
$fixerConflicts = array();
$fixerNames = array_keys($ruleSet->getRules());
foreach ($fixerNames as $name) {
-----> if (!array_key_exists($name, $this->fixersByName)) {
throw new \UnexpectedValueException(sprintf('Rule "%s" does not exist.', $name));
}
ResolveSet() 按预期工作
在 resolveSet() 和 fixerFactory 之间的某个地方，数组键丢失了
我会进一步调查，有什么提示或建议吗？
关于 github 的问题：
https://github.com/FriendsOfPHP/PHP-CS-Fixer/issues/2518
https://github.com/phpro/grumphp/issues/281
解决方案：
你需要用另一个@转义参数！
@@Symfony
看起来像这样：
phpcsfixer2:
allow_risky: false
cache_file: ~
config: ~
rules: ['@@Symfony']
using_cache: false
path_mode: ~
verbose: true
希望这对某人有所帮助！
或者您可以构建一个具有许多其他功能的解决方法：
php_cs.dist
<?php
$finder = PhpCsFixer\Finder::create()
->exclude(['vendor','tmpl_c'])
->name('*.php5');
return PhpCsFixer\Config::create()
->setRules([
'@Symfony' => true,
'encoding' => false,
'psr0' => false,
'psr4' => false,
'self_accessor' => false,
'no_short_echo_tag' => true,
'array_syntax' => ['syntax' => 'short'],
])
->setFinder($finder);
已更新grumphp.yml
parameters:
bin_dir: "./vendor/bin"
git_dir: "."
hooks_dir: ~
hooks_preset: local
stop_on_failure: false
ignore_unstaged_changes: false
process_async_limit: 10
process_async_wait: 1000
process_timeout: 60
ascii:
failed: grumphp-grumpy.txt
succeeded: grumphp-happy.txt
tasks:
git_blacklist:
keywords:
- "die("
- "var_dump("
- "print_f("
- "dump("
- "dd("
- "exit;"
triggered_by: ["php"]
git_commit_message:
matchers:
- /SER-([0-9]*)/
case_insensitive: true
multiline: true
additional_modifiers: ''
git_conflict: ~
phpcsfixer2:
allow_risky: false
cache_file: ~
config: config/php_cs.dist
rules: []
using_cache: false
path_mode: ~
verbose: true
phpmd:
exclude: []
ruleset: ['cleancode', 'codesize', 'naming']
triggered_by: ["php"]
phpparser:
ignore_patterns: []
kind: php7
triggered_by: ["php"]
visitors: {}
phpunit: ~
phpversion:
project: "7.0"
shell: ~
testsuites: []
extensions: []
问题是 Grumphp 使用 Symfony 服务容器，
php-cs 修复程序选项变为 小写并删除 @ 符号 这导致 cs 修复程序找不到规则！
这发生在 Symfony 服务容器中！
http://symfony.com/doc/current/service_container.html#service-parameters
If you want to use a string that starts with an @ sign as a parameter
value (e.g. a very safe mailer password) in a YAML file, you need to
escape it by adding another @ sign (this only applies to the YAML
format)
我在提交之前使用 grumphp 检查我的代码，它告诉我：
F [UnexpectedValueException] Rule "symfony" does not exist.
Exception trace: () at /Users/foo/projects/bar/app/vendor/friendsofphp/php-cs-fixer/src/FixerFactory.php:181 PhpCsFixer\FixerFactory->useRuleSet() at /Users/foo/projects/bar/app/vendor/friendsofphp/php-cs-fixer/src/Console/ConfigurationResolver.php:264 PhpCsFixer\Console\ConfigurationResolver->getFixers() at /Users/foo/projects/bar/app/vendor/friendsofphp/php-cs-fixer/src/Console/Command/FixCommand.php:164 PhpCsFixer\Console\Command\FixCommand->execute() at /Users/foo/projects/bar/app/vendor/symfony/console/Command/Command.php:261 Symfony\Component\Console\Command\Command->run() at /Users/foo/projects/bar/app/vendor/symfony/console/Application.php:817 Symfony\Component\Console\Application->doRunCommand() at /Users/foo/projects/bar/app/vendor/symfony/console/Application.php:185 Symfony\Component\Console\Application->doRun() at /Users/foo/projects/bar/app/vendor/symfony/console/Application.php:116 Symfony\Component\Console\Application->run() at /Users/foo/projects/bar/app/vendor/friendsofphp/php-cs-fixer/php-cs-fixer:45
尝试手动执行它，它告诉我同样的结果。
所以我开始研究代码
我可以看到有一个规则集，修复器工厂正在调用 $ruleset->getRules() 但它只返回 symfony 的规则名称，而不是 91 个数组键：
array:1 [
0 => "symfony"
]
rule_set 是
'@Symfony' => array(
'@PSR2' => true,
'binary_operator_spaces' => array(
'align_double_arrow' => false,
'align_equals' => false,
),
'blank_line_after_opening_tag' => true,
'blank_line_before_return' => true,
'cast_spaces' => true,
'class_definition' => array('singleLine' => true),
'concat_space' => array('spacing' => 'none'),
'declare_equal_normalize' => true,
'function_typehint_space' => true,
'hash_to_slash_comment' => true,
'heredoc_to_nowdoc' => true,
'include' => true,
'lowercase_cast' => true,
'method_separation' => true,
'native_function_casing' => true,
'new_with_braces' => true,
'no_alias_functions' => true,
'no_blank_lines_after_class_opening' => true,
'no_blank_lines_after_phpdoc' => true,
'no_empty_comment' => true,
'no_empty_phpdoc' => true,
'no_empty_statement' => true,
'no_extra_consecutive_blank_lines' => array(
'curly_brace_block',
'extra',
'parenthesis_brace_block',
'square_brace_block',
'throw',
'use',
),
'no_leading_import_slash' => true,
'no_leading_namespace_whitespace' => true,
'no_mixed_echo_print' => array('use' => 'echo'),
'no_multiline_whitespace_around_double_arrow' => true,
'no_short_bool_cast' => true,
'no_singleline_whitespace_before_semicolons' => true,
'no_spaces_around_offset' => true,
'no_trailing_comma_in_list_call' => true,
'no_trailing_comma_in_singleline_array' => true,
'no_unneeded_control_parentheses' => true,
'no_unreachable_default_argument_value' => true,
'no_unused_imports' => true,
'no_whitespace_before_comma_in_array' => true,
'no_whitespace_in_blank_line' => true,
'normalize_index_brace' => true,
'object_operator_without_whitespace' => true,
'php_unit_fqcn_annotation' => true,
'phpdoc_align' => true,
'phpdoc_annotation_without_dot' => true,
'phpdoc_indent' => true,
'phpdoc_inline_tag' => true,
'phpdoc_no_access' => true,
'phpdoc_no_alias_tag' => true,
'phpdoc_no_empty_return' => true,
'phpdoc_no_package' => true,
'phpdoc_scalar' => true,
'phpdoc_separation' => true,
'phpdoc_single_line_var_spacing' => true,
'phpdoc_summary' => true,
'phpdoc_to_comment' => true,
'phpdoc_trim' => true,
'phpdoc_types' => true,
'phpdoc_var_without_name' => true,
'pre_increment' => true,
'return_type_declaration' => true,
'self_accessor' => true,
'short_scalar_cast' => true,
'single_blank_line_before_namespace' => true,
'single_class_element_per_statement' => true,
'single_quote' => true,
'space_after_semicolon' => true,
'standardize_not_equals' => true,
'ternary_operator_spaces' => true,
'trailing_comma_in_multiline_array' => true,
'trim_array_spaces' => true,
'unary_operator_spaces' => true,
'whitespace_after_comma_in_array' => true,
),
最后崩溃了：
public function useRuleSet(RuleSetInterface $ruleSet)
{
$fixers = array();
$fixersByName = array();
$fixerConflicts = array();
$fixerNames = array_keys($ruleSet->getRules());
foreach ($fixerNames as $name) {
-----> if (!array_key_exists($name, $this->fixersByName)) {
throw new \UnexpectedValueException(sprintf('Rule "%s" does not exist.', $name));
}
ResolveSet() 按预期工作 在 resolveSet() 和 fixerFactory 之间的某个地方，数组键丢失了 我会进一步调查，有什么提示或建议吗？
关于 github 的问题： https://github.com/FriendsOfPHP/PHP-CS-Fixer/issues/2518 https://github.com/phpro/grumphp/issues/281
解决方案：
你需要用另一个@转义参数！
@@Symfony
看起来像这样：
phpcsfixer2:
allow_risky: false
cache_file: ~
config: ~
rules: ['@@Symfony']
using_cache: false
path_mode: ~
verbose: true
希望这对某人有所帮助！
或者您可以构建一个具有许多其他功能的解决方法：
php_cs.dist
<?php
$finder = PhpCsFixer\Finder::create()
->exclude(['vendor','tmpl_c'])
->name('*.php5');
return PhpCsFixer\Config::create()
->setRules([
'@Symfony' => true,
'encoding' => false,
'psr0' => false,
'psr4' => false,
'self_accessor' => false,
'no_short_echo_tag' => true,
'array_syntax' => ['syntax' => 'short'],
])
->setFinder($finder);
已更新grumphp.yml
parameters:
bin_dir: "./vendor/bin"
git_dir: "."
hooks_dir: ~
hooks_preset: local
stop_on_failure: false
ignore_unstaged_changes: false
process_async_limit: 10
process_async_wait: 1000
process_timeout: 60
ascii:
failed: grumphp-grumpy.txt
succeeded: grumphp-happy.txt
tasks:
git_blacklist:
keywords:
- "die("
- "var_dump("
- "print_f("
- "dump("
- "dd("
- "exit;"
triggered_by: ["php"]
git_commit_message:
matchers:
- /SER-([0-9]*)/
case_insensitive: true
multiline: true
additional_modifiers: ''
git_conflict: ~
phpcsfixer2:
allow_risky: false
cache_file: ~
config: config/php_cs.dist
rules: []
using_cache: false
path_mode: ~
verbose: true
phpmd:
exclude: []
ruleset: ['cleancode', 'codesize', 'naming']
triggered_by: ["php"]
phpparser:
ignore_patterns: []
kind: php7
triggered_by: ["php"]
visitors: {}
phpunit: ~
phpversion:
project: "7.0"
shell: ~
testsuites: []
extensions: []
问题是 Grumphp 使用 Symfony 服务容器，
php-cs 修复程序选项变为 小写并删除 @ 符号 这导致 cs 修复程序找不到规则！
这发生在 Symfony 服务容器中！
http://symfony.com/doc/current/service_container.html#service-parameters
If you want to use a string that starts with an @ sign as a parameter value (e.g. a very safe mailer password) in a YAML file, you need to escape it by adding another @ sign (this only applies to the YAML format)