Lint to prevent floating promises

.eslintrc.json

@@ -4,12 +4,15 @@
   "extends": [
     "eslint:recommended",
     "plugin:@typescript-eslint/recommended",
+    // We want to enable this in the long run. For now there are a lot of errors that needs to be handled.
+    // "plugin:@typescript-eslint/recommended-requiring-type-checking",
     "plugin:import/typescript",
     "prettier"
   ],
   "parserOptions": {
     "ecmaVersion": 6,
-    "sourceType": "module"
+    "sourceType": "module",
+    "project": true
   },
   "plugins": [
     "@typescript-eslint",
@@ -37,6 +40,7 @@
         }
       }
     ],
+    "@typescript-eslint/no-floating-promises": "error",
     "@typescript-eslint/no-explicit-any": "off",
     "@typescript-eslint/no-inferrable-types": "off",
     "@typescript-eslint/no-non-null-assertion": "off",
@@ -85,22 +89,30 @@
           }
         ]
       }
+    },
+    {
+      "files": [
+        "jest.config.ts",
+        "docusaurus.config.mts",
+        "mdx-components.tsx",
+        "typings/**"
+      ],
+      "extends": ["plugin:@typescript-eslint/disable-type-checked"]
     }
   ],
   "settings": {
     "import/resolver": {
       "typescript": {
         "alwaysTryTypes": true, // always try to resolve types under `<root>@types` directory even it doesn't contain any source code, like `@types/unist`
-
         "project": ["tsconfig.json", "packages/*/tsconfig.json"]
       }
     }
   },
   "ignorePatterns": [
-    "**/vendor/**/*.ts",
-    "**/vendor/**/*.js",
-    "**/out/**",
     "**/generated/**",
-    "data/playground/**"
+    "**/out/**",
+    "**/vendor/**/*.js",
+    "**/vendor/**/*.ts",
+    "/data/playground/**"
   ]
 }

package.json

@@ -31,7 +31,7 @@
     "@pnpm/meta-updater": "1.0.0",
     "@types/node": "18.18.2",
     "@typescript-eslint/eslint-plugin": "^7.4.0",
-    "@typescript-eslint/parser": "^7.4.0",
+    "@typescript-eslint/parser": "^7.18.0",
     "esbuild": "^0.20.2",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",

packages/common/src/types/command/command.types.ts

@@ -10,7 +10,7 @@ import type { CommandV5 } from "./legacy/CommandV5.types";
 
 export type CommandComplete = Required<Omit<CommandLatest, "spokenForm">> &
   Pick<CommandLatest, "spokenForm">;
-export const LATEST_VERSION = 7 as const;
+export const LATEST_VERSION = 7;
 
 export type CommandLatest = Command & {
   version: typeof LATEST_VERSION;

packages/common/src/util/splitKey.ts

@@ -1,10 +1,17 @@
 import type { HatStyleName } from "../ide/types/hatStyles.types";
 
-export function splitKey(key: string) {
+interface SplitKey {
+  hatStyle: string;
+  // If the character is `.` then it will appear as a zero length string
+  // due to the way the split on `.` works
+  character: HatStyleName;
+}
+
+export function splitKey(key: string): SplitKey {
   const [hatStyle, character] = key.split(".");
 
   return {
-    hatStyle: hatStyle as HatStyleName,
+    hatStyle,
     // If the character is `.` then it will appear as a zero length string
     // due to the way the split on `.` works
     character: character.length === 0 ? "." : character,

packages/common/src/util/uniqWithHash.ts

@@ -51,7 +51,7 @@ export function uniqWithHash<T>(
   // For hash collisions, uniq the items,
   // letting uniqWith provide correct semantics.
   needsUniq.forEach((key) => {
-    hashToItems.set(key, uniqWith(hashToItems.get(key)!, isEqual));
+    hashToItems.set(key, uniqWith(hashToItems.get(key), isEqual));
   });
 
   // To preserve order, step through the original items
@@ -67,7 +67,7 @@ export function uniqWithHash<T>(
       // Removed by uniqWith.
       return [];
     }
-    const first = items[0]!;
+    const first = items[0];
     if (!isEqual(first, item)) {
       // Removed by uniqWith.
       // Note that it is sufficient to check the first item,

packages/cursorless-engine/src/actions/Find.ts

@@ -20,7 +20,7 @@ abstract class Find implements SimpleAction {
     let query: string;
     if (text.length > 200) {
       query = text.substring(0, 200);
-      showWarning(
+      void showWarning(
         ide().messages,
         "truncatedSearchText",
         "Search text is longer than 200 characters; truncating",

packages/cursorless-engine/src/actions/GenerateSnippet/GenerateSnippet.ts

@@ -60,7 +60,7 @@ export default class GenerateSnippet {
     // immediately starts saying the name of the snippet (eg command chain
     // "snippet make funk camel my function"), we're more likely to
     // win the race and have the input box ready for them
-    flashTargets(ide(), targets, FlashStyle.referenced);
+    void flashTargets(ide(), targets, FlashStyle.referenced);
 
     if (snippetName == null) {
       snippetName = await ide().showInputBox({

packages/cursorless-engine/src/actions/ShowParseTree.ts

@@ -22,7 +22,8 @@ export default class ShowParseTree {
       results.push(parseTree(editor.document, tree, contentRange));
     }
 
-    ide().openUntitledTextDocument({
+    // FIXME: If we await this our test break. We should probably find out when this actually resolves.
+    void ide().openUntitledTextDocument({
       language: "markdown",
       content: results.join("\n\n"),
     });

packages/cursorless-engine/src/actions/Sort.ts

@@ -14,7 +14,7 @@ abstract class SortBase implements SimpleAction {
 
   async run(targets: Target[]): Promise<ActionReturnValue> {
     if (targets.length < 2) {
-      showWarning(
+      void showWarning(
         ide().messages,
         "tooFewTargets",
         'This action works on multiple targets, e.g. "sort every line block" instead of "sort block".',

packages/cursorless-engine/src/core/commandVersionUpgrades/upgradeV5ToV6/upgradeV5ToV6.ts

@@ -5,8 +5,6 @@ import {
   CommandV6,
   DestinationDescriptor,
   EnforceUndefined,
-  ExecuteCommandOptions,
-  GetTextActionOptions,
   HighlightActionDescriptor,
   HighlightId,
   ImplicitDestinationDescriptor,
@@ -28,6 +26,8 @@ import {
   PrimitiveDestinationDescriptor,
   ReplaceWith,
   WrapWithSnippetArg,
+  type ExecuteCommandOptions,
+  type GetTextActionOptions,
 } from "@cursorless/common";
 import canonicalizeActionName from "./canonicalizeActionName";
 

packages/cursorless-engine/src/cursorlessEngine.ts

@@ -64,6 +64,7 @@ export async function createCursorlessEngine({
 
   const debug = new Debug(ide);
   const rangeUpdater = new RangeUpdater();
+
   const storedTargets = new StoredTargetMap();
   const keyboardTargetUpdater = new KeyboardTargetUpdater(ide, storedTargets);
   const customSpokenFormGenerator = new CustomSpokenFormGeneratorImpl(

packages/cursorless-engine/src/customCommandGrammar/parseCommand.ts

@@ -49,5 +49,5 @@ export function parseAction(input: string): WithPlaceholders<ActionDescriptor> {
     );
   }
 
-  return parser.results[0] as WithPlaceholders<ActionDescriptor>;
+  return parser.results[0];
 }

packages/cursorless-engine/src/languages/LanguageDefinition.ts

@@ -139,7 +139,7 @@ async function readQueryFileAndImports(
           return undefined;
         }
 
-        showError(
+        void showError(
           ide.messages,
           "LanguageDefinition.readQueryFileAndImports.queryNotFound",
           `Could not find imported query file ${queryName}`,
@@ -193,7 +193,7 @@ function validateImportSyntax(
   let isError = false;
 
   if (/[/\\]/g.test(importName)) {
-    showError(
+    void showError(
       ide.messages,
       "LanguageDefinition.readQueryFileAndImports.invalidImport",
       `Invalid import statement in ${file}: "${actual}". Relative import paths not supported`,
@@ -204,7 +204,7 @@ function validateImportSyntax(
 
   const canonicalSyntax = `;; import ${importName}`;
   if (actual !== canonicalSyntax) {
-    showError(
+    void showError(
       ide.messages,
       "LanguageDefinition.readQueryFileAndImports.malformedImport",
       `Malformed import statement in ${file}: "${actual}". Import statements must be of the form "${canonicalSyntax}"`,

packages/cursorless-engine/src/languages/LanguageDefinitions.ts

@@ -74,7 +74,7 @@ export class LanguageDefinitionsImpl
     private treeSitterQueryProvider: RawTreeSitterQueryProvider,
   ) {
     ide.onDidOpenTextDocument((document) => {
-      this.loadLanguage(document.languageId);
+      void this.loadLanguage(document.languageId);
     });
     ide.onDidChangeVisibleTextEditors((editors) => {
       editors.forEach(({ document }) => this.loadLanguage(document.languageId));
@@ -111,7 +111,7 @@ export class LanguageDefinitionsImpl
         languageIds.map((languageId) => this.loadLanguage(languageId)),
       );
     } catch (err) {
-      showError(
+      void showError(
         this.ide.messages,
         "Failed to load language definitions",
         toString(err),

packages/cursorless-engine/src/languages/TreeSitterQuery/TreeSitterQuery.ts

@@ -49,7 +49,7 @@ export class TreeSitterQuery {
           )}\``,
         ].join(", ");
 
-        showError(
+        void showError(
           ide().messages,
           "TreeSitterQuery.parsePredicates",
           `Error parsing predicate for ${context}: ${error.error}`,

packages/cursorless-engine/src/languages/TreeSitterQuery/checkCaptureStartEnd.ts

@@ -39,7 +39,7 @@ export function checkCaptureStartEnd(
     .at(0);
   if (lastStart != null && firstEnd != null) {
     if (lastStart.isAfter(firstEnd)) {
-      showError(
+      void showError(
         messages,
         "TreeSitterQuery.checkCaptures.badOrder",
         `Start capture must be before end capture: ${captures}`,
@@ -57,7 +57,7 @@ export function checkCaptureStartEnd(
   if (regularCount > 0 && (startCount > 0 || endCount > 0)) {
     // Found a mix of regular captures and start/end captures, which is not
     // allowed
-    showError(
+    void showError(
       messages,
       "TreeSitterQuery.checkCaptures.mixRegularStartEnd",
       `Please do not mix regular captures and start/end captures: ${captures.map(
@@ -69,7 +69,7 @@ export function checkCaptureStartEnd(
 
   if (regularCount > 1) {
     // Found duplicate captures
-    showError(
+    void showError(
       messages,
       "TreeSitterQuery.checkCaptures.duplicate",
       `A capture with the same name may only appear once in a single pattern: ${captures.map(

packages/cursorless-engine/src/languages/TreeSitterQuery/validateQueryCaptures.ts

@@ -80,7 +80,7 @@ export function validateQueryCaptures(file: string, rawQuery: string): void {
     }
 
     if (!allowedCaptures.has(captureName)) {
-      const lineNumber = match.input!.slice(0, match.index!).split("\n").length;
+      const lineNumber = match.input.slice(0, match.index).split("\n").length;
       errors.push(`${file}(${lineNumber}) invalid capture '@${captureName}'.`);
     }
   }
@@ -91,7 +91,7 @@ export function validateQueryCaptures(file: string, rawQuery: string): void {
 
   const message = errors.join("\n");
 
-  showError(
+  void showError(
     ide().messages,
     "validateQueryCaptures.invalidCaptureName",
     message,

packages/cursorless-engine/src/languages/getNodeMatcher.ts

@@ -68,7 +68,7 @@ function matcherIncludeSiblings(matcher: NodeMatcher): NodeMatcher {
         selectionWithEditorFromRange(selection, match.selection.selection),
         matcher,
       ),
-    ) as NodeMatcherValue[];
+    );
     if (matches.length > 0) {
       return matches;
     }
@@ -83,7 +83,7 @@ function iterateNearestIterableAncestor(
 ) {
   let parent: SyntaxNode | null = node.parent;
   while (parent != null) {
-    const matches = parent!.namedChildren
+    const matches = parent.namedChildren
       .flatMap((sibling) => nodeMatcher(selection, sibling))
       .filter((match) => match != null) as NodeMatcherValue[];
     if (matches.length > 0) {

packages/cursorless-engine/src/processTargets/modifiers/scopeHandlers/TreeSitterScopeHandler/BaseTreeSitterScopeHandler.ts

@@ -61,7 +61,7 @@ export abstract class BaseTreeSitterScopeHandler extends BaseScopeHandler {
               const message =
                 "Please use #allow-multiple! predicate in your query to allow multiple matches for this scope type";
 
-              showError(
+              void showError(
                 ide().messages,
                 "BaseTreeSitterScopeHandler.allow-multiple",
                 message,

packages/cursorless-engine/src/processTargets/modifiers/scopeHandlers/WordScopeHandler/WordScopeHandler.ts

@@ -86,9 +86,7 @@ function constructTarget(
   const isInDelimitedList =
     leadingDelimiterRange != null || trailingDelimiterRange != null;
   const insertionDelimiter = isInDelimitedList
-    ? editor.document.getText(
-        (leadingDelimiterRange ?? trailingDelimiterRange)!,
-      )
+    ? editor.document.getText(leadingDelimiterRange ?? trailingDelimiterRange)
     : "";
 
   return new SubTokenWordTarget({

packages/cursorless-engine/src/scopeProviders/ScopeRangeWatcher.ts

@@ -73,7 +73,7 @@ export class ScopeRangeWatcher {
             config,
           );
         } catch (err) {
-          showError(
+          void showError(
             ide().messages,
             "ScopeRangeWatcher.provide",
             (err as Error).message,

packages/cursorless-engine/src/scripts/transformRecordedTests/index.ts

@@ -95,4 +95,4 @@ function parseCommandLineArguments(args: string[]) {
   return { transformationName, minimumVersion, paths };
 }
 
-main(process.argv.slice(2));
+void main(process.argv.slice(2));

packages/cursorless-engine/src/snippets/snippet.ts

@@ -189,9 +189,13 @@ function findMatchingSnippetDefinitionForSingleTarget(
         }
       }
 
+      if (matchingScopeType == null) {
+        return false;
+      }
+
       return (
         matchingTarget != null &&
-        !(excludeDescendantScopeTypes ?? []).includes(matchingScopeType!)
+        !(excludeDescendantScopeTypes ?? []).includes(matchingScopeType)
       );
     }
 

packages/cursorless-engine/src/spokenForms/CustomSpokenForms.ts

@@ -87,7 +87,7 @@ export class CustomSpokenForms {
       } else {
         console.error("Error loading custom spoken forms", err);
         const msg = (err as Error).message.replace(/\.$/, "");
-        showError(
+        void showError(
           ide().messages,
           "CustomSpokenForms.updateSpokenFormMaps",
           `Error loading custom spoken forms: ${msg}. Falling back to default spoken forms.`,

packages/cursorless-engine/src/util/targetUtils.ts

@@ -106,7 +106,7 @@ export function createThatMark(
             : new Selection(range!.start, range!.end),
         }))
       : targets.map((target) => ({
-          editor: target!.editor,
+          editor: target.editor,
           selection: target.contentSelection,
         }));
   return thatMark;

packages/cursorless-everywhere-talon-e2e/src/types/std.d.ts

@@ -0,0 +1,3 @@
+declare module "std" {
+  function exit(code: number): void;
+}

packages/cursorless-everywhere-talon-e2e/tsconfig.json

@@ -4,7 +4,6 @@
     "target": "ES2022"
   },
   "include": ["src/**/*.ts", "src/**/*.json", "../../typings/**/*.d.ts"],
-  "exclude": ["src/quickjsTest.ts"],
   "references": [
     {
       "path": "../common"