From 05868eadeda50fba6cfc56a76e94748ac050fc2a Mon Sep 17 00:00:00 2001 From: Simon Hamp Date: Sat, 7 Mar 2026 14:48:58 +0000 Subject: [PATCH 1/7] Add NativePHP Masterclass landing page with Stripe checkout - Create /course landing page with hero, curriculum, audience, pricing, and email signup sections - Wire up Stripe checkout for one-time $99 early bird payment using Cart/Product infrastructure - Add migration to seed Masterclass product and price in the database - Integrate Mailcoach for email waitlist signup via direct form POST - Fix null stripe_price crash in CustomerLicenseController dashboard - Add feature tests for course page Co-Authored-By: Claude Opus 4.6 --- .cursor/rules/laravel-boost.mdc | 292 +++---- .github/copilot-instructions.md | 292 +++---- .junie/guidelines.md | 292 +++---- AGENTS.md | 375 +++++++++ CLAUDE.md | 292 +++---- .../Controllers/CustomerLicenseController.php | 10 +- boost.json | 10 + ..._03_07_143318_seed_masterclass_product.php | 43 ++ resources/views/course.blade.php | 713 ++++++++++++++++++ routes/web.php | 62 ++ tests/Feature/CoursePageTest.php | 51 ++ 11 files changed, 1741 insertions(+), 691 deletions(-) create mode 100644 AGENTS.md create mode 100644 boost.json create mode 100644 database/migrations/2026_03_07_143318_seed_masterclass_product.php create mode 100644 resources/views/course.blade.php create mode 100644 tests/Feature/CoursePageTest.php diff --git a/.cursor/rules/laravel-boost.mdc b/.cursor/rules/laravel-boost.mdc index aecaa3e0..f677987c 100644 --- a/.cursor/rules/laravel-boost.mdc +++ b/.cursor/rules/laravel-boost.mdc @@ -11,18 +11,28 @@ The Laravel Boost guidelines are specifically curated by Laravel maintainers for ## Foundational Context 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. -- php - 8.4.11 +- php - 8.4.18 - filament/filament (FILAMENT) - v3 -- laravel/framework (LARAVEL) - v10 +- laravel/cashier (CASHIER) - v15 +- laravel/framework (LARAVEL) - v12 +- laravel/horizon (HORIZON) - v5 +- laravel/nightwatch (NIGHTWATCH) - v1 +- laravel/pennant (PENNANT) - v1 - laravel/prompts (PROMPTS) - v0 +- laravel/sanctum (SANCTUM) - v4 +- laravel/socialite (SOCIALITE) - v5 - livewire/livewire (LIVEWIRE) - v3 +- laravel/mcp (MCP) - v0 - laravel/pint (PINT) - v1 +- laravel/sail (SAIL) - v1 +- phpunit/phpunit (PHPUNIT) - v11 +- rector/rector (RECTOR) - v2 - alpinejs (ALPINEJS) - v3 +- prettier (PRETTIER) - v3 - tailwindcss (TAILWINDCSS) - v4 - ## Conventions -- 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. +- 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, and naming. - Use descriptive names for variables and methods. For example, `isRegisteredForDiscounts`, not `discount()`. - Check for existing components to reuse before writing a new one. @@ -30,7 +40,7 @@ This application is a Laravel application and its main Laravel ecosystems packag - Do not create verification scripts or tinker when tests cover that functionality and prove it works. Unit and feature tests are more important. ## Application Structure & Architecture -- Stick to existing directory structure - don't create new base folders without approval. +- Stick to existing directory structure; don't create new base folders without approval. - Do not change the application's dependencies without approval. ## Frontend Bundling @@ -42,17 +52,16 @@ This application is a Laravel application and its main Laravel ecosystems packag ## Documentation Files - You must only create documentation files if explicitly requested by the user. - === boost rules === ## Laravel Boost - Laravel Boost is an MCP server that comes with powerful tools designed specifically for this application. Use them. ## Artisan -- Use the `list-artisan-commands` tool when you need to call an Artisan command to double check the available parameters. +- Use the `list-artisan-commands` tool when you need to call an Artisan command to double-check the available parameters. ## URLs -- 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. +- 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. ## Tinker / Debugging - You should use the `tinker` tool when you need to execute PHP to debug code or query Eloquent models directly. @@ -63,22 +72,21 @@ This application is a Laravel application and its main Laravel ecosystems packag - Only recent browser logs will be useful - ignore old logs. ## Searching Documentation (Critically Important) -- 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. -- The 'search-docs' tool is perfect for all Laravel related packages, including Laravel, Inertia, Livewire, Filament, Tailwind, Pest, Nova, Nightwatch, etc. -- You must use this tool to search for Laravel-ecosystem documentation before falling back to other approaches. +- Boost comes with a powerful `search-docs` tool you should use before any other approaches when dealing with Laravel or Laravel ecosystem packages. This tool automatically passes a list of installed packages and their versions to the remote Boost API, so it returns only version-specific documentation for the user's circumstance. You should pass an array of packages to filter on if you know you need docs for particular packages. +- The `search-docs` tool is perfect for all Laravel-related packages, including Laravel, Inertia, Livewire, Filament, Tailwind, Pest, Nova, Nightwatch, etc. +- You must use this tool to search for Laravel ecosystem documentation before falling back to other approaches. - Search the documentation before making code changes to ensure we are taking the correct approach. -- Use multiple, broad, simple, topic based queries to start. For example: `['rate limiting', 'routing rate limiting', 'routing']`. -- Do not add package names to queries - package information is already shared. For example, use `test resource table`, not `filament 4 test resource table`. +- Use multiple, broad, simple, topic-based queries to start. For example: `['rate limiting', 'routing rate limiting', 'routing']`. +- Do not add package names to queries; package information is already shared. For example, use `test resource table`, not `filament 4 test resource table`. ### Available Search Syntax - You can and should pass multiple queries at once. The most relevant results will be returned first. -1. Simple Word Searches with auto-stemming - query=authentication - finds 'authenticate' and 'auth' -2. Multiple Words (AND Logic) - query=rate limit - finds knowledge containing both "rate" AND "limit" -3. Quoted Phrases (Exact Position) - query="infinite scroll" - Words must be adjacent and in that order -4. Mixed Queries - query=middleware "rate limit" - "middleware" AND exact phrase "rate limit" -5. Multiple Queries - queries=["authentication", "middleware"] - ANY of these terms - +1. Simple Word Searches with auto-stemming - query=authentication - finds 'authenticate' and 'auth'. +2. Multiple Words (AND Logic) - query=rate limit - finds knowledge containing both "rate" AND "limit". +3. Quoted Phrases (Exact Position) - query="infinite scroll" - words must be adjacent and in that order. +4. Mixed Queries - query=middleware "rate limit" - "middleware" AND exact phrase "rate limit". +5. Multiple Queries - queries=["authentication", "middleware"] - ANY of these terms. === php rules === @@ -89,7 +97,7 @@ This application is a Laravel application and its main Laravel ecosystems packag ### Constructors - Use PHP 8 constructor property promotion in `__construct()`. - public function __construct(public GitHub $github) { } -- Do not allow empty `__construct()` methods with zero parameters. +- Do not allow empty `__construct()` methods with zero parameters unless the constructor is private. ### Type Declarations - Always use explicit return type declarations for methods and functions. @@ -103,7 +111,7 @@ protected function isAccessible(User $user, ?string $path = null): bool ## Comments -- Prefer PHPDoc blocks over comments. Never use comments within the code itself unless there is something _very_ complex going on. +- Prefer PHPDoc blocks over inline comments. Never use comments within the code itself unless there is something very complex going on. ## PHPDoc Blocks - Add useful array shape type definitions for arrays when appropriate. @@ -111,116 +119,31 @@ protected function isAccessible(User $user, ?string $path = null): bool ## Enums - Typically, keys in an Enum should be TitleCase. For example: `FavoritePerson`, `BestLake`, `Monthly`. +=== herd rules === -=== filament/core rules === - -## Filament -- Filament is used by this application, check how and where to follow existing application conventions. -- Filament is a Server-Driven UI (SDUI) framework for Laravel. It allows developers to define user interfaces in PHP using structured configuration objects. It is built on top of Livewire, Alpine.js, and Tailwind CSS. -- You can use the `search-docs` tool to get information from the official Filament documentation when needed. This is very useful for Artisan command arguments, specific code examples, testing functionality, relationship management, and ensuring you're following idiomatic practices. -- Utilize static `make()` methods for consistent component initialization. - -### Artisan -- You must use the Filament specific Artisan commands to create new files or components for Filament. You can find these with the `list-artisan-commands` tool, or with `php artisan` and the `--help` option. -- Inspect the required options, always pass `--no-interaction`, and valid arguments for other options when applicable. - -### Filament's Core Features -- Actions: Handle doing something within the application, often with a button or link. Actions encapsulate the UI, the interactive modal window, and the logic that should be executed when the modal window is submitted. They can be used anywhere in the UI and are commonly used to perform one-time actions like deleting a record, sending an email, or updating data in the database based on modal form input. -- Forms: Dynamic forms rendered within other features, such as resources, action modals, table filters, and more. -- Infolists: Read-only lists of data. -- Notifications: Flash notifications displayed to users within the application. -- Panels: The top-level container in Filament that can include all other features like pages, resources, forms, tables, notifications, actions, infolists, and widgets. -- Resources: Static classes that are used to build CRUD interfaces for Eloquent models. Typically live in `app/Filament/Resources`. -- Schemas: Represent components that define the structure and behavior of the UI, such as forms, tables, or lists. -- Tables: Interactive tables with filtering, sorting, pagination, and more. -- Widgets: Small component included within dashboards, often used for displaying data in charts, tables, or as a stat. - -### Relationships -- Determine if you can use the `relationship()` method on form components when you need `options` for a select, checkbox, repeater, or when building a `Fieldset`: - - -Forms\Components\Select::make('user_id') - ->label('Author') - ->relationship('author') - ->required(), - - - -## Testing -- It's important to test Filament functionality for user satisfaction. -- Ensure that you are authenticated to access the application within the test. -- Filament uses Livewire, so start assertions with `livewire()` or `Livewire::test()`. - -### Example Tests - - - livewire(ListUsers::class) - ->assertCanSeeTableRecords($users) - ->searchTable($users->first()->name) - ->assertCanSeeTableRecords($users->take(1)) - ->assertCanNotSeeTableRecords($users->skip(1)) - ->searchTable($users->last()->email) - ->assertCanSeeTableRecords($users->take(-1)) - ->assertCanNotSeeTableRecords($users->take($users->count() - 1)); - - - - livewire(CreateUser::class) - ->fillForm([ - 'name' => 'Howdy', - 'email' => 'howdy@example.com', - ]) - ->call('create') - ->assertNotified() - ->assertRedirect(); - - assertDatabaseHas(User::class, [ - 'name' => 'Howdy', - 'email' => 'howdy@example.com', - ]); - - - - use Filament\Facades\Filament; - - Filament::setCurrentPanel('app'); - - - - livewire(EditInvoice::class, [ - 'invoice' => $invoice, - ])->callAction('send'); - - expect($invoice->refresh())->isSent()->toBeTrue(); - +## Laravel Herd +- The application is served by Laravel Herd and will be available at: `https?://[kebab-case-project-dir].test`. Use the `get-absolute-url` tool to generate URLs for the user to ensure valid URLs. +- You must not run any commands to make the site available via HTTP(S). It is always available through Laravel Herd. -=== filament/v3 rules === - -## Filament 3 +=== tests rules === -## Version 3 Changes To Focus On -- Resources are located in `app/Filament/Resources/` directory. -- Resource pages (List, Create, Edit) are auto-generated within the resource's directory - e.g., `app/Filament/Resources/PostResource/Pages/`. -- Forms use the `Forms\Components` namespace for form fields. -- 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 `php artisan filament:optimize` command for production optimization. -- Requires implementing `FilamentUser` contract for production access control. +## 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 `php artisan test --compact` with a specific filename or filter. === laravel/core rules === ## Do Things the Laravel Way - 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. -- If you're creating a generic PHP class, use `artisan make:class`. +- If you're creating a generic PHP class, use `php artisan 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 - Always use proper Eloquent relationship methods with return type hints. Prefer relationship methods over raw queries or manual joins. -- Use Eloquent models and relationships before suggesting raw database queries +- Use Eloquent models and relationships before suggesting raw database queries. - Avoid `DB::`; prefer `Model::query()`. Generate code that leverages Laravel's ORM capabilities rather than bypassing them. - Generate code that prevents N+1 query problems by using eager loading. - Use Laravel's query builder for very complex database operations. @@ -250,33 +173,49 @@ Forms\Components\Select::make('user_id') ### 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 `php artisan make:test [options] ` 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 `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. ### Vite Error - 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`. +=== laravel/v12 rules === -=== laravel/v10 rules === +## Laravel 12 -## Laravel 10 +- Use the `search-docs` tool to get version-specific documentation. +- This project upgraded from Laravel 10 without migrating to the new streamlined Laravel file structure. +- This is **perfectly fine** and recommended by Laravel. Follow the existing structure from Laravel 10. We do not need to migrate to the new Laravel structure unless the user explicitly requests it. -- Use the `search-docs` tool to get version specific documentation. -- Middleware typically live in `app/Http/Middleware/` and service providers in `app/Providers/`. -- There is no `bootstrap/app.php` application configuration in Laravel 10: - - Middleware registration is in `app/Http/Kernel.php` +### Laravel 10 Structure +- Middleware typically lives in `app/Http/Middleware/` and service providers in `app/Providers/`. +- There is no `bootstrap/app.php` application configuration in a Laravel 10 structure: + - Middleware registration happens in `app/Http/Kernel.php` - Exception handling is in `app/Exceptions/Handler.php` - - Console commands and schedule registration is in `app/Console/Kernel.php` + - Console commands and schedule register in `app/Console/Kernel.php` - Rate limits likely exist in `RouteServiceProvider` or `app/Http/Kernel.php` -- When using Eloquent model casts, you must use `protected $casts = [];` and not the `casts()` method. The `casts()` method isn't available on models in Laravel 10. +### Database +- 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. +- Laravel 12 allows limiting eagerly loaded records natively, without external packages: `$query->latest()->limit(10);`. + +### Models +- 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. + +=== pennant/core rules === + +## Laravel Pennant + +- This application uses Laravel Pennant for feature flag management, providing a flexible system for controlling feature availability across different organizations and user types. +- Use the `search-docs` tool, in combination with existing codebase conventions, to assist the user effectively with feature flags. === livewire/core rules === -## Livewire Core -- Use the `search-docs` tool to find exact version specific documentation for how to write Livewire & Livewire tests. -- Use the `php artisan make:livewire [Posts\\CreatePost]` artisan command to create new components +## Livewire + +- Use the `search-docs` tool to find exact version-specific documentation for how to write Livewire and Livewire tests. +- Use the `php artisan 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. +- All Livewire requests hit the Laravel backend; they're like regular HTTP requests. Always validate form data and run authorization checks in Livewire actions. ## Livewire Best Practices - Livewire components require a single root element. @@ -291,17 +230,16 @@ Forms\Components\Select::make('user_id') @endforeach ``` -- Prefer lifecycle hooks like `mount()`, `updatedFoo()`) for initialization and reactive side effects: +- Prefer lifecycle hooks like `mount()`, `updatedFoo()` for initialization and reactive side effects: - + public function mount(User $user) { $this->user = $user; } public function updatedSearch() { $this->resetPage(); } - ## Testing Livewire - + Livewire::test(Counter::class) ->assertSet('count', 0) ->call('increment') @@ -310,19 +248,17 @@ Forms\Components\Select::make('user_id') ->assertStatus(200); - - - $this->get('/posts/create') - ->assertSeeLivewire(CreatePost::class); - - + + $this->get('/posts/create') + ->assertSeeLivewire(CreatePost::class); + === livewire/v3 rules === ## Livewire 3 ### Key Changes From Livewire 2 -- These things changed in Livewire 2, but may not have been updated in this application. Verify this application's setup to ensure you conform with application conventions. +- These things changed in Livewire 3, but may not have been updated in this application. Verify this application's setup to ensure you conform with application conventions. - Use `wire:model.live` for real-time updates, `wire:model` is now deferred by default. - Components now use the `App\Livewire` namespace (not `App\Http\Livewire`). - Use `$this->dispatch()` to dispatch events (not `emit` or `dispatchBrowserEvent`). @@ -332,13 +268,13 @@ Forms\Components\Select::make('user_id') - `wire:show`, `wire:transition`, `wire:cloak`, `wire:offline`, `wire:target` are available for use. Use the documentation to find usage examples. ### Alpine -- Alpine is now included with Livewire, don't manually include Alpine.js. +- Alpine is now included with Livewire; don't manually include Alpine.js. - Plugins included with Alpine: persist, intersect, collapse, and focus. ### Lifecycle Hooks - You can listen for `livewire:init` to hook into Livewire initialization, and `fail.status === 419` for the page expiring: - + document.addEventListener('livewire:init', function () { Livewire.hook('request', ({ fail }) => { if (fail && fail.status === 419) { @@ -352,7 +288,6 @@ document.addEventListener('livewire:init', function () { }); - === pint/core rules === ## Laravel Pint Code Formatter @@ -360,50 +295,71 @@ document.addEventListener('livewire:init', function () { - You must run `vendor/bin/pint --dirty` before finalizing changes to ensure your code matches the project's expected style. - Do not run `vendor/bin/pint --test`, simply run `vendor/bin/pint` to fix any formatting issues. +=== phpunit/core rules === + +## PHPUnit + +- 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. +- 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. +- Tests should test all of the happy paths, failure paths, and weird paths. +- 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. + +### Running Tests +- Run the minimal number of tests, using an appropriate filter, before finalizing. +- To run all tests: `php artisan test --compact`. +- To run all tests in a file: `php artisan test --compact tests/Feature/ExampleTest.php`. +- To filter on a particular test name: `php artisan test --compact --filter=testName` (recommended after making a change to a related file). === tailwindcss/core rules === -## Tailwind Core +## Tailwind CSS -- Use Tailwind CSS classes to style HTML, check and use existing tailwind conventions within the project before writing your own. -- Offer to extract repeated patterns into components that match the project's conventions (i.e. Blade, JSX, Vue, etc..) -- Think through class placement, order, priority, and defaults - remove redundant classes, add classes to parent or child carefully to limit repetition, group elements logically +- Use Tailwind CSS classes to style HTML; check and use existing Tailwind conventions within the project before writing your own. +- Offer to extract repeated patterns into components that match the project's conventions (i.e. Blade, JSX, Vue, etc.). +- Think through class placement, order, priority, and defaults. Remove redundant classes, add classes to parent or child carefully to limit repetition, and group elements logically. - You can use the `search-docs` tool to get exact examples from the official documentation when needed. ### Spacing -- When listing items, use gap utilities for spacing, don't use margins. - - -
-
Superior
-
Michigan
-
Erie
-
- - +- When listing items, use gap utilities for spacing; don't use margins. + + +
+
Superior
+
Michigan
+
Erie
+
+ ### Dark Mode - If existing pages and components support dark mode, new pages and components must support dark mode in a similar way, typically using `dark:`. - === tailwindcss/v4 rules === -## Tailwind 4 +## Tailwind CSS 4 -- Always use Tailwind CSS v4 - do not use the deprecated utilities. +- Always use Tailwind CSS v4; do not use the deprecated utilities. - `corePlugins` is not supported in Tailwind v4. +- In Tailwind v4, configuration is CSS-first using the `@theme` directive — no separate `tailwind.config.js` file is needed. + + +@theme { + --color-brand: oklch(0.72 0.11 178); +} + + - In Tailwind v4, you import Tailwind using a regular CSS `@import` statement, not using the `@tailwind` directives used in v3: - - @tailwind base; - @tailwind components; - @tailwind utilities; + @import "tailwindcss"; - ### Replaced Utilities -- Tailwind v4 removed deprecated utilities. Do not use the deprecated option - use the replacement. +- Tailwind v4 removed deprecated utilities. Do not use the deprecated option; use the replacement. - Opacity values are still numeric. | Deprecated | Replacement | @@ -419,12 +375,4 @@ document.addEventListener('livewire:init', function () { | overflow-ellipsis | text-ellipsis | | decoration-slice | box-decoration-slice | | decoration-clone | box-decoration-clone | - - -=== tests rules === - -## 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 `php artisan test` with a specific filename or filter. - \ No newline at end of file + diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index bc83ebc7..126421d1 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -8,18 +8,28 @@ The Laravel Boost guidelines are specifically curated by Laravel maintainers for ## Foundational Context 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. -- php - 8.4.11 +- php - 8.4.18 - filament/filament (FILAMENT) - v3 -- laravel/framework (LARAVEL) - v10 +- laravel/cashier (CASHIER) - v15 +- laravel/framework (LARAVEL) - v12 +- laravel/horizon (HORIZON) - v5 +- laravel/nightwatch (NIGHTWATCH) - v1 +- laravel/pennant (PENNANT) - v1 - laravel/prompts (PROMPTS) - v0 +- laravel/sanctum (SANCTUM) - v4 +- laravel/socialite (SOCIALITE) - v5 - livewire/livewire (LIVEWIRE) - v3 +- laravel/mcp (MCP) - v0 - laravel/pint (PINT) - v1 +- laravel/sail (SAIL) - v1 +- phpunit/phpunit (PHPUNIT) - v11 +- rector/rector (RECTOR) - v2 - alpinejs (ALPINEJS) - v3 +- prettier (PRETTIER) - v3 - tailwindcss (TAILWINDCSS) - v4 - ## Conventions -- 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. +- 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, and naming. - Use descriptive names for variables and methods. For example, `isRegisteredForDiscounts`, not `discount()`. - Check for existing components to reuse before writing a new one. @@ -27,7 +37,7 @@ This application is a Laravel application and its main Laravel ecosystems packag - Do not create verification scripts or tinker when tests cover that functionality and prove it works. Unit and feature tests are more important. ## Application Structure & Architecture -- Stick to existing directory structure - don't create new base folders without approval. +- Stick to existing directory structure; don't create new base folders without approval. - Do not change the application's dependencies without approval. ## Frontend Bundling @@ -39,17 +49,16 @@ This application is a Laravel application and its main Laravel ecosystems packag ## Documentation Files - You must only create documentation files if explicitly requested by the user. - === boost rules === ## Laravel Boost - Laravel Boost is an MCP server that comes with powerful tools designed specifically for this application. Use them. ## Artisan -- Use the `list-artisan-commands` tool when you need to call an Artisan command to double check the available parameters. +- Use the `list-artisan-commands` tool when you need to call an Artisan command to double-check the available parameters. ## URLs -- 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. +- 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. ## Tinker / Debugging - You should use the `tinker` tool when you need to execute PHP to debug code or query Eloquent models directly. @@ -60,22 +69,21 @@ This application is a Laravel application and its main Laravel ecosystems packag - Only recent browser logs will be useful - ignore old logs. ## Searching Documentation (Critically Important) -- 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. -- The 'search-docs' tool is perfect for all Laravel related packages, including Laravel, Inertia, Livewire, Filament, Tailwind, Pest, Nova, Nightwatch, etc. -- You must use this tool to search for Laravel-ecosystem documentation before falling back to other approaches. +- Boost comes with a powerful `search-docs` tool you should use before any other approaches when dealing with Laravel or Laravel ecosystem packages. This tool automatically passes a list of installed packages and their versions to the remote Boost API, so it returns only version-specific documentation for the user's circumstance. You should pass an array of packages to filter on if you know you need docs for particular packages. +- The `search-docs` tool is perfect for all Laravel-related packages, including Laravel, Inertia, Livewire, Filament, Tailwind, Pest, Nova, Nightwatch, etc. +- You must use this tool to search for Laravel ecosystem documentation before falling back to other approaches. - Search the documentation before making code changes to ensure we are taking the correct approach. -- Use multiple, broad, simple, topic based queries to start. For example: `['rate limiting', 'routing rate limiting', 'routing']`. -- Do not add package names to queries - package information is already shared. For example, use `test resource table`, not `filament 4 test resource table`. +- Use multiple, broad, simple, topic-based queries to start. For example: `['rate limiting', 'routing rate limiting', 'routing']`. +- Do not add package names to queries; package information is already shared. For example, use `test resource table`, not `filament 4 test resource table`. ### Available Search Syntax - You can and should pass multiple queries at once. The most relevant results will be returned first. -1. Simple Word Searches with auto-stemming - query=authentication - finds 'authenticate' and 'auth' -2. Multiple Words (AND Logic) - query=rate limit - finds knowledge containing both "rate" AND "limit" -3. Quoted Phrases (Exact Position) - query="infinite scroll" - Words must be adjacent and in that order -4. Mixed Queries - query=middleware "rate limit" - "middleware" AND exact phrase "rate limit" -5. Multiple Queries - queries=["authentication", "middleware"] - ANY of these terms - +1. Simple Word Searches with auto-stemming - query=authentication - finds 'authenticate' and 'auth'. +2. Multiple Words (AND Logic) - query=rate limit - finds knowledge containing both "rate" AND "limit". +3. Quoted Phrases (Exact Position) - query="infinite scroll" - words must be adjacent and in that order. +4. Mixed Queries - query=middleware "rate limit" - "middleware" AND exact phrase "rate limit". +5. Multiple Queries - queries=["authentication", "middleware"] - ANY of these terms. === php rules === @@ -86,7 +94,7 @@ This application is a Laravel application and its main Laravel ecosystems packag ### Constructors - Use PHP 8 constructor property promotion in `__construct()`. - public function __construct(public GitHub $github) { } -- Do not allow empty `__construct()` methods with zero parameters. +- Do not allow empty `__construct()` methods with zero parameters unless the constructor is private. ### Type Declarations - Always use explicit return type declarations for methods and functions. @@ -100,7 +108,7 @@ protected function isAccessible(User $user, ?string $path = null): bool ## Comments -- Prefer PHPDoc blocks over comments. Never use comments within the code itself unless there is something _very_ complex going on. +- Prefer PHPDoc blocks over inline comments. Never use comments within the code itself unless there is something very complex going on. ## PHPDoc Blocks - Add useful array shape type definitions for arrays when appropriate. @@ -108,116 +116,31 @@ protected function isAccessible(User $user, ?string $path = null): bool ## Enums - Typically, keys in an Enum should be TitleCase. For example: `FavoritePerson`, `BestLake`, `Monthly`. +=== herd rules === -=== filament/core rules === - -## Filament -- Filament is used by this application, check how and where to follow existing application conventions. -- Filament is a Server-Driven UI (SDUI) framework for Laravel. It allows developers to define user interfaces in PHP using structured configuration objects. It is built on top of Livewire, Alpine.js, and Tailwind CSS. -- You can use the `search-docs` tool to get information from the official Filament documentation when needed. This is very useful for Artisan command arguments, specific code examples, testing functionality, relationship management, and ensuring you're following idiomatic practices. -- Utilize static `make()` methods for consistent component initialization. - -### Artisan -- You must use the Filament specific Artisan commands to create new files or components for Filament. You can find these with the `list-artisan-commands` tool, or with `php artisan` and the `--help` option. -- Inspect the required options, always pass `--no-interaction`, and valid arguments for other options when applicable. - -### Filament's Core Features -- Actions: Handle doing something within the application, often with a button or link. Actions encapsulate the UI, the interactive modal window, and the logic that should be executed when the modal window is submitted. They can be used anywhere in the UI and are commonly used to perform one-time actions like deleting a record, sending an email, or updating data in the database based on modal form input. -- Forms: Dynamic forms rendered within other features, such as resources, action modals, table filters, and more. -- Infolists: Read-only lists of data. -- Notifications: Flash notifications displayed to users within the application. -- Panels: The top-level container in Filament that can include all other features like pages, resources, forms, tables, notifications, actions, infolists, and widgets. -- Resources: Static classes that are used to build CRUD interfaces for Eloquent models. Typically live in `app/Filament/Resources`. -- Schemas: Represent components that define the structure and behavior of the UI, such as forms, tables, or lists. -- Tables: Interactive tables with filtering, sorting, pagination, and more. -- Widgets: Small component included within dashboards, often used for displaying data in charts, tables, or as a stat. - -### Relationships -- Determine if you can use the `relationship()` method on form components when you need `options` for a select, checkbox, repeater, or when building a `Fieldset`: - - -Forms\Components\Select::make('user_id') - ->label('Author') - ->relationship('author') - ->required(), - - - -## Testing -- It's important to test Filament functionality for user satisfaction. -- Ensure that you are authenticated to access the application within the test. -- Filament uses Livewire, so start assertions with `livewire()` or `Livewire::test()`. - -### Example Tests - - - livewire(ListUsers::class) - ->assertCanSeeTableRecords($users) - ->searchTable($users->first()->name) - ->assertCanSeeTableRecords($users->take(1)) - ->assertCanNotSeeTableRecords($users->skip(1)) - ->searchTable($users->last()->email) - ->assertCanSeeTableRecords($users->take(-1)) - ->assertCanNotSeeTableRecords($users->take($users->count() - 1)); - - - - livewire(CreateUser::class) - ->fillForm([ - 'name' => 'Howdy', - 'email' => 'howdy@example.com', - ]) - ->call('create') - ->assertNotified() - ->assertRedirect(); - - assertDatabaseHas(User::class, [ - 'name' => 'Howdy', - 'email' => 'howdy@example.com', - ]); - - - - use Filament\Facades\Filament; - - Filament::setCurrentPanel('app'); - - - - livewire(EditInvoice::class, [ - 'invoice' => $invoice, - ])->callAction('send'); - - expect($invoice->refresh())->isSent()->toBeTrue(); - +## Laravel Herd +- The application is served by Laravel Herd and will be available at: `https?://[kebab-case-project-dir].test`. Use the `get-absolute-url` tool to generate URLs for the user to ensure valid URLs. +- You must not run any commands to make the site available via HTTP(S). It is always available through Laravel Herd. -=== filament/v3 rules === - -## Filament 3 +=== tests rules === -## Version 3 Changes To Focus On -- Resources are located in `app/Filament/Resources/` directory. -- Resource pages (List, Create, Edit) are auto-generated within the resource's directory - e.g., `app/Filament/Resources/PostResource/Pages/`. -- Forms use the `Forms\Components` namespace for form fields. -- 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 `php artisan filament:optimize` command for production optimization. -- Requires implementing `FilamentUser` contract for production access control. +## 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 `php artisan test --compact` with a specific filename or filter. === laravel/core rules === ## Do Things the Laravel Way - 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. -- If you're creating a generic PHP class, use `artisan make:class`. +- If you're creating a generic PHP class, use `php artisan 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 - Always use proper Eloquent relationship methods with return type hints. Prefer relationship methods over raw queries or manual joins. -- Use Eloquent models and relationships before suggesting raw database queries +- Use Eloquent models and relationships before suggesting raw database queries. - Avoid `DB::`; prefer `Model::query()`. Generate code that leverages Laravel's ORM capabilities rather than bypassing them. - Generate code that prevents N+1 query problems by using eager loading. - Use Laravel's query builder for very complex database operations. @@ -247,33 +170,49 @@ Forms\Components\Select::make('user_id') ### 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 `php artisan make:test [options] ` 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 `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. ### Vite Error - 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`. +=== laravel/v12 rules === -=== laravel/v10 rules === +## Laravel 12 -## Laravel 10 +- Use the `search-docs` tool to get version-specific documentation. +- This project upgraded from Laravel 10 without migrating to the new streamlined Laravel file structure. +- This is **perfectly fine** and recommended by Laravel. Follow the existing structure from Laravel 10. We do not need to migrate to the new Laravel structure unless the user explicitly requests it. -- Use the `search-docs` tool to get version specific documentation. -- Middleware typically live in `app/Http/Middleware/` and service providers in `app/Providers/`. -- There is no `bootstrap/app.php` application configuration in Laravel 10: - - Middleware registration is in `app/Http/Kernel.php` +### Laravel 10 Structure +- Middleware typically lives in `app/Http/Middleware/` and service providers in `app/Providers/`. +- There is no `bootstrap/app.php` application configuration in a Laravel 10 structure: + - Middleware registration happens in `app/Http/Kernel.php` - Exception handling is in `app/Exceptions/Handler.php` - - Console commands and schedule registration is in `app/Console/Kernel.php` + - Console commands and schedule register in `app/Console/Kernel.php` - Rate limits likely exist in `RouteServiceProvider` or `app/Http/Kernel.php` -- When using Eloquent model casts, you must use `protected $casts = [];` and not the `casts()` method. The `casts()` method isn't available on models in Laravel 10. +### Database +- 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. +- Laravel 12 allows limiting eagerly loaded records natively, without external packages: `$query->latest()->limit(10);`. + +### Models +- 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. + +=== pennant/core rules === + +## Laravel Pennant + +- This application uses Laravel Pennant for feature flag management, providing a flexible system for controlling feature availability across different organizations and user types. +- Use the `search-docs` tool, in combination with existing codebase conventions, to assist the user effectively with feature flags. === livewire/core rules === -## Livewire Core -- Use the `search-docs` tool to find exact version specific documentation for how to write Livewire & Livewire tests. -- Use the `php artisan make:livewire [Posts\\CreatePost]` artisan command to create new components +## Livewire + +- Use the `search-docs` tool to find exact version-specific documentation for how to write Livewire and Livewire tests. +- Use the `php artisan 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. +- All Livewire requests hit the Laravel backend; they're like regular HTTP requests. Always validate form data and run authorization checks in Livewire actions. ## Livewire Best Practices - Livewire components require a single root element. @@ -288,17 +227,16 @@ Forms\Components\Select::make('user_id') @endforeach ``` -- Prefer lifecycle hooks like `mount()`, `updatedFoo()`) for initialization and reactive side effects: +- Prefer lifecycle hooks like `mount()`, `updatedFoo()` for initialization and reactive side effects: - + public function mount(User $user) { $this->user = $user; } public function updatedSearch() { $this->resetPage(); } - ## Testing Livewire - + Livewire::test(Counter::class) ->assertSet('count', 0) ->call('increment') @@ -307,19 +245,17 @@ Forms\Components\Select::make('user_id') ->assertStatus(200); - - - $this->get('/posts/create') - ->assertSeeLivewire(CreatePost::class); - - + + $this->get('/posts/create') + ->assertSeeLivewire(CreatePost::class); + === livewire/v3 rules === ## Livewire 3 ### Key Changes From Livewire 2 -- These things changed in Livewire 2, but may not have been updated in this application. Verify this application's setup to ensure you conform with application conventions. +- These things changed in Livewire 3, but may not have been updated in this application. Verify this application's setup to ensure you conform with application conventions. - Use `wire:model.live` for real-time updates, `wire:model` is now deferred by default. - Components now use the `App\Livewire` namespace (not `App\Http\Livewire`). - Use `$this->dispatch()` to dispatch events (not `emit` or `dispatchBrowserEvent`). @@ -329,13 +265,13 @@ Forms\Components\Select::make('user_id') - `wire:show`, `wire:transition`, `wire:cloak`, `wire:offline`, `wire:target` are available for use. Use the documentation to find usage examples. ### Alpine -- Alpine is now included with Livewire, don't manually include Alpine.js. +- Alpine is now included with Livewire; don't manually include Alpine.js. - Plugins included with Alpine: persist, intersect, collapse, and focus. ### Lifecycle Hooks - You can listen for `livewire:init` to hook into Livewire initialization, and `fail.status === 419` for the page expiring: - + document.addEventListener('livewire:init', function () { Livewire.hook('request', ({ fail }) => { if (fail && fail.status === 419) { @@ -349,7 +285,6 @@ document.addEventListener('livewire:init', function () { }); - === pint/core rules === ## Laravel Pint Code Formatter @@ -357,50 +292,71 @@ document.addEventListener('livewire:init', function () { - You must run `vendor/bin/pint --dirty` before finalizing changes to ensure your code matches the project's expected style. - Do not run `vendor/bin/pint --test`, simply run `vendor/bin/pint` to fix any formatting issues. +=== phpunit/core rules === + +## PHPUnit + +- 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. +- 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. +- Tests should test all of the happy paths, failure paths, and weird paths. +- 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. + +### Running Tests +- Run the minimal number of tests, using an appropriate filter, before finalizing. +- To run all tests: `php artisan test --compact`. +- To run all tests in a file: `php artisan test --compact tests/Feature/ExampleTest.php`. +- To filter on a particular test name: `php artisan test --compact --filter=testName` (recommended after making a change to a related file). === tailwindcss/core rules === -## Tailwind Core +## Tailwind CSS -- Use Tailwind CSS classes to style HTML, check and use existing tailwind conventions within the project before writing your own. -- Offer to extract repeated patterns into components that match the project's conventions (i.e. Blade, JSX, Vue, etc..) -- Think through class placement, order, priority, and defaults - remove redundant classes, add classes to parent or child carefully to limit repetition, group elements logically +- Use Tailwind CSS classes to style HTML; check and use existing Tailwind conventions within the project before writing your own. +- Offer to extract repeated patterns into components that match the project's conventions (i.e. Blade, JSX, Vue, etc.). +- Think through class placement, order, priority, and defaults. Remove redundant classes, add classes to parent or child carefully to limit repetition, and group elements logically. - You can use the `search-docs` tool to get exact examples from the official documentation when needed. ### Spacing -- When listing items, use gap utilities for spacing, don't use margins. - - -
-
Superior
-
Michigan
-
Erie
-
- - +- When listing items, use gap utilities for spacing; don't use margins. + + +
+
Superior
+
Michigan
+
Erie
+
+ ### Dark Mode - If existing pages and components support dark mode, new pages and components must support dark mode in a similar way, typically using `dark:`. - === tailwindcss/v4 rules === -## Tailwind 4 +## Tailwind CSS 4 -- Always use Tailwind CSS v4 - do not use the deprecated utilities. +- Always use Tailwind CSS v4; do not use the deprecated utilities. - `corePlugins` is not supported in Tailwind v4. +- In Tailwind v4, configuration is CSS-first using the `@theme` directive — no separate `tailwind.config.js` file is needed. + + +@theme { + --color-brand: oklch(0.72 0.11 178); +} + + - In Tailwind v4, you import Tailwind using a regular CSS `@import` statement, not using the `@tailwind` directives used in v3: - - @tailwind base; - @tailwind components; - @tailwind utilities; + @import "tailwindcss"; - ### Replaced Utilities -- Tailwind v4 removed deprecated utilities. Do not use the deprecated option - use the replacement. +- Tailwind v4 removed deprecated utilities. Do not use the deprecated option; use the replacement. - Opacity values are still numeric. | Deprecated | Replacement | @@ -416,12 +372,4 @@ document.addEventListener('livewire:init', function () { | overflow-ellipsis | text-ellipsis | | decoration-slice | box-decoration-slice | | decoration-clone | box-decoration-clone | - - -=== tests rules === - -## 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 `php artisan test` with a specific filename or filter. - \ No newline at end of file + diff --git a/.junie/guidelines.md b/.junie/guidelines.md index bc83ebc7..126421d1 100644 --- a/.junie/guidelines.md +++ b/.junie/guidelines.md @@ -8,18 +8,28 @@ The Laravel Boost guidelines are specifically curated by Laravel maintainers for ## Foundational Context 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. -- php - 8.4.11 +- php - 8.4.18 - filament/filament (FILAMENT) - v3 -- laravel/framework (LARAVEL) - v10 +- laravel/cashier (CASHIER) - v15 +- laravel/framework (LARAVEL) - v12 +- laravel/horizon (HORIZON) - v5 +- laravel/nightwatch (NIGHTWATCH) - v1 +- laravel/pennant (PENNANT) - v1 - laravel/prompts (PROMPTS) - v0 +- laravel/sanctum (SANCTUM) - v4 +- laravel/socialite (SOCIALITE) - v5 - livewire/livewire (LIVEWIRE) - v3 +- laravel/mcp (MCP) - v0 - laravel/pint (PINT) - v1 +- laravel/sail (SAIL) - v1 +- phpunit/phpunit (PHPUNIT) - v11 +- rector/rector (RECTOR) - v2 - alpinejs (ALPINEJS) - v3 +- prettier (PRETTIER) - v3 - tailwindcss (TAILWINDCSS) - v4 - ## Conventions -- 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. +- 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, and naming. - Use descriptive names for variables and methods. For example, `isRegisteredForDiscounts`, not `discount()`. - Check for existing components to reuse before writing a new one. @@ -27,7 +37,7 @@ This application is a Laravel application and its main Laravel ecosystems packag - Do not create verification scripts or tinker when tests cover that functionality and prove it works. Unit and feature tests are more important. ## Application Structure & Architecture -- Stick to existing directory structure - don't create new base folders without approval. +- Stick to existing directory structure; don't create new base folders without approval. - Do not change the application's dependencies without approval. ## Frontend Bundling @@ -39,17 +49,16 @@ This application is a Laravel application and its main Laravel ecosystems packag ## Documentation Files - You must only create documentation files if explicitly requested by the user. - === boost rules === ## Laravel Boost - Laravel Boost is an MCP server that comes with powerful tools designed specifically for this application. Use them. ## Artisan -- Use the `list-artisan-commands` tool when you need to call an Artisan command to double check the available parameters. +- Use the `list-artisan-commands` tool when you need to call an Artisan command to double-check the available parameters. ## URLs -- 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. +- 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. ## Tinker / Debugging - You should use the `tinker` tool when you need to execute PHP to debug code or query Eloquent models directly. @@ -60,22 +69,21 @@ This application is a Laravel application and its main Laravel ecosystems packag - Only recent browser logs will be useful - ignore old logs. ## Searching Documentation (Critically Important) -- 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. -- The 'search-docs' tool is perfect for all Laravel related packages, including Laravel, Inertia, Livewire, Filament, Tailwind, Pest, Nova, Nightwatch, etc. -- You must use this tool to search for Laravel-ecosystem documentation before falling back to other approaches. +- Boost comes with a powerful `search-docs` tool you should use before any other approaches when dealing with Laravel or Laravel ecosystem packages. This tool automatically passes a list of installed packages and their versions to the remote Boost API, so it returns only version-specific documentation for the user's circumstance. You should pass an array of packages to filter on if you know you need docs for particular packages. +- The `search-docs` tool is perfect for all Laravel-related packages, including Laravel, Inertia, Livewire, Filament, Tailwind, Pest, Nova, Nightwatch, etc. +- You must use this tool to search for Laravel ecosystem documentation before falling back to other approaches. - Search the documentation before making code changes to ensure we are taking the correct approach. -- Use multiple, broad, simple, topic based queries to start. For example: `['rate limiting', 'routing rate limiting', 'routing']`. -- Do not add package names to queries - package information is already shared. For example, use `test resource table`, not `filament 4 test resource table`. +- Use multiple, broad, simple, topic-based queries to start. For example: `['rate limiting', 'routing rate limiting', 'routing']`. +- Do not add package names to queries; package information is already shared. For example, use `test resource table`, not `filament 4 test resource table`. ### Available Search Syntax - You can and should pass multiple queries at once. The most relevant results will be returned first. -1. Simple Word Searches with auto-stemming - query=authentication - finds 'authenticate' and 'auth' -2. Multiple Words (AND Logic) - query=rate limit - finds knowledge containing both "rate" AND "limit" -3. Quoted Phrases (Exact Position) - query="infinite scroll" - Words must be adjacent and in that order -4. Mixed Queries - query=middleware "rate limit" - "middleware" AND exact phrase "rate limit" -5. Multiple Queries - queries=["authentication", "middleware"] - ANY of these terms - +1. Simple Word Searches with auto-stemming - query=authentication - finds 'authenticate' and 'auth'. +2. Multiple Words (AND Logic) - query=rate limit - finds knowledge containing both "rate" AND "limit". +3. Quoted Phrases (Exact Position) - query="infinite scroll" - words must be adjacent and in that order. +4. Mixed Queries - query=middleware "rate limit" - "middleware" AND exact phrase "rate limit". +5. Multiple Queries - queries=["authentication", "middleware"] - ANY of these terms. === php rules === @@ -86,7 +94,7 @@ This application is a Laravel application and its main Laravel ecosystems packag ### Constructors - Use PHP 8 constructor property promotion in `__construct()`. - public function __construct(public GitHub $github) { } -- Do not allow empty `__construct()` methods with zero parameters. +- Do not allow empty `__construct()` methods with zero parameters unless the constructor is private. ### Type Declarations - Always use explicit return type declarations for methods and functions. @@ -100,7 +108,7 @@ protected function isAccessible(User $user, ?string $path = null): bool ## Comments -- Prefer PHPDoc blocks over comments. Never use comments within the code itself unless there is something _very_ complex going on. +- Prefer PHPDoc blocks over inline comments. Never use comments within the code itself unless there is something very complex going on. ## PHPDoc Blocks - Add useful array shape type definitions for arrays when appropriate. @@ -108,116 +116,31 @@ protected function isAccessible(User $user, ?string $path = null): bool ## Enums - Typically, keys in an Enum should be TitleCase. For example: `FavoritePerson`, `BestLake`, `Monthly`. +=== herd rules === -=== filament/core rules === - -## Filament -- Filament is used by this application, check how and where to follow existing application conventions. -- Filament is a Server-Driven UI (SDUI) framework for Laravel. It allows developers to define user interfaces in PHP using structured configuration objects. It is built on top of Livewire, Alpine.js, and Tailwind CSS. -- You can use the `search-docs` tool to get information from the official Filament documentation when needed. This is very useful for Artisan command arguments, specific code examples, testing functionality, relationship management, and ensuring you're following idiomatic practices. -- Utilize static `make()` methods for consistent component initialization. - -### Artisan -- You must use the Filament specific Artisan commands to create new files or components for Filament. You can find these with the `list-artisan-commands` tool, or with `php artisan` and the `--help` option. -- Inspect the required options, always pass `--no-interaction`, and valid arguments for other options when applicable. - -### Filament's Core Features -- Actions: Handle doing something within the application, often with a button or link. Actions encapsulate the UI, the interactive modal window, and the logic that should be executed when the modal window is submitted. They can be used anywhere in the UI and are commonly used to perform one-time actions like deleting a record, sending an email, or updating data in the database based on modal form input. -- Forms: Dynamic forms rendered within other features, such as resources, action modals, table filters, and more. -- Infolists: Read-only lists of data. -- Notifications: Flash notifications displayed to users within the application. -- Panels: The top-level container in Filament that can include all other features like pages, resources, forms, tables, notifications, actions, infolists, and widgets. -- Resources: Static classes that are used to build CRUD interfaces for Eloquent models. Typically live in `app/Filament/Resources`. -- Schemas: Represent components that define the structure and behavior of the UI, such as forms, tables, or lists. -- Tables: Interactive tables with filtering, sorting, pagination, and more. -- Widgets: Small component included within dashboards, often used for displaying data in charts, tables, or as a stat. - -### Relationships -- Determine if you can use the `relationship()` method on form components when you need `options` for a select, checkbox, repeater, or when building a `Fieldset`: - - -Forms\Components\Select::make('user_id') - ->label('Author') - ->relationship('author') - ->required(), - - - -## Testing -- It's important to test Filament functionality for user satisfaction. -- Ensure that you are authenticated to access the application within the test. -- Filament uses Livewire, so start assertions with `livewire()` or `Livewire::test()`. - -### Example Tests - - - livewire(ListUsers::class) - ->assertCanSeeTableRecords($users) - ->searchTable($users->first()->name) - ->assertCanSeeTableRecords($users->take(1)) - ->assertCanNotSeeTableRecords($users->skip(1)) - ->searchTable($users->last()->email) - ->assertCanSeeTableRecords($users->take(-1)) - ->assertCanNotSeeTableRecords($users->take($users->count() - 1)); - - - - livewire(CreateUser::class) - ->fillForm([ - 'name' => 'Howdy', - 'email' => 'howdy@example.com', - ]) - ->call('create') - ->assertNotified() - ->assertRedirect(); - - assertDatabaseHas(User::class, [ - 'name' => 'Howdy', - 'email' => 'howdy@example.com', - ]); - - - - use Filament\Facades\Filament; - - Filament::setCurrentPanel('app'); - - - - livewire(EditInvoice::class, [ - 'invoice' => $invoice, - ])->callAction('send'); - - expect($invoice->refresh())->isSent()->toBeTrue(); - +## Laravel Herd +- The application is served by Laravel Herd and will be available at: `https?://[kebab-case-project-dir].test`. Use the `get-absolute-url` tool to generate URLs for the user to ensure valid URLs. +- You must not run any commands to make the site available via HTTP(S). It is always available through Laravel Herd. -=== filament/v3 rules === - -## Filament 3 +=== tests rules === -## Version 3 Changes To Focus On -- Resources are located in `app/Filament/Resources/` directory. -- Resource pages (List, Create, Edit) are auto-generated within the resource's directory - e.g., `app/Filament/Resources/PostResource/Pages/`. -- Forms use the `Forms\Components` namespace for form fields. -- 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 `php artisan filament:optimize` command for production optimization. -- Requires implementing `FilamentUser` contract for production access control. +## 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 `php artisan test --compact` with a specific filename or filter. === laravel/core rules === ## Do Things the Laravel Way - 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. -- If you're creating a generic PHP class, use `artisan make:class`. +- If you're creating a generic PHP class, use `php artisan 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 - Always use proper Eloquent relationship methods with return type hints. Prefer relationship methods over raw queries or manual joins. -- Use Eloquent models and relationships before suggesting raw database queries +- Use Eloquent models and relationships before suggesting raw database queries. - Avoid `DB::`; prefer `Model::query()`. Generate code that leverages Laravel's ORM capabilities rather than bypassing them. - Generate code that prevents N+1 query problems by using eager loading. - Use Laravel's query builder for very complex database operations. @@ -247,33 +170,49 @@ Forms\Components\Select::make('user_id') ### 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 `php artisan make:test [options] ` 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 `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. ### Vite Error - 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`. +=== laravel/v12 rules === -=== laravel/v10 rules === +## Laravel 12 -## Laravel 10 +- Use the `search-docs` tool to get version-specific documentation. +- This project upgraded from Laravel 10 without migrating to the new streamlined Laravel file structure. +- This is **perfectly fine** and recommended by Laravel. Follow the existing structure from Laravel 10. We do not need to migrate to the new Laravel structure unless the user explicitly requests it. -- Use the `search-docs` tool to get version specific documentation. -- Middleware typically live in `app/Http/Middleware/` and service providers in `app/Providers/`. -- There is no `bootstrap/app.php` application configuration in Laravel 10: - - Middleware registration is in `app/Http/Kernel.php` +### Laravel 10 Structure +- Middleware typically lives in `app/Http/Middleware/` and service providers in `app/Providers/`. +- There is no `bootstrap/app.php` application configuration in a Laravel 10 structure: + - Middleware registration happens in `app/Http/Kernel.php` - Exception handling is in `app/Exceptions/Handler.php` - - Console commands and schedule registration is in `app/Console/Kernel.php` + - Console commands and schedule register in `app/Console/Kernel.php` - Rate limits likely exist in `RouteServiceProvider` or `app/Http/Kernel.php` -- When using Eloquent model casts, you must use `protected $casts = [];` and not the `casts()` method. The `casts()` method isn't available on models in Laravel 10. +### Database +- 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. +- Laravel 12 allows limiting eagerly loaded records natively, without external packages: `$query->latest()->limit(10);`. + +### Models +- 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. + +=== pennant/core rules === + +## Laravel Pennant + +- This application uses Laravel Pennant for feature flag management, providing a flexible system for controlling feature availability across different organizations and user types. +- Use the `search-docs` tool, in combination with existing codebase conventions, to assist the user effectively with feature flags. === livewire/core rules === -## Livewire Core -- Use the `search-docs` tool to find exact version specific documentation for how to write Livewire & Livewire tests. -- Use the `php artisan make:livewire [Posts\\CreatePost]` artisan command to create new components +## Livewire + +- Use the `search-docs` tool to find exact version-specific documentation for how to write Livewire and Livewire tests. +- Use the `php artisan 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. +- All Livewire requests hit the Laravel backend; they're like regular HTTP requests. Always validate form data and run authorization checks in Livewire actions. ## Livewire Best Practices - Livewire components require a single root element. @@ -288,17 +227,16 @@ Forms\Components\Select::make('user_id') @endforeach ``` -- Prefer lifecycle hooks like `mount()`, `updatedFoo()`) for initialization and reactive side effects: +- Prefer lifecycle hooks like `mount()`, `updatedFoo()` for initialization and reactive side effects: - + public function mount(User $user) { $this->user = $user; } public function updatedSearch() { $this->resetPage(); } - ## Testing Livewire - + Livewire::test(Counter::class) ->assertSet('count', 0) ->call('increment') @@ -307,19 +245,17 @@ Forms\Components\Select::make('user_id') ->assertStatus(200); - - - $this->get('/posts/create') - ->assertSeeLivewire(CreatePost::class); - - + + $this->get('/posts/create') + ->assertSeeLivewire(CreatePost::class); + === livewire/v3 rules === ## Livewire 3 ### Key Changes From Livewire 2 -- These things changed in Livewire 2, but may not have been updated in this application. Verify this application's setup to ensure you conform with application conventions. +- These things changed in Livewire 3, but may not have been updated in this application. Verify this application's setup to ensure you conform with application conventions. - Use `wire:model.live` for real-time updates, `wire:model` is now deferred by default. - Components now use the `App\Livewire` namespace (not `App\Http\Livewire`). - Use `$this->dispatch()` to dispatch events (not `emit` or `dispatchBrowserEvent`). @@ -329,13 +265,13 @@ Forms\Components\Select::make('user_id') - `wire:show`, `wire:transition`, `wire:cloak`, `wire:offline`, `wire:target` are available for use. Use the documentation to find usage examples. ### Alpine -- Alpine is now included with Livewire, don't manually include Alpine.js. +- Alpine is now included with Livewire; don't manually include Alpine.js. - Plugins included with Alpine: persist, intersect, collapse, and focus. ### Lifecycle Hooks - You can listen for `livewire:init` to hook into Livewire initialization, and `fail.status === 419` for the page expiring: - + document.addEventListener('livewire:init', function () { Livewire.hook('request', ({ fail }) => { if (fail && fail.status === 419) { @@ -349,7 +285,6 @@ document.addEventListener('livewire:init', function () { }); - === pint/core rules === ## Laravel Pint Code Formatter @@ -357,50 +292,71 @@ document.addEventListener('livewire:init', function () { - You must run `vendor/bin/pint --dirty` before finalizing changes to ensure your code matches the project's expected style. - Do not run `vendor/bin/pint --test`, simply run `vendor/bin/pint` to fix any formatting issues. +=== phpunit/core rules === + +## PHPUnit + +- 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. +- 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. +- Tests should test all of the happy paths, failure paths, and weird paths. +- 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. + +### Running Tests +- Run the minimal number of tests, using an appropriate filter, before finalizing. +- To run all tests: `php artisan test --compact`. +- To run all tests in a file: `php artisan test --compact tests/Feature/ExampleTest.php`. +- To filter on a particular test name: `php artisan test --compact --filter=testName` (recommended after making a change to a related file). === tailwindcss/core rules === -## Tailwind Core +## Tailwind CSS -- Use Tailwind CSS classes to style HTML, check and use existing tailwind conventions within the project before writing your own. -- Offer to extract repeated patterns into components that match the project's conventions (i.e. Blade, JSX, Vue, etc..) -- Think through class placement, order, priority, and defaults - remove redundant classes, add classes to parent or child carefully to limit repetition, group elements logically +- Use Tailwind CSS classes to style HTML; check and use existing Tailwind conventions within the project before writing your own. +- Offer to extract repeated patterns into components that match the project's conventions (i.e. Blade, JSX, Vue, etc.). +- Think through class placement, order, priority, and defaults. Remove redundant classes, add classes to parent or child carefully to limit repetition, and group elements logically. - You can use the `search-docs` tool to get exact examples from the official documentation when needed. ### Spacing -- When listing items, use gap utilities for spacing, don't use margins. - - -
-
Superior
-
Michigan
-
Erie
-
- - +- When listing items, use gap utilities for spacing; don't use margins. + + +
+
Superior
+
Michigan
+
Erie
+
+ ### Dark Mode - If existing pages and components support dark mode, new pages and components must support dark mode in a similar way, typically using `dark:`. - === tailwindcss/v4 rules === -## Tailwind 4 +## Tailwind CSS 4 -- Always use Tailwind CSS v4 - do not use the deprecated utilities. +- Always use Tailwind CSS v4; do not use the deprecated utilities. - `corePlugins` is not supported in Tailwind v4. +- In Tailwind v4, configuration is CSS-first using the `@theme` directive — no separate `tailwind.config.js` file is needed. + + +@theme { + --color-brand: oklch(0.72 0.11 178); +} + + - In Tailwind v4, you import Tailwind using a regular CSS `@import` statement, not using the `@tailwind` directives used in v3: - - @tailwind base; - @tailwind components; - @tailwind utilities; + @import "tailwindcss"; - ### Replaced Utilities -- Tailwind v4 removed deprecated utilities. Do not use the deprecated option - use the replacement. +- Tailwind v4 removed deprecated utilities. Do not use the deprecated option; use the replacement. - Opacity values are still numeric. | Deprecated | Replacement | @@ -416,12 +372,4 @@ document.addEventListener('livewire:init', function () { | overflow-ellipsis | text-ellipsis | | decoration-slice | box-decoration-slice | | decoration-clone | box-decoration-clone | - - -=== tests rules === - -## 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 `php artisan test` with a specific filename or filter. - \ No newline at end of file + diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000..126421d1 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,375 @@ + +=== foundation rules === + +# Laravel Boost Guidelines + +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. + +## Foundational Context +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. + +- php - 8.4.18 +- filament/filament (FILAMENT) - v3 +- laravel/cashier (CASHIER) - v15 +- laravel/framework (LARAVEL) - v12 +- laravel/horizon (HORIZON) - v5 +- laravel/nightwatch (NIGHTWATCH) - v1 +- laravel/pennant (PENNANT) - v1 +- laravel/prompts (PROMPTS) - v0 +- laravel/sanctum (SANCTUM) - v4 +- laravel/socialite (SOCIALITE) - v5 +- livewire/livewire (LIVEWIRE) - v3 +- laravel/mcp (MCP) - v0 +- laravel/pint (PINT) - v1 +- laravel/sail (SAIL) - v1 +- phpunit/phpunit (PHPUNIT) - v11 +- rector/rector (RECTOR) - v2 +- alpinejs (ALPINEJS) - v3 +- prettier (PRETTIER) - v3 +- tailwindcss (TAILWINDCSS) - v4 + +## Conventions +- 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, and naming. +- Use descriptive names for variables and methods. For example, `isRegisteredForDiscounts`, not `discount()`. +- Check for existing components to reuse before writing a new one. + +## Verification Scripts +- Do not create verification scripts or tinker when tests cover that functionality and prove it works. Unit and feature tests are more important. + +## Application Structure & Architecture +- Stick to existing directory structure; don't create new base folders without approval. +- Do not change the application's dependencies without approval. + +## Frontend Bundling +- 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. + +## Replies +- Be concise in your explanations - focus on what's important rather than explaining obvious details. + +## Documentation Files +- You must only create documentation files if explicitly requested by the user. + +=== boost rules === + +## Laravel Boost +- Laravel Boost is an MCP server that comes with powerful tools designed specifically for this application. Use them. + +## Artisan +- Use the `list-artisan-commands` tool when you need to call an Artisan command to double-check the available parameters. + +## URLs +- 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. + +## Tinker / Debugging +- You should use the `tinker` tool when you need to execute PHP to debug code or query Eloquent models directly. +- Use the `database-query` tool when you only need to read from the database. + +## Reading Browser Logs With the `browser-logs` Tool +- You can read browser logs, errors, and exceptions using the `browser-logs` tool from Boost. +- Only recent browser logs will be useful - ignore old logs. + +## Searching Documentation (Critically Important) +- Boost comes with a powerful `search-docs` tool you should use before any other approaches when dealing with Laravel or Laravel ecosystem packages. This tool automatically passes a list of installed packages and their versions to the remote Boost API, so it returns only version-specific documentation for the user's circumstance. You should pass an array of packages to filter on if you know you need docs for particular packages. +- The `search-docs` tool is perfect for all Laravel-related packages, including Laravel, Inertia, Livewire, Filament, Tailwind, Pest, Nova, Nightwatch, etc. +- You must use this tool to search for Laravel ecosystem documentation before falling back to other approaches. +- Search the documentation before making code changes to ensure we are taking the correct approach. +- Use multiple, broad, simple, topic-based queries to start. For example: `['rate limiting', 'routing rate limiting', 'routing']`. +- Do not add package names to queries; package information is already shared. For example, use `test resource table`, not `filament 4 test resource table`. + +### Available Search Syntax +- You can and should pass multiple queries at once. The most relevant results will be returned first. + +1. Simple Word Searches with auto-stemming - query=authentication - finds 'authenticate' and 'auth'. +2. Multiple Words (AND Logic) - query=rate limit - finds knowledge containing both "rate" AND "limit". +3. Quoted Phrases (Exact Position) - query="infinite scroll" - words must be adjacent and in that order. +4. Mixed Queries - query=middleware "rate limit" - "middleware" AND exact phrase "rate limit". +5. Multiple Queries - queries=["authentication", "middleware"] - ANY of these terms. + +=== php rules === + +## PHP + +- Always use curly braces for control structures, even if it has one line. + +### Constructors +- Use PHP 8 constructor property promotion in `__construct()`. + - public function __construct(public GitHub $github) { } +- Do not allow empty `__construct()` methods with zero parameters unless the constructor is private. + +### Type Declarations +- Always use explicit return type declarations for methods and functions. +- Use appropriate PHP type hints for method parameters. + + +protected function isAccessible(User $user, ?string $path = null): bool +{ + ... +} + + +## Comments +- Prefer PHPDoc blocks over inline comments. Never use comments within the code itself unless there is something very complex going on. + +## PHPDoc Blocks +- Add useful array shape type definitions for arrays when appropriate. + +## Enums +- Typically, keys in an Enum should be TitleCase. For example: `FavoritePerson`, `BestLake`, `Monthly`. + +=== herd rules === + +## Laravel Herd + +- The application is served by Laravel Herd and will be available at: `https?://[kebab-case-project-dir].test`. Use the `get-absolute-url` tool to generate URLs for the user to ensure valid URLs. +- You must not run any commands to make the site available via HTTP(S). It is always available through Laravel Herd. + +=== tests rules === + +## 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 `php artisan test --compact` with a specific filename or filter. + +=== laravel/core rules === + +## Do Things the Laravel Way + +- 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. +- If you're creating a generic PHP class, use `php artisan 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 +- Always use proper Eloquent relationship methods with return type hints. Prefer relationship methods over raw queries or manual joins. +- Use Eloquent models and relationships before suggesting raw database queries. +- Avoid `DB::`; prefer `Model::query()`. Generate code that leverages Laravel's ORM capabilities rather than bypassing them. +- Generate code that prevents N+1 query problems by using eager loading. +- 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 `php artisan 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. + +### Controllers & Validation +- Always create Form Request classes for validation rather than inline validation in controllers. Include both validation rules and custom error messages. +- Check sibling Form Requests to see if the application uses array or string based validation rules. + +### Queues +- Use queued jobs for time-consuming operations with the `ShouldQueue` interface. + +### Authentication & Authorization +- Use Laravel's built-in authentication and authorization features (gates, policies, Sanctum, etc.). + +### URL Generation +- When generating links to other pages, prefer named routes and the `route()` function. + +### Configuration +- 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')`. + +### 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 `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. + +### Vite Error +- 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`. + +=== laravel/v12 rules === + +## Laravel 12 + +- Use the `search-docs` tool to get version-specific documentation. +- This project upgraded from Laravel 10 without migrating to the new streamlined Laravel file structure. +- This is **perfectly fine** and recommended by Laravel. Follow the existing structure from Laravel 10. We do not need to migrate to the new Laravel structure unless the user explicitly requests it. + +### Laravel 10 Structure +- Middleware typically lives in `app/Http/Middleware/` and service providers in `app/Providers/`. +- There is no `bootstrap/app.php` application configuration in a Laravel 10 structure: + - Middleware registration happens in `app/Http/Kernel.php` + - Exception handling is in `app/Exceptions/Handler.php` + - Console commands and schedule register in `app/Console/Kernel.php` + - Rate limits likely exist in `RouteServiceProvider` or `app/Http/Kernel.php` + +### Database +- 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. +- Laravel 12 allows limiting eagerly loaded records natively, without external packages: `$query->latest()->limit(10);`. + +### Models +- 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. + +=== pennant/core rules === + +## Laravel Pennant + +- This application uses Laravel Pennant for feature flag management, providing a flexible system for controlling feature availability across different organizations and user types. +- Use the `search-docs` tool, in combination with existing codebase conventions, to assist the user effectively with feature flags. + +=== livewire/core rules === + +## Livewire + +- Use the `search-docs` tool to find exact version-specific documentation for how to write Livewire and Livewire tests. +- Use the `php artisan 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. + +## Livewire Best Practices +- Livewire components require a single root element. +- Use `wire:loading` and `wire:dirty` for delightful loading states. +- Add `wire:key` in loops: + + ```blade + @foreach ($items as $item) +
+ {{ $item->name }} +
+ @endforeach + ``` + +- Prefer lifecycle hooks like `mount()`, `updatedFoo()` for initialization and reactive side effects: + + + public function mount(User $user) { $this->user = $user; } + public function updatedSearch() { $this->resetPage(); } + + +## Testing Livewire + + + Livewire::test(Counter::class) + ->assertSet('count', 0) + ->call('increment') + ->assertSet('count', 1) + ->assertSee(1) + ->assertStatus(200); + + + + $this->get('/posts/create') + ->assertSeeLivewire(CreatePost::class); + + +=== livewire/v3 rules === + +## Livewire 3 + +### Key Changes From Livewire 2 +- These things changed in Livewire 3, but may not have been updated in this application. Verify this application's setup to ensure you conform with application conventions. + - Use `wire:model.live` for real-time updates, `wire:model` is now deferred by default. + - Components now use the `App\Livewire` namespace (not `App\Http\Livewire`). + - Use `$this->dispatch()` to dispatch events (not `emit` or `dispatchBrowserEvent`). + - Use the `components.layouts.app` view as the typical layout path (not `layouts.app`). + +### New Directives +- `wire:show`, `wire:transition`, `wire:cloak`, `wire:offline`, `wire:target` are available for use. Use the documentation to find usage examples. + +### Alpine +- Alpine is now included with Livewire; don't manually include Alpine.js. +- Plugins included with Alpine: persist, intersect, collapse, and focus. + +### Lifecycle Hooks +- You can listen for `livewire:init` to hook into Livewire initialization, and `fail.status === 419` for the page expiring: + + +document.addEventListener('livewire:init', function () { + Livewire.hook('request', ({ fail }) => { + if (fail && fail.status === 419) { + alert('Your session expired'); + } + }); + + Livewire.hook('message.failed', (message, component) => { + console.error(message); + }); +}); + + +=== pint/core rules === + +## Laravel Pint Code Formatter + +- You must run `vendor/bin/pint --dirty` before finalizing changes to ensure your code matches the project's expected style. +- Do not run `vendor/bin/pint --test`, simply run `vendor/bin/pint` to fix any formatting issues. + +=== phpunit/core rules === + +## PHPUnit + +- 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. +- 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. +- Tests should test all of the happy paths, failure paths, and weird paths. +- 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. + +### Running Tests +- Run the minimal number of tests, using an appropriate filter, before finalizing. +- To run all tests: `php artisan test --compact`. +- To run all tests in a file: `php artisan test --compact tests/Feature/ExampleTest.php`. +- To filter on a particular test name: `php artisan test --compact --filter=testName` (recommended after making a change to a related file). + +=== tailwindcss/core rules === + +## Tailwind CSS + +- Use Tailwind CSS classes to style HTML; check and use existing Tailwind conventions within the project before writing your own. +- Offer to extract repeated patterns into components that match the project's conventions (i.e. Blade, JSX, Vue, etc.). +- Think through class placement, order, priority, and defaults. Remove redundant classes, add classes to parent or child carefully to limit repetition, and group elements logically. +- You can use the `search-docs` tool to get exact examples from the official documentation when needed. + +### Spacing +- When listing items, use gap utilities for spacing; don't use margins. + + +
+
Superior
+
Michigan
+
Erie
+
+ + +### Dark Mode +- If existing pages and components support dark mode, new pages and components must support dark mode in a similar way, typically using `dark:`. + +=== tailwindcss/v4 rules === + +## Tailwind CSS 4 + +- Always use Tailwind CSS v4; do not use the deprecated utilities. +- `corePlugins` is not supported in Tailwind v4. +- In Tailwind v4, configuration is CSS-first using the `@theme` directive — no separate `tailwind.config.js` file is needed. + + +@theme { + --color-brand: oklch(0.72 0.11 178); +} + + +- In Tailwind v4, you import Tailwind using a regular CSS `@import` statement, not using the `@tailwind` directives used in v3: + + + - @tailwind base; + - @tailwind components; + - @tailwind utilities; + + @import "tailwindcss"; + + +### Replaced Utilities +- Tailwind v4 removed deprecated utilities. Do not use the deprecated option; use the replacement. +- Opacity values are still numeric. + +| Deprecated | Replacement | +|------------+--------------| +| bg-opacity-* | bg-black/* | +| text-opacity-* | text-black/* | +| border-opacity-* | border-black/* | +| divide-opacity-* | divide-black/* | +| ring-opacity-* | ring-black/* | +| placeholder-opacity-* | placeholder-black/* | +| flex-shrink-* | shrink-* | +| flex-grow-* | grow-* | +| overflow-ellipsis | text-ellipsis | +| decoration-slice | box-decoration-slice | +| decoration-clone | box-decoration-clone | + diff --git a/CLAUDE.md b/CLAUDE.md index bc83ebc7..126421d1 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -8,18 +8,28 @@ The Laravel Boost guidelines are specifically curated by Laravel maintainers for ## Foundational Context 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. -- php - 8.4.11 +- php - 8.4.18 - filament/filament (FILAMENT) - v3 -- laravel/framework (LARAVEL) - v10 +- laravel/cashier (CASHIER) - v15 +- laravel/framework (LARAVEL) - v12 +- laravel/horizon (HORIZON) - v5 +- laravel/nightwatch (NIGHTWATCH) - v1 +- laravel/pennant (PENNANT) - v1 - laravel/prompts (PROMPTS) - v0 +- laravel/sanctum (SANCTUM) - v4 +- laravel/socialite (SOCIALITE) - v5 - livewire/livewire (LIVEWIRE) - v3 +- laravel/mcp (MCP) - v0 - laravel/pint (PINT) - v1 +- laravel/sail (SAIL) - v1 +- phpunit/phpunit (PHPUNIT) - v11 +- rector/rector (RECTOR) - v2 - alpinejs (ALPINEJS) - v3 +- prettier (PRETTIER) - v3 - tailwindcss (TAILWINDCSS) - v4 - ## Conventions -- 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. +- 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, and naming. - Use descriptive names for variables and methods. For example, `isRegisteredForDiscounts`, not `discount()`. - Check for existing components to reuse before writing a new one. @@ -27,7 +37,7 @@ This application is a Laravel application and its main Laravel ecosystems packag - Do not create verification scripts or tinker when tests cover that functionality and prove it works. Unit and feature tests are more important. ## Application Structure & Architecture -- Stick to existing directory structure - don't create new base folders without approval. +- Stick to existing directory structure; don't create new base folders without approval. - Do not change the application's dependencies without approval. ## Frontend Bundling @@ -39,17 +49,16 @@ This application is a Laravel application and its main Laravel ecosystems packag ## Documentation Files - You must only create documentation files if explicitly requested by the user. - === boost rules === ## Laravel Boost - Laravel Boost is an MCP server that comes with powerful tools designed specifically for this application. Use them. ## Artisan -- Use the `list-artisan-commands` tool when you need to call an Artisan command to double check the available parameters. +- Use the `list-artisan-commands` tool when you need to call an Artisan command to double-check the available parameters. ## URLs -- 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. +- 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. ## Tinker / Debugging - You should use the `tinker` tool when you need to execute PHP to debug code or query Eloquent models directly. @@ -60,22 +69,21 @@ This application is a Laravel application and its main Laravel ecosystems packag - Only recent browser logs will be useful - ignore old logs. ## Searching Documentation (Critically Important) -- 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. -- The 'search-docs' tool is perfect for all Laravel related packages, including Laravel, Inertia, Livewire, Filament, Tailwind, Pest, Nova, Nightwatch, etc. -- You must use this tool to search for Laravel-ecosystem documentation before falling back to other approaches. +- Boost comes with a powerful `search-docs` tool you should use before any other approaches when dealing with Laravel or Laravel ecosystem packages. This tool automatically passes a list of installed packages and their versions to the remote Boost API, so it returns only version-specific documentation for the user's circumstance. You should pass an array of packages to filter on if you know you need docs for particular packages. +- The `search-docs` tool is perfect for all Laravel-related packages, including Laravel, Inertia, Livewire, Filament, Tailwind, Pest, Nova, Nightwatch, etc. +- You must use this tool to search for Laravel ecosystem documentation before falling back to other approaches. - Search the documentation before making code changes to ensure we are taking the correct approach. -- Use multiple, broad, simple, topic based queries to start. For example: `['rate limiting', 'routing rate limiting', 'routing']`. -- Do not add package names to queries - package information is already shared. For example, use `test resource table`, not `filament 4 test resource table`. +- Use multiple, broad, simple, topic-based queries to start. For example: `['rate limiting', 'routing rate limiting', 'routing']`. +- Do not add package names to queries; package information is already shared. For example, use `test resource table`, not `filament 4 test resource table`. ### Available Search Syntax - You can and should pass multiple queries at once. The most relevant results will be returned first. -1. Simple Word Searches with auto-stemming - query=authentication - finds 'authenticate' and 'auth' -2. Multiple Words (AND Logic) - query=rate limit - finds knowledge containing both "rate" AND "limit" -3. Quoted Phrases (Exact Position) - query="infinite scroll" - Words must be adjacent and in that order -4. Mixed Queries - query=middleware "rate limit" - "middleware" AND exact phrase "rate limit" -5. Multiple Queries - queries=["authentication", "middleware"] - ANY of these terms - +1. Simple Word Searches with auto-stemming - query=authentication - finds 'authenticate' and 'auth'. +2. Multiple Words (AND Logic) - query=rate limit - finds knowledge containing both "rate" AND "limit". +3. Quoted Phrases (Exact Position) - query="infinite scroll" - words must be adjacent and in that order. +4. Mixed Queries - query=middleware "rate limit" - "middleware" AND exact phrase "rate limit". +5. Multiple Queries - queries=["authentication", "middleware"] - ANY of these terms. === php rules === @@ -86,7 +94,7 @@ This application is a Laravel application and its main Laravel ecosystems packag ### Constructors - Use PHP 8 constructor property promotion in `__construct()`. - public function __construct(public GitHub $github) { } -- Do not allow empty `__construct()` methods with zero parameters. +- Do not allow empty `__construct()` methods with zero parameters unless the constructor is private. ### Type Declarations - Always use explicit return type declarations for methods and functions. @@ -100,7 +108,7 @@ protected function isAccessible(User $user, ?string $path = null): bool ## Comments -- Prefer PHPDoc blocks over comments. Never use comments within the code itself unless there is something _very_ complex going on. +- Prefer PHPDoc blocks over inline comments. Never use comments within the code itself unless there is something very complex going on. ## PHPDoc Blocks - Add useful array shape type definitions for arrays when appropriate. @@ -108,116 +116,31 @@ protected function isAccessible(User $user, ?string $path = null): bool ## Enums - Typically, keys in an Enum should be TitleCase. For example: `FavoritePerson`, `BestLake`, `Monthly`. +=== herd rules === -=== filament/core rules === - -## Filament -- Filament is used by this application, check how and where to follow existing application conventions. -- Filament is a Server-Driven UI (SDUI) framework for Laravel. It allows developers to define user interfaces in PHP using structured configuration objects. It is built on top of Livewire, Alpine.js, and Tailwind CSS. -- You can use the `search-docs` tool to get information from the official Filament documentation when needed. This is very useful for Artisan command arguments, specific code examples, testing functionality, relationship management, and ensuring you're following idiomatic practices. -- Utilize static `make()` methods for consistent component initialization. - -### Artisan -- You must use the Filament specific Artisan commands to create new files or components for Filament. You can find these with the `list-artisan-commands` tool, or with `php artisan` and the `--help` option. -- Inspect the required options, always pass `--no-interaction`, and valid arguments for other options when applicable. - -### Filament's Core Features -- Actions: Handle doing something within the application, often with a button or link. Actions encapsulate the UI, the interactive modal window, and the logic that should be executed when the modal window is submitted. They can be used anywhere in the UI and are commonly used to perform one-time actions like deleting a record, sending an email, or updating data in the database based on modal form input. -- Forms: Dynamic forms rendered within other features, such as resources, action modals, table filters, and more. -- Infolists: Read-only lists of data. -- Notifications: Flash notifications displayed to users within the application. -- Panels: The top-level container in Filament that can include all other features like pages, resources, forms, tables, notifications, actions, infolists, and widgets. -- Resources: Static classes that are used to build CRUD interfaces for Eloquent models. Typically live in `app/Filament/Resources`. -- Schemas: Represent components that define the structure and behavior of the UI, such as forms, tables, or lists. -- Tables: Interactive tables with filtering, sorting, pagination, and more. -- Widgets: Small component included within dashboards, often used for displaying data in charts, tables, or as a stat. - -### Relationships -- Determine if you can use the `relationship()` method on form components when you need `options` for a select, checkbox, repeater, or when building a `Fieldset`: - - -Forms\Components\Select::make('user_id') - ->label('Author') - ->relationship('author') - ->required(), - - - -## Testing -- It's important to test Filament functionality for user satisfaction. -- Ensure that you are authenticated to access the application within the test. -- Filament uses Livewire, so start assertions with `livewire()` or `Livewire::test()`. - -### Example Tests - - - livewire(ListUsers::class) - ->assertCanSeeTableRecords($users) - ->searchTable($users->first()->name) - ->assertCanSeeTableRecords($users->take(1)) - ->assertCanNotSeeTableRecords($users->skip(1)) - ->searchTable($users->last()->email) - ->assertCanSeeTableRecords($users->take(-1)) - ->assertCanNotSeeTableRecords($users->take($users->count() - 1)); - - - - livewire(CreateUser::class) - ->fillForm([ - 'name' => 'Howdy', - 'email' => 'howdy@example.com', - ]) - ->call('create') - ->assertNotified() - ->assertRedirect(); - - assertDatabaseHas(User::class, [ - 'name' => 'Howdy', - 'email' => 'howdy@example.com', - ]); - - - - use Filament\Facades\Filament; - - Filament::setCurrentPanel('app'); - - - - livewire(EditInvoice::class, [ - 'invoice' => $invoice, - ])->callAction('send'); - - expect($invoice->refresh())->isSent()->toBeTrue(); - +## Laravel Herd +- The application is served by Laravel Herd and will be available at: `https?://[kebab-case-project-dir].test`. Use the `get-absolute-url` tool to generate URLs for the user to ensure valid URLs. +- You must not run any commands to make the site available via HTTP(S). It is always available through Laravel Herd. -=== filament/v3 rules === - -## Filament 3 +=== tests rules === -## Version 3 Changes To Focus On -- Resources are located in `app/Filament/Resources/` directory. -- Resource pages (List, Create, Edit) are auto-generated within the resource's directory - e.g., `app/Filament/Resources/PostResource/Pages/`. -- Forms use the `Forms\Components` namespace for form fields. -- 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 `php artisan filament:optimize` command for production optimization. -- Requires implementing `FilamentUser` contract for production access control. +## 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 `php artisan test --compact` with a specific filename or filter. === laravel/core rules === ## Do Things the Laravel Way - 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. -- If you're creating a generic PHP class, use `artisan make:class`. +- If you're creating a generic PHP class, use `php artisan 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 - Always use proper Eloquent relationship methods with return type hints. Prefer relationship methods over raw queries or manual joins. -- Use Eloquent models and relationships before suggesting raw database queries +- Use Eloquent models and relationships before suggesting raw database queries. - Avoid `DB::`; prefer `Model::query()`. Generate code that leverages Laravel's ORM capabilities rather than bypassing them. - Generate code that prevents N+1 query problems by using eager loading. - Use Laravel's query builder for very complex database operations. @@ -247,33 +170,49 @@ Forms\Components\Select::make('user_id') ### 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 `php artisan make:test [options] ` 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 `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. ### Vite Error - 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`. +=== laravel/v12 rules === -=== laravel/v10 rules === +## Laravel 12 -## Laravel 10 +- Use the `search-docs` tool to get version-specific documentation. +- This project upgraded from Laravel 10 without migrating to the new streamlined Laravel file structure. +- This is **perfectly fine** and recommended by Laravel. Follow the existing structure from Laravel 10. We do not need to migrate to the new Laravel structure unless the user explicitly requests it. -- Use the `search-docs` tool to get version specific documentation. -- Middleware typically live in `app/Http/Middleware/` and service providers in `app/Providers/`. -- There is no `bootstrap/app.php` application configuration in Laravel 10: - - Middleware registration is in `app/Http/Kernel.php` +### Laravel 10 Structure +- Middleware typically lives in `app/Http/Middleware/` and service providers in `app/Providers/`. +- There is no `bootstrap/app.php` application configuration in a Laravel 10 structure: + - Middleware registration happens in `app/Http/Kernel.php` - Exception handling is in `app/Exceptions/Handler.php` - - Console commands and schedule registration is in `app/Console/Kernel.php` + - Console commands and schedule register in `app/Console/Kernel.php` - Rate limits likely exist in `RouteServiceProvider` or `app/Http/Kernel.php` -- When using Eloquent model casts, you must use `protected $casts = [];` and not the `casts()` method. The `casts()` method isn't available on models in Laravel 10. +### Database +- 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. +- Laravel 12 allows limiting eagerly loaded records natively, without external packages: `$query->latest()->limit(10);`. + +### Models +- 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. + +=== pennant/core rules === + +## Laravel Pennant + +- This application uses Laravel Pennant for feature flag management, providing a flexible system for controlling feature availability across different organizations and user types. +- Use the `search-docs` tool, in combination with existing codebase conventions, to assist the user effectively with feature flags. === livewire/core rules === -## Livewire Core -- Use the `search-docs` tool to find exact version specific documentation for how to write Livewire & Livewire tests. -- Use the `php artisan make:livewire [Posts\\CreatePost]` artisan command to create new components +## Livewire + +- Use the `search-docs` tool to find exact version-specific documentation for how to write Livewire and Livewire tests. +- Use the `php artisan 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. +- All Livewire requests hit the Laravel backend; they're like regular HTTP requests. Always validate form data and run authorization checks in Livewire actions. ## Livewire Best Practices - Livewire components require a single root element. @@ -288,17 +227,16 @@ Forms\Components\Select::make('user_id') @endforeach ``` -- Prefer lifecycle hooks like `mount()`, `updatedFoo()`) for initialization and reactive side effects: +- Prefer lifecycle hooks like `mount()`, `updatedFoo()` for initialization and reactive side effects: - + public function mount(User $user) { $this->user = $user; } public function updatedSearch() { $this->resetPage(); } - ## Testing Livewire - + Livewire::test(Counter::class) ->assertSet('count', 0) ->call('increment') @@ -307,19 +245,17 @@ Forms\Components\Select::make('user_id') ->assertStatus(200); - - - $this->get('/posts/create') - ->assertSeeLivewire(CreatePost::class); - - + + $this->get('/posts/create') + ->assertSeeLivewire(CreatePost::class); + === livewire/v3 rules === ## Livewire 3 ### Key Changes From Livewire 2 -- These things changed in Livewire 2, but may not have been updated in this application. Verify this application's setup to ensure you conform with application conventions. +- These things changed in Livewire 3, but may not have been updated in this application. Verify this application's setup to ensure you conform with application conventions. - Use `wire:model.live` for real-time updates, `wire:model` is now deferred by default. - Components now use the `App\Livewire` namespace (not `App\Http\Livewire`). - Use `$this->dispatch()` to dispatch events (not `emit` or `dispatchBrowserEvent`). @@ -329,13 +265,13 @@ Forms\Components\Select::make('user_id') - `wire:show`, `wire:transition`, `wire:cloak`, `wire:offline`, `wire:target` are available for use. Use the documentation to find usage examples. ### Alpine -- Alpine is now included with Livewire, don't manually include Alpine.js. +- Alpine is now included with Livewire; don't manually include Alpine.js. - Plugins included with Alpine: persist, intersect, collapse, and focus. ### Lifecycle Hooks - You can listen for `livewire:init` to hook into Livewire initialization, and `fail.status === 419` for the page expiring: - + document.addEventListener('livewire:init', function () { Livewire.hook('request', ({ fail }) => { if (fail && fail.status === 419) { @@ -349,7 +285,6 @@ document.addEventListener('livewire:init', function () { }); - === pint/core rules === ## Laravel Pint Code Formatter @@ -357,50 +292,71 @@ document.addEventListener('livewire:init', function () { - You must run `vendor/bin/pint --dirty` before finalizing changes to ensure your code matches the project's expected style. - Do not run `vendor/bin/pint --test`, simply run `vendor/bin/pint` to fix any formatting issues. +=== phpunit/core rules === + +## PHPUnit + +- 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. +- 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. +- Tests should test all of the happy paths, failure paths, and weird paths. +- 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. + +### Running Tests +- Run the minimal number of tests, using an appropriate filter, before finalizing. +- To run all tests: `php artisan test --compact`. +- To run all tests in a file: `php artisan test --compact tests/Feature/ExampleTest.php`. +- To filter on a particular test name: `php artisan test --compact --filter=testName` (recommended after making a change to a related file). === tailwindcss/core rules === -## Tailwind Core +## Tailwind CSS -- Use Tailwind CSS classes to style HTML, check and use existing tailwind conventions within the project before writing your own. -- Offer to extract repeated patterns into components that match the project's conventions (i.e. Blade, JSX, Vue, etc..) -- Think through class placement, order, priority, and defaults - remove redundant classes, add classes to parent or child carefully to limit repetition, group elements logically +- Use Tailwind CSS classes to style HTML; check and use existing Tailwind conventions within the project before writing your own. +- Offer to extract repeated patterns into components that match the project's conventions (i.e. Blade, JSX, Vue, etc.). +- Think through class placement, order, priority, and defaults. Remove redundant classes, add classes to parent or child carefully to limit repetition, and group elements logically. - You can use the `search-docs` tool to get exact examples from the official documentation when needed. ### Spacing -- When listing items, use gap utilities for spacing, don't use margins. - - -
-
Superior
-
Michigan
-
Erie
-
- - +- When listing items, use gap utilities for spacing; don't use margins. + + +
+
Superior
+
Michigan
+
Erie
+
+ ### Dark Mode - If existing pages and components support dark mode, new pages and components must support dark mode in a similar way, typically using `dark:`. - === tailwindcss/v4 rules === -## Tailwind 4 +## Tailwind CSS 4 -- Always use Tailwind CSS v4 - do not use the deprecated utilities. +- Always use Tailwind CSS v4; do not use the deprecated utilities. - `corePlugins` is not supported in Tailwind v4. +- In Tailwind v4, configuration is CSS-first using the `@theme` directive — no separate `tailwind.config.js` file is needed. + + +@theme { + --color-brand: oklch(0.72 0.11 178); +} + + - In Tailwind v4, you import Tailwind using a regular CSS `@import` statement, not using the `@tailwind` directives used in v3: - - @tailwind base; - @tailwind components; - @tailwind utilities; + @import "tailwindcss"; - ### Replaced Utilities -- Tailwind v4 removed deprecated utilities. Do not use the deprecated option - use the replacement. +- Tailwind v4 removed deprecated utilities. Do not use the deprecated option; use the replacement. - Opacity values are still numeric. | Deprecated | Replacement | @@ -416,12 +372,4 @@ document.addEventListener('livewire:init', function () { | overflow-ellipsis | text-ellipsis | | decoration-slice | box-decoration-slice | | decoration-clone | box-decoration-clone | - - -=== tests rules === - -## 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 `php artisan test` with a specific filename or filter. - \ No newline at end of file + diff --git a/app/Http/Controllers/CustomerLicenseController.php b/app/Http/Controllers/CustomerLicenseController.php index 11a3b238..62cc960a 100644 --- a/app/Http/Controllers/CustomerLicenseController.php +++ b/app/Http/Controllers/CustomerLicenseController.php @@ -31,9 +31,13 @@ public function index(): View // Get subscription plan name $subscriptionName = null; if ($activeSubscription) { - try { - $subscriptionName = \App\Enums\Subscription::fromStripePriceId($activeSubscription->stripe_price)->name(); - } catch (\RuntimeException) { + if ($activeSubscription->stripe_price) { + try { + $subscriptionName = \App\Enums\Subscription::fromStripePriceId($activeSubscription->stripe_price)->name(); + } catch (\RuntimeException) { + $subscriptionName = ucfirst($activeSubscription->type); + } + } else { $subscriptionName = ucfirst($activeSubscription->type); } } diff --git a/boost.json b/boost.json new file mode 100644 index 00000000..836a4274 --- /dev/null +++ b/boost.json @@ -0,0 +1,10 @@ +{ + "agents": [ + "claude_code", + "copilot", + "cursor", + "opencode", + "phpstorm" + ], + "guidelines": [] +} diff --git a/database/migrations/2026_03_07_143318_seed_masterclass_product.php b/database/migrations/2026_03_07_143318_seed_masterclass_product.php new file mode 100644 index 00000000..a730980b --- /dev/null +++ b/database/migrations/2026_03_07_143318_seed_masterclass_product.php @@ -0,0 +1,43 @@ + 'The NativePHP Masterclass', + 'slug' => 'nativephp-masterclass', + 'description' => 'Go from zero to published app. Learn to build native mobile and desktop applications using the PHP and Laravel skills you already have.', + 'is_active' => true, + 'published_at' => now(), + ]); + + ProductPrice::create([ + 'product_id' => $product->id, + 'tier' => 'regular', + 'amount' => 9900, + 'currency' => 'USD', + 'is_active' => true, + ]); + } + + /** + * Reverse the migrations. + */ + public function down(): void + { + $product = Product::where('slug', 'nativephp-masterclass')->first(); + + if ($product) { + $product->prices()->delete(); + $product->delete(); + } + } +}; diff --git a/resources/views/course.blade.php b/resources/views/course.blade.php new file mode 100644 index 00000000..c29e5393 --- /dev/null +++ b/resources/views/course.blade.php @@ -0,0 +1,713 @@ + +
+ {{-- Hero Section --}} +
+
+ {{-- Badge --}} +
+ + + + + Early Bird Pricing Available +
+ + {{-- Title --}} +

+ The + + NativePHP + +
+ Masterclass +

+ + {{-- Subtitle --}} +

+ Go from zero to published app. Learn to build native mobile + and desktop applications using the PHP and Laravel skills you + already have. +

+ + {{-- CTA --}} +
+ + Get Early Bird Access — $99 + + + + + + or join the waitlist + +
+
+
+ + {{-- What You'll Learn --}} +
+
+

+ What You'll Learn +

+

+ A complete curriculum taking you from setup to the app stores +

+
+ +
+ {{-- Module 1 --}} +
+
+ + + +
+

+ Getting Started +

+

+ Install NativePHP, configure your environment for mobile + and desktop, and run your first native app in minutes. +

+
+ + {{-- Module 2 --}} +
+
+ + + + +
+

+ Building for Mobile +

+

+ Build iOS and Android apps with Livewire and Blade. + Learn navigation patterns, gestures, and mobile-first UI. +

+
+ + {{-- Module 3 --}} +
+
+ + + +
+

+ Building for Desktop +

+

+ Create macOS, Windows, and Linux desktop apps. Window + management, menus, system tray, and file system access. +

+
+ + {{-- Module 4 --}} +
+
+ + + + +
+

+ Native APIs +

+

+ Access the camera, push notifications, biometrics, + haptics, sharing, and more — all from PHP. +

+
+ + {{-- Module 5 --}} +
+
+ + + +
+

+ Plugins & Extensibility +

+

+ Extend your app with the NativePHP plugin ecosystem. + Learn to use and build plugins for custom native features. +

+
+ + {{-- Module 6 --}} +
+
+ + + + +
+

+ Deploy & Publish +

+

+ Ship to the App Store, Google Play, and desktop platforms. + Use Bifrost for cloud builds and continuous deployment. +

+
+
+
+ + {{-- Who It's For --}} +
+
+

+ Who Is This For? +

+

+ This masterclass is built for developers who want to go + native without starting from scratch +

+
+ +
+ {{-- Persona 1 --}} +
+
+ + + +
+

+ Laravel Developers +

+

+ You already build web apps with Laravel. Now you want to + ship real native mobile and desktop apps — without + learning Swift, Kotlin, or Dart. +

+
+ + {{-- Persona 2 --}} +
+
+ + + +
+

+ PHP Developers +

+

+ You know PHP inside and out. This course shows you how + to leverage that expertise to build apps that run natively + on any device. +

+
+ + {{-- Persona 3 --}} +
+
+ + + + +
+

+ Web Developers +

+

+ Tired of being told you need to learn a completely new + stack for native apps? This course proves you don't. +

+
+
+
+ + {{-- Pricing --}} +
+
+

+ Simple Pricing +

+

+ One price. Full access. No subscriptions. +

+
+ +
+
+ {{-- Badge --}} +
+ EARLY BIRD +
+ +

+ The NativePHP Masterclass +

+ +
+ + $99 + + + one-time payment + +
+ +
    +
  • + + Full mobile + desktop curriculum +
    • +
  • + + Lifetime access to all content +
    • +
  • + + Future updates included +
    • +
  • + + Source code for all example projects +
    • +
  • + + Access to private community +
    • +
+ +
+ @csrf + +
+ +

+ Early bird pricing won't last forever. Lock in the lowest price today. +

+
+
+
+ + {{-- Email Signup --}} +
+
+

+ Not Ready to Buy? +

+

+ Join the waitlist and we'll let you know when the masterclass + launches, plus get exclusive early access content. +

+ +
+ + + {{-- Honeypot --}} +
+ + +
+ + +
+
+
+
+ diff --git a/routes/web.php b/routes/web.php index de78bb68..ee216d70 100644 --- a/routes/web.php +++ b/routes/web.php @@ -64,6 +64,68 @@ Route::view('/', 'welcome')->name('welcome'); Route::redirect('pricing', 'blog/nativephp-for-mobile-is-now-free')->name('pricing'); Route::view('alt-pricing', 'alt-pricing')->name('alt-pricing')->middleware('signed'); +Route::view('course', 'course')->name('course'); + +Route::post('course/checkout', function (\Illuminate\Http\Request $request) { + $user = $request->user(); + + if (! $user) { + session(['url.intended' => route('course')]); + + return to_route('customer.login') + ->with('message', 'Please log in or create an account to complete your purchase.'); + } + + $product = \App\Models\Product::where('slug', 'nativephp-masterclass')->firstOrFail(); + + if ($product->isOwnedBy($user)) { + return to_route('course')->with('error', 'You already own this course.'); + } + + $cartService = resolve(\App\Services\CartService::class); + $cart = $cartService->getCart($user); + $cartService->addProduct($cart, $product); + + $cart->load('items.product'); + $item = $cart->items->where('product_id', $product->id)->first(); + + $user->createOrGetStripeCustomer(); + + $metadata = ['cart_id' => (string) $cart->id]; + + $session = \Laravel\Cashier\Cashier::stripe()->checkout->sessions->create([ + 'mode' => 'payment', + 'line_items' => [[ + 'price_data' => [ + 'currency' => strtolower($item->currency), + 'unit_amount' => $item->product_price_at_addition, + 'product_data' => [ + 'name' => $product->name, + 'description' => $product->description, + ], + ], + 'quantity' => 1, + ]], + 'success_url' => route('course').'?purchased=1', + 'cancel_url' => route('course'), + 'customer' => $user->stripe_id, + 'metadata' => $metadata, + 'allow_promotion_codes' => true, + 'billing_address_collection' => 'required', + 'invoice_creation' => [ + 'enabled' => true, + 'invoice_data' => [ + 'description' => 'NativePHP Masterclass Purchase', + 'metadata' => $metadata, + ], + ], + ]); + + $cart->update(['stripe_checkout_session_id' => $session->id]); + + return redirect($session->url); +})->name('course.checkout'); + Route::view('wall-of-love', 'wall-of-love')->name('wall-of-love'); Route::view('brand', 'brand')->name('brand'); Route::get('showcase/{platform?}', [App\Http\Controllers\ShowcaseController::class, 'index']) diff --git a/tests/Feature/CoursePageTest.php b/tests/Feature/CoursePageTest.php new file mode 100644 index 00000000..8eb19c19 --- /dev/null +++ b/tests/Feature/CoursePageTest.php @@ -0,0 +1,51 @@ +withoutVite() + ->get(route('course')) + ->assertStatus(200) + ->assertSee('The NativePHP Masterclass') + ->assertSee('Early Bird'); + } + + #[Test] + public function course_page_contains_mailcoach_signup_form(): void + { + $this + ->withoutVite() + ->get(route('course')) + ->assertSee('simonhamp.mailcoach.app/subscribe/', false) + ->assertSee('Join Waitlist'); + } + + #[Test] + public function course_page_contains_checkout_form(): void + { + $this + ->withoutVite() + ->get(route('course')) + ->assertSee(route('course.checkout'), false) + ->assertSee('Get Early Bird Access'); + } + + #[Test] + public function course_checkout_redirects_guests_to_login(): void + { + $this + ->post(route('course.checkout')) + ->assertRedirect(route('customer.login')); + } +} From f0a5477a0699c24290357a23a1c58a79ad00bf6b Mon Sep 17 00:00:00 2001 From: Simon Hamp Date: Sat, 7 Mar 2026 14:51:11 +0000 Subject: [PATCH 2/7] Add Learn link to main nav, mobile menu, and footer Co-Authored-By: Claude Opus 4.6 --- resources/views/components/footer.blade.php | 8 +++++++ .../components/navbar/mobile-menu.blade.php | 24 +++++++++++++++++++ .../views/components/navigation-bar.blade.php | 19 +++++++++++++++ 3 files changed, 51 insertions(+) diff --git a/resources/views/components/footer.blade.php b/resources/views/components/footer.blade.php index 7fd3d6c1..7c464943 100644 --- a/resources/views/components/footer.blade.php +++ b/resources/views/components/footer.blade.php @@ -239,6 +239,14 @@ class="inline-block px-px py-1.5 transition duration-300 will-change-transform h Develop +
  • + + Learn + +
  • routeIs('blog*'); $isPartnersActive = request()->routeIs('partners*'); $isServicesActive = request()->routeIs('build-my-app'); + $isCourseActive = request()->routeIs('course'); $isSponsorActive = request()->routeIs('sponsoring*'); $isLoginActive = request()->routeIs('customer.login*'); @endphp @@ -244,6 +245,29 @@ class="size-4 shrink-0" + {{-- Course Link --}} + + {{-- Login/Dashboard --}} @feature(App\Features\ShowAuthButtons::class)
    diff --git a/resources/views/components/navigation-bar.blade.php b/resources/views/components/navigation-bar.blade.php index 3161cba3..42365db3 100644 --- a/resources/views/components/navigation-bar.blade.php +++ b/resources/views/components/navigation-bar.blade.php @@ -162,6 +162,25 @@ class="size-[3px] rotate-45 rounded-xs bg-gray-400 transition duration-200 dark: Develop + {{-- Decorative circle --}} + + + {{-- Link --}} + request()->routeIs('course'), + 'opacity-60 hover:opacity-100' => ! request()->routeIs('course'), + ]) + aria-current="{{ request()->routeIs('course') ? 'page' : 'false' }}" + > + Learn + + {{-- Login/Logout --}} @feature(App\Features\ShowAuthButtons::class) {{-- Decorative circle --}} From 29ed8b87dacf2ae432422c7b62efc49901cd1222 Mon Sep 17 00:00:00 2001 From: Simon Hamp Date: Sat, 7 Mar 2026 15:05:24 +0000 Subject: [PATCH 3/7] Update masterclass price to $101 Co-Authored-By: Claude Opus 4.6 --- .../migrations/2026_03_07_143318_seed_masterclass_product.php | 2 +- resources/views/course.blade.php | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/database/migrations/2026_03_07_143318_seed_masterclass_product.php b/database/migrations/2026_03_07_143318_seed_masterclass_product.php index a730980b..3a9f362b 100644 --- a/database/migrations/2026_03_07_143318_seed_masterclass_product.php +++ b/database/migrations/2026_03_07_143318_seed_masterclass_product.php @@ -22,7 +22,7 @@ public function up(): void ProductPrice::create([ 'product_id' => $product->id, 'tier' => 'regular', - 'amount' => 9900, + 'amount' => 10100, 'currency' => 'USD', 'is_active' => true, ]); diff --git a/resources/views/course.blade.php b/resources/views/course.blade.php index c29e5393..e1a0d5d5 100644 --- a/resources/views/course.blade.php +++ b/resources/views/course.blade.php @@ -116,7 +116,7 @@ class="mt-8 flex flex-col items-center gap-4 sm:flex-row" href="#pricing" class="inline-flex items-center gap-2 rounded-xl bg-emerald-600 px-8 py-4 font-semibold text-white transition hover:bg-emerald-700" > - Get Early Bird Access — $99 + Get Early Bird Access — $101 - $99 + $101 one-time payment From 8ad7453b051384fd9e54897db286eb793fcaa880 Mon Sep 17 00:00:00 2001 From: Simon Hamp Date: Sun, 8 Mar 2026 15:16:18 +0000 Subject: [PATCH 4/7] Auto-submit checkout after login/registration flow Co-Authored-By: Claude Opus 4.6 --- resources/views/course.blade.php | 9 +++++++++ routes/web.php | 2 +- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/resources/views/course.blade.php b/resources/views/course.blade.php index e1a0d5d5..4946b403 100644 --- a/resources/views/course.blade.php +++ b/resources/views/course.blade.php @@ -609,6 +609,7 @@ class="mx-auto mt-10 max-w-lg" action="{{ route('course.checkout') }}" method="POST" class="mt-8" + id="checkout-form" > @csrf
  • diff --git a/resources/views/components/layout.blade.php b/resources/views/components/layout.blade.php index 6e32a6fd..5b218a8d 100644 --- a/resources/views/components/layout.blade.php +++ b/resources/views/components/layout.blade.php @@ -104,7 +104,7 @@ }" x-resize=" width = $width - if (width >= 1024) { + if (width >= 1280) { showMobileMenu = false showDocsMenu = false } diff --git a/resources/views/components/navbar/mobile-menu.blade.php b/resources/views/components/navbar/mobile-menu.blade.php index ea929e33..b174d2ef 100644 --- a/resources/views/components/navbar/mobile-menu.blade.php +++ b/resources/views/components/navbar/mobile-menu.blade.php @@ -264,7 +264,10 @@ class="size-4 shrink-0" /> @endif -
    Learn
    +
    + Learn + New +
    diff --git a/resources/views/components/navigation-bar.blade.php b/resources/views/components/navigation-bar.blade.php index 42365db3..65f18de9 100644 --- a/resources/views/components/navigation-bar.blade.php +++ b/resources/views/components/navigation-bar.blade.php @@ -178,7 +178,10 @@ class="size-[3px] rotate-45 rounded-xs bg-gray-400 transition duration-200 dark: ]) aria-current="{{ request()->routeIs('course') ? 'page' : 'false' }}" > - Learn + + Learn + New + {{-- Login/Logout --}} From e378c6bdfcd70a736210d4a0738e4717e0382a9c Mon Sep 17 00:00:00 2001 From: Simon Hamp Date: Mon, 9 Mar 2026 15:40:35 +0000 Subject: [PATCH 7/7] Add post-purchase flow with sync license creation (#276) * Add post-purchase flow with sync license creation and success banner Co-Authored-By: Claude Opus 4.6 * Redirect course checkout to cart success page for webhook-based purchase confirmation Instead of synchronously creating licenses on the /course page after Stripe checkout, redirect to the existing cart/success page that polls for webhook confirmation. Co-Authored-By: Claude Opus 4.6 --------- Co-authored-by: Claude Opus 4.6 --- resources/views/course.blade.php | 6 ++++ routes/web.php | 2 +- tests/Feature/CoursePageTest.php | 58 ++++++++++++++++++++++++++++++++ 3 files changed, 65 insertions(+), 1 deletion(-) diff --git a/resources/views/course.blade.php b/resources/views/course.blade.php index 6d8c1d8e..3f404c70 100644 --- a/resources/views/course.blade.php +++ b/resources/views/course.blade.php @@ -1,5 +1,11 @@
    + @if (session('error')) +
    + {{ session('error') }} +
    + @endif + {{-- Hero Section --}}
    1, ]], - 'success_url' => route('course').'?purchased=1', + 'success_url' => route('cart.success').'?session_id={CHECKOUT_SESSION_ID}', 'cancel_url' => route('course'), 'customer' => $user->stripe_id, 'metadata' => $metadata, diff --git a/tests/Feature/CoursePageTest.php b/tests/Feature/CoursePageTest.php index 8eb19c19..5d3c1ee7 100644 --- a/tests/Feature/CoursePageTest.php +++ b/tests/Feature/CoursePageTest.php @@ -2,6 +2,7 @@ namespace Tests\Feature; +use App\Models\User; use Illuminate\Foundation\Testing\RefreshDatabase; use PHPUnit\Framework\Attributes\Test; use Tests\TestCase; @@ -48,4 +49,61 @@ public function course_checkout_redirects_guests_to_login(): void ->post(route('course.checkout')) ->assertRedirect(route('customer.login')); } + + #[Test] + public function course_checkout_redirects_to_stripe_with_cart_success_url(): void + { + $user = User::factory()->create(['stripe_id' => 'cus_test123']); + + $stripeSessionUrl = 'https://checkout.stripe.com/test-session'; + $capturedParams = null; + + $mockCheckoutSessions = new class($stripeSessionUrl, $capturedParams) + { + public function __construct( + private string $url, + private &$capturedParams, + ) {} + + public function create(array $params): object + { + $this->capturedParams = $params; + + return (object) [ + 'id' => 'cs_test123', + 'url' => $this->url, + ]; + } + }; + + $mockCheckout = new \stdClass; + $mockCheckout->sessions = $mockCheckoutSessions; + + $mockCustomers = new class + { + public function retrieve(): \Stripe\Customer + { + return \Stripe\Customer::constructFrom([ + 'id' => 'cus_test123', + 'name' => 'Test User', + 'email' => 'test@example.com', + ]); + } + }; + + $mockStripeClient = $this->createMock(\Stripe\StripeClient::class); + $mockStripeClient->checkout = $mockCheckout; + $mockStripeClient->customers = $mockCustomers; + + $this->app->bind(\Stripe\StripeClient::class, fn () => $mockStripeClient); + + $this + ->actingAs($user) + ->post(route('course.checkout')) + ->assertRedirect($stripeSessionUrl); + + $this->assertNotNull($capturedParams, 'Stripe checkout session should have been created'); + $this->assertStringContainsString(route('cart.success'), $capturedParams['success_url']); + $this->assertStringContainsString('{CHECKOUT_SESSION_ID}', $capturedParams['success_url']); + } }