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.

Sign up for GitHub

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

Jump to bottom

New command: qmk lint #10761

Merged
merged 10 commits into from
Nov 7, 2020
Merged

New command: qmk lint #10761

merged 10 commits into from
Nov 7, 2020

Conversation

skullydazed
Copy link
Member

@skullydazed skullydazed commented Oct 25, 2020 •
edited
Loading

Description

Adds a command for checking over a keyboard/keymap.

Types of Changes

  • Core
  • New feature

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 tested the changes and verified that they work and don't break anything (as well as I can manage).

@skullydazed skullydazed added core python cli qmk cli command labels Oct 25, 2020
@github-actions github-actions bot added CI and removed core labels Oct 25, 2020
@skullydazed skullydazed changed the base branch from master to generate_api_data October 25, 2020 18:35
@skullydazed
Copy link
Member Author

I accidentally based this on the branch for #10609. When that's merged I'll retarget master here.

@github-actions github-actions bot removed the CI label Oct 25, 2020
@skullydazed
Copy link
Member Author

Some examples:

Screen Shot 2020-10-25 at 11 49 15

Base automatically changed from generate_api_data to master October 25, 2020 21:48
@drashna drashna requested a review from a team October 29, 2020 05:53
@github-actions github-actions bot added the CI label Oct 29, 2020
@skullydazed skullydazed marked this pull request as ready for review October 29, 2020 15:24
@skullydazed
Copy link
Member Author

I'm happy with the state of the PR and am ready for reviews.

fauxpark
fauxpark requested changes Oct 29, 2020
View reviewed changes
docs/cli_commands.md Outdated Show resolved Hide resolved
docs/hardware_keyboard_guidelines.md Outdated Show resolved Hide resolved
@skullydazed @fauxpark
Apply suggestions from code review
b23bc07 
Co-authored-by: Ryan <fauxpark@gmail.com>
@skullydazed skullydazed requested a review from a team October 29, 2020 18:59
@skullydazed skullydazed requested review from fauxpark and zvecr October 30, 2020 00:55
@drashna drashna requested a review from a team November 1, 2020 18:53
Erovia
Erovia approved these changes Nov 4, 2020
View reviewed changes
Copy link
Member

@Erovia Erovia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

lib/python/qmk/cli/lint.py Show resolved Hide resolved
@skullydazed skullydazed merged commit 4d33d72 into master Nov 7, 2020
@skullydazed skullydazed deleted the qmk_lint branch November 7, 2020 17:56
ChrissiQ pushed a commit to ChrissiQ/qmk_firmware that referenced this pull request Nov 10, 2020
@skullydazed @fauxpark @ChrissiQ
New command: qmk lint (qmk#10761)
cfc9437 
* Basic qmk lint command

* check for keymap readme

* change the workflow from qmk info to qmk lint

* add a strict mode

* parsing -> parse

* document qmk lint

* small info logging cleanup

* Apply suggestions from code review

Co-authored-by: Ryan <fauxpark@gmail.com>

* honor --strict in more places

* change the job name to lint

Co-authored-by: Ryan <fauxpark@gmail.com>
ChrissiQ pushed a commit to ChrissiQ/qmk_firmware that referenced this pull request Nov 10, 2020
@skullydazed @fauxpark @ChrissiQ
New command: qmk lint (qmk#10761)
11db165 
* Basic qmk lint command

* check for keymap readme

* change the workflow from qmk info to qmk lint

* add a strict mode

* parsing -> parse

* document qmk lint

* small info logging cleanup

* Apply suggestions from code review

Co-authored-by: Ryan <fauxpark@gmail.com>

* honor --strict in more places

* change the job name to lint

Co-authored-by: Ryan <fauxpark@gmail.com>
nicsuzor added a commit to nicsuzor/qmk_firmware that referenced this pull request Nov 14, 2020
@nicsuzor
Merge remote-tracking branch 'upstream/master'
9133835 
* upstream/master: (48 commits)
  [Keymap] idobo:egstad (qmk#10783)
  Adding few Korean translated files (qmk#5895)
  [Keyboard] Keebwerk MEGA Initial commit (qmk#10777)
  Indicator LEDs as config (qmk#10816)
  add missing physical layout options and VIA support for Sesame (qmk#10471)
  [Keyboard] Fix unused variables in mschwingen modelm (qmk#10811)
  Add big spacebar defaults to Underscore33 (qmk#10731)
  Add qmk info -l to show the layouts too (qmk#10882)
  New command: qmk lint (qmk#10761)
  Updates to Talljoe's Keymaps (qmk#10115)
  [Keymap] bcat keymaps and userspace (qmk#10705)
  add dp60 indicator mode (qmk#8801)
  E85 backlight & LED indicator updates (qmk#10678)
  Add support for 4 IS31FL3731 devices (qmk#10860)
  [Keymap] add brandonschlack userspace and keymaps (qmk#10411)
  [Keymap] add ai03/polaris:mekberg (qmk#10508)
  CLI: Add `qmk clean` (qmk#10785)
  Adds support for XD84 Pro (qmk#9750)
  Freyr refactor (qmk#10833)
  KC60 refactor (qmk#10834)
  ...
drashna pushed a commit to zsa/qmk_firmware that referenced this pull request Nov 24, 2020
@skullydazed @fauxpark @drashna
New command: qmk lint (qmk#10761)
f90458a 
* Basic qmk lint command

* check for keymap readme

* change the workflow from qmk info to qmk lint

* add a strict mode

* parsing -> parse

* document qmk lint

* small info logging cleanup

* Apply suggestions from code review

Co-authored-by: Ryan <fauxpark@gmail.com>

* honor --strict in more places

* change the job name to lint

Co-authored-by: Ryan <fauxpark@gmail.com>
drashna pushed a commit to zsa/qmk_firmware that referenced this pull request Jan 13, 2021
@skullydazed @fauxpark @drashna
New command: qmk lint (qmk#10761)
781cc0e 
* Basic qmk lint command

* check for keymap readme

* change the workflow from qmk info to qmk lint

* add a strict mode

* parsing -> parse

* document qmk lint

* small info logging cleanup

* Apply suggestions from code review

Co-authored-by: Ryan <fauxpark@gmail.com>

* honor --strict in more places

* change the job name to lint

Co-authored-by: Ryan <fauxpark@gmail.com>
BorisTestov pushed a commit to BorisTestov/qmk_firmware that referenced this pull request May 23, 2024
@skullydazed @fauxpark
New command: qmk lint (qmk#10761)
7192759 
* Basic qmk lint command

* check for keymap readme

* change the workflow from qmk info to qmk lint

* add a strict mode

* parsing -> parse

* document qmk lint

* small info logging cleanup

* Apply suggestions from code review

Co-authored-by: Ryan <fauxpark@gmail.com>

* honor --strict in more places

* change the job name to lint

Co-authored-by: Ryan <fauxpark@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fauxpark fauxpark fauxpark approved these changes

@Erovia Erovia Erovia approved these changes

@zvecr zvecr Awaiting requested review from zvecr

Assignees
No one assigned
Labels
CI cli qmk cli command documentation python
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@skullydazed @Erovia @fauxpark @zvecr