srosro / deepspring-shellmate

MIT License
99 stars 7 forks source link

Warn user when sm CLI is not installed #117

Closed delattre1 closed 1 month ago

delattre1 commented 2 months ago

Implement a user experience enhancement to handle cases where the user tries to run the sm command in the CLI, but the terminal session was opened before ShellMate was installed.

Options:

maryldyer commented 2 months ago

On Shellmate's first open we open a new terminal window that way the user can see the walkthrough tips and experience shellmate working properly. If they switch back to a previously open window (I'm making an assumption that we would not know right away that we are going to have a problem) the ux follows the happy path until the user tries to execute a sm command and they get an error. Which is when we would have a special alert banner explaining that we encountered an issue.

I'm open to changing the alert copy if you have a better suggestion!

Figma

Screenshot 2024-08-19 at 1 39 03 PM
delattre1 commented 2 months ago

A follow-up fix if put more time into development would be: Show a warning with the source ~/.zshrc or source ~/.bashrc command so the user can manually update their profile.

delattre1 commented 2 months ago

When the user runs the command sm 'how can I display a calendar' in the terminal, it triggers both the sm not installed warning and the pro tip: insert suggestion instruction. This overlap causes a conflict in the user experience, where both states are activated simultaneously, potentially confusing the user.

image

delattre1 commented 2 months ago

These are all the warnings implemented in the app: image image

delattre1 commented 1 month ago

New bugs to fix:

Red warning should only show at the terminal window that has the problem. Not at all windows: image

Fix padding between 1st pro-tip and the second element when red warning is showing will display without any padding

image