feat: enhance ModelMakeCommand to support builder generation and add model stub

Author: MrPunyapal

src/Commands/ModelMakeCommand.php

@@ -20,6 +20,36 @@ public function handle()
         }
     }
 
+    /**
+     * @inheritdoc
+     */
+    protected function getStub()
+    {
+        return $this->resolveStubPath('/../../stubs/model.stub');
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function resolveStubPath($stub)
+    {
+        return file_exists($customPath = $this->laravel->basePath(trim($stub, '/')))
+            ? $customPath
+            : __DIR__.$stub;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function buildClass($name)
+    {
+        $replace = $this->buildBuilderReplacements();
+
+        return str_replace(
+            array_keys($replace), array_values($replace), parent::buildClass($name)
+        );
+    }
+
     /**
      * Create a builder file for the model.
      *
@@ -35,6 +65,51 @@ protected function createBuilder()
         ]);
     }
 
+    /**
+     * Build the replacements for a builder.
+     *
+     * @return array<string, string>
+     */
+    protected function buildBuilderReplacements()
+    {
+        $replacements = [];
+
+        if ($this->option('builder') || $this->option('all')) {
+            $modelPath = Str::of($this->argument('name'))->studly()->replace('/', '\\')->toString();
+
+            $builderNamespace = 'App\\Models\\Builders\\'.$modelPath.'Builder';
+            $builderClass = Str::of($builderNamespace)->afterLast('\\')->toString();
+
+            $builderCode = <<<EOT
+            /**
+                 * Create a new Eloquent query builder for the model.
+                 *
+                 * @param  \Illuminate\Database\Query\Builder \$query
+                 * @return $builderClass<$modelPath>
+                 */
+                public function newEloquentBuilder(\$query): $builderClass
+                {
+                    return new $builderClass(\$query);
+                }
+            EOT;
+            
+            $replacements['{{ newBuilderFunction }}'] = $builderCode;
+            $replacements['{{ builderImport }}'] = "use $builderNamespace;";
+
+            if(! $this->option('factory')){
+                $replacements["//\n"] = '';
+                $replacements["//\r\n"] = '';
+            }
+        } else {
+            $replacements["{{ newBuilderFunction }}\n"] = '';
+            $replacements["{{ newBuilderFunction }}\r\n"] = '';
+            $replacements["{{ builderImport }}\n"] = '';
+            $replacements["{{ builderImport }}\r\n"] = '';
+        }
+
+        return $replacements;
+    }
+
     /**
      * @inheritDoc
      */

stubs/model.stub

@@ -0,0 +1,14 @@
+<?php
+
+namespace {{ namespace }};
+
+{{ factoryImport }}
+{{ builderImport }}
+use Illuminate\Database\Eloquent\Model;
+
+class {{ class }} extends Model
+{
+    {{ factory }}
+
+    {{ newBuilderFunction }}
+}

tests/Unit/Commands/ModelMakeCommandTest.php

@@ -30,6 +30,10 @@
     $this->assertFileContains([
         'namespace App\Models;',
         'class Foo extends Model',
+        'use App\Models\Builders\FooBuilder;',
+        '@return FooBuilder<Foo>',
+        'public function newEloquentBuilder($query): FooBuilder',
+        'return new FooBuilder($query);',
     ], 'app/Models/Foo.php');
 
     $this->assertFileContains([