#608, #229 Reveal the error location after the failed verify

[kittaakos]

Motivation

• To reveal the compilation error location in the editor after a failed verify. The first compiler error is extracted from the CLI output and the IDE2 reveals it. (The user is not guided to the error line when an error is encountered after verifying/uploading the sketch #608)

compiler_errors_01.mp4

• Show the errors with error color in the Output view (Display error messages from Compiler and Linker in red... #229).

• Show the first compilation error in the notification center.

• Can copy the Output content from the error notification:

compiler_errors_02.mp4

Experimental

You need to enable the experimental features from the settings.json if you want to see "more errors" 😉:

• Open the Command Palette with F1,
• Type and Preferences: Open Settings (JSON) and press Enter,
• Add "arduino.compile.experimental": true to the JSON, save the file if you do not have auto-save enabled, and close the settings.json editor.
• Compile a sketch with multiple errors. Here is an example sketch:
  Errors.zip

It should be possible to navigate between the errors.

compiler_errors_03.mp4

Expected behavior:

• The order of the compiler errors is given by the CLI (The order of the compiler errors are indeterministic arduino-cli#1760),
• The Next Error and the Previous Error navigation depend on the order of the compiler errors,
• The error parsing logic in IDE2 is expected to be identical as in the Java IDE.
• If the experimental features are enabled, but there is one compiler error, navigation is not available.
• If the cursor location intersects the location of the compiler error, or in the same line, the error under the cursor will be the current error and will have the previous/next action. (There is an issue when there are multiple errors in the same line or location. I am working on this. 🚧 #608, #229 Reveal the error location after the failed verify #1064 (comment) Fixed: 4f486cb)
• The error decoration (red line) must be sticky. It means, that editing the file should move the markers around.
• If a code is deleted from an error decoration location, or text is inserted into an error decoration location, the error decoration will be removed.

compiler_errors_04.mp4

Known issues:

• When deleting code from a location with the error decoration.

compiler_errors_05.mp4

• TBD,

Open questions:

• As noted in the code, I do not know which focusing logic prefers the community the best. So I would like to hear feedback. I will add a preference for this soon. I added a preference: 54e60f6

Change description

Other information

Closes #608
Closes #229

Reviewer checklist

• PR addresses a single concern.
• The PR has no duplicates (please search among the Pull Requests before creating one)
• PR title and description are properly filled.
• Docs have been added / updated (for bug fixes / features)

[kittaakos]

Nice to have: burn bootloader is unrelated to the sketch content, IDE2 won't ever get a location, so consider having a different error type.

[kittaakos]

Nice to have: consider replacing message with a ServiceError instance.

[kittaakos]

The ServiceError object does not contain sufficient info about the error, so this won't fix.

Ref: arduino/arduino-cli#1767

[per1234]

It may be out of scope for this PR, but I think the color used for stderr in the output panel with the "Light (Arduino)" theme must be made lighter.

Here is how it looks in Arduino IDE 1.8.19:

Compare that to the color when using the build from this PR:

At one point, this color in Arduino IDE 1.x was changed to a similar darker red until it was restored to the current color after complaints about readability from the users:

• Default colors for errors is illegible Arduino#2901
• Arduino IDE environment colours Arduino#3056

[per1234]

UPDATE: resolved

More of a "nice to have" than something really essential, but I thought I would mention it since I did notice it by chance.

Would it be possible to still get selection highlighting on the text of the line with the error highlighting?

Notice how the selected text on the error line has a yellow background in Arduino IDE 1.8.19:

While there is no visual indication of the same selection on that line when using the build from this PR:

[kittaakos]

Thank you for trying it out!

It may be out of scope for this PR, but I think the color used for stderr in the output panel with the "Light (Arduino)" theme must be made lighter.

I propose opening a follow-up for this. Currently, IDE2 uses the default --theia-inputValidation-errorBackground value. The designer team can work on it and align the default Theia "error color" to the Arduino theme.

Would it be possible to still get selection highlighting on the text of the line with the error highlighting.

Nice catch! Sure. I look into it.

[kittaakos]

Notice how the selected text on the error line has a yellow background in Arduino IDE 1.8.19:

While there is no visual indication of the same selection on that line when using the build from this PR:

✅ Fixed

selection_fix.mp4

[kittaakos]

I fixed all outstanding issues and made the PR ready for review. Please verify. Thank you!

[per1234]

It is working great for me.

Thanks for this very valuable advancement Akos!

[kittaakos]

@davegarthsimpson please review e7ee861 for #1074. I verified it locally, but I would appreciate a double-check. Thank you!

Update: here is the link to the module.