-
-
Notifications
You must be signed in to change notification settings - Fork 277
Expand file tree
/
Copy pathcode-checker.texy
More file actions
78 lines (54 loc) · 2.59 KB
/
code-checker.texy
File metadata and controls
78 lines (54 loc) · 2.59 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
Nette Code Checker
******************
.[perex]
[Code Checker |https://github.com/nette/code-checker] controlla i tuoi file sorgente alla ricerca di difetti formali come un BOM invisibile, caratteri di controllo, codifica errata o sintassi non valida nei file PHP, Latte, NEON, JSON e YAML, e può correggerli automaticamente.
Installazione
=============
Installalo globalmente tramite Composer:
```shell
composer global require nette/code-checker
```
Assicurati che la directory globale `bin` di Composer sia nel [tuo `$PATH` |https://getcomposer.org/doc/03-cli.md#global]. Il comando `code-checker` è quindi disponibile da qualsiasi posizione, su qualsiasi sistema operativo.
In alternativa, installalo come progetto autonomo:
```shell
composer create-project nette/code-checker
```
Richiede PHP 8.0 o superiore.
Utilizzo
========
Per impostazione predefinita, Code Checker viene eseguito in modalità di sola lettura e segnala solo i problemi che trova:
```shell
code-checker
```
Per riparare effettivamente i file, aggiungi `--fix`. Esegui prima un backup dei file, oppure eseguilo su un albero di lavoro pulito così potrai rivedere le modifiche in seguito con `git diff`:
```shell
code-checker --fix
```
Puoi limitare la scansione a un percorso specifico, saltare file o eseguire controlli più rapidi solo sulla sintassi:
```shell
code-checker -d src --ignore "temp/*"
code-checker --only-syntax
```
In modalità di sola lettura lo strumento esce con codice `0` quando tutto è a posto e `1` quando viene trovato un problema, quindi si integra perfettamente nelle pipeline CI.
Elenco completo delle opzioni:
```
Usage: code-checker [options]
Options:
-d <path> Folder or file to scan (default: current directory)
-i | --ignore <mask> Files to ignore
-f | --fix Fix the files
-l | --eol Normalize line endings to the system default
--only-syntax Check syntax only (faster)
--no-progress Do not show progress dots
--version Show version
```
Cosa fa Code Checker
====================
- controlla la sintassi dei template [Latte |latte:] e dei file `.php`, `.neon` e `.json`
- rimuove il [BOM |nette:glossary#BOM]
- verifica che i file siano UTF-8 validi
- controlla la presenza di [caratteri di controllo |nette:glossary#Caratteri di controllo]
- rileva commenti phpDoc malformati (es. `/* @var` invece di `/** @var`)
- impone l'indentazione con tabulazioni nei file PHP, CSS, JS e TS, e con spazi in YAML
- rimuove gli spazi finali e le righe vuote alla fine dei file
- normalizza i fine riga al valore predefinito di sistema (con il parametro `-l`)