qmk/qmk_firmware

[Bug] qmk setup can't handle spaces in home path

Open

#23,098 opened on Feb 16, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)C (43,867 forks)batch import
bughelp wanted

Repository metrics

Stars
 (20,368 stars)
PR merge metrics
 (Avg merge 20d 9h) (27 merged PRs in 30d)

Description

Describe the Bug

I was just upgrading to the external userspace and had to update my qmk config because I couldn't get the userspace-add command to work.

I then saw this line in my config: user.qmk_home=S:ProjectsKeyboardsQMK

This was really weird and I tried to run qmk setup again but it set it to the above so I had to set it manually. I had to set the path sorrounded with "" to set it to: user.qmk_home=S:/Projects/Keyboards/QMK Firmware/qmk_firmware

After setting it manually it finally works. I would expect that qmk setup would set the path correctly even if it contains a space. Sadly I don't know enough about the build code to do any PR for it :)

Keyboard Used

No response

Link to product page (if applicable)

No response

Operating System

Windows

qmk doctor Output

No response

Is AutoHotKey / Karabiner installed

  • AutoHotKey (Windows)
  • Karabiner (macOS)

Other keyboard-related software installed

No response

Additional Context

No response

Contributor guide

Research direction
Investigate how qmk setup constructs the QMK home path and ensure it properly handles spaces, especially on Windows. Check the configuration parsing and validation logic.
Tech stack
pythonc
Domain
clitoolingdevops
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70