[WIP] Feat(CompilerBase-Error): Add 'One-Sentence', text rendering and error handler to CompilerError. #136

zong-zhe · 2022-08-05T01:36:11Z

1. Does this PR affect any open issues?(Y/N) and add issue references (e.g. "fix #123", "re #123".):

N
Y

fix #115

2. What is the scope of this PR (e.g. component or file name):

kclvm/compiler_base

3. Provide a description of the PR(e.g. more details, effects, motivations or doc link):

In /kclvm/compiler_base/diagnostic/, the basic structure of One-Sentence is implemented in compiler-base-diagnostic, which includes 'Pendant', 'Sentence' and 'Diagnostic'.
In /kclvm/compiler_base/style/, the basic structure of text-rendering is implemented in compiler-base-style, which includes 'Style', and 'StyleBuffer'.
In /kclvm/compiler_base/macros/, Macro attributes 'DiagnosticBuilderMacro' is created to support generation of 'Diagnostic' from 'error/warning structs'.

4. Are there any breaking changes?(Y/N) and describe the breaking changes(e.g. more details, motivations or doc link):

N
Y

5. Are there test cases for these changes?(Y/N) select and add more details, references or doc links:

The unit test cases in
/kclvm/compiler_base/diagnostic/src/tests.rs
/kclvm/compiler_base/style/src/tests.rs

6. Release note

Please refer to Release Notes Language Style Guide to write a quality release note.

None

coveralls · 2022-08-05T02:01:45Z

Pull Request Test Coverage Report for Build 2817522474

0 of 0 changed or added relevant lines in 0 files are covered.
51 unchanged lines in 2 files lost coverage.
Overall coverage increased (+0.07%) to 59.551%

Files with Coverage Reduction	New Missed Lines	%
kclvm/sema/src/resolver/attr.rs	12	64.62%
kclvm/sema/src/resolver/node.rs	39	75.23%

Totals
Change from base Build 2780151826:	0.07%
Covered Lines:	22365
Relevant Lines:	37556

💛 - Coveralls

Peefy

Pls merge your 17 commits+

Peefy · 2022-08-05T03:05:56Z

Delete KCL related content in CompilerBase, considering generality

Peefy · 2022-08-05T04:03:31Z

kclvm/compiler_base/style/src/lib.rs

@@ -0,0 +1,108 @@
+//! 'Style' is responsible for providing 'Shader' for text color rendering.


I suggest this package is available as a 3rdparty for compiler_base

Peefy · 2022-08-05T04:04:16Z

kclvm/compiler_base/diagnostic/src/lib.rs

+/// 
+/// e.g. an error diagnostic.
+/// error[E0999]: oh no! this is an error!
+///  --> mycode.k:3:5


remove the *.k

Peefy · 2022-08-05T04:04:28Z

kclvm/compiler_base/diagnostic/src/lib.rs

+/// Sentence 1: error[E0999]: oh no! this is an error!
+/// 
+/// Sentence 2: 
+/// --> mycode.rs:3:5


remove the *.rs

Peefy · 2022-08-05T04:13:53Z

kclvm/compiler_base/error/src/lib.rs

+
+// before
+// 
+// KCL Complier Error[E2L28] : Unique key error


remove KCL

Peefy · 2022-08-05T05:07:20Z

kclvm/compiler_base/diagnostic/src/pendant.rs

+/// error: this is an error!
+/// warning[W0011]: this is an warning!
+/// note: this is note.
+/// KCL error[E1000]: this is a KCL error!


remove KCL

Peefy · 2022-08-05T05:10:12Z

kclvm/compiler_base/diagnostic/src/lib.rs

+/// A Position is valid if the line number is > 0.
+/// The line and column are both 1 based.
+#[derive(PartialEq, Clone, Eq, Hash, Debug, Default)]
+pub struct Position {


Use Span and SourceMap instead of Position to calculate the error Postion.

Peefy · 2022-08-05T05:11:05Z

kclvm/compiler_base/diagnostic/test_datas/main.k

@@ -0,0 +1,11 @@
+schema Person:


Remove KCL tests.

Peefy · 2022-08-05T05:12:45Z

kclvm/compiler_base/diagnostic/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "compiler-base-diagnostic"


Should compiler-base-diagnostic belongs to compiler-base-error ?

Peefy · 2022-08-05T05:14:10Z

kclvm/Cargo.toml

@@ -52,5 +52,8 @@ members = [
    "sema",
    "span",
    "tools",
-    "version"
+    "version",
+    "compiler_base",


compiler_base is not one of kclvm members.

Peefy · 2022-08-05T05:15:18Z

kclvm/compiler_base/src/lib.rs

+use std::panic;
+use compiler_base_diagnostic::{emitter::{Emitter, EmitterWriter}, DiagnosticBuilder};
+
+pub struct ErrHandler {


How can I use ErrHandler? and it should be part of the error package?

Peefy · 2022-08-05T05:18:18Z

Important things:

All error submodules should belong to the compiler-base-errors crate.
Need to describe how to use Handler, how to define user own errors, and what the default errors are in lib.rs of compiler-base-errors crate.
It should not contain anything KCL related.

chai2010 · 2022-08-08T05:56:34Z

kclvm/Cargo.toml

-    "version"
+    "version",
+    "compiler_base",
+    "compiler_base/error",


s/error/errors/

Peefy · 2022-08-17T07:57:13Z

Split large WIP PRs into smaller ones

zong-zhe added 17 commits August 4, 2022 20:42

Enhanced compiler infrastructure and init pendent

7ee3881

add sentence

93ed06c

add sentences and finish the workflow from diagnostic to emitter

0169f7e

finish err 2 diagnostic manual

bcd41b8

That's one small step for myself

93c11be

create crate compiler-base and move new_error into it

e83fe3a

finish mvp

a9d5a88

add test cases for shader.rs and style.rs

9a3bed0

add test cases for styled_builder.rs

cd9df6e

add test cases for pendant.rs

2dc3511

add test cases for Position

84b2811

add test ceses for Sentence

63b6884

add comments for DiagnosticBuilderMacro

e19bade

add comments to diagnostic_builder.rs

46f6ddf

add comments to style

3615e5a

remove useless files

5b7beb3

fix a mistake

32eee96

zong-zhe added enhancement New feature or request error-handling Issues or PRs related to kcl error handling labels Aug 5, 2022

zong-zhe added this to the v0.4.3 Release milestone Aug 5, 2022

zong-zhe requested review from chai2010, Peefy, ldxdl, He1pa and a team August 5, 2022 01:36

zong-zhe self-assigned this Aug 5, 2022

zong-zhe mentioned this pull request Aug 5, 2022

[Feature] An error handling kit: CompilerBase-Error #115

Closed

Peefy reviewed Aug 5, 2022

View reviewed changes

chai2010 reviewed Aug 8, 2022

View reviewed changes

kclvm/Cargo.toml

"version"

"version",

"compiler_base",

"compiler_base/error",

Copy link

Contributor

chai2010 Aug 8, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/error/errors/

add DiagnosticStyle

165009c

Peefy changed the title ~~Feat(CompilerBase-Error): Add 'One-Sentence', text rendering and error handler to CompilerError.~~ [WIP] Feat(CompilerBase-Error): Add 'One-Sentence', text rendering and error handler to CompilerError. Aug 9, 2022

add CodeSpanPendant

2893258

Peefy closed this Aug 17, 2022

github-actions bot locked and limited conversation to collaborators Aug 17, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Feat(CompilerBase-Error): Add 'One-Sentence', text rendering and error handler to CompilerError. #136

[WIP] Feat(CompilerBase-Error): Add 'One-Sentence', text rendering and error handler to CompilerError. #136

zong-zhe commented Aug 5, 2022

coveralls commented Aug 5, 2022 •

edited

Loading

Peefy left a comment •

edited

Loading

Peefy commented Aug 5, 2022

Peefy Aug 5, 2022

Peefy Aug 5, 2022

Peefy Aug 5, 2022

Peefy Aug 5, 2022

Peefy Aug 5, 2022

Peefy Aug 5, 2022

Peefy Aug 5, 2022

Peefy Aug 5, 2022

Peefy Aug 5, 2022

Peefy Aug 5, 2022

Peefy commented Aug 5, 2022 •

edited

Loading

chai2010 Aug 8, 2022

Peefy commented Aug 17, 2022

		@@ -0,0 +1,108 @@
		//! 'Style' is responsible for providing 'Shader' for text color rendering.

[WIP] Feat(CompilerBase-Error): Add 'One-Sentence', text rendering and error handler to CompilerError. #136

[WIP] Feat(CompilerBase-Error): Add 'One-Sentence', text rendering and error handler to CompilerError. #136

Conversation

zong-zhe commented Aug 5, 2022

1. Does this PR affect any open issues?(Y/N) and add issue references (e.g. "fix #123", "re #123".):

2. What is the scope of this PR (e.g. component or file name):

3. Provide a description of the PR(e.g. more details, effects, motivations or doc link):

4. Are there any breaking changes?(Y/N) and describe the breaking changes(e.g. more details, motivations or doc link):

5. Are there test cases for these changes?(Y/N) select and add more details, references or doc links:

6. Release note

coveralls commented Aug 5, 2022 • edited Loading

Pull Request Test Coverage Report for Build 2817522474

💛 - Coveralls

Peefy left a comment • edited Loading

Choose a reason for hiding this comment

Peefy commented Aug 5, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Peefy commented Aug 5, 2022 • edited Loading

Choose a reason for hiding this comment

Peefy commented Aug 17, 2022

coveralls commented Aug 5, 2022 •

edited

Loading

Peefy left a comment •

edited

Loading

Peefy commented Aug 5, 2022 •

edited

Loading