feat: lsp hover keyword highlight

[shruti2522]

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

• N
• Y
  fix [LFX PreTest] pretest for LFX LSP hover content #1304

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

kcl/kclvm/tools/src/LSP/src/hover.rs
kcl/kclvm/sema/src/ty/mod.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

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

cc @He1pa @Peefy

[shruti2522]

I have added Atrributes to the keywords in KCL.tmLanguage.json and this is how the changes look locally @Peefy @He1pa

[coveralls]

Pull Request Test Coverage Report for Build 9188427383

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

• For more information on this, see Tracking coverage changes with pull request builds.
• To avoid this issue with future PRs, see these Recommended CI Configurations.
• For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

• 33 of 33 (100.0%) changed or added relevant lines in 4 files are covered.
• 23 unchanged lines in 2 files lost coverage.
• Overall coverage decreased (-0.03%) to 71.062%

---

Files with Coverage Reduction	New Missed Lines	%
kclvm/tools/src/LSP/src/hover.rs	1	90.0%
kclvm/sema/src/ty/mod.rs	22	77.32%

Totals
Change from base Build 9177105510:	-0.03%
Covered Lines:	53813
Relevant Lines:	75727

---

💛 - Coveralls

[shruti2522]

The current hover looks like this, is this the required keyword syntax highlighting? @Peefy @He1pa

[Peefy]

I have added Atrributes to the keywords in KCL.tmLanguage.json and this is how the changes look locally @Peefy @He1pa

Hello @shruti2522 The hover content expect a right kcl code form with indentation like the rust-analyzer does.

Furthermore, I do not believe that adding ````kcl` is the correct approach for two reasons

1. You cannot ensure that all IDE clients such as VS Code, idea render hovers in a markdown format, right?
2. kcl is not a label that can be marked down for normal rendering in the markdown files.

cc @He1pa

[shruti2522]

PTAL @Peefy @He1pa

[shruti2522]

current hover:

[He1pa]

The current hover looks like this, is this the required keyword syntax highlighting? @Peefy @He1pa

You dont need to follow the previous stlpe, and the Attributes is not must required
The previous hover content was:

pkg
schema Name
---
doc
---
Attributes:
attr1: type1
attr2: type2

Now can be rendered as

pkg
```kcl
schema Name:
attr1: type1
attr2: type2

---

doc

Or some other better style.

[shruti2522]

updated doc style @He1pa

[shruti2522]

added indentation for attrs. working on updating the test cases for it.

[Peefy]

@shruti2522
Good Job! Besides I suggest merging the hovering market string of schema name and schema attribute into one (merge docs[0] and docs[1] to docs[0]).

[shruti2522]

Done @Peefy

[Peefy]

Done @Peefy

According to the review comments, what I mean is to merge the content of the schema doc hover instead of merging the content of the docs to hover.

[shruti2522]

According to the review comments, what I mean is to merge the content of the schema doc hover instead of merging the content of the docs to hover.

If I understand correctly, what I need to do is to merge all the contents of docs into one such that the complete hover content is displayed as one without any separating lines? @Peefy

[Peefy]

According to the review comments, what I mean is to merge the content of the schema doc hover instead of merging the content of the docs to hover.

If I understand correctly, what I need to do is to merge all the contents of docs into one such that the complete hover content is displayed as one without any separating lines? @Peefy

Just merge the schema doc instead of merge all docs in docs_to_hover function.

[shruti2522]

Hey @Peefy @He1pa , I have updated all the newly added test cases. Any further changes?

[shruti2522]

Done with the changes @Peefy

[Peefy]

PR conflict

[shruti2522]

Resolved conflicts @Peefy

[Peefy]

Hello @shruti2522 Add some comments.

[shruti2522]

schema hover:

fn hover:

type hover:

cc @Peefy @He1pa

[Peefy]

Hello @shruti2522 Add some comments and CI failed.

[shruti2522]

CI shows:

assertion `left == right` failed
  left: [LanguageString(LanguageString { language: "KCL", value: "schedulingStrategy: SchedulingStrategy" }), String("SchedulingStrategy represents scheduling strategy.")]
 right: [LanguageString(LanguageString { language: "KCL", value: "schedulingStrategy: SchedulingStrategy" }), LanguageString(LanguageString { language: "KCL", value: "SchedulingStrategy represents scheduling strategy." })]

but the expected value in konfig_hover_test_main is :

let expect: Vec<MarkedString> = vec![
                MarkedString::LanguageString(lsp_types::LanguageString {
                    language: "KCL".to_string(),
                    value: "schedulingStrategy: SchedulingStrategy".to_string(),
                }),
                MarkedString::String(
                    "SchedulingStrategy represents scheduling strategy.".to_string(),
                ),
            ];

@Peefy

[Peefy]

This indicates that there is an issue with the implementation logic of the hover in this PR. Please carefully check the code. @shruti2522

[shruti2522]

All checks have passed @Peefy

[Peefy]

@shruti2522

Although all the test cases have been passed, I believe there is an issue with the implementation of docs_to_hover, which resulted in incorrect test cases. Please refer to the review comments for modifications.

cc @He1pa Could you please check it again?

[shruti2522]

I have updated the test cases in hover to use LanguageString in place of String wherever required and the test cases pass locally. @Peefy

[Peefy]

LGTM