Suggestions not working

[tobia]

To Reproduce

1. Close ST3, rename away your ~/.config/sublime-text-3` directory, and reopen ST3
2. Install Package control from the command palette
3. Install LSP and LSP-yaml packages; restart ST3
4. Open or create a yaml file with a $schema: declaration at the top (see example below); restart ST3 again for good measure
5. Place your cursor in any place where a fixed set of keys are expected and start writing

Expected behavior
The available keys according to the schema should be shown in the suggestion menu.

Actual behaviour
Either nothing is shown, or ST3's default menu based on the other words present in the file.

Example
Here is a yaml file with a valid schema:

$schema: https://vega.github.io/schema/vega-lite/v4.json
description: A simple bar chart
data:
  values:
    - { a: A, b: 28 }
    - { a: B, b: 55 }
    - { a: C, b: 43 }
mark: bar
encoding:
  x: 
    field: a
    type: nominal
    axis: 
      labelAngle: 0
  y: 
    field: b
    type: quantitative
  # <- here

If you place your cursor where the comment is shown, aligned with y:, and start typing col... it should suggest color, but instead nothing is suggested.

[jfcherng]

upstream issue. redhat-developer/yaml-language-server#354

[rchl]

But it looks like it supports the modeline comment like:

# yaml-language-server: $schema=expectedUrl

[tobia]

upstream issue. redhat-developer/yaml-language-server#354

If this is an issue of supporting the $schema directive, are you implying that there is another way of specifying the schema that actually works with this plugin?

Can you please explain what it is?

[rchl]

Just based on that referenced issue, there is no support for $schema key currently but there is support for having a comment on the first line that references the schema.

[jfcherng]

Since there is already a PR in the upstream repo, it may be supported soon.

[tobia]

Ok, what I mean is, how do users of this plugin usually associate schemas with files?

The README says nothing, so at least that should be addressed?

[rchl]

It includes associations for schemas from schemastore.org.

As for using custom schemas, I haven't investigated that. But sure, extending readme wouldn't hurt. Feel free to submit a PR.

[rchl]

Actually, default settings have an option for associating custom schemas:

LSP-yaml/LSP-yaml.sublime-settings

Line 48 in d7cc4de

"yaml.schemas": {},

And you can follow the link to the original server documentation to get more details on that.

[jfcherng]

Ok, what I mean is, how do users of this plugin usually associate schemas with files?

All related information seems to be started from https://github.com/redhat-developer/yaml-language-server#associating-a-schema-to-a-glob-pattern-via-yamlschemas but yeah, we didn't try it.

[RandomByte]

but yeah, we didn't try it.

I actually did that a while ago. Using the mentioned yaml.schemas configuration, following the mentioned documentation 👍 (make sure to check the "More examples" chapter).

The $schema: concept is actually new to me. But it would certainly make things easier in some cases. Anyways, an upstream issue with the YAML Language Server.