Skip to content

Introduce Phpstan #456

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
Jun 11, 2024
Merged

Introduce Phpstan #456

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
f3089c6
Add phpstan
Prometee Jun 11, 2024
4839695
Remove duplicate
Prometee Jun 11, 2024
4586a3c
Remove not needed anymore exclusion
Prometee Jun 11, 2024
1937753
Add PHPStan config and ci
Prometee Jun 11, 2024
1e23c10
Switch to static analysis and add phpstan symfony req
Prometee Jun 11, 2024
6d986f9
Level set to 1 and baseline regenerated
Prometee Jun 11, 2024
e73d20e
Split tests
Prometee Jun 11, 2024
eb40e72
Remove reportUnmatchedIgnoredErrors (not needed here)
Prometee Jun 11, 2024
cfc3ae4
Rename action name
Prometee Jun 11, 2024
f9c3740
Add phpstan-symfony config
Prometee Jun 11, 2024
f0381b9
Update .github/workflows/coding-standards.yml
Prometee Jun 11, 2024
c76b1a3
Update .github/workflows/coding-standards.yml
Prometee Jun 11, 2024
89d3c7b
Remove unecessary plugin
Prometee Jun 11, 2024
7492cbe
Remove not accessible file imports
Prometee Jun 11, 2024
d850dac
Use PHPStan var to include baselines from plugins
Prometee Jun 11, 2024
5f03635
Increase PHPStan level to 2
Prometee Jun 11, 2024
9e3be05
Fix PHPDoc @var to @type
Prometee Jun 11, 2024
c1e4e35
Use array key typing instead of @var notation
Prometee Jun 11, 2024
3eeb7f1
Fix spaces
Prometee Jun 11, 2024
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
24 changes: 24 additions & 0 deletions .github/workflows/coding-standards.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: "Static analysis"

on:
push:
branches:
- '[0-9]+.x'
- '[0-9]+.[0-9]+'
- '[0-9]+.[0-9]+.x'
pull_request:

jobs:
phpstan:
name: "PHPStan"
runs-on: "ubuntu-latest"

steps:
- name: "Checkout"
uses: "actions/checkout@v3"
- name: PHPStan
uses: "docker://oskarstark/phpstan-ga"
env:
REQUIRE_DEV: true
with:
args: analyze --no-progress
6 changes: 3 additions & 3 deletions .github/workflows/static-analysis.yml → .github/workflows/php-cs-fixer.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: "Static analysis"
name: "PHP-CS-Fixer"

on:
push:
Expand All @@ -9,8 +9,8 @@ on:
pull_request:

jobs:
coding-standards:
name: "Coding Standards"
php-cs-fixer:
name: "PHP-CS-Fixer"
runs-on: "ubuntu-latest"

steps:
Expand Down
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@
/build/
/composer.lock
/phpspec.yml
/phpstan.neon
/phpunit.xml
/vendor/
11 changes: 4 additions & 7 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,11 @@
},
"conflict": {
"php-http/guzzle6-adapter": "<1.1",
"php-http/cache-plugin": "<1.7.0",
"php-http/cache-plugin": "<1.7",
"php-http/curl-client": "<2.0",
"php-http/socket-client": "<2.0",
"kriswallsmith/buzz": "<0.17",
"php-http/react-adapter": "<3.0",
"php-http/cache-plugin": "<1.7"
"php-http/react-adapter": "<3.0"
},
"require-dev": {
"guzzlehttp/psr7": "^1.7 || ^2.0",
Expand All @@ -58,6 +57,7 @@
"php-http/cache-plugin": "^1.7",
"php-http/mock-client": "^1.2",
"php-http/promise": "^1.0",
"phpstan/phpstan-symfony": "^1.2",
"symfony/browser-kit": "^5.4 || ^6.0 || ^7.0",
"symfony/cache": "^5.4 || ^6.0 || ^7.0",
"symfony/dom-crawler": "^5.4 || ^6.0 || ^7.0",
Expand All @@ -84,10 +84,7 @@
"autoload": {
"psr-4": {
"Http\\HttplugBundle\\": "src/"
},
"exclude-from-classmap": [
"/Tests/Resources/MyPsr18TestClient.php"
]
}
},
"autoload-dev": {
"psr-4": {
Expand Down
31 changes: 31 additions & 0 deletions phpstan-baseline.neon
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
parameters:
ignoreErrors:
-
message: "#^Call to static method create\\(\\) on an unknown class Symfony\\\\Component\\\\HttpClient\\\\HttpClient\\.$#"
count: 1
path: src/ClientFactory/SymfonyFactory.php
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i guess this means we don't test the factory, otherwise we would depend on the symfony http client.

we should probably add that, but in a separate merge request. and its no blocker for releasing 2.0


-
message: "#^Class Http\\\\Client\\\\Plugin\\\\Vcr\\\\NamingStrategy\\\\NamingStrategyInterface not found\\.$#"
count: 1
path: src/DependencyInjection/Configuration.php
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does the code properly handle a missing vcr plugin? if it does its okay i guess.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we could composer require the vcr plugin in a first step of the phpstan job, to have it validate correctly. the php tests would discover if we messed up with validation.

some nice to haves would be to have the configuration class error when configuring without vcr without having the plugin installed, and https://github.com/php-http/HttplugBundle/blob/b7ad2c1951edec36ef0bd9897e309b0038c59a54/src/DependencyInjection/HttplugExtension.php should throw an exception at the beginning of the method if vcr is not available.

but probably this still not enough to make phpstan happy, so composer require step for this could be added. that means that phpstan locally would complain about those though 🤔

we can also merge the current state and continue in separate pull requests.


-
message: "#^Class Http\\\\Client\\\\Plugin\\\\Vcr\\\\Recorder\\\\PlayerInterface not found\\.$#"
count: 1
path: src/DependencyInjection/Configuration.php

-
message: "#^Class Http\\\\Client\\\\Plugin\\\\Vcr\\\\Recorder\\\\RecorderInterface not found\\.$#"
count: 1
path: src/DependencyInjection/Configuration.php

-
message: "#^Class Http\\\\Client\\\\Plugin\\\\Vcr\\\\RecordPlugin not found\\.$#"
count: 1
path: src/DependencyInjection/HttplugExtension.php

-
message: "#^Class Http\\\\Client\\\\Plugin\\\\Vcr\\\\ReplayPlugin not found\\.$#"
count: 1
path: src/DependencyInjection/HttplugExtension.php
12 changes: 12 additions & 0 deletions phpstan.neon.dist
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
includes:
- phpstan-baseline.neon
- vendor/phpstan/phpstan-symfony/extension.neon
- vendor/phpstan/phpstan-symfony/rules.neon

parameters:
scanFiles:
- vendor/symfony/dependency-injection/Loader/Configurator/ContainerConfigurator.php

level: 1
paths:
- src
Loading