qmk/qmk_firmware

[Feature Request] Command to edit info.json files

Open

#12,446 建立於 2021年3月31日

在 GitHub 查看
 (7 留言) (1 反應) (0 負責人)C (43,867 fork)batch import
enhancementgood first issuehelp wantedpythonto do

倉庫指標

Star
 (20,368 star)
PR 合併指標
 (平均合併 20天 9小時) (30 天內合併 27 個 PR)

描述

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:

貢獻者指南