From 8692ebac37a28cf3cf275db50dcd2fcdcc9e6ad6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guillaume=20Perr=C3=A9al?= <guillaume.perreal@irstea.fr> Date: Wed, 11 Dec 2019 16:56:16 +0100 Subject: [PATCH] =?UTF-8?q?Met=20=C3=A0=20jour=20la=20doc.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 39 ++++++++++++++++++++++++++++----------- 1 file changed, 28 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index de58a7b..62cde1e 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,12 @@ Configuration pour [PHP-CS-Fixer](https://cs.symfony.com/). +**Attention** : à partir de la version 2.0, PHP **7.1** est requis. Utiliser les version 1.x pour +les versions précédentes de PHP. + ### Installation + ```shell composer require --dev irstea/php-cs-fixer-config ``` @@ -33,24 +37,37 @@ return Irstea\CS\Config::create() Pour plus de détails, cf. https://cs.symfony.com/#usage -#### En-tête de fichiers +### Usage + +```shell +vendor/bin/php-cs-fixer fix +``` + +cf. https://cs.symfony.com/#usage + +### En-tête de fichiers + +php-cs-fixer peut s'assurer que tous les fichiers PHP commençent par un commentaire fixe. Ceci +est généralement utilisé pour mettre les mentions légales obligatoires (de licence, notamment). -Un modèle d'en-tête (cf. règle `header_comment`) peut être défini dans un fichier `.docheader`. Les tags `%package%` et `%yearRange%` sont remplacés automatiquement à partir des informations du dépôt git et de `composer.json`. +`irstea/php-cs-fixer-config` permet d'utiliser un modèle avec quelques tags : +* `%package%` est remplacé par le nom du package Composer, +* `%description%` est remplacé par le description du package Composer, +* `%yearRange%` est remplacé par la période de développement d'années d'parès le dépôt git. + +Par défaut, `irstea/php-cs-fixer-config` consulte la licence indiquée dans le fichier `composer.json` +puis cherche un modèle correspondant dans son dossier [headers/](headers/). S'il ne trouve pas, +il utilise un [modèle par défaut](headers/default.txt) qui renvoie au fichier LICENSE qui devrait +se trouver à la racine du projet. + +Sinon, un modèle d'en-tête personnamlié en créant un fichier `.docheader` à la racine du projet. Exemple : ``` -This file is part of "%package%". +%package% - %description% (c) %yearRange% Irstea <dsi.poleis@irstea.fr> For the full copyright and license information, please view the LICENSE file that was distributed with this source code. ``` - -### Usage - -```shell -vendor/bin/php-cs-fixer fix -``` - -cf. https://cs.symfony.com/#usage -- GitLab