Skip to content

Commit f2f4cd6

Browse files
mnapoliondrejmirtes
authored andcommitted
Add an example of a simple phpstan.neon file
1 parent 9aba869 commit f2f4cd6

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@ New extensions are becoming available on a regular basis!
318318

319319
## Configuration
320320

321-
Config file is passed to the `phpstan` executable with `-c` option:
321+
A config file can passed to the `phpstan` executable using the `-c` option:
322322

323323
```bash
324324
vendor/bin/phpstan analyse -l 4 -c phpstan.neon src tests
@@ -351,6 +351,16 @@ All the following options are part of the `parameters` section.
351351

352352
Relative paths in the configuration are made absolute according to the directory where the configuration file resides.
353353

354+
Here is an example of a `phpstan.neon` file to run `vendor/bin/phpstan analyse` without any extra argument:
355+
356+
```neon
357+
parameters:
358+
level: 5
359+
paths:
360+
- src
361+
- tests
362+
```
363+
354364
### Autoloading
355365

356366
PHPStan uses Composer's autoloader by default.

0 commit comments

Comments
 (0)