Nette Documentation Preview

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

.[perex]
Narzędzie [Code Checker |https://github.com/nette/code-checker] sprawdza i ewentualnie naprawia niektóre formalne błędy w Twoich kodach źródłowych.


Instalacja
==========

Code Checker nie powinien być dodawany do zależności, ale instalowany jako projekt.

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

Lub zainstaluj go globalnie za pomocą:

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

i upewnij się, że twój globalny katalog `vendor/bin` jest w [zmiennej środowiskowej $PATH |https://getcomposer.org/doc/03-cli.md#global].


Użycie
======

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

Options:
	-d <path>             Katalog lub plik do skanowania (domyślnie: bieżący katalog)
	-i | --ignore <mask>  Pliki do ignorowania
	-f | --fix            Naprawia pliki
	-l | --eol            Konwertuj znaki nowej linii
	--no-progress         Nie pokazuj kropek postępu
	--strict-types        Sprawdza, czy dyrektywa PHP 7.0 strict_types jest włączona
```

Bez parametrów sprawdza bieżący katalog w trybie tylko do odczytu, z parametrem `-f` naprawia pliki.

Zanim się z nim zapoznasz, na pewno najpierw zrób kopię zapasową plików.

Dla łatwiejszego uruchamiania możemy utworzyć plik `code.bat`:

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


Co wszystko robi?
=================

- usuwa [BOM |nette:glossary#BOM]
- sprawdza poprawność szablonów [Latte |latte:]
- sprawdza poprawność plików `.neon`, `.php` i `.json`
- sprawdza występowanie [znaków kontrolnych |nette:glossary#Znaki kontrolne]
- sprawdza, czy plik jest zakodowany w UTF-8
- sprawdza błędnie zapisane `/* @adnotacje */` (brakuje gwiazdki)
- usuwa kończące `?>` w plikach PHP
- usuwa prawostronne spacje i zbędne linie na końcu pliku
- normalizuje separatory linii do systemowych (jeśli podasz opcję `-l`)

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

Nette Code Checker

Narzędzie Code Checker sprawdza i ewentualnie naprawia niektóre formalne błędy w Twoich kodach źródłowych.

Instalacja

Code Checker nie powinien być dodawany do zależności, ale instalowany jako projekt.

composer create-project nette/code-checker

Lub zainstaluj go globalnie za pomocą:

composer global require nette/code-checker

i upewnij się, że twój globalny katalog vendor/bin jest w zmiennej środowiskowej $PATH.

Użycie

Usage: php code-checker [options]

Options:
	-d <path>             Katalog lub plik do skanowania (domyślnie: bieżący katalog)
	-i | --ignore <mask>  Pliki do ignorowania
	-f | --fix            Naprawia pliki
	-l | --eol            Konwertuj znaki nowej linii
	--no-progress         Nie pokazuj kropek postępu
	--strict-types        Sprawdza, czy dyrektywa PHP 7.0 strict_types jest włączona

Bez parametrów sprawdza bieżący katalog w trybie tylko do odczytu, z parametrem -f naprawia pliki.

Zanim się z nim zapoznasz, na pewno najpierw zrób kopię zapasową plików.

Dla łatwiejszego uruchamiania możemy utworzyć plik code.bat:

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

Co wszystko robi?

  • usuwa BOM
  • sprawdza poprawność szablonów Latte
  • sprawdza poprawność plików .neon, .php.json
  • sprawdza występowanie znaków kontrolnych
  • sprawdza, czy plik jest zakodowany w UTF-8
  • sprawdza błędnie zapisane /* @adnotacje */ (brakuje gwiazdki)
  • usuwa kończące ?> w plikach PHP
  • usuwa prawostronne spacje i zbędne linie na końcu pliku
  • normalizuje separatory linii do systemowych (jeśli podasz opcję -l)