Skip to content

Commit 89cdd09

Browse files
codemashercodemasher
committed
:octocat: switch phan for phpstan (see #277)
1 parent f65d9d2 commit 89cdd09

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+539
-217
lines changed

‎.gitattributes

+21-18
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
1-
/.build export-ignore
2-
/.github export-ignore
3-
/.idea export-ignore
4-
/.phan export-ignore
5-
/.phpdoc export-ignore
6-
/benchmark export-ignore
7-
/docs export-ignore
8-
/examples export-ignore
9-
/tests export-ignore
10-
/.editorconfig export-ignore
11-
/.gitattributes export-ignore
12-
/.gitignore export-ignore
13-
/.readthedocs.yml export-ignore
14-
/phpbench.json export-ignore
15-
/phpcs.xml.dist export-ignore
16-
/phpdoc.xml.dist export-ignore
17-
/phpmd.xml.dist export-ignore
18-
/phpunit.xml.dist export-ignore
1+
/.build export-ignore
2+
/.github export-ignore
3+
/.idea export-ignore
4+
/.phan export-ignore
5+
/.phpdoc export-ignore
6+
/benchmark export-ignore
7+
/docs export-ignore
8+
/examples export-ignore
9+
/tests export-ignore
10+
/.editorconfig export-ignore
11+
/.gitattributes export-ignore
12+
/.gitignore export-ignore
13+
/.readthedocs.yml export-ignore
14+
/composer.lock export-ignore
15+
/phpbench.json export-ignore
16+
/phpcs.xml.dist export-ignore
17+
/phpdoc.xml.dist export-ignore
18+
/phpmd.xml.dist export-ignore
19+
/phpunit.xml.dist export-ignore
20+
/phpstan.dist.neon export-ignore
21+
/phpstan-baseline.neon export-ignore
1922

2023
*.php diff=php

‎.github/workflows/ci.yml

+3-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ jobs:
4040
uses: shivammathur/setup-php@v2
4141
with:
4242
php-version: ${{ matrix.php-version }}
43-
extensions: ast, ${{ env.PHP_EXTENSIONS }}
43+
extensions: ${{ env.PHP_EXTENSIONS }}
4444
ini-values: ${{ env.PHP_INI_VALUES }}
4545
coverage: none
4646

@@ -49,6 +49,8 @@ jobs:
4949

5050
- name: "Run phan"
5151
run: php vendor/bin/phan --target-php-version=${{ matrix.php-version }}
52+
- name: "Run PHPStan"
53+
run: php vendor/bin/phpstan
5254

5355

5456
tests:

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,5 @@ phpcs.xml
1818
phpdoc.xml
1919
phpmd.xml
2020
phpunit.xml
21+
phpstan.neon
2122
tests/Performance/*.json

‎.phan/config.php

-60
This file was deleted.

‎.phan/stubs/misc.php

-9
This file was deleted.

‎composer.json

+5-3
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,10 @@
5555
"chillerlan/php-authenticator": "^5.2.1",
5656
"intervention/image": "^3.7",
5757
"phpbench/phpbench": "^1.2.15",
58-
"phan/phan": "^5.4",
5958
"phpunit/phpunit": "^11.2",
6059
"phpmd/phpmd": "^2.15",
60+
"phpstan/phpstan": "^1.11",
61+
"phpstan/phpstan-deprecation-rules": "^1.2",
6162
"setasign/fpdf": "^1.8.2",
6263
"squizlabs/php_codesniffer": "^3.10"
6364
},
@@ -79,13 +80,14 @@
7980
}
8081
},
8182
"scripts": {
82-
"phan": "@php vendor/bin/phan",
8383
"phpcs": "@php vendor/bin/phpcs",
8484
"phpbench":[
8585
"Composer\\Config::disableProcessTimeout",
8686
"@php vendor/bin/phpbench run"
8787
],
88-
"phpunit": "@php vendor/bin/phpunit"
88+
"phpunit": "@php vendor/bin/phpunit",
89+
"phpstan": "@php vendor/bin/phpstan",
90+
"phpstan-baseline": "@php vendor/bin/phpstan --generate-baseline"
8991
},
9092
"config": {
9193
"lock": false,

‎examples/imagickImageAsBackground.php

+2
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ protected function createImage():Imagick{
5656

5757
/**
5858
* augment the QROptions class
59+
*
60+
* @property string $background
5961
*/
6062
class ImageAsBackgroundOptions extends QROptions{
6163

‎examples/imagickWithLogo.php

+2
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@ public function dump(string|null $file = null):string{
6565

6666
/**
6767
* augment the QROptions class
68+
*
69+
* @property string $pngLogo
6870
*/
6971
class ImagickWithLogoOptions extends QROptions{
7072

‎examples/qrcode-interactive.php

+9-11
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,15 @@
1313

1414
require_once '../vendor/autoload.php';
1515

16+
/**
17+
* @param array<string, mixed> $response
18+
*/
19+
function sendResponse(array $response):never{
20+
header('Content-type: application/json;charset=utf-8;');
21+
echo json_encode($response);
22+
exit;
23+
}
24+
1625
try{
1726

1827
$moduleValues = [
@@ -89,14 +98,3 @@
8998
header('HTTP/1.1 500 Internal Server Error');
9099
sendResponse(['error' => $e->getMessage()]);
91100
}
92-
93-
exit;
94-
95-
/**
96-
* @param array $response
97-
*/
98-
function sendResponse(array $response){
99-
header('Content-type: application/json;charset=utf-8;');
100-
echo json_encode($response);
101-
exit;
102-
}

‎examples/svgMeltedModules.php

+4
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,10 @@ protected function lightModule(Closure $check, bool $invert):string{
217217

218218
/**
219219
* the augmented options class
220+
*
221+
* @property bool $melt
222+
* @property bool $inverseMelt
223+
* @property float $meltRadius
220224
*/
221225
class MeltedOutputOptions extends QROptions{
222226

‎examples/svgRandomColoredDots.php

+7-1
Original file line numberDiff line numberDiff line change
@@ -81,13 +81,19 @@ protected function collectModules(Closure $transform):array{
8181

8282
}
8383

84-
// the extended options with the $dotColors option
84+
85+
/**
86+
* the extended options with the $dotColors option
87+
*
88+
* @property array<int, string> $dotColors
89+
*/
8590
class RandomDotsOptions extends QROptions{
8691

8792
/**
8893
* a map of $M_TYPE_LAYER => color
8994
*
9095
* @see \array_rand()
96+
* @var array<int, string>
9197
*/
9298
protected array $dotColors = [];
9399

‎examples/svgRoundQuietzone.php

+7
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,12 @@ protected function collectModules(Closure $transform):array{
210210

211211
/**
212212
* the augmented options class
213+
*
214+
* @property int $additionalModules
215+
* @property array<int, string> $dotColors
216+
* @property string $svgLogo
217+
* @property float $svgLogoScale
218+
* @property string $svgLogoCssClass
213219
*/
214220
class RoundQuietzoneOptions extends QROptions{
215221

@@ -231,6 +237,7 @@ class RoundQuietzoneOptions extends QROptions{
231237
* a map of $M_TYPE_LAYER => color
232238
*
233239
* @see \array_rand()
240+
* @var array<int, string>
234241
*/
235242
protected array $dotColors = [];
236243

‎examples/svgWithLogo.php

+4
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,10 @@ protected function getLogo():string{
7272

7373
/**
7474
* augment the QROptions class
75+
*
76+
* @property string $svgLogo
77+
* @property float $svgLogoScale
78+
* @property string $svgLogoCssClass
7579
*/
7680
class SVGWithLogoOptions extends QROptions{
7781
// path to svg logo

‎examples/svgWithLogoAndCustomShapes.php

+4
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,10 @@ protected function getLogo():string{
130130

131131
/**
132132
* augment the QROptions class
133+
*
134+
* @property string $svgLogo
135+
* @property float $svgLogoScale
136+
* @property string $svgLogoCssClass
133137
*/
134138
class SVGWithLogoAndCustomShapesOptions extends QROptions{
135139
// path to svg logo

0 commit comments

Comments
 (0)