qmk / qmk/qmk_cli

[Feature Request] Warn when setting qmk_{firmware,userspace} paths if they contain spaces

Open
#167 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
187
Forks
53
PR merge metrics
No merged PRs in 30d

Description

Description

Due to make and possibly other build build tools used for qmk, a space in your paths to qmk_firmware or qmk_userspace can cause compilation to fail. Specifically, I had no issue with a space in my path until I started using External Userspace. While using External Userspace with a space in the path for both qmk_firmware and qmk_userspace, qmk compile and qmk userspace-compile fail with unhelpful errors.

While it may not be possibly to fully support spaces in paths, it might be a good idea to not allow spaces in paths to begin with. That could be enforced at the qmk_cli level. When user.qmk_home or user.overlay_dir are set, there could be a check for spaces, and an error if they are present.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the qmk_cli handling for user.qmk_home and user.overlay_dir, then trace how qmk compile and qmk userspace-compile consume those values. Done means paths containing spaces produce a clear error rather than proceeding to unhelpful compilation failures.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.