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 1 commit
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
9 changes: 8 additions & 1 deletion 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,7 @@

@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.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 +62,11 @@ def format_json(cli):

json_file['layers'][layer_num] = current_layer

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
print(json.dumps(json_file, cls=json_encoder, sort_keys=True))
print(output)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like with --inplace it would both write the formatted JSON back into the file and print the same JSON to stdout; is this intended and useful?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes - I didn't want to remove the stdout output as to maintain as much parity with existing functionality as possible.
If you think it's better to be removed, it's a trivial change to make.

In terms of usefulness - I suppose it could be useful as a gut-check for someone to look at after the command runs, but they can also just do a git diff or open the formatted info.json.

Happy to do whichever the QMK team wants.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

imo, returning something like qmk format-c is doing by default https://github.com/qmk/qmk_firmware/blob/develop/lib/python/qmk/cli/format/c.py#L60 would probably be preferred to standardize on output and function . maybe do a -v or -p option to verbose/output in terminal. Up to QMK team for sure, thanks for the PR 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dexter93 I think that approach is really nice, I'll implement it. Hopefully the QMK team likes it!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I looked again - I realized that the format-c command seems to run in-place and modify the file by default. Setting --dry-run causes the output to be print to stdout.

Given format-json already has different default behavior, and changing it to run in-place without printing could break user expectations - I think adding the --print flag is still the right call.