Diagnostic improvement

### 新需求提供了什么功能？

### Design of diagnostic collection and reporting

#### Diagnostic object
1. Diagnostic kind: 
   - **_CompilerBug_** - for compiler internal errors. All _unreachables_, _asserts_ and _segfaults_ must be wrapped into this kind of diagnostic. Diagnostic message must contain all information about fail(es2panda version, stack trace and maybe something else) and suggestion to report this bug special channel (gitee issue tracker, on email). Action: _abort_.
   - **_Fatal_** - log and _abort_, when it isn't possible to continue compilation.
   - **_SyntaxError_** - diagnose grammar violations
   - **_SemanticError_** - diagnose type system, name resolution and other non-grammar violations
   - **_Warning_** - notify users about some depricated features and possible bugs
   - **_PluginError_** - diagnose error from plugins
2. Every diagnostic must contains:
   - **Loc** - begin and end position of source code, which course a diagnostic message
   - **DiagType** - kind of diagnostic
   - **DiagID** - id number of diagnostic message
   - **DiagParams** - params to format diagnostic message
   - **Suggestions** - suggestions with code transformation to solve this error. Example for error "Unresolved referense 'xx'". One of the possible suggestion can be "Maybe do you mean 'x'".
   - **Parser context** - (optional) for syntax errors
   - **Plugin name** - (optional) for plugins errors
#### Diagnostic descriptions
All non-plugins diagnostic will describes into `yaml` files with following structure:
- `Name` - short name, will be identifier in c++ code
- `Id` - unique number of diagnostic message
- `Message` - format string of diagnostic message
- `Suggestions` - _(optional)_ format strings for possible suggestions]

All diagnostic messages must be correct, short and clear. We need rule for diagnostic messages like [Swift](https://github.com/swiftlang/swift/blob/main/docs/Diagnostics.md#grammar-and-phrasing).

Also locals must be supported.

#### Diagnostic collection and emition
1. All non-abort diagnostic will be saved into separate vectors. One vector for each kind of diagnostic.
2. Emit diagnostic points:
    - After checker and abort if there are some error. All warnings or some specific warnings can be like non-abort errors if special option is passed
    - Before abort of `Fatal` and `CompilerBug` diagnostic
    - Emit warnings in the end of pipeline if there aren't any errors
3. Before emition:
    1. All vectors will merged
    2. Resulted vector will be sorted by diagnostic location
    3. Dublicated diagnotic will be removed
4. There must be several options for diagnostic emition:
    - Short, IDE friendly - 1 line message, like now
    - More verbose and beautifull for CLI. With source line highlighting and suggestions

#### Recovery and diagnistic
Need to implement several methods for correct and exact problem diagnostic and recovery after errors.
For example:
- Check missing keyword, type and etc
- Check missing closing brace
- ...
- Use transactions to check something and rollback parser state, can be usefull for detection TS-specific code
- Reparse some part of code, if there are some specific errors, can be usefull for detection TS-specific code

#### Error message format
1. Short, IDE fiendly:
```
[path_from_project_root/file.sts:line:offset] Category (ERROR_ID): Error message
```
* Category - Syntax error | Semantic error | Warning | {Plugin name} plugin error | Compiler bug | Suggestion
* ERROR_ID - prefix + id, 
* ERROR_ID: 
    - Syntax error: S0001 - S0999 
    - Semantic error: E1001 - E1999
    - Warning: W2001 - W2999
    - Plugin error: PLUGIN_NAME P9000+unique id for plugin (for example: P9001, P9002, P9003), one ID can be generated for different plugins, difference will be in plugin name
Example:
```
[src/main.sts:13:3] Syntax error S0001: Unexpected token '}' in the end of function 'Foo'. '}' expected
[src/main.sts:13:3] Suggestion: Replace with '}'
[src/plugin/foo.sts:1:11] Semantic error E1003: 'string' can't be converted to 'number'
[src/test.sts:15:1] Memo plugin error P0001: Memoization supported only for class methods
[src/test.sts:20:15] Compiler bug: tvoi kod - plohoi. Ia obidelsia =(
```
2. CLI messages example. Format and colors will be specified later.
```
> [src/main.sts:13:3] Syntax error S0001
    Unexpected token '}' in the end of function 'Foo'. '}' expected
     |    return 42 (note: light grey for more context)
  13 |  {
     |  ^ Replace with '}'
```
Something like this with colors:
![image](/uploads/f887556b39ce074d7f49d39d82b6663d/image.png)

### 该需求带来的价值、应用场景？

.

OpenHarmony/arkcompiler_ets_frontend
关闭

内容风险标识

评论 (2)

OpenHarmony/arkcompiler_ets_frontend关闭 .gitee-modal { width: 500px !important; }

内容风险标识