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

[XAP][Refactor] syntax sugar #17039

Closed
wants to merge 6 commits into from
Closed

[XAP][Refactor] syntax sugar #17039

wants to merge 6 commits into from

Conversation

amrsoll
Copy link

@amrsoll amrsoll commented May 9, 2022

Description

Refactor XAP cli code to be more flexible and clean. I am not 100% on all the change, namely because I wasn't always able to confirm the magic numbers used in the code.

Also fixes a few bugs:

  • Display the whole payload when using qmk xap listen
  • cli forces the use of an action (See CliAction)

Potential problem: I tried to enforce LSB/MSB byte order to be correct everywhere, but unsure how well it will play out on Windows, where I think the hex() command might behave differently?

Note: The xap dump command didn't work for me before my changes, so I did the best I could to keep the behaviour same same

Types of Changes

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

Issues Fixed or Closed by This PR

N/A

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).

@github-actions github-actions bot added cli qmk cli command python labels May 9, 2022
@amrsoll amrsoll changed the title [Refactor] XAP syntax sugar [XAP][Refactor] syntax sugar May 9, 2022
@amrsoll amrsoll marked this pull request as draft May 9, 2022 13:14
@zvecr
Copy link
Member

zvecr commented May 9, 2022

The code in this area is throwaway, with the intention to be mostly completely replaced by #15623. It exists right now as more of a playground to help develop the foundations of the framework.

To that effect, theres not a need to try and productionise it.

@zvecr
Copy link
Member

zvecr commented Jul 8, 2022

Most of the proposed changes have either been wrapped up in recent CLI updates, or no longer apply.

Will pick back up when work starts on #15623.

@zvecr zvecr closed this Jul 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli qmk cli command python
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants