From e91d2c9e93a9635f5606a692bfe1f6332d5ce178 Mon Sep 17 00:00:00 2001 From: Mathieu Jaumotte Date: Thu, 20 Oct 2022 09:55:42 +0200 Subject: [PATCH] complete chill documentation about csfixer and phpstan --- docs/source/installation/index.rst | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/docs/source/installation/index.rst b/docs/source/installation/index.rst index 00f27ed69..01a8c4aee 100644 --- a/docs/source/installation/index.rst +++ b/docs/source/installation/index.rst @@ -265,7 +265,7 @@ Tests reside inside the installed bundles. You must `cd` into that directory, do **Note**: some bundle require the fixture to be executed. See the dedicated _how-tos_. -Exemple, for running test inside `main` bundle: +Exemple, for running unit test inside `main` bundle: .. code-block:: bash @@ -280,6 +280,30 @@ Exemple, for running test inside `main` bundle: # run tests bin/phpunit src/Bundle/path/to/your/test +Or for running tests to check code style and php conventions with csfixer and phpstan: + +.. code-block:: bash + + # run code style fixer + bin/grumphp run --tasks=phpcsfixer + # run phpstan + bin/grumphp run --tasks=phpstan + + +.. note:: + + To avoid phpstan block your commits: + + .. code-block:: bash + + git commit -n ... + + To avoid phpstan block your commits permanently: + + .. code-block:: bash + + ./bin/grumphp git:deinit + How to run webpack interactively ================================