Skip to content

feat(cli): show workspace favorite status in list output #11878

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
merged 3 commits into from
Jan 29, 2024
Merged

feat(cli): show workspace favorite status in list output #11878

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
db1389d
feat(cli): show workspace favorite status in list output
johnstcn Jan 29, 2024
7c8eda5
remove favorite from default columns, prefix name with star if favorite
johnstcn Jan 29, 2024
6d3f752
make gen
johnstcn Jan 29, 2024
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
Next Next commit
feat(cli): show workspace favorite status in list output
  • Loading branch information
@johnstcn
johnstcn committed Jan 29, 2024
commit db1389dc554e089991ccb51c96c6a241cc6d6f55
3 changes: 3 additions & 0 deletions cli/list.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ type workspaceListRow struct {
codersdk.Workspace `table:"-"`

// For table format:
Favorite bool `json:"-" table:"favorite"`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It feels a bit weird to occupy this much prime real-estate at the beginning of the table for this, but I think I understand the motivation for having it first (to make the sort order obvious).

Would it be weird to have favorite be "Fav" and */empty instead of true/false 🤔. Or would it be feasible to have it towards the end of the table?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I was playing around with that idea as well.
Another alternative I was considering was to append an asterisk (*) to workspace.Name to indicate favorite status.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought about that too, and I like it, but I worry if it might be problematic (re: parsing), then again, anyone parsing should just be using --output=json. So maybe try that out?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah that's a fair point.
Aside: it might be good to check if stdout is a pipe and warn to stderr to use JSON format instead for parsing. Similar to what the apt command does:

WARNING: apt does not have a stable CLI interface. Use with caution in scripts.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another alternative I was considering was to append an asterisk (*)

I think we are also using emojis to highlight things, for example "Workspace is outdated ". Maybe we could just have a "star" for favorite ones?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another alternative I was considering was to append an asterisk (*)

I think we are also using emojis to highlight things, for example "Workspace is outdated ". Maybe we could just have a "star" for favorite ones?

Something like this?

WORKSPACE      TEMPLATE  STATUS   HEALTHY  LAST BUILT  CURRENT VERSION   OUTDATED  STARTS AT  STOPS AFTER  
admin/test     docker    Stopped           16d17h      peaceful_yonath2  false                1d           
★ admin/test2  docker    Failed            3d22h       peaceful_yonath2  false                1d

Copy link
Member

@mtojek mtojek Jan 29, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or ⭐️ + column padding.

One more question: favs have sorting priority, right?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Padding to the width of an emoji glyph is going to be tricky; AFAICT there doesn't appear to be a space character equal to the width of an emoji.

WorkspaceName string `json:"-" table:"workspace,default_sort"`
Template string `json:"-" table:"template"`
Status string `json:"-" table:"status"`
Expand All @@ -47,6 +48,7 @@ func workspaceListRowFromWorkspace(now time.Time, workspace codersdk.Workspace)
healthy = strconv.FormatBool(workspace.Health.Healthy)
}
return workspaceListRow{
Favorite: workspace.Favorite,
Workspace: workspace,
WorkspaceName: workspace.OwnerName + "/" + workspace.Name,
Template: workspace.TemplateName,
Expand All @@ -70,6 +72,7 @@ func (r *RootCmd) list() *clibase.Cmd {
cliui.TableFormat(
[]workspaceListRow{},
[]string{
"favorite",
"workspace",
"template",
"status",
Expand Down
8 changes: 4 additions & 4 deletions cli/testdata/coder_list_--help.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ OPTIONS:
-a, --all bool
Specifies whether all workspaces will be listed or not.

-c, --column string-array (default: workspace,template,status,healthy,last built,current version,outdated,starts at,stops after)
Columns to display in table output. Available columns: workspace,
template, status, healthy, last built, current version, outdated,
starts at, starts next, stops after, stops next, daily cost.
-c, --column string-array (default: favorite,workspace,template,status,healthy,last built,current version,outdated,starts at,stops after)
Columns to display in table output. Available columns: favorite,
workspace, template, status, healthy, last built, current version,
outdated, starts at, starts next, stops after, stops next, daily cost.

-o, --output string (default: table)
Output format. Available formats: table, json.
Expand Down
10 changes: 5 additions & 5 deletions docs/cli/list.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.