switch to laravel pint, drop house style and use PER-CS (#45)

* tweak: remove our house style, leaving only PER-CS2.0 and PHP84Migration

* qa: replace php-cs-fixer with pint
This commit is contained in:
Chuck Adams 2025-01-31 12:00:45 -07:00 committed by GitHub
parent f9b671a879
commit 9bfdb8b309
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
9 changed files with 416 additions and 1527 deletions

5
.gitignore vendored
View file

@ -21,8 +21,3 @@
###> phpstan/phpstan ###
phpstan.neon
###< phpstan/phpstan ###

###> friendsofphp/php-cs-fixer ###
/.php-cs-fixer.php
/.php-cs-fixer.cache
###< friendsofphp/php-cs-fixer ###

View file

@ -1,134 +0,0 @@
<?php
declare(strict_types=1);

use PhpCsFixer\Config;
use PhpCsFixer\Finder;
use PhpCsFixer\Runner\Parallel\ParallelConfigFactory;

$finder = (new Finder())
->in(__DIR__)
->exclude([
'var',
'vendor',
])
->notPath([
'_ide_helper.php',
'.phpstorm.meta.php',
]);

return (new Config())
->setRules([
'@PER-CS2.0' => true,
'@PHP84Migration' => true,
// Most rules below come from @Symfony and @PhpCsFixer, but there are a few differences in configuration,
// as well as some rules we just don't take at all because we have no official opinion on the style.
'backtick_to_shell_exec' => true,
'binary_operator_spaces' => ['default' => 'at_least_single_space'], // leaves existing alignments alone
'braces_position' => [
// these are all defaults, but it's good to spell them out here
'allow_single_line_anonymous_functions' => true,
'allow_single_line_empty_anonymous_classes' => true,
'anonymous_classes_opening_brace' => 'same_line',
'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',
],
'class_attributes_separation' => ['elements' => ['method' => 'one']],
'class_definition' => ['single_line' => true],
'class_reference_name_casing' => true,
'declare_parentheses' => true,
'empty_loop_body' => ['style' => 'braces'],
'empty_loop_condition' => ['style' => 'while'],
'explicit_indirect_variable' => true,
'fully_qualified_strict_types' => ['import_symbols' => true],
'general_phpdoc_tag_rename' => ['replacements' => ['inheritDocs' => 'inheritDoc']],
'global_namespace_import' => ['import_classes' => true, 'import_constants' => true, 'import_functions' => false],
'include' => true,
'lambda_not_used_import' => true,
'magic_constant_casing' => true,
'magic_method_casing' => true,
'method_argument_space' => ['on_multiline' => 'ignore'],
'method_chaining_indentation' => true,
'multiline_whitespace_before_semicolons' => ['strategy' => 'no_multi_line'],
'native_function_casing' => true,
'native_type_declaration_casing' => true,
'no_alias_language_construct_call' => true,
'no_alternative_syntax' => true,
'no_binary_string' => true,
'no_blank_lines_after_phpdoc' => true,
'no_empty_phpdoc' => true,
'no_empty_statement' => 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_leading_namespace_whitespace' => true,
'no_mixed_echo_print' => ['use' => 'echo'],
'no_multiline_whitespace_around_double_arrow' => true,
'no_null_property_initialization' => true,
'no_short_bool_cast' => true,
'no_singleline_whitespace_before_semicolons' => true,
'no_spaces_around_offset' => true,
'no_superfluous_phpdoc_tags' => ['allow_mixed' => true, 'remove_inheritdoc' => true],
'no_trailing_comma_in_singleline' => true,
'no_unneeded_braces' => ['namespaces' => true],
'no_unneeded_control_parentheses' => [
'statements' => [
'break', 'clone', 'continue', 'echo_print', 'others', 'return', 'switch_case', 'yield', 'yield_from',
],
],
'no_unneeded_import_alias' => true,
'no_unused_imports' => true,
'no_useless_concat_operator' => ['juggle_simple_strings' => true],
'no_useless_nullsafe_operator' => true,
'no_useless_return' => true,
'nullable_type_declaration' => ['syntax' => 'question_mark'],
'object_operator_without_whitespace' => true,
'operator_linebreak' => ['only_booleans' => true],
'ordered_imports' => ['imports_order' => ['class', 'function', 'const'], 'sort_algorithm' => 'alpha'],
'ordered_types' => ['null_adjustment' => 'always_last', 'sort_algorithm' => 'none'],
'phpdoc_add_missing_param_annotation' => true,
'phpdoc_align' => false, // align phpdoc yourself or don't, but we don't enforce it
'phpdoc_indent' => true,
'phpdoc_inline_tag_normalizer' => true,
'phpdoc_no_access' => true,
'phpdoc_no_empty_return' => true,
'phpdoc_no_package' => true,
'phpdoc_no_useless_inheritdoc' => true,
'phpdoc_order' => ['order' => ['param', 'return', 'throws']],
'phpdoc_order_by_value' => ['annotations' => ['covers']],
'phpdoc_return_self_reference' => true,
'phpdoc_scalar' => true,
'phpdoc_single_line_var_spacing' => true,
'phpdoc_trim' => true,
'phpdoc_trim_consecutive_blank_line_separation' => true,
'phpdoc_types' => true,
'phpdoc_types_order' => ['null_adjustment' => 'always_last', 'sort_algorithm' => 'none'],
'phpdoc_var_annotation_correct_order' => true,
'phpdoc_var_without_name' => true,
'protected_to_private' => true,
'self_static_accessor' => true,
'single_class_element_per_statement' => true,
'single_import_per_statement' => true,
'single_quote' => false, // we have no opinion on single quote use
'single_space_around_construct' => true,
'space_after_semicolon' => ['remove_in_empty_for_expressions' => true],
'standardize_not_equals' => true,
'string_implicit_backslashes' => true,
'switch_continue_to_break' => true,
'trailing_comma_in_multiline' => ['after_heredoc' => true,
'elements' => ['array_destructuring', 'arrays', 'match', 'parameters'],
],
'trim_array_spaces' => true,
'type_declaration_spaces' => true,
'types_spaces' => ['space' => 'none'],
'unary_operator_spaces' => true,
'whitespace_after_comma_in_array' => ['ensure_single_space' => true],
'yoda_style' => false, // official opinion on yoda style we do not have
])
->setFinder($finder)
->setCacheFile(__DIR__ . '/.cache/.php_cs.cache')
->setParallelConfig(ParallelConfigFactory::detect());

View file

@ -30,7 +30,7 @@
"thecodingmachine/safe": ">=2.5"
},
"require-dev": {
"friendsofphp/php-cs-fixer": "^3.68.3",
"laravel/pint": "^1.20",
"phpstan/phpstan": ">=1.12.16",
"phpunit/phpunit": ">=11.4.4",
"rector/rector": "^1.2.10",
@ -70,12 +70,12 @@
"scripts": {
"phpstan": "phpstan --verbose --memory-limit=2G",
"phpunit": "phpunit",
"php-cs-fixer": "php-cs-fixer",
"pint": "pint",
"test": "@phpunit",
"test:unit": "@phpunit --testsuite=Unit",
"test:functional": "@phpunit --testsuite=functional",
"style:check": "@php-cs-fixer check",
"style:fix": "@php-cs-fixer fix",
"style:check": "@pint --test",
"style:fix": "@pint",
"auto-scripts": {
"cache:clear": "symfony-cmd",
"assets:install %PUBLIC_DIR%": "symfony-cmd"

1757
composer.lock generated

File diff suppressed because it is too large Load diff

13
pint.json Normal file
View file

@ -0,0 +1,13 @@
{
"preset": "per",
"exclude": [
"svn",
"tmp",
"var",
"vendor"
],
"notName": [
"_ide_helper.php",
".phpstorm.meta.php"
]
}

View file

@ -29,20 +29,15 @@ class SyncAsset
#[ORM\Column(type: UuidType::NAME, unique: true)]
#[ORM\Id]
public readonly Uuid $id,

#[ORM\JoinColumn(name: 'sync_id', nullable: false)]
#[ORM\ManyToOne(inversedBy: 'assets')]
public readonly SyncResource $resource,

#[ORM\Column(length: 32)]
public readonly string $version,

#[ORM\Column(type: Types::TEXT, nullable: true)]
public readonly string $url,

#[ORM\Column]
public readonly int $created,

#[ORM\Column(nullable: true)]
public readonly ?array $metadata = null,
) {}

View file

@ -32,22 +32,16 @@ class SyncResource
#[ORM\Column(type: UuidType::NAME, unique: true)]
#[ORM\Id]
public readonly Uuid $id,

#[ORM\Column(length: 32)]
public readonly ResourceType $type,

#[ORM\Column(length: 255)]
public readonly string $slug,

#[ORM\Column(type: Types::TEXT)]
public readonly string $name,

#[ORM\Column(length: 32)]
public readonly string $status,

#[ORM\Column(length: 32, nullable: true)]
public readonly ?string $version,

#[ORM\Column(length: 32)]
public readonly string $origin,

@ -62,7 +56,6 @@ class SyncResource
// last updated date in metadata
#[ORM\Column]
public readonly ?int $updated,

#[ORM\Column(nullable: true)]
public readonly ?array $metadata = null,
) {

View file

@ -53,7 +53,7 @@ abstract class AbstractListService implements ListServiceInterface
$revision = $this->currentRevision[$name]['revision'];
$this->em->getConnection()->insert(
'revisions',
['action' => $name, 'revision' => $revision, 'added' => time()]
['action' => $name, 'revision' => $revision, 'added' => time()],
);
return (string) $revision;
}

View file

@ -26,18 +26,6 @@
"migrations/.gitignore"
]
},
"friendsofphp/php-cs-fixer": {
"version": "3.65",
"recipe": {
"repo": "github.com/symfony/recipes",
"branch": "main",
"version": "3.0",
"ref": "be2103eb4a20942e28a6dd87736669b757132435"
},
"files": [
".php-cs-fixer.dist.php"
]
},
"league/flysystem-bundle": {
"version": "3.3",
"recipe": {