Canop/broot

Username with one or more spaces causes an error

Closed

#849 opened on Mar 7, 2024

View on GitHubContributor guide
 (9 comments) (1 reaction) (0 assignees)Rust (213 forks)batch import
bughelp wantedwindows

Repository metrics

Stars
 (9,383 stars)
PR merge metrics
 (Avg merge 53m) (1 merged PR in 30d)

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

Research direction
Investigate the PowerShell profile generation code in broot and replace the hardcoded path with the $HOME environment variable to handle spaces in usernames.
Tech stack
rust
Domain
cli
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
PowerShell
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70