Skip to content

Commit

Permalink
cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
TomasVotruba committed Aug 22, 2023
1 parent 44bc11a commit 5f1c0ac
Showing 1 changed file with 4 additions and 17 deletions.
21 changes: 4 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,21 +50,18 @@ Pick what you need, drop the rest.
## 3. How we use Configurable Rules
Last but not least, configurable rules with *saints defaults*. That's just polite wording for *opinionated*, like [`AllowedExclusiveDependencyRule`](https://github.com/symplify/phpstan-rules/blob/main/docs/rules_overview.md#allowedexclusivedependencyrule).

You might not like them, but maybe you do:
Last but not least, configurable rules with *saints defaults*:
```yaml
# phpstan.neon
includes:
- vendor/symplify/phpstan-rules/config/configurable-rules.neon
```
Give it a trial run... so many erros and unclear feedback.... Would you like to **configure them yourself?**
That's good! We use one rule by another in other projects too, instead of one big import.
Would you like to **configure them yourself?**
- **Pick one and put it to your `phpstan.neon` manually**.
- Configure it to your specific needs and re-run PHPStan. It's easier to be responsible, when you're in control.
- Configure it to your specific needs and re-run PHPStan.

E.g. `ForbiddenNodeRule`:

Expand All @@ -80,16 +77,6 @@ services:
- PhpParser\Node\Expr\ErrorSuppress
```

You'll find them all in [rules overview](docs/rules_overview.md).

Happy coding!

<br>

## Report Issues

In case you are experiencing a bug or want to request a new feature head over to the [Symplify monorepo issue tracker](https://github.com/symplify/symplify/issues)

## Contribute

The sources of this package are contained in the Symplify monorepo. We welcome contributions for this package on [symplify/symplify](https://github.com/symplify/symplify).
Happy coding!

0 comments on commit 5f1c0ac

Please sign in to comment.