Generate noinspections PHPStorm tags

[mzglinski]

When using write option for models eq

 php artisan ide-helper:models --smart-reset --write 

Generated PHPDoc has fully qualified names, about which PHPStorm complains (as it should). However, this is problematic since later during automatic code cleanup tasks these names are replaced with use statements. This generates unnecessary changes in the files, especially if some developers forget to run code cleanup. Later on, all of this stays in the git history.

As a solution, this PR adds a new option to the model command. --phpstorm-noinspections eg

php artisan ide-helper:models --smart-reset --write --phpstorm-noinspections

This will include two PHPStorm inspections at the end of the PHPDoc comment

 * @noinspection PhpFullyQualifiedNameUsageInspection
 * @noinspection PhpUnnecessaryFullyQualifiedNameInspection

which will stop PHPStorm from replacing the autogenerated FQN with use statements.

[mfn]

I like it, seems "practically useful".

(although personally I've been living with this warning for years and no team member ever complained, but 🤷‍♀️)

However: could you please add a test for this? Thanks!

[mfn]

• @noinspection PhpFullyQualifiedNameUsageInspection
• @noinspection PhpUnnecessaryFullyQualifiedNameInspection

Wait, why does it need both?

I'm on 2020.1 Beta and only PhpFullyQualifiedNameUsageInspection is recognized, the other seems not to have an impact?

[mzglinski]

Sure, I will write a test tomorrow ;)

As for PhpUnnecessaryFullyQualifiedNameInspection please refer to https://www.jetbrains.com/help/phpstorm/php-unnecessary-fully-qualified-name.html

This is for relations basically, they are also FQN but all models are usually in the same namespace so FQN is not necessary and PHPStorm removes their namespaces on code cleanup/code reformat.

[mfn]

As for PhpUnnecessaryFullyQualifiedNameInspection please refer to https://www.jetbrains.com/help/phpstorm/php-unnecessary-fully-qualified-name.html

This is for relations basically, they are also FQN but all models are usually in the same namespace so FQN is not necessary and PHPStorm removes their namespaces on code cleanup/code reformat.

Thanks for the details!

I think it would be great if you could add this as a code comment with the block if ($this->phpstorm_noinspections) { so it's clear as to why (adding the link would be also nice).

thanks

[mfn]

LGTM 👍

ping @barryvdh

[mzglinski]

Is there any chance for this to be merged in the near future?