rescript-lang / rescript-lang/rescript-vscode

Better error message when parsing of compiler log fails

Open
#553 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
ReScript
Stars
354
Forks
63
Avg merge
11h 29m
Merged PRs (30d)
1

Description

We recently improved the errors around Reanalyze failing for some unknown reason: https://github.com/rescript-lang/rescript-vscode/pull/544

Let's do the same type of thing (recover from error, prompt the user that there's been an error and how they should report it) to the parsing of the compiler log, which has seen crashes in exotic cases.

Example of a crash: https://github.com/rescript-lang/rescript-vscode/issues/386

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading PR #544 to understand how Reanalyze failures recover and report errors, then compare that approach with the compiler-log parsing path. Review issue #386 for the reported crash and use it to define the failure case. Done means parsing no longer crashes, the user is prompted with reporting guidance, and the error is recoverable.

Written by the indexing model from the issue text.

Assessment

Domain
devtools
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.