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

Allow codegen of keymap.json => keymap.c without requiring layers/layout etc. #23451

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from

Conversation

tzarc
Copy link
Member

@tzarc tzarc commented Apr 10, 2024

Description

Allows for keymap.c to coexist with keymap.json. Anything in keymap.json will take precedence and supplying stuff in both will cause failures, but that comes with the territory.

Have migrated the onekey console keymap so that there's at least one keymap in-tree.

Minimal keymap.json could be something like this:

{
    "converter": "promicro_rp2040",
    "config": {
        "features": {
            "unicode": true
        }
    }
}

...with a corresponding keymap.c as per normal usage patterns.

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout/userspace (addition or update)
  • Documentation

Checklist

  • My code follows the code style of this project: C, Python
  • I have read the PR Checklist document and have made the appropriate changes.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

@tzarc tzarc requested a review from a team April 10, 2024 12:52
@github-actions github-actions bot added core python cli qmk cli command dd Data Driven Changes labels Apr 10, 2024
@tzarc tzarc marked this pull request as ready for review May 3, 2024 05:56
lib/python/qmk/commands.py Outdated Show resolved Hide resolved
@tzarc tzarc marked this pull request as draft May 19, 2024 04:04
@tzarc
Copy link
Member Author

tzarc commented May 19, 2024

Moved back to draft until I get time to sort out test failures etc.
Need to go digging as per Z's comment.

Across the org: https://github.com/search?q=org%3Aqmk+__KEYMAP_GOES_HERE__&type=code

@tzarc tzarc marked this pull request as ready for review August 14, 2024 02:51
@tzarc
Copy link
Member Author

tzarc commented Aug 14, 2024

Cleared draft state. Seems like it's now properly working both inside qmk_firmware and inside qmk_userspace.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli qmk cli command core dd Data Driven Changes keymap python
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants