Skip to content

ECSConfig

github-actions edited this page Apr 26, 2026 · 1 revision

Provides the default ECS configuration.

Consumers can use this as a starting point and extend it:

$config = \FastForward\DevTools\Config\ECSConfig::configure(); $config->withRules([CustomRule::class]); $config->withConfiguredRule(PhpdocAlignFixer::class, ['align' => 'right']); return $config;


  • Full name: \FastForward\DevTools\Config\ECSConfig
  • This class is marked as final and can't be subclassed
  • This class is a Final class

See Also:

Constants

Constant Visibility Type Value
DEFAULT_PHP_CS_FIXER_SETS public array{symfony: bool, symfonyRisky: bool, auto: bool, autoRisky: bool} ['symfony' => true, 'symfonyRisky' => true, 'auto' => true, 'autoRisky' => true]
DEFAULT_PREPARED_SETS public array{psr12: bool, common: bool, symplify: bool, strict: bool, cleanCode: bool} ['psr12' => true, 'common' => true, 'symplify' => true, 'strict' => true, 'cleanCode' => true]
DEFAULT_SKIPPED_RULES public list [\PhpCsFixer\Fixer\Phpdoc\PhpdocToCommentFixer::class, \PhpCsFixer\Fixer\Phpdoc\NoSuperfluousPhpdocTagsFixer::class, \PhpCsFixer\Fixer\Phpdoc\NoEmptyPhpdocFixer::class, \PhpCsFixer\Fixer\Phpdoc\PhpdocNoEmptyReturnFixer::class, \PhpCsFixer\Fixer\Import\GlobalNamespaceImportFixer::class, \PhpCsFixer\Fixer\Phpdoc\GeneralPhpdocAnnotationRemoveFixer::class]
DEFAULT_CONFIGURED_RULES public array<class-string,array<string,mixed>> [\PhpCsFixer\Fixer\Phpdoc\PhpdocAlignFixer::class => ['align' => 'left'], \PhpCsFixer\Fixer\PhpUnit\PhpUnitTestCaseStaticMethodCallsFixer::class => ['call_type' => 'self'], \PhpCsFixer\Fixer\Phpdoc\PhpdocAddMissingParamAnnotationFixer::class => ['only_untyped' => false]]

Methods

configure

Creates the default ECS configuration.

public static configure(callable|null $customize = null): \Symplify\EasyCodingStandard\Configuration\ECSConfigBuilder
  • This method is static. Parameters:
Parameter Type Description
$customize callable|null optional callback to customize the configuration builder

Return Value:

the configured ECS configuration builder


applyDefaultPathsAndSkips

Applies the default repository paths and skipped rules to an ECS builder.

public static applyDefaultPathsAndSkips(\Symplify\EasyCodingStandard\Configuration\ECSConfigBuilder $config, string $workingDirectory): \Symplify\EasyCodingStandard\Configuration\ECSConfigBuilder
  • This method is static. Parameters:
Parameter Type Description
$config \Symplify\EasyCodingStandard\Configuration\ECSConfigBuilder
$workingDirectory string

applyDefaultRulesAndSets

Applies the default ECS sets, root files, and configured rules to an ECS builder.

public static applyDefaultRulesAndSets(\Symplify\EasyCodingStandard\Configuration\ECSConfigBuilder $config): \Symplify\EasyCodingStandard\Configuration\ECSConfigBuilder
  • This method is static. Parameters:
Parameter Type Description
$config \Symplify\EasyCodingStandard\Configuration\ECSConfigBuilder

Clone this wiki locally