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

45 lines
1.5 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 shutil import which
2019-08-22 17:18:52 +00:00
from milc import cli
Configuration system for CLI (#6708) * Rework how bin/qmk handles subcommands * qmk config wip * Code to show all configs * Fully working `qmk config` command * Mark some CLI arguments so they don't pollute the config file * Fleshed out config support, nicer subcommand support * sync with installable cli * pyformat * Add a test for subcommand_modules * Documentation for the `qmk config` command * split config_token on space so qmk config is more predictable * Rework how subcommands are imported * Document `arg_only` * Document deleting from CLI * Document how multiple operations work * Add cli config to the doc index * Add tests for the cli commands * Make running the tests more reliable * Be more selective about building all default keymaps * Update new-keymap to fit the new subcommand style * Add documentation about writing CLI scripts * Document new-keyboard * Update docs/cli_configuration.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/cli_development.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/cli_development.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/cli_development.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Address yan's comments. * Apply suggestions from code review suggestions from @noahfrederick Co-Authored-By: Noah Frederick <code@noahfrederick.com> * Apply suggestions from code review Co-Authored-By: Noah Frederick <code@noahfrederick.com> * Remove pip3 from the test runner
2019-09-22 20:25:33 +00:00
@cli.argument('files', nargs='*', arg_only=True, help='Filename(s) to format.')
@cli.subcommand("Format C code according to QMK's style.")
def cformat(cli):
2019-08-22 17:18:52 +00:00
"""Format C code according to QMK's style.
"""
# Determine which version of clang-format to use
2019-08-22 17:18:52 +00:00
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
2019-08-22 20:33:34 +00:00
# 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:
ignores = ['tmk_core/protocol/usb_hid', 'quantum/template']
for dir in ['drivers', 'quantum', 'tests', 'tmk_core']:
for dirpath, dirnames, filenames in os.walk(dir):
if any(i in dirpath for i in ignores):
dirnames.clear()
2019-08-22 20:33:34 +00:00
for name in filenames:
if name.endswith(('.c', '.h', '.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