diff options
| author | Zach White <skullydazed@gmail.com> | 2020-11-07 09:56:08 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-07 09:56:08 -0800 |
| commit | 4d33d72975f2d63c7b6ff6fd4aa7e0f4c4347583 (patch) | |
| tree | afc9f0ebeeefed8405443cbe8636458d6c4c18d2 /docs/cli_commands.md | |
| parent | 7ce5402417b0332569bf48cf2c51e412cd35a18a (diff) | |
New command: qmk lint (#10761)
* Basic qmk lint command
* check for keymap readme
* change the workflow from qmk info to qmk lint
* add a strict mode
* parsing -> parse
* document qmk lint
* small info logging cleanup
* Apply suggestions from code review
Co-authored-by: Ryan <fauxpark@gmail.com>
* honor --strict in more places
* change the job name to lint
Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'docs/cli_commands.md')
| -rw-r--r-- | docs/cli_commands.md | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md index c970b1efa6..b10f5d4995 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md @@ -178,6 +178,24 @@ Creates a keymap.json from a keymap.c. qmk c2json [--no-cpp] [-o OUTPUT] filename ``` +## `qmk lint` + +Checks over a keyboard and/or keymap and highlights common errors, problems, and anti-patterns. + +**Usage**: + +``` +qmk lint [-km KEYMAP] [-kb KEYBOARD] [--strict] +``` + +This command is directory aware. It will automatically fill in KEYBOARD and/or KEYMAP if you are in a keyboard or keymap directory. + +**Examples**: + +Do a basic lint check: + + qmk lint -kb rominronin/katana60/rev2 + ## `qmk list-keyboards` This command lists all the keyboards currently defined in `qmk_firmware` @@ -309,4 +327,3 @@ This command runs the python test suite. If you make changes to python code you ``` qmk pytest ``` - |