diff options
| -rw-r--r-- | docs/cli.md | 10 | ||||
| -rw-r--r-- | lib/python/qmk/cli/cformat.py | 27 |
2 files changed, 37 insertions, 0 deletions
diff --git a/docs/cli.md b/docs/cli.md index 1843f42cd1..4b8472b19e 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -36,3 +36,13 @@ qmk compile <configuratorExport.json> ``` qmk compile -kb <keyboard_name> -km <keymap_name> ``` + +## `qmk cformat` + +This command formats C code using clang-format. Run it with no arguments to format all core code, or pass filenames on the command line to run it on specific files. + +**Usage**: + +``` +qmk cformat [file1] [file2] [...] [fileN] +``` diff --git a/lib/python/qmk/cli/cformat.py b/lib/python/qmk/cli/cformat.py new file mode 100644 index 0000000000..f7020f4c5f --- /dev/null +++ b/lib/python/qmk/cli/cformat.py @@ -0,0 +1,27 @@ +"""Format C code according to QMK's style. +""" +import os +import subprocess + +from milc import cli + + +@cli.entrypoint("Format C code according to QMK's style.") +def main(cli): + """Format C code according to QMK's style. + """ + clang_format = ['clang-format', '-i'] + code_files = [] + for dir in ['drivers', 'quantum', 'tests', 'tmk_core']: + for dirpath, dirnames, filenames in os.walk(dir): + if 'tmk_core/protocol/usb_hid' in dirpath: + continue + for name in filenames: + if name.endswith('.c') or name.endswith('.h') or name.endswith('.cpp'): + code_files.append(os.path.join(dirpath, name)) + + try: + subprocess.run(clang_format + code_files, check=True) + cli.log.info('Successfully formatted the C code.') + except subprocess.CalledProcessError: + cli.log.error('Error formatting C code!') |