codeclimate phpcodesniffer

CODE CLIMAT PHP_CODESNIFFER MOTEUR

codeclimate-phpcodesniffer est un moteur climatique de code qui enveloppe l'outil d'analyse statique Sniffer statique PHP_CODE. Vous pouvez l'exécuter sur votre ligne de commande à l'aide du Code Climate CLI ou sur notre plate-forme d'analyse hébergée.

Php_codesniffer vous aide à détecter les violations d'une norme de codage définie.

Installation

1. Si vous ne l'avez pas déjà fait, installez le Code Climate CLI.
2. Exécutez codeclimate engines:enable phpcodesniffer . Cette commande installe à la fois le moteur et le permet dans votre fichier .codeclimate.yml .
3. Vous êtes prêt à analyser! Parcourez le dossier de votre projet et exécutez codeclimate analyze .

Options de configuration

Formatez les valeurs de ces options de configuration selon la documentation PHP_CODESNIFFER.

• File_Extensions - C'est là que vous pouvez configurer les extensions de fichiers pour les fichiers que vous souhaitez analyser php_codesniffer.
• Standard - Il s'agit de la liste des normes délimitées par virgule que vous souhaitez utiliser PHP_CODESNIFFER lors de l'analyse de vos fichiers. Vous pouvez éventuellement inclure un chemin relatif vers un fichier PHPCS RuleSet.xml personnalisé.
• IGNORE_WARNINGS - Vous pouvez masquer les avertissements et signaler uniquement les erreurs avec cette option.
• Encodage - Par défaut, PHPCS utilise ISO-8859-1. Utilisez-le pour le changer dans votre encodage, par exemple UTF-8.

Exemple de configuration

 exclude_paths:
 - "/examples/**/*"
engines:
  phpcodesniffer:
    enabled: true
    config:
      file_extensions: "php,inc,lib"
      standard: "PSR1,PSR2,my_custom_php_ruleset.xml"
      ignore_warnings: true
      encoding: utf-8
ratings:
  paths:
  - "**.php"

Normes de codage prises en charge

En plus des normes fournies par défaut avec PHP_CODESNIFFER, les normes de codage d'extension Drupal, WordPress, Yii2 et Magento sont prises en charge. Voici la liste complète:

• Drupal
• Drupalpractice
• Meqp1
• Meqp2
• Mysource
• POIRE
• Phpc
• Psr1
• Psr2
• Gaspiller
• Wordpress
• Wordpress-core
• Wordpress-docs
• WordPress-Extra
• Wordpress-vip
• Yii2
• Zend

Besoin d'aide?

Pour obtenir de l'aide avec php_codesniffer, consultez leur documentation.

Si vous rencontrez un problème climatique de code, examinez d'abord les problèmes de github de ce projet, car votre question a peut-être déjà été couverte. Sinon, allez-y et ouvrez un ticket d'assistance avec nous.