Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

qmk format-json: Add an in-place mode to format json command #21610

Merged
merged 3 commits into from
Sep 14, 2023
Merged

qmk format-json: Add an in-place mode to format json command #21610

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8b73c6f
Add inplace mode to format-json CLI command
awkannan Jul 25, 2023
d2d82aa
Add print flag
awkannan Jul 27, 2023
539ee8a
Update lib/python/qmk/cli/format/json.py
Sep 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions lib/python/qmk/cli/format/json.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@

@cli.argument('json_file', arg_only=True, type=normpath, help='JSON file to format')
@cli.argument('-f', '--format', choices=['auto', 'keyboard', 'keymap'], default='auto', arg_only=True, help='JSON formatter to use (Default: autodetect)')
@cli.argument('-i', '--inplace', action='store_true', arg_only=True, help='If set, will operate in-place on the input file')
@cli.argument('-p', '--print', action='store_true', arg_only=True, help='If set, will print the formatted json to stdout ')
@cli.subcommand('Generate an info.json file for a keyboard.', hidden=False if cli.config.user.developer else True)
def format_json(cli):
"""Format a json file.
Expand Down Expand Up @@ -61,5 +63,14 @@ def format_json(cli):

json_file['layers'][layer_num] = current_layer

# Display the results
print(json.dumps(json_file, cls=json_encoder, sort_keys=True))
output = json.dumps(json_file, cls=json_encoder, sort_keys=True)

if cli.args.inplace:
with open(cli.args.json_file, 'w+') as outfile:
awkannan marked this conversation as resolved.
Show resolved Hide resolved
outfile.write(output)

# Display the results if print was set
# We don't operate in-place by default, so also display to stdout
# if in-place is not set.
if cli.args.print or not cli.args.inplace:
print(output)