Populate Index with content from json files

[cdietrich]

additional to our dsl files *.hello we also have some *.something.json files in the workspace.
now we want to make declarations done in json available to the dsl files via cross reference.

i see these options

1. write a simple json grammar and register it to *.something.json.
2. register a language but ly in the parser ?!?
3. hook into WorkspaceManager.loadAdditionalDocuments and DefaultDocumentUpdateHandler.didChangeWatchedFiles (and maybe more ?!?, manually populate some structure (dont think we can manage langium docs from there=

any comments, hints, best practices

[msujew]

Hey @cdietrich,

I'm thinking of this:

1. Declare the JSON grammar as types in your Langium grammar. I.e. interface JSONObject, JSONArray, JSONProperty, etc.
2. This allows your DSL files to reference elements of type JSONProperty.
3. Load your JSON during the respective events, parse it and construct in memory instances of JSONObject, JSONArray, JSONProperty, etc. and put those into a document.

I believe that this should generally allow the linking service to link to those elements of the JSON document. Additionally, you might be also able to play around with the CST to even allow navigation to those declarations (assuming you use a JSON parser that yields you the line/column information of the JSON objects, like jsonc-parser).

[cdietrich]

this based on my 3?

[msujew]

Yes, you can combine that well with your nr. 3.

[jmenzies12]

@cdietrich did you end up with a solution for this? We're looking to do something similar

[cdietrich]

Unfinished prototype https://github.com/cdietrich/json-indexing-experiment