Files
web/.php-cs-fixer.php
2026-01-03 01:12:18 +08:00

733 lines
24 KiB
PHP
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?php
/*
* Copyright (c) 2025, Антон Аксенов
* This file is part of m3u.su project
* MIT License: https://git.axenov.dev/IPTV/web/src/branch/master/LICENSE
*/
declare(strict_types=1);
use PhpCsFixer\Config;
use PhpCsFixer\Finder;
// директории для проверки
$includePaths = [
'app/',
'config/',
];
// файлы для проверки
$includeNames = [
'public/index.php',
];
// директории, исключённые из проверки
$excludePaths = [
'cache/',
'views/',
'vendor/',
];
// файлы, исключённые из проверки
$excludeNames = [
];
// правила
// https://cs.symfony.com/doc/rules/index.html
// https://mlocati.github.io/php-cs-fixer-configurator/#version:3.83
$rules = [
// Alias
'array_push' => true,
'backtick_to_shell_exec' => true,
'ereg_to_preg' => true,
'mb_str_functions' => false,
'modernize_strpos' => true,
'no_alias_functions' => ['sets' => ['@all']],
'no_alias_language_construct_call' => true,
'no_mixed_echo_print' => ['use' => 'echo'],
'pow_to_exponentiation' => true,
'random_api_migration' => true,
'set_type_to_cast' => false,
// Array Notation
'array_syntax' => ['syntax' => 'short'],
'no_multiline_whitespace_around_double_arrow' => true,
'no_whitespace_before_comma_in_array' => ['after_heredoc' => false],
'normalize_index_brace' => true,
'return_to_yield_from' => false,
'trim_array_spaces' => true,
'whitespace_after_comma_in_array' => ['ensure_single_space' => true],
'yield_from_array_to_yields' => false,
// Attribute Notation
'attribute_empty_parentheses' => false,
'ordered_attributes' => ['order' => [], 'sort_algorithm' => 'alpha'],
// Basic
'braces_position' => [
'allow_single_line_anonymous_functions' => false,
'allow_single_line_empty_anonymous_classes' => false,
'anonymous_classes_opening_brace' => 'next_line_unless_newline_at_signature_end',
'anonymous_functions_opening_brace' => 'same_line',
'classes_opening_brace' => 'next_line_unless_newline_at_signature_end',
'control_structures_opening_brace' => 'same_line',
'functions_opening_brace' => 'next_line_unless_newline_at_signature_end',
],
'encoding' => true,
'no_multiple_statements_per_line' => true,
'no_trailing_comma_in_singleline' => [
'elements' => [
'arguments',
'array',
'array_destructuring',
'group_import',
],
],
'non_printable_character' => ['use_escape_sequences_in_strings' => true],
'numeric_literal_separator' => ['override_existing' => false, 'strategy' => 'no_separator'],
'octal_notation' => true,
'psr_autoloading' => ['dir' => null],
// Casing
'class_reference_name_casing' => true,
'constant_case' => ['case' => 'lower'],
'integer_literal_case' => true,
'lowercase_keywords' => true,
'lowercase_static_reference' => true,
'magic_constant_casing' => true,
'magic_method_casing' => true,
'native_function_casing' => true,
'native_type_declaration_casing' => true,
// Cast Notation
'cast_spaces' => ['space' => 'single'],
'lowercase_cast' => true,
'modernize_types_casting' => true,
'no_short_bool_cast' => true,
'no_unset_cast' => true,
'short_scalar_cast' => true,
// Class Notation
'class_attributes_separation' => [
'elements' => [
'const' => 'one',
'method' => 'one',
'property' => 'one',
'trait_import' => 'none',
'case' => 'one',
],
],
'class_definition' => [
'inline_constructor_arguments' => true,
'multi_line_extends_each_single_line' => true,
'single_item_single_line' => true,
'single_line' => false,
'space_before_parenthesis' => false,
],
'final_class' => false,
'final_internal_class' => [
'consider_absent_docblock_as_internal_class' => false,
'exclude' => [],
'include' => ['@IamTotallySureThisClassMustBeFinal'],
],
'final_public_method_for_abstract_class' => false,
'no_blank_lines_after_class_opening' => true,
'no_null_property_initialization' => false,
'no_php4_constructor' => true,
'no_unneeded_final_method' => ['private_methods' => true],
'ordered_class_elements' => [
'case_sensitive' => false,
'order' => [
'use_trait',
'case',
'constant_public',
'constant_protected',
'constant_private',
'property_public',
'property_protected',
'property_private',
'construct',
'destruct',
'method_public',
'method_protected',
'method_private',
'magic',
'phpunit',
],
'sort_algorithm' => 'none',
],
'ordered_interfaces' => [
'case_sensitive' => false,
'direction' => 'ascend',
'order' => 'alpha',
],
'ordered_traits' => [
'case_sensitive' => false,
],
'ordered_types' => [
'case_sensitive' => false,
'null_adjustment' => 'always_last',
'sort_algorithm' => 'alpha',
],
'phpdoc_readonly_class_comment_to_keyword' => true,
'protected_to_private' => false,
'self_accessor' => true,
'self_static_accessor' => true,
'single_class_element_per_statement' => ['elements' => ['const', 'property']],
'single_trait_insert_per_statement' => false,
'modifier_keywords' => ['elements' => ['const', 'method', 'property']],
// Class Usage
'date_time_immutable' => false, // при true ломает строку 'DateTime', что пока весьма важно
// Comment
'comment_to_phpdoc' => ['ignored_tags' => []],
// 'header_comment' => ['header' => ''],
'multiline_comment_opening_closing' => false,
'no_empty_comment' => true,
'no_trailing_whitespace_in_comment' => true,
'single_line_comment_spacing' => true,
'single_line_comment_style' => ['comment_types' => ['asterisk', 'hash']],
// Constant Notation
'native_constant_invocation' => [
'exclude' => [],
'include' => [],
'fix_built_in' => false,
'scope' => 'all',
'strict' => false,
],
// Control Structure
'single_line_empty_body' => false, // иначе ругается на пустые классы
'control_structure_braces' => true,
'control_structure_continuation_position' => ['position' => 'same_line'],
'elseif' => true,
'empty_loop_body' => ['style' => 'braces'],
'empty_loop_condition' => ['style' => 'while'],
'include' => true,
'no_alternative_syntax' => ['fix_non_monolithic_code' => true],
'no_break_comment' => ['comment_text' => 'намеренно не останавливаем выполнение'],
'no_superfluous_elseif' => true,
'no_unneeded_braces' => ['namespaces' => false],
'no_unneeded_control_parentheses' => [
'statements' => ['break', 'clone', 'continue', 'echo_print', 'return', 'switch_case', 'yield', 'yield_from'],
],
'no_useless_else' => true,
'simplified_if_return' => true,
'switch_case_semicolon_to_colon' => true,
'switch_case_space' => true,
'switch_continue_to_break' => true,
'trailing_comma_in_multiline' => true,
'yoda_style' => [
'equal' => false,
'identical' => false,
'less_and_greater' => false,
],
// Doctrine Annotation
// (не используем)
// Function Notation
'combine_nested_dirname' => true,
'date_time_create_from_format_call' => true,
'fopen_flag_order' => false,
// TODO 'fopen_flags' => ['b_mode' => false],
'function_declaration' => [
'closure_fn_spacing' => 'one',
'closure_function_spacing' => 'one',
'trailing_comma_single_line' => false,
],
'implode_call' => true,
'lambda_not_used_import' => true,
'method_argument_space' => [
'after_heredoc' => true,
'attribute_placement' => 'standalone',
// TODO 'keep_multiple_spaces_after_comma' => true,
'on_multiline' => 'ensure_fully_multiline',
],
'native_function_invocation' => [
'exclude' => ['@all'],
'include' => [],
'scope' => 'all',
'strict' => false,
],
'no_spaces_after_function_name' => true,
'no_unreachable_default_argument_value' => true,
'no_useless_sprintf' => true,
// 'phpdoc_to_param_type' => [ // risky, experimenal :(
// 'scalar_types' => true,
// 'union_types' => true,
// ],
// 'phpdoc_to_property_type' => [ // risky, experimenal :(
// 'scalar_types' => true,
// 'union_types' => true,
// ],
// 'phpdoc_to_return_type' => [ // risky, experimenal :(
// 'scalar_types' => true,
// 'union_types' => true,
// ],
'regular_callable_call' => true,
'return_type_declaration' => ['space_before' => 'none'],
'single_line_throw' => false,
'static_lambda' => true,
'use_arrow_functions' => true,
'void_return' => true,
'nullable_type_declaration_for_default_null_value' => true,
// Import
'fully_qualified_strict_types' => [
'import_symbols' => true,
'leading_backslash_in_global_namespace' => false,
'phpdoc_tags' => [
'param',
'property',
'property-read',
'property-write',
'phpstan-param',
'phpstan-property',
'phpstan-property-read',
'phpstan-property-write',
'phpstan-return',
'phpstan-var',
'psalm-param',
'psalm-property',
'psalm-property-read',
'psalm-property-write',
'psalm-return',
'psalm-var',
'return',
'see',
'link',
'throws',
'var',
],
],
'global_namespace_import' => [
'import_classes' => true,
'import_constants' => false,
'import_functions' => true,
],
'group_import' => false,
'no_leading_import_slash' => true,
'no_unneeded_import_alias' => true,
'no_unused_imports' => true,
'ordered_imports' => [
'case_sensitive' => false,
'imports_order' => ['class', 'const', 'function'],
'sort_algorithm' => 'alpha',
],
'single_import_per_statement' => ['group_to_single_imports' => true],
'single_line_after_imports' => true,
// Language Construct
'class_keyword' => false, // при true ломает строку 'DateTime', что пока весьма важно
'combine_consecutive_issets' => true,
'combine_consecutive_unsets' => false, // иначе местами приводит к превышению длины строки
'declare_equal_normalize' => ['space' => 'none'],
'declare_parentheses' => true,
'dir_constant' => true,
'error_suppression' => false,
'explicit_indirect_variable' => true,
'function_to_constant' => [
'functions' => [
'get_called_class',
'get_class',
'get_class_this',
'php_sapi_name',
'phpversion',
'pi',
],
],
'get_class_to_class_keyword' => true,
'is_null' => false,
'no_unset_on_property' => false,
'nullable_type_declaration' => ['syntax' => 'question_mark'],
'single_space_around_construct' => [
'constructs_contain_a_single_space' => ['yield_from'],
'constructs_followed_by_a_single_space' => [
'abstract',
'as',
'attribute',
// 'break',
'case',
'catch',
'class',
'clone',
'comment',
'const',
'const_import',
'continue',
'do',
'echo',
'else',
'elseif',
'enum',
'extends',
'final',
'finally',
'for',
'foreach',
'function',
'function_import',
'global',
'goto',
'if',
'implements',
'include',
'include_once',
'instanceof',
'insteadof',
'interface',
'match',
'named_argument',
'namespace',
'new',
'open_tag_with_echo',
'php_doc',
'php_open',
'print',
'private',
'protected',
'public',
'readonly',
'require',
'require_once',
'return',
'static',
'switch',
'throw',
'trait',
'try',
'type_colon',
'use',
'use_lambda',
'use_trait',
'var',
'while',
'yield',
'yield_from',
],
'constructs_preceded_by_a_single_space' => ['as', 'else', 'elseif', 'use_lambda'],
],
// List Notation
'list_syntax' => ['syntax' => 'short'],
// Namespace Notation
'blank_line_after_namespace' => true,
'blank_lines_before_namespace' => ['max_line_breaks' => 2, 'min_line_breaks' => 2],
'clean_namespace' => true,
'no_leading_namespace_whitespace' => true,
// Naming
'no_homoglyph_names' => true,
// Operator
'assign_null_coalescing_to_coalesce_equal' => true,
'binary_operator_spaces' => [
'default' => 'single_space',
'operators' => [],
],
'concat_space' => ['spacing' => 'one'],
'increment_style' => ['style' => 'pre'],
'logical_operators' => true,
'long_to_shorthand_operator' => true,
'new_with_parentheses' => ['anonymous_class' => true, 'named_class' => true],
'no_space_around_double_colon' => true,
'no_useless_concat_operator' => ['juggle_simple_strings' => false],
'no_useless_nullsafe_operator' => true,
'not_operator_with_space' => false,
'not_operator_with_successor_space' => false,
'object_operator_without_whitespace' => true,
'operator_linebreak' => [
'only_booleans' => true,
'position' => 'beginning',
],
'standardize_increment' => true,
'standardize_not_equals' => true,
'ternary_operator_spaces' => true,
'ternary_to_elvis_operator' => false,
'ternary_to_null_coalescing' => true,
'unary_operator_spaces' => ['only_dec_inc' => false],
// PHP Tag
'blank_line_after_opening_tag' => true,
'echo_tag_syntax' => [
'format' => 'short',
'long_function' => 'echo',
'shorten_simple_statements_only' => true,
],
'full_opening_tag' => true,
'linebreak_after_opening_tag' => true,
'no_closing_tag' => true,
// PHPUnit
'php_unit_assert_new_names' => true,
'php_unit_attributes' => ['keep_annotations' => false],
'php_unit_construct' => ['assertions' => ['assertEquals', 'assertSame', 'assertNotEquals', 'assertNotSame']],
'php_unit_data_provider_name' => ['prefix' => 'provide', 'suffix' => ''],
'php_unit_data_provider_return_type' => false,
'php_unit_data_provider_static' => ['force' => true],
'php_unit_dedicate_assert' => ['target' => 'newest'],
'php_unit_dedicate_assert_internal_type' => ['target' => 'newest'],
'php_unit_expectation' => ['target' => 'newest'],
'php_unit_fqcn_annotation' => true,
'php_unit_internal_class' => false,
'php_unit_method_casing' => ['case' => 'camel_case'],
'php_unit_mock' => ['target' => 'newest'],
'php_unit_mock_short_will_return' => true,
'php_unit_namespaced' => ['target' => 'newest'],
'php_unit_no_expectation_annotation' => ['target' => 'newest', 'use_class_const' => true],
'php_unit_set_up_tear_down_visibility' => true,
'php_unit_size_class' => false,
'php_unit_strict' => [
'assertions' => [
'assertAttributeEquals',
'assertAttributeNotEquals',
// 'assertEquals', // не всегда возможно
// 'assertNotEquals', // не всегда возможно
],
],
'php_unit_test_annotation' => ['style' => 'prefix'],
'php_unit_test_case_static_method_calls' => ['call_type' => 'this', 'methods' => []],
'php_unit_test_class_requires_covers' => false,
// PHPDoc
'align_multiline_comment' => ['comment_type' => 'phpdocs_only'],
'general_phpdoc_annotation_remove' => [
'annotations' => ['author', 'package', 'subpackage'],
'case_sensitive' => false,
],
'general_phpdoc_tag_rename' => [
'case_sensitive' => false,
'fix_annotation' => true,
'fix_inline' => true,
'replacements' => [
'inheritDocs' => 'inheritDoc',
// 'link' => 'see', // phpdoc_no_alias_tag
],
],
'no_blank_lines_after_phpdoc' => true,
'no_empty_phpdoc' => true,
'no_superfluous_phpdoc_tags' => false,
'phpdoc_add_missing_param_annotation' => ['only_untyped' => true],
'phpdoc_align' => [
'align' => 'left',
'spacing' => 1,
'tags' => [
'param',
'property',
'property-read',
'property-write',
'phpstan-param',
'phpstan-property',
'phpstan-property-read',
'phpstan-property-write',
'phpstan-return',
'phpstan-var',
'psalm-param',
'psalm-property',
'psalm-property-read',
'psalm-property-write',
'psalm-return',
'psalm-var',
'return',
'see',
'link',
'throws',
'var',
],
],
'phpdoc_annotation_without_dot' => true,
'phpdoc_array_type' => false,
'phpdoc_indent' => true,
'phpdoc_inline_tag_normalizer' => [
'tags' => ['example', 'id', 'internal', 'inheritdoc', 'inheritdocs', 'link', 'source', 'see', 'tutorial'],
],
'phpdoc_line_span' => [
'const' => 'multi',
'method' => 'multi',
'property' => 'multi',
],
'phpdoc_list_type' => false,
'phpdoc_no_access' => true,
'phpdoc_no_alias_tag' => [
'replacements' => [
'property-read' => 'property',
'property-write' => 'property',
'type' => 'var',
'link' => 'see',
],
],
'phpdoc_no_empty_return' => false,
'phpdoc_no_package' => false, // general_phpdoc_annotation_remove
'phpdoc_no_useless_inheritdoc' => true,
'phpdoc_order_by_value' => ['annotations' => []],
'phpdoc_order' => ['order' => ['param', 'return', 'throws', 'covers', 'dataProvider']],
'phpdoc_param_order' => true,
'phpdoc_return_self_reference' => [
'replacements' => [
'this' => '$this',
'@this' => '$this',
'$self' => 'self',
'@self' => 'self',
'$static' => 'static',
'@static' => 'static',
],
],
'phpdoc_scalar' => ['types' => ['boolean', 'callback', 'double', 'integer', 'real', 'str']],
'phpdoc_separation' => ['groups' => [], 'skip_unlisted_annotations' => true],
'phpdoc_single_line_var_spacing' => true,
'phpdoc_summary' => false,
'phpdoc_tag_casing' => [
'tags' => [
'param',
'property',
'property-read',
'property-write',
'phpstan-param',
'phpstan-property',
'phpstan-property-read',
'phpstan-property-write',
'phpstan-return',
'phpstan-var',
'psalm-param',
'psalm-property',
'psalm-property-read',
'psalm-property-write',
'psalm-return',
'psalm-var',
'return',
'see',
'link',
'throws',
'var',
],
],
'phpdoc_tag_type' => [
'tags' => [
'api' => 'annotation',
'author' => 'annotation',
'copyright' => 'annotation',
'deprecated' => 'annotation',
'example' => 'annotation',
'global' => 'annotation',
'inheritDoc' => 'annotation',
'internal' => 'annotation',
'license' => 'annotation',
'method' => 'annotation',
'package' => 'annotation',
'param' => 'annotation',
'property' => 'annotation',
'return' => 'annotation',
'see' => 'annotation',
'since' => 'annotation',
'throws' => 'annotation',
'todo' => 'annotation',
'uses' => 'annotation',
'var' => 'annotation',
'version' => 'annotation',
],
],
'phpdoc_to_comment' => false, // при true ломаются докблоки к выражениям, которые обязаны быть докблоками, а не многострочными комментами
'phpdoc_trim_consecutive_blank_line_separation' => true,
'phpdoc_trim' => true,
'phpdoc_types' => ['groups' => ['simple', 'alias', 'meta']],
'phpdoc_types_order' => [
'case_sensitive' => false,
'null_adjustment' => 'always_last',
'sort_algorithm' => 'none',
],
'phpdoc_var_annotation_correct_order' => true,
'phpdoc_var_without_name' => true,
// Return Notation
'no_useless_return' => true,
'return_assignment' => true,
'simplified_null_return' => true,
// Semicolon
'multiline_whitespace_before_semicolons' => ['strategy' => 'no_multi_line'],
'no_empty_statement' => true,
'no_singleline_whitespace_before_semicolons' => true,
'semicolon_after_instruction' => true,
'space_after_semicolon' => ['remove_in_empty_for_expressions' => true],
// Strict
'declare_strict_types' => true,
'strict_comparison' => true,
'strict_param' => false,
// String Notation
'explicit_string_variable' => true,
'heredoc_closing_marker' => [
'closing_marker' => 'EOD',
'explicit_heredoc_style' => false,
'reserved_closing_markers' => ['SQL', 'EOF'],
],
'heredoc_to_nowdoc' => false,
'multiline_string_to_heredoc' => false,
'no_binary_string' => true,
'no_trailing_whitespace_in_string' => false,
'simple_to_complex_string_variable' => true,
'single_quote' => ['strings_containing_single_quote_chars' => false],
'string_implicit_backslashes' => [
'double_quoted' => 'escape',
'heredoc' => 'escape',
'single_quoted' => 'unescape',
],
'string_length_to_empty' => false,
'string_line_ending' => true,
// Whitespace
'array_indentation' => true,
'blank_line_before_statement' => ['statements' => ['declare', 'return', 'throw', 'try']],
'blank_line_between_import_groups' => true,
'compact_nullable_type_declaration' => true,
'heredoc_indentation' => ['indentation' => 'start_plus_one'],
'indentation_type' => true,
'line_ending' => true,
'method_chaining_indentation' => true,
'no_extra_blank_lines' => [
'tokens' => [
'attribute',
'break',
'case',
'continue',
'curly_brace_block',
'default',
'extra',
'parenthesis_brace_block',
'return',
'square_brace_block',
'switch',
'throw',
'use',
],
],
'no_spaces_around_offset' => ['positions' => ['inside', 'outside']],
'no_trailing_whitespace' => true,
'no_whitespace_in_blank_line' => true,
'single_blank_line_at_eof' => true,
'spaces_inside_parentheses' => ['space' => 'none'],
'statement_indentation' => ['stick_comment_to_next_continuous_control_statement' => false],
'type_declaration_spaces' => ['elements' => ['function', 'property']],
'types_spaces' => ['space' => 'none', 'space_multiple_catch' => null],
];
$finder = (new Finder())
->ignoreVCSIgnored(true) // игнорируем игнорируемое
->in($includePaths) // добавляем директории
->append($includeNames) // добавляем файлы
->exclude($excludePaths) // исключаем директории
->notPath($excludeNames); // исключаем файлы
return (new Config())
// спорная фигня, пока не активирую
// ->setParallelConfig(PhpCsFixer\Runner\Parallel\ParallelConfigFactory::detect());
->setFinder($finder)
->setRules($rules) // ставим правила
->setRiskyAllowed(true); // рискованные правила разрешаем, но в общий список добавляем аккуратно