Add TLDR section, update options (#1639)

* Format IDE helper

* composer fix-style

* Format IDE helper

* composer fix-style

---------

Co-authored-by: laravel-ide-helper <[email protected]>

CHANGELOG.md

@@ -54,6 +54,7 @@
 - Fix type of hashed model property to `string`
 
 ### Changed
+- Update view "version" variable name to avoid potential conflicts
 
 - Add support for EloquentBuilder generics introduced in Laravel 11.15.
 - Drop support for Laravel versions earlier than 11.15.

README.md

@@ -33,42 +33,27 @@ Require this package with composer using the following command:
 composer require --dev barryvdh/laravel-ide-helper
 ```
 
-> [!NOTE]  
-> If you encounter version conflicts with doctrine/dbal, please try:
-> `composer require --dev barryvdh/laravel-ide-helper --with-all-dependencies`
- 
-This package makes use of [Laravels package auto-discovery mechanism](https://medium.com/@taylorotwell/package-auto-discovery-in-laravel-5-5-ea9e3ab20518), which means if you don't install dev dependencies in production, it also won't be loaded.
-
-If for some reason you want manually control this:
-- add the package to the `extra.laravel.dont-discover` key in `composer.json`, e.g.
-  ```json
-  "extra": {
-    "laravel": {
-      "dont-discover": [
-        "barryvdh/laravel-ide-helper"
-      ]
-    }
-  }
-  ```
-- Add the following class to the `providers` array in `config/app.php`:
-  ```php
-  Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class,
-  ```
-  If you want to manually load it only in non-production environments, instead you can add this to your `AppServiceProvider` with the `register()` method:
-  ```php
-  public function register()
-  {
-      if ($this->app->isLocal()) {
-          $this->app->register(\Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class);
-      }
-      // ...
-  }
-  ```
-
-> Note: Avoid caching the configuration in your development environment, it may cause issues after installing this package; respectively clear the cache beforehand via `php artisan cache:clear` if you encounter problems when running the commands
 
 ## Usage
 
+### TL;DR
+
+Run this to generate autocompletion for Facades. This creates _ide_helper.php
+
+```
+php artisan ide-helper:generate
+```
+
+Run this to add phpdocs for your models. Add -RW to Reset existing phpdocs and Write to the models directly.
+```
+php artisan ide-helper:models -RW
+```
+
+If you don't want the full _ide_helper.php file, you can run add `--write-eloquent-helper` to the model command to generate small version, which is required for the `@mixin \Eloquent` to be able to add the QueryBuilder methods.
+
+If you don't want to add all the phpdocs to your Models directly, you can use `--nowrite` to create a seperate file. The  `--write-mixin` option can be used to only add a `@mixin` to your models, but add the generated phpdocs in a seperate file. This avoids having the results marked as duplicate.
+
+
 _Check out [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!_
 
 - `php artisan ide-helper:generate` - [PHPDoc generation for Laravel Facades ](#automatic-phpdoc-generation-for-laravel-facades)
@@ -76,7 +61,7 @@ _Check out [this Laracasts video](https://laracasts.com/series/how-to-be-awesome
 - `php artisan ide-helper:meta` - [PhpStorm Meta file](#phpstorm-meta-for-container-instances)
 
 
-Note: You do need CodeComplice for Sublime Text: https://github.com/spectacles/CodeComplice
+> Note: You do need CodeComplice for Sublime Text: https://github.com/spectacles/CodeComplice
 
 ### Automatic PHPDoc generation for Laravel Facades
 
@@ -86,8 +71,6 @@ You can now re-generate the docs yourself (for future updates)
 php artisan ide-helper:generate
 ```
 
-Note: `bootstrap/compiled.php` has to be cleared first, so run `php artisan clear-compiled` before generating.
-
 This will generate the file `_ide_helper.php` which is expected to be additionally parsed by your IDE for autocomplete. You can use the config `filename` to change its name.
 
 You can configure your `composer.json` to do this each time you update your dependencies:
@@ -115,7 +98,7 @@ You can use an in-memory SQLite driver by adding the `-M` option.
 
 If you use [real-time facades](https://laravel.com/docs/master/facades#real-time-facades) in your app, those will also be included in the generated file using a `@mixin` annotation and extending the original class underneath the facade. 
 
-**Note**: this feature uses the generated real-time facades files in the `storage/framework/cache` folder. Those files are generated on-demand as you use the real-time facade, so if the framework has not generated that first, it will not be included in the helper file. Run the route/command/code first and then regenerate the helper file and this time the real-time facade will be included in it.
+> **Note**: this feature uses the generated real-time facades files in the `storage/framework/cache` folder. Those files are generated on-demand as you use the real-time facade, so if the framework has not generated that first, it will not be included in the helper file. Run the route/command/code first and then regenerate the helper file and this time the real-time facade will be included in it.
 
 You can choose to include helper files. This is not enabled by default, but you can override it with the `--helpers (-H)` option.
 The `Illuminate/Support/helpers.php` is already set up, but you can add/remove your own files in the config file.
@@ -149,6 +132,8 @@ The class name will be different from the model, avoiding the IDE duplicate anno
 
 > Please make sure to back up your models, before writing the info.
 
+> You need the _ide_helper.php file to add the QueryBuilder methods. You can add --write-eloquent-helper/-E to generate a minimal version. If this file does not exist, you will be prompted for it.
+
 Writing to the models should keep the existing comments and only append new properties/methods. It will not update changed properties/methods.
 
 With the `--reset (-R)` option, the whole existing PHPDoc is replaced, including any comments that have been made.
@@ -382,7 +367,7 @@ app(App\SomeClass::class);
 ```
 
 > Note: You might need to restart PhpStorm and make sure `.phpstorm.meta.php` is indexed.
->
+
 > Note: When you receive a FatalException: class not found, check your config
 > (for example, remove S3 as cloud driver when you don't have S3 configured. Remove Redis ServiceProvider when you don't use it).
 

composer.json

@@ -65,7 +65,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "3.2-dev"
+            "dev-master": "3.4-dev"
         },
         "laravel": {
             "providers": [

resources/views/helper.php

@@ -14,31 +14,34 @@
 
 /**
  * A helper file for Laravel, to provide autocomplete information to your IDE
- * Generated for Laravel <?= $version ?>.
+ * Generated for Laravel <?= app()->version() ?>.
  *
  * This file should not be included in your code, only analyzed by your IDE!
  *
  * @author Barry vd. Heuvel <[email protected]>
  * @see https://github.com/barryvdh/laravel-ide-helper
  */
-
+<?php
+$s1 = '    ';
+$s2 = $s1 . $s1;
+$s3 = $s1 . $s2;
+?>
 <?php foreach ($namespaces_by_extends_ns as $namespace => $aliases) : ?>
 namespace <?= $namespace === '__root' ? '' : trim($namespace, '\\') ?> {
     <?php foreach ($aliases as $alias) : ?>
-        <?= trim($alias->getDocComment('    ')) ?>
+<?php echo trim($alias->getDocComment($s1)) . "\n{$s1}" . $alias->getClassType() ?> <?= $alias->getExtendsClass() ?> {
-        <?= $alias->getClassType() ?> <?= $alias->getExtendsClass() ?> {
         <?php foreach ($alias->getMethods() as $method) : ?>
-            <?= trim($method->getDocComment('        ')) ?>
+<?= trim($method->getDocComment($s2)) . "\n{$s2}" ?>public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
-        public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
         {<?php if ($method->getDeclaringClass() !== $method->getRoot()) : ?>
-            //Method inherited from <?= $method->getDeclaringClass() ?>
+<?= "\n" . $s3?>//Method inherited from <?= $method->getDeclaringClass() ?>
-         <?php endif; ?>
+ <?php endif; ?>
 
-            <?php if ($method->isInstanceCall()) : ?>
+<?php if ($method->isInstanceCall()) : ?>
-            /** @var <?=$method->getRoot()?> $instance */
+<?= $s3 ?>/** @var <?=$method->getRoot()?> $instance */
-            <?php endif?>
+<?php endif?>
-            <?= $method->shouldReturn() ? 'return ' : '' ?><?= $method->getRootMethodCall() ?>;
+<?= $s3 . ($method->shouldReturn() ? 'return ' : '') ?><?= $method->getRootMethodCall() ?>;
         }
+
         <?php endforeach; ?>
     }
     <?php endforeach; ?>
@@ -48,26 +51,27 @@ namespace <?= $namespace === '__root' ? '' : trim($namespace, '\\') ?> {
 
 <?php foreach ($namespaces_by_alias_ns as $namespace => $aliases) : ?>
 namespace <?= $namespace === '__root' ? '' : trim($namespace, '\\') ?> {
-    <?php foreach ($aliases as $alias) : ?>
+<?php foreach ($aliases as $alias) : ?>
-        <?php if ($alias->getExtendsNamespace() === '\Illuminate\Database\Eloquent') : ?>
+<?php if ($alias->getExtendsNamespace() === '\Illuminate\Database\Eloquent') : ?>
-        <?= $alias->getPhpDocTemplates('            ') ?>
+<?= "\n" . $alias->getPhpDocTemplates($s1) . "\n" ?>
-        <?php endif?>
+<?php endif?>
-        <?= $alias->getClassType() ?> <?= $alias->getShortName() ?> extends <?= $alias->getExtends() ?> {<?php if ($alias->getExtendsNamespace() === '\Illuminate\Database\Eloquent') : ?>
+<?= $s1 . $alias->getClassType() ?> <?= $alias->getShortName() ?> extends <?= $alias->getExtends() ?> {<?php if ($alias->getExtendsNamespace() === '\Illuminate\Database\Eloquent') : ?>
-            <?php foreach ($alias->getMethods() as $method) : ?>
+<?php foreach ($alias->getMethods() as $method) : ?>
-                <?= trim($method->getDocComment('            ')) ?>
+<?= $s2 . trim($method->getDocComment($s2)) . "\n" ?>
-            public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
+<?= $s2 ?>public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
-            {<?php if ($method->getDeclaringClass() !== $method->getRoot()) : ?>
+<?= $s2?>{<?php if ($method->getDeclaringClass() !== $method->getRoot()) : ?>
-                //Method inherited from <?= $method->getDeclaringClass() ?>
+<?= $s2 ?>//Method inherited from <?= $method->getDeclaringClass() ?>
-             <?php endif; ?>
+<?php endif; ?>
 
-                <?php if ($method->isInstanceCall()) : ?>
+<?php if ($method->isInstanceCall()) : ?>
-                /** @var <?=$method->getRoot()?> $instance */
+<?= $s3 ?>/** @var <?=$method->getRoot()?> $instance */
-                <?php endif?>
+<?php endif?>
-                <?= $method->shouldReturn() ? 'return ' : '' ?><?= $method->getRootMethodCall() ?>;
+<?= $s3 . ($method->shouldReturn() ? 'return ' : '') ?><?= $method->getRootMethodCall() ?>;
-            }
+<?= $s2 ?>}
-            <?php endforeach; ?>
+
-        <?php endif; ?>}
+<?php endforeach; ?>
-    <?php endforeach; ?>
+<?php endif; ?>}
+<?php endforeach; ?>
 }
 
 <?php endforeach; ?>

src/Console/GeneratorCommand.php

@@ -113,7 +113,12 @@ class GeneratorCommand extends Command
         }
 
         $generator = new Generator($this->config, $this->view, $this->getOutput(), $helpers);
-        $content = $generator->generate();
+        if ($this->option('eloquent')) {
+            $content = $generator->generateEloquent();
+        } else {
+            $content = $generator->generate();
+        }
+
         $written = $this->files->put($filename, $content);
 
         if ($written !== false) {
@@ -169,6 +174,7 @@ class GeneratorCommand extends Command
             ['write_mixins', 'W', InputOption::VALUE_OPTIONAL, 'Write mixins to Laravel Model?', $writeMixins],
             ['helpers', 'H', InputOption::VALUE_NONE, 'Include the helper files'],
             ['memory', 'M', InputOption::VALUE_NONE, 'Use sqlite memory driver'],
+            ['eloquent', 'E', InputOption::VALUE_NONE, 'Only write Eloquent methods'],
         ];
     }
 }

src/Console/ModelsCommand.php

@@ -12,6 +12,7 @@
 namespace Barryvdh\LaravelIdeHelper\Console;
 
 use Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface;
+use Barryvdh\LaravelIdeHelper\Generator;
 use Barryvdh\LaravelIdeHelper\Parsers\PhpDocReturnTypeParser;
 use Barryvdh\Reflection\DocBlock;
 use Barryvdh\Reflection\DocBlock\Context;
@@ -19,6 +20,7 @@ use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
 use Barryvdh\Reflection\DocBlock\Tag;
 use Composer\ClassMapGenerator\ClassMapGenerator;
 use Illuminate\Console\Command;
+use Illuminate\Contracts\Config\Repository;
 use Illuminate\Contracts\Database\Eloquent\Castable;
 use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
 use Illuminate\Contracts\Database\Eloquent\CastsInboundAttributes;
@@ -46,6 +48,7 @@ use Illuminate\Filesystem\Filesystem;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
+use Illuminate\View\Factory as ViewFactory;
 use phpDocumentor\Reflection\Types\ContextFactory;
 use ReflectionClass;
 use ReflectionNamedType;
@@ -82,6 +85,14 @@ class ModelsCommand extends Command
      */
     protected $files;
 
+    /**
+     * @var Repository
+     */
+    protected $config;
+
+    /** @var ViewFactory */
+    protected $view;
+
     /**
      * The console command name.
      *
@@ -131,10 +142,12 @@ class ModelsCommand extends Command
     /**
      * @param Filesystem $files
      */
-    public function __construct(Filesystem $files)
+    public function __construct(Filesystem $files, Repository $config, ViewFactory $view)
     {
-        parent::__construct();
+        $this->config = $config;
         $this->files = $files;
+        $this->view = $view;
+        parent::__construct();
     }
 
     /**
@@ -187,6 +200,27 @@ class ModelsCommand extends Command
                 $this->error("Failed to write model information to $filename");
             }
         }
+
+        $helperFilename = $this->config->get('ide-helper.filename');
+        $writeHelper = $this->option('write-eloquent-helper');
+
+        if (!$writeHelper && !$this->files->exists($helperFilename) && ($this->write || $this->write_mixin)) {
+            if ($this->confirm("{$helperFilename} does not exist.
+            Do you want to generate a minimal helper to generate the Eloquent methods?")) {
+                $writeHelper = true;
+            }
+        }
+
+        if ($writeHelper) {
+            $generator = new Generator($this->config, $this->view, $this->getOutput());
+            $content = $generator->generateEloquent();
+            $written = $this->files->put($helperFilename, $content);
+            if ($written !== false) {
+                $this->info("Eloquent helper was written to $helperFilename");
+            } else {
+                $this->error("Failed to write eloquent helper to $helperFilename");
+            }
+        }
     }
 
 
@@ -217,6 +251,9 @@ class ModelsCommand extends Command
             ['write-mixin', 'M', InputOption::VALUE_NONE,
                 "Write models to {$this->filename} and adds @mixin to each model, avoiding IDE duplicate declaration warnings",
             ],
+            ['write-eloquent-helper', 'E', InputOption::VALUE_NONE,
+                'Write Eloquent helper file to _ide_helper.php',
+            ],
             ['nowrite', 'N', InputOption::VALUE_NONE, 'Don\'t write to Model file'],
             ['reset', 'R', InputOption::VALUE_NONE, 'Remove the original phpdocs instead of appending'],
             ['smart-reset', 'r', InputOption::VALUE_NONE, 'Retained for compatibility, while it no longer has any effect'],
@@ -389,7 +426,7 @@ class ModelsCommand extends Command
                     break;
                 case 'array':
                 case 'json':
-                    $realType = 'array';
+                    $realType = 'array<array-key, mixed>';
                     break;
                 case 'object':
                     $realType = 'object';
@@ -413,10 +450,10 @@ class ModelsCommand extends Command
                     $realType = '\Carbon\CarbonImmutable';
                     break;
                 case 'collection':
-                    $realType = '\Illuminate\Support\Collection';
+                    $realType = '\Illuminate\Support\Collection<array-key, mixed>';
                     break;
                 case AsArrayObject::class:
-                    $realType = '\ArrayObject';
+                    $realType = '\ArrayObject<array-key, mixed>';
                     break;
                 default:
                     // In case of an optional custom cast parameter , only evaluate

src/Generator.php

@@ -11,6 +11,7 @@
 
 namespace Barryvdh\LaravelIdeHelper;
 
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Foundation\AliasLoader;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Facade;
@@ -83,12 +84,37 @@ class Generator
             ->with('namespaces_by_alias_ns', $this->getAliasesByAliasNamespace())
             ->with('real_time_facades', $this->getRealTimeFacades())
             ->with('helpers', $this->helpers)
-            ->with('version', $app->version())
             ->with('include_fluent', $this->config->get('ide-helper.include_fluent', true))
             ->with('factories', $this->config->get('ide-helper.include_factory_builders') ? Factories::all() : [])
             ->render();
     }
 
+    public function generateEloquent()
+    {
+        $name = 'Eloquent';
+        $facade = Model::class;
+        $magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : [];
+        $alias = new Alias($this->config, $name, $facade, $magicMethods, $this->interfaces);
+        if (!$alias->isValid()) {
+            throw new \RuntimeException('Cannot generate Eloquent helper');
+        }
+
+        //Add extra methods, from other classes (magic static calls)
+        if (array_key_exists($name, $this->extra)) {
+            $alias->addClass($this->extra[$name]);
+        }
+
+        $app = app();
+        return $this->view->make('helper')
+            ->with('namespaces_by_extends_ns', [])
+            ->with('namespaces_by_alias_ns', ['__root' => [$alias]])
+            ->with('real_time_facades', [])
+            ->with('helpers', '')
+            ->with('include_fluent', false)
+            ->with('factories', [])
+            ->render();
+    }
+
     protected function detectDrivers()
     {
         $defaultUserModel = config('auth.providers.users.model', config('auth.model', 'App\User'));

src/IdeHelperServiceProvider.php

@@ -65,7 +65,7 @@ class IdeHelperServiceProvider extends ServiceProvider implements DeferrableProv
         $configPath = __DIR__ . '/../config/ide-helper.php';
         $this->mergeConfigFrom($configPath, 'ide-helper');
 
-        $this->app->when([GeneratorCommand::class, MetaCommand::class])
+        $this->app->when([GeneratorCommand::class, MetaCommand::class, ModelsCommand::class])
             ->needs(\Illuminate\Contracts\View\Factory::class)
             ->give(function () {
                 return $this->createLocalViewFactory();

tests/Console/EloquentCommandTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Barryvdh\LaravelIdeHelper\Tests\Console;
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\EloquentCommand;
 
 use Barryvdh\LaravelIdeHelper\Console\EloquentCommand;
 use Barryvdh\LaravelIdeHelper\Tests\TestCase;
@@ -23,7 +23,7 @@ class EloquentCommandTest extends TestCase
         }
 
         $actualContent = null;
-        $mockFilesystem = Mockery::mock(Filesystem::class);
+        $mockFilesystem = Mockery::mock(Filesystem::class)->makePartial();
         $mockFilesystem
             ->shouldReceive('get')
             // We don't care about actual args (filename)

tests/Console/GeneratorCommand/GenerateEloquentOnly/Test.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand\GenerateEloquentOnly;
+
+use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
+use Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand\AbstractGeneratorCommand;
+
+class Test extends AbstractGeneratorCommand
+{
+    public function testGenerator(): void
+    {
+        $command = $this->app->make(GeneratorCommand::class);
+
+        $tester = $this->runCommand($command, [
+            '--eloquent' => true,
+        ]);
+
+        $this->assertSame(0, $tester->getStatusCode());
+        $this->assertStringContainsString('A new helper file was written to _ide_helper.php', $tester->getDisplay());
+        $this->assertStringNotContainsString('public static function configure($basePath = null)', $this->mockFilesystemOutput);
+        $this->assertStringContainsString('class Eloquent extends \Illuminate\Database\Eloquent\Model', $this->mockFilesystemOutput);
+    }
+}

tests/Console/ModelsCommand/AdvancedCasts/__snapshots__/Test__test__1.php

@@ -22,13 +22,13 @@ use Illuminate\Database\Eloquent\Model;
  * @property \Carbon\CarbonImmutable $cast_to_immutable_datetime
  * @property int $cast_to_timestamp
  * @property mixed $cast_to_encrypted
- * @property array $cast_to_encrypted_array
+ * @property array<array-key, mixed> $cast_to_encrypted_array
- * @property \Illuminate\Support\Collection $cast_to_encrypted_collection
+ * @property \Illuminate\Support\Collection<array-key, mixed> $cast_to_encrypted_collection
- * @property array $cast_to_encrypted_json
+ * @property array<array-key, mixed> $cast_to_encrypted_json
  * @property object $cast_to_encrypted_object
  * @property \Illuminate\Support\Collection $cast_to_as_collection
  * @property \Illuminate\Support\Collection $cast_to_as_enum_collection
- * @property \ArrayObject $cast_to_as_array_object
+ * @property \ArrayObject<array-key, mixed> $cast_to_as_array_object
  * @property AdvancedCastCollection $cast_to_as_collection_using
  * @property \Illuminate\Support\Collection<int, AdvancedCastEnum> $cast_to_as_enum_collection_of
  * @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast newModelQuery()

tests/Console/ModelsCommand/GenerateBasicPhpdoc/Test.php

@@ -19,6 +19,8 @@ class Test extends AbstractModelsCommand
 
         $this->assertSame(0, $tester->getStatusCode());
         $this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
+        $this->assertStringContainsString('Do you want to generate a minimal helper to generate the Eloquent methods?', $tester->getDisplay());
+
         $this->assertMatchesMockedSnapshot();
     }
 }

tests/Console/ModelsCommand/GenerateBasicPhpdocWithEloquentHelper/Models/Post.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpdocWithEloquentHelper\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+class Post extends Model
+{
+}

tests/Console/ModelsCommand/GenerateBasicPhpdocWithEloquentHelper/Test.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpdocWithEloquentHelper;
+
+use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
+
+class Test extends AbstractModelsCommand
+{
+    public function test(): void
+    {
+        $command = $this->app->make(ModelsCommand::class);
+
+        $tester = $this->runCommand($command, [
+            '--write' => true,
+            '--write-eloquent-helper' => true,
+        ]);
+
+        $this->assertSame(0, $tester->getStatusCode());
+        $this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
+        $this->assertStringNotContainsString('Do you want to generate a minimal helper to generate the Eloquent methods?', $tester->getDisplay());
+        $this->assertStringContainsString('Eloquent helper was written to _ide_helper.php', $tester->getDisplay());
+
+        //        $this->assertMatchesMockedSnapshot();
+    }
+}

tests/Console/ModelsCommand/GenerateBasicPhpdocWithEloquentHelper/__snapshots__/Test__test__1.php

@@ -0,0 +1,161 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpdocWithEloquentHelper\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * 
+ *
+ * @property int $id
+ * @property string|null $char_nullable
+ * @property string $char_not_nullable
+ * @property string|null $string_nullable
+ * @property string $string_not_nullable
+ * @property string|null $text_nullable
+ * @property string $text_not_nullable
+ * @property string|null $medium_text_nullable
+ * @property string $medium_text_not_nullable
+ * @property string|null $long_text_nullable
+ * @property string $long_text_not_nullable
+ * @property int|null $integer_nullable
+ * @property int $integer_not_nullable
+ * @property int|null $tiny_integer_nullable
+ * @property int $tiny_integer_not_nullable
+ * @property int|null $small_integer_nullable
+ * @property int $small_integer_not_nullable
+ * @property int|null $medium_integer_nullable
+ * @property int $medium_integer_not_nullable
+ * @property int|null $big_integer_nullable
+ * @property int $big_integer_not_nullable
+ * @property int|null $unsigned_integer_nullable
+ * @property int $unsigned_integer_not_nullable
+ * @property int|null $unsigned_tiny_integer_nullable
+ * @property int $unsigned_tiny_integer_not_nullable
+ * @property int|null $unsigned_small_integer_nullable
+ * @property int $unsigned_small_integer_not_nullable
+ * @property int|null $unsigned_medium_integer_nullable
+ * @property int $unsigned_medium_integer_not_nullable
+ * @property int|null $unsigned_big_integer_nullable
+ * @property int $unsigned_big_integer_not_nullable
+ * @property float|null $float_nullable
+ * @property float $float_not_nullable
+ * @property float|null $double_nullable
+ * @property float $double_not_nullable
+ * @property string|null $decimal_nullable
+ * @property string $decimal_not_nullable
+ * @property int|null $boolean_nullable
+ * @property int $boolean_not_nullable
+ * @property string|null $enum_nullable
+ * @property string $enum_not_nullable
+ * @property string|null $json_nullable
+ * @property string $json_not_nullable
+ * @property string|null $jsonb_nullable
+ * @property string $jsonb_not_nullable
+ * @property string|null $date_nullable
+ * @property string $date_not_nullable
+ * @property string|null $datetime_nullable
+ * @property string $datetime_not_nullable
+ * @property string|null $datetimetz_nullable
+ * @property string $datetimetz_not_nullable
+ * @property string|null $time_nullable
+ * @property string $time_not_nullable
+ * @property string|null $timetz_nullable
+ * @property string $timetz_not_nullable
+ * @property string|null $timestamp_nullable
+ * @property string $timestamp_not_nullable
+ * @property string|null $timestamptz_nullable
+ * @property string $timestamptz_not_nullable
+ * @property int|null $year_nullable
+ * @property int $year_not_nullable
+ * @property string|null $binary_nullable
+ * @property string $binary_not_nullable
+ * @property string|null $uuid_nullable
+ * @property string $uuid_not_nullable
+ * @property string|null $ipaddress_nullable
+ * @property string $ipaddress_not_nullable
+ * @property string|null $macaddress_nullable
+ * @property string $macaddress_not_nullable
+ * @property \Illuminate\Support\Carbon|null $created_at
+ * @property \Illuminate\Support\Carbon|null $updated_at
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post newModelQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post newQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post query()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBigIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBigIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBinaryNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBinaryNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBooleanNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBooleanNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereCharNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereCharNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereCreatedAt($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDateNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDateNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDatetimeNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDatetimeNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDatetimetzNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDatetimetzNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDecimalNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDecimalNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDoubleNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDoubleNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereEnumNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereEnumNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereFloatNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereFloatNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereId($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereIpaddressNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereIpaddressNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereJsonNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereJsonNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereJsonbNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereJsonbNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereLongTextNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereLongTextNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMacaddressNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMacaddressNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMediumIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMediumIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMediumTextNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMediumTextNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereSmallIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereSmallIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereStringNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereStringNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTextNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTextNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimeNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimeNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimestampNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimestampNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimestamptzNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimestamptzNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimetzNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimetzNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTinyIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTinyIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedBigIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedBigIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedMediumIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedMediumIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedSmallIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedSmallIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedTinyIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedTinyIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUpdatedAt($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUuidNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUuidNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereYearNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereYearNullable($value)
+ * @mixin \Eloquent
+ */
+class Post extends Model
+{
+}

tests/Console/ModelsCommand/ModelHooks/Test.php

@@ -36,7 +36,7 @@ class Test extends AbstractModelsCommand
     {
         $actualContent = null;
 
-        $mockFilesystem = Mockery::mock(Filesystem::class);
+        $mockFilesystem = Mockery::mock(Filesystem::class)->makePartial();
         $mockFilesystem
             ->shouldReceive('get')
             ->andReturn(file_get_contents(__DIR__ . '/Models/Simple.php'))

tests/Console/ModelsCommand/SimpleCasts/__snapshots__/Test__test__1.php

@@ -19,9 +19,9 @@ use Illuminate\Database\Eloquent\Model;
  * @property bool $cast_to_bool
  * @property bool $cast_to_boolean
  * @property object $cast_to_object
- * @property array $cast_to_array
+ * @property array<array-key, mixed> $cast_to_array
- * @property array $cast_to_json
+ * @property array<array-key, mixed> $cast_to_json
- * @property \Illuminate\Support\Collection $cast_to_collection
+ * @property \Illuminate\Support\Collection<array-key, mixed> $cast_to_collection
  * @property \Illuminate\Support\Carbon $cast_to_date
  * @property \Illuminate\Support\Carbon $cast_to_datetime
  * @property \Illuminate\Support\Carbon $cast_to_date_serialization
@@ -34,9 +34,9 @@ use Illuminate\Database\Eloquent\Model;
  * @property \Carbon\CarbonImmutable $cast_to_immutable_datetime_serialization
  * @property int $cast_to_timestamp
  * @property mixed $cast_to_encrypted
- * @property array $cast_to_encrypted_array
+ * @property array<array-key, mixed> $cast_to_encrypted_array
- * @property \Illuminate\Support\Collection $cast_to_encrypted_collection
+ * @property \Illuminate\Support\Collection<array-key, mixed> $cast_to_encrypted_collection
- * @property array $cast_to_encrypted_json
+ * @property array<array-key, mixed> $cast_to_encrypted_json
  * @property object $cast_to_encrypted_object
  * @method static \Illuminate\Database\Eloquent\Builder<static>|SimpleCast newModelQuery()
  * @method static \Illuminate\Database\Eloquent\Builder<static>|SimpleCast newQuery()