mirror of
				https://github.com/mfulz/qmk_firmware.git
				synced 2025-11-04 07:12:33 +01:00 
			
		
		
		
	* 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
		
			
				
	
	
		
			35 lines
		
	
	
		
			1.1 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
			
		
		
	
	
			35 lines
		
	
	
		
			1.1 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
"""Format C code according to QMK's style.
 | 
						|
"""
 | 
						|
import os
 | 
						|
import subprocess
 | 
						|
 | 
						|
from milc import cli
 | 
						|
 | 
						|
 | 
						|
@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):
 | 
						|
    """Format C code according to QMK's style.
 | 
						|
    """
 | 
						|
    clang_format = ['clang-format', '-i']
 | 
						|
 | 
						|
    # 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
 | 
						|
 | 
						|
                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
 |