qmk_firmware/lib/python/qmk/cli/cformat.py

35 lines
1.1 KiB
Python
Raw Normal View History

2019-08-22 17:18:52 +00:00
"""Format C code according to QMK's style.
"""
import os
import subprocess
from milc import cli
@cli.argument('files', nargs='*', help='Filename(s) to format.')
2019-08-22 17:18:52 +00:00
@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']
2019-08-22 20:33:34 +00:00
# Find the list of files to format
if not cli.args.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
2019-08-22 20:33:34 +00:00
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))
2019-08-22 17:18:52 +00:00
2019-08-22 20:33:34 +00:00
# Run clang-format on the files we've found
2019-08-22 17:18:52 +00:00
try:
subprocess.run(clang_format + cli.args.files, check=True)
2019-08-22 17:18:52 +00:00
cli.log.info('Successfully formatted the C code.')
2019-08-22 20:33:34 +00:00
2019-08-22 17:18:52 +00:00
except subprocess.CalledProcessError:
cli.log.error('Error formatting C code!')
return False