Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 5691163

Browse files
authored
docs: update usage documentation for describe --expand and @ (#9119)
1 parent 1a37f2a commit 5691163

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

doc/usage.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,24 @@ To visualize all the rules that belong to a ruleset:
199199
200200
php php-cs-fixer.phar describe @PSR2
201201
202+
The ``--expand`` option can be used to show all rules when describing a ruleset, including nested rulesets:
203+
204+
.. code-block:: console
205+
206+
php php-cs-fixer.phar describe @PSR2 --expand
207+
208+
You can also use the special ``@`` alias to describe the configuration currently in use:
209+
210+
.. code-block:: console
211+
212+
php php-cs-fixer.phar describe @
213+
214+
The ``--config`` option can be used to specify which config file to load:
215+
216+
.. code-block:: console
217+
218+
php php-cs-fixer.phar describe @ --config=.php-cs-fixer.dist.php
219+
202220
Command-line completion
203221
-----------------------
204222

0 commit comments

Comments
 (0)