Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat(Compiler-Base): Add diagnostic handler. #170

Merged
merged 22 commits into from
Sep 1, 2022
Merged

Feat(Compiler-Base): Add diagnostic handler. #170

merged 22 commits into from
Sep 1, 2022

Conversation

zong-zhe
Copy link
Contributor

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

  • N
  • Y

issue #115

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

add diagnostic handler in compiler_base/error/lib.rs.

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

  • Affects user behaviors
  • Contains syntax changes
  • Contains variable changes
  • Contains experimental features
  • Performance regression: Consumes more CPU
  • Performance regression: Consumes more Memory
  • Other

Turn TemplateLoader completely into a private crate for DiagnosticHandler.
Move some comments from TemplateLoader to DiagnosticHandler.
Move MessageArgs form 'compiler_base/error/diagnostic_message.rs' to 'compiler_base/error/lib.rs'.
Add DiagnosticHandler in 'compiler_base/error/lib.rs'.

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:

  • Unit test
  • Integration test
  • Benchmark (add benchmark stats below)
  • Manual test (add detailed scripts or steps below)
  • Other

test cases in 'compiler_base/error/tests.rs'.

6. Release note

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

None

@zong-zhe zong-zhe added enhancement New feature or request error-handling Issues or PRs related to kcl error handling feat labels Aug 30, 2022
@zong-zhe zong-zhe added this to the v0.4.3 Release milestone Aug 30, 2022
@zong-zhe zong-zhe self-assigned this Aug 30, 2022
@coveralls
Copy link
Collaborator

coveralls commented Aug 30, 2022

Pull Request Test Coverage Report for Build 2968688349

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 340 unchanged lines in 3 files lost coverage.
  • Overall coverage increased (+0.3%) to 60.42%

Files with Coverage Reduction New Missed Lines %
kclvm/tools/src/printer/tests.rs 1 95.24%
kclvm/runtime/src/api/kclvm.rs 25 44.44%
kclvm/runtime/src/value/api.rs 314 0%
Totals Coverage Status
Change from base Build 2949877482: 0.3%
Covered Lines: 23789
Relevant Lines: 39373

💛 - Coveralls

@Peefy Peefy modified the milestones: v0.4.3 Release, v0.4.4 Release Aug 31, 2022
@Peefy
Copy link
Contributor

Peefy commented Aug 31, 2022

Two important things:

  1. DiagnosticHandler preferably has a default method, which loads the default template
  2. It is necessary to write clearly how to write *.ftl template in the lib.rs and new_with_template_dir methods, you can link the *.ftl official documentation.

kclvm/compiler_base/error/src/lib.rs Outdated Show resolved Hide resolved
kclvm/compiler_base/error/src/lib.rs Outdated Show resolved Hide resolved
kclvm/compiler_base/error/src/lib.rs Outdated Show resolved Hide resolved
kclvm/compiler_base/error/src/lib.rs Outdated Show resolved Hide resolved
ldxdl
ldxdl previously approved these changes Sep 1, 2022
Copy link
Contributor

@ldxdl ldxdl left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link
Contributor

@Peefy Peefy left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@He1pa He1pa left a comment

Choose a reason for hiding this comment

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

LGTM

@zong-zhe zong-zhe merged commit 40b87f3 into kcl-lang:main Sep 1, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Sep 1, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request error-handling Issues or PRs related to kcl error handling feat
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants