Skip to content

Commit bd54800

Browse files
committed
Add Laravel Boost Copilot CLI integration
Introduces Laravel Boost and MCP configuration for Copilot CLI support. Adds boost.json and .github/mcp-config.json, updates composer dependencies, and removes CLAUDE.md documentation to focus on Copilot guidelines.
1 parent e4a3dde commit bd54800

6 files changed

Lines changed: 510 additions & 138 deletions

File tree

.github/copilot-instructions.md

Lines changed: 214 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -272,4 +272,217 @@ When working with this codebase:
272272
6. **Minimal Changes**: Make surgical modifications rather than large refactors
273273
7. **Consistency**: Follow existing coding standards and conventions
274274

275-
This application is production-ready and actively used for automated reporting. Prioritize stability and maintainability in all modifications.
275+
This application is production-ready and actively used for automated reporting. Prioritize stability and maintainability in all modifications.
276+
277+
===
278+
279+
<laravel-boost-guidelines>
280+
=== foundation rules ===
281+
282+
# Laravel Boost Guidelines
283+
284+
The Laravel Boost guidelines are specifically curated by Laravel maintainers for this application. These guidelines should be followed closely to enhance the user's satisfaction building Laravel applications.
285+
286+
## Foundational Context
287+
This application is a Laravel application and its main Laravel ecosystems package & versions are below. You are an expert with them all. Ensure you abide by these specific packages & versions.
288+
289+
- php - 8.4.14
290+
- laravel/framework (LARAVEL) - v12
291+
- laravel/prompts (PROMPTS) - v0
292+
- laravel/mcp (MCP) - v0
293+
- laravel/pint (PINT) - v1
294+
- laravel/sail (SAIL) - v1
295+
- phpunit/phpunit (PHPUNIT) - v11
296+
297+
## Conventions
298+
- You must follow all existing code conventions used in this application. When creating or editing a file, check sibling files for the correct structure, approach, naming.
299+
- Use descriptive names for variables and methods. For example, `isRegisteredForDiscounts`, not `discount()`.
300+
- Check for existing components to reuse before writing a new one.
301+
302+
## Verification Scripts
303+
- Do not create verification scripts or tinker when tests cover that functionality and prove it works. Unit and feature tests are more important.
304+
305+
## Application Structure & Architecture
306+
- Stick to existing directory structure - don't create new base folders without approval.
307+
- Do not change the application's dependencies without approval.
308+
309+
## Frontend Bundling
310+
- If the user doesn't see a frontend change reflected in the UI, it could mean they need to run `npm run build`, `npm run dev`, or `composer run dev`. Ask them.
311+
312+
## Replies
313+
- Be concise in your explanations - focus on what's important rather than explaining obvious details.
314+
315+
## Documentation Files
316+
- You must only create documentation files if explicitly requested by the user.
317+
318+
319+
=== boost rules ===
320+
321+
## Laravel Boost
322+
- Laravel Boost is an MCP server that comes with powerful tools designed specifically for this application. Use them.
323+
324+
## Artisan
325+
- Use the `list-artisan-commands` tool when you need to call an Artisan command to double check the available parameters.
326+
327+
## URLs
328+
- Whenever you share a project URL with the user you should use the `get-absolute-url` tool to ensure you're using the correct scheme, domain / IP, and port.
329+
330+
## Tinker / Debugging
331+
- You should use the `tinker` tool when you need to execute PHP to debug code or query Eloquent models directly.
332+
- Use the `database-query` tool when you only need to read from the database.
333+
334+
## Reading Browser Logs With the `browser-logs` Tool
335+
- You can read browser logs, errors, and exceptions using the `browser-logs` tool from Boost.
336+
- Only recent browser logs will be useful - ignore old logs.
337+
338+
## Searching Documentation (Critically Important)
339+
- Boost comes with a powerful `search-docs` tool you should use before any other approaches. This tool automatically passes a list of installed packages and their versions to the remote Boost API, so it returns only version-specific documentation specific for the user's circumstance. You should pass an array of packages to filter on if you know you need docs for particular packages.
340+
- The 'search-docs' tool is perfect for all Laravel related packages, including Laravel, Inertia, Livewire, Filament, Tailwind, Pest, Nova, Nightwatch, etc.
341+
- You must use this tool to search for Laravel-ecosystem documentation before falling back to other approaches.
342+
- Search the documentation before making code changes to ensure we are taking the correct approach.
343+
- Use multiple, broad, simple, topic based queries to start. For example: `['rate limiting', 'routing rate limiting', 'routing']`.
344+
- Do not add package names to queries - package information is already shared. For example, use `test resource table`, not `filament 4 test resource table`.
345+
346+
### Available Search Syntax
347+
- You can and should pass multiple queries at once. The most relevant results will be returned first.
348+
349+
1. Simple Word Searches with auto-stemming - query=authentication - finds 'authenticate' and 'auth'
350+
2. Multiple Words (AND Logic) - query=rate limit - finds knowledge containing both "rate" AND "limit"
351+
3. Quoted Phrases (Exact Position) - query="infinite scroll" - Words must be adjacent and in that order
352+
4. Mixed Queries - query=middleware "rate limit" - "middleware" AND exact phrase "rate limit"
353+
5. Multiple Queries - queries=["authentication", "middleware"] - ANY of these terms
354+
355+
356+
=== php rules ===
357+
358+
## PHP
359+
360+
- Always use curly braces for control structures, even if it has one line.
361+
362+
### Constructors
363+
- Use PHP 8 constructor property promotion in `__construct()`.
364+
- <code-snippet>public function __construct(public GitHub $github) { }</code-snippet>
365+
- Do not allow empty `__construct()` methods with zero parameters.
366+
367+
### Type Declarations
368+
- Always use explicit return type declarations for methods and functions.
369+
- Use appropriate PHP type hints for method parameters.
370+
371+
<code-snippet name="Explicit Return Types and Method Params" lang="php">
372+
protected function isAccessible(User $user, ?string $path = null): bool
373+
{
374+
...
375+
}
376+
</code-snippet>
377+
378+
## Comments
379+
- Prefer PHPDoc blocks over comments. Never use comments within the code itself unless there is something _very_ complex going on.
380+
381+
## PHPDoc Blocks
382+
- Add useful array shape type definitions for arrays when appropriate.
383+
384+
## Enums
385+
- Typically, keys in an Enum should be TitleCase. For example: `FavoritePerson`, `BestLake`, `Monthly`.
386+
387+
388+
=== laravel/core rules ===
389+
390+
## Do Things the Laravel Way
391+
392+
- Use `php 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.
393+
- If you're creating a generic PHP class, use `artisan make:class`.
394+
- 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.
395+
396+
### Database
397+
- Always use proper Eloquent relationship methods with return type hints. Prefer relationship methods over raw queries or manual joins.
398+
- Use Eloquent models and relationships before suggesting raw database queries
399+
- Avoid `DB::`; prefer `Model::query()`. Generate code that leverages Laravel's ORM capabilities rather than bypassing them.
400+
- Generate code that prevents N+1 query problems by using eager loading.
401+
- Use Laravel's query builder for very complex database operations.
402+
403+
### Model Creation
404+
- 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 `php artisan make:model`.
405+
406+
### APIs & Eloquent Resources
407+
- For APIs, default to using Eloquent API Resources and API versioning unless existing API routes do not, then you should follow existing application convention.
408+
409+
### Controllers & Validation
410+
- Always create Form Request classes for validation rather than inline validation in controllers. Include both validation rules and custom error messages.
411+
- Check sibling Form Requests to see if the application uses array or string based validation rules.
412+
413+
### Queues
414+
- Use queued jobs for time-consuming operations with the `ShouldQueue` interface.
415+
416+
### Authentication & Authorization
417+
- Use Laravel's built-in authentication and authorization features (gates, policies, Sanctum, etc.).
418+
419+
### URL Generation
420+
- When generating links to other pages, prefer named routes and the `route()` function.
421+
422+
### Configuration
423+
- Use environment variables only in configuration files - never use the `env()` function directly outside of config files. Always use `config('app.name')`, not `env('APP_NAME')`.
424+
425+
### Testing
426+
- 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.
427+
- Faker: Use methods such as `$this->faker->word()` or `fake()->randomDigit()`. Follow existing conventions whether to use `$this->faker` or `fake()`.
428+
- When creating tests, make use of `php artisan make:test [options] <name>` to create a feature test, and pass `--unit` to create a unit test. Most tests should be feature tests.
429+
430+
### Vite Error
431+
- If you receive an "Illuminate\Foundation\ViteException: Unable to locate file in Vite manifest" error, you can run `npm run build` or ask the user to run `npm run dev` or `composer run dev`.
432+
433+
434+
=== laravel/v12 rules ===
435+
436+
## Laravel 12
437+
438+
- Use the `search-docs` tool to get version specific documentation.
439+
- Since Laravel 11, Laravel has a new streamlined file structure which this project uses.
440+
441+
### Laravel 12 Structure
442+
- No middleware files in `app/Http/Middleware/`.
443+
- `bootstrap/app.php` is the file to register middleware, exceptions, and routing files.
444+
- `bootstrap/providers.php` contains application specific service providers.
445+
- **No app\Console\Kernel.php** - use `bootstrap/app.php` or `routes/console.php` for console configuration.
446+
- **Commands auto-register** - files in `app/Console/Commands/` are automatically available and do not require manual registration.
447+
448+
### Database
449+
- When modifying a column, the migration must include all of the attributes that were previously defined on the column. Otherwise, they will be dropped and lost.
450+
- Laravel 11 allows limiting eagerly loaded records natively, without external packages: `$query->latest()->limit(10);`.
451+
452+
### Models
453+
- Casts can and likely should be set in a `casts()` method on a model rather than the `$casts` property. Follow existing conventions from other models.
454+
455+
456+
=== pint/core rules ===
457+
458+
## Laravel Pint Code Formatter
459+
460+
- You must run `vendor/bin/pint --dirty` before finalizing changes to ensure your code matches the project's expected style.
461+
- Do not run `vendor/bin/pint --test`, simply run `vendor/bin/pint` to fix any formatting issues.
462+
463+
464+
=== phpunit/core rules ===
465+
466+
## PHPUnit Core
467+
468+
- This application uses PHPUnit for testing. All tests must be written as PHPUnit classes. Use `php artisan make:test --phpunit <name>` to create a new test.
469+
- If you see a test using "Pest", convert it to PHPUnit.
470+
- Every time a test has been updated, run that singular test.
471+
- 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.
472+
- Tests should test all of the happy paths, failure paths, and weird paths.
473+
- 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.
474+
475+
### Running Tests
476+
- Run the minimal number of tests, using an appropriate filter, before finalizing.
477+
- To run all tests: `php artisan test`.
478+
- To run all tests in a file: `php artisan test tests/Feature/ExampleTest.php`.
479+
- To filter on a particular test name: `php artisan test --filter=testName` (recommended after making a change to a related file).
480+
481+
482+
=== tests rules ===
483+
484+
## Test Enforcement
485+
486+
- 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.
487+
- Run the minimum number of tests needed to ensure code quality and speed. Use `php artisan test` with a specific filename or filter.
488+
</laravel-boost-guidelines>

.github/mcp-config.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"mcpServers": {
3+
"laravel-boost": {
4+
"type": "local",
5+
"command": "php",
6+
"args": [
7+
"artisan",
8+
"boost:mcp"
9+
],
10+
"tools": [
11+
"*"
12+
]
13+
}
14+
}
15+
}

CLAUDE.md

Lines changed: 0 additions & 135 deletions
This file was deleted.

boost.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"agents": [
3+
"copilot"
4+
],
5+
"editors": [
6+
"copilot-cli"
7+
],
8+
"guidelines": []
9+
}

composer.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@
2222
"laravel/sail": "^1.41",
2323
"mockery/mockery": "^1.6",
2424
"nunomaduro/collision": "^8.6",
25-
"phpunit/phpunit": "^11.5.3"
25+
"phpunit/phpunit": "^11.5.3",
26+
"revolution/laravel-boost-copilot-cli": "^1.0"
2627
},
2728
"autoload": {
2829
"psr-4": {

0 commit comments

Comments
 (0)