Merge branch 'main' into dependabot/npm_and_yarn/babel/traverse-7.23.2

CHANGELOG.md

@@ -1,3 +1,20 @@
+### 1.15.0
+- Fix: some small type issues [#918](https://github.com/redhat-developer/yaml-language-server/pull/918)
+- Add: volar-service-yaml to clients [#920](https://github.com/redhat-developer/yaml-language-server/pull/920)
+- Fix: Remove ide-yaml from known clients [#921](https://github.com/redhat-developer/yaml-language-server/pull/921)
+- Fix: schema loading performance [#923](https://github.com/redhat-developer/yaml-language-server/pull/923)
+- Fix: undefined error in mergingResult.problemArgs [#924](https://github.com/redhat-developer/yaml-language-server/pull/924)
+- Add: unify string insert text for array and property [#934](https://github.com/redhat-developer/yaml-language-server/pull/934)
+- Add: Improve some special cases for selection ranges [#939](https://github.com/redhat-developer/yaml-language-server/pull/939)
+- Fix: show all enums on hover [#942](https://github.com/redhat-developer/yaml-language-server/pull/942)
+- Fix: update README syntax highlighting [#945](https://github.com/redhat-developer/yaml-language-server/pull/945)
+- Fix: render examples as yaml on hover [#947](https://github.com/redhat-developer/yaml-language-server/pull/947)
+- Fix: snippets in additionalProperties [#951](https://github.com/redhat-developer/yaml-language-server/pull/951)
+- Fix: crash when url is undefined [#954](https://github.com/redhat-developer/yaml-language-server/pull/954)
+- Fix: Add null check for customTags [#955](https://github.com/redhat-developer/yaml-language-server/pull/955)
+
+Thanks to [Remco Haszing](https://github.com/remcohaszing), [Petr Spacek](https://github.com/p-spacek), [Tony](https://github.com/Legend-Master), [Gustav Eikaas](https://github.com/GustavEikaas), [Skip Baney](https://github.com/twelvelabs) and [Pierre Prinetti](https://github.com/pierreprinetti) for your contributions.
+
 ### 1.14.0
 - Fix: Request textDocument/hover failed with message: Invalid regular expression: /(?s).*/: Invalid group [#874](https://github.com/redhat-developer/yaml-language-server/issues/874)
 - Fix: nested anyof const [#888](https://github.com/redhat-developer/yaml-language-server/pull/888)

package.json

@@ -29,15 +29,13 @@
     "type": "git",
     "url": "https://github.com/redhat-developer/yaml-language-server.git"
   },
-  "optionalDependencies": {
-    "prettier": "2.8.7"
-  },
   "dependencies": {
     "ajv": "^8.11.0",
     "lodash": "4.17.21",
+    "prettier": "^3.0.0",
     "request-light": "^0.5.7",
     "vscode-json-languageservice": "4.1.8",
-    "vscode-languageserver": "^7.0.0",
+    "vscode-languageserver": "^9.0.0",
     "vscode-languageserver-textdocument": "^1.0.1",
     "vscode-languageserver-types": "^3.16.0",
     "vscode-nls": "^5.0.0",
@@ -49,17 +47,16 @@
     "@types/chai": "^4.2.12",
     "@types/mocha": "8.2.2",
     "@types/node": "16.x",
-    "@types/prettier": "2.7.2",
     "@types/sinon": "^9.0.5",
     "@types/sinon-chai": "^3.2.5",
     "@typescript-eslint/eslint-plugin": "^5.38.0",
     "@typescript-eslint/parser": "^5.38.0",
     "chai": "^4.2.0",
     "coveralls": "3.1.1",
     "eslint": "^8.24.0",
-    "eslint-config-prettier": "^8.5.0",
+    "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-prettier": "^5.0.0",
     "http-proxy-agent": "^5.0.0",
     "https-proxy-agent": "^5.0.0",
     "mocha": "9.2.2",

src/languageserver/handlers/languageHandlers.ts

@@ -114,7 +114,7 @@ export class LanguageHandlers {
    * Called when the formatter is invoked
    * Returns the formatted document content using prettier
    */
-  formatterHandler(formatParams: DocumentFormattingParams): TextEdit[] {
+  formatterHandler(formatParams: DocumentFormattingParams): Promise<TextEdit[]> {
     const document = this.yamlSettings.documents.get(formatParams.textDocument.uri);
 
     if (!document) {

src/languageserver/handlers/requestHandlers.ts

@@ -14,7 +14,10 @@ import { SchemaModificationNotification } from '../../requestTypes';
 
 export class RequestHandlers {
   private languageService: LanguageService;
-  constructor(private readonly connection: Connection, languageService: LanguageService) {
+  constructor(
+    private readonly connection: Connection,
+    languageService: LanguageService
+  ) {
     this.languageService = languageService;
   }
 

src/languageserver/handlers/settingsHandlers.ts

@@ -81,7 +81,7 @@ export class SettingsHandler {
 
       if (settings.yaml.schemaStore) {
         this.yamlSettings.schemaStoreEnabled = settings.yaml.schemaStore.enable;
-        if (settings.yaml.schemaStore.url.length !== 0) {
+        if (settings.yaml.schemaStore.url?.length !== 0) {
           this.yamlSettings.schemaStoreUrl = settings.yaml.schemaStore.url;
         }
       }
@@ -180,7 +180,7 @@ export class SettingsHandler {
   private async setSchemaStoreSettingsIfNotSet(): Promise<void> {
     const schemaStoreIsSet = this.yamlSettings.schemaStoreSettings.length !== 0;
     let schemaStoreUrl = '';
-    if (this.yamlSettings.schemaStoreUrl.length !== 0) {
+    if (this.yamlSettings.schemaStoreUrl?.length !== 0) {
       schemaStoreUrl = this.yamlSettings.schemaStoreUrl;
     } else {
       schemaStoreUrl = JSON_SCHEMASTORE_URL;

src/languageserver/handlers/validationHandlers.ts

@@ -14,7 +14,11 @@ export class ValidationHandler {
   private languageService: LanguageService;
   private yamlSettings: SettingsState;
 
-  constructor(private readonly connection: Connection, languageService: LanguageService, yamlSettings: SettingsState) {
+  constructor(
+    private readonly connection: Connection,
+    languageService: LanguageService,
+    yamlSettings: SettingsState
+  ) {
     this.languageService = languageService;
     this.yamlSettings = yamlSettings;
 

src/languageserver/handlers/workspaceHandlers.ts

@@ -7,7 +7,10 @@ import { ExecuteCommandParams, Connection } from 'vscode-languageserver';
 import { CommandExecutor } from '../commandExecutor';
 
 export class WorkspaceHandlers {
-  constructor(private readonly connection: Connection, private readonly commandExecutor: CommandExecutor) {}
+  constructor(
+    private readonly connection: Connection,
+    private readonly commandExecutor: CommandExecutor
+  ) {}
 
   registerHandlers(): void {
     this.connection.onExecuteCommand((params) => this.executeCommand(params));

src/languageservice/parser/jsonParser07.ts

@@ -286,7 +286,10 @@ export interface ISchemaCollector {
 
 class SchemaCollector implements ISchemaCollector {
   schemas: IApplicableSchema[] = [];
-  constructor(private focusOffset = -1, private exclude: ASTNode = null) {}
+  constructor(
+    private focusOffset = -1,
+    private exclude: ASTNode = null
+  ) {}
   add(schema: IApplicableSchema): void {
     this.schemas.push(schema);
   }
@@ -888,6 +891,7 @@ function validate(
             ),
           source: getSchemaSource(schema, originalSchema),
           schemaUri: getSchemaUri(schema, originalSchema),
+          data: { values: schema.enum },
         });
       }
     }
@@ -907,6 +911,7 @@ function validate(
           source: getSchemaSource(schema, originalSchema),
           schemaUri: getSchemaUri(schema, originalSchema),
           problemArgs: [JSON.stringify(schema.const)],
+          data: { values: [schema.const] },
         });
         validationResult.enumValueMatch = false;
       } else {
@@ -1385,6 +1390,7 @@ function validate(
                 length: propertyNode.keyNode.length,
               },
               severity: DiagnosticSeverity.Warning,
+              code: ErrorCode.PropertyExpected,
               message: schema.errorMessage || localize('DisallowedExtraPropWarning', MSG_PROPERTY_NOT_ALLOWED, propertyName),
               source: getSchemaSource(schema, originalSchema),
               schemaUri: getSchemaUri(schema, originalSchema),

src/languageservice/services/documentSymbols.ts

@@ -17,7 +17,10 @@ import { convertErrorToTelemetryMsg } from '../utils/objects';
 export class YAMLDocumentSymbols {
   private jsonDocumentSymbols;
 
-  constructor(schemaService: YAMLSchemaService, private readonly telemetry?: Telemetry) {
+  constructor(
+    schemaService: YAMLSchemaService,
+    private readonly telemetry?: Telemetry
+  ) {
     this.jsonDocumentSymbols = new JSONDocumentSymbols(schemaService);
 
     // override 'getKeyLabel' to handle complex mapping

src/languageservice/services/yamlCodeActions.ts

@@ -28,9 +28,12 @@ import { FlowStyleRewriter } from '../utils/flow-style-rewriter';
 import { ASTNode } from '../jsonASTTypes';
 import * as _ from 'lodash';
 import { SourceToken } from 'yaml/dist/parse/cst';
+import { ErrorCode } from 'vscode-json-languageservice';
 
 interface YamlDiagnosticData {
   schemaUri: string[];
+  values?: string[];
+  properties?: string[];
 }
 export class YamlCodeActions {
   private indentation = '  ';
@@ -54,6 +57,7 @@ export class YamlCodeActions {
     result.push(...this.getUnusedAnchorsDelete(params.context.diagnostics, document));
     result.push(...this.getConvertToBlockStyleActions(params.context.diagnostics, document));
     result.push(...this.getKeyOrderActions(params.context.diagnostics, document));
+    result.push(...this.getQuickFixForPropertyOrValueMismatch(params.context.diagnostics, document));
 
     return result;
   }
@@ -221,7 +225,7 @@ export class YamlCodeActions {
     const results: CodeAction[] = [];
     for (const diagnostic of diagnostics) {
       if (diagnostic.code === 'flowMap' || diagnostic.code === 'flowSeq') {
-        const node = getNodeforDiagnostic(document, diagnostic);
+        const node = getNodeForDiagnostic(document, diagnostic);
         if (isMap(node.internalNode) || isSeq(node.internalNode)) {
           const blockTypeDescription = isMap(node.internalNode) ? 'map' : 'sequence';
           const rewriter = new FlowStyleRewriter(this.indentation);
@@ -242,7 +246,7 @@ export class YamlCodeActions {
     const results: CodeAction[] = [];
     for (const diagnostic of diagnostics) {
       if (diagnostic?.code === 'mapKeyOrder') {
-        let node = getNodeforDiagnostic(document, diagnostic);
+        let node = getNodeForDiagnostic(document, diagnostic);
         while (node && node.type !== 'object') {
           node = node.parent;
         }
@@ -292,8 +296,8 @@ export class YamlCodeActions {
                   item.value.end.splice(newLineIndex, 1);
                 }
               } else if (item.value?.type === 'block-scalar') {
-                const nwline = item.value.props.find((p) => p.type === 'newline');
-                if (!nwline) {
+                const newline = item.value.props.find((p) => p.type === 'newline');
+                if (!newline) {
                   item.value.props.push({ type: 'newline', indent: 0, offset: item.value.offset, source: '\n' } as SourceToken);
                 }
               }
@@ -312,9 +316,52 @@ export class YamlCodeActions {
     }
     return results;
   }
+
+  /**
+   * Check if diagnostic contains info for quick fix
+   * Supports Enum/Const/Property mismatch
+   */
+  private getPossibleQuickFixValues(diagnostic: Diagnostic): string[] | undefined {
+    if (typeof diagnostic.data !== 'object') {
+      return;
+    }
+    if (
+      diagnostic.code === ErrorCode.EnumValueMismatch &&
+      'values' in diagnostic.data &&
+      Array.isArray((diagnostic.data as YamlDiagnosticData).values)
+    ) {
+      return (diagnostic.data as YamlDiagnosticData).values;
+    } else if (
+      diagnostic.code === ErrorCode.PropertyExpected &&
+      'properties' in diagnostic.data &&
+      Array.isArray((diagnostic.data as YamlDiagnosticData).properties)
+    ) {
+      return (diagnostic.data as YamlDiagnosticData).properties;
+    }
+  }
+
+  private getQuickFixForPropertyOrValueMismatch(diagnostics: Diagnostic[], document: TextDocument): CodeAction[] {
+    const results: CodeAction[] = [];
+    for (const diagnostic of diagnostics) {
+      const values = this.getPossibleQuickFixValues(diagnostic);
+      if (!values?.length) {
+        continue;
+      }
+      for (const value of values) {
+        results.push(
+          CodeAction.create(
+            value,
+            createWorkspaceEdit(document.uri, [TextEdit.replace(diagnostic.range, value)]),
+            CodeActionKind.QuickFix
+          )
+        );
+      }
+    }
+    return results;
+  }
 }
 
-function getNodeforDiagnostic(document: TextDocument, diagnostic: Diagnostic): ASTNode {
+function getNodeForDiagnostic(document: TextDocument, diagnostic: Diagnostic): ASTNode {
   const yamlDocuments = yamlDocumentsCache.getYamlDocument(document);
   const startOffset = document.offsetAt(diagnostic.range.start);
   const yamlDoc = matchOffsetToDocument(startOffset, yamlDocuments);

src/languageservice/services/yamlCodeLens.ts

@@ -15,7 +15,10 @@ import { convertErrorToTelemetryMsg } from '../utils/objects';
 import { getSchemaTitle } from '../utils/schemaUtils';
 
 export class YamlCodeLens {
-  constructor(private schemaService: YAMLSchemaService, private readonly telemetry?: Telemetry) {}
+  constructor(
+    private schemaService: YAMLSchemaService,
+    private readonly telemetry?: Telemetry
+  ) {}
 
   async getCodeLens(document: TextDocument): Promise<CodeLens[]> {
     const result = [];

src/languageservice/services/yamlCompletion.ts

@@ -293,7 +293,7 @@ export class YamlCompletion {
       proposed,
     };
 
-    if (this.customTags.length > 0) {
+    if (this.customTags && this.customTags.length > 0) {
       this.getCustomTagValueCompletions(collector);
     }
 
@@ -925,7 +925,8 @@ export class YamlCompletion {
             if (propertySchema) {
               this.addSchemaValueCompletions(propertySchema, separatorAfter, collector, types, 'value');
             }
-          } else if (s.schema.additionalProperties) {
+          }
+          if (s.schema.additionalProperties) {
             this.addSchemaValueCompletions(s.schema.additionalProperties, separatorAfter, collector, types, 'value');
           }
         }
@@ -1205,7 +1206,7 @@ export class YamlCompletion {
         insertText = `\${${insertIndex++}:0}`;
         break;
       case 'string':
-        insertText = `\${${insertIndex++}:""}`;
+        insertText = `\${${insertIndex++}}`;
         break;
       case 'object':
         {

src/languageservice/services/yamlFormatter.ts

@@ -6,9 +6,8 @@
 
 import { Range, Position, TextEdit, FormattingOptions } from 'vscode-languageserver-types';
 import { CustomFormatterOptions, LanguageSettings } from '../yamlLanguageService';
-import * as prettier from 'prettier';
-import { Options } from 'prettier';
-import * as parser from 'prettier/parser-yaml';
+import { format, Options } from 'prettier';
+import * as parser from 'prettier/plugins/yaml';
 import { TextDocument } from 'vscode-languageserver-textdocument';
 
 export class YAMLFormatter {
@@ -20,7 +19,10 @@ export class YAMLFormatter {
     }
   }
 
-  public format(document: TextDocument, options: Partial<FormattingOptions> & CustomFormatterOptions = {}): TextEdit[] {
+  public async format(
+    document: TextDocument,
+    options: Partial<FormattingOptions> & CustomFormatterOptions = {}
+  ): Promise<TextEdit[]> {
     if (!this.formatterEnabled) {
       return [];
     }
@@ -43,7 +45,7 @@ export class YAMLFormatter {
         printWidth: options.printWidth,
       };
 
-      const formatted = prettier.format(text, prettierOptions);
+      const formatted = await format(text, prettierOptions);
 
       return [TextEdit.replace(Range.create(Position.create(0, 0), document.positionAt(text.length)), formatted)];
     } catch (error) {

src/languageservice/services/yamlHover.ts

@@ -26,7 +26,10 @@ export class YAMLHover {
   private indentation: string;
   private schemaService: YAMLSchemaService;
 
-  constructor(schemaService: YAMLSchemaService, private readonly telemetry?: Telemetry) {
+  constructor(
+    schemaService: YAMLSchemaService,
+    private readonly telemetry?: Telemetry
+  ) {
     this.shouldHover = true;
     this.schemaService = schemaService;
   }