Skip to content
Merged
Changes from all commits
Commits
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
22 changes: 18 additions & 4 deletions docs/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,30 @@ import { Steps } from '@astrojs/starlight/components';

## PHPStan extension

Upon installation, if you're using `phpstan/extension-installer`, an extension will be enabled automatically.
Alternatively, you can enable it manually in your `phpstan.neon`:
A PHPStan extension is shipped with the package. If you're using `phpstan/extension-installer`, it will be
enabled automatically. We recommend keeping it on, but it's not required.

If it's causing you any issues or you just don't want it, you can disable it through your `composer.json`:

```json
{
"extra": {
"phpstan/extension-installer": {
"ignore": ["good-php/reflection"]
}
}
}
```

#### If you aren't using `phpstan/extension-installer`

You can, of course, enable it manually in your `phpstan.neon`:

```neon
includes:
- vendor/good-php/reflection/phpstan-extension.neon
```

It improves some type inference, so we recommend keeping it on, but it's not required :)

## Customizing cache

It's crucial that you use some kind of cache. Out of the box, we support file-based cache and in-memory cache.
Expand Down