PHPackages                             phbsis/kr04-php-lint - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. phbsis/kr04-php-lint

ActiveLibrary[Utility & Helpers](/categories/utility)

phbsis/kr04-php-lint
====================

The OKR's Project! #KR04

v0.5(8y ago)131GNUPHPPHP ^5.6

Since Aug 30Pushed 8y ago1 watchersCompare

[ Source](https://github.com/br-monteiro/php-lint-project)[ Packagist](https://packagist.org/packages/phbsis/kr04-php-lint)[ Docs](https://github.com/br-monteiro/php-lint-project)[ RSS](/packages/phbsis-kr04-php-lint/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependencies (1)Versions (8)Used By (0)

KR04 PHP Linter
---------------

[](#kr04-php-linter)

Este projeto foi criado para atender ao cronograma de tarefas das OKRs de oito semanas na *Chaordic Systems*. Porém, pode ser perfeitamente usado, modificado ou adaptado pela comunidade. O KR04 foi criado para verificar se os códigos PHP do seu projeto estão de acordo com alguns padrões, dentre eles: **Sintaxe, PSR-2, PSR-3** e **Chaordic Patterns**.

### Dependências

[](#dependências)

- PHP 5.6+
- Composer

### Instalação

[](#instalação)

Para instalar o KR04 use o Composer. Esta documentação assume que você já tem o Composer instalado em sua máquina. Caso precise instalar o Composer siga a [documentação oficial](https://getcomposer.org/). Abaixo é possível observar um exemplo de configuração do arquivo ***composer.json***.

```
{
    "require": {
        "phbsis/kr04-php-lint": "^0.5.0"
    },
    "scripts": {
        "post-install-cmd": [
            "php -r \"copy('vendor/phbsis/kr04-php-lint/index.php', 'checker-kr04');\""
        ],
        "post-update-cmd": [
            "php -r \"copy('vendor/phbsis/kr04-php-lint/index.php', 'checker-kr04');\""
        ]
    }
}
```

Após configurar o arquivo ***composer.json***, rode o comando composer install e aguarde o final da instalação.

```
$ composer install
```

Ao final do processo, se tudo ocorrer com sucesso, será possível observar o arquivo **checker-kr04** na raiz do projeto; este será usado como *executável* da biblioteca KR04.

### Como usar o KR04

[](#como-usar-o-kr04)

Por padrão, a biblioteca já vem com os checadores de Sintaxe, PSR-2, PSR-3 e padrões usados na Chaordic Systems. É importante informar que não foram implementadas todas as regras das PSRs citadas acima. Continuando com as informações de uso, assumindo que você já se encontra no diretório raiz do seu projeto, basta rodar no terminal o comando:

```
php checker-kr04
```

### Parâmetros especiais no terminal

[](#parâmetros-especiais-no-terminal)

O KR04 também possui alguns parâmetros que podem ser passados ao executar a verificação de seus aquivos PHP. Abaixo é possível ver a lista de atributos que já são usados pelo sistema. Caso seja necessário, também é possível receber os parâmetros nas Classes Checkers através da Injeção de Dependência de *KR04\\Cli\\Commands* que toda Checker possui.

**list** : Lista todos os Checkers registrados no sistema.

```
php checker-kr04 --list
```

**stop** : Para a execução no primeiro erro encontrado.

```
php checker-kr04 --stop
```

**only** : Executa somente os Checkers passados como parâmetro.

```
php checker-kr04 --only=chaordicpatternchecker,syntaxchecker
```

**except** : Executa todos os demais Checkers, exceto os passados como parâmetro.

```
php checker-kr04 --except=syntaxchecker
```

### Criando novas regras de verificação

[](#criando-novas-regras-de-verificação)

Novas regras podem ser criadas para atenderem às particularidades dos seus projetos. Para criar uma nova regra é muito simples, porém algumas passos devem ser seguidos para o correto funcionamento do sistema. Uma nova classe de regra (Checker) se parece com o seguinte:

```