Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
smortexa committed Aug 7, 2022
1 parent e7c7925 commit f2b88cc
Showing 1 changed file with 24 additions and 7 deletions.
31 changes: 24 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,12 +103,11 @@ class ControllersNaming extends BaseRule implements RuleContract

## Configuration

You can publish the Laravel Arkitect configuration file using the following Artisan command:
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. There are a few rules
provided by the package in this file that you can activate and apply to your codebase:
The `arkitect` configuration file will be placed in your application's `config` directory.

```php
// config/arkitect.php
Expand All @@ -118,10 +117,6 @@ provided by the package in this file that you can activate and apply to your cod
use ...

return [
'types' => [
'naming' => true,
],

'rules' => [
'naming' => [
ControllersNaming::class,
Expand All @@ -139,6 +134,28 @@ return [
BuildersNaming::class,
ContractsNaming::class,
RepositoriesNaming::class,
MailsNaming::class,
],
'extending' => [
ControllersExtending::class,
CommandsExtending::class,
ExceptionsExtending::class,
RequestsExtending::class,
ResourcesExtending::class,
ResourceCollectionsExtending::class,
ModelsExtending::class,
NotificationsExtending::class,
ProvidersExtending::class,
ViewsExtending::class,
FactoriesExtending::class,
SeedersExtending::class,
MailsExtending::class,
],
'implementing' => [
RulesImplementing::class,
CastsImplementing::class,
ScopesImplementing::class,
JobsImplementing::class,
],
],
];
Expand Down

0 comments on commit f2b88cc

Please sign in to comment.