Enhancement: Use baseline feature to run phpstan with and without ext…

…ension

.gitattributes

@@ -1,11 +1,14 @@
-.docker/        export-ignore
-.github/        export-ignore
-test/           export-ignore
-.editorconfig   export-ignore
-.gitattributes  export-ignore
-.gitignore      export-ignore
-.php_cs         export-ignore
-composer.lock   export-ignore
-Makefile        export-ignore
-phpstan.neon    export-ignore
-phpunit.xml     export-ignore
+.docker/                                export-ignore
+.github/                                export-ignore
+test/                                   export-ignore
+.editorconfig                           export-ignore
+.gitattributes                          export-ignore
+.gitignore                              export-ignore
+.php_cs                                 export-ignore
+composer.lock                           export-ignore
+Makefile                                export-ignore
+phpstan-with-extension-baseline.neon    export-ignore
+phpstan-with-extension.neon             export-ignore
+phpstan-without-extension-baseline.neon export-ignore
+phpstan-without-extension.neon          export-ignore
+phpunit.xml                             export-ignore

.github/CONTRIBUTING.md

@@ -28,6 +28,16 @@ $ make static-code-analysis
 
 to run a static code analysis.
 
+We are also using the baseline feature of [`phpstan/phpstan`](https://medium.com/@ondrejmirtes/phpstans-baseline-feature-lets-you-hold-new-code-to-a-higher-standard-e77d815a5dff).
+
+Run
+
+```
+$ make static-code-analysis-baseline
+```
+
+to regenerate the baselines in [`../phpstan-with-extension-baseline.neon`](../phpstan-with-extension-baseline.neon) and [`../phpstan-without-extension-baseline.neon`](../phpstan-without-extension-baseline.neon).
+
 ## Tests
 
 We are using [`phpunit/phpunit`](https://github.com/sebastianbergmann/phpunit) to drive the development.

.github/workflows/continuous-integration.yml

@@ -115,8 +115,11 @@ jobs:
       - name: "Create cache directory for phpstan/phpstan"
         run: "mkdir -p .build/phpstan"
 
-      - name: "Run phpstan/phpstan"
-        run: "vendor/bin/phpstan analyse --configuration=phpstan.neon"
+      - name: "Run phpstan/phpstan with extension"
+        run: "vendor/bin/phpstan analyse --configuration=phpstan-with-extension.neon"
+
+      - name: "Run phpstan/phpstan without extension"
+        run: "vendor/bin/phpstan analyse --configuration=phpstan-without-extension.neon"
 
   tests:
     name: "Tests"

Makefile

@@ -13,7 +13,15 @@ help: ## Displays this list of targets with descriptions
 .PHONY: static-code-analysis
 static-code-analysis: vendor ## Runs a static code analysis with phpstan/phpstan
 	mkdir -p .build/phpstan
-	vendor/bin/phpstan analyse --configuration=phpstan.neon
+	vendor/bin/phpstan analyse --configuration=phpstan-with-extension.neon
+	vendor/bin/phpstan analyse --configuration=phpstan-without-extension.neon
+
+.PHONY: static-code-analysis-baseline
+static-code-analysis-baseline: vendor ## Generates a baseline for static code analysis with phpstan/phpstan
+	echo '' > phpstan-with-extension-baseline.neon
+	vendor/bin/phpstan analyze --configuration=phpstan-with-extension.neon --error-format=baselineNeon > phpstan-with-extension-baseline.neon || true
+	echo '' > phpstan-without-extension-baseline.neon
+	vendor/bin/phpstan analyze --configuration=phpstan-without-extension.neon --error-format=baselineNeon > phpstan-without-extension-baseline.neon || true
 
 .PHONY: tests
 tests: vendor ## Runs tests with phpunit/phpunit

phpstan-with-extension-baseline.neon

@@ -0,0 +1,32 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Property JanGregor\\\\Prophecy\\\\Test\\\\StaticAnalysis\\\\Test\\\\ObjectProphecy\\\\ProphesizeTest\\:\\:\\$prophecy has no typehint specified\\.$#"
+			count: 1
+			path: test/StaticAnalysis/Test/ObjectProphecy/ProphesizeTest.php
+
+		-
+			message: "#^Method JanGregor\\\\Prophecy\\\\Test\\\\StaticAnalysis\\\\Test\\\\ObjectProphecy\\\\ProphesizeTest\\:\\:createProphecy\\(\\) has no return typehint specified\\.$#"
+			count: 1
+			path: test/StaticAnalysis/Test/ObjectProphecy/ProphesizeTest.php
+
+		-
+			message: "#^Property JanGregor\\\\Prophecy\\\\Test\\\\StaticAnalysis\\\\Test\\\\ObjectProphecy\\\\WillExtendTest\\:\\:\\$prophecy has no typehint specified\\.$#"
+			count: 1
+			path: test/StaticAnalysis/Test/ObjectProphecy/WillExtendTest.php
+
+		-
+			message: "#^Method JanGregor\\\\Prophecy\\\\Test\\\\StaticAnalysis\\\\Test\\\\ObjectProphecy\\\\WillExtendTest\\:\\:createProphecy\\(\\) has no return typehint specified\\.$#"
+			count: 1
+			path: test/StaticAnalysis/Test/ObjectProphecy/WillExtendTest.php
+
+		-
+			message: "#^Property JanGregor\\\\Prophecy\\\\Test\\\\StaticAnalysis\\\\Test\\\\ObjectProphecy\\\\WillImplementTest\\:\\:\\$prophecy has no typehint specified\\.$#"
+			count: 1
+			path: test/StaticAnalysis/Test/ObjectProphecy/WillImplementTest.php
+
+		-
+			message: "#^Method JanGregor\\\\Prophecy\\\\Test\\\\StaticAnalysis\\\\Test\\\\ObjectProphecy\\\\WillImplementTest\\:\\:createProphecy\\(\\) has no return typehint specified\\.$#"
+			count: 1
+			path: test/StaticAnalysis/Test/ObjectProphecy/WillImplementTest.php
+

phpstan-with-extension.neon

@@ -0,0 +1,11 @@
+includes:
+	- extension.neon
+	- phpstan-with-extension-baseline.neon
+
+parameters:
+	inferPrivatePropertyTypeFromConstructor: true
+	level: max
+	paths:
+		- src/
+		- test/
+	tmpDir: .build/phpstan

phpstan-without-extension-baseline.neon

@@ -0,0 +1,97 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Call to an undefined method Prophecy\\\\Prophecy\\\\ObjectProphecy\\:\\:bar\\(\\)\\.$#"
+			count: 1
+			path: test/StaticAnalysis/Test/BaseModelTest.php
+
+		-
+			message: "#^Parameter \\#1 \\$bar of method JanGregor\\\\Prophecy\\\\Test\\\\StaticAnalysis\\\\Src\\\\BaseModel\\:\\:bar\\(\\) expects JanGregor\\\\Prophecy\\\\Test\\\\StaticAnalysis\\\\Src\\\\Bar, object given\\.$#"
+			count: 1
+			path: test/StaticAnalysis/Test/BaseModelTest.php
+
+		-
+			message: "#^Call to an undefined method Prophecy\\\\Prophecy\\\\ObjectProphecy\\:\\:baz\\(\\)\\.$#"
+			count: 1
+			path: test/StaticAnalysis/Test/BaseModelTest.php
+
+		-
+			message: "#^Parameter \\#1 \\$baz of method JanGregor\\\\Prophecy\\\\Test\\\\StaticAnalysis\\\\Src\\\\BaseModel\\:\\:baz\\(\\) expects JanGregor\\\\Prophecy\\\\Test\\\\StaticAnalysis\\\\Src\\\\Baz, object given\\.$#"
+			count: 1
+			path: test/StaticAnalysis/Test/BaseModelTest.php
+
+		-
+			message: "#^Property JanGregor\\\\Prophecy\\\\Test\\\\StaticAnalysis\\\\Test\\\\ObjectProphecy\\\\ProphesizeTest\\:\\:\\$prophecy has no typehint specified\\.$#"
+			count: 1
+			path: test/StaticAnalysis/Test/ObjectProphecy/ProphesizeTest.php
+
+		-
+			message: "#^Call to an undefined method Prophecy\\\\Prophecy\\\\ObjectProphecy\\:\\:getFoo\\(\\)\\.$#"
+			count: 1
+			path: test/StaticAnalysis/Test/ObjectProphecy/ProphesizeTest.php
+
+		-
+			message: "#^Call to an undefined method Prophecy\\\\Prophecy\\\\ObjectProphecy\\:\\:doubleTheNumber\\(\\)\\.$#"
+			count: 1
+			path: test/StaticAnalysis/Test/ObjectProphecy/ProphesizeTest.php
+
+		-
+			message: "#^Call to an undefined method object\\:\\:getFoo\\(\\)\\.$#"
+			count: 1
+			path: test/StaticAnalysis/Test/ObjectProphecy/ProphesizeTest.php
+
+		-
+			message: "#^Call to an undefined method object\\:\\:doubleTheNumber\\(\\)\\.$#"
+			count: 1
+			path: test/StaticAnalysis/Test/ObjectProphecy/ProphesizeTest.php
+
+		-
+			message: "#^Method JanGregor\\\\Prophecy\\\\Test\\\\StaticAnalysis\\\\Test\\\\ObjectProphecy\\\\ProphesizeTest\\:\\:createProphecy\\(\\) has no return typehint specified\\.$#"
+			count: 1
+			path: test/StaticAnalysis/Test/ObjectProphecy/ProphesizeTest.php
+
+		-
+			message: "#^Property JanGregor\\\\Prophecy\\\\Test\\\\StaticAnalysis\\\\Test\\\\ObjectProphecy\\\\WillExtendTest\\:\\:\\$prophecy has no typehint specified\\.$#"
+			count: 1
+			path: test/StaticAnalysis/Test/ObjectProphecy/WillExtendTest.php
+
+		-
+			message: "#^Call to an undefined method Prophecy\\\\Prophecy\\\\ObjectProphecy\\:\\:baz\\(\\)\\.$#"
+			count: 1
+			path: test/StaticAnalysis/Test/ObjectProphecy/WillExtendTest.php
+
+		-
+			message: "#^Parameter \\#1 \\$baz of method JanGregor\\\\Prophecy\\\\Test\\\\StaticAnalysis\\\\Src\\\\BaseModel\\:\\:baz\\(\\) expects JanGregor\\\\Prophecy\\\\Test\\\\StaticAnalysis\\\\Src\\\\Baz, object given\\.$#"
+			count: 1
+			path: test/StaticAnalysis/Test/ObjectProphecy/WillExtendTest.php
+
+		-
+			message: "#^Method JanGregor\\\\Prophecy\\\\Test\\\\StaticAnalysis\\\\Test\\\\ObjectProphecy\\\\WillExtendTest\\:\\:createProphecy\\(\\) has no return typehint specified\\.$#"
+			count: 1
+			path: test/StaticAnalysis/Test/ObjectProphecy/WillExtendTest.php
+
+		-
+			message: "#^Property JanGregor\\\\Prophecy\\\\Test\\\\StaticAnalysis\\\\Test\\\\ObjectProphecy\\\\WillImplementTest\\:\\:\\$prophecy has no typehint specified\\.$#"
+			count: 1
+			path: test/StaticAnalysis/Test/ObjectProphecy/WillImplementTest.php
+
+		-
+			message: "#^Call to an undefined method Prophecy\\\\Prophecy\\\\ObjectProphecy\\:\\:bar\\(\\)\\.$#"
+			count: 1
+			path: test/StaticAnalysis/Test/ObjectProphecy/WillImplementTest.php
+
+		-
+			message: "#^Parameter \\#1 \\$bar of method JanGregor\\\\Prophecy\\\\Test\\\\StaticAnalysis\\\\Src\\\\BaseModel\\:\\:bar\\(\\) expects JanGregor\\\\Prophecy\\\\Test\\\\StaticAnalysis\\\\Src\\\\Bar, object given\\.$#"
+			count: 1
+			path: test/StaticAnalysis/Test/ObjectProphecy/WillImplementTest.php
+
+		-
+			message: "#^Method JanGregor\\\\Prophecy\\\\Test\\\\StaticAnalysis\\\\Test\\\\ObjectProphecy\\\\WillImplementTest\\:\\:createProphecy\\(\\) has no return typehint specified\\.$#"
+			count: 1
+			path: test/StaticAnalysis/Test/ObjectProphecy/WillImplementTest.php
+
+		-
+			message: "#^Parameter \\#1 \\$declaringClass of class JanGregor\\\\Prophecy\\\\Reflection\\\\ObjectProphecyMethodReflection constructor expects PHPStan\\\\Reflection\\\\ClassReflection, object given\\.$#"
+			count: 2
+			path: test/Unit/Reflection/ObjectProphecyMethodReflectionTest.php
+

phpstan-without-extension.neon

@@ -0,0 +1,10 @@
+includes:
+	- phpstan-without-extension-baseline.neon
+
+parameters:
+	inferPrivatePropertyTypeFromConstructor: true
+	level: max
+	paths:
+		- src/
+		- test/
+	tmpDir: .build/phpstan