Skip to content
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

More Informative External Diff Tool Error Messages #100

Open
chrstinalin opened this issue Jul 31, 2024 · 5 comments
Open

More Informative External Diff Tool Error Messages #100

chrstinalin opened this issue Jul 31, 2024 · 5 comments
Labels
nice-to-have Functionality or features that would be nice to have in Assay.

Comments

@chrstinalin
Copy link
Contributor

chrstinalin commented Jul 31, 2024

There's a debatably uninformative error message when the command doesn't exist (image, ENOENT) or is used incorrectly (No error message at all).

image

From #99

@chrstinalin chrstinalin added the bug Something isn't working label Jul 31, 2024
@willdurand willdurand added nice-to-have Functionality or features that would be nice to have in Assay. and removed bug Something isn't working labels Jul 31, 2024
@willdurand
Copy link
Member

I changed the label because while the error message might not be clear (arguably ENOENT is pretty common for developers), there is still an error message. We should make it better and more clear, though.

@chrstinalin
Copy link
Contributor Author

@willdurand I figured, but the silent error is the one that's more worrisome to me

@willdurand
Copy link
Member

Ha, I see. I am wondering if the silent error is because there is no validation on the setting. Maybe we could force a non-empty value for this setting?

@chrstinalin
Copy link
Contributor Author

@willdurand In the case I tested, I used git as the diff tool command. Since git does not throw an error (responds with "is not a git command"), no error message is shown on Assay's side (openInDiffTool() in diffController.ts`).

There's probably an argument to be made here that it's no longer Assay's responsibility at that point, but I think an information message showing "success" would be helpful so that the user at least knows something happened.

@willdurand
Copy link
Member

Fair enough, though it's very low priority since we added a default value that reviewers will likely not change anyway.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
nice-to-have Functionality or features that would be nice to have in Assay.
Projects
None yet
Development

No branches or pull requests

2 participants