Skip to content

Commit

Permalink
Merge pull request #71 from sasezaki/notify-settings-readme
Browse files Browse the repository at this point in the history
Reconsider the default settings of the rules
  • Loading branch information
sasezaki authored Dec 8, 2023
2 parents 745e5aa + 67e7b0a commit 8276964
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,22 @@
* [PSR-3: Logger Interface - PHP-FIG](https://www.php-fig.org/psr/psr-3/)
* [PSR-3 Meta Document](https://www.php-fig.org/psr/psr-3/meta/)

> [!IMPORTANT]
> It is planned to change default rule settings.
* MessageStaticStringRule would be enabled by default.
* ContextRequireExceptionKeyRule would be disabled by default.
* [Recommendation] write these parameters to your project's `phpstan.neon`

```neon
parameters:
sfpPsrLog:
enableMessageStaticStringRule: true
enableContextRequireExceptionKeyRule: true
reportContextExceptionLogLevel: 'info'
contextKeyOriginalPattern: '#\A[A-Za-z0-9-_]+\z#'
```

## Stubs

This extension depends on our psr/log stub to serve strictness.
Expand Down

0 comments on commit 8276964

Please # to comment.