Trim strings and bump reflection docblock (#1721)

* Update version restraint * UPdate snapshots * update strings
2026-08-17 17:47:13 +00:00 · 2025-07-17 08:20:10 +02:00
parent fafe264b3c
commit 877f5ed0a7
45 changed files with 14 additions and 130 deletions
@@ -23,7 +23,7 @@
    "require": {
        "php": "^8.2",
        "ext-json": "*",
-        "barryvdh/reflection-docblock": "^2.3",
+        "barryvdh/reflection-docblock": "^2.4",
        "composer/class-map-generator": "^1.0",
        "illuminate/console": "^11.15 || ^12",
        "illuminate/database": "^11.15 || ^12",
@@ -13,8 +13,6 @@ use Illuminate\Database\Eloquent\Casts\AsEnumCollection;
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @property \Illuminate\Support\Carbon $cast_to_date_serialization
 * @property \Illuminate\Support\Carbon $cast_to_datetime_serialization
 * @property \Illuminate\Support\Carbon $cast_to_custom_datetime
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AllowGlobDirecto
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @property int $id
 * @property string|null $char_nullable
 * @property string $char_not_nullable
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ArrayCastsWithCo
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @property array<int, string>|null $cast_to_array -- These three should not be duplicated
 * @property array<int, string> $cast_to_json some-description
 * @property \Illuminate\Support\Collection<int, string> $cast_to_collection some-description
@@ -8,8 +8,6 @@ use Illuminate\Database\Eloquent\Casts\Attribute;
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @property int $id
 * @property string|null $name
 * @property string|null $name_read
@@ -85,8 +83,6 @@ use Illuminate\Database\Eloquent\Casts\Attribute;
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @property int $id
 * @property int $diverging_type_hinted_get_and_set
 * @property string|null $name
@@ -10,8 +10,6 @@ use Illuminate\Database\Eloquent\Relations\HasOne;
 use Illuminate\Database\Eloquent\Relations\MorphTo;

 /**
- * 
- *
 * @property int $id
 * @property string $both_same_name I'm a getter
 * @property string $both_without_getter_comment
@@ -9,8 +9,6 @@ use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\HasMany;

 /**
- * 
- *
 * @property int $id
 * @property-read SimpleCollection<int, Simple> $relationHasMany
 * @property-read int|null $relation_has_many_count
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomDate\Model
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @property \Carbon\CarbonImmutable|null $created_at
 * @property \Carbon\CarbonImmutable|null $updated_at
 * @method static \Illuminate\Database\Eloquent\Builder<static>|CustomDate newModelQuery()
@@ -13,8 +13,6 @@

 namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DoesNotGeneratePhpdocWithExternalEloquentBuilder\Models{
 /**
- * 
- *
 * @property int $id
 * @property string|null $char_nullable
 * @property string $char_not_nullable
@@ -10,8 +10,6 @@ use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Eloquent\Relations\HasOne;

 /**
- * 
- *
 * @property-read \Illuminate\Database\Eloquent\Collection<int, Dynamic> $regularHasMany
 * @property-read int|null $regular_has_many_count
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Dynamic newModelQuery()
@@ -9,8 +9,6 @@ use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @method static \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\CustomSpace\ModelWithCustomNamespaceFactory factory($count = null, $state = [])
 * @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithCustomNamespace newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithCustomNamespace newQuery()
@@ -41,8 +39,6 @@ use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @method static \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Factories\ModelWithFactoryFactory factory($count = null, $state = [])
 * @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithFactory newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithFactory newQuery()
@@ -60,8 +56,6 @@ declare(strict_types=1);
 namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models;

 /**
- * 
- *
 * @method static \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Factories\ModelWithNestedFactoryFactory factory($count = null, $state = [])
 * @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithNestedFactory newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithNestedFactory newQuery()
@@ -81,8 +75,6 @@ use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithoutFactory newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithoutFactory newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithoutFactory query()
@@ -9,8 +9,6 @@ use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @property int $id
 * @property string|null $char_nullable
 * @property string $char_not_nullable
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhp
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @property int $id
 * @property string|null $char_nullable
 * @property string $char_not_nullable
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhp
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @property int $id
 * @property string|null $charNullable
 * @property string $charNotNullable
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhp
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @property int $id
 * @property string|null $char_nullable
 * @property string $char_not_nullable
@@ -67,8 +67,6 @@ class WithCollection extends Model

 namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\Models{
 /**
- * 
- *
 * @property-read \Illuminate\Support\Collection<int, string> $collection
 * @property-read \Illuminate\Support\Collection<\Illuminate\Support\Collection, \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\NonModels\CollectionModel<\Illuminate\Support\Collection, \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\NonModels\CollectionModel<int, \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\NonModels\NonModel>>> $collection_with_nested_template
 * @property-read \Illuminate\Support\Collection<int, \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\NonModels\NonModel> $collection_with_non_model_template
@@ -8,8 +8,6 @@ use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @method static Builder<static>|Comment newModelQuery()
 * @method static Builder<static>|Comment newQuery()
 * @method static Builder<static>|Comment query()
@@ -13,8 +13,6 @@

 namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithExternalEloquentBuilder\Models{
 /**
- * 
- *
 * @property int $id
 * @property string|null $char_nullable
 * @property string $char_not_nullable
@@ -8,8 +8,6 @@ use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithExte
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @property int $id
 * @property string|null $char_nullable
 * @property string $char_not_nullable
@@ -9,8 +9,6 @@ use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Eloquent\SoftDeletes;

 /**
- * 
- *
 * @property int $id
 * @property string|null $char_nullable
 * @property string $char_not_nullable
@@ -15,8 +15,6 @@ use Illuminate\Database\Query\Builder as QueryBuilder;
 use Illuminate\Support\Carbon;

 /**
- * 
- *
 * @property int $id
 * @property string|null $char_nullable
 * @property CastType $char_not_nullable
@@ -13,8 +13,6 @@

 namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithFqnInExternalFile\Models{
 /**
- * 
- *
 * @property int $id
 * @property string|null $char_nullable
 * @property string $char_not_nullable
@@ -45,8 +45,6 @@ class Post extends Model

 namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithMixin\Models{
 /**
- * 
- *
 * @property $someProp
 * @method someMethod(string $method)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|FinalPost newModelQuery()
@@ -60,8 +58,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWi

 namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithMixin\Models{
 /**
- * 
- *
 * @property $someProp
 * @method someMethod(string $method)
 * @property int $id
@@ -9,8 +9,6 @@ use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Database\Eloquent\Relations\HasMany;

 /**
- * 
- *
 * @property int $id
 * @property-read \Illuminate\Database\Eloquent\Collection|Simple[] $regularBelongsToMany
 * @property-read int|null $regular_belongs_to_many_count
@@ -8,8 +8,6 @@ use DateTime;
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @property int $id
 * @property-read int|null $attribute_return_type_int_or_null
 * @property-read array $attribute_returns_array
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Ignored\Models;
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @method static \Illuminate\Database\Eloquent\Builder<static>|NotIgnored newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|NotIgnored newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|NotIgnored query()
@@ -13,8 +13,6 @@

 namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Interfaces\Models{
 /**
- * 
- *
 * @method static \Illuminate\Database\Eloquent\Builder<static>|User newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|User newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|User query()
@@ -24,8 +24,6 @@ use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Cas
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @property \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CastedProperty $casted_property_with_return_type
 * @property \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CastedProperty $casted_property_with_return_docblock
 * @property \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CastedProperty $casted_property_with_return_docblock_fqn
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\MagicWhere\Model
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @property int $id
 * @property string|null $char_nullable
 * @property string $char_not_nullable
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks\Model
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @property int $id
 * @property-read string $custom
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Simple custom($custom)
@@ -8,8 +8,6 @@ use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\MorphTo;

 /**
- * 
- *
 * @property string $relation_morph_to_type
 * @property int $relation_morph_to_id
 * @property string|null $nullable_relation_morph_to_type
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\PHPStormNoInspec
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @property int $id
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newQuery()
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\PHPStormNoInspec
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @property int $id
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newQuery()
@@ -9,8 +9,6 @@ use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Pivot\Models\Pivots\Di
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @property-read DifferentCustomPivot|CustomPivot|null $pivot
 * @property-read \Illuminate\Database\Eloquent\Collection<int, ModelWithPivot> $relationCustomPivotUsingSameAccessor
 * @property-read int|null $relation_custom_pivot_using_same_accessor_count
@@ -75,8 +73,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Pivot\Models\Piv
 use Illuminate\Database\Eloquent\Relations\Pivot;

 /**
- * 
- *
 * @method static \Illuminate\Database\Eloquent\Builder<static>|CustomPivot newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|CustomPivot newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|CustomPivot query()
@@ -94,8 +90,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Pivot\Models\Piv
 use Illuminate\Database\Eloquent\Relations\Pivot;

 /**
- * 
- *
 * @method static \Illuminate\Database\Eloquent\Builder<static>|DifferentCustomPivot newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|DifferentCustomPivot newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|DifferentCustomPivot query()
@@ -9,8 +9,6 @@ use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @method static Builder<static>|Comment local() Scope using the 'Scope' attribute
 * @method static Builder<static>|Comment newModelQuery()
 * @method static Builder<static>|Comment newQuery()
@@ -48,8 +46,6 @@ declare(strict_types=1);
 namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryScopes\Models;

 /**
- * 
- *
 * @property int $id
 * @property string|null $char_nullable
 * @property string $char_not_nullable
@@ -215,8 +211,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryScopes\Mode
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @method static \Illuminate\Database\Eloquent\Builder<static>|PostParent active()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|PostParent newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|PostParent newQuery()
@@ -8,8 +8,6 @@ use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\HasMany;

 /**
- * 
- *
 * @property int $id
 * @property string|null $char_nullable
 * @property string $char_not_nullable
@@ -8,8 +8,6 @@ use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;

 /**
- * 
- *
 * @property int $id
 * @property int $not_null_column_with_foreign_key_constraint
 * @property int $not_null_column_with_no_foreign_key_constraint
@@ -61,8 +59,6 @@ use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;

 /**
- * 
- *
 * @property int $id
 * @property int $not_null_column_with_foreign_key_constraint
 * @property int $not_null_column_with_no_foreign_key_constraint
@@ -132,8 +128,6 @@ use Illuminate\Database\Eloquent\Relations\MorphTo;
 use Illuminate\Database\Eloquent\Relations\MorphToMany;

 /**
- * 
- *
 * @property int $id
 * @property-read Simple $relationBelongsTo
 * @property-read AnotherModel $relationBelongsToInAnotherNamespace
@@ -8,8 +8,6 @@ use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;

 /**
- * 
- *
 * @property int $id
 * @property int $not_null_column_with_foreign_key_constraint
 * @property int $not_null_column_with_no_foreign_key_constraint
@@ -61,8 +59,6 @@ use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;

 /**
- * 
- *
 * @property int $id
 * @property int $not_null_column_with_foreign_key_constraint
 * @property int $not_null_column_with_no_foreign_key_constraint
@@ -132,8 +128,6 @@ use Illuminate\Database\Eloquent\Relations\MorphTo;
 use Illuminate\Database\Eloquent\Relations\MorphToMany;

 /**
- * 
- *
 * @property int $id
 * @property-read Simple|null $relationBelongsTo
 * @property-read AnotherModel|null $relationBelongsToInAnotherNamespace
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\SimpleCasts\Mode
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @property int $cast_to_int
 * @property int $cast_to_integer
 * @property float $cast_to_real
@@ -8,8 +8,6 @@ use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\SoftDeletes;

 /**
- * 
- *
 * @property int $id
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newQuery()
@@ -9,8 +9,6 @@ use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Query\Builder;

 /**
- * 
- *
 * @property-read string|int|null $foo
 * @property-read \Illuminate\Database\Eloquent\Collection<int, UnionTypeModel> $withUnionTypeReturn
 * @property-read int|null $with_union_type_return_count
@@ -8,8 +8,6 @@ use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;

 /**
- * 
- *
 * @property int $id
 * @method static Builder<static>|Simple newModelQuery()
 * @method static Builder<static>|Simple newQuery()
@@ -1,6 +1,4 @@
 /**
- * 
- *
 * @mixin \Eloquent
 * @mixin \Illuminate\Database\Eloquent\Builder
 * @mixin \Illuminate\Database\Query\Builder
@@ -242,13 +242,11 @@ class MacroTest extends TestCase
        $macro = new Macro($reflectionMethod, 'URL', new ReflectionClass(UrlGenerator::class), 'macroName');
        $output = <<<'DOC'
 /**
- * 
- *
 * @param string $foo
 * @param int $bar
- * @return string 
+ * @return string
 * @see \Barryvdh\LaravelIdeHelper\Tests\UrlGeneratorMacroClass::__invoke()
- * @static 
+ * @static
 */
 DOC;
        $this->assertSame($output, $macro->getDocComment(''));
@@ -36,12 +36,10 @@ class MethodTest extends TestCase

        $output = <<<'DOC'
 /**
- * 
- *
 * @param string $last
 * @param string $first
 * @param string $middle
- * @static 
+ * @static
 */
 DOC;
        $this->assertSame($output, $method->getDocComment(''));
@@ -71,8 +69,8 @@ DOC;
 * @param array $values
 * @param array|string $uniqueBy
 * @param array|null $update
- * @return int 
- * @static 
+ * @return int
+ * @static
 */
 DOC;
        $this->assertSame($output, $method->getDocComment(''));
@@ -104,8 +102,8 @@ DOC;
 * @param mixed $operator
 * @param mixed $value
 * @param string $boolean
- * @return \Illuminate\Database\Eloquent\Builder<static> 
- * @static 
+ * @return \Illuminate\Database\Eloquent\Builder<static>
+ * @static
 */
 DOC;
        $this->assertSame($output, $method->getDocComment(''));
@@ -134,8 +132,8 @@ DOC;
 * @param string|array|\Illuminate\Contracts\Database\Query\Expression $columns
 * @param string $boolean
 * @param bool $not
- * @return \Illuminate\Database\Eloquent\Builder<static> 
- * @static 
+ * @return \Illuminate\Database\Eloquent\Builder<static>
+ * @static
 */
 DOC;

@@ -177,10 +175,8 @@ DOC;

        $output = <<<'DOC'
 /**
- * 
- *
- * @return \Illuminate\Foundation\Application 
- * @static 
+ * @return \Illuminate\Foundation\Application
+ * @static
 */
 DOC;

@@ -208,8 +204,8 @@ DOC;
 * @template TValue
 * @param (\Closure(): TValue)|list<string> $columns
 * @param (\Closure(): TValue)|null $callback
- * @return TModel|TValue 
- * @static 
+ * @return TModel|TValue
+ * @static
 */
 DOC;
        $this->assertSame($output, $method->getDocComment(''));