qmk/qmk_firmware

[Feature Request] Exclude external userspace from lint checking

Open

#24,676 opened on Dec 4, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)C (43,867 forks)batch import
enhancementhelp wantedto do

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

qmk lint can be run locally before submitting a keyboard PRs to avoid unnecessary churn of commits just to satisfy the the CI lint checker. However, when run locally, external userspace keymaps are included in keymap list, so via[l] keymaps get erroneously flagged as "should not exist" even when they are properly located outside of the qmk_firmware repository. When checking for the presence of those keymaps, it would be ideal if the keymap list did not include keymaps found in the external userspace.

Contributor guide

Research direction
Examine the qmk lint script to understand how it collects keymaps and modify the filtering logic to exclude keymaps from external userspace directories.
Tech stack
c
Domain
backendcli
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
QMK firmwarekeymap structurepython (for lint script)
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40