chore(dev-deps): update typescript and related deps (#165)

Author: bd82

.eslintrc.js

@@ -13,12 +13,18 @@ module.exports = {
       "error",
       { functions: false, classes: false },
     ],
-    // We actually need to ignore multiple things the TypeScript Compiler cannot
-    // seem to figure out by itself.
-    "@typescript-eslint/ban-ts-ignore": "off",
-    // This rule replaces `ban-ts-ignore` but we need to upgrade to latest major version of eslint+typescript
-    // to have full configuration options for it.
-    "@typescript-eslint/ban-ts-comment": "off",
+    "@typescript-eslint/ban-ts-comment": [
+      "error",
+      {
+        // We only allow ts-expect-error comments to enforce removal
+        // of outdated suppression comments when the underlying issue has been resolved.
+        // https://devblogs.microsoft.com/typescript/announcing-typescript-3-9/#what-about-ts-ignore
+        "ts-expect-error": "allow-with-description",
+        "ts-ignore": true,
+        "ts-nocheck": true,
+        "ts-check": true,
+      },
+    ],
     "eslint-comments/disable-enable-pair": ["error", { allowWholeFile: true }],
   },
   ignorePatterns: ["**/*.js"],

package.json

@@ -39,9 +39,9 @@
     "@types/fs-extra": "9.0.1",
     "chai": "4.2.0",
     "deep-equal-in-any-order": "^1.0.24",
-    "eslint": "6.8.0",
-    "@typescript-eslint/parser": "2.34.0",
-    "@typescript-eslint/eslint-plugin": "2.34.0",
+    "eslint": "7.1.0",
+    "@typescript-eslint/parser": "3.1.0",
+    "@typescript-eslint/eslint-plugin": "3.1.0",
     "eslint-config-prettier": "6.11.0",
     "eslint-plugin-eslint-comments": "3.1.2",
     "husky": "4.2.5",
@@ -52,7 +52,7 @@
     "nyc": "15.1.0",
     "prettier": "2.0.5",
     "source-map-support": "0.5.19",
-    "typescript": "3.8.3",
+    "typescript": "3.9.3",
     "cz-conventional-changelog": "3.2.0",
     "@commitlint/cli": "8.3.5",
     "@commitlint/config-conventional": "8.3.4",

packages/logic-utils/src/utils/documentation.ts

@@ -186,8 +186,7 @@ function replace(
   matcher: RegExp,
   replacement: string | ReplaceFunction
 ): string {
-  // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
-  //@ts-ignore - 'replace' is defined with 2 overloads instead of a union type in the definitions file
+  // @ts-expect-error - 'replace' is defined with 2 overloads instead of a union type in the definitions file
   return string.replace(matcher, replacement);
 }
 

packages/semantic-model/.eslintrc.js

@@ -0,0 +1,5 @@
+module.exports = {
+  // Fixing and or ignoring issues in generated files is not scalable
+  // unless one also implemented the generator.
+  ignorePatterns: ["src/api-json.d.ts"],
+};

packages/semantic-model/package.json

@@ -16,6 +16,7 @@
   "dependencies": {
     "@ui5-language-assistant/semantic-model-types": "^1.3.0",
     "ajv": "6.12.2",
+    "fs-extra": "9.0.1",
     "deep-freeze-strict": "1.1.1",
     "lodash": "4.17.15"
   },
@@ -32,7 +33,7 @@
     "lint": "eslint . --ext .ts --max-warnings=0 --ignore-path=../../.gitignore",
     "test": "mocha",
     "coverage": "nyc mocha",
-    "generate-json-api": "json2ts -i ./resources/sap-ui-library-api.json -o ./src/api-json.d.ts --no-unknownAny --bannerComment \"/* eslint-disable @typescript-eslint/no-explicit-any */ /* This file is automatically generated. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file (sap-ui-library-api.json) and run generate-json-api from the package.json to regenerate this file. */\" && prettier --write ./src/api-json.d.ts"
+    "generate-json-api": "json2ts -i ./resources/sap-ui-library-api.json -o ./src/api-json.d.ts --no-unknownAny --bannerComment \"/* This file is automatically generated. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file (sap-ui-library-api.json) and run generate-json-api from the package.json to regenerate this file. */\" && prettier --write ./src/api-json.d.ts"
   },
   "publishConfig": {
     "access": "public"

packages/semantic-model/src/api-json.d.ts

@@ -1,4 +1,4 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */ /* This file is automatically generated. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file (sap-ui-library-api.json) and run generate-json-api from the package.json to regenerate this file. */
+/* This file is automatically generated. DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file (sap-ui-library-api.json) and run generate-json-api from the package.json to regenerate this file. */
 
 export type LibraryVersion = string;
 export type ConcreteSymbol =

packages/semantic-model/src/validate.ts

@@ -1,9 +1,17 @@
-import Ajv, { ValidateFunction } from "ajv";
+import { ValidateFunction } from "ajv";
+import Ajv from "ajv";
+import { readJsonSync } from "fs-extra";
+import { isPlainObject, isArray } from "lodash";
+import * as schema from "@ui5-language-assistant/semantic-model/resources/sap-ui-library-api.json";
 import { Json } from "../api";
 import { SchemaForApiJsonFiles } from "./api-json";
-import * as schema from "@ui5-language-assistant/semantic-model/resources/sap-ui-library-api.json";
-import * as jsonDraft06Schema from "ajv/lib/refs/json-schema-draft-06.json";
-import { isPlainObject, isArray } from "lodash";
+
+// https://github.com/microsoft/TypeScript/issues/38540
+// TODO: revert back to: `import * as jsonDraft06Schema from "ajv/lib/refs/json-schema-draft-06.json"`
+//       once TypeScript 3.9.5 is released.
+const jsonDraft06Schema = readJsonSync(
+  require.resolve("ajv/lib/refs/json-schema-draft-06.json")
+);
 
 const validate = createSchemaValidator();
 

packages/semantic-model/test/utils-spec.ts

@@ -0,0 +1,27 @@
+import { expect } from "chai";
+import {
+  expectExists,
+  generateModel,
+} from "@ui5-language-assistant/test-utils";
+import { UI5SemanticModel } from "@ui5-language-assistant/semantic-model-types";
+
+import { findSymbol } from "../src/api";
+
+describe("The semantic model utils", () => {
+  let model: UI5SemanticModel;
+
+  before(async () => {
+    model = await generateModel({ version: "1.74.0" });
+  });
+
+  context("findSymbols", () => {
+    it("can locate a UI5 symbol in the model by FQN", () => {
+      const button = findSymbol(model, "sap.m.Button");
+      expectExists(button, "find symbol failed");
+      expect(button.kind).to.eql("UI5Class");
+      // cannot use FQN utility here due to cyclic packages deps
+      // TODO: fix cyclic packages deps (test-utils and semantic-model)
+      expect(button.name).to.eql("Button");
+    });
+  });
+});

packages/xml-views-validation/src/validators/document/non-unique-id.ts

@@ -44,9 +44,9 @@ function buildIssuesForSingleID(
       );
 
       return {
-        kind: "NonUniqueIDIssue" as "NonUniqueIDIssue",
+        kind: "NonUniqueIDIssue" as const,
         message: getMessage(NON_UNIQUE_ID, id),
-        severity: "error" as "error",
+        severity: "error" as const,
         offsetRange: {
           start: currDupIdValToken.startOffset,
           end: currDupIdValToken.endOffset,
@@ -84,10 +84,10 @@ class IdsCollectorVisitor implements XMLAstVisitor {
       !isNoneUI5id(attrib)
     ) {
       if (this.idsToXMLElements[attrib.value] === undefined) {
-        // @ts-ignore - TSC does not understand: `attrib.syntax.value !== undefined` is a type guard
+        // @ts-expect-error - TSC does not understand: `attrib.syntax.value !== undefined` is a type guard
         this.idsToXMLElements[attrib.value] = [attrib];
       } else {
-        // @ts-ignore - TSC does not understand: `attrib.syntax.value !== undefined` is a type guard
+        // @ts-expect-error - TSC does not understand: `attrib.syntax.value !== undefined` is a type guard
         this.idsToXMLElements[attrib.value].push(attrib);
       }
     }

packages/xml-views-validation/src/validators/elements/unknown-tag-name.ts

@@ -58,12 +58,12 @@ function validateTagWithNamespace(
   model: UI5SemanticModel
 ): UnknownTagNameIssue[] {
   const issueDefaults = {
-    kind: "UnknownTagName" as "UnknownTagName",
+    kind: "UnknownTagName" as const,
     offsetRange: {
       start: xmlElement.syntax.openName.startOffset,
       end: xmlElement.syntax.openName.endOffset,
     },
-    severity: "error" as "error",
+    severity: "error" as const,
   };
 
   // To avoid false positives, we assume unrecognized namespaces are user-defined so we don't validate tags in them
@@ -124,12 +124,12 @@ function validateTagWithoutNamespace(
   model: UI5SemanticModel
 ): UnknownTagNameIssue[] {
   const issueDefaults = {
-    kind: "UnknownTagName" as "UnknownTagName",
+    kind: "UnknownTagName" as const,
     offsetRange: {
       start: xmlElement.syntax.openName.startOffset,
       end: xmlElement.syntax.openName.endOffset,
     },
-    severity: "error" as "error",
+    severity: "error" as const,
   };
 
   // If the default namespace is defined and it's not a known namespace, don't validate