formatting

Author: taylorotwell

.ai/core.blade.php

@@ -1,29 +1,30 @@
 # Laravel Boost Guidelines
-The Laravel Boost Guidelines are specifically curated by Laravel maintainers for this project. These guidelines should be followed closely to help enhance the user's experience and satisfaction.
+
+The Laravel Boost guidelines are specifically curated by Laravel maintainers for this application. These guidelines should be followed closely to help enhance the user's experience and satisfaction building Laravel applications.
 
 ## Foundational Context
-This project is a Laravel app and its main Laravel ecosystems package & versions are below. You are an expert with them all. Ensure we abide by these specific packages & versions.
+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 - {{ PHP_VERSION }}
 @foreach (app(\Laravel\Roster\Roster::class)->packages()->unique(fn ($package) => $package->rawName()) as $package)
 - {{ $package->rawName() }} ({{ $package->name() }}) - v{{ $package->majorVersion() }}
 @endforeach
 
-@if(!empty(config('boost.project_purpose')))
-    Project purpose: {!! config('boost.project_purpose') !!}
+@if (! empty(config('boost.purpose')))
+Application purpose: {!! config('boost.purpose') !!}
 @endif
 
 ## Conventions
-- You must follow all existing code conventions used in this project. When creating or editing a file, check sibling files for the correct structure, approach, naming.
-- Use descriptive names. For example, `isRegisteredForDiscounts` not `discount()`.
-- Check for existing components to reuse before writing one anew.
+- 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.
+- 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.
 
-## Project Structure and Architecture
-- Stick to existing directory structure - no new base folders without approval.
-- No dependency changes without approval.
+## 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.
 
 ## Replies
 - Be concise in your explanations - focus on what's important rather than explaining obvious details.

.ai/enforce-tests.blade.php

@@ -1,2 +1,4 @@
-- 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.
+## 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.

.ai/php/8.4/core.blade.php

@@ -1,15 +1,17 @@
-## PHP 8.4 has new array functions that will make code simpler whenever we don't use Collections
+## PHP 8.4
 
-- `array_find(array $array, callable $callback): mixed` - Find first matching element
-- `array_find_key(array $array, callable $callback): int|string|null` - Find first matching key
-- `array_any(array $array, callable $callback): bool` - Check if any element satisfies a callback function
-- `array_all(array $array, callable $callback): bool` - Check if all elements satisfy a callback function
+- PHP 8.4 has new array functions that will make code simpler whenever we don't use Laravel's collections.
+    - `array_find(array $array, callable $callback): mixed` - Find first matching element
+    - `array_find_key(array $array, callable $callback): int|string|null` - Find first matching key
+    - `array_any(array $array, callable $callback): bool` - Check if any element satisfies a callback function
+    - `array_all(array $array, callable $callback): bool` - Check if all elements satisfy a callback function
 
-## Make use of cleaner chaining on new instances
-<code-snippet name="No extra parentheses needed for chaining on new instances" lang="php">
-// Before
+### Cleaner Chaining on New Instances
+- No extra parentheses are needed when chaining on new object instances:
+<code-snippet name="New Object Chaining Example" lang="php">
+// Before PHP 8.4
 $response = (new JsonResponse(['data' => $data]))->setStatusCode(201);
 
-// After
+// After PHP 8.4
 $response = new JsonResponse(['data' => $data])->setStatusCode(201);
 </code-snippet>

.ai/php/core.blade.php

@@ -1,36 +1,38 @@
+## PHP
+
 @php
 /** @var \Laravel\Boost\Install\GuidelineAssist $assist */
 @endphp
-
 @if($assist->shouldEnforceStrictTypes())
-- Always use strict typing at the head of a .php file: `declare(strict_types=1);`.
+- Always use strict typing at the head of a `.php` file: `declare(strict_types=1);`.
 @endif
 - Always use curly braces for control structures, even if it has one line.
 
-## Constructors
+### Constructors
 - Use PHP 8 constructor property promotion in `__construct()`.
-<code-snippet>public function __construct(public GitHub $github) { }</code-snippet>
+    - <code-snippet>public function __construct(public GitHub $github) { }</code-snippet>
 - Do not allow empty `__construct()` methods with zero parameters.
 
-## Type Declarations
+### Type Declarations
 - Always use explicit return type declarations for methods and functions.
 - Use appropriate PHP type hints for method parameters.
-<code-snippet name="Explicit return types and method params" lang="php">
+
+<code-snippet name="Explicit Return Types and Method Params" lang="php">
 protected function isAccessible(User $user, ?string $path = null): bool
 {
     ...
 }
 </code-snippet>
 
 ## Comments
-- Prefer PHPDoc blocks over comments. Use zero comments, unless there is something _very_ complex going on.
+- Prefer PHPDoc blocks over comments. Never use comments within the code itself unless there is something _very_ complex going on.
 
-## PHPDoc blocks
-- Add useful array shape definitions for arrays
+## PHPDoc Blocks
+- Add useful array shape type definitions for arrays when appropriate.
 
 ## Enums
 @if(empty($assist->enums()) || preg_match('/[A-Z]{3,8}/', $assist->enumContents()))
-- Keys in an Enum should be UPPERCASE and words separated with an underscore. i.e. `FAVORITE_PERSON`, `BEST_LAKE`, `MONTHLY`
+- Typically, keys in an Enum should be TitleCase. For example: `FavoritePerson`, `BestLake`, `Monthly`.
 @else
-- Keys in an Enum should follow existing Enum conventions.
+- That being said, keys in an Enum should follow existing application Enum conventions.
 @endif

.ai/phpunit/core.blade.php

@@ -1,15 +1,14 @@
 ## PHPUnit Core
 
-- We are using PHPUnit for testing. All tests must be written as PHPUnit classes.
+- This application uses PHPUnit for testing. All tests must be written as PHPUnit classes.
 - 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'd like to also run the entire test suite to make sure everything is still passing.
-- Tests should test all of the unhappy paths, happy paths, and weird paths.
+- 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
+### Running Tests
 - Run the minimal number of tests, using an appropriate filter, before finalizing.
-- Run all tests: `php artisan test`.
-- Run all tests in a file: `php artisan test tests/Feature/ExampleTest.php`.
-- Filter on particular test name: `php artisan test --filter=testName` (recommended after making a change to a related file).
+    - To run all tests: `php artisan test`.
+    - To run all tests in a file: `php artisan test tests/Feature/ExampleTest.php`.
+    - To filter on a particular test name: `php artisan test --filter=testName` (recommended after making a change to a related file).

.ai/pint/core.blade.php

@@ -1,3 +1,4 @@
-## Pint Code Formatting Core
+## Laravel Pint Code Formatter
+
 - You must run `vendor/bin/pint` 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.

.ai/tailwindcss/3/core.blade.php

@@ -1,2 +1,4 @@
-- Always use Tailwind CSS v3, verify you're using only supported classes.
-- Use the `search-docs` tool to find exactly what's supported in this project's Tailwind setup.
+## Tailwind 3
+
+- Always use Tailwind CSS v3 - verify you're using only classes supported by this version.
+- Use the `search-docs` tool to find exactly what's supported in this application's Tailwind setup.

.ai/tailwindcss/4/core.blade.php

@@ -1,6 +1,8 @@
-- Always use Tailwind CSS v4, do not use the deprecated utilities.
-- Use the `search-docs` tool to find exactly what's supported in this project's Tailwind setup.
-- In Tailwind v4 you import Tailwind using a regular CSS `@import` statement, not using the `@tailwind` directives used in v3:
+## Tailwind 4
+
+- Always use Tailwind CSS v4 - do not use the deprecated utilities.
+- Use the `search-docs` tool to find exactly what's supported in this application's Tailwind setup.
+- In Tailwind v4, you import Tailwind using a regular CSS `@import` statement, not using the `@tailwind` directives used in v3:
 @verbatim
 <code-snippet name="Tailwind v4 import tailwind diff" lang="diff"
    - @tailwind base;
@@ -9,10 +11,10 @@
    + @import "tailwindcss";
 </code-snippet>
 @endverbatim
-- `corePlugins` is not supported in v4.
+- `corePlugins` is not supported in Tailwind v4.
 
-## Replaced utilities
-- Tailwind v4 removed deprecated utilities. Do not use the deprecated option, use the replacement.
+### Replaced Utilities
+- Tailwind v4 removed deprecated utilities. Do not use the deprecated option - use the replacement.
 - Opacity values are still numeric.
 
 | Deprecated |	Replacement |
@@ -28,4 +30,3 @@
 | overflow-ellipsis | text-ellipsis |
 | decoration-slice | box-decoration-slice |
 | decoration-clone | box-decoration-clone |
-

.ai/tailwindcss/core.blade.php

@@ -1,11 +1,13 @@
-- 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
+## Tailwind Core
 
-## Spacing
-- Use gap utilities for spacing, don't use margins
+- 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.
+
+### Spacing
+- When listing items, use gap utilities for spacing, don't use margins.
 @verbatim
-    <code-snippet name="Valid Flex gap spacing example" lang="html">
+    <code-snippet name="Valid Flex Gap Spacing Example" lang="html">
         <div class="flex gap-8">
             <div>Superior</div>
             <div>Michigan</div>
@@ -14,5 +16,5 @@
     </code-snippet>
 @endverbatim
 
-## Tailwind Dark Mode
+### 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:`.

.ai/volt/core.blade.php

@@ -1,10 +1,11 @@
-- This project uses Livewire Volt for interactivity within its pages. New pages requiring interactivity must also use Livewire Volt. There is documentation available for it.
-- Volt is an elegantly crafted **functional** API for Livewire that supports single-file components, allowing a component's PHP logic and Blade templates to coexist in the same file
-- **Single-File Components**: Livewire Volt allows PHP logic and Blade templates in one file. Components use the `@volt` directive.
-- You must check existing Volt components to find out if they're functional or class based. If you can't detect that, ask the user which they prefer before writing a Volt component.
+## Livewire Volt
 
+- This project uses Livewire Volt for interactivity within its pages. New pages requiring interactivity must also use Livewire Volt. There is documentation available for it.
+- Volt is an elegantly crafted **class-based** and **functional** API for Livewire that supports single-file components, allowing a component's PHP logic and Blade templates to co-exist in the same file
+- Livewire Volt allows PHP logic and Blade templates in one file. Components use the `@volt` directive.
+- You must check existing Volt components to determine if they're functional or class based. If you can't detect that, ask the user which they prefer before writing a Volt component.
 
-## Volt Functional Component Example
+### Volt Functional Component Example
 @verbatim
 <code-snippet name="Volt Functional Component Example" lang="php">
 @volt
@@ -29,7 +30,7 @@
 </code-snippet>
 @endverbatim
 
-## Volt Class based Component Example
+### Volt Class Based Component Example
 To get started, define an anonymous class that extends Livewire\Volt\Component. Within the class, you may utilize all of the features of Livewire using traditional Livewire syntax:
 
 @verbatim
@@ -53,7 +54,7 @@ public function increment()
 @endverbatim
 
 ### Testing Volt & Volt Components
-- Use the existing location if tests already exist, otherwise fallback to `tests/Feature/Volt`
+- Use the existing directory for tests if it already exists. Otherwise, fallback to `tests/Feature/Volt`.
 
 <code-snippet name="Livewire Test Example" lang="php">
 use Livewire\Volt\Volt;
@@ -67,7 +68,7 @@ public function increment()
 </code-snippet>
 
 @verbatim
-<code-snippet name="Volt component test using Pest" lang="php">
+<code-snippet name="Volt Component Test Using Pest" lang="php">
 declare(strict_types=1);
 
 use App\Models\{User, Product};
@@ -89,10 +90,10 @@ public function increment()
 </code-snippet>
 @endverbatim
 
-## Common Patterns
+### Common Patterns
 
 @verbatim
-<code-snippet name="CRUD with Volt" lang="php">
+<code-snippet name="CRUD With Volt" lang="php">
 @volt
 use App\Models\Product;
 use function Livewire\Volt\{state, computed};
@@ -106,24 +107,23 @@ public function increment()
 $edit = fn(Product $product) => $this->editing = $product->id;
 $delete = fn(Product $product) => $product->delete();
 ?>
-
-    <!-- UI here -->
 @endvolt
+
+<!-- UI here -->
 </code-snippet>
 @endverbatim
 
 @verbatim
-<code-snippet name="Real-time search with Volt" lang="php">
+<code-snippet name="Real-time Search With Volt" lang="php">
     <flux:input
         wire:model.live.debounce.300ms="search"
         placeholder="Search..."
     />
 </code-snippet>
 @endverbatim
 
-
 @verbatim
-<code-snippet name="Loading states with Volt" lang="php">
+<code-snippet name="Loading States With Volt" lang="php">
     <flux:button wire:click="save" wire:loading.attr="disabled">
         <span wire:loading.remove>Save</span>
         <span wire:loading>Saving...</span>