Skip to content

Update index.rst #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 1, 2025
Merged

Update index.rst #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ PHP Coding Standards Fixer
==========================

The PHP Coding Standards Fixer (PHP CS Fixer) tool fixes your code to follow standards;
whether you want to follow PHP coding standards as defined in the PSR-1, PSR-2, etc.,
whether you want to follow PHP coding standards as defined by `PER Coding Style <https://www.php-fig.org/per/coding-style/>`__,
or other community driven ones like the Symfony one.
You can **also** define your (team's) style through configuration.

Expand Down Expand Up @@ -32,7 +32,7 @@ Installation
The recommended way to install PHP CS Fixer is to use
`Composer <https://getcomposer.org/download/>`__:

.. code:: console
.. code:: sh
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

console already looks ok on https://cs.symfony.com, when using $ prefix.
Only the docker line below (without $) doesn't look nice (blue). I added the $ there.

Also changed to sh to correspond readme in main repo. Tried on the website via dev tools to change highlight-console line to highlight-sh class in html. There is no difference in styling.


$ composer require --dev friendsofphp/php-cs-fixer
$ ## or when facing conflicts in dependencies:
Expand All @@ -48,9 +48,9 @@ PHP CS Fixer can be run in a Docker container.

You can use pre-built Docker images to run ``php-cs-fixer``.

.. code:: console
.. code:: sh

docker run -v $(pwd):/code ghcr.io/php-cs-fixer/php-cs-fixer:${FIXER_VERSION:-3-php8.3} fix src
$ docker run -v $(pwd):/code ghcr.io/php-cs-fixer/php-cs-fixer:${FIXER_VERSION:-3-php8.3} fix src

``$FIXER_VERSION`` used in example above is an identifier of a release you want to use, which is based on Fixer and PHP versions combined. There are different tags for each Fixer's SemVer level and PHP version with syntax ``<php-cs-fixer-version>-php<php-version>``. For example:

Expand All @@ -64,7 +64,7 @@ Usage
Assuming you installed PHP CS Fixer as instructed above, you can run
the following command to fix the files PHP files in the ``src`` directory:

.. code:: console
.. code:: sh

$ ./vendor/bin/php-cs-fixer fix src

Expand Down