README.md 1.46 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
Ce dépôt contient la configuration par défaut de quelques outils utiles pendant le développement.

Installation
============

Cloner le dossier dans $HOME/.config/devtools.

```bash
git clone git@gitlab-ssh.irstea.fr:pole-is/devtools-config.git $HOME/.config/devtools
```

Utilisation

Globale
-------

Créer des liens symboliques dans $HOME pour .editorconf et phpcs.xml.dist:

```bash
ln -snf $HOME/.config/devtools/php/phpcs.xml.dist $HOME/phpcs.xml.dist
ln -snf $HOME/.config/devtools/.editorconfig $HOME/.editorconfig
```

Enfin, configurer PHPStorm pour utiliser les fichiers $HOME/.config/devtools/php/phpcs.xml.dist et $HOME/.config/devtools/php/phpmd-ruleset.xml pour phpcs et phpmd respectivement.

Par projet
----------

php-cs-fixer nécessite de copier le fichier directement dans le projet :

```bash
cp $HOME/.config/devtools/php/.php_cs.dist chemin/vers/mon/projet
```

Pour phpcs et phpmd, c'est également nécessaire pour l'intégration continue.

Outils
======

* [editorconfig](): permet de configurer globalement l'encodage, l'indentation et la gestion des espaces.

* [phpcs](https://github.com/squizlabs/PHP_CodeSniffer): vérification du style de codage.

* [php-cs-fixer](https://github.com/FriendsOfPhp/PHP-CS-Fixer): cousin de phpcs, mais qui permet de corriger les fichiers et inclut également des aide pour migrer d'une version de PHP à une autre. 

* [phpmd](https://phpmd.org/): détection de bugs potentielles, de fonctions/classes trop complexes, ...