Nette Documentation Preview

syntax
Nette Code Checker
******************

.[perex]
Инструмент [Code Checker |https://github.com/nette/code-checker] проверяет и при необходимости исправляет некоторые формальные ошибки в ваших исходных кодах.


Установка
=========

Code Checker не следует добавлять в зависимости, а устанавливать как проект.

```shell
composer create-project nette/code-checker
```

Или установите его глобально с помощью:

```shell
composer global require nette/code-checker
```

и убедитесь, что ваш глобальный каталог `vendor/bin` находится в [переменной окружения $PATH |https://getcomposer.org/doc/03-cli.md#global].


Использование
=============

```
Usage: php code-checker [options]

Options:
	-d <path>             Folder or file to scan (default: current directory)
	-i | --ignore <mask>  Files to ignore
	-f | --fix            Fixes files
	-l | --eol            Convert newline characters
	--no-progress         Do not show progress dots
	--strict-types        Checks whether PHP 7.0 directive strict_types is enabled
```

Без параметров проверяет текущий каталог в режиме только для чтения, с параметром `-f` исправляет файлы.

Прежде чем ознакомиться с ним, обязательно сделайте резервную копию файлов.

Для более легкого запуска можно создать файл `code.bat`:

```shell
php path_to_Nette_tools\Code-Checker\code-checker %*
```


Что он делает?
==============

- удаляет [BOM |nette:glossary#BOM]
- проверяет валидность шаблонов [Latte |latte:]
- проверяет валидность файлов `.neon`, `.php` и `.json`
- проверяет наличие [управляющих символов |nette:glossary#Управляющие символы]
- проверяет, закодирован ли файл в UTF-8
- проверяет неправильно записанные `/* @anotace */` (отсутствует звездочка)
- удаляет завершающий `?>` у PHP-файлов
- удаляет пробелы в конце строк и лишние строки в конце файла
- нормализует разделители строк до системных (если указана опция `-l`)

{{leftbar: www:@menu-common}}

Nette Code Checker

Инструмент Code Checker проверяет и при необходимости исправляет некоторые формальные ошибки в ваших исходных кодах.

Установка

Code Checker не следует добавлять в зависимости, а устанавливать как проект.

composer create-project nette/code-checker

Или установите его глобально с помощью:

composer global require nette/code-checker

и убедитесь, что ваш глобальный каталог vendor/bin находится в переменной окружения $PATH.

Использование

Usage: php code-checker [options]

Options:
	-d <path>             Folder or file to scan (default: current directory)
	-i | --ignore <mask>  Files to ignore
	-f | --fix            Fixes files
	-l | --eol            Convert newline characters
	--no-progress         Do not show progress dots
	--strict-types        Checks whether PHP 7.0 directive strict_types is enabled

Без параметров проверяет текущий каталог в режиме только для чтения, с параметром -f исправляет файлы.

Прежде чем ознакомиться с ним, обязательно сделайте резервную копию файлов.

Для более легкого запуска можно создать файл code.bat:

php path_to_Nette_tools\Code-Checker\code-checker %*

Что он делает?

  • удаляет BOM
  • проверяет валидность шаблонов Latte
  • проверяет валидность файлов .neon, .php и .json
  • проверяет наличие управляющих символов
  • проверяет, закодирован ли файл в UTF-8
  • проверяет неправильно записанные /* @anotace */ (отсутствует звездочка)
  • удаляет завершающий ?> у PHP-файлов
  • удаляет пробелы в конце строк и лишние строки в конце файла
  • нормализует разделители строк до системных (если указана опция -l)