Merge branch 'main' into yaml-schema-lint

Author: X-Guardian

.github/workflows/CI.yaml

@@ -74,6 +74,7 @@ jobs:
         uses: coverallsapp/github-action@c7885c00cb7ec0b8f9f5ff3f53cddb980f7a4412 # v2.2.0
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
+        continue-on-error: true
 
       - name: Publish
         if: ${{ success() && runner.os == 'Linux' && github.event_name == 'push' && github.ref == 'refs/heads/main'}}

CHANGELOG.md

@@ -1,3 +1,16 @@
+### 1.21.0
+- Feat: Enable suppressing diagnostics per-line by adding a `# yaml-language-server-disable` comment [vscode-yaml#666](https://github.com/redhat-developer/vscode-yaml/issues/666)
+- Feat: Allow `yaml.validate` and `yaml.format.enable` to be overriden in language-specific settings [#1188](https://github.com/redhat-developer/yaml-language-server/pull/1188)
+- Fix: Do not register the extension for templated YAML languages (such as Helm, Jinja, etc.) [vscode-yaml#1204](https://github.com/redhat-developer/vscode-yaml/issues/1204)
+- Fix: Handle default booleans and integers properly in required properties completion [vscode-yaml#1205](https://github.com/redhat-developer/vscode-yaml/issues/1205)
+- Fix: Prevent infinite `$ref` resolution loops [#1195](https://github.com/redhat-developer/yaml-language-server/issues/1195)
+- Fix: Preserve document end marker (`...`) when formatting (by updating prettier to 3.8.1) [vscode-yaml#1211](https://github.com/redhat-developer/vscode-yaml/issues/1211)
+- Fix: Don't escape '-' in hover text, since it was breaking links [#1151](https://github.com/redhat-developer/yaml-language-server/issues/1151)
+- Fix: Attempt to resolve a schema referenced through a relative `$ref` locally before peforming a remote `$id` lookup [#1186](https://github.com/redhat-developer/yaml-language-server/issues/1184)
+- Fix: Improve documentation of `yaml.schemas` setting [vscode-yaml#1207](https://github.com/redhat-developer/vscode-yaml/issues/1207)
+
+Thanks to [Simon Heather](https://github.com/X-Guardian) for your contributions
+
 ### 1.20.0
 - Feat: Support JSON Schema 2019-09 and 2020-12 [#478](https://github.com/redhat-developer/yaml-language-server/issues/478), [vscode-yaml#1122](https://github.com/redhat-developer/vscode-yaml/issues/1122), [#823](https://github.com/redhat-developer/yaml-language-server/issues/823)
 - Feat: Support drafts 2019-09 and 2020-12 when validating a referenced JSON schema using AJV [#1164](https://github.com/redhat-developer/yaml-language-server/pull/1164)

README.md

@@ -56,6 +56,33 @@ The following settings are supported:
 - `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`
 
+## Suppressing diagnostics
+
+You can suppress specific validation warnings on a per-line basis by adding a `# yaml-language-server-disable` comment on the line immediately before the one producing the diagnostic.
+
+### Suppress all diagnostics on a line
+
+```yaml
+# yaml-language-server-disable
+version: 123
+```
+
+### Suppress only specific diagnostics
+
+Provide one or more message substrings (comma-separated, case-insensitive). Only diagnostics whose message contains a matching substring will be suppressed; the rest are kept.
+
+```yaml
+# yaml-language-server-disable Incorrect type
+version: 123
+```
+
+```yaml
+# yaml-language-server-disable Incorrect type, not accepted
+version: 123
+```
+
+The substrings are matched against the diagnostic message text reported by the language server.
+
 ##### Adding custom tags
 
 In order to use the custom tags in your YAML file you need to first specify the custom tags in the setting of your code editor. For example, we can have the following custom tags:
@@ -260,6 +287,12 @@ or absolute path:
 # yaml-language-server: $schema=/absolute/path/to/schema
 ```
 
+or IntelliJ compatible format:
+
+```yaml
+# $schema: <urlOrPathToTheSchema>
+```
+
 ### Schema priority
 
 The following is the priority of schema association in highest to lowest priority:

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "yaml-language-server",
   "description": "YAML language server",
-  "version": "1.20.1",
+  "version": "1.22.0",
   "author": "Red Hat",
   "license": "MIT",
   "contributors": [
@@ -30,7 +30,7 @@
     "@vscode/l10n": "^0.0.18",
     "ajv": "^8.17.1",
     "ajv-draft-04": "^1.0.0",
-    "prettier": "^3.5.0",
+    "prettier": "^3.8.1",
     "request-light": "^0.5.7",
     "vscode-json-languageservice": "4.1.8",
     "vscode-languageserver": "^9.0.0",
@@ -53,8 +53,6 @@
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-prettier": "^5.0.0",
-    "http-proxy-agent": "^5.0.0",
-    "https-proxy-agent": "^5.0.0",
     "mocha": "11.7.1",
     "mocha-lcov-reporter": "^1.3.0",
     "nyc": "^15.1.0",
@@ -69,9 +67,9 @@
     "clean": "rimraf out/server && rimraf lib",
     "compile": "tsc -p .",
     "watch": "tsc --watch -p .",
-    "test": "mocha --require ts-node/register --timeout 5000 --ui bdd ./test/*.test.ts",
-    "coverage": "nyc mocha --require ts-node/register --timeout 5000 --require source-map-support/register --recursive --ui bdd ./test/*.test.ts",
-    "coveralls": "nyc --reporter=lcov --reporter=text mocha --timeout 5000 --require ts-node/register --require source-map-support/register --recursive --ui bdd ./test/*.test.ts",
+    "test": "mocha --require ts-node/register --timeout 10000 --ui bdd ./test/*.test.ts",
+    "coverage": "nyc mocha --require ts-node/register --timeout 10000 --require source-map-support/register --recursive --ui bdd ./test/*.test.ts",
+    "coveralls": "nyc --reporter=lcov --reporter=text mocha --timeout 10000 --require ts-node/register --require source-map-support/register --recursive --ui bdd ./test/*.test.ts",
     "lint": "eslint --max-warnings 0 -c .eslintrc.js --ext .ts src test",
     "lint-ci": "eslint --max-warnings 0 -c .eslintrc.js -f @microsoft/eslint-formatter-sarif -o eslint-result.sarif --ext .ts src test",
     "prettier-fix": "npm run prettier --write .",

package.json

@@ -40,7 +40,7 @@ export class SettingsHandler {
     const config = await this.connection.workspace.getConfiguration([
       { section: 'yaml' },
       { section: 'http' },
-      { section: '[yaml]', scopeUri: 'null' },
+      { section: '[yaml]' },
       { section: 'editor' },
       { section: 'files' },
     ]);

src/languageserver/handlers/settingsHandlers.ts

@@ -37,7 +37,7 @@ export function autoDetectKubernetesSchemaFromDocument(
     })
     .filter((ref) => ref)
     .map((ref) => ref.replace('_definitions.json#/definitions/', '').toLowerCase());
-  const groupWithoutK8sIO = group.replace('.k8s.io', '');
+  const groupWithoutK8sIO = group.replace('.k8s.io', '').replace('rbac.authorization', 'rbac');
   const k8sTypeName = `io.k8s.api.${groupWithoutK8sIO.toLowerCase()}.${version.toLowerCase()}.${kind.toLowerCase()}`;
 
   if (kubernetesBuildIns.includes(k8sTypeName)) {

src/languageservice/services/crdUtil.ts

@@ -17,21 +17,16 @@ export function getSchemaFromModeline(doc: SingleYAMLDocument | JSONDocument): s
       return isModeline(lineComment);
     });
     if (yamlLanguageServerModeline != undefined) {
-      const schemaMatchs = yamlLanguageServerModeline.match(/\$schema=\S+/g);
-      if (schemaMatchs !== null && schemaMatchs.length >= 1) {
-        if (schemaMatchs.length >= 2) {
-          console.log(
-            'Several $schema attributes have been found on the yaml-language-server modeline. The first one will be picked.'
-          );
-        }
-        return schemaMatchs[0].substring('$schema='.length);
+      const schemaMatches = yamlLanguageServerModeline.match(/\$schema(?:=|:\s*)(\S+)/);
+      if (schemaMatches !== null && schemaMatches.length === 2) {
+        return schemaMatches[1];
       }
     }
   }
   return undefined;
 }
 
 export function isModeline(lineText: string): boolean {
-  const matchModeline = lineText.match(/^#\s+yaml-language-server\s*:/g);
+  const matchModeline = lineText.match(/^#\s+(?:yaml-language-server\s*:|\$schema:)/g);
   return matchModeline !== null && matchModeline.length === 1;
 }

src/languageservice/services/modelineUtil.ts

@@ -336,21 +336,24 @@ export class YamlCompletion {
       }
 
       if (isModeline(lineContent) || isInComment(doc.tokens, offset)) {
-        const schemaIndex = lineContent.indexOf('$schema=');
-        if (schemaIndex !== -1 && schemaIndex + '$schema='.length <= position.character) {
-          this.schemaService.getAllSchemas().forEach((schema) => {
-            const schemaIdCompletion: CompletionItem = {
-              kind: CompletionItemKind.Constant,
-              label: schema.name ?? schema.uri,
-              detail: schema.description,
-              insertText: schema.uri,
-              insertTextFormat: InsertTextFormat.PlainText,
-              insertTextMode: InsertTextMode.asIs,
-            };
-            result.items.push(schemaIdCompletion);
-          });
+        const schemaMatch = lineContent.match(/\$schema[=:]/);
+        if (schemaMatch) {
+          const schemaIndex = schemaMatch.index;
+          if (schemaIndex + schemaMatch[0].length <= position.character) {
+            this.schemaService.getAllSchemas().forEach((schema) => {
+              const schemaIdCompletion: CompletionItem = {
+                kind: CompletionItemKind.Constant,
+                label: schema.name ?? schema.uri,
+                detail: schema.description,
+                insertText: schema.uri,
+                insertTextFormat: InsertTextFormat.PlainText,
+                insertTextMode: InsertTextMode.asIs,
+              };
+              result.items.push(schemaIdCompletion);
+            });
+          }
+          return result;
         }
-        return result;
       }
 
       if (!schema || schema.errors.length) {
@@ -1164,8 +1167,8 @@ export class YamlCompletion {
           case 'number':
           case 'integer':
           case 'anyOf': {
-            let value = propertySchema.default || propertySchema.const;
-            if (value) {
+            let value = propertySchema.default !== undefined ? propertySchema.default : propertySchema.const;
+            if (value !== undefined) {
               if (type === 'string') {
                 value = toYamlStringScalar(value);
               }