Skip to content

Declare type configs #184

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

Draft
wants to merge 21 commits into
base: main
Choose a base branch
from
+1,381 −17
Draft

Declare type configs #184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
4fe7576
deprecate the old type adding rules
peterfox Feb 22, 2024
0666467
Add automated type declarations configs
peterfox Feb 22, 2024
9bc9ec7
More type hinting goodness
peterfox Feb 27, 2024
eb552d1
Fix import and code styles
peterfox Mar 4, 2024
cb41eb3
Rector changes
peterfox Mar 4, 2024
ef18c2a
PHPStan fixes
peterfox Mar 4, 2024
d76da15
CS fixes
peterfox Mar 4, 2024
eca32c1
handle nested arrays
peterfox Mar 5, 2024
0e4f7b2
Sets up validation type
peterfox Mar 5, 2024
db397d7
Small fixes found
peterfox Mar 12, 2024
6d3bfec
Remove with as it's slightly problematic
peterfox Mar 13, 2024
0de1986
Refactor of the type system
peterfox May 7, 2024
7e300de
Document the set
peterfox May 7, 2024
37fd929
fixes
peterfox May 8, 2024
c4e286c
More fixes
peterfox May 9, 2024
0ea9c68
Update Sets
peterfox Sep 21, 2024
1681437
Adds more stubs
peterfox Sep 22, 2024
4d95960
Minor tweak
peterfox Sep 22, 2024
d003dd2
Test of arg rule
peterfox Sep 22, 2024
fb3b8a3
Fix PHPStan
peterfox Sep 22, 2024
b39d29f
cs fixes
peterfox Sep 22, 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
11 changes: 11 additions & 0 deletions config/sets/type-declaration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?php

use Rector\Config\RectorConfig;

return static function (RectorConfig $rectorConfig): void {
$rectorConfig->import(__DIR__ . '/../config.php');

$rectorConfig->import(__DIR__ . '/type-declaration/eloquent.php');
$rectorConfig->import(__DIR__ . '/type-declaration/service-container.php');
$rectorConfig->import(__DIR__ . '/type-declaration/validation.php');
};
151 changes: 151 additions & 0 deletions config/sets/type-declaration/eloquent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
<?php

use PHPStan\Type\ObjectType;
use PHPStan\Type\StringType;
use Rector\Config\RectorConfig;
use Rector\TypeDeclaration\Rector\FunctionLike\AddParamTypeForFunctionLikeWithinCallLikeArgDeclarationRector;
use Rector\TypeDeclaration\ValueObject\AddParamTypeForFunctionLikeWithinCallLikeArgDeclaration;
use RectorLaravel\Util\AddParamTypeForFunctionLikeWithinCallLikeArgDeclarationRectorConfigGenerator;

return static function (RectorConfig $rectorConfig): void {
$rectorConfig->import(__DIR__ . '/../../config.php');

$generator = new AddParamTypeForFunctionLikeWithinCallLikeArgDeclarationRectorConfigGenerator;

$builderClass = new ObjectType(
'Illuminate\Contracts\Database\Query\Builder'
);

/** @var class-string[] $classesToApplyTo */
$classesToApplyTo = [
'Illuminate\Database\Eloquent\Model',
'Illuminate\Contracts\Database\Query\Builder',
'Illuminate\Database\Query\Builder',
];

$basicRuleConfiguration = [
...$generator->generate(
[0, 1, 2, 'builder'],
$classesToApplyTo,
0,
'where',
$builderClass,
),
...$generator->generate(
[0, 'builder'],
$classesToApplyTo,
0,
'orWhere',
$builderClass,
),
...$generator->generate(
[0, 'builder'],
$classesToApplyTo,
0,
'whereNot',
$builderClass,
),
...$generator->generate(
[0, 'builder'],
$classesToApplyTo,
0,
'whereExists',
$builderClass,
),
...$generator->generate(
[1, 'builder'],
$classesToApplyTo,
0,
'whereHas',
$builderClass,
),
...$generator->generate(
[1, 'builder'],
$classesToApplyTo,
0,
'orWhereHas',
$builderClass,
),
...$generator->generate(
[1, 'builder'],
$classesToApplyTo,
0,
'whereDoesntHave',
$builderClass,
),
...$generator->generate(
[1, 'builder'],
$classesToApplyTo,
0,
'orWhereDoesntHave',
$builderClass,
),
...$generator->generate(
[1, 'builder'],
$classesToApplyTo,
0,
'withWhereHas',
$builderClass,
),
...$generator->generate(
[1, 2, 'builder'],
$classesToApplyTo,
0,
'when',
$builderClass,
),
...$generator->generate(
[2, 'builder'],
$classesToApplyTo,
0,
'whereHasMorph',
$builderClass,
),
...$generator->generate(
[2, 'builder'],
$classesToApplyTo,
0,
'orWhereHasMorph',
$builderClass,
),
...$generator->generate(
[2, 'builder'],
$classesToApplyTo,
0,
'whereDoesntHaveMorph',
$builderClass,
),
...$generator->generate(
[2, 'builder'],
$classesToApplyTo,
0,
'orWhereDoesntHaveMorph',
$builderClass,
),
];

$rectorConfig->ruleWithConfiguration(
AddParamTypeForFunctionLikeWithinCallLikeArgDeclarationRector::class,
$basicRuleConfiguration
);

$rectorConfig->ruleWithConfiguration(
AddParamTypeForFunctionLikeWithinCallLikeArgDeclarationRector::class,
[
new AddParamTypeForFunctionLikeWithinCallLikeArgDeclaration(
'Illuminate\Database\Eloquent\Model',
'handleLazyLoadingViolationUsing',
0,
0,
new ObjectType('Illuminate\Database\Eloquent\Model')
),
new AddParamTypeForFunctionLikeWithinCallLikeArgDeclaration(
'Illuminate\Database\Eloquent\Model',
'handleLazyLoadingViolationUsing',
0,
1,
new StringType,
),
]
);
};
74 changes: 74 additions & 0 deletions config/sets/type-declaration/service-container.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
<?php

use Rector\TypeDeclaration\Rector\FunctionLike\AddClosureParamTypeFromArgRector;
use Rector\TypeDeclaration\ValueObject\AddClosureParamTypeFromArg;
use PHPStan\Type\ObjectType;
use Rector\Config\RectorConfig;
use Rector\TypeDeclaration\Rector\FunctionLike\AddParamTypeForFunctionLikeWithinCallLikeArgDeclarationRector;
use Rector\TypeDeclaration\ValueObject\AddParamTypeForFunctionLikeWithinCallLikeArgDeclaration;

return static function (RectorConfig $rectorConfig): void {
$rectorConfig->import(__DIR__ . '/../../config.php');

$applicationClass = new ObjectType(
'Illuminate\Contracts\Foundation\Application'
);

$classesToApplyTo = [
'Illuminate\Support\Facades\App',
'Illuminate\Contracts\Foundation\Application',
];

$ruleConfiguration = [];

foreach ($classesToApplyTo as $classToApplyTo) {
foreach ([
'bind', 'bindIf', 'singleton', 'singletonIf', 'scoped', 'scopedIf',
] as $method) {
$ruleConfiguration[] = new AddParamTypeForFunctionLikeWithinCallLikeArgDeclaration(
$classToApplyTo,
$method,
1,
0,
$applicationClass,
);
}
$ruleConfiguration[] = new AddParamTypeForFunctionLikeWithinCallLikeArgDeclaration(
$classToApplyTo,
'resolving',
1,
1,
$applicationClass,
);
$ruleConfiguration[] = new AddParamTypeForFunctionLikeWithinCallLikeArgDeclaration(
$classToApplyTo,
'extends',
1,
1,
$applicationClass,
);
}

$rectorConfig->ruleWithConfiguration(
AddParamTypeForFunctionLikeWithinCallLikeArgDeclarationRector::class,
$ruleConfiguration
);

$rectorConfig->ruleWithConfiguration(
AddClosureParamTypeFromArgRector::class,
[
new AddClosureParamTypeFromArg(
'Illuminate\Support\Facades\App',
'extends',
1,
0,
),
new AddClosureParamTypeFromArg(
'Illuminate\Support\Facades\App',
'resolving',
1,
0,
),
]
);
};
154 changes: 154 additions & 0 deletions config/sets/type-declaration/validation.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
<?php

use PHPStan\Type\MixedType;
use PHPStan\Type\ObjectType;
use PHPStan\Type\StringType;
use Rector\Config\RectorConfig;
use Rector\TypeDeclaration\Rector\FunctionLike\AddParamTypeForFunctionLikeWithinCallLikeArgDeclarationRector;
use Rector\TypeDeclaration\ValueObject\AddParamTypeForFunctionLikeWithinCallLikeArgDeclaration;
use RectorLaravel\Rector\Param\AddParamTypeForFunctionLikeWithinCallLikeArgArrayValuesDeclarationRector;

return static function (RectorConfig $rectorConfig): void {
$rectorConfig->import(__DIR__ . '/../../config.php');

$targetClasses = [
'Illuminate\Support\Facades\Validator',
'Illuminate\Contracts\Validation\Factory',
];

foreach ($targetClasses as $targetClass) {
$rectorConfig->ruleWithConfiguration(
AddParamTypeForFunctionLikeWithinCallLikeArgArrayValuesDeclarationRector::class,
[
new AddParamTypeForFunctionLikeWithinCallLikeArgDeclaration(
$targetClass,
'make',
1,
0,
new StringType,
),
new AddParamTypeForFunctionLikeWithinCallLikeArgDeclaration(
$targetClass,
'make',
1,
1,
new MixedType(true),
),
new AddParamTypeForFunctionLikeWithinCallLikeArgDeclaration(
$targetClass,
'make',
1,
2,
new ObjectType('Closure'),
),
]
);
}

$rectorConfig->ruleWithConfiguration(
AddParamTypeForFunctionLikeWithinCallLikeArgArrayValuesDeclarationRector::class,
[
new AddParamTypeForFunctionLikeWithinCallLikeArgDeclaration(
'Illuminate\Http\Request',
'validate',
0,
0,
new StringType,
),
new AddParamTypeForFunctionLikeWithinCallLikeArgDeclaration(
'Illuminate\Http\Request',
'validate',
0,
1,
new MixedType(true),
),
new AddParamTypeForFunctionLikeWithinCallLikeArgDeclaration(
'Illuminate\Http\Request',
'validate',
0,
2,
new ObjectType('Closure'),
),
]
);

$rectorConfig->ruleWithConfiguration(
AddParamTypeForFunctionLikeWithinCallLikeArgDeclarationRector::class,
[
new AddParamTypeForFunctionLikeWithinCallLikeArgDeclaration(
'Illuminate\Contracts\Validation\Validator',
'after',
0,
0,
new ObjectType('Illuminate\Contracts\Validation\Validator'),
),
]
);

$rectorConfig->ruleWithConfiguration(
AddParamTypeForFunctionLikeWithinCallLikeArgDeclarationRector::class,
[
new AddParamTypeForFunctionLikeWithinCallLikeArgDeclaration(
'Illuminate\Contracts\Validation\Validator',
'sometimes',
2,
0,
new ObjectType('Illuminate\Support\Fluent'),
),
new AddParamTypeForFunctionLikeWithinCallLikeArgDeclaration(
'Illuminate\Contracts\Validation\Validator',
'sometimes',
2,
1,
new MixedType(true),
),
]
);

$rectorConfig->ruleWithConfiguration(
AddParamTypeForFunctionLikeWithinCallLikeArgDeclarationRector::class,
[
new AddParamTypeForFunctionLikeWithinCallLikeArgDeclaration(
'Illuminate\Validation\Rule',
'forEach',
0,
0,
new MixedType(true),
),
new AddParamTypeForFunctionLikeWithinCallLikeArgDeclaration(
'Illuminate\Validation\Rule',
'forEach',
0,
1,
new StringType,
),
]
);

$rectorConfig->ruleWithConfiguration(
AddParamTypeForFunctionLikeWithinCallLikeArgDeclarationRector::class,
[
new AddParamTypeForFunctionLikeWithinCallLikeArgDeclaration(
'Illuminate\Validation\Rules\Exists',
'where',
0,
0,
new ObjectType('Illuminate\Contracts\Database\Query\Builder'),
),
new AddParamTypeForFunctionLikeWithinCallLikeArgDeclaration(
'Illuminate\Validation\Rules\Exists',
'where',
1,
0,
new ObjectType('Illuminate\Contracts\Database\Query\Builder'),
),
new AddParamTypeForFunctionLikeWithinCallLikeArgDeclaration(
'Illuminate\Validation\Rules\Exists',
'using',
0,
0,
new ObjectType('Illuminate\Contracts\Database\Query\Builder'),
),
]
);
};
Loading
Loading