Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
175 changes: 175 additions & 0 deletions config/set/per-cs.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@
<?php

declare(strict_types=1);

use PhpCsFixer\Fixer\ArrayNotation\ArraySyntaxFixer;
use PhpCsFixer\Fixer\AttributeNotation\AttributeBlockNoSpacesFixer;
use PhpCsFixer\Fixer\Basic\BracesPositionFixer;
use PhpCsFixer\Fixer\Basic\EncodingFixer;
use PhpCsFixer\Fixer\Basic\NoMultipleStatementsPerLineFixer;
use PhpCsFixer\Fixer\Basic\SingleLineEmptyBodyFixer;
use PhpCsFixer\Fixer\Casing\ConstantCaseFixer;
use PhpCsFixer\Fixer\Casing\LowercaseKeywordsFixer;
use PhpCsFixer\Fixer\Casing\LowercaseStaticReferenceFixer;
use PhpCsFixer\Fixer\CastNotation\CastSpacesFixer;
use PhpCsFixer\Fixer\CastNotation\LowercaseCastFixer;
use PhpCsFixer\Fixer\CastNotation\ShortScalarCastFixer;
use PhpCsFixer\Fixer\ClassNotation\ClassDefinitionFixer;
use PhpCsFixer\Fixer\ClassNotation\ModifierKeywordsFixer;
use PhpCsFixer\Fixer\ClassNotation\NoBlankLinesAfterClassOpeningFixer;
use PhpCsFixer\Fixer\ClassNotation\OrderedClassElementsFixer;
use PhpCsFixer\Fixer\ClassNotation\OrderedTypesFixer;
use PhpCsFixer\Fixer\ClassNotation\SingleClassElementPerStatementFixer;
use PhpCsFixer\Fixer\ClassNotation\SingleTraitInsertPerStatementFixer;
use PhpCsFixer\Fixer\Comment\NoTrailingWhitespaceInCommentFixer;
use PhpCsFixer\Fixer\ControlStructure\ControlStructureBracesFixer;
use PhpCsFixer\Fixer\ControlStructure\ControlStructureContinuationPositionFixer;
use PhpCsFixer\Fixer\ControlStructure\ElseifFixer;
use PhpCsFixer\Fixer\ControlStructure\NoBreakCommentFixer;
use PhpCsFixer\Fixer\ControlStructure\SwitchCaseSemicolonToColonFixer;
use PhpCsFixer\Fixer\ControlStructure\SwitchCaseSpaceFixer;
use PhpCsFixer\Fixer\ControlStructure\TrailingCommaInMultilineFixer;
use PhpCsFixer\Fixer\FunctionNotation\FunctionDeclarationFixer;
use PhpCsFixer\Fixer\FunctionNotation\MethodArgumentSpaceFixer;
use PhpCsFixer\Fixer\FunctionNotation\NoSpacesAfterFunctionNameFixer;
use PhpCsFixer\Fixer\FunctionNotation\ReturnTypeDeclarationFixer;
use PhpCsFixer\Fixer\Import\NoLeadingImportSlashFixer;
use PhpCsFixer\Fixer\Import\OrderedImportsFixer;
use PhpCsFixer\Fixer\Import\SingleImportPerStatementFixer;
use PhpCsFixer\Fixer\Import\SingleLineAfterImportsFixer;
use PhpCsFixer\Fixer\LanguageConstruct\DeclareEqualNormalizeFixer;
use PhpCsFixer\Fixer\LanguageConstruct\NullableTypeDeclarationFixer;
use PhpCsFixer\Fixer\LanguageConstruct\SingleSpaceAroundConstructFixer;
use PhpCsFixer\Fixer\NamespaceNotation\BlankLineAfterNamespaceFixer;
use PhpCsFixer\Fixer\NamespaceNotation\BlankLinesBeforeNamespaceFixer;
use PhpCsFixer\Fixer\Operator\BinaryOperatorSpacesFixer;
use PhpCsFixer\Fixer\Operator\ConcatSpaceFixer;
use PhpCsFixer\Fixer\Operator\NewWithParenthesesFixer;
use PhpCsFixer\Fixer\Operator\NoSpaceAroundDoubleColonFixer;
use PhpCsFixer\Fixer\Operator\OperatorLinebreakFixer;
use PhpCsFixer\Fixer\Operator\TernaryOperatorSpacesFixer;
use PhpCsFixer\Fixer\Operator\UnaryOperatorSpacesFixer;
use PhpCsFixer\Fixer\PhpTag\BlankLineAfterOpeningTagFixer;
use PhpCsFixer\Fixer\PhpTag\FullOpeningTagFixer;
use PhpCsFixer\Fixer\PhpTag\NoClosingTagFixer;
use PhpCsFixer\Fixer\Whitespace\ArrayIndentationFixer;
use PhpCsFixer\Fixer\Whitespace\BlankLineBetweenImportGroupsFixer;
use PhpCsFixer\Fixer\Whitespace\CompactNullableTypeDeclarationFixer;
use PhpCsFixer\Fixer\Whitespace\IndentationTypeFixer;
use PhpCsFixer\Fixer\Whitespace\LineEndingFixer;
use PhpCsFixer\Fixer\Whitespace\NoExtraBlankLinesFixer;
use PhpCsFixer\Fixer\Whitespace\NoTrailingWhitespaceFixer;
use PhpCsFixer\Fixer\Whitespace\NoWhitespaceInBlankLineFixer;
use PhpCsFixer\Fixer\Whitespace\SingleBlankLineAtEofFixer;
use PhpCsFixer\Fixer\Whitespace\SpacesInsideParenthesesFixer;
use PhpCsFixer\Fixer\Whitespace\StatementIndentationFixer;
use PhpCsFixer\Fixer\Whitespace\TypesSpacesFixer;
use Symplify\EasyCodingStandard\Config\ECSConfig;

// PER Coding Style 3.0, mirrors PHP-CS-Fixer @PER-CS3x0 set (non-risky rules only)
return ECSConfig::configure()
->withConfiguredRule(BinaryOperatorSpacesFixer::class, [
'default' => 'at_least_single_space',
])
->withConfiguredRule(BracesPositionFixer::class, [
'allow_single_line_anonymous_functions' => false,
'allow_single_line_empty_anonymous_classes' => true,
])
->withConfiguredRule(ClassDefinitionFixer::class, [
'inline_constructor_arguments' => false,
'space_before_parenthesis' => true,
])
->withConfiguredRule(ConcatSpaceFixer::class, [
'spacing' => 'one',
])
->withConfiguredRule(FunctionDeclarationFixer::class, [
'closure_fn_spacing' => 'none',
])
->withConfiguredRule(MethodArgumentSpaceFixer::class, [
'after_heredoc' => false,
])
->withConfiguredRule(NewWithParenthesesFixer::class, [
'anonymous_class' => false,
])
->withConfiguredRule(NoExtraBlankLinesFixer::class, [
'tokens' => ['use'],
])
->withConfiguredRule(OrderedClassElementsFixer::class, [
'order' => ['use_trait'],
])
->withConfiguredRule(OrderedImportsFixer::class, [
'imports_order' => ['class', 'function', 'const'],
'sort_algorithm' => 'none',
])
->withConfiguredRule(OrderedTypesFixer::class, [
'null_adjustment' => 'always_last',
'sort_algorithm' => 'none',
])
->withConfiguredRule(SingleImportPerStatementFixer::class, [
'group_to_single_imports' => false,
])
->withConfiguredRule(SingleSpaceAroundConstructFixer::class, [
'constructs_followed_by_a_single_space' => [
'abstract', 'as', 'case', 'catch', 'class', 'const', 'const_import', 'do', 'else', 'elseif',
'enum', 'final', 'finally', 'for', 'foreach', 'function', 'function_import', 'if', 'insteadof',
'interface', 'match', 'named_argument', 'namespace', 'new', 'private', 'protected', 'public',
'readonly', 'static', 'switch', 'trait', 'try', 'type_colon', 'use', 'use_lambda', 'while',
],
'constructs_preceded_by_a_single_space' => ['as', 'else', 'elseif', 'use_lambda'],
])
->withConfiguredRule(TrailingCommaInMultilineFixer::class, [
'after_heredoc' => true,
'elements' => ['arguments', 'array_destructuring', 'arrays', 'match', 'parameters'],
])
->withConfiguredRule(UnaryOperatorSpacesFixer::class, [
'only_dec_inc' => true,
])
->withRules([
ArrayIndentationFixer::class,
ArraySyntaxFixer::class,
AttributeBlockNoSpacesFixer::class,
BlankLineAfterNamespaceFixer::class,
BlankLineAfterOpeningTagFixer::class,
BlankLineBetweenImportGroupsFixer::class,
BlankLinesBeforeNamespaceFixer::class,
CastSpacesFixer::class,
CompactNullableTypeDeclarationFixer::class,
ConstantCaseFixer::class,
ControlStructureBracesFixer::class,
ControlStructureContinuationPositionFixer::class,
DeclareEqualNormalizeFixer::class,
ElseifFixer::class,
EncodingFixer::class,
FullOpeningTagFixer::class,
IndentationTypeFixer::class,
LineEndingFixer::class,
LowercaseCastFixer::class,
LowercaseKeywordsFixer::class,
LowercaseStaticReferenceFixer::class,
ModifierKeywordsFixer::class,
NoBlankLinesAfterClassOpeningFixer::class,
NoBreakCommentFixer::class,
NoClosingTagFixer::class,
NoLeadingImportSlashFixer::class,
NoMultipleStatementsPerLineFixer::class,
NoSpaceAroundDoubleColonFixer::class,
NoSpacesAfterFunctionNameFixer::class,
NoTrailingWhitespaceFixer::class,
NoTrailingWhitespaceInCommentFixer::class,
NoWhitespaceInBlankLineFixer::class,
NullableTypeDeclarationFixer::class,
OperatorLinebreakFixer::class,
ReturnTypeDeclarationFixer::class,
ShortScalarCastFixer::class,
SingleBlankLineAtEofFixer::class,
SingleClassElementPerStatementFixer::class,
SingleLineAfterImportsFixer::class,
SingleLineEmptyBodyFixer::class,
SingleTraitInsertPerStatementFixer::class,
SpacesInsideParenthesesFixer::class,
StatementIndentationFixer::class,
SwitchCaseSemicolonToColonFixer::class,
SwitchCaseSpaceFixer::class,
TernaryOperatorSpacesFixer::class,
TypesSpacesFixer::class,
]);
6 changes: 6 additions & 0 deletions src/Configuration/ECSConfigBuilder.php
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,8 @@ public function withRootFiles(): self
public function withPreparedSets(
/** @see SetList::PSR_12 */
bool $psr12 = false,
/** @see SetList::PER_CS */
bool $perCs = false,
/** @see SetList::COMMON */
bool $common = false,
/** @see SetList::LARAVEL */
Expand Down Expand Up @@ -238,6 +240,10 @@ public function withPreparedSets(
$this->sets[] = SetList::PSR_12;
}

if ($perCs) {
$this->sets[] = SetList::PER_CS;
}

if ($common) {
// include all "common" sets
$this->sets[] = SetList::COMMON;
Expand Down
5 changes: 5 additions & 0 deletions src/ValueObject/Set/SetList.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ final class SetList
*/
public const string PSR_12 = __DIR__ . '/../../../config/set/psr12.php';

/**
* @api
*/
public const string PER_CS = __DIR__ . '/../../../config/set/per-cs.php';

/**
* @api
*/
Expand Down
26 changes: 26 additions & 0 deletions tests/Set/PerCs/Fixture/fixture.php.inc
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<?php
declare(strict_types=1);
namespace App;
class Sample{
public function run(null|int $a,array $items=array()):bool{
$result = $a
&& count($items) > 0;
return $result;
}
}
-----
<?php

declare(strict_types=1);

namespace App;

class Sample
{
public function run(?int $a, array $items = []): bool
{
$result = $a
&& count($items) > 0;
return $result;
}
}
29 changes: 29 additions & 0 deletions tests/Set/PerCs/PerCsTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?php

declare(strict_types=1);

namespace Symplify\EasyCodingStandard\Tests\Set\PerCs;

use Iterator;
use PHPUnit\Framework\Attributes\DataProvider;
use Symplify\EasyCodingStandard\Testing\PHPUnit\AbstractCheckerTestCase;
use Symplify\EasyCodingStandard\ValueObject\Set\SetList;

final class PerCsTest extends AbstractCheckerTestCase
{
#[DataProvider('provideData')]
public function test(string $filePath): void
{
$this->doTestFile($filePath);
}

public static function provideData(): Iterator
{
return self::yieldFiles(__DIR__ . '/Fixture');
}

public function provideConfig(): string
{
return SetList::PER_CS;
}
}
Loading