aboutsummaryrefslogtreecommitdiff
path: root/lib/python/qmk/cli/cformat.py
diff options
context:
space:
mode:
Diffstat (limited to 'lib/python/qmk/cli/cformat.py')
-rw-r--r--lib/python/qmk/cli/cformat.py43
1 files changed, 43 insertions, 0 deletions
diff --git a/lib/python/qmk/cli/cformat.py b/lib/python/qmk/cli/cformat.py
new file mode 100644
index 0000000000..17ca91b3b5
--- /dev/null
+++ b/lib/python/qmk/cli/cformat.py
@@ -0,0 +1,43 @@
+"""Format C code according to QMK's style.
+"""
+import os
+import subprocess
+from shutil import which
+
+from milc import cli
+
+
[email protected]('files', nargs='*', arg_only=True, help='Filename(s) to format.')
[email protected]("Format C code according to QMK's style.")
+def cformat(cli):
+ """Format C code according to QMK's style.
+ """
+ # Determine which version of clang-format to use
+ clang_format = ['clang-format', '-i']
+ for clang_version in [10, 9, 8, 7]:
+ binary = 'clang-format-%d' % clang_version
+ if which(binary):
+ clang_format[0] = binary
+ break
+
+ # Find the list of files to format
+ if cli.args.files:
+ cli.args.files = [os.path.join(os.environ['ORIG_CWD'], file) for file in cli.args.files]
+ else:
+ 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'):
+ cli.args.files.append(os.path.join(dirpath, name))
+
+ # Run clang-format on the files we've found
+ try:
+ subprocess.run(clang_format + cli.args.files, check=True)
+ cli.log.info('Successfully formatted the C code.')
+
+ except subprocess.CalledProcessError:
+ cli.log.error('Error formatting C code!')
+ return False