Skip to content

Commit a95628e

Browse files
committed
README.md updated
1 parent 92aea16 commit a95628e

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -85,26 +85,29 @@ The package includes powerful auto-fix functionality that can automatically reso
8585
This behavior can be adjusted using the following parameters from git-hooks.php config file:
8686
```php
8787
// config/git-hooks.php
88+
return [
89+
...
8890
'automatically_fix_errors' => false,
8991
'rerun_analyzer_after_autofix' => false,
9092
'stop_at_first_analyzer_failure' => true,
93+
];
9194
```
9295

9396
## 3️⃣ Advanced Usage
9497

9598
### 🐳 Laravel Sail support
9699

97-
If you are using Laravel Sail and maybe not lokal PHP is installed, you can adjust the following parameters in the git-hooks.php config file:
98-
100+
If you are using Laravel Sail and maybe not local PHP is installed, you can adjust the following parameters in the `git-hooks.php` config file.
101+
This will force the local git hooks to use the `sail` command to execute the hooks:
99102
```php
100103
// config/git-hooks.php
101104
'use_sail' => env('GITHOOKS_USE_SAIL', false),
102105
```
103-
This will force the local git hooks to use the `sail` command to execute the hooks.
106+
104107

105108
### 🐳 Docker support
106109

107-
By default commands are executed locally, however this behavior can be adjusted for each hook using the parameters `run_in_docker` and `docker_container`:
110+
By default, commands are executed locally, however this behavior can be adjusted for each hook using the parameters `run_in_docker` and `docker_container`:
108111

109112
```php
110113
// config/git-hooks.php
@@ -119,11 +122,18 @@ It also provides additional configuration options for fine-tuning hook behavior.
119122

120123
```php
121124
// config/git-hooks.php
122-
'output_errors' => false,
123-
'debug_commands' => false,
124-
'debug_output' => false,
125+
return [
126+
...
127+
'artisan_path' => base_path('artisan'),
125128
'validate_paths' => env('GITHOOKS_VALIDATE_PATHS', true),
126129
'analyzer_chunk_size' => env('GITHOOKS_ANALYZER_CHUNK_SIZE', 100),
130+
131+
'output_errors' => env('GITHOOKS_OUTPUT_ERRORS', false),
132+
133+
'debug_commands' => env('GITHOOKS_DEBUG_COMMANDS', false),
134+
'debug_output' => env('GITHOOKS_DEBUG_OUTPUT', false),
135+
...
136+
];
127137
```
128138

129139
### 🛠️ Creating Custom Git Hooks

0 commit comments

Comments
 (0)