https://github.com/codeclimate/codeclimate-phpcodesniffer

Code Climate Engine for PHP Code Sniffer
https://github.com/codeclimate/codeclimate-phpcodesniffer

code-quality codeclimate codeclimate-engine hacktoberfest metrics php php-codesniffer quality static-analysis static-code-analysis

Last synced: about 1 month ago
JSON representation

Code Climate Engine for PHP Code Sniffer

• Host: GitHub
• URL: https://github.com/codeclimate/codeclimate-phpcodesniffer
• Owner: codeclimate
• License: mit
• Created: 2015-06-19T18:20:06.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-03-13T13:55:10.000Z (almost 2 years ago)
• Last Synced: 2024-08-04T09:05:41.472Z (4 months ago)
• Topics: code-quality, codeclimate, codeclimate-engine, hacktoberfest, metrics, php, php-codesniffer, quality, static-analysis, static-code-analysis
• Language: PHP
• Homepage:
• Size: 104 KB
• Stars: 28
• Watchers: 25
• Forks: 23
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-network-stuff - **21**星

README

        
# Code Climate PHP_CodeSniffer Engine

[![Code Climate](https://codeclimate.com/github/codeclimate/codeclimate-phpcodesniffer/badges/gpa.svg)](https://codeclimate.com/github/codeclimate/codeclimate-phpcodesniffer)

`codeclimate-phpcodesniffer` is a Code Climate engine that wraps the [PHP_Code Sniffer](https://github.com/squizlabs/PHP_CodeSniffer) static analysis tool. You can run it on your command line using the Code Climate CLI, or on our hosted analysis platform.

PHP_CodeSniffer helps you detect violations of a defined coding standard.

### Installation

1. If you haven't already, [install the Code Climate CLI](https://github.com/codeclimate/codeclimate).

2. Run `codeclimate engines:enable phpcodesniffer`. This command both installs the engine and enables it in your `.codeclimate.yml` file.

3. You're ready to analyze! Browse into your project's folder and run `codeclimate analyze`.

### Config Options

Format the values for these config options per the [PHP_CodeSniffer documentation](https://github.com/squizlabs/PHP_CodeSniffer).

* file_extensions - This is where you can configure the file extensions for the files that you want PHP_CodeSniffer to analyze.

* standard - This is the comma delimited list of standards that you want

PHP_CodeSniffer to use while analyzing your files. You may optionally include

a relative path to a custom phpcs ruleset.xml file.

* ignore_warnings - You can hide warnings, and only report errors with this option.

* encoding - By default, PHPCS uses ISO-8859-1. Use this to change it to your encoding, e.g. UTF-8.

### Sample Config

    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"

### Supported Coding Standards

In addition to standards provided by [default](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Usage#printing-a-list-of-installed-coding-standards) with PHP_CodeSniffer, the [Drupal](https://github.com/klausi/coder), [WordPress](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards), [Yii2](https://github.com/yiisoft/yii2-coding-standards), and [Magento Extension](https://github.com/magento/marketplace-eqp) coding standards are supported. Here is the full list:

* Drupal

* DrupalPractice

* MEQP1

* MEQP2

* MySource

* PEAR

* PHPCS

* PSR1

* PSR2

* Squiz

* WordPress

* WordPress-Core

* WordPress-Docs

* WordPress-Extra

* WordPress-VIP

* Yii2

* Zend

### Need help?

For help with PHP_CodeSniffer, [check out their documentation](https://github.com/squizlabs/PHP_CodeSniffer).

If you're running into a Code Climate issue, first look over this project's [GitHub Issues](https://github.com/squizlabs/PHP_CodeSniffer/issues), as your question may have already been covered. If not, [go ahead and open a support ticket with us](https://codeclimate.com/help).