Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add symlink loop prevention to config template and docs #2825

Merged
merged 1 commit into from
Mar 29, 2022
Merged

docs: add symlink loop prevention to config template and docs #2825

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions docs/configuration_and_processing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ return static function (ContainerConfigurator $containerConfigurator): void {
// this will not import root namespace classes, like \DateTime or \Exception
$parameters->set(Option::IMPORT_SHORT_CLASSES, false);

// this prevents infinite loop issues due to symlinks in e.g. ".Build/" folders within single extensions
$parameters->set(Option::FOLLOW_SYMLINKS, false);

// this will not import classes used in PHP DocBlocks, like in /** @var \Some\Class */
$parameters->set(Option::IMPORT_DOC_BLOCKS, false);

Expand Down
3 changes: 3 additions & 0 deletions templates/rector.php.dist
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ return static function (ContainerConfigurator $containerConfigurator): void {
// this will not import root namespace classes, like \DateTime or \Exception
$parameters->set(Option::IMPORT_SHORT_CLASSES, false);

// this prevents infinite loop issues due to symlinks in e.g. ".Build/" folders within single extensions
$parameters->set(Option::FOLLOW_SYMLINKS, false);

// this will not import classes used in PHP DocBlocks, like in /** @var \Some\Class */
$parameters->set(Option::IMPORT_DOC_BLOCKS, false);

Expand Down