vsushkov/oggetto-coding-standard

PHP Code Sniffer rules for Oggetto coding standard

Oggetto Coding Standard

Репозиторий содержит правила для PHP Code Sniffer, которые автоматизируют проверку PHP-кода на соответствие корпоративному стандарту Oggetto Web.

Описание стандарта: http://oggettoweb.github.io/docs/php/code_style/index.html

Установка из консоли

1. Установить composer в папку с проектом

$ curl -sS https://getcomposer.org/installer | php

2. Добавить в composer.json:

{
    "require": {
        "oggettoweb/coding_standard": "dev-master"
    },
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/OggettoWeb/Oggetto-Coding-Standard"
        }
    ]
}

3. Установить стандарт:

$ php composer.phar install

4. Запустить сниффер:

$ vendor/bin/phpcs --standard=vendor/oggettoweb/coding_standard/Oggetto/ /path/to/php/code

5. Для удобства использования можно добавить алиас в ~/.bashrc:

alias cs="vendor/bin/phpcs --standard=vendor/oggettoweb/coding_standard/Oggetto/"

И запускать сниффер вот так:

$ cs /path/to/php/code

Установка в PHPStorm

1. Для начала, необходимо добавить новый scope, чтобы сниффером проверялись только классы из папки local. Для этого в настройках PHPStorm находим Scopes, в них добавляем новый как показано на иллюстриции:
   
2. Далее, находим в настройках раздел Inspections, в нем PHP Code Shiffer validation:
   
3. Нажимаем правой кнопкой мыщи и указываем scope:
   
4. Выбираем стандарт:
   
5. Указываем полный путь к папке со стандартом внутри vendor:
   

Установка в git pre-commit

...