Add schema info to diagnostics

[gorkem]

when validation against a schema fails also add the schema information to the published diagnostics. This way users can identify the schemas that is affecting their YAML files.

[evidolob]

@gorkem @JPinkney @joshuawilson
I have prototype of this, I add scheme URL in source field of Diagnostic
Example URL:

Example local file:

WDYT?

[JPinkney]

That looks good to me

[gorkem]

Are you sending it as part of the message filed on Diagnostic?

[evidolob]

I not sure that understand the question, I add URL/path to Diagnostic#source field

[gorkem]

That is exactly what I was asking.
Can you also provide a screenshot the problem view when you have one of these issues.

[evidolob]

[gorkem]

OK this is half bad :) Can we have a format such as yaml-schema: ${schema} and for generic yaml issues just yaml

[evidolob]

We can, but what is the value of ${schema} ? URI or just name?
We can use schema title if present, if not, than URI.

[gorkem]

We can use schema title if present, if not, than URI.
+1 Sounds like a plan

[rivy]

Thanks, nice addition!

[ssbarnea]

I looked for the entire morning on how to expose this information and I still do not know how to enable the diagnosticst. Was this fixed only in an unreleased version? -- I am currently using the latest YAML 0.15.0 extension, which was released two weeks ago, so I expect to be able to see the diagnostics. Is there a hidden option to enable these?

[evidolob]

@ssbarnea this works since 0.12.0

[ssbarnea]

@evidolob So why do I see only this:

[evidolob]

I discuss that there #310 (comment)
Becouse your schema has title field we show it first and then show shema url.

[evidolob]

And you can use Jump to schema location CodeAction to open schema in editor.

[ssbarnea]

The string that is displayed is not really the schema name but is the title of the schema property that generated the error, which does not give any hint about which schema was effectively used. Take a look at one file like https://github.com/ansible-community/ansible-lint/blob/schemas/src/ansiblelint/data/ansible-playbook-schema.json and you will see lots of titles around.

So yet, we do display information from within the schema but not the schema information itself.

Combined with the fact that user can enable the schemaStore, you endup with a plethora of possible sources for schemas, some configured by local patterns and some determined by the schemastore. Still, as a user I have no clue from which file this came.

I am not sure where is the "Jump to schema location" available from, as by pressing F1 (CommandPallete) I am unable to find it and I neither see the light-bulb contextual action available on the error, as documented on https://code.visualstudio.com/docs/editor/refactoring#_code-actions-quick-fixes-and-refactorings -- (i did not disable it in settings).

My yaml related settings look like:

  "[yaml]": {
      "editor.insertSpaces": true,
      "editor.quickSuggestions": {
          "comments": true,
          "other": true,
          "strings": true
      },
      "editor.tabSize": 2
  },
  "yaml.completion": true,
  "yaml.customTags": [
      "!include-raw:"
  ],
  "yaml.format.enable": true,
  "yaml.schemas": {
...
  },
  "yaml.schemaStore.enable": false,
  "yaml.trace.server": "verbose",
  "yaml.validate": true

[evidolob]

Oh, my bad Jump to schema location is not released yet.

As for

The string that is displayed is not really the schema name but is the title of the schema property that generated the error, which does not give any hint about which schema was effectively used. Take a look at one file like https://github.com/ansible-community/ansible-lint/blob/schemas/src/ansiblelint/data/ansible-playbook-schema.json and you will see lots of titles around.

So yet, we do display information from within the schema but not the schema information itself.

Combined with the fact that user can enable the schemaStore, you endup with a plethora of possible sources for schemas, some configured by local patterns and some determined by the schemastore. Still, as a user I have no clue from which file this came.

Can you create an issue for it? We can fix that pretty fast.