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.

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

Config generation on global installation #65

Open
umulmrum opened this issue Aug 1, 2022 · 5 comments
Open

Config generation on global installation #65

umulmrum opened this issue Aug 1, 2022 · 5 comments

Comments

@umulmrum
Copy link

umulmrum commented Aug 1, 2022

Hi,

I have the following constellation:

  • PHPStan is installed globally (composer global require ...)
  • My project is of course "local" and I use PHPStan there.

My problem is as follows:

  • I run PHPStan after setup, and results are as expected.
  • Then I run composer install locally in the project.
  • When I run PHPStan again, the scan fails.

This is because the extension installer re-generates the GeneratedConfig on composer install, and because there are no extensions installed locally, the config is now empty. This leads to some code not being correctly interpreted because the extensions are ignored.

Is there anything I need to do, or do you have other advice? Thanks! :-)

@ondrejmirtes
Copy link
Member

Hi, I don't understand this problem, can you list the exact steps that lead to this problem? I don't understand why running composer install locally in the project would lead to executing a plugin from the global installation.

Anyway, your best best is to install PHPStan locally in your project, which will remove your headaches like these, and is the recommended option anyway (https://phpstan.org/user-guide/getting-started).

@umulmrum
Copy link
Author

umulmrum commented Aug 2, 2022

@ondrejmirtes Thanks for your reply. These are the steps (I didn't doublecheck, so there might be mistakes in them, but I think the way in general gets clear):

  • composer install in the project directory (so all dependencies are available). Do NOT install PHPStan in the project.
  • composer global require phpstan/phpstan phpstan/extension-installer phpstan/phpstan-doctrine (I include more extensions, but the Doctrine one should be enough for the example).
  • Define a Doctrine entity with a mapped generated ID without write accesses (as Doctrine handles those in the background). See below for an example. Without the extension this would fail with "$id is never written, only read".
  • phpstan analyse (on level 9) within the project directory, using the globally installed PHPStan. The check passes because of the extension.
  • composer install in the project directory. This overwrites the GeneratedConfig in the global PHPStan installation.
  • phpstan analyse again. Now the check fails because the extension is no longer active.

Example entity (reader, but no setter):

class MyEntity
{
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column(type: 'integer')]
    private int $id;

    public function getId(): int
    {
        return $this->id;
    }
}

I'd like to avoid installing quality tools as project dependencies, to a) have them completely independent and "un-interfering", and b) only need a single installation in a monorepo to simplify maintenance.

@scollovati
Copy link

I had the same issue today: TomasVotruba/type-coverage#10 (comment)

By uninstalling the global "auto-installer" everything goes fine. However, having the possibility of using PHPStan with extensions both locally and globally with the auto-installer would be great.

Until this issue is solved, the only possibility is to include manually the config files.

NB: it seems the same issue referenced here #76 (comment)

@michaellehmkuhl
Copy link

I also ran into this issue. Thanks @scollovati for the hint about uninstalling.

After I removed it with composer global uninstall phpstan/extension-installer, my local project composer install correctly populated the GeneratedConfig.php in my project vendor directory.

@umulmrum
Copy link
Author

umulmrum commented Jun 6, 2024

FYI I ended up adding a call to composer global install to the composer script that runs PHPStan, so the issue is automatically handled on each execution.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants