Enable eslint strict type checks (#1561)

ansible · Oct 9, 2024 · c1671de · c1671de
1 parent 6e92107
commit c1671de
Show file tree

Hide file tree

Showing 52 changed files with 195 additions and 153 deletions.
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -20,7 +20,7 @@ export default tseslint.config(
   {
     extends: [
       eslint.configs.recommended,
-      ...tseslint.configs.recommended, // TODO: switch to strictTypeChecked
+      ...tseslint.configs.strictTypeChecked,
       prettierRecommendedConfig,
     ],
     files: [
@@ -48,16 +48,37 @@ export default tseslint.config(
     },
     rules: {
       eqeqeq: ["error", "smart"],
+      // Needed for tseslint.configs.strictTypeChecked
       "@typescript-eslint/no-namespace": "error",
       "@typescript-eslint/no-non-null-assertion": "error",
-      "@typescript-eslint/no-unused-vars": "error",
+      "@typescript-eslint/no-unsafe-member-access": "off",
+      "@typescript-eslint/no-unnecessary-condition": "off",
+      "@typescript-eslint/use-unknown-in-catch-callback-variable": "off",
+      "@typescript-eslint/no-unsafe-argument": "off",
+      "@typescript-eslint/prefer-promise-reject-errors": "off",
+      "@typescript-eslint/no-unsafe-assignment": "off",
+      "@typescript-eslint/no-base-to-string": "off",
+      "@typescript-eslint/no-unsafe-return": "off",
+      "@typescript-eslint/no-redundant-type-constituents": "off",
+      "@typescript-eslint/no-confusing-void-expression": "off",
+      "@typescript-eslint/no-unused-vars": "warn",
+      "@typescript-eslint/no-unsafe-call": "off",
+      "@typescript-eslint/require-await": "off",
+      "@typescript-eslint/restrict-plus-operands": "off",
+      "@typescript-eslint/no-dynamic-delete": "off",
+      "@typescript-eslint/no-unsafe-enum-comparison": "off",
+      "@typescript-eslint/prefer-literal-enum-member": "off",
+      "@typescript-eslint/no-misused-promises": "off",
+      "@typescript-eslint/no-floating-promises": "off",
+      "@typescript-eslint/await-thenable": "off",
+      "@typescript-eslint/restrict-template-expressions": "off",
+      "@typescript-eslint/only-throw-error": "off",
       "no-case-declarations": "error",
       "no-constant-condition": "error",
       "no-control-regex": "error",
       "no-empty-function": "error",
       "no-prototype-builtins": "error",
       "tsdoc/syntax": "error",
-      // Needed for tseslint.configs.strictTypeChecked
       // "@typescript-eslint/require-await": "error",
       // "@typescript-eslint/await-thenable": "error",
       "@typescript-eslint/unbound-method": "error",

diff --git a/packages/ansible-language-server/src/ansibleLanguageService.ts b/packages/ansible-language-server/src/ansibleLanguageService.ts
@@ -171,9 +171,9 @@ export class AnsibleLanguageService {
 
     this.connection.onDidChangeWatchedFiles((params) => {
       try {
-        this.workspaceManager.forEachContext((context) =>
-          context.handleWatchedDocumentChange(params),
-        );
+        this.workspaceManager.forEachContext((context) => {
+          context.handleWatchedDocumentChange(params);
+        });
       } catch (error) {
         this.handleError(error, "onDidChangeWatchedFiles");
       }

diff --git a/packages/ansible-language-server/src/providers/completionProvider.ts b/packages/ansible-language-server/src/providers/completionProvider.ts
@@ -591,7 +591,7 @@ export async function doCompletionResolve(
           completionItem.data.firstElementOfList,
           isAnsiblePlaybook,
         )}`
-      : `${completionItem.label}`;
+      : completionItem.label;
 
     if (completionItem.textEdit) {
       completionItem.textEdit.newText = insertText;

diff --git a/packages/ansible-language-server/src/services/ansibleInventory.ts b/packages/ansible-language-server/src/services/ansibleInventory.ts
@@ -148,7 +148,7 @@ function parseInventoryHosts(hostObj: inventoryType): HostType[] {
   );
 
   const groupsHavingChildren = topLevelGroups.filter(
-    (item) => hostObj[`${item}`] && hostObj[`${item}`].children,
+    (item) => hostObj[item] && hostObj[item].children,
   );
 
   const otherGroups = getChildGroups(groupsHavingChildren, hostObj);
@@ -188,8 +188,8 @@ function parseInventoryHosts(hostObj: inventoryType): HostType[] {
   let allHosts = [localhostObj, allHostObj, ...ungroupedHostsObjList];
 
   for (const group of allGroups) {
-    if (hostObj[`${group.host}`] && hostObj[`${group.host}`].hosts) {
-      const hostsObj = hostObj[`${group.host}`].hosts.map((item) => {
+    if (hostObj[group.host] && hostObj[group.host].hosts) {
+      const hostsObj = hostObj[group.host].hosts.map((item) => {
         return { host: item, priority: 4 };
       });
       allHosts = [...allHosts, ...hostsObj];
@@ -205,8 +205,8 @@ function getChildGroups(
   res: string[] = [],
 ): string[] {
   for (const host of groupList) {
-    if (hostObj[`${host}`].children) {
-      getChildGroups(hostObj[`${host}`].children, hostObj, res);
+    if (hostObj[host].children) {
+      getChildGroups(hostObj[host].children, hostObj, res);
     } else {
       res.push(host);
     }

diff --git a/packages/ansible-language-server/src/services/executionEnvironment.ts b/packages/ansible-language-server/src/services/executionEnvironment.ts
@@ -51,7 +51,7 @@ export class ExecutionEnvironment {
         this.settings.executionEnvironment.volumeMounts;
 
       const setEngineSuccess = this.setContainerEngine();
-      if (setEngineSuccess === false) {
+      if (!setEngineSuccess) {
         this.isServiceInitialized = false;
         return;
       }
@@ -61,7 +61,7 @@ export class ExecutionEnvironment {
         this.settings.executionEnvironment.containerOptions;
 
       const pullSuccess = await this.pullContainerImage();
-      if (pullSuccess === false) {
+      if (!pullSuccess) {
         this.isServiceInitialized = false;
         return;
       }
@@ -85,10 +85,7 @@ export class ExecutionEnvironment {
       );
       return;
     }
-    const containerName = `${this._container_image.replace(
-      /[^a-z0-9]/gi,
-      "_",
-    )}`;
+    const containerName = this._container_image.replace(/[^a-z0-9]/gi, "_");
     let progressTracker;
 
     try {

diff --git a/packages/ansible-language-server/src/services/settingsManager.ts b/packages/ansible-language-server/src/services/settingsManager.ts
@@ -215,10 +215,14 @@ export class SettingsManager {
       this.documentSettings = newDocumentSettings;
 
       // fire handlers
-      handlersToFire.forEach((h) => h());
+      handlersToFire.forEach((h) => {
+        h();
+      });
     } else {
       if (params.settings.ansible) {
-        this.configurationChangeHandlers.forEach((h) => h());
+        this.configurationChangeHandlers.forEach((h) => {
+          h();
+        });
       }
       this.globalSettings = params.settings.ansible || this.defaultSettings;
     }

diff --git a/packages/ansible-language-server/src/services/validationManager.ts b/packages/ansible-language-server/src/services/validationManager.ts
@@ -185,7 +185,9 @@ export class ValidationManager {
   public handleDocumentClosed(fileUri: string): void {
     const referencedFiles = this.referencedFilesByOrigin.get(fileUri);
     if (referencedFiles) {
-      referencedFiles.forEach((f) => this.handleFileUnreferenced(f));
+      referencedFiles.forEach((f) => {
+        this.handleFileUnreferenced(f);
+      });
       // remove the diagnostics origin file from tracking
       this.referencedFilesByOrigin.delete(fileUri);
     }

diff --git a/packages/ansible-language-server/src/utils/docsFormatter.ts b/packages/ansible-language-server/src/utils/docsFormatter.ts
@@ -17,7 +17,7 @@ export function formatModule(
     sections.push("**DEPRECATED**");
     if (route?.deprecation) {
       if (route.deprecation.warningText) {
-        sections.push(`${route.deprecation.warningText}`);
+        sections.push(route.deprecation.warningText);
       }
       sections.push(
         `Removal date: ${route.deprecation.removalDate}, removal version: ${route.deprecation.removalVersion}`,
@@ -50,16 +50,16 @@ export function formatModule(
 
 export function formatTombstone(route: IPluginRoute): MarkupContent {
   const sections: string[] = [];
-  if (route?.tombstone) {
+  if (route.tombstone) {
     sections.push("**REMOVED**");
     if (route.tombstone.warningText) {
-      sections.push(`${route.tombstone.warningText}`);
+      sections.push(route.tombstone.warningText);
     }
     sections.push(
       `Removal date: ${route.tombstone.removalDate}, removal version: ${route.tombstone.removalVersion}`,
     );
   }
-  if (route?.redirect) {
+  if (route.redirect) {
     sections.push(`Use *${route.redirect}* instead.`);
   }
   return {

diff --git a/packages/ansible-language-server/src/utils/getAnsibleMetaData.ts b/packages/ansible-language-server/src/utils/getAnsibleMetaData.ts
@@ -146,17 +146,17 @@ async function getPythonInfo() {
     return pythonInfo;
   }
 
-  pythonInfo["version"] = pythonVersionResult?.stdout
-    ?.trim()
-    ?.split(" ")
-    ?.pop()
+  pythonInfo["version"] = pythonVersionResult.stdout
+    .trim()
+    .split(" ")
+    .pop()
     ?.trim();
 
   const pythonPathResult = await getResultsThroughCommandRunner(
     "python3",
     '-c "import sys; print(sys.executable)"',
   );
-  pythonInfo["location"] = pythonPathResult?.stdout?.trim();
+  pythonInfo["location"] = pythonPathResult?.stdout.trim();
 
   return pythonInfo;
 }
@@ -192,11 +192,11 @@ async function getAnsibleLintInfo() {
   }
 
   ansibleLintInfo["version"] =
-    ansibleLintVersion?.split("using")[0]?.trim()?.split(" ")?.pop()?.trim() ||
+    ansibleLintVersion.split("using")[0]?.trim()?.split(" ")?.pop()?.trim() ||
     undefined;
 
   ansibleLintInfo["location"] =
-    ansibleLintPathResult?.stdout?.trim() || undefined;
+    ansibleLintPathResult?.stdout.trim() || undefined;
 
   ansibleLintInfo["config file path"] =
     context.ansibleLint.ansibleLintConfigFilePath;

diff --git a/packages/ansible-language-server/src/utils/yaml.ts b/packages/ansible-language-server/src/utils/yaml.ts
@@ -608,7 +608,7 @@ export function isCursorInsideJinjaBrackets(
   position: Position,
   path: Node[],
 ): boolean {
-  const node = path?.[path?.length - 1];
+  const node = path[path.length - 1];
   let nodeObject: string | string[];
 
   try {
@@ -641,7 +641,7 @@ export function isCursorInsideJinjaBrackets(
   // this is a safety check in case of multiple jinja inline brackets in a single line
   let jinjaInlineBracketEndIndex = lineAfterCursor.indexOf(" }}");
   if (
-    lineAfterCursor.indexOf("{{ ") !== -1 &&
+    lineAfterCursor.includes("{{ ") &&
     lineAfterCursor.indexOf("{{ ") < jinjaInlineBracketEndIndex
   ) {
     jinjaInlineBracketEndIndex = -1;

diff --git a/packages/ansible-language-server/test/helper.ts b/packages/ansible-language-server/test/helper.ts
@@ -122,7 +122,7 @@ export function smartFilter(
 
   // Sort completion list based on `sortText` property of the completion item
   completionList.sort((a: CompletionItem, b: CompletionItem) =>
-    a.sortText && b.sortText ? a.sortText.localeCompare(b?.sortText) : 0,
+    a.sortText && b.sortText ? a.sortText.localeCompare(b.sortText) : 0,
   );
 
   // Construct a new Fuse object to do fuzzy search with key as `filterText` property of the completion item

diff --git a/packages/ansible-language-server/test/index.ts b/packages/ansible-language-server/test/index.ts
@@ -9,7 +9,7 @@ const SKIP_PODMAN = (process.env.SKIP_PODMAN ?? "0") === "1";
 const SKIP_DOCKER = (process.env.SKIP_DOCKER ?? "0") === "1";
 let EE_VERSION = "N/A";
 const DEFAULT_CONTAINER =
-  pkg?.contributes?.configuration[6]?.properties[
+  pkg.contributes.configuration[6]?.properties[
     "ansible.executionEnvironment.image"
   ]?.default ?? "";
 

diff --git a/packages/ansible-language-server/test/rootMochaHooks.ts b/packages/ansible-language-server/test/rootMochaHooks.ts
@@ -14,7 +14,7 @@ export const mochaHooks = (): Mocha.RootHookObject => {
     beforeEach(this: Mocha.Context) {
       if (skipEE() && this.currentTest?.fullTitle().includes("@ee")) {
         console.warn(
-          `Skipped test due to environment conditions: ${this.currentTest?.title}`,
+          `Skipped test due to environment conditions: ${this.currentTest.title}`,
         );
         this.skip();
       } else {

diff --git a/packages/ansible-language-server/test/utils/withInterpreter.test.ts b/packages/ansible-language-server/test/utils/withInterpreter.test.ts
@@ -82,9 +82,7 @@ describe("withInterpreter", () => {
             if (!actualCommand[1] || typeof expectedEnv === "string") {
               expect(false);
             } else {
-              expect(actualCommand[1][key]).to.include(
-                expectedEnv[key] as string,
-              );
+              expect(actualCommand[1][key]).to.include(expectedEnv[key]);
             }
           });
         }

diff --git a/src/features/ansibleTox/controller.ts b/src/features/ansibleTox/controller.ts
@@ -63,9 +63,9 @@ export class AnsibleToxController {
       watcher.onDidChange((uri) =>
         this.parseTestsInFileContents(this.getOrCreateFile(uri)),
       );
-      watcher.onDidDelete((uri) =>
-        this.controller.items.delete(uri.toString()),
-      );
+      watcher.onDidDelete((uri) => {
+        this.controller.items.delete(uri.toString());
+      });
       const files = await vscode.workspace.findFiles(pattern);
       files.forEach(this.getOrCreateFile);
       watchers.push(watcher);

diff --git a/src/features/ansibleTox/runner.ts b/src/features/ansibleTox/runner.ts
@@ -47,7 +47,7 @@ export async function getToxEnvs(
       channel.appendLine(stderr);
       channel.show(true);
     }
-    return stdout?.trim().split(os.EOL);
+    return stdout.trim().split(os.EOL);
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
   } catch (err: any) {
     const channel = getOutputChannel();

diff --git a/src/features/contentCreator/createAnsibleCollectionPage.ts b/src/features/contentCreator/createAnsibleCollectionPage.ts
@@ -21,7 +21,13 @@ export class CreateAnsibleCollection {
       extensionUri,
     );
     this._setWebviewMessageListener(this._panel.webview);
-    this._panel.onDidDispose(() => this.dispose(), null, this._disposables);
+    this._panel.onDidDispose(
+      () => {
+        this.dispose();
+      },
+      null,
+      this._disposables,
+    );
   }
 
   public static render(extensionUri: vscode.Uri) {

diff --git a/src/features/contentCreator/createAnsibleProjectPage.ts b/src/features/contentCreator/createAnsibleProjectPage.ts
@@ -21,7 +21,13 @@ export class CreateAnsibleProject {
       extensionUri,
     );
     this._setWebviewMessageListener(this._panel.webview);
-    this._panel.onDidDispose(() => this.dispose(), null, this._disposables);
+    this._panel.onDidDispose(
+      () => {
+        this.dispose();
+      },
+      null,
+      this._disposables,
+    );
   }
 
   public static render(extensionUri: vscode.Uri) {

diff --git a/src/features/lightspeed/contentMatchesWebview.ts b/src/features/lightspeed/contentMatchesWebview.ts
@@ -5,6 +5,7 @@ import { SettingsManager } from "../../settings";
 import {
   ContentMatchesRequestParams,
   ContentMatchesResponseParams,
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   IContentMatch,
   IContentMatchParams,
   ISuggestionDetails,
@@ -156,7 +157,7 @@ export class ContentMatchesWebview implements vscode.WebviewViewProvider {
   private async getErrorWebviewContent(error: IError) {
     let detail: unknown = error.detail;
     if (typeof error.detail === "string") {
-      detail = error.detail as string;
+      detail = error.detail;
     } else if (typeof error.detail === "object") {
       detail = JSON.stringify(error.detail, undefined, "  ");
     }
@@ -246,7 +247,7 @@ export class ContentMatchesWebview implements vscode.WebviewViewProvider {
 
       const contentMatchValue = contentMatchResponses.contentmatches[taskIndex];
       contentMatchesHtml += this.renderContentMatchWithTasKDescription(
-        <IContentMatchParams[]>(<IContentMatch>contentMatchValue).contentmatch,
+        contentMatchValue.contentmatch,
         taskNameDescription || "",
         rhUserHasSeat === true,
       );
@@ -289,10 +290,10 @@ export class ContentMatchesWebview implements vscode.WebviewViewProvider {
   ): string {
     let taskContentMatch = "";
     for (let index = 0; index < contentMatchesResponse.length; index++) {
-      taskContentMatch += `${this.renderContentMatches(
+      taskContentMatch += this.renderContentMatches(
         contentMatchesResponse[index],
         rhUserHasSeat,
-      )}`;
+      );
     }
 
     return `