iglebekk / generelle-laravel-prinsipper
Generelle Laravel-utviklingsprinsipper som publishable dokumentasjon.
Package info
github.com/iglebekk/generelle-laravel-prinsipper
pkg:composer/iglebekk/generelle-laravel-prinsipper
Requires
- php: ^8.3
- illuminate/contracts: ^9.0|^10.0|^11.0|^12.0|^13.0
- spatie/laravel-package-tools: ^1.16
Requires (Dev)
- laravel/pint: ^1.14
- orchestra/testbench: ^7.0|^8.0|^9.0|^10.0|^11.0
- pestphp/pest: ^2.0|^3.0|^4.0
- pestphp/pest-plugin-laravel: ^2.0|^3.0|^4.0
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
Denne pakken publiserer dokumentasjonen om kodestandarder og beste praksis for Laravel.
Den publiserte dokumentasjonen anbefaler Flux UI som standard for egenprodusert Blade-UI, alltid gjennom app-spesifikke komponenter.
Støttede Laravel-versjoner: 9.x, 10.x, 11.x, 12.x, 13.x.
Installasjon
composer require iglebekk/generelle-laravel-prinsipper --dev
Publiser dokumentasjon
php artisan vendor:publish --tag=laravel-prinsipper-docs
Dette legger dokumentasjonen i docs/laravel-prinsipper.md i prosjektet ditt.
Synkronisering til instruksjonsfiler
For å sikre at siste versjon alltid er tilgjengelig i prosjektet og AI-instruksjonsfiler, kjør:
php artisan laravel-prinsipper:sync
Standard atferd:
docs/laravel-prinsipper.mdoverskrives med full prinsipptekst (kilde).AGENTS.md,CLAUDE.md,GEMINI.mdfår kun en kort referanse mellom markørene som peker til docs-fila — for å unngå duplisert innhold.
Markører:
<!-- LARAVEL-PRINSIPPER:START -->
<!-- LARAVEL-PRINSIPPER:END -->
Konfigurasjon
php artisan vendor:publish --tag=laravel-prinsipper-config
I config/laravel-prinsipper.php kan du justere source, docs_target, reference_targets, reference_body og markører.
Oppdatering
Når retningslinjene oppdateres i pakken, kjør:
composer update iglebekk/generelle-laravel-prinsipper php artisan laravel-prinsipper:sync
Utvikling
composer test # Pest via orchestra/testbench composer format # Laravel Pint
Automatisering via composer
Legg til i prosjektets composer.json:
{
"scripts": {
"post-install-cmd": [
"@php -r \"require_once 'vendor/autoload.php'; if (! class_exists('Iglebekk\\\\LaravelPrinciples\\\\LaravelPrinciplesServiceProvider')) { exit(0); } passthru(PHP_BINARY . ' artisan laravel-prinsipper:sync --no-interaction', $exitCode); exit($exitCode);\""
],
"post-update-cmd": [
"@php -r \"require_once 'vendor/autoload.php'; if (! class_exists('Iglebekk\\\\LaravelPrinciples\\\\LaravelPrinciplesServiceProvider')) { exit(0); } passthru(PHP_BINARY . ' artisan laravel-prinsipper:sync --no-interaction', $exitCode); exit($exitCode);\""
]
}
}
Dette er viktig hvis pakken er installert med --dev. I produksjon kjøres ofte composer install --no-dev, og da finnes ikke kommandoen. Guard-en over avslutter derfor stille med 0 når pakken ikke er tilgjengelig.