KCL-Vet should tell user the error line in json/yaml file.

[zong-zhe]

Feature Request

Is your feature request related to a problem? Please describe:

KCL-Vet should tell user the error line in json/yaml file.
At present, KCL-Vet can only tell the user what is wrong with the KCL constructed by KCL-Vet.

Describe the feature you'd like:

The output error message indicates which line of json/yaml is wrong.

Describe alternatives you've considered:

None

Teachability, Documentation, Adoption, Migration Strategy:

None

[zong-zhe]

Research on cue vet

How does cue obtain the location information of json ?

cue language is a superset of json, and the parser of cue can parse json files.

How does cue obtain the location information of yaml?

The idea of cue validating yaml is similar to KCL, which parses the yaml file into AST, and then merges the AST of the yaml file with the AST of cue for validation.

As for the location information, the location information used by cue vet has been calculated when parsing the yaml file into AST.

cue uses a third-party library to parse yaml:

https://github.com/cue-lang/cue/tree/master/internal/third_party/yaml

Reference code:

During the process of cue parsing the yaml file, the location information of the corresponding node in the AST is updated synchronously
https://github.com/cue-lang/cue/blob/b36b4775e6a890899c460f62f8e59b4182d63c2a/internal/third_party/yaml/decode.go#L190C18-L190C22
https://github.com/cue-lang/cue/blob/b36b4775e6a890899c460f62f8e59b4182d63c2a/internal/third_party/yaml/decode.go#L303
https://github.com/cue-lang/cue/blob/b36b4775e6a890899c460f62f8e59b4182d63c2a/internal/third_party/yaml/decode.go#L451C21-L451C22

kcl vet solution

The process of kcl vet validating yaml is similar to cue, currently parsing json and yaml into kcl ast. The solution is to calculate and update the file information of json/yaml when parsing the json or yaml into the AST.

KCL's resolver and runner do not check whether the file type is a KCL file, and the diagnostic emitter will not check the file type. Therefore, the error information in the json/yaml file can also be display normally.

The part that needs to be implemented is to parse the specific location of each element during parsing the json and yaml files, and then fill it into the AST synchronously.

Json element location information third-party library https://crates.io/crates/json-spanned-value
Yaml element location information third-party library https://crates.io/crates/marked-yaml

I manually mock it into kcl-vet to show the diagnostic in json file:

[Peefy]

Closed by #944 and #949