Merge branch 'master' into esm-and-umd-libs

apisim · web-flow · commit 81c26895c994 · 2020-09-09T19:41:54.000-05:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,7 +8,12 @@
 
 #### 0.10.0
 
-- Allows to declare a schema inside the yaml file through modeline `# yaml-language-server: $schema=<urlOfTheSchema>`
+- Allows to declare a schema inside the yaml file through modeline `# yaml-language-server: $schema=<urlOfTheSchema>` [#280](https://github.com/redhat-developer/yaml-language-server/pull/280)
+- Insert empty string instead of 'null' for string array completion [#277](https://github.com/redhat-developer/yaml-language-server/pull/277)
+- Handle workspace/workspaceFolders event for multi root workspaces [#281](https://github.com/redhat-developer/yaml-language-server/pull/281)
+- Provide default object as completion snippet [#291] https://github.com/redhat-developer/yaml-language-server/pull/291
+- Add validation of date and time formats [#292](https://github.com/redhat-developer/yaml-language-server/pull/292)
+- Fix document symbols computation if yaml has complex mappings [#293](https://github.com/redhat-developer/yaml-language-server/pull/293)
 
 #### 0.9.0
 
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "yaml-language-server",
   "description": "YAML language server",
-  "version": "0.9.0",
+  "version": "0.10.1",
   "author": "Gorkem Ercan (Red Hat)",
   "license": "MIT",
   "contributors": [
diff --git a/src/languageservice/parser/jsonParser07.ts b/src/languageservice/parser/jsonParser07.ts
@@ -205,7 +205,7 @@ export class ObjectASTNodeImpl extends ASTNodeImpl implements ObjectASTNode {
   }
 }
 
-export function asSchema(schema: JSONSchemaRef) {
+export function asSchema(schema: JSONSchemaRef): JSONSchema {
   if (isBoolean(schema)) {
     return schema ? {} : { not: {} };
   }
@@ -238,13 +238,13 @@ export interface ISchemaCollector {
 class SchemaCollector implements ISchemaCollector {
   schemas: IApplicableSchema[] = [];
   constructor(private focusOffset = -1, private exclude: ASTNode = null) {}
-  add(schema: IApplicableSchema) {
+  add(schema: IApplicableSchema): void {
     this.schemas.push(schema);
   }
-  merge(other: ISchemaCollector) {
+  merge(other: ISchemaCollector): void {
     this.schemas.push(...other.schemas);
   }
-  include(node: ASTNode) {
+  include(node: ASTNode): boolean {
     return (this.focusOffset === -1 || contains(node, this.focusOffset)) && node !== this.exclude;
   }
   newSub(): ISchemaCollector {
@@ -256,16 +256,20 @@ class NoOpSchemaCollector implements ISchemaCollector {
   private constructor() {
     // ignore
   }
-  get schemas() {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  get schemas(): any[] {
     return [];
   }
-  add(schema: IApplicableSchema) {
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  add(schema: IApplicableSchema): void {
     // ignore
   }
-  merge(other: ISchemaCollector) {
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  merge(other: ISchemaCollector): void {
     // ignore
   }
-  include(node: ASTNode) {
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  include(node: ASTNode): boolean {
     return true;
   }
   newSub(): ISchemaCollector {
@@ -383,7 +387,7 @@ export class ValidationResult {
   }
 }
 
-export function newJSONDocument(root: ASTNode, diagnostics: Diagnostic[] = []) {
+export function newJSONDocument(root: ASTNode, diagnostics: Diagnostic[] = []): JSONDocument {
   return new JSONDocument(root, diagnostics, []);
 }
 
@@ -468,7 +472,8 @@ function validate(
   validationResult: ValidationResult,
   matchingSchemas: ISchemaCollector,
   isKubernetes: boolean
-) {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+): any {
   if (!node || !matchingSchemas.include(node)) {
     return;
   }
@@ -481,10 +486,10 @@ function validate(
       _validateArrayNode(node, schema, validationResult, matchingSchemas);
       break;
     case 'string':
-      _validateStringNode(node, schema, validationResult, matchingSchemas);
+      _validateStringNode(node, schema, validationResult);
       break;
     case 'number':
-      _validateNumberNode(node, schema, validationResult, matchingSchemas);
+      _validateNumberNode(node, schema, validationResult);
       break;
     case 'property':
       return validate(node.valueNode, schema, validationResult, matchingSchemas, isKubernetes);
@@ -493,8 +498,8 @@ function validate(
 
   matchingSchemas.add({ node: node, schema: schema });
 
-  function _validateNode() {
-    function matchesType(type: string) {
+  function _validateNode(): void {
+    function matchesType(type: string): boolean {
       return node.type === type || (type === 'integer' && node.type === 'number' && node.isInteger);
     }
 
@@ -540,7 +545,7 @@ function validate(
       }
     }
 
-    const testAlternatives = (alternatives: JSONSchemaRef[], maxOneMatch: boolean) => {
+    const testAlternatives = (alternatives: JSONSchemaRef[], maxOneMatch: boolean): number => {
       const matches = [];
 
       // remember the best match that is used for error messages
@@ -592,7 +597,7 @@ function validate(
       testAlternatives(schema.oneOf, true);
     }
 
-    const testBranch = (schema: JSONSchemaRef) => {
+    const testBranch = (schema: JSONSchemaRef): void => {
       const subValidationResult = new ValidationResult(isKubernetes);
       const subMatchingSchemas = matchingSchemas.newSub();
 
@@ -604,7 +609,7 @@ function validate(
       matchingSchemas.merge(subMatchingSchemas);
     };
 
-    const testCondition = (ifSchema: JSONSchemaRef, thenSchema?: JSONSchemaRef, elseSchema?: JSONSchemaRef) => {
+    const testCondition = (ifSchema: JSONSchemaRef, thenSchema?: JSONSchemaRef, elseSchema?: JSONSchemaRef): void => {
       const subSchema = asSchema(ifSchema);
       const subValidationResult = new ValidationResult(isKubernetes);
       const subMatchingSchemas = matchingSchemas.newSub();
@@ -682,12 +687,7 @@ function validate(
     }
   }
 
-  function _validateNumberNode(
-    node: NumberASTNode,
-    schema: JSONSchema,
-    validationResult: ValidationResult,
-    matchingSchemas: ISchemaCollector
-  ): void {
+  function _validateNumberNode(node: NumberASTNode, schema: JSONSchema, validationResult: ValidationResult): void {
     const val = node.value;
 
     if (isNumber(schema.multipleOf)) {
@@ -748,12 +748,7 @@ function validate(
     }
   }
 
-  function _validateStringNode(
-    node: StringASTNode,
-    schema: JSONSchema,
-    validationResult: ValidationResult,
-    matchingSchemas: ISchemaCollector
-  ): void {
+  function _validateStringNode(node: StringASTNode, schema: JSONSchema, validationResult: ValidationResult): void {
     if (isNumber(schema.minLength) && node.value.length < schema.minLength) {
       validationResult.problems.push({
         location: { offset: node.offset, length: node.length },
@@ -992,7 +987,7 @@ function validate(
       }
     }
 
-    const propertyProcessed = (prop: string) => {
+    const propertyProcessed = (prop: string): void => {
       let index = unprocessedProperties.indexOf(prop);
       while (index >= 0) {
         unprocessedProperties.splice(index, 1);
@@ -1179,7 +1174,8 @@ function validate(
   }
 
   //Alternative comparison is specifically used by the kubernetes/openshift schema but may lead to better results then genericComparison depending on the schema
-  function alternativeComparison(subValidationResult, bestMatch, subSchema, subMatchingSchemas) {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  function alternativeComparison(subValidationResult, bestMatch, subSchema, subMatchingSchemas): any {
     const compareResult = subValidationResult.compareKubernetes(bestMatch.validationResult);
     if (compareResult > 0) {
       // our node is the best matching so far
@@ -1197,7 +1193,8 @@ function validate(
   }
 
   //genericComparison tries to find the best matching schema using a generic comparison
-  function genericComparison(maxOneMatch, subValidationResult, bestMatch, subSchema, subMatchingSchemas) {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  function genericComparison(maxOneMatch, subValidationResult, bestMatch, subSchema, subMatchingSchemas): any {
     if (!maxOneMatch && !subValidationResult.hasProblems() && !bestMatch.validationResult.hasProblems()) {
       // no errors, both are equally good matches
       bestMatch.matchingSchemas.merge(subMatchingSchemas);
diff --git a/src/languageservice/parser/recursivelyBuildAst.ts b/src/languageservice/parser/recursivelyBuildAst.ts
@@ -78,8 +78,6 @@ export default function recursivelyBuildAst(parent: ASTNode, node: Yaml.YAMLNode
       const instance = <Yaml.YAMLScalar>node;
       const type = Yaml.determineScalarType(instance);
 
-      // The name is set either by the sequence or the mapping case.
-      const name = null;
       const value = instance.value;
 
       //This is a patch for redirecting values with these strings to be boolean nodes because its not supported in the parser.
diff --git a/src/languageservice/parser/yamlParser07.ts b/src/languageservice/parser/yamlParser07.ts
@@ -17,7 +17,6 @@ import { getLineStartPositions } from '../utils/documentPositionCalculator';
 import { ASTNode } from '../jsonASTTypes';
 import { ErrorCode } from 'vscode-json-languageservice';
 
-const YAML_DIRECTIVE_PREFIX = '%';
 const YAML_COMMENT_PREFIX = '#';
 const YAML_DATA_INSTANCE_SEPARATOR = '---';
 
@@ -43,7 +42,8 @@ export class SingleYAMLDocument extends JSONDocument {
     this.lineComments = [];
   }
 
-  public getSchemas(schema, doc, node) {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
+  public getSchemas(schema: any, doc: any, node: any): any[] {
     const matchingSchemas = [];
     doc.validate(schema, matchingSchemas, node.start);
     return matchingSchemas;
@@ -114,17 +114,17 @@ export function parse(text: string, customTags = []): YAMLDocument {
   return new YAMLDocument(yamlDocs);
 }
 
-function parseLineComments(text: string, yamlDocs: SingleYAMLDocument[]) {
+function parseLineComments(text: string, yamlDocs: SingleYAMLDocument[]): void {
   const lines = text.split(/[\r\n]+/g);
   let yamlDocCount = 0;
+  let firstSeparatorFound = false;
   lines.forEach((line) => {
-    if (line.startsWith(YAML_DIRECTIVE_PREFIX) && yamlDocCount === 0) {
-      yamlDocCount--;
-    }
-    if (line === YAML_DATA_INSTANCE_SEPARATOR) {
+    if (line === YAML_DATA_INSTANCE_SEPARATOR && firstSeparatorFound) {
       yamlDocCount++;
+    } else if (line === YAML_DATA_INSTANCE_SEPARATOR) {
+      firstSeparatorFound = true;
     }
-    if (line.startsWith(YAML_COMMENT_PREFIX)) {
+    if (line.startsWith(YAML_COMMENT_PREFIX) && yamlDocCount < yamlDocs.length) {
       yamlDocs[yamlDocCount].lineComments.push(line);
     }
   });
diff --git a/src/languageservice/services/yamlSchemaService.ts b/src/languageservice/services/yamlSchemaService.ts
@@ -372,7 +372,7 @@ export class YAMLSchemaService extends JSONSchemaService {
         if (schemaMatchs !== null && schemaMatchs.length >= 1) {
           if (schemaMatchs.length >= 2) {
             console.log(
-              'Several $schema attributes has been found on the yaml-language-server modeline. The first one will be picked.'
+              'Several $schema attributes have been found on the yaml-language-server modeline. The first one will be picked.'
             );
           }
           return schemaMatchs[0].substring('$schema='.length);
diff --git a/src/languageservice/yamlLanguageService.ts b/src/languageservice/yamlLanguageService.ts
@@ -81,6 +81,7 @@ export interface Thenable<R> {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   then<TResult>(
     onfulfilled?: (value: R) => TResult | Thenable<TResult>,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     onrejected?: (reason: any) => TResult | Thenable<TResult>
   ): Thenable<TResult>;
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
diff --git a/src/server.ts b/src/server.ts
@@ -21,7 +21,7 @@ import {
   DocumentFormattingRequest,
 } from 'vscode-languageserver';
 
-import { xhr, XHRResponse, configure as configureHttpRequests } from 'request-light';
+import { xhr, configure as configureHttpRequests } from 'request-light';
 import * as URL from 'url';
 import { removeDuplicatesObj } from './languageservice/utils/arrUtils';
 import {
@@ -155,7 +155,7 @@ const checkSchemaURI = (uri: string): string => {
  * AND the schema store setting is enabled. If the schema store setting
  * is not enabled we need to clear the schemas.
  */
-function setSchemaStoreSettingsIfNotSet() {
+function setSchemaStoreSettingsIfNotSet(): void {
   const schemaStoreIsSet = schemaStoreSettings.length !== 0;
 
   if (schemaStoreEnabled && !schemaStoreIsSet) {
@@ -164,7 +164,7 @@ function setSchemaStoreSettingsIfNotSet() {
         schemaStoreSettings = schemaStore.schemas;
         updateConfiguration();
       })
-      .catch((error: XHRResponse) => {
+      .catch(() => {
         // ignore
       });
   } else if (!schemaStoreEnabled) {
@@ -176,7 +176,8 @@ function setSchemaStoreSettingsIfNotSet() {
 /**
  * When the schema store is enabled, download and store YAML schema associations
  */
-function getSchemaStoreMatchingSchemas() {
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function getSchemaStoreMatchingSchemas(): Promise<{ schemas: any[] }> {
   return xhr({ url: JSON_SCHEMASTORE_URL }).then((response) => {
     const languageSettings = {
       schemas: [],
@@ -208,9 +209,9 @@ function getSchemaStoreMatchingSchemas() {
 
 /**
  * Called when server settings or schema associations are changed
- * Re-creates schema associations and revalidates any open YAML files
+ * Re-creates schema associations and re-validates any open YAML files
  */
-function updateConfiguration() {
+function updateConfiguration(): void {
   let languageSettings: LanguageSettings = {
     validate: yamlShouldValidate,
     hover: yamlShouldHover,
@@ -267,7 +268,8 @@ function updateConfiguration() {
  * @param schema schema id
  * @param languageSettings current server settings
  */
-function configureSchemas(uri: string, fileMatch: string[], schema: any, languageSettings: LanguageSettings) {
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function configureSchemas(uri: string, fileMatch: string[], schema: any, languageSettings: LanguageSettings): LanguageSettings {
   uri = checkSchemaURI(uri);
 
   if (schema === null) {
@@ -287,7 +289,7 @@ function configureSchemas(uri: string, fileMatch: string[], schema: any, languag
   return languageSettings;
 }
 
-function isKubernetes(textDocument: TextDocument) {
+function isKubernetes(textDocument: TextDocument): boolean {
   for (const path in specificValidatorPaths) {
     const globPath = specificValidatorPaths[path];
     const fpa = new FilePatternAssociation(globPath);
@@ -339,7 +341,7 @@ function validateTextDocument(textDocument: TextDocument): void {
         diagnostics: removeDuplicatesObj(diagnostics),
       });
     },
-    function (error) {
+    function () {
       // ignore
     }
   );
@@ -547,7 +549,7 @@ documents.onDidClose((event) => {
 
 /**
  * Called when a monitored file is changed in an editor
- * Revalidates the entire document
+ * Re-validates the entire document
  */
 connection.onDidChangeWatchedFiles((change) => {
   let hasChanges = false;
diff --git a/test/schemaValidation.test.ts b/test/schemaValidation.test.ts
@@ -777,4 +777,42 @@ suite('Validation Tests', () => {
         .then(done, done);
     });
   });
+
+  describe('Multi Document schema validation tests', () => {
+    it('Document does not error when --- is present with schema', (done) => {
+      languageService.addSchema(SCHEMA_ID, {
+        type: 'object',
+        properties: {
+          cwd: {
+            type: 'string',
+          },
+        },
+      });
+      const content = '---\n# this is a test\ncwd: this';
+      const validator = parseSetup(content);
+      validator
+        .then(function (result) {
+          assert.equal(result.length, 0);
+        })
+        .then(done, done);
+    });
+
+    it('Multi Document does not error when --- is present with schema', (done) => {
+      languageService.addSchema(SCHEMA_ID, {
+        type: 'object',
+        properties: {
+          cwd: {
+            type: 'string',
+          },
+        },
+      });
+      const content = '---\n# this is a test\ncwd: this...\n---\n# second comment\ncwd: hello\n...';
+      const validator = parseSetup(content);
+      validator
+        .then(function (result) {
+          assert.equal(result.length, 0);
+        })
+        .then(done, done);
+    });
+  });
 });
diff --git a/test/yamlParser.test.ts b/test/yamlParser.test.ts

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "yaml-language-server",`
`3`	`3`	`"description": "YAML language server",`
`4`		`- "version": "0.9.0",`
	`4`	`+ "version": "0.10.1",`
`5`	`5`	`"author": "Gorkem Ercan (Red Hat)",`
`6`	`6`	`"license": "MIT",`
`7`	`7`	`"contributors": [`
Original file line number	Diff line number	Diff line change
`@@ -372,7 +372,7 @@ export class YAMLSchemaService extends JSONSchemaService {`
`372`	`372`	`if (schemaMatchs !== null && schemaMatchs.length >= 1) {`
`373`	`373`	`if (schemaMatchs.length >= 2) {`
`374`	`374`	`console.log(`
`375`		`- 'Several $schema attributes has been found on the yaml-language-server modeline. The first one will be picked.'`
	`375`	`+ 'Several $schema attributes have been found on the yaml-language-server modeline. The first one will be picked.'`
`376`	`376`	`);`
`377`	`377`	`}`
`378`	`378`	`return schemaMatchs[0].substring('$schema='.length);`