feat: add expected properties to diagnostic message

l10n/bundle.l10n.de.json

@@ -33,6 +33,7 @@
   "maxItemsWarning": "Array hat zu viele Elemente. Erwartet: {0} oder weniger.",
   "uniqueItemsWarning": "Array enthält doppelte Elemente.",
   "DisallowedExtraPropWarning": "Eigenschaft {0} ist nicht erlaubt.",
+  "DisallowedExtraPropWarningWithExpected": "Eigenschaft {0} ist nicht erlaubt. Erwartet: {1}.",
   "MaxPropWarning": "Objekt hat mehr Eigenschaften als das Limit von {0}.",
   "MinPropWarning": "Objekt hat weniger Eigenschaften als die erforderliche Anzahl von {0}.",
   "RequiredDependentPropWarning": "Objekt fehlt die Eigenschaft {0}, die von Eigenschaft {1} benötigt wird.",

l10n/bundle.l10n.fr.json

@@ -33,6 +33,7 @@
   "maxItemsWarning": "Le tableau contient trop d'éléments. On attend {0} ou moins.",
   "uniqueItemsWarning": "Le tableau contient des éléments en double.",
   "DisallowedExtraPropWarning": "La propriété {0} n'est pas autorisée.",
+  "DisallowedExtraPropWarningWithExpected": "La propriété {0} n'est pas autorisée. Attendu: {1}.",
   "MaxPropWarning": "L'objet a plus de propriétés que la limite de {0}.",
   "MinPropWarning": "L'objet a moins de propriétés que le nombre requis de {0}",
   "RequiredDependentPropWarning": "L'objet ne possède pas la propriété {0} requise par la propriété {1}.",

l10n/bundle.l10n.ja.json

@@ -33,6 +33,7 @@
   "maxItemsWarning": "配列の項目数が多すぎます。{0} 項目以下にしてください。",
   "uniqueItemsWarning": "配列に重複する項目があります。",
   "DisallowedExtraPropWarning": "プロパティ {0} は許可されていません。",
+  "DisallowedExtraPropWarningWithExpected": "プロパティ {0} は許可されていません。期待される値: {1}。",
   "MaxPropWarning": "オブジェクトのプロパティ数が制限値 {0} を超えています。",
   "MinPropWarning": "オブジェクトのプロパティ数が必要数 {0} に満たないです。",
   "RequiredDependentPropWarning": "プロパティ {1} によって必要とされるプロパティ {0} が存在しません。",

l10n/bundle.l10n.json

@@ -33,6 +33,7 @@
   "maxItemsWarning": "Array has too many items. Expected {0} or fewer.",
   "uniqueItemsWarning": "Array has duplicate items.",
   "DisallowedExtraPropWarning": "Property {0} is not allowed.",
+  "DisallowedExtraPropWarningWithExpected": "Property {0} is not allowed. Expected: {1}.",
   "MaxPropWarning": "Object has more properties than limit of {0}.",
   "MinPropWarning": "Object has fewer properties than the required number of {0}",
   "RequiredDependentPropWarning": "Object is missing property {0} required by property {1}.",
@@ -52,5 +53,5 @@
   "flowStyleMapForbidden": "Flow style mapping is forbidden",
   "flowStyleSeqForbidden": "Flow style sequence is forbidden",
   "unUsedAnchor": "Unused anchor \"{0}\"",
-  "unUsedAlias": "Unresolved alias \"{0}\""  
+  "unUsedAlias": "Unresolved alias \"{0}\""
 }

l10n/bundle.l10n.ko.json

@@ -33,6 +33,7 @@
   "maxItemsWarning": "배열 항목 수가 너무 많습니다. 최대 {0}개 허용됩니다.",
   "uniqueItemsWarning": "배열에 중복된 항목이 있습니다.",
   "DisallowedExtraPropWarning": "속성 {0}은(는) 허용되지 않습니다.",
+  "DisallowedExtraPropWarningWithExpected": "속성 {0}은(는) 허용되지 않습니다. 예상: {1}.",
   "MaxPropWarning": "객체에 허용된 속성 수 {0}을 초과했습니다.",
   "MinPropWarning": "객체에 필요한 최소 속성 수 {0}보다 적습니다.",
   "RequiredDependentPropWarning": "속성 {1}에 필요한 속성 {0}이 누락되었습니다.",

l10n/bundle.l10n.zh-cn.json

@@ -33,6 +33,7 @@
   "maxItemsWarning": "数组项数过多。应为 {0} 项或更少。",
   "uniqueItemsWarning": "数组中包含重复项。",
   "DisallowedExtraPropWarning": "属性 {0} 不被允许。",
+  "DisallowedExtraPropWarningWithExpected": "属性 {0} 不被允许。预期：{1}。",
   "MaxPropWarning": "对象的属性数超过了限制 {0}。",
   "MinPropWarning": "对象的属性数少于所需数量 {0}。",
   "RequiredDependentPropWarning": "属性 {1} 依赖的属性 {0} 缺失。",

l10n/bundle.l10n.zh-tw.json

@@ -33,6 +33,7 @@
   "maxItemsWarning": "陣列項目數太多。應為 {0} 項或更少。",
   "uniqueItemsWarning": "陣列中有重複項目。",
   "DisallowedExtraPropWarning": "不允許的屬性 {0}。",
+  "DisallowedExtraPropWarningWithExpected": "不允許的屬性 {0}。預期：{1}。",
   "MaxPropWarning": "物件的屬性數量超過限制 {0}。",
   "MinPropWarning": "物件的屬性數量少於所需的 {0}。",
   "RequiredDependentPropWarning": "缺少由屬性 {1} 所需的屬性 {0}。",

package.json

@@ -30,6 +30,7 @@
     "@vscode/l10n": "^0.0.18",
     "ajv": "^8.17.1",
     "ajv-draft-04": "^1.0.0",
+    "fast-uri": "^3.0.6",
     "lodash": "4.17.21",
     "prettier": "^3.5.0",
     "request-light": "^0.5.7",

src/languageserver/handlers/languageHandlers.ts

@@ -38,6 +38,7 @@ import { ResultLimitReachedNotification } from '../../requestTypes';
 import * as path from 'path';
 
 export class LanguageHandlers {
+  public isTest = false;
   private languageService: LanguageService;
   private yamlSettings: SettingsState;
   private validationHandler: ValidationHandler;
@@ -84,6 +85,31 @@ export class LanguageHandlers {
     return this.languageService.findLinks(document);
   }
 
+  previousCall: { uri?: string; time?: number; request?: DocumentSymbol[] | SymbolInformation[] } = {};
+  documentSymbolHandlerFix(documentSymbolParams: DocumentSymbolParams): DocumentSymbol[] | SymbolInformation[] {
+    /**
+     * I had to combine server and client DocumentSymbol
+     * And if I use only client DocumentSymbol, outline doesn't work.
+     * So this is a prevent for double call.
+     */
+    if (
+      !this.isTest && //don't use cache when testing
+      this.previousCall.request &&
+      this.previousCall.time &&
+      this.previousCall.uri === documentSymbolParams.textDocument.uri &&
+      new Date().getTime() - this.previousCall.time < 100
+    ) {
+      return this.previousCall.request;
+    }
+
+    const res = this.documentSymbolHandler(documentSymbolParams);
+    this.previousCall = {
+      time: new Date().getTime(),
+      uri: documentSymbolParams.textDocument.uri,
+      request: res,
+    };
+  }
+
   /**
    * Called when the code outline in an editor needs to be populated
    * Returns a list of symbols that is then shown in the code outline
@@ -101,7 +127,10 @@ export class LanguageHandlers {
       'document symbols'
     );
 
-    const context = { resultLimit: this.yamlSettings.maxItemsComputed, onResultLimitExceeded };
+    const context = {
+      resultLimit: this.yamlSettings.maxItemsComputed,
+      onResultLimitExceeded,
+    };
 
     if (this.yamlSettings.hierarchicalDocumentSymbolSupport) {
       return this.languageService.findDocumentSymbols2(document, context);
@@ -149,7 +178,8 @@ export class LanguageHandlers {
       return Promise.resolve(undefined);
     }
 
-    return this.languageService.doHover(document, textDocumentPositionParams.position);
+    return this.languageService.doHoverDetail(document, textDocumentPositionParams.position);
+    // return this.languageService.doHover(document, textDocumentPositionParams.position);
   }
 
   /**

src/languageserver/handlers/requestHandlers.ts

@@ -2,21 +2,36 @@
  *  Copyright (c) Red Hat, Inc. All rights reserved.
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
-import { Connection } from 'vscode-languageserver';
+import { Connection, TextDocumentPositionParams } from 'vscode-languageserver';
+import { TextDocument } from 'vscode-languageserver-textdocument';
 import {
   MODIFICATION_ACTIONS,
   SchemaAdditions,
   SchemaDeletions,
   SchemaDeletionsAll,
 } from '../../languageservice/services/yamlSchemaService';
 import { LanguageService } from '../../languageservice/yamlLanguageService';
-import { SchemaModificationNotification } from '../../requestTypes';
+import {
+  CompletionYamlRequest,
+  GetDiagnosticRequest,
+  HoverDetailRequest,
+  HoverYamlRequest,
+  RevalidateBySchemaRequest,
+  RevalidateRequest,
+  SchemaModificationNotification,
+  VSCodeContentRequest,
+} from '../../requestTypes';
+import { SettingsState } from '../../yamlSettings';
+import { ValidationHandler } from './validationHandlers';
+import { yamlDocumentsCache } from '../../languageservice/parser/yaml-documents';
 
 export class RequestHandlers {
   private languageService: LanguageService;
   constructor(
     private readonly connection: Connection,
-    languageService: LanguageService
+    languageService: LanguageService,
+    private yamlSettings: SettingsState,
+    private validationHandler: ValidationHandler
   ) {
     this.languageService = languageService;
   }
@@ -25,6 +40,95 @@ export class RequestHandlers {
     this.connection.onRequest(SchemaModificationNotification.type, (modifications) =>
       this.registerSchemaModificationNotificationHandler(modifications)
     );
+
+    /**
+     * Received request from the client that detail info is needed.
+     */
+    this.connection.onRequest(HoverDetailRequest.type, (params: TextDocumentPositionParams) => {
+      const document = this.yamlSettings.documents.get(params.textDocument.uri);
+      // return this.languageService.doHover(document, params.position);
+      return this.languageService.doHoverDetail(document, params.position);
+    });
+
+    /**
+     * Received request from the client that revalidation is needed.
+     */
+    this.connection.onRequest(RevalidateRequest.type, async (uri: string) => {
+      const document = this.yamlSettings.documents.get(uri);
+      if (!document) {
+        console.log('Revalidate: No document found for uri: ' + uri);
+      }
+      await this.validationHandler.validate(document);
+    });
+
+    /**
+     * Received request from the client that the diagnostic is needed.
+     * If the file hasn't been opened yet, we need to get the content from the client.
+     * It's used fot the builder solution diagnostic.
+     */
+    this.connection.onRequest(GetDiagnosticRequest.type, async (uri: string) => {
+      let document = this.yamlSettings.documents.get(uri);
+      if (!document) {
+        const content = await this.connection.sendRequest(VSCodeContentRequest.type, uri);
+        if (typeof content !== 'string') {
+          console.log('Revalidate: No content found for uri: ' + uri);
+          return;
+        }
+        document = TextDocument.create(uri, 'yaml', 0, content);
+      }
+      const result = await this.languageService.doValidation(document, false);
+      return result;
+    });
+
+    /**
+     * Received request from the client that revalidation is needed.
+     */
+    this.connection.onRequest(RevalidateBySchemaRequest.type, async (params: { yaml: string; schema: unknown }) => {
+      const yamlName = Math.random().toString(36).substring(2) + '.yaml';
+      const document = TextDocument.create(yamlName, 'yaml', 0, params.yaml);
+      this.languageService.addSchema(yamlName, params.schema);
+      try {
+        const result = await this.languageService.doValidation(document, false);
+        return result;
+      } finally {
+        yamlDocumentsCache.delete(document);
+        this.languageService.deleteSchema(yamlName);
+      }
+    });
+
+    /**
+     * Received request from the client that do completion for expression.
+     */
+    this.connection.onRequest(
+      CompletionYamlRequest.type,
+      async (params: { yaml: string; position: TextDocumentPositionParams['position']; fileName: string }) => {
+        const { yaml, fileName, position } = params;
+        const document = TextDocument.create(fileName, 'yaml', 0, yaml);
+        try {
+          const result = await this.languageService.doComplete(document, position, false);
+          return result;
+        } finally {
+          yamlDocumentsCache.delete(document);
+        }
+      }
+    );
+
+    /**
+     * Received request from the client that do completion for expression.
+     */
+    this.connection.onRequest(
+      HoverYamlRequest.type,
+      async (params: { yaml: string; position: TextDocumentPositionParams['position']; fileName: string }) => {
+        const { yaml, fileName, position } = params;
+        const document = TextDocument.create(fileName, 'yaml', 0, yaml);
+        try {
+          const result = await this.languageService.doHoverDetail(document, position);
+          return result;
+        } finally {
+          yamlDocumentsCache.delete(document);
+        }
+      }
+    );
   }
 
   private registerSchemaModificationNotificationHandler(

src/languageserver/handlers/settingsHandlers.ts

@@ -3,7 +3,12 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 import { configure as configureHttpRequests, xhr } from 'request-light';
-import { Connection, DidChangeConfigurationNotification, DocumentFormattingRequest } from 'vscode-languageserver';
+import {
+  Connection,
+  DidChangeConfigurationNotification,
+  DocumentFormattingRequest,
+  DocumentSelector, // jigx
+} from 'vscode-languageserver';
 import { isRelativePath, relativeToAbsolutePath } from '../../languageservice/utils/paths';
 import { checkSchemaURI, JSON_SCHEMASTORE_URL, KUBERNETES_SCHEMA_URL } from '../../languageservice/utils/schemaUrls';
 import { LanguageService, LanguageSettings, SchemaPriority } from '../../languageservice/yamlLanguageService';
@@ -33,6 +38,23 @@ export class SettingsHandler {
     this.connection.onDidChangeConfiguration(() => this.pullConfiguration());
   }
 
+  private getDocumentSelectors(settings: Settings): DocumentSelector {
+    let docSelector: DocumentSelector = [
+      { language: 'yaml' },
+      { language: 'dockercompose' },
+      { language: 'github-actions-workflow' },
+      { pattern: '*.y(a)ml' },
+    ];
+    if (settings.yaml.extraLanguage) {
+      docSelector = docSelector.concat(
+        settings.yaml.extraLanguage.map((l) => {
+          return { language: l };
+        })
+      );
+    }
+    return docSelector;
+  }
+
   /**
    *  The server pull the 'yaml', 'http.proxy', 'http.proxyStrictSSL', '[yaml]' settings sections
    */
@@ -69,7 +91,7 @@ export class SettingsHandler {
         this.yamlSettings.yamlShouldValidate = settings.yaml.validate;
       }
       if (Object.prototype.hasOwnProperty.call(settings.yaml, 'hover')) {
-        this.yamlSettings.yamlShouldHover = settings.yaml.hover;
+        this.yamlSettings.yamlShouldHover = false; //settings.yaml.hover;
       }
       if (Object.prototype.hasOwnProperty.call(settings.yaml, 'completion')) {
         this.yamlSettings.yamlShouldCompletion = settings.yaml.completion;
@@ -115,6 +137,9 @@ export class SettingsHandler {
           this.yamlSettings.yamlFormatterSettings.enable = settings.yaml.format.enable;
         }
       }
+      if (settings.yaml.propTableStyle) {
+        this.yamlSettings.propTableStyle = settings.yaml.propTableStyle;
+      }
       this.yamlSettings.disableAdditionalProperties = settings.yaml.disableAdditionalProperties;
       this.yamlSettings.disableDefaultProperties = settings.yaml.disableDefaultProperties;
 
@@ -163,12 +188,7 @@ export class SettingsHandler {
       if (enableFormatter) {
         if (!this.yamlSettings.formatterRegistration) {
           this.yamlSettings.formatterRegistration = this.connection.client.register(DocumentFormattingRequest.type, {
-            documentSelector: [
-              { language: 'yaml' },
-              { language: 'dockercompose' },
-              { language: 'github-actions-workflow' },
-              { pattern: '*.y(a)ml' },
-            ],
+            documentSelector: this.getDocumentSelectors(settings),
           });
         }
       } else if (this.yamlSettings.formatterRegistration) {
@@ -260,6 +280,7 @@ export class SettingsHandler {
       customTags: this.yamlSettings.customTags,
       format: this.yamlSettings.yamlFormatterSettings.enable,
       indentation: this.yamlSettings.indentation,
+      propTableStyle: this.yamlSettings.propTableStyle,
       disableAdditionalProperties: this.yamlSettings.disableAdditionalProperties,
       disableDefaultProperties: this.yamlSettings.disableDefaultProperties,
       parentSkeletonSelectedFirst: this.yamlSettings.suggest.parentSkeletonSelectedFirst,

src/languageservice/jsonSchema.ts

@@ -3,7 +3,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { CompletionItemKind } from 'vscode-json-languageservice';
+import { CompletionItemKind, DiagnosticSeverity } from 'vscode-json-languageservice';
 import { SchemaVersions } from './yamlTypes';
 
 export type JSONSchemaRef = JSONSchema | boolean;
@@ -50,6 +50,7 @@ export interface JSONSchema {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   enum?: any[];
   format?: string;
+  inlineObject?: boolean;
 
   // schema draft 06
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -81,6 +82,7 @@ export interface JSONSchema {
 
   errorMessage?: string; // VSCode extension
   patternErrorMessage?: string; // VSCode extension
+  patterns?: Pattern[]; // VSCode extension
   deprecationMessage?: string; // VSCode extension
   enumDescriptions?: string[]; // VSCode extension
   markdownEnumDescriptions?: string[]; // VSCode extension
@@ -93,6 +95,12 @@ export interface JSONSchema {
   filePatternAssociation?: string; // extension for if condition to be able compare doc yaml uri with this file pattern association
 }
 
+export interface Pattern {
+  pattern: string;
+  message: string;
+  severity?: DiagnosticSeverity;
+}
+
 export interface JSONSchemaMap {
   [name: string]: JSONSchemaRef;
 }

src/languageservice/parser/ast-converter.ts

@@ -191,7 +191,7 @@ function toFixedOffsetLength(range: NodeRange, lineCounter: LineCounter): [numbe
   const result: [number, number] = [range[0], range[1] - range[0]];
   // -1 as range may include '\n'
   if (start.line !== end.line && (lineCounter.lineStarts.length !== end.line || end.col === 1)) {
-    result[1]--;
+    // result[1]--;
   }
 
   return result;