symplify / skipper
Skip files by rule class, directory, file or fnmatch
Fund package maintenance!
tomasvotruba
www.paypal.me/rectorphp
Requires
- php: >=8.0
- nette/utils: ^3.2
- symfony/config: ^6.0
- symfony/dependency-injection: ^6.0
- symfony/filesystem: ^6.0
- symfony/finder: ^6.0
- symplify/package-builder: ^11.1.6
- symplify/smart-file-system: ^11.1.6
- symplify/symplify-kernel: ^11.1.6
Requires (Dev)
- phpunit/phpunit: ^9.5.23
Conflicts
- symplify/autowire-array-parameter: <11.1.6
- symplify/coding-standard: <11.1.6
- symplify/composer-json-manipulator: <11.1.6
- symplify/config-transformer: <11.1.6
- symplify/easy-ci: <11.1.6
- symplify/easy-coding-standard: <11.1.6
- symplify/easy-parallel: <11.1.6
- symplify/easy-testing: <11.1.6
- symplify/monorepo-builder: <11.1.6
- symplify/php-config-printer: <11.1.6
- symplify/phpstan-extensions: <11.1.6
- symplify/phpstan-rules: <11.1.6
- symplify/rule-doc-generator: <11.1.6
- symplify/rule-doc-generator-contracts: <11.1.6
- symplify/symfony-static-dumper: <11.1.6
- symplify/vendor-patches: <11.1.6
- dev-main / 11.2.x-dev
- 11.1.6
- 11.1.5
- 11.1.4
- 11.1.3
- 11.1.2
- 11.1.1
- 11.1.0
- 11.0.9
- 11.0.8
- 11.0.7
- 11.0.6
- 11.0.5
- 11.0.4
- 11.0.3
- 11.0.2
- 11.0.1
- 11.0.0
- 10.3.3
- 10.3.2
- 10.3.1
- 10.3.0
- 10.2.11
- 10.2.10
- 10.2.9
- 10.2.8
- 10.2.7
- 10.2.6
- 10.2.5
- 10.2.4
- 10.2.3
- 10.2.2
- 10.2.1
- 10.2.0
- 10.1.4
- 10.1.3
- 10.1.2
- 10.1.1
- 10.1.0
- 10.0.25
- 10.0.24
- 10.0.23
- 10.0.22
- 10.0.21
- 10.0.20
- 10.0.19
- 10.0.18
- 10.0.17
- 10.0.16
- 10.0.15
- 10.0.14
- 10.0.13
- 10.0.12
- 10.0.11
- 10.0.10
- 10.0.9
- 10.0.8
- 10.0.7
- 10.0.6
- 10.0.5
- 10.0.4
- 10.0.3
- 10.0.2
- 10.0.1
- 10.0.0
- 10.0.0-beta17
- 10.0.0-beta16
- 10.0.0-beta15
- 10.0.0-beta14
- 10.0.0-beta13
- 10.0.0-beta12
- 10.0.0-beta11
- 10.0.0-beta10
- 10.0.0-beta9
- 10.0.0-beta8
- 10.0.0-beta7
- 10.0.0-beta6
- 10.0.0-beta5
- 10.0.0-beta4
- 10.0.0-beta3
- 10.0.0-beta2
- 10.0.0-beta1
- 9.4.70
- 9.4.69
- 9.4.68
- 9.4.67
- 9.4.66
- 9.4.65
- 9.4.64
- 9.4.63
- 9.4.62
- 9.4.61
- 9.4.60
- 9.4.59
- 9.4.58
- 9.4.57
- 9.4.56
- 9.4.55
- 9.4.54
- 9.4.53
- 9.4.52
- 9.4.51
- 9.4.50
- 9.4.49
- 9.4.48
- 9.4.47
- 9.4.46
- 9.4.45
- 9.4.44
- 9.4.43
- 9.4.42
- 9.4.41
- 9.4.40
- 9.4.39
- 9.4.38
- 9.4.37
- 9.4.36
- 9.4.35
- 9.4.34
- 9.4.33
- 9.4.32
- 9.4.31
- 9.4.30
- 9.4.29
- 9.4.28
- 9.4.27
- 9.4.26
- 9.4.25
- 9.4.24
- 9.4.23
- 9.4.22
- 9.4.21
- 9.4.20
- 9.4.19
- 9.4.18
- 9.4.17
- 9.4.16
- 9.4.15
- 9.4.14
- 9.4.13
- 9.4.12
- 9.4.11
- 9.4.10
- 9.4.9
- 9.4.8
- 9.4.7
- 9.4.6
- 9.4.5
- 9.4.4
- 9.4.3
- 9.4.2
- v9.4.1
- v9.4.0
- v9.3.27
- v9.3.26
- v9.3.25
- v9.3.24
- v9.3.23
- v9.3.22
- v9.3.21
- v9.3.20
- v9.3.19
- v9.3.18
- v9.3.17
- v9.3.16
- v9.3.15
- v9.3.14
- v9.3.13
- v9.3.12
- v9.3.11
- v9.3.10
- v9.3.8
- v9.3.6
- v9.3.5
- v9.3.4
- v9.3.3
- v9.3.1
- v9.3.0
- v9.2.24
- v9.2.23
- v9.2.22
- v9.2.21
- v9.2.20
- v9.2.19
- v9.2.18
- v9.2.17
- v9.2.16
- v9.2.15
- v9.2.14
- v9.2.13
- v9.2.12
- v9.2.11
- v9.2.10
- v9.2.9
- v9.2.8
- v9.2.7
- v9.2.6
- v9.2.5
- v9.2.4
- v9.2.3
- v9.2.2
- 9.2.1
- 9.2.0
- 9.1.9
- 9.1.8
- 9.1.7
- 9.1.6
- 9.1.5
- 9.1.4
- 9.1.3
- 9.1.1
- 9.1.0
- 9.0.50
- 9.0.49
- 9.0.48
- 9.0.47
- 9.0.46
- 9.0.45
- 9.0.44
- 9.0.43
- 9.0.42
- 9.0.41
- 9.0.40
- 9.0.39
- 9.0.38
- 9.0.37
- 9.0.36
- 9.0.35
- 9.0.34
- 9.0.33
- 9.0.32
- 9.0.31
- 9.0.30
- 9.0.29
- 9.0.28
- 9.0.27
- 9.0.26
- 9.0.25
- 9.0.24
- 9.0.23
- 9.0.22
- 9.0.21
- 9.0.20
- 9.0.19
- 9.0.18
- 9.0.17
- 9.0.16
- 9.0.15
- 9.0.14
- 9.0.13
- 9.0.12
- 9.0.11
- 9.0.10
- 9.0.9
- 9.0.8
- 9.0.7
- 9.0.6
- 9.0.5
- 9.0.4
- 9.0.3
- 9.0.2
- 9.0.1
- 9.0.0
- 9.0.0-rc1
- 9.0.0-BETA9
- 9.0.0-BETA8
- 9.0.0-BETA7
- 9.0.0-BETA6
- 9.0.0-BETA5
- 9.0.0-BETA4
- 9.0.0-BETA3
- 9.0.0-BETA2
- 9.0.0-BETA1
- 8.3.48
This package is auto-updated.
Last update: 2022-08-31 14:15:41 UTC
README
Skip files by rule class, fnmatch or regex.
Install
composer require symplify/skipper
Register package in your config:
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator; use Symplify\Skipper\ValueObject\SkipperConfig; return static function (ContainerConfigurator $containerConfigurator): void { $containerConfigurator->import(SkipperConfig::FILE_PATH); };
Use
1. Configure with Option::SKIP
parameter.
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator; use Symplify\Skipper\ValueObject\Option; return static function (ContainerConfigurator $containerConfigurator): void { $parameters = $containerConfigurator->parameters(); $parameters->set(Option::SKIP, [ // absolute directory __DIR__ . '/some-path', // absolute file __DIR__ . '/some-path/some-file.php', // with mask '*/Fixture/*', // specific class SomeClass::class, ]); };
Or for rules and paths specific ignores:
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator; use Symplify\Skipper\ValueObject\Option; return static function (ContainerConfigurator $containerConfigurator): void { $parameters = $containerConfigurator->parameters(); $parameters->set(Option::SKIP, [ // specific class SomeClass::class => [__DIR__ . '/src/OnlyHere'], // class code in paths SomeSniff::class . '.SomeCode' => ['*Sniff.php', '*YamlFileLoader.php'], ]); };
2. Use Skipper
service in Your Project
You have 3 way to decide, if the something should be skipped:
- the element
- the file info
- the element in the file info
use Symplify\Skipper\Skipper\Skipper; use Symplify\SmartFileSystem\SmartFileInfo; final class SomeClass { /** * @var Skipper */ private $skipper; public function __construct(Skipper $skipper) { $this->skipper = $skipper; } public function run(string|object $element, SmartFileInfo $fileInfo): void { // 1. skip the element? $shouldBeSkipped = $this->skipper->shouldSkipElement($element); // 2. skip the file path? $shouldBeSkipped = $this->skipper->shouldSkipFileInfo($fileInfo); // 3. skip the element in the file path? $shouldBeSkipped = $this->skipper->shouldSkipElementAndFileInfo($element, $fileInfo); } }
Report Issues
In case you are experiencing a bug or want to request a new feature head over to the Symplify monorepo issue tracker
Contribute
The sources of this package are contained in the Symplify monorepo. We welcome contributions for this package on symplify/symplify.