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.

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

Conversation

johnstcn
Copy link
Member

@johnstcn johnstcn commented Jan 29, 2024

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            3d23h       peaceful_yonath2  false                1d             

Note: TableFormatter currently only supports a single default_sort.

@@ -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

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.

Copy link
Member

@mtojek mtojek left a comment

Choose a reason for hiding this comment

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

👍

@johnstcn johnstcn merged commit eeef56a into main Jan 29, 2024
@johnstcn johnstcn deleted the cj/cli-list-favorite branch January 29, 2024 14:14
@github-actions github-actions bot locked and limited conversation to collaborators Jan 29, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants