yaml-language-server 1.11.1-f19ac11.0 → 1.12.1-3b973a6.0

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+### [UNRELEASED] 
+
+- Add: Enforce alphabetical ordering of keys in mappings and provide codeaction to fix it. 
+
+### 1.11.0
+- Fix: only the first choice is shown when hovering anyOf-typed properties [#784](https://github.com/redhat-developer/vscode-yaml/issues/784)
+- Fix: Description in the schema root does not get displayed [#809](https://github.com/redhat-developer/vscode-yaml/issues/809)
+- Fix: yaml.validation.error telemetry events are broken [#816](https://github.com/redhat-developer/vscode-yaml/issues/816)
+- Add: add diagnostic data with missing properties [#775](https://github.com/redhat-developer/yaml-language-server/pull/775)
+- Fix: Can't suggest object correctly with certain schema definition. [#769](https://github.com/redhat-developer/yaml-language-server/issues/769)
+- Fix: Property shows up multiple times in completions [#829](https://github.com/redhat-developer/vscode-yaml/issues/829)
+- Fix: oneOf validation of keys using "required" not working since 1.3.0 [#769](https://github.com/redhat-developer/vscode-yaml/issues/769)
+- Fix: incorrect behavior of keys with quotes [#842](https://github.com/redhat-developer/vscode-yaml/issues/842)
+- Fix: bad completion with array of objects [#793](https://github.com/redhat-developer/yaml-language-server/issues/793)
+- Add: Modeline takes precendence over registerContributor API [#806](https://github.com/redhat-developer/yaml-language-server/pull/806)
+
+Thanks to Petr Spacek,Josh Pinkney
+
 ### 1.10.0
 - Fix: TypeError: i.startsWith is not a function [#747](https://github.com/redhat-developer/yaml-language-server/issues/747)
 - Fix: fix: autocomplete indent on object within an array [#751](https://github.com/redhat-developer/yaml-language-server/pull/751)

package/README.md

@@ -52,6 +52,7 @@ The following settings are supported:
 - `yaml.suggest.parentSkeletonSelectedFirst`: If true, the user must select some parent skeleton first before autocompletion starts to suggest the rest of the properties.\nWhen yaml object is not empty, autocompletion ignores this setting and returns all properties and skeletons.
 - `yaml.style.flowMapping` : Forbids flow style mappings if set to `forbid` 
 - `yaml.style.flowSequence` : Forbids flow style sequences if set to `forbid`
+- `yaml.keyOrdering` : Enforces alphabetical ordering of keys in mappings when set to `true`. Default is `false`
 
 ##### Adding custom tags
 
@@ -224,6 +225,19 @@ yaml.schemas: {
 
 `yaml.schemas` allows you to specify json schemas that you want to validate against the yaml that you write. Kubernetes is an optional field. It does not require a url as the language server will provide that. You just need the keyword kubernetes and a glob pattern.
 
+### Nested Schema References
+
+Suppose a file is meant to be a component of an existing schema (like a `job.yaml` file in a circleci orb), but there isn't a standalone schema that you can reference. If there is a nested schema definition for this subcomponent, you can reference it using a url fragment, e.g.:
+
+```
+yaml.schemas: {
+    "https://json.schemastore.org/circleciconfig#/definitions/jobs/additionalProperties": "/src/jobs/*.yaml",
+}
+```
+
+> **Note**
+> This will require reading your existing schema and understanding the schemastore structure a bit. (TODO: link to a documentation or blog post here?)
+
 ### Using inlined schema
 
 It is possible to specify a yaml schema using a modeline.
@@ -244,6 +258,15 @@ or absolute path:
 # yaml-language-server: $schema=/absolute/path/to/schema
 ```
 
+### Schema priority
+
+The following is the priority of schema association in highest to lowest priority:
+1. Modeline
+2. CustomSchemaProvider API
+3. yaml.settings
+4. Schema association notification
+5. Schema Store
+
 ## Containerized Language Server
 
 An image is provided for users who would like to use the YAML language server without having to install dependencies locally.