drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

CLI/Docs: Fix the format commands' name (#13668)

Browse source 
PR #13296 changed the name of the `cformat` and `pyformat` commands to
`format-c` and `format-py` respectively. This PR updates the documentation
and some parts of the CLI to use the new names.
Also add documentation for the new `format-text` subcommand, introduced
in the same PR.
This commit is contained in:
Erovia 2021-07-23 21:41:33 +01:00 • committed by GitHub
parent 164a74a078
commit fdcea06336
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 50 additions and 39 deletions
Download patch file Download diff file Expand all files Collapse all files

2
lib/python/qmk/cli/format/c.py
View file

@ -127,7 +127,7 @@ def format_c(cli):
# Sanity check
if not files:
cli.log.error('No changed files detected. Use "qmk cformat -a" to format all core files')
cli.log.error('No changed files detected. Use "qmk format-c -a" to format all core files')
return False
# Run clang-format on the files we've found

12
lib/python/qmk/tests/test_cli_commands.py
View file

@ -31,13 +31,13 @@ def check_returncode(result, expected=[0]):
assert result.returncode in expected
def test_cformat():
result = check_subcommand('cformat', '-n', 'quantum/matrix.c')
def test_format_c():
result = check_subcommand('format-c', '-n', 'quantum/matrix.c')
check_returncode(result)
def test_cformat_all():
result = check_subcommand('cformat', '-n', '-a')
def test_format_c_all():
result = check_subcommand('format-c', '-n', '-a')
check_returncode(result, [0, 1])
@ -80,8 +80,8 @@ def test_hello():
assert 'Hello,' in result.stdout
def test_pyformat():
result = check_subcommand('pyformat', '--dry-run')
def test_format_python():
result = check_subcommand('format-python', '--dry-run')
check_returncode(result)
assert 'Python code in `bin/qmk` and `lib/python` is correctly formatted.' in result.stdout