Merge pull request #24 from crowdsecurity/new-features

- make crowdsec mentions hidable
- remove useless dockerfiles
- add phpcs-fixer
- lint pass

Author: mobula9

.php_cs

@@ -16,10 +16,12 @@ return PhpCsFixer\Config::create()
         'native_constant_invocation' => true,
         'combine_nested_dirname' => true,
         'list_syntax' => ['syntax' => 'short'],
+        'phpdoc_to_comment' => false,
     ])
     ->setRiskyAllowed(true)
     ->setFinder(
         PhpCsFixer\Finder::create()
             ->in(__DIR__.'/src')
+            ->in(__DIR__.'/tests')
     )
 ;

README.md

@@ -6,11 +6,11 @@
 
 > The official PHP bouncer library for the CrowdSec LAPI/CAPI
 
-<p align="center">
-<img src="https://img.shields.io/github/workflow/status/crowdsecurity/php-cs-bouncer/tests/main">
-<img src="https://img.shields.io/github/license/crowdsecurity/php-cs-bouncer">
-<img src="https://img.shields.io/github/v/release/crowdsecurity/php-cs-bouncer?include_prereleases">
-</p>
+![Version](https://img.shields.io/github/v/release/crowdsecurity/php-cs-bouncer?include_prereleases)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=crowdsecurity_php-cs-bouncer&metric=alert_status)](https://sonarcloud.io/dashboard?id=crowdsecurity_php-cs-bouncer)
+![Build Status](https://img.shields.io/github/workflow/status/crowdsecurity/php-cs-bouncer/tests/main)
+![Licence](https://img.shields.io/github/license/crowdsecurity/php-cs-bouncer)
+
 
 <p align="center">
 :books: <a href="https://doc.crowdsec.net">Documentation</a>

docker/php-7.0.Dockerfile

@@ -164,7 +164,7 @@ Used for the stream mode when we have to update the remediations list.
 
 `array`
 
-> number of deleted and new decisions.
+> number of deleted and new decisions
 
 
 <hr />
@@ -191,7 +191,7 @@ Used when the stream mode has just been activated.
 
 `int`
 
-> number of decisions added.
+> number of decisions added
 
 
 <hr />

docker/php-7.1.Dockerfile

@@ -289,7 +289,7 @@ This method should be called periodically (ex: crontab) in a asynchronous way to
 
 `array`
 
-> number of deleted and new decisions.
+> number of deleted and new decisions
 
 
 <hr />
@@ -315,7 +315,7 @@ This method should be called only to force a cache warm up.
 
 `int`
 
-> number of decisions added.
+> number of decisions added
 
 
 <hr />

docker/php-7.1.opcache.ini

@@ -47,6 +47,13 @@ docker run -e "FILTER_REGEX_INCLUDE=/tmp/lint/src/.*" -e RUN_LOCAL=true -v ${PWD
 
 Full details here: https://github.com/github/super-linter/blob/master/docs/run-linter-locally.md
 
+To autolint with phpcs-fixer:
+
+```bash
+composer install --working-dir=tools/php-cs-fixer
+PHP_CS_FIXER_IGNORE_ENV=1 tools/php-cs-fixer/vendor/bin/php-cs-fixer fix
+```
+
 ## How to generate PHP Doc
 
 ```bash
@@ -62,9 +69,15 @@ We use the git workflow [Github Flow](https://guides.github.com/introduction/flo
 ```bash
 git checkout -b <basic-name> # the name is not important now, you can type "new-features"
 git commit # as mush as necessary.
-docker-compose run --rm app vendor/bin/phpdoc-md # regenerate php doc
+
+PHP_CS_FIXER_IGNORE_ENV=1 tools/php-cs-fixer/vendor/bin/php-cs-fixer fix # fix coding standards
+docker run -e "FILTER_REGEX_INCLUDE=/tmp/lint/src/.*" -e RUN_LOCAL=true -v ${PWD}:/tmp/lint github/super-linter # super linter local pass
+./tests-local.sh # check tests are still OK
+docker-compose run --rm app vendor/bin/phpdoc-md # Regenerate php doc
+
 git branch -m <name-of-the-branch> # to rename the branch to what has really be done.
 git push origin :<basic-name> && git push origin <name-of-the-branch> # Only if already pushed
+
 gh pr create --fill
 ```