Refactor Sail Command Usage

pushpak1300 · pushpak1300 · commit b8573a1eb252 · 2025-11-07T18:22:40.000+05:30
Signed-off-by: Pushpak Chhajed &lt;pushpak1300@gmail.com&gt;
diff --git a/.ai/enforce-tests.blade.php b/.ai/enforce-tests.blade.php
@@ -4,4 +4,4 @@
 ## Test Enforcement
 
 - Every change must be programmatically tested. Write a new test or update an existing test, then run the affected tests to make sure they pass.
-- Run the minimum number of tests needed to ensure code quality and speed. Use `{{ $assist->artisan() }} test` with a specific filename or filter.
+- Run the minimum number of tests needed to ensure code quality and speed. Use `{{ $assist->artisanCommand('test') }}` with a specific filename or filter.
diff --git a/.ai/filament/3/core.blade.php b/.ai/filament/3/core.blade.php
@@ -10,5 +10,5 @@
 - Tables use the `Tables\Columns` namespace for table columns.
 - A new `Filament\Forms\Components\RichEditor` component is available.
 - Form and table schemas now use fluent method chaining.
-- Added `{{ $assist->artisan() }} filament:optimize` command for production optimization.
+- Added `{{ $assist->artisanCommand('filament:optimize') }}` command for production optimization.
 - Requires implementing `FilamentUser` contract for production access control.
diff --git a/.ai/folio/core.blade.php b/.ai/folio/core.blade.php
@@ -7,17 +7,17 @@
     - `pages/index.blade.php` → `/`
     - `pages/profile/index.blade.php` → `/profile`
     - `pages/auth/login.blade.php` → `/auth/login`
-- You may list available Folio routes using `{{ $assist->artisan() }} folio:list` or using Boost's `list-routes` tool.
+- You may list available Folio routes using `{{ $assist->artisanCommand("folio:list") }}`  or using Boost's `list-routes` tool.
 
 ### New Pages & Routes
-- Always create new `folio` pages and routes using `{{ $assist->artisan() }} folio:page [name]` following existing naming conventions.
+- Always create new `folio` pages and routes using `{{ $assist->artisanCommand('folio:page [name]') }}` following existing naming conventions.
 
 <code-snippet name="Example folio:page Commands for Automatic Routing" lang="shell">
     // Creates: resources/views/pages/products.blade.php → /products
-    {{ $assist->artisan() }} folio:page 'products'
+    {{ $assist->artisanCommand("folio:page 'products'") }}
 
     // Creates: resources/views/pages/products/[id].blade.php → /products/{id}
-    {{ $assist->artisan() }} folio:page 'products/[id]'
+    {{ $assist->artisanCommand("folio:page 'products/[id]'") }}
 </code-snippet>
 
 - Add a 'name' to each new Folio page at the very top of the file so it has a named route available for other parts of the codebase to use.
diff --git a/.ai/foundation.blade.php b/.ai/foundation.blade.php
@@ -30,10 +30,10 @@
 - Do not change the application's dependencies without approval.
 
 ## Frontend Bundling
-@if ($assist->config->enforceSail)
-- If the user doesn't see a frontend change reflected in the UI, it could mean they need to run `{{ $assist->composer() }} run dev`. Ask them.
+@if ($assist->config->usesSail)
+- If the user doesn't see a frontend change reflected in the UI, it could mean they need to run `{{ $assist->composerCommand('run dev') }}`. Ask them.
 @else
-- If the user doesn't see a frontend change reflected in the UI, it could mean they need to run `{{ $assist->nodePackageManager() }} run build`, `{{ $assist->nodePackageManager() }} run dev`, or `{{ $assist->composer() }} run dev`. Ask them.
+- If the user doesn't see a frontend change reflected in the UI, it could mean they need to run `{{ $assist->nodePackageManager() }} run build`, `{{ $assist->nodePackageManager() }} run dev`, or `{{ $assist->composerCommand('run dev') }}`. Ask them.
 @endif
 
 ## Replies
diff --git a/.ai/laravel/11/core.blade.php b/.ai/laravel/11/core.blade.php
@@ -1,3 +1,6 @@
+@php
+/** @var \Laravel\Boost\Install\GuidelineAssist $assist */
+@endphp
 ## Laravel 11
 
 - Use the `search-docs` tool to get version specific documentation.
@@ -32,6 +35,6 @@
 
 ### New Artisan Commands
 - List Artisan commands using Boost's MCP tool, if available. New commands available in Laravel 11:
-    - `{{ $assist->artisan() }} make:enum`
-    - `{{ $assist->artisan() }} make:class`
-    - `{{ $assist->artisan() }} make:interface`
+    - `{{ $assist->artisanCommand('make:enum') }}`
+    - `{{ $assist->artisanCommand('make:class') }} `
+    - `{{ $assist->artisanCommand('make:interface') }} `
diff --git a/.ai/laravel/core.blade.php b/.ai/laravel/core.blade.php
@@ -3,8 +3,8 @@
 @endphp
 ## Do Things the Laravel Way
 
-- Use `{{ $assist->artisan() }} make:` commands to create new files (i.e. migrations, controllers, models, etc.). You can list available Artisan commands using the `list-artisan-commands` tool.
-- If you're creating a generic PHP class, use `{{ $assist->artisan() }} make:class`.
+- Use `{{ $assist->artisanCommand('make:') }}` commands to create new files (i.e. migrations, controllers, models, etc.). You can list available Artisan commands using the `list-artisan-commands` tool.
+- If you're creating a generic PHP class, use `{{ $assist->artisanCommand('make:class') }}`.
 - Pass `--no-interaction` to all Artisan commands to ensure they work without user input. You should also pass the correct `--options` to ensure correct behavior.
 
 ### Database
@@ -15,7 +15,7 @@
 - Use Laravel's query builder for very complex database operations.
 
 ### Model Creation
-- When creating new models, create useful factories and seeders for them too. Ask the user if they need any other things, using `list-artisan-commands` to check the available options to `{{ $assist->artisan() }} make:model`.
+- When creating new models, create useful factories and seeders for them too. Ask the user if they need any other things, using `list-artisan-commands` to check the available options to `{{ $assist->artisanCommand('make:model') }}`.
 
 ### APIs & Eloquent Resources
 - For APIs, default to using Eloquent API Resources and API versioning unless existing API routes do not, then you should follow existing application convention.
@@ -39,11 +39,11 @@
 ### Testing
 - When creating models for tests, use the factories for the models. Check if the factory has custom states that can be used before manually setting up the model.
 - Faker: Use methods such as `$this->faker->word()` or `fake()->randomDigit()`. Follow existing conventions whether to use `$this->faker` or `fake()`.
-- When creating tests, make use of `{{ $assist->artisan() }} make:test [options] <name>` to create a feature test, and pass `--unit` to create a unit test. Most tests should be feature tests.
+- When creating tests, make use of `{{ $assist->artisanCommand('make:test [options] <name>') }}` to create a feature test, and pass `--unit` to create a unit test. Most tests should be feature tests.
 
 ### Vite Error
-@if ($assist->config->enforceSail)
-- If you receive an "Illuminate\Foundation\ViteException: Unable to locate file in Vite manifest" error, you can run `{{ $assist->composer() }} run dev` or ask the user to run it.
+@if ($assist->config->usesSail)
+- If you receive an "Illuminate\Foundation\ViteException: Unable to locate file in Vite manifest" error, you can run `{{ $assist->composerCommand('run dev') }}` or ask the user to run it.
 @else
-- If you receive an "Illuminate\Foundation\ViteException: Unable to locate file in Vite manifest" error, you can run `{{ $assist->nodePackageManager() }} run build` or ask the user to run `{{ $assist->nodePackageManager() }} run dev` or `{{ $assist->composer() }} run dev`.
+- If you receive an "Illuminate\Foundation\ViteException: Unable to locate file in Vite manifest" error, you can run `{{ $assist->nodePackageManager() }} run build` or ask the user to run `{{ $assist->nodePackageManager() }} run dev` or `{{ $assist->composerCommand('run dev') }}`.
 @endif
diff --git a/.ai/livewire/core.blade.php b/.ai/livewire/core.blade.php
@@ -3,7 +3,7 @@
 @endphp
 ## Livewire Core
 - Use the `search-docs` tool to find exact version specific documentation for how to write Livewire & Livewire tests.
-- Use the `{{ $assist->artisan() }} make:livewire [Posts\\CreatePost]` artisan command to create new components
+- Use the `{{ $assist->artisanCommand('make:livewire [Posts\\CreatePost]') }}` artisan command to create new components
 - State should live on the server, with the UI reflecting it.
 - All Livewire requests hit the Laravel backend, they're like regular HTTP requests. Always validate form data, and run authorization checks in Livewire actions.
 
diff --git a/.ai/pest/core.blade.php b/.ai/pest/core.blade.php
@@ -6,7 +6,7 @@
 - If you need to verify a feature is working, write or update a Unit / Feature test.
 
 ### Pest Tests
-- All tests must be written using Pest. Use `{{ $assist->artisan() }} make:test --pest <name>`.
+- All tests must be written using Pest. Use `{{ $assist->artisanCommand('make:test --pest <name>') }}`.
 - You must not remove any tests or test files from the tests directory without approval. These are not temporary or helper files - these are core to the application.
 - Tests should test all of the happy paths, failure paths, and weird paths.
 - Tests live in the `tests/Feature` and `tests/Unit` directories.
@@ -19,9 +19,9 @@
 
 ### Running Tests
 - Run the minimal number of tests using an appropriate filter before finalizing code edits.
-- To run all tests: `{{ $assist->artisan() }} test`.
-- To run all tests in a file: `{{ $assist->artisan() }} test tests/Feature/ExampleTest.php`.
-- To filter on a particular test name: `{{ $assist->artisan() }} test --filter=testName` (recommended after making a change to a related file).
+- To run all tests: `{{ $assist->artisanCommand('test') }}`.
+- To run all tests in a file: `{{ $assist->artisanCommand('test tests/Feature/ExampleTest.php') }}`.
+- To filter on a particular test name: `{{ $assist->artisanCommand('test --filter=testName') }}` (recommended after making a change to a related file).
 - When the tests relating to your changes are passing, ask the user if they would like to run the entire test suite to ensure everything is still passing.
 
 ### Pest Assertions
diff --git a/.ai/phpunit/core.blade.php b/.ai/phpunit/core.blade.php
@@ -3,7 +3,7 @@
 @endphp
 ## PHPUnit Core
 
-- This application uses PHPUnit for testing. All tests must be written as PHPUnit classes. Use `{{ $assist->artisan() }} make:test --phpunit <name>` to create a new test.
+- This application uses PHPUnit for testing. All tests must be written as PHPUnit classes. Use `{{ $assist->artisanCommand('make:test --phpunit <name>') }}` to create a new test.
 - If you see a test using "Pest", convert it to PHPUnit.
 - Every time a test has been updated, run that singular test.
 - When the tests relating to your feature are passing, ask the user if they would like to also run the entire test suite to make sure everything is still passing.
@@ -12,6 +12,6 @@
 
 ### Running Tests
 - Run the minimal number of tests, using an appropriate filter, before finalizing.
-- To run all tests: `{{ $assist->artisan() }} test`.
-- To run all tests in a file: `{{ $assist->artisan() }} test tests/Feature/ExampleTest.php`.
-- To filter on a particular test name: `{{ $assist->artisan() }} test --filter=testName` (recommended after making a change to a related file).
+- To run all tests: `{{ $assist->artisanCommand('test') }}`.
+- To run all tests in a file: `{{ $assist->artisanCommand('test tests/Feature/ExampleTest.php') }}`.
+- To filter on a particular test name: `{{ $assist->artisanCommand('test --filter=testName') }}` (recommended after making a change to a related file).
diff --git a/.ai/pint/core.blade.php b/.ai/pint/core.blade.php
@@ -3,5 +3,5 @@
 @endphp
 ## Laravel Pint Code Formatter
 
-- You must run `{{ $assist->bin() }}pint --dirty` before finalizing changes to ensure your code matches the project's expected style.
-- Do not run `{{ $assist->bin() }}pint --test`, simply run `{{ $assist->bin() }}pint` to fix any formatting issues.
+- You must run `{{ $assist->binCommand('pint') }} --dirty` before finalizing changes to ensure your code matches the project's expected style.
+- Do not run `{{ $assist->binCommand('pint') }} --test`, simply run `{{ $assist->binCommand('pint') }}` to fix any formatting issues.
diff --git a/.ai/sail/core.blade.php b/.ai/sail/core.blade.php
@@ -1,11 +1,14 @@
+@php
+/** @var \Laravel\Boost\Install\GuidelineAssist $assist */
+@endphp
 ## Laravel Sail
 
 - This project runs inside Laravel Sail's Docker containers. You MUST execute all commands through Sail.
-- Start services using `vendor/bin/sail up -d` and stop them with `vendor/bin/sail stop`.
-- Open the application in the browser by running `vendor/bin/sail open`.
-- Always prefix PHP, Artisan, Composer, and Node commands** with `vendor/bin/sail`. Examples:
-  - Run migrations: `vendor/bin/sail artisan migrate`
-  - Install Composer packages: `vendor/bin/sail composer install`
-  - Run npm: `vendor/bin/sail npm run dev`
-  - Execute PHP scripts: `vendor/bin/sail php [script]`
-- View all available Sail commands by running `vendor/bin/sail` without arguments.
+- Start services using `{{$assist->sailBinaryPath()}} up -d` and stop them with `{{$assist->sailBinaryPath()}} stop`.
+- Open the application in the browser by running `{{$assist->sailBinaryPath()}} open`.
+- Always prefix PHP, Artisan, Composer, and Node commands** with `{{$assist->sailBinaryPath()}}`. Examples:
+  - Run migrations: `{{$assist->sailBinaryPath()}} artisan migrate`
+  - Install Composer packages: `{{$assist->sailBinaryPath()}} composer install`
+  - Run npm: `{{$assist->sailBinaryPath()}} npm run dev`
+  - Execute PHP scripts: `{{$assist->sailBinaryPath()}} php [script]`
+- View all available Sail commands by running `{{$assist->sailBinaryPath()}}` without arguments.
diff --git a/.ai/volt/core.blade.php b/.ai/volt/core.blade.php
@@ -4,7 +4,7 @@
 ## Livewire Volt
 
 - This project uses Livewire Volt for interactivity within its pages. New pages requiring interactivity must also use Livewire Volt. There is documentation available for it.
-- Make new Volt components using `{{ $assist->artisan() }} make:volt [name] [--test] [--pest]`
+- Make new Volt components using `{{ $assist->artisanCommand('make:volt [name] [--test] [--pest]') }}`
 - Volt is a **class-based** and **functional** API for Livewire that supports single-file components, allowing a component's PHP logic and Blade templates to co-exist in the same file
 - Livewire Volt allows PHP logic and Blade templates in one file. Components use the @verbatim`@volt`@endverbatim directive.
 - You must check existing Volt components to determine if they're functional or class based. If you can't detect that, ask the user which they prefer before writing a Volt component.
diff --git a/src/Console/InstallCommand.php b/src/Console/InstallCommand.php
@@ -447,7 +447,7 @@ protected function installGuidelines(): void
         $guidelineConfig->caresAboutLocalization = $this->detectLocalization();
         $guidelineConfig->hasAnApi = false;
         $guidelineConfig->aiGuidelines = $this->selectedAiGuidelines->values()->toArray();
-        $guidelineConfig->enforceSail = $this->shouldUseSail();
+        $guidelineConfig->usesSail = $this->shouldUseSail();
 
         $composer = app(GuidelineComposer::class)->config($guidelineConfig);
         $guidelines = $composer->guidelines();
@@ -538,14 +538,16 @@ protected function shouldUseSail(): bool
 
     protected function buildMcpCommand(McpClient $mcpClient): array
     {
+        $serverName = 'laravel-boost';
+
         if ($this->shouldUseSail()) {
-            return ['laravel-boost', Sail::SAIL_BINARY_PATH, 'artisan', 'boost:mcp'];
+            return $this->sail->buildMcpCommand($serverName);
         }
 
         $inWsl = $this->isRunningInWsl();
 
         return array_filter([
-            'laravel-boost',
+            $serverName,
             $inWsl ? 'wsl.exe' : false,
             $mcpClient->getPhpPath($inWsl),
             $mcpClient->getArtisanPath($inWsl),
diff --git a/src/Install/GuidelineAssist.php b/src/Install/GuidelineAssist.php
@@ -169,24 +169,36 @@ public function nodePackageManager(): string
         return ($this->roster->nodePackageManager() ?? NodePackageManager::NPM)->value;
     }
 
-    public function artisan(): string
+    public function artisanCommand(string $command): string
     {
-        return $this->config->enforceSail
-            ? Sail::SAIL_BINARY_PATH.' artisan'
-            : 'php artisan';
+        return "{$this->artisan()} {$command}";
     }
 
-    public function composer(): string
+    public function composerCommand(string $command): string
     {
-        return $this->config->enforceSail
-            ? Sail::SAIL_BINARY_PATH.' composer'
+        $composerCommand = $this->config->usesSail
+            ? Sail::composerCommand()
             : 'composer';
+
+        return "{$composerCommand} {$command}";
+    }
+
+    public function binCommand(string $command): string
+    {
+        return $this->config->usesSail
+            ? Sail::binCommand().$command
+            : "vendor/bin/{$command}";
+    }
+
+    public function artisan(): string
+    {
+        return $this->config->usesSail
+            ? Sail::artisanCommand()
+            : 'php artisan';
     }
 
-    public function bin(): string
+    public function sailBinaryPath(): string
     {
-        return $this->config->enforceSail
-            ? Sail::SAIL_BINARY_PATH.' bin '
-            : 'vendor/bin/';
+        return Sail::BINARY_PATH;
     }
 }
diff --git a/src/Install/GuidelineComposer.php b/src/Install/GuidelineComposer.php
@@ -132,11 +132,11 @@ protected function find(): Collection
         // $phpMajorMinor = PHP_MAJOR_VERSION.'.'.PHP_MINOR_VERSION;
         // $guidelines->put('php/v'.$phpMajorMinor, $this->guidelinesDir('php/'.$phpMajorMinor));
 
-        if (str_contains((string) config('app.url'), '.test') && $this->herd->isInstalled() && ! $this->config->enforceSail) {
+        if (str_contains((string) config('app.url'), '.test') && $this->herd->isInstalled() && ! $this->config->usesSail) {
             $guidelines->put('herd', $this->guideline('herd/core'));
         }
 
-        if ($this->config->enforceSail) {
+        if ($this->config->usesSail) {
             $guidelines->put('sail', $this->guideline('sail/core'));
         }
 
diff --git a/src/Install/GuidelineConfig.php b/src/Install/GuidelineConfig.php
@@ -10,7 +10,7 @@ class GuidelineConfig
 
     public bool $laravelStyle = false;
 
-    public bool $enforceSail = false;
+    public bool $usesSail = false;
 
     public bool $caresAboutLocalization = false;
 
diff --git a/src/Install/Sail.php b/src/Install/Sail.php
@@ -8,16 +8,39 @@
 
 class Sail
 {
-    public const SAIL_BINARY_PATH = 'vendor'.DIRECTORY_SEPARATOR.'bin'.DIRECTORY_SEPARATOR.'sail';
+    public const BINARY_PATH = 'vendor'.DIRECTORY_SEPARATOR.'bin'.DIRECTORY_SEPARATOR.'sail';
+
+    public static function artisanCommand(): string
+    {
+        return self::BINARY_PATH.' artisan';
+    }
+
+    public static function binCommand(): string
+    {
+        return self::BINARY_PATH.' bin ';
+    }
+
+    public static function composerCommand(): string
+    {
+        return self::BINARY_PATH.' composer';
+    }
 
     public function isInstalled(): bool
     {
-        return file_exists(base_path(self::SAIL_BINARY_PATH)) &&
-               (file_exists(base_path('docker-compose.yml')) || file_exists(base_path('compose.yaml')));
+        return file_exists(base_path(self::BINARY_PATH)) &&
+            (file_exists(base_path('docker-compose.yml')) || file_exists(base_path('compose.yaml')));
     }
 
     public function isActive(): bool
     {
         return get_current_user() === 'sail' || getenv('LARAVEL_SAIL') === '1';
     }
+
+    /**
+     * @return array<int, string>
+     */
+    public function buildMcpCommand(string $serverName): array
+    {
+        return [$serverName, self::BINARY_PATH, 'artisan', 'boost:mcp'];
+    }
 }
diff --git a/tests/Feature/Install/GuidelineComposerTest.php b/tests/Feature/Install/GuidelineComposerTest.php
@@ -164,7 +164,7 @@
     config(['app.url' => 'http://myapp.test']);
 
     $config = new GuidelineConfig;
-    $config->enforceSail = true;
+    $config->usesSail = true;
 
     $guidelines = $this->composer
         ->config($config)
@@ -187,7 +187,7 @@
     config(['app.url' => 'http://myapp.test']);
 
     $config = new GuidelineConfig;
-    $config->enforceSail = false;
+    $config->usesSail = false;
 
     $guidelines = $this->composer
         ->config($config)
@@ -629,7 +629,7 @@
     expect($guidelines)
         ->toContain('=== wayfinder/core rules ===')
         ->toContain('## Laravel Wayfinder')
-        ->toContain('import { show } from \'@/actions/')
+        ->toContain("import { show, store, update } from '@/actions/App/Http/Controllers/PostController'")
         ->not->toContain('Wayfinder + Inertia')
         ->not->toContain('Wayfinder Form Component');
 });
