Merge: introduce nit_env.sh to setup the shell environement
[nit.git] / share / man / nitpick.md
1 # NAME
2
3 nitpick - collect potential style and code issues.
4
5 # SYNOPSIS
6
7 nitpick [*options*] FILE...
8
9 # DESCRIPTION
10
11 `nitpick` is a fast code checker.
12
13 It is currently used with the vim syntactic plugin.
14
15 # OPTIONS
16
17 ### `--vim-autocomplete`
18 Generate metadata files used by the Vim plugin for autocompletion.
19
20 This option is not expected to be called directly by users.
21
22 # SEE ALSO
23
24 The Nit language documentation and the source code of its tools and libraries may be downloaded from <http://nitlanguage.org>