Merge pull request #72 from sasezaki/default-rule-enables

Change default enable rules

Author: sasezaki

README.md

@@ -11,11 +11,11 @@
 * [PSR-3 Meta Document](https://www.php-fig.org/psr/psr-3/meta/)
 
 > [!IMPORTANT]
-> It is planned to change default rule settings.
+> Since `0.20.0`, changed 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`
+* MessageStaticStringRule is enabled by default.
+* ContextRequireExceptionKeyRule is disabled by default.
+* [Recommendation] write these parameters to your project's `phpstan.neon`.
 
 ```neon
 parameters:
@@ -182,19 +182,16 @@ Then, `debug`| `info` | `notice` LogLevel  is ignored for report.
 }
 ```
 
-* If you want to disable this rule, please add `enableContextRequireExceptionKeyRule` as false.
+* If you want to enable this rule, please add `enableContextRequireExceptionKeyRule` as true.
 
 ```neon
 parameters:
     sfpPsrLog:
-        enableContextRequireExceptionKeyRule: false
+        enableContextRequireExceptionKeyRule: true
 ```
 
 ### MessageStaticStringRule
 
-> [!IMPORTANT]
-> This Rule is currently experimental.
-
 | :pushpin: _error identifier_ |
 | --- |
 | sfp-psr-log.messageNotStaticString |
@@ -208,12 +205,12 @@ $logger->info(sprintf('Message contains %s variable', $var));
 
 #### Configuration
 
-* If you want to enable this rule, please add `enableMessageStaticStringRule` as true.
+* If you want to disable this rule, please add `enableMessageStaticStringRule` as false.
 
 ```neon
 parameters:
     sfpPsrLog:
-        enableMessageStaticStringRule: true
+        enableMessageStaticStringRule: false
 ```
 
 ## Installation

example/phpstan.neon

@@ -13,7 +13,7 @@ parameters:
 	paths:
 		- %currentWorkingDirectory%/example/src
 	sfpPsrLog:
-		# enableContextRequireExceptionKeyRule: true
+		enableContextRequireExceptionKeyRule: true
 		enableMessageStaticStringRule: true
 		reportContextExceptionLogLevel: 'notice'
 		contextKeyOriginalPattern: '#\A[A-Za-z0-9-]+\z#'

rules.neon

@@ -8,8 +8,8 @@ parametersSchema:
 
 parameters:
 	sfpPsrLog:
-		enableContextRequireExceptionKeyRule: true
-		enableMessageStaticStringRule: false
+		enableContextRequireExceptionKeyRule: false
+		enableMessageStaticStringRule: true
 		reportContextExceptionLogLevel: 'debug'
 		contextKeyOriginalPattern: null