Introduction

Introduction – Description et exemples d'utilisation simples

Description

PHP_CodeSniffer est un script PHP5 tokenize et "sniffe" le code PHP et JavaScript pour détecter des violations d'un standard défini de codage. C'est un outil de développement essentiel qui garanti que votre code reste clair et consistent. Il peut aussi aider à prévenir d'erreurs classiques de sémantique .

Un standard de codage, pour PHP_CodeSniffer, c'est une collection de fichiers sniffeurs. Chaque fichier sniffeur vérifie seulement une partie des règles de codage. Plusieurs standards de codages peuvent être utilisés avec PHP_CodeSniffer, et une seule installation peut-être utilisée pour plusieurs projets. Le standard de codage utilisé par défaut par PHP_CodeSniffer est celui de PEAR.

Exemple

Pour vérifier si un fichier répond aux règles de codage PEAR, il suffit de spécifier l'emplacement du fichier.

Vérifier un fichier avec PHP_CodeSniffer


$ phpcs /chemin/du/code/mon_fichierfile.php

FILE: /chemin/du/code/mon_fichierfile.php
--------------------------------------------------------------------------------
FOUND 5 ERROR(S) AFFECTING 2 LINE(S)
--------------------------------------------------------------------------------
  2 | ERROR | Missing file doc comment
 20 | ERROR | PHP keywords must be lowercase; expected "false" but found "FALSE"
 47 | ERROR | Line not indented correctly; expected 4 spaces but found 1
 51 | ERROR | Missing function doc comment
 88 | ERROR | Line not indented correctly; expected 9 spaces but found 6
--------------------------------------------------------------------------------

Ou, si vous souhaitez vérifier un répertoire tout entier, vous donnez le nom de ce répertoire au lieu d'un fichier.

Vérifier un répertoire avec PHP_CodeSniffer


$ phpcs /chemin/du/code/

FILE: /chemin/du/code/mon_fichierfile.php
--------------------------------------------------------------------------------
FOUND 5 ERROR(S) AFFECTING 5 LINE(S)
--------------------------------------------------------------------------------
  2 | ERROR | Missing file doc comment
 20 | ERROR | PHP keywords must be lowercase; expected "false" but found "FALSE"
 47 | ERROR | Line not indented correctly; expected 4 spaces but found 1
 51 | ERROR | Missing function doc comment
 88 | ERROR | Line not indented correctly; expected 9 spaces but found 6
--------------------------------------------------------------------------------

FILE: /chemin/du/code/un_autre_fichierfile.php
--------------------------------------------------------------------------------
FOUND 1 ERROR(S) AND 1 WARNING(S) AFFECTING 1 LINE(S)
--------------------------------------------------------------------------------
 21 | ERROR   | PHP keywords must be lowercase; expected "false" but found
    |         | "FALSE"
 21 | WARNING | Equals sign not aligned with surrounding assignments
--------------------------------------------------------------------------------
PHP_CodeSniffer (Previous) A list of software requirements (Next)
Last updated: Sun, 29 Aug 2010 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

There are no user contributed notes for this page.