Skip to content

Commit 488eb1f

Browse files
committed
Implement alias for PHPStan and update docs
1 parent b6e438f commit 488eb1f

2 files changed

Lines changed: 16 additions & 3 deletions

File tree

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,20 +31,32 @@ install and usage example.
3131
Bugs and feature request are tracked on [GitHub](https://github.com/bigbluebutton/bigbluebutton-api-php/issues)
3232

3333
## Contributing guidelines
34-
### Code style
34+
### Code Quality (style)
3535

3636
Make sure the code style configuration is applied by running PHPCS-Fixer.
3737

38+
```bash
39+
# using an alias
40+
$ composer cs-fix
3841
```
39-
composer cs-fix
42+
43+
### Code Quality (static code analysis)
44+
PHPStan shall be used for static code analysis by running the command below:
45+
46+
```bash
47+
# using an alias
48+
$ composer code-check
49+
50+
# or the same w/o alias
51+
$ ./vendor/bin/phpstan analyse
4052
```
4153

4254
### Running tests
4355

4456
For every implemented feature add unit tests and check all is green by running the command below.
4557

4658
```bash
47-
composer test
59+
$ composer test
4860
```
4961

5062
To run a single test

composer.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
"phpstan/phpstan": "^1.10"
4343
},
4444
"scripts": {
45+
"code-check": "./vendor/bin/phpstan analyse",
4546
"test": "./vendor/bin/phpunit",
4647
"test-cov": "XDEBUG_MODE=coverage ./vendor/bin/phpunit --coverage-html coverage",
4748
"cs-fix": "PHP_CS_FIXER_IGNORE_ENV=1 ./vendor/bin/php-cs-fixer fix --allow-risky yes",

0 commit comments

Comments
 (0)