Skip to content

Commit

Permalink
docs: add symlink loop prevention to config template and docs
Browse files Browse the repository at this point in the history
Relates: #2653
  • Loading branch information
helsner committed Mar 29, 2022
1 parent c714176 commit db69b94
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/configuration_and_processing.md
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 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
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 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

0 comments on commit db69b94

Please sign in to comment.