Add documentation explanation for Auto Import #111
Conversation
Signed-off-by: Abdul Malik Ikhsan <[email protected]>
samsonasik
force-pushed
the
add-autoimport-doc
branch
from
cd2352c
to
8f8bf66
Compare
| @@ -14,7 +14,15 @@ return static function (RectorConfig $rectorConfig): void { | |||
| }; | |||
| ``` | |||
|
|
|||
| If you want to make renamed class type hint auto import enabled, you may use `SetList::LAMINAS_SERVICEMANGER_40_AUTO_IMPORT` set list, so the `rector.php` config will be as follow: | |||
| Rector works with all class names as fully qualified by default.In the most projects, that's not a desired behavior, because short version with use statement is easier to read. | |||
There was a problem hiding this comment.
…is easier to read.
This should be avoid because it is easier for you or me does not mean that it is easier for everyone else.
| Rector works with all class names as fully qualified by default.In the most projects, that's not a desired behavior, because short version with use statement is easier to read. | |
| Rector works with fully qualified class names by default. | |
| But most projects and coding standards use imported class names instead, like [laminas-coding-standard](https://docs.laminas.dev/laminas-coding-standard/). |
| If you want to make renamed class type hint auto import enabled, you may use `SetList::LAMINAS_SERVICEMANGER_40_AUTO_IMPORT` set list, so the `rector.php` config will be as follow: | ||
| Rector works with all class names as fully qualified by default.In the most projects, that's not a desired behavior, because short version with use statement is easier to read. | ||
|
|
||
| To import FQCN, configure rector.php with: |
There was a problem hiding this comment.
| To import FQCN, configure rector.php with: | |
| To import fully qualified class name (FQCN), configure rector.php with: |
| $rectorConfig->importNames(); | ||
| ``` | ||
|
|
||
| If you want to make renamed class type hint to use short name with import its fully qualified ot use statement, you may use `SetList::LAMINAS_SERVICEMANGER_40_AUTO_IMPORT` set list that utilize `$rectorConfig->importNames()` on it, so the `rector.php` config will be as follow: |
There was a problem hiding this comment.
Unfortunately, I don't understand the sentence or what the statement is. I will work out another proposal.
There was a problem hiding this comment.
Ok, I can close this PR for now so we can use yours :)
There was a problem hiding this comment.
…so we can use yours…
Which one? 🤷♂️
There was a problem hiding this comment.
When you have time to propose it, I believe you have better wording for it 👍
There was a problem hiding this comment.
Why did you delete the branch? All you had to do was explain what you wanted to say, then we would have found a suitable wording.
There was a problem hiding this comment.
You said you will work out another proposal, so I guess you had better wording already in mind :)
There was a problem hiding this comment.
Help me out, otherwise I can't help you!
What is happening? Why is SetList::LAMINAS_SERVICEMANGER_40_AUTO_IMPORT needed or better than $rectorConfig->importNames() or should both be used?
There was a problem hiding this comment.
The SetList::LAMINAS_SERVICEMANGER_40_AUTO_IMPORT include the base LAMINAS_SERVICEMANGER_40 which auto import enabled.
There is no better or worst, just a shortcut (1 statement vs multi).
user can directly use $rectorConfig->importNames(); after if they want.
There was a problem hiding this comment.
What is the recommended way? I think $rectorConfig->importNames();, as documented in the official documentation: https://getrector.com/documentation/import-names
So SetList::LAMINAS_SERVICEMANGER_40_AUTO_IMPORT is only nice to have and because it corresponds to the coding standard of Laminas. Right?
There was a problem hiding this comment.
Yeah, $rectorConfig->importNames() probably better, but since Rector still version 0.*, anything can changed about the name.
The SetList::LAMINAS_SERVICEMANGER_40_AUTO_IMPORT is a shortcut in case user don't want to type multi statements in config, also safer as the config call already included.
Description
@froschdesign this is copied from the website https://getrector.org/documentation/import-names
Fixes #69