Canop/broot

Username with one or more spaces causes an error

Open

#849 opened on Mar 7, 2024

View on GitHub
 (8 comments) (1 reaction) (0 assignees)Rust (9,383 stars) (213 forks)batch import
bughelp wantedwindows

Description

Steps to reproduce

  1. (optional) change your username to include one or more spaces
  2. If you have already br installed, run br --install
  3. run broot --install
  4. the command above creates $HOME\Documents\WindowsPowershell\Profile.ps1 with the following contents (when username is "User Name")
. C:\Users\User\ Name\AppData\Roaming\dystroy\broot\config\launcher\powershell\br.ps1

Possible solution

Use $HOME environment variable instead so windows will automatically expand it on execution appropriately.

Contributor guide

Tech stack
rustshell
Domain
cli
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic RustWindows environment variables
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95
Research direction
The fix involves replacing the hardcoded user path with $HOME in the generated PowerShell script. Search the Rust source for the string 'C:\Users\' or the path construction. The relevant code is likely in a function that generates the profile. Replace the username part with $HOME and ensure proper escaping for PowerShell.