qmk/qmk_firmware

[Feature Request] info.json for userspace building

Open

#20,406 opened on Apr 10, 2023

View on GitHub
 (2 comments) (1 reaction) (0 assignees)C (43,867 forks)batch import
discussionenhancementhelp wanted

Repository metrics

Stars
 (20,368 stars)
PR merge metrics
 (Avg merge 20d 9h) (27 merged PRs in 30d)

Description

Feature Request Type

  • Core functionality
  • Add-on hardware support (eg. audio, RGB, OLED screen, etc.)
  • Alteration (enhancement/optimization) of existing feature(s)
  • New behavior

Description

I have a couple of handwired keyboards. I like the idea of building qmk with github userspace and a data driven keyboard configuration.

From my understanding the keymap.json could include a complete keyboard configuration, but it is not treated as such. The qmk compile command still needs the keyboard configuration folder.

My current approach is to create a info.json use qmk import-keyboard to create a keyboard directory and then compile the keyboard with an keymap.json.

Is there a better way to do it? Would you be open for a enhancement to somehow specify a data driven keyboard config? I might be able to implement needed changes in qmk_cli

Contributor guide

Research direction
Examine the qmk compile command to understand how it currently uses keyboard configuration folders versus info.json. Investigate how to extend the CLI to accept a data driven keyboard configuration via info.json or keymap.json directly.
Tech stack
cpython
Domain
developer experiencetooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGitQMK firmware build process
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70