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

Improved error reporting #315

Closed

Conversation

lextm
Copy link
Contributor

@lextm lextm commented Mar 9, 2022

Scenario: When a Sphinx project is being edited, the build fails and succeeds often (especially when conf.py is being changed).

Problem: The current version raises too many error notifications. Besides, "see output window for details" is ambiguous, as some users might not know it is "Esbonio Language Server" channel under OUTPUT panel that they should open and read.

Solution: Removed the error notifications. Instead, automatically open the channel when errors occur.

@alcarney
Copy link
Member

alcarney commented Mar 9, 2022

I'm not a fan of this solution, only because any client that is not VSCode will now fail silently.
Perhaps the error could be converted into a diagnostic instead?

@lextm
Copy link
Contributor Author

lextm commented Mar 10, 2022

I added a commit which monitors initialization errors (such as typing something random in conf.py to trigger a config error) and generates error diagnostics from them. However, such diagnostics are not very visible to users (they might simply ignore them). So to me that's not a very convenient way either.

@alcarney
Copy link
Member

I agree it's not perfect, but it's probably better than nothing... could update these test cases to look for the diagnostic instead?

@lextm
Copy link
Contributor Author

lextm commented Mar 11, 2022

Sure. I will check how to update the test cases.

@alcarney
Copy link
Member

alcarney commented Apr 5, 2022

Thanks for this, the changes have been incorporated into #352

@alcarney alcarney closed this Apr 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants