close
The Wayback Machine - https://web.archive.org/web/20220509100128/https://github.com/qmk/qmk_firmware/issues/12446
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.

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

[Feature Request] Command to edit info.json files #12446

Open
2 tasks done
skullydazed opened this issue Mar 31, 2021 · 1 comment
Open
2 tasks done

[Feature Request] Command to edit info.json files #12446

skullydazed opened this issue Mar 31, 2021 · 1 comment

Comments

@skullydazed
Copy link

@skullydazed skullydazed commented Mar 31, 2021

Feature Request Type

  • Core functionality
  • New behavior

Description

We now have the pieces in place to build a TUI for editing a keyboard. The info.json can be used to describe all the basic attributes of a keyboard and we have a jsonschema for that file in data/schemas/keyboard.jsonschema.

We should have a qmk edit -kb <keyboard> command that gives a friendly interface for editing. It should use the schema file to know what a valid info.json looks like, and when new items are added to the schema it should not be necessary to change qmk edit. The interface should be similar to other configuration TUI's, such as raspberry pi's raspi-config or make menuconfig used by linux, busybox, and other projects.

When it comes to choosing a TUI library for this long term maintainability is the most important factor. It would be nice if we could use the curses library and not have to include more dependencies, but that library is pretty low level and doesn't work on windows. I'll leave the selection up to whoever is going to implement this, but if you want to use something niche please talk to us before getting started. Some interesting possibilities to consider:

@stale
Copy link

@stale stale bot commented Jun 30, 2021

This issue has been automatically marked as stale because it has not had activity in the last 90 days. It will be closed in the next 30 days unless it is tagged properly or other activity occurs.
For maintainers: Please label with bug, in progress, on hold, discussion or to do to prevent the issue from being re-flagged.

@stale stale bot added the stale label Jun 30, 2021
@stale stale bot removed the stale label Jun 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant