Commit Graph

40 Commits

Author SHA1 Message Date
Joel Challis
0ca620a7f6 Fix cformat processing files within ignore folders (#8063) 2020-02-26 10:15:12 +09:00
Mikkel Jeppesen
b1f101030b Qmk doctor os check to support newer msys2/w10 installations (#8031)
* Fixed OS detection on newer MSYS installations

* made OS sting lower case
2020-02-26 10:15:12 +09:00
skullydazed
41b518c55f Beef up how qmk doctor works. (#7375)
* Beef up how `qmk doctor` works.

* improve the `git submodule status` parsing. h/t @erovia

* Fix whitespace and imports

* yapf

* Add documentation for the new doctor functionality

* Replace type_unchanged() with str()

* remove unused modules

* Update lib/python/qmk/cli/doctor.py

Co-Authored-By: Erovia <Erovia@users.noreply.github.com>

Co-authored-by: Erovia <Erovia@users.noreply.github.com>
2020-02-26 10:15:12 +09:00
Joel Challis
72c5e4958c Align cformat rules with current CI implementation (#7936)
* Align cformat rules with current CI implementation

* Optimise file walking
2020-02-26 10:15:12 +09:00
Erovia
97038602f5 Fix attribute heritance for long commands.
This is needed for inheritance to work with commands that have dashes in
their names.
2020-02-26 10:15:12 +09:00
Erovia
6a5afb67fd Fix commandline arg merging, small improvements
Commandline args should be merged with the submodule's config.
Compare config values to None instead of False, so empty lines and False
can be used as values.
2020-02-26 10:15:12 +09:00
Erovia
bbcc605195 MILC: Fix/complete attribute heritance
If an undefined attribute of a submodule is accessed, fall back to
same attribute of the submodule's parent.
2020-02-26 10:15:12 +09:00
skullY
06e5032ad3 yapf and style 2020-02-26 10:15:12 +09:00
Erovia
dc05100c4c Make the udev rules easier to read and manage 2020-02-26 10:15:12 +09:00
Erovia
d37042f31c Fix Pro Micro's and its bootloader's name 2020-02-26 10:15:12 +09:00
Erovia
dac9a94d17 CLI: Rework ModemManager check and add udev check 2020-02-26 10:15:12 +09:00
skullY
0f1f9ba155 Add pep8-naming to our python linting 2020-01-09 08:57:11 +09:00
Erovia
ac75812e50 MILC: Add support for hidden subcommands (#7034)
* MILC: Add support for hidden subcommands

Subcommands with 'hidden=True' will not show up in the help output, but
will work as any other subcommands.

* Hide those hidden submodules, for real now

* Rebase on latest MILC
2020-01-09 08:57:11 +09:00
skullydazed
dfa3631a44 Add flake8 to our test suite and fix all errors (#7379)
* Add flake8 to our test suite and fix all errors

* Add some documentation
2020-01-09 08:57:11 +09:00
skullydazed
4dc4b7af75 Improve a number of things about how MILC operates (#7344)
* Pull in updates for MILC

* Remove the shadow argparser
* Make it easier to reason about arguments and how they're translated into the config tree
* Populate self.config during init to support setting user.qmk_home for the global CLI
* Remove the short argument -c so that we can unambiguously determine the config file location without doing full argument processing
* Remove the --save-config option as it's a little confusing anyway
* Use Pathlib for path manipulation

* Fix commands with no arguments
2020-01-09 08:57:11 +09:00
QMK Bot
6f57ecc58e format code according to conventions [skip ci] 2020-01-09 08:57:11 +09:00
jorgemanzo
d459da0c95 Add CLI command for flashing a keyboard
A new CLI subcommand was added, flash, which behaves very similar to the already present compile CLI comamnd, but with the added ability to target a bootloader. The command is used like so: qmk flash [-h] [-b] [-kb KEYBOARD] [-km KEYMAP] [-bl BOOTLOADER] [filename].

A -kb <keyboard> and -km <keymap> is expected, or a configurator export JSON filename. A bootloader can be specified using -bl <target>, and if left unspecified, the target is assumed to be :flash. -bl can be used to list the available bootloaders.

If -km <keymap> is provided, but no -kb <keyboard>, then a message is printed suggesting the user to run qmk list_keyboards.
2020-01-09 08:57:11 +09:00
QMK Bot
22891f9c83 format code according to conventions [skip ci] 2020-01-09 08:57:11 +09:00
Cody Bender
31608fe2a9 Add cli convert subcommand, from raw KLE to JSON (#6898)
* Add initial pass at KLE convert

* Add cli log on convert

* Move kle2xy, add absolute filepath arg support

* Add overwrite flag, and context sensitive conversion

* Update docs/cli.md

* Fix converter.py typo

* Add convert unit test

* Rename to kle2qmk

* Rename subcommand

* Rename subcommand to kle2json

* Change tests to cover rename

* Rename in __init__.py

* Update CLI docs with new subcommand name

* Fix from suggestions in PR #6898

* Help with cases of case sensitivity

* Update cli.md

* Use angle brackets to indicate required option

* Make the output text more accurate
2020-01-09 08:57:11 +09:00
skullY
853394f8e1 Make generating keymap.c from JSON more reliable 2020-01-09 08:57:11 +09:00
skullY
8d35ebab7f Small CLI cleanups
* yapf changes
* Fix the cformat test
* Make the normpath test work when run from /
* `qmk config`: Mark `--read-only` as arg_only
2020-01-09 08:57:11 +09:00
skullY
55b2c4c1ed When checking program returncodes treat both 0 and 1 as installed 2020-01-09 08:57:11 +09:00
skullY
06a8a3c0d3 Add support for newer versions of clang-format, if installed 2020-01-09 08:57:11 +09:00
Erovia
e3e2489f86 MILC: Use dashes instead of underscores for subcommands
The subcommand functions' name follows the Python convention of using
snake case, but looks odd on the command line.
Fix it by converting underscores to dashes, eg.: list_keyboards ->
list-keyboards.
2019-11-04 16:51:03 +09:00
Harry Wada
415ab3c96c Fix detection of ModemManager (#7076) 2019-11-04 16:51:03 +09:00
Dan McClain
be4771380f [CLI] Add qmk list_keyboards (#6927)
`list_keyboards` replicates the `make list-keyboards` by globbing for all paths
that include `rules.mk` and then removing the paths that include `keymaps`.

This basis of this cli command could be reused in the future as a util, but is
not done so here since this would be the only place that would use it currently

Resolves #6911
2019-11-04 16:51:03 +09:00
St. John Johnson
56dd8cfe48 Use keymap instead of username variable for qmk new_keymap (#6885)
Username is not defined and this causes `qmk new_keymap` to error.  This
appears to have originated from a partial update in
https://github.com/qmk/qmk_firmware/pull/6708/files#diff-d5208bcbc79aa428556a743b6ff41086.  This change completes the migration from `username` to `keymap`
2019-11-04 16:51:03 +09:00
Ayman Bagabas
74d3820ff4 Fix qmk doctor 'bytes-like object is required' on linux
This fixes the following issue related to encoding on linux systems. Add
`universal_newlines=True` to subprocess.

<class 'TypeError'>
☒ a bytes-like object is required, not 'str'
Traceback (most recent call last):
  File "/usr/local/lib/python3.7/site-packages/milc.py", line 564, in __call__
    return self.__call__()
  File "/usr/local/lib/python3.7/site-packages/milc.py", line 569, in __call__
    return self._entrypoint(self)
  File "$HOME/qmk_firmware/lib/python/qmk/cli/doctor.py", line 56, in doctor
    for line in mm_check.stdout.split('\n'):
TypeError: a bytes-like object is required, not 'str'
2019-11-04 16:51:03 +09:00
skullydazed
3f2ea83234 Configuration system for CLI (#6708)
* 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
2019-11-04 16:51:03 +09:00
Kenny Hoang
5ad8d221c8 Created new_keymap.py, python version of new_keymap.sh (#6066)
* Created python version of new_keymap.sh: new_keymap.py

* Updated usage message

* Updated new_keymap.py to use python3.5+ syntax & be more similar to new_keyboard.sh

* Updated complete message

* Updated usage in argparser and removed incorrect usage_message

* Reverted the fstrings back to strings that use .format() & updated docstring convention

* Added helper to recursively cd .. until at qmk_firmware root directory

* Revert "Added helper to recursively cd .. until at qmk_firmware root directory"

This reverts commit 61a0ff3b25f91901287bec8d58eb51a1f126e2ad.

* Updated new_keymap.py to use printf-style format strings

* First draft lib/python/qmk/cli/new/keymap.py with milc

* Removed shebang & syspath appending lines

* Added optional args & resolved some cr comemnts

* Added a docstring and updated strings
2019-09-26 10:08:39 +09:00
skullY
74d97c7c1d Add a command to format python code 2019-09-26 10:08:39 +09:00
skullY
6d891bfae9 Make the modem manager check more pythonic 2019-09-26 10:08:39 +09:00
skullY
3cb9a24bff run yapf on the code 2019-09-26 10:08:39 +09:00
skullY
50f3d2556d Setup a python test framework 2019-09-26 10:08:39 +09:00
skullY
128bde1be1 readability enhancements 2019-09-26 10:08:39 +09:00
skullY
ffca0ecd0a Add support for passing files at the command line 2019-09-26 10:08:39 +09:00
skullY
56443ee486 CLI command to format C code 2019-09-26 10:08:39 +09:00
skullydazed
ca5162b90e Refactor qmk compile-json to qmk compile (#6592) 2019-08-28 14:55:37 +09:00
skullydazed
8ca6a89078 Fix compiling json files. (#6340) 2019-07-19 10:05:36 +09:00
skullydazed
7e080e7ecd QMK CLI and JSON keymap support (#6176)
* Script to generate keymap.c from JSON file.

* Support for keymap.json

* Add a warning about the keymap.c getting overwritten.

* Fix keymap generating

* Install the python deps

* Flesh out more of the python environment

* Remove defunct json2keymap

* Style everything with yapf

* Polish up python support

* Hide json keymap.c into the .build dir

* Polish up qmk-compile-json

* Make milc work with positional arguments

* Fix a couple small things

* Fix some errors and make the CLI more understandable

* Make the qmk wrapper more robust

* Add basic QMK Doctor

* Clean up docstrings and flesh them out as needed

* remove unused compile_firmware() function
2019-07-19 10:05:36 +09:00