superfaceai / cli

Let AI connect the APIs for you
https://superface.ai
MIT License
22 stars 4 forks source link

feat: improve error message #349

Closed Jakub-Vacek closed 1 year ago

Jakub-Vacek commented 1 year ago

Description

This PR adds printing out instructions on reporting to GH discussions when UserError is thrown.

Error in terminal looks like this:

Snímek obrazovky 2023-08-07 v 7 24 37

Motivation and Context

Types of changes

Checklist:

martyndavies commented 1 year ago

@Jakub-Vacek I realize now that the GH Discussions URL will be useless unless it's clickable. Is that possible to do with Oclif? If not, we should replace it with a short link.

Additionally one copy update:

"Please include these information" -> "Please include the following information:"

kysely commented 1 year ago

At least in iTerm a link (or any path really) is clickable when holding Cmd. But I think it should be a shortlink anyways — it's better readable and we can keep it up to date.

Jakub-Vacek commented 1 year ago

Snímek obrazovky 2023-08-08 v 15 52 44

Short and highlighted link @martyndavies @kysely

martyndavies commented 1 year ago

@Jakub-Vacek Nice, looks good.