Certain file paths ignored per default

[scheb]

Subject	Details
PHP version	PHP 7.3.7
Full Command	vendor/composer/bin/rector process src test -vvv

Current Behaviour

Hello there, I tried to upgrade my project with rector (great tool btw!) and was wondering why certain parts of my codebase aren't upgraded, although I haven't excluded these files and I've seen the files being auto-loaded during the parsing process. Running rector with -vvv revealed that they're never listed during [parsing].

Recognized that it's only ignoring directories with name "fixtures", which is where I store classes to load fixture data and prepare state. They're part of the test suite and they're code like everything else following the same coding standards and autoloading conventions, so I want to include them in the upgrade process of course.

Turned out that rector has some hardcoded filters to ignore certain file paths per default (including "fixtures") and these rules cannot be deactivated/overwritten. Imo that's a bad idea, because it is not obvious to the user and there's no way to contol this behavior.

Minimal PHP Code Causing Issue

rector/src/FileSystem/FilesFinder.php

Lines 100 to 102 in 548d132

	->exclude(
	['examples', 'Examples', 'stubs', 'Stubs', 'fixtures', 'Fixtures', 'polyfill', 'Polyfill', 'vendor']
	)

Expected Behaviour

Rector should not make assumptions that certain paths can be excluded per default. Exclusion patterns should be required to be configured explicitly.

[TomasVotruba]

👍 It could be a parameter

[scheb]

Thanks for the super-quick response. That would work for me :)

[scheb]

@TomasVotruba Do you have a suggestion how to name that parameter, then I may try myself on implementing it.

[TomasVotruba]

@scheb If you look how PHP version is provided, it should be the same:

• add excluded_paths to config like php_version_features -

  rector/config/config.yaml

  Line 12 in 4e0ec2e

  php_version_features: ~ # what PHP version should be used for features, local PHP version is used by default

• then create e.g. ExcludePathsProvider like

  rector/src/Php/PhpVersionProvider.php

  Line 24 in 2883040

  $phpVersionFeatures = $this->parameterProvider->provideParameter(Option::PHP_VERSION_FEATURES);

[scheb]

Ok, got it.

Since there is already exclude_paths as a parameter, should we go with default_exclude_paths: true/false then?

[TomasVotruba]

Ah, what about passing this parameter to a command and keep it empty?

To be honest, I'm not sure why there are those default ignores. Possibly some left over from Symfony refactoring experiments a year back

[scheb]

Well, if you ask me, the best solution would be to remove these default excludes and instead ask people to explicitly configure them in excluded_paths, if they really need them. Just thought you want to keep them for a reason, but as I now understand there is no such reason ;)

[TomasVotruba]

Go for it :)