Skip to content

fix: accept "default" as the default board name #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jwarykowski merged 1 commit into from
Jul 29, 2026
Merged

fix: accept "default" as the default board name #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions internal/store/store.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,11 @@ func ResolveBoard(flag string) (string, error) {
if name == "" {
name = os.Getenv("SHEPHERD_BOARD")
}
// "default" is the label `boards` advertises for the empty-named default
// board; accept it back so a name read from that listing round-trips.
if name == "default" {
return "", nil
}
if name != "" && !boardRE.MatchString(name) {
return "", fmt.Errorf("invalid board name %q (use letters, digits, . _ -)", name)
}
Expand Down Expand Up @@ -185,6 +190,9 @@ func CreateBoard(name string) error {
if err := ValidBoard(name); err != nil {
return err
}
if name == "default" {
return fmt.Errorf("board %q is reserved for the default board", name)
}
p := TodoPathFor(name)
if fileExists(p) {
return fmt.Errorf("board %q already exists", name)
Expand Down
7 changes: 7 additions & 0 deletions internal/store/store_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,13 @@ func TestResolveBoard(t *testing.T) {
if got, err := ResolveBoard(""); err != nil || got != "" {
t.Fatalf("empty -> default: %q %v", got, err)
}
// "default" (the name `boards` advertises) round-trips to the empty board.
if got, err := ResolveBoard("default"); err != nil || got != "" {
t.Fatalf(`"default" -> empty: %q %v`, got, err)
}
if err := CreateBoard("default"); err == nil {
t.Fatal(`"default" should be reserved`)
}
if _, err := ResolveBoard("../evil"); err == nil {
t.Fatal("traversal via flag not rejected")
}
Expand Down
Loading