Visual Studio Code : configurer PHP-CS-Fixer

Il y a peu, j’ai réinstallé mon poste de travail. Gros boulet que je suis, j’ai oublié de conserver une copie des fichiers de configuration de l’extension php cs fixer de Visual Studio Code. Je profite donc de refaire la configuration pour rédiger ce petit billet qui me servira de mémo à l’avenir. Et qui sait, peut-être que ces quelques lignes pourront être utiles à certains d’entre vous. 😛

 

Visual Studio Code Logo

 

 

PHP CS Fixer ?

PHP CS Fixer (PHP Coding Standards Fixer) vous permet de formater votre code automatiquement selon les standards de programmation (PSR-1, PSR-2, etc.) voire d’appliquer des directives spécifiques à vos développements.

 

Installation de l’extension

Ajouter l’extension php cs fixer de junstyle à Visual Studio Code.

 

Téléchargement de php-cs-fixer-v2.phar

Pour que cette extension fonctionne, il faut « installer » Php CS Fixer. Pour ce faire, télécharger le fichier php-cs-fixer-v2.phar sur gitHub : https://github.com/FriendsOfPHP/PHP-CS-Fixer#installation

Placez ce fichier dans votre répertoire php. Pour ma part, mon répertoire se trouve à la racine : c:/php/

 

Le fichier de configuration

Il faut maintenant créer un fichier explicitant vos règles de formatage des fichiers. Personnellement, je l’ai nommé vscode.php_cs et configuré comme suit :

<?php

return PhpCsFixer\Config::create() ->setRules([
    '@PSR2' => true,
    'array_syntax' => ['syntax' => 'short'],
    'combine_consecutive_unsets' => true,
    'method_separation' => true,
    'no_multiline_whitespace_before_semicolons' => true,
    'single_quote' => true,
    'binary_operator_spaces' => [
        'align_double_arrow' => true,
        'align_equals' => false
    ],
    'blank_line_after_opening_tag' => true,
    'blank_line_before_return' => true,
    'braces' => [
        'allow_single_line_closure' => true
    ],
    'concat_space' => ['spacing' => 'one'],
    'declare_equal_normalize' => true,
    'function_typehint_space' => true,
    'hash_to_slash_comment' => true,
    'include' => true,
    'lowercase_cast' => true,
    'no_extra_consecutive_blank_lines' => [
        'curly_brace_block',
        'extra',
        'parenthesis_brace_block',
        'square_brace_block',
        'throw',
        'use',
    ],
    'no_multiline_whitespace_around_double_arrow' => true,
    'nospaces_around_offset' => true,
    'no_whitespace_before_comma_in_array' => true,
    'no_whitespace_in_blank_line' => true,
    'object_operator_without_whitespace' => true,
    'single_blank_line_before_namespace' => true,
    'ternary_operator_spaces' => true,
    'trim_array_spaces' => true,
    'unary_operator_spaces' => true,
    'whitespace_after_comma_in_array' => true,
])
->setLineEnding("\r\n")
->setUsingCache(false);

Je ne vous détaille pas les règles car elles sont relativement explicites. 🙂 Vous trouverez leurs détails ici : https://github.com/FriendsOfPHP/PHP-CS-Fixer

Personnellement, j’ai placé ce fichier dans le répertoire de php : c:/php/

 

Configuration de Visual Studio Code

Enfin, indiquez les chemins (path) de vos deux fichiers php-cs-fixer-v2.phar et vscode.php_cs dans les paramètres de Visual Studio Code :

"php-cs-fixer.executablePath": "C:\\php\\php-cs-fixer-v2.phar",
"php-cs-fixer.config": "C:\\php\\vscode.php_cs",

Pour formater votre code, il vous suffit maintenant de presser les touches Alt + Maj + F (raccourcis par défaut sous Windows).

 

Et le tour est joué ! ^^

Laisser un commentaire