Skip to content

Document import_short_classes + import_doc_blocks #2428

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

Merged
TomasVotruba merged 1 commit into from
Dec 13, 2019
Merged

Document import_short_classes + import_doc_blocks #2428

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
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,14 +193,23 @@ parameters:

### Import Use Statements

FQN classes are imported by default every time Rector performs a change, so you don't have to do it manually/after each run. You can disable it by:
FQN classes are imported by default every time Rector performs a change, so you don't have to do it manually/after each run. You can disable it by:

```yaml
# rector.yaml
parameters:
auto_import_names: false
```

You can also fine-tune how these imports are processed using these two options :

```yaml
# rector.yaml
parameters:
import_short_classes: false # this will not import root namespace classes, like \DateTime or \Exception
import_doc_blocks: false # this will not import classes used in PHP DocBlocks, like in /** @var \Some\Class */
```

### Limit Execution to Changed Files

Execution can be limited to changed files using the `process` option `--match-git-diff`.
Expand Down