Nette Documentation Preview

syntax
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
```

и убедитесь, что каталог глобальных двоичных файлов поставщика находится в [вашей переменной окружения `$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`, для более удобного запуска Code-Checker под Windows:

```shell
php path_to\Nette_tools\Code-Checker\code-checker %*
```


Что делает Code-Checker?
========================

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

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

Code Checker

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

Установка

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

composer create-project nette/code-checker

Или установите его глобально через:

composer global require nette/code-checker

и убедитесь, что каталог глобальных двоичных файлов поставщика находится в вашей переменной окружения $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, для более удобного запуска Code-Checker под Windows:

php path_to\Nette_tools\Code-Checker\code-checker %*

Что делает Code-Checker?

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