PHP Code Sniffer rules for Oggetto coding standard
PHP
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Oggetto
.gitignore
README.md
composer.json

README.md

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
  1. Добавить в composer.json:
{
    "require": {
        "oggettoweb/coding_standard": "dev-master"
    },
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/OggettoWeb/Oggetto-Coding-Standard"
        }
    ]
}
  1. Установить стандарт:
$ php composer.phar install
  1. Запустить сниффер:
$ vendor/bin/phpcs --standard=vendor/oggettoweb/coding_standard/Oggetto/ /path/to/php/code
  1. Для удобства использования можно добавить алиас в ~/.bashrc:
alias cs="vendor/bin/phpcs --standard=vendor/oggettoweb/coding_standard/Oggetto/"

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

$ cs /path/to/php/code

Установка в PHPStorm

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

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

...