[Improvement]: Improve compiler diagnostics

[LakshanWeerasinghe]

Description

The current format of compiler error diagnostics in Ballerina could be enhanced to provide more helpful information to users. Currently, it outputs errors in the following format:

ERROR [filename:(startPosition, endPosition)] error message

This format lacks detailed information about the area of the error code, making it less user-friendly compared to other compilers like Rust. By enhancing the output to include the area of the error code, users will have a clearer understanding of where the error occurred, which can significantly improve the user experience.

Describe your problem(s)

No response

Describe your solution(s)

• Modify the compiler error diagnostics format to include the area of the error code.

Related area

-> Compilation

Related issue(s) (optional)

No response

Suggested label(s) (optional)

No response

Suggested assignee(s) (optional)

No response

[RadCod3]

21/02/2024 Update

• Semantic diagnostics rendering works.
• Syntax Diagnostics,
  • Used args that are passed into createDiagnostic method to get the missing token/keyword for BCE0001 to BCE0400.

    ballerina-lang/compiler/ballerina-parser/src/main/java/io/ballerina/compiler/internal/parser/SyntaxErrors.java

    Line 96 in 838820f

    diagnosticList.add(createDiagnostic(diagnosticCode));

• Used jline for resizing diagnostic rendering based on terminal window size.

[RadCod3]

Tasks

• Improve Diagnostic Rendering using Diagnostic API and Syntax API. Improved diagnostic rendering #42236
• Add a bal explain <error_code> command to explain error codes.
• Prepare Diagnostic structure guide