* 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
		
			
				
	
	
		
			55 lines
		
	
	
		
			1.7 KiB
		
	
	
	
		
			Python
		
	
	
		
			Executable File
		
	
	
	
	
			
		
		
	
	
			55 lines
		
	
	
		
			1.7 KiB
		
	
	
	
		
			Python
		
	
	
		
			Executable File
		
	
	
	
	
| """Generate a keymap.c from a configurator export.
 | |
| """
 | |
| import json
 | |
| import os
 | |
| import sys
 | |
| 
 | |
| from milc import cli
 | |
| 
 | |
| import qmk.keymap
 | |
| 
 | |
| 
 | |
| @cli.argument('-o', '--output', arg_only=True, help='File to write to')
 | |
| @cli.argument('filename', arg_only=True, help='Configurator JSON file')
 | |
| @cli.subcommand('Create a keymap.c from a QMK Configurator export.')
 | |
| def json_keymap(cli):
 | |
|     """Generate a keymap.c from a configurator export.
 | |
| 
 | |
|     This command uses the `qmk.keymap` module to generate a keymap.c from a configurator export. The generated keymap is written to stdout, or to a file if -o is provided.
 | |
|     """
 | |
|     # Error checking
 | |
|     if cli.args.filename == ('-'):
 | |
|         cli.log.error('Reading from STDIN is not (yet) supported.')
 | |
|         cli.print_usage()
 | |
|         exit(1)
 | |
|     if not os.path.exists(qmk.path.normpath(cli.args.filename)):
 | |
|         cli.log.error('JSON file does not exist!')
 | |
|         cli.print_usage()
 | |
|         exit(1)
 | |
| 
 | |
|     # Environment processing
 | |
|     if cli.args.output == ('-'):
 | |
|         cli.args.output = None
 | |
| 
 | |
|     # Parse the configurator json
 | |
|     with open(qmk.path.normpath(cli.args.filename), 'r') as fd:
 | |
|         user_keymap = json.load(fd)
 | |
| 
 | |
|     # Generate the keymap
 | |
|     keymap_c = qmk.keymap.generate(user_keymap['keyboard'], user_keymap['layout'], user_keymap['layers'])
 | |
| 
 | |
|     if cli.args.output:
 | |
|         output_dir = os.path.dirname(cli.args.output)
 | |
| 
 | |
|         if not os.path.exists(output_dir):
 | |
|             os.makedirs(output_dir)
 | |
| 
 | |
|         output_file = qmk.path.normpath(cli.args.output)
 | |
|         with open(output_file, 'w') as keymap_fd:
 | |
|             keymap_fd.write(keymap_c)
 | |
| 
 | |
|         cli.log.info('Wrote keymap to %s.', cli.args.output)
 | |
| 
 | |
|     else:
 | |
|         print(keymap_c)
 |