feat(VSCode): Define metadata API

[lordrip]

No description provided.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@c3cf5e0). Learn more about missing BASE report.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1435   +/-   ##
=======================================
  Coverage        ?   67.53%           
  Complexity      ?       25           
=======================================
  Files           ?      266           
  Lines           ?     7601           
  Branches        ?     1520           
=======================================
  Hits            ?     5133           
  Misses          ?     2465           
  Partials        ?        3           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[apupier]

just a note to ensure that you have in mind that this info will need to be computed on your side.
In maven based project, I think the path which is mentioned in the camel route is the one from the classpath, so from src/main/resources usually.

[lordrip]

Since we would need to use a File picker of some sorts, the expectation would be to intercept that filepath and make it relative to the open file

[apupier]

This could work only on first edit.
When reopening the editor, it won't go through the File picker.

[lordrip]

no, it won't, but the path will be already stored if needed, so no problem for the next time

[apupier]

when moving from standalone to a Maven projects, need to check where the xslt files are moved and if the saved path needs to be updated then

[lordrip]

I think this conversation will need to happen once we get more information about the topic, at the moment of the implementation. I'll remove the comment relative to the file being edited so we can move forward.

[apupier]

either need to remove the path parameter of the currently edited file from setMetadata and getMetadata, or to add it also in getResourceContent to make it coherent of either rely on the parameters for the currently edited file or rely on the channelAPI attributes.

I think we can rely on the channel api and remove the path parameter of getMetadata and setMetadata

[apupier]

Should we declare the exception in case there is an exception while trying to save the file?

[lordrip]

It might be a good idea for the future, at this moment, I think whenever an exception happens, the notification and handling should be delegated to the host. For VSCode, this is what I think should happen:

1. A file is being saved
2. An exception is thrown from the fs or the MA module that controls the files being written
3. VSCode captures this exception and notifies the user through the VSCode alert functionality
4. We could choose to rethrow the exception to the Editor as well, just in case we want to either handle the UI part differently or notify the user as well.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[lordrip]

Merging this as a first iteration of the needed API, will be revisited once the implementation is more mature.