Download the PHP package mortexa/laravel-arkitect without Composer
On this page you can find all versions of the php package mortexa/laravel-arkitect. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mortexa/laravel-arkitect
More information about mortexa/laravel-arkitect
Files in mortexa/laravel-arkitect
Package laravel-arkitect
Short Description Test and enforce architectural rules in your Laravel applications
License MIT
Informations about the package laravel-arkitect
Laravel Arkitect
Laravel Arkitect lets you test and enforce your architectural rules in your Laravel applications, and it's a PHPArkitect wrapper for Laravel. This package helps you to keep your app's architecture clean and consistent.
Installation
You can install the package via Composer:
Usage
First, you should create your architectural rules by running the following Artisan command:
php artisan make:arkitect ControllersNaming
By running the command, the ControllersNaming.php
file will be created in your application's tests/Architecture
directory like this:
Then, you must implement rule()
and path()
methods based on the following example.
And finally, you can run your tests by the following command:
php artisan test:arkitect
Done!
If you want to stop checking command immediately after first violation, you can use
--stop-on-failure
option.
For all available rules, please take a look at the PHPArkitect repository: https://github.com/phparkitect/arkitect
Default rules
Some opinionated rules are provided by the package and apply by default. These rules are about Laravel user-land structure. You are free to customize or ignore them entirely by publishing config file.
Example
Configuration
If you want to customize the default rules provided by the package, You can publish the Laravel Arkitect configuration file using the following Artisan command:
php artisan vendor:publish --provider="Mortexa\LaravelArkitect\ArkitectServiceProvider" --tag="config"
The arkitect
configuration file will be placed in your application's config
directory.
Ignore namespaces
If you want to ignore any namespaces from being under architectural test, you should add the related path to ignored_namespaces
key in configuration file.
Contributing
Thank you for considering contributing! If you find an issue, or have a better way to do something, feel free to open an issue, or a PR.
Licence
This repository is open-sourced software licensed under the MIT license.