diff --git a/AGENTS.md b/AGENTS.md index be85a2c5065..5a09aa51c45 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -12,6 +12,7 @@ - Engine code is in `/packages/lib-engine/` - Tests are in `resources/fixtures/recorded` and `resources/fixtures/scopes` - Language-specific parsing is defined in the `resources/queries/*.scm` files +- Packages starting `lib-` are only used internally in this monorepo and are not published to npm. Changing the api surface is fine as long as every place that consumes the api within this repository is updated. ## Build and test diff --git a/oxlint.config.mts b/oxlint.config.mts index 409ca2f010c..8d658e5b3ae 100644 --- a/oxlint.config.mts +++ b/oxlint.config.mts @@ -1,10 +1,23 @@ +import type { OxlintConfig } from "oxlint"; import { defineConfig } from "oxlint"; +// These rules should probably be re-enabled eventually +const temporarilyDisabled = [ + "eslint/no-param-reassign", + "eslint/no-shadow", + "eslint/prefer-template", + "import/no-default-export", + "typescript/no-unsafe-type-assertion", + "unicorn/no-array-reduce", +]; + const disabledRules = [ + ...temporarilyDisabled, "eslint/arrow-body-style", "eslint/capitalized-comments", "eslint/class-methods-use-this", "eslint/complexity", + "eslint/func-names", "eslint/id-length", "eslint/init-declarations", "eslint/max-classes-per-file", @@ -12,9 +25,12 @@ const disabledRules = [ "eslint/max-lines", "eslint/max-params", "eslint/max-statements", + "eslint/no-await-in-loop", "eslint/no-console", "eslint/no-continue", "eslint/no-eq-null", + "eslint/no-lonely-if", + "eslint/no-loop-func", "eslint/no-magic-numbers", "eslint/no-negated-condition", "eslint/no-plusplus", @@ -36,15 +52,20 @@ const disabledRules = [ "import/no-relative-parent-imports", "import/prefer-default-export", "oxc/no-async-await", + "oxc/no-barrel-file", + "oxc/no-map-spread", "oxc/no-optional-chaining", "oxc/no-rest-spread-properties", + "promise/always-return", "promise/avoid-new", "promise/prefer-await-to-callbacks", "react-perf/jsx-no-new-function-as-prop", "react/jsx-max-depth", + "react/no-danger", "react/no-multi-comp", "react/only-export-components", "react/react-in-jsx-scope", + "react/rules-of-hooks", "typescript/explicit-function-return-type", "typescript/parameter-properties", "typescript/prefer-readonly-parameter-types", @@ -53,14 +74,33 @@ const disabledRules = [ "unicorn/filename-case", "unicorn/no-array-callback-reference", "unicorn/no-array-for-each", + "unicorn/no-array-reverse", + "unicorn/no-array-sort", + "unicorn/no-lonely-if", "unicorn/no-null", + "unicorn/no-object-as-default-parameter", + "unicorn/no-useless-undefined", "unicorn/prefer-at", + "unicorn/prefer-event-target", "unicorn/prefer-module", + "unicorn/prefer-query-selector", "unicorn/prefer-spread", "unicorn/prefer-ternary", + "unicorn/require-post-message-target-origin", "unicorn/switch-case-braces", ]; +const plugins: OxlintConfig["plugins"] = [ + "eslint", + "unicorn", + "oxc", + "import", + "node", + "promise", + "react", + "react-perf", +]; + // oxlint-disable-next-line import/no-default-export export default defineConfig({ ignorePatterns: [ @@ -69,43 +109,36 @@ export default defineConfig({ "packages/app-vscode/src/keyboard/grammar/generated/**", "packages/lib-engine/src/customCommandGrammar/generated/**", "packages/lib-engine/src/snippets/vendor/**", + "**/*.d.ts", ], options: { typeAware: true, typeCheck: false, }, - plugins: [ - "eslint", - "typescript", - "unicorn", - "oxc", - "import", - "node", - "promise", - "react", - "react-perf", - ], + plugins, jsPlugins: [ { name: "mocha", specifier: "eslint-plugin-mocha", }, ], + categories: { + correctness: "warn", + suspicious: "warn", + pedantic: "warn", + perf: "warn", + style: "warn", + restriction: "warn", + // Disabled since nursery contains rules under development that may change + // nursery: "warn", + }, rules: { ...Object.fromEntries(disabledRules.map((r) => [r, "off"])), - curly: "warn", - eqeqeq: [ - "warn", - "always", - { - null: "never", - }, - ], - "eslint/no-constant-condition": [ + "eslint/no-duplicate-imports": [ "warn", { - checkLoops: false, + allowSeparateTypeImports: true, }, ], "eslint/no-restricted-imports": [ @@ -125,41 +158,54 @@ export default defineConfig({ ], }, ], - "eslint/no-throw-literal": "warn", "eslint/no-unused-vars": [ "warn", { argsIgnorePattern: "^_", varsIgnorePattern: "^_", - caughtErrorsIgnorePattern: "^_", ignoreRestSiblings: true, }, ], - "import/no-duplicates": "warn", - "mocha/no-exclusive-tests": "warn", - "mocha/no-pending-tests": "warn", + "import/no-unassigned-import": [ + "warn", + { + allow: ["**/*.css"], + }, + ], "no-warning-comments": [ "warn", { terms: ["todo"], }, ], - "typescript/consistent-type-assertions": [ + "react/jsx-filename-extension": [ + "warn", + { + extensions: [".tsx"], + }, + ], + eqeqeq: [ "warn", + "always", { - assertionStyle: "as", + null: "never", }, ], - "typescript/consistent-type-imports": "warn", - "typescript/no-base-to-string": "off", - "typescript/restrict-template-expressions": "off", - "typescript/unbound-method": "off", - "unicorn/prefer-module": "warn", - "unicorn/prefer-node-protocol": "warn", - "unicorn/throw-new-error": "warn", }, overrides: [ + { + files: ["**/*.js"], + rules: { + "import/unambiguous": "off", + }, + }, + + { + files: ["**/*.{ts,cts,mts,tsx}"], + plugins: [...plugins, "typescript"], + }, + { files: ["packages/app-vscode/src/scripts/**/*.ts"], rules: { diff --git a/packages/app-neovim/src/NeovimCommandServerApi.ts b/packages/app-neovim/src/NeovimCommandServerApi.ts index a0d09de8f8b..dd0f5838819 100644 --- a/packages/app-neovim/src/NeovimCommandServerApi.ts +++ b/packages/app-neovim/src/NeovimCommandServerApi.ts @@ -9,7 +9,11 @@ export class NeovimCommandServerApi implements CommandServerApi { signals: { prePhrase: InboundSignal }; constructor(private client: NeovimClient) { - this.signals = { prePhrase: { getVersion: async () => null } }; + this.signals = { + prePhrase: { + getVersion: () => Promise.resolve(null), + }, + }; } // for vscode, it is actually stored into the command-server @@ -19,8 +23,7 @@ export class NeovimCommandServerApi implements CommandServerApi { const currentMode = await this.client.mode; if (currentMode.mode === "t" || currentMode.mode === "nt") { return "terminal"; - } else { - return "textEditor"; } + return "textEditor"; } } diff --git a/packages/app-neovim/src/constructTestHelpers.ts b/packages/app-neovim/src/constructTestHelpers.ts index 662d47d9e50..4b3f996d083 100644 --- a/packages/app-neovim/src/constructTestHelpers.ts +++ b/packages/app-neovim/src/constructTestHelpers.ts @@ -30,7 +30,7 @@ export function constructTestHelpers( injectIde: (ide: IDE) => void, ): NeovimTestHelpers | undefined { return { - commandServerApi: commandServerApi!, + commandServerApi, ide: normalizedIde, neovimIDE, injectIde, diff --git a/packages/app-neovim/src/registerCommands.ts b/packages/app-neovim/src/registerCommands.ts index f3055c684b5..0c15dc5b5b5 100644 --- a/packages/app-neovim/src/registerCommands.ts +++ b/packages/app-neovim/src/registerCommands.ts @@ -17,12 +17,12 @@ import { } from "@cursorless/lib-neovim-common"; import { getNeovimRegistry } from "@cursorless/lib-neovim-registry"; -export async function registerCommands( +export function registerCommands( client: NeovimClient, neovimIDE: NeovimIDE, commandApi: CommandApi, commandServerApi: CommandServerApi, -): Promise { +): void { const commands: Record any> = { // The core Cursorless command [CURSORLESS_COMMAND_ID]: async (...args: unknown[]) => { @@ -55,84 +55,84 @@ export async function registerCommands( } return result; - } catch (e) { + } catch (error) { if (neovimIDE.runMode !== "test") { - const err = e as Error; - console.error(err.stack); - neovimIDE.handleCommandError(err); + if (error instanceof Error) { + console.error(error.stack); + } + neovimIDE.handleCommandError(error); } - throw e; + throw error; } }, - ["cursorless.repeatPreviousCommand"]: dummyCommandHandler, + "cursorless.repeatPreviousCommand": dummyCommandHandler, // Cheatsheet commands - ["cursorless.showCheatsheet"]: dummyCommandHandler, - ["cursorless.internal.updateCheatsheetDefaults"]: dummyCommandHandler, + "cursorless.showCheatsheet": dummyCommandHandler, + "cursorless.internal.updateCheatsheetDefaults": dummyCommandHandler, // Testcase recorder commands - ["cursorless.recordTestCase"]: dummyCommandHandler, - ["cursorless.recordOneTestCaseThenPause"]: dummyCommandHandler, - ["cursorless.pauseRecording"]: dummyCommandHandler, - ["cursorless.resumeRecording"]: dummyCommandHandler, - ["cursorless.takeSnapshot"]: dummyCommandHandler, + "cursorless.recordTestCase": dummyCommandHandler, + "cursorless.recordOneTestCaseThenPause": dummyCommandHandler, + "cursorless.pauseRecording": dummyCommandHandler, + "cursorless.resumeRecording": dummyCommandHandler, + "cursorless.takeSnapshot": dummyCommandHandler, // Scope test recorder commands - ["cursorless.recordScopeTests.showUnimplementedFacets"]: - dummyCommandHandler, - ["cursorless.recordScopeTests.saveActiveDocument"]: dummyCommandHandler, + "cursorless.recordScopeTests.showUnimplementedFacets": dummyCommandHandler, + "cursorless.recordScopeTests.saveActiveDocument": dummyCommandHandler, // Other commands - ["cursorless.showQuickPick"]: dummyCommandHandler, - ["cursorless.showDocumentation"]: dummyCommandHandler, - ["cursorless.showInstallationDependencies"]: dummyCommandHandler, - ["cursorless.private.logQuickActions"]: dummyCommandHandler, + "cursorless.showQuickPick": dummyCommandHandler, + "cursorless.showDocumentation": dummyCommandHandler, + "cursorless.showInstallationDependencies": dummyCommandHandler, + "cursorless.private.logQuickActions": dummyCommandHandler, // Hats - ["cursorless.toggleDecorations"]: dummyCommandHandler, - ["cursorless.recomputeDecorationStyles"]: dummyCommandHandler, + "cursorless.toggleDecorations": dummyCommandHandler, + "cursorless.recomputeDecorationStyles": dummyCommandHandler, // Scope visualizer - ["cursorless.showScopeVisualizer"]: dummyCommandHandler, - ["cursorless.hideScopeVisualizer"]: dummyCommandHandler, - ["cursorless.scopeVisualizer.openUrl"]: dummyCommandHandler, + "cursorless.showScopeVisualizer": dummyCommandHandler, + "cursorless.hideScopeVisualizer": dummyCommandHandler, + "cursorless.scopeVisualizer.openUrl": dummyCommandHandler, // Command history - ["cursorless.analyzeCommandHistory"]: dummyCommandHandler, + "cursorless.analyzeCommandHistory": dummyCommandHandler, // General keyboard commands - ["cursorless.keyboard.escape"]: dummyCommandHandler, + "cursorless.keyboard.escape": dummyCommandHandler, // Targeted keyboard commands - ["cursorless.keyboard.targeted.targetHat"]: dummyCommandHandler, - ["cursorless.keyboard.targeted.targetScope"]: dummyCommandHandler, - ["cursorless.keyboard.targeted.targetSelection"]: dummyCommandHandler, - ["cursorless.keyboard.targeted.clearTarget"]: dummyCommandHandler, - ["cursorless.keyboard.targeted.runActionOnTarget"]: dummyCommandHandler, + "cursorless.keyboard.targeted.targetHat": dummyCommandHandler, + "cursorless.keyboard.targeted.targetScope": dummyCommandHandler, + "cursorless.keyboard.targeted.targetSelection": dummyCommandHandler, + "cursorless.keyboard.targeted.clearTarget": dummyCommandHandler, + "cursorless.keyboard.targeted.runActionOnTarget": dummyCommandHandler, // Modal keyboard commands - ["cursorless.keyboard.modal.modeOn"]: dummyCommandHandler, - ["cursorless.keyboard.modal.modeOff"]: dummyCommandHandler, - ["cursorless.keyboard.modal.modeToggle"]: dummyCommandHandler, - ["cursorless.keyboard.undoTarget"]: dummyCommandHandler, - ["cursorless.keyboard.redoTarget"]: dummyCommandHandler, + "cursorless.keyboard.modal.modeOn": dummyCommandHandler, + "cursorless.keyboard.modal.modeOff": dummyCommandHandler, + "cursorless.keyboard.modal.modeToggle": dummyCommandHandler, + "cursorless.keyboard.undoTarget": dummyCommandHandler, + "cursorless.keyboard.redoTarget": dummyCommandHandler, // Tutorial commands - ["cursorless.tutorial.start"]: dummyCommandHandler, - ["cursorless.tutorial.next"]: dummyCommandHandler, - ["cursorless.tutorial.previous"]: dummyCommandHandler, - ["cursorless.tutorial.restart"]: dummyCommandHandler, - ["cursorless.tutorial.resume"]: dummyCommandHandler, - ["cursorless.tutorial.list"]: dummyCommandHandler, - ["cursorless.documentationOpened"]: dummyCommandHandler, + "cursorless.tutorial.start": dummyCommandHandler, + "cursorless.tutorial.next": dummyCommandHandler, + "cursorless.tutorial.previous": dummyCommandHandler, + "cursorless.tutorial.restart": dummyCommandHandler, + "cursorless.tutorial.resume": dummyCommandHandler, + "cursorless.tutorial.list": dummyCommandHandler, + "cursorless.documentationOpened": dummyCommandHandler, }; - Object.entries(commands).forEach(([commandId, callback]) => - getNeovimRegistry().registerCommand(commandId, callback), - ); + Object.entries(commands).forEach(([commandId, callback]) => { + getNeovimRegistry().registerCommand(commandId, callback); + }); } -export async function dummyCommandHandler(...args: any[]) { +export function dummyCommandHandler(...args: any[]) { console.debug(`dummyCommandHandler(): args=${args}`); } diff --git a/packages/app-vscode/resources/installationDependencies.js b/packages/app-vscode/resources/installationDependencies.js index 6784fd0446b..a1cbc211f6d 100644 --- a/packages/app-vscode/resources/installationDependencies.js +++ b/packages/app-vscode/resources/installationDependencies.js @@ -1,16 +1,16 @@ /* global window, document, acquireVsCodeApi */ const vscode = acquireVsCodeApi(); -const msgTalon = document.getElementById("msg-talon"); -const msgCursorlessTalon = document.getElementById("msg-cursorless-talon"); -const msgCommandServer = document.getElementById("msg-command-server"); -const msgAllInstalled = document.getElementById("msg-all-installed"); -const inputDontShow = document.getElementById("input-dont-show"); +const msgTalon = document.querySelector("#msg-talon"); +const msgCursorlessTalon = document.querySelector("#msg-cursorless-talon"); +const msgCommandServer = document.querySelector("#msg-command-server"); +const msgAllInstalled = document.querySelector("#msg-all-installed"); +const inputDontShow = document.querySelector("#input-dont-show"); -inputDontShow.onchange = (e) => { +inputDontShow.addEventListener("change", (e) => { const command = { type: "dontShow", checked: e.target.checked }; vscode.postMessage(command); -}; +}); window.addEventListener("message", (event) => { const { dontShow, hasMissingDependencies, dependencies } = event.data; diff --git a/packages/app-vscode/src/InstallationDependencies.ts b/packages/app-vscode/src/InstallationDependencies.ts index cd60f7d7692..6978f9e2fa3 100644 --- a/packages/app-vscode/src/InstallationDependencies.ts +++ b/packages/app-vscode/src/InstallationDependencies.ts @@ -39,7 +39,10 @@ export class InstallationDependencies { (value) => !value, ); return { - dontShow: !!this.extensionContext.globalState.get(STATE_KEY), + dontShow: this.extensionContext.globalState.get( + STATE_KEY, + false, + ), hasMissingDependencies, dependencies, }; diff --git a/packages/app-vscode/src/ReleaseNotes.test.ts b/packages/app-vscode/src/ReleaseNotes.test.ts index 03ea83bac18..8cff925ce01 100644 --- a/packages/app-vscode/src/ReleaseNotes.test.ts +++ b/packages/app-vscode/src/ReleaseNotes.test.ts @@ -152,7 +152,7 @@ const testCases: TestCase[] = [ }, ]; -suite("release notes", async function () { +suite("release notes", function () { teardown(() => { sinon.restore(); }); @@ -220,7 +220,7 @@ async function runTest(input: Input, expectedOutput: Output) { } } -async function getFakes(input: Input) { +function getFakes(input: Input) { const openExternal = sinon.fake.resolves<[Uri], Promise>(true); const vscodeApi = { window: { diff --git a/packages/app-vscode/src/ScopeTreeProvider.ts b/packages/app-vscode/src/ScopeTreeProvider.ts index 60fa8dafee6..9b2fce400cc 100644 --- a/packages/app-vscode/src/ScopeTreeProvider.ts +++ b/packages/app-vscode/src/ScopeTreeProvider.ts @@ -36,8 +36,8 @@ import { serializeScopeType, uriEncodeHashId, } from "@cursorless/lib-common"; -import { type CustomSpokenFormGenerator } from "@cursorless/lib-engine"; -import { type VscodeApi } from "@cursorless/lib-vscode-common"; +import type { CustomSpokenFormGenerator } from "@cursorless/lib-engine"; +import type { VscodeApi } from "@cursorless/lib-vscode-common"; import type { ScopeVisualizer, VisualizationType, @@ -374,6 +374,7 @@ class SupportCategoryTreeItem extends TreeItem { description = "unsupported in language of active editor"; collapsibleState = TreeItemCollapsibleState.Collapsed; break; + // No default } super(label, collapsibleState); diff --git a/packages/app-vscode/src/SpyWebviewView.ts b/packages/app-vscode/src/SpyWebviewView.ts index 0f802aa8eab..0eecb76e68e 100644 --- a/packages/app-vscode/src/SpyWebviewView.ts +++ b/packages/app-vscode/src/SpyWebviewView.ts @@ -1,5 +1,4 @@ -import { cloneDeep } from "lodash-es"; -import type { Uri, Webview, WebviewView } from "vscode"; +import type { Uri, Webview, WebviewOptions, WebviewView } from "vscode"; import type { Disposable } from "@cursorless/lib-common"; import type { SpyWebViewEvent } from "@cursorless/lib-vscode-common"; @@ -27,7 +26,7 @@ export class SpyWebviewView { } getEventLog(): SpyWebViewEvent[] { - return cloneDeep(this.eventLog); + return structuredClone(this.eventLog); } show(preserveFocus: boolean): void { @@ -56,11 +55,19 @@ class SpyWebview { }); } + get html(): string { + return this.view.html; + } + set html(value: string) { this.view.html = value; } - set options(value: { enableScripts: boolean; localResourceRoots: Uri[] }) { + get options(): WebviewOptions { + return this.view.options; + } + + set options(value: WebviewOptions) { this.view.options = value; } diff --git a/packages/app-vscode/src/VscodeSnippets.ts b/packages/app-vscode/src/VscodeSnippets.ts index 9d8b785b63d..cfa5450f7ae 100644 --- a/packages/app-vscode/src/VscodeSnippets.ts +++ b/packages/app-vscode/src/VscodeSnippets.ts @@ -1,7 +1,8 @@ import { open } from "node:fs/promises"; import { join } from "node:path"; import type { IDE, TextEditor } from "@cursorless/lib-common"; -import { type Snippets } from "@cursorless/lib-engine"; +import type { Snippets } from "@cursorless/lib-engine"; +import { isEexistError } from "@cursorless/lib-node-common"; export class VscodeSnippets implements Snippets { constructor(private ide: IDE) {} @@ -20,10 +21,10 @@ async function createNewFile(path: string) { try { const file = await open(path, "wx"); await file.close(); - } catch (e) { - if (e instanceof Error && "code" in e && e.code === "EEXIST") { - throw new Error(`Snippet file already exists: ${path}`, { cause: e }); + } catch (error) { + if (isEexistError(error)) { + throw new Error(`Snippet file already exists: ${path}`, { cause: error }); } - throw e; + throw error; } } diff --git a/packages/app-vscode/src/VscodeTutorial.ts b/packages/app-vscode/src/VscodeTutorial.ts index 363ea1393bc..39f223524b5 100644 --- a/packages/app-vscode/src/VscodeTutorial.ts +++ b/packages/app-vscode/src/VscodeTutorial.ts @@ -113,6 +113,9 @@ export class VscodeTutorial implements WebviewViewProvider { case "next": void this.next(); break; + default: { + throw new Error(`Unknown message type: ${data.type}`); + } } }); } diff --git a/packages/app-vscode/src/constructTestHelpers.ts b/packages/app-vscode/src/constructTestHelpers.ts index ebe6385acfb..e2e82805762 100644 --- a/packages/app-vscode/src/constructTestHelpers.ts +++ b/packages/app-vscode/src/constructTestHelpers.ts @@ -40,7 +40,7 @@ export function constructTestHelpers( loadLanguage: (languageId: string) => Promise, ): VscodeTestHelpers | undefined { return { - commandServerApi: commandServerApi!, + commandServerApi, ide: normalizedIde, injectIde, loadLanguage, diff --git a/packages/app-vscode/src/createScopeVisualizer.ts b/packages/app-vscode/src/createScopeVisualizer.ts index 35ea8bb7aec..02db5fc20d5 100644 --- a/packages/app-vscode/src/createScopeVisualizer.ts +++ b/packages/app-vscode/src/createScopeVisualizer.ts @@ -5,10 +5,8 @@ import type { ScopeProvider, ScopeType, } from "@cursorless/lib-common"; -import { - type VscodeScopeVisualizer, - createVscodeScopeVisualizer, -} from "./ide/vscode/VSCodeScopeVisualizer"; +import { createVscodeScopeVisualizer } from "./ide/vscode/VSCodeScopeVisualizer"; +import type { VscodeScopeVisualizer } from "./ide/vscode/VSCodeScopeVisualizer"; import type { ScopeVisualizer, ScopeVisualizerListener, diff --git a/packages/app-vscode/src/extension.ts b/packages/app-vscode/src/extension.ts index 1fba600d7a7..44c5d4fe5b5 100644 --- a/packages/app-vscode/src/extension.ts +++ b/packages/app-vscode/src/extension.ts @@ -127,6 +127,7 @@ export async function activate( revisualizeOnCustomRegexChange(scopeVisualizer, scopeProvider), ); + // oxlint-disable-next-line no-new new ScopeTreeProvider( normalizedIde, vscodeApi, diff --git a/packages/app-vscode/src/ide/vscode/VSCodeScopeVisualizer/VscodeFancyRangeHighlighter/generateDifferentiatedRanges.ts b/packages/app-vscode/src/ide/vscode/VSCodeScopeVisualizer/VscodeFancyRangeHighlighter/generateDifferentiatedRanges.ts index 636b9149508..ec0b2734d75 100644 --- a/packages/app-vscode/src/ide/vscode/VSCodeScopeVisualizer/VscodeFancyRangeHighlighter/generateDifferentiatedRanges.ts +++ b/packages/app-vscode/src/ide/vscode/VSCodeScopeVisualizer/VscodeFancyRangeHighlighter/generateDifferentiatedRanges.ts @@ -67,12 +67,13 @@ function getDifferentiationIndex( : maxContainingDifferentiationIndex + 1; for (; ; i++) { + const index = i; if ( !currentRanges.some( - ({ differentiationIndex }) => differentiationIndex === i, + ({ differentiationIndex }) => differentiationIndex === index, ) ) { - return i; + return index; } } } diff --git a/packages/app-vscode/src/ide/vscode/VSCodeScopeVisualizer/VscodeScopeVisualizer.ts b/packages/app-vscode/src/ide/vscode/VSCodeScopeVisualizer/VscodeScopeVisualizer.ts index c051595cad0..89bce2b34ae 100644 --- a/packages/app-vscode/src/ide/vscode/VSCodeScopeVisualizer/VscodeScopeVisualizer.ts +++ b/packages/app-vscode/src/ide/vscode/VSCodeScopeVisualizer/VscodeScopeVisualizer.ts @@ -59,16 +59,21 @@ export abstract class VscodeScopeVisualizer { return; } - switch (this.getScopeSupport(editor)) { + const scopeSupport = this.getScopeSupport(editor); + switch (scopeSupport) { case ScopeSupport.supportedAndPresentInEditor: case ScopeSupport.supportedButNotPresentInEditor: - return; + break; case ScopeSupport.unsupported: void showError( this.ide.messages, "ScopeVisualizer.scopeTypeNotSupported", `Scope type not supported for ${editor.document.languageId}. See ${DOCS_URL}/contributing/adding-a-new-language for more about how to update your language.`, ); + break; + default: { + const _exhaustiveCheck: never = scopeSupport; + } } } diff --git a/packages/app-vscode/src/ide/vscode/VSCodeScopeVisualizer/createVscodeScopeVisualizer.ts b/packages/app-vscode/src/ide/vscode/VSCodeScopeVisualizer/createVscodeScopeVisualizer.ts index 5304c617bd1..5e769f83733 100644 --- a/packages/app-vscode/src/ide/vscode/VSCodeScopeVisualizer/createVscodeScopeVisualizer.ts +++ b/packages/app-vscode/src/ide/vscode/VSCodeScopeVisualizer/createVscodeScopeVisualizer.ts @@ -19,5 +19,6 @@ export function createVscodeScopeVisualizer( return new VscodeScopeRemovalVisualizer(ide, scopeProvider, scopeType); case "iteration": return new VscodeIterationScopeVisualizer(ide, scopeProvider, scopeType); + // No default } } diff --git a/packages/app-vscode/src/ide/vscode/VscodeConfiguration.ts b/packages/app-vscode/src/ide/vscode/VscodeConfiguration.ts index 90cf32c8fad..a4488d43fdc 100644 --- a/packages/app-vscode/src/ide/vscode/VscodeConfiguration.ts +++ b/packages/app-vscode/src/ide/vscode/VscodeConfiguration.ts @@ -17,7 +17,7 @@ type TranslatorMap = { }; const translators: TranslatorMap = { - ["experimental.hatStability"]: (value: string) => { + "experimental.hatStability": (value: string) => { return HatStability[value as keyof typeof HatStability]; }, }; @@ -59,14 +59,14 @@ export default class VscodeConfiguration implements Configuration { */ export function vscodeGetConfigurationString(path: string): string | undefined { const index = path.lastIndexOf("."); - const section = path.substring(0, index); - const field = path.substring(index + 1); + const section = path.slice(0, index); + const field = path.slice(index + 1); const value = vscode.workspace.getConfiguration(section).get(field); return value != null ? evaluateStringVariables(value) : undefined; } function evaluateStringVariables(value: string): string { - return value.replace(/\${(\w+)}/g, (match, variable) => { + return value.replaceAll(/\${(\w+)}/g, (match, variable) => { switch (variable) { case "userHome": return os.homedir(); diff --git a/packages/app-vscode/src/ide/vscode/VscodeEnabledHatStyleManager.ts b/packages/app-vscode/src/ide/vscode/VscodeEnabledHatStyleManager.ts index 1980f3da1f5..03fea0cd332 100644 --- a/packages/app-vscode/src/ide/vscode/VscodeEnabledHatStyleManager.ts +++ b/packages/app-vscode/src/ide/vscode/VscodeEnabledHatStyleManager.ts @@ -46,7 +46,7 @@ export default class VscodeEnabledHatStyleManager { return this.notifier.registerListener(listener); } - private async recomputeEnabledHatStyles() { + private recomputeEnabledHatStyles() { this.constructHatStyleMap(); this.notifier.notifyListeners(this.hatStyleMap); } diff --git a/packages/app-vscode/src/ide/vscode/VscodeFileSystem.ts b/packages/app-vscode/src/ide/vscode/VscodeFileSystem.ts index 2a79ba70277..6e86112d141 100644 --- a/packages/app-vscode/src/ide/vscode/VscodeFileSystem.ts +++ b/packages/app-vscode/src/ide/vscode/VscodeFileSystem.ts @@ -6,6 +6,7 @@ import type { PathChangeListener, RunMode, } from "@cursorless/lib-common"; +import { isErrnoException } from "@cursorless/lib-node-common"; export class VscodeFileSystem implements FileSystem { public readonly cursorlessTalonStateJsonPath: string; @@ -30,8 +31,8 @@ export class VscodeFileSystem implements FileSystem { await vscode.workspace.fs.createDirectory( vscode.Uri.file(this.cursorlessDir), ); - } catch (err) { - console.log("Cannot create cursorlessDir", this.cursorlessDir, err); + } catch (error) { + console.log("Cannot create cursorlessDir", this.cursorlessDir, error); } } @@ -51,15 +52,11 @@ export class VscodeFileSystem implements FileSystem { return this.decoder.decode( await vscode.workspace.fs.readFile(this.resolveBundledPath(path)), ); - } catch (err) { - if ( - err instanceof Error && - "code" in err && - err.code === "FileNotFound" - ) { + } catch (error) { + if (isErrnoException(error) && error.code === "FileNotFound") { return undefined; } - throw err; + throw error; } } diff --git a/packages/app-vscode/src/ide/vscode/VscodeFlashHandler.ts b/packages/app-vscode/src/ide/vscode/VscodeFlashHandler.ts index c13636810f4..e580d1b2f47 100644 --- a/packages/app-vscode/src/ide/vscode/VscodeFlashHandler.ts +++ b/packages/app-vscode/src/ide/vscode/VscodeFlashHandler.ts @@ -32,10 +32,10 @@ export default class VscodeFlashHandler { ); } - private async setDecorationRanges( + private setDecorationRanges( style: FlashStyle, ranges: EditorGeneralizedRange[], - ): Promise { + ): void { const editorRangeMap = groupBy(ranges, ({ editor }) => editor.id); this.ide.visibleTextEditors.forEach((editor) => { diff --git a/packages/app-vscode/src/ide/vscode/VscodeFold.ts b/packages/app-vscode/src/ide/vscode/VscodeFold.ts index e4db9ebaf2d..3786c954a82 100644 --- a/packages/app-vscode/src/ide/vscode/VscodeFold.ts +++ b/packages/app-vscode/src/ide/vscode/VscodeFold.ts @@ -3,7 +3,7 @@ import type { Range } from "@cursorless/lib-common"; import type { VscodeIDE } from "./VscodeIDE"; import type { VscodeTextEditor } from "./VscodeTextEditor"; -export async function vscodeFold( +export function vscodeFold( ide: VscodeIDE, editor: VscodeTextEditor, ranges: Range[] | undefined, @@ -33,7 +33,7 @@ async function foldOrUnfold( // Don't mix multi and single line targets. // This is probably the result of an "every" command // and folding the single line targets will fold the parent as well - ranges = multiLineRanges.length ? multiLineRanges : singleLineRanges; + ranges = multiLineRanges.length > 0 ? multiLineRanges : singleLineRanges; const originalEditor = ide.activeEditableTextEditor; diff --git a/packages/app-vscode/src/ide/vscode/VscodeHighlights.ts b/packages/app-vscode/src/ide/vscode/VscodeHighlights.ts index d7eb4bea8ee..f024c9bbc46 100644 --- a/packages/app-vscode/src/ide/vscode/VscodeHighlights.ts +++ b/packages/app-vscode/src/ide/vscode/VscodeHighlights.ts @@ -48,11 +48,11 @@ export default class VscodeHighlights { ); } - async setHighlightRanges( + setHighlightRanges( style: VscodeStyle, editor: VscodeTextEditor, ranges: GeneralizedRange[], - ) { + ): void { const [lineRanges, tokenRanges] = partition( ranges, isLineRange, diff --git a/packages/app-vscode/src/ide/vscode/VscodeIDE.ts b/packages/app-vscode/src/ide/vscode/VscodeIDE.ts index 30b20fbd09c..40463f312f8 100644 --- a/packages/app-vscode/src/ide/vscode/VscodeIDE.ts +++ b/packages/app-vscode/src/ide/vscode/VscodeIDE.ts @@ -18,7 +18,10 @@ import type { TextDocumentChangeEvent, TextEditor, } from "@cursorless/lib-common"; -import { OutdatedExtensionError } from "@cursorless/lib-common"; +import { + getErrorMessage, + OutdatedExtensionError, +} from "@cursorless/lib-common"; import { fromVscodeRange, fromVscodeSelection, @@ -74,11 +77,12 @@ export class VscodeIDE implements IDE { highlightId == null ? HighlightStyle.highlight0 : HighlightStyle[highlightId as keyof typeof HighlightStyle]; - return this.highlights.setHighlightRanges( + this.highlights.setHighlightRanges( vscodeHighlightId, editor as VscodeTextEditor, ranges, ); + return Promise.resolve(); } flashRanges(flashDescriptors: FlashDescriptor[]): Promise { @@ -216,17 +220,17 @@ export class VscodeIDE implements IDE { return this.editorMap.get(editor)!; } - handleCommandError(err: Error) { - if (err instanceof OutdatedExtensionError) { - void this.showUpdateExtensionErrorMessage(err); + handleCommandError(error: unknown) { + if (error instanceof OutdatedExtensionError) { + void this.showUpdateExtensionErrorMessage(error); } else { - void vscode.window.showErrorMessage(err.message); + void vscode.window.showErrorMessage(getErrorMessage(error)); } } - private async showUpdateExtensionErrorMessage(err: OutdatedExtensionError) { + private async showUpdateExtensionErrorMessage(error: OutdatedExtensionError) { const item = await vscode.window.showErrorMessage( - err.message, + error.message, "Check for updates", ); diff --git a/packages/app-vscode/src/ide/vscode/VscodeMessages.ts b/packages/app-vscode/src/ide/vscode/VscodeMessages.ts index 11894d22042..0a3e9554015 100644 --- a/packages/app-vscode/src/ide/vscode/VscodeMessages.ts +++ b/packages/app-vscode/src/ide/vscode/VscodeMessages.ts @@ -16,6 +16,7 @@ export default class VscodeMessages implements Messages { return await window.showWarningMessage(message, ...options); case MessageType.error: return await window.showErrorMessage(message, ...options); + // No default } } } diff --git a/packages/app-vscode/src/ide/vscode/VscodeOpenLink.ts b/packages/app-vscode/src/ide/vscode/VscodeOpenLink.ts index 895907b0aa8..2be5a6a86a0 100644 --- a/packages/app-vscode/src/ide/vscode/VscodeOpenLink.ts +++ b/packages/app-vscode/src/ide/vscode/VscodeOpenLink.ts @@ -33,7 +33,7 @@ export default async function vscodeOpenLink( try { await openLink(filteredLinks[0], openAside); - } catch (_err) { + } catch { // Fallback to moving cursor and running open link command await runCommandAtRange(editor, "editor.action.openLink", range); } diff --git a/packages/app-vscode/src/ide/vscode/VscodeRevealLine.ts b/packages/app-vscode/src/ide/vscode/VscodeRevealLine.ts index 06b8534dc0c..17fd67839fd 100644 --- a/packages/app-vscode/src/ide/vscode/VscodeRevealLine.ts +++ b/packages/app-vscode/src/ide/vscode/VscodeRevealLine.ts @@ -14,11 +14,6 @@ export async function vscodeRevealLine( await vscode.commands.executeCommand("revealLine", { lineNumber, - at: - at === RevealLineAt.top - ? "top" - : at === RevealLineAt.bottom - ? "bottom" - : "center", + at, }); } diff --git a/packages/app-vscode/src/ide/vscode/VscodeTextEditor.ts b/packages/app-vscode/src/ide/vscode/VscodeTextEditor.ts index 8377bebd061..dd1e4850ba7 100644 --- a/packages/app-vscode/src/ide/vscode/VscodeTextEditor.ts +++ b/packages/app-vscode/src/ide/vscode/VscodeTextEditor.ts @@ -125,8 +125,9 @@ export class VscodeTextEditor implements EditableTextEditor { return this.id === other.id; } - public async revealRange(range: Range): Promise { + public revealRange(range: Range): Promise { this.editor.revealRange(toVscodeRange(range)); + return Promise.resolve(); } public revealLine(lineNumber: number, at: RevealLineAt): Promise { diff --git a/packages/app-vscode/src/ide/vscode/hats/VscodeHatRenderer.ts b/packages/app-vscode/src/ide/vscode/hats/VscodeHatRenderer.ts index 223bedce04d..9bfa656a3cb 100644 --- a/packages/app-vscode/src/ide/vscode/hats/VscodeHatRenderer.ts +++ b/packages/app-vscode/src/ide/vscode/hats/VscodeHatRenderer.ts @@ -1,20 +1,20 @@ import * as fs from "node:fs/promises"; import * as path from "node:path"; -import { cloneDeep, isEqual } from "lodash-es"; +import { isEqual } from "lodash-es"; import * as vscode from "vscode"; import type { Listener, Messages, PathChangeListener, } from "@cursorless/lib-common"; -import { Notifier } from "@cursorless/lib-common"; +import { getErrorMessage, Notifier } from "@cursorless/lib-common"; import { walkFiles } from "@cursorless/lib-node-common"; import type { VscodeApi } from "@cursorless/lib-vscode-common"; import type { HatShape, VscodeHatStyleName } from "../hatStyles.types"; import { HAT_SHAPES } from "../hatStyles.types"; import { vscodeGetConfigurationString } from "../VscodeConfiguration"; -import type { ExtendedHatStyleMap } from "../VscodeEnabledHatStyleManager"; import type VscodeEnabledHatStyleManager from "../VscodeEnabledHatStyleManager"; +import type { ExtendedHatStyleMap } from "../VscodeEnabledHatStyleManager"; import type { FontMeasurements } from "./FontMeasurements"; import getHatThemeColors from "./getHatThemeColors"; import { performPr1868ShapeUpdateInit } from "./performPr1868ShapeUpdateInit"; @@ -63,7 +63,7 @@ interface SvgInfo { export default class VscodeHatRenderer { private decorationMap!: HatDecorationMap; private disposables: vscode.Disposable[] = []; - private notifier: Notifier<[]> = new Notifier(); + private notifier: Notifier = new Notifier(); private lastSeenEnabledHatStyles: ExtendedHatStyleMap = {}; private hatsDirWatcherDisposable?: vscode.Disposable; private hatShapeOverrides: Record = {}; @@ -110,7 +110,7 @@ export default class VscodeHatRenderer { await this.recomputeDecorations(); } - registerListener(listener: Listener<[]>) { + registerListener(listener: Listener) { return this.notifier.registerListener(listener); } @@ -140,8 +140,8 @@ export default class VscodeHatRenderer { this.hatsDirWatcherDisposable = watchDir(hatsDir, () => this.updateShapeOverrides(hatsDir), ); - } catch (e) { - console.error("cannot watch hatsDir", hatsDir, e); + } catch (error) { + console.error("cannot watch hatsDir", hatsDir, error); } } else { this.hatShapeOverrides = {}; @@ -169,9 +169,9 @@ export default class VscodeHatRenderer { return await walkFiles(hatShapesDir, CURSORLESS_HAT_SHAPES_SUFFIX); } catch (error) { void vscode.window.showErrorMessage( - `Error with cursorless hat shapes dir "${hatShapesDir}": ${ - (error as Error).message - }`, + `Error with cursorless hat shapes dir "${hatShapesDir}": ${getErrorMessage( + error, + )}`, ); return []; } @@ -299,7 +299,7 @@ export default class VscodeHatRenderer { ), ); - this.lastSeenEnabledHatStyles = cloneDeep( + this.lastSeenEnabledHatStyles = structuredClone( this.enabledHatStyles.hatStyleMap, ); } @@ -337,9 +337,9 @@ export default class VscodeHatRenderer { // so that you can be notified if/when it changes or is removed. const [fill, stroke] = color.split("-"); let svg = originalSvg - .replace(/fill="(?!none)[^"]+"/g, `fill="${fill}"`) - .replace(/fill:(?!none)[^;]+;/g, `fill:${fill};`) - .replace(/\r?\n/g, " "); + .replaceAll(/fill="(?!none)[^"]+"/g, `fill="${fill}"`) + .replaceAll(/fill:(?!none)[^;]+;/g, `fill:${fill};`) + .replaceAll(/\r?\n/g, " "); if (stroke !== undefined) { svg = this.addInnerStrokeToSvg(svgInfo, svg, stroke); } @@ -484,7 +484,7 @@ export default class VscodeHatRenderer { Number.isNaN(originalViewBoxWidth) || Number.isNaN(originalViewBoxHeight) ) { - throw new Error(`Invalid viewBox dimensions: ${viewBoxValue}`); + throw new TypeError(`Invalid viewBox dimensions: ${viewBoxValue}`); } return { originalViewBoxHeight, originalViewBoxWidth }; @@ -498,11 +498,11 @@ export default class VscodeHatRenderer { } function watchDir( - path: string, + dirPath: string, onDidChange: PathChangeListener, ): vscode.Disposable { const hatsDirWatcher = vscode.workspace.createFileSystemWatcher( - new vscode.RelativePattern(path, `**/*${CURSORLESS_HAT_SHAPES_SUFFIX}`), + new vscode.RelativePattern(dirPath, `**/*${CURSORLESS_HAT_SHAPES_SUFFIX}`), ); hatsDirWatcher.onDidChange(onDidChange); diff --git a/packages/app-vscode/src/keyboard/KeyboardCommandTypeHelpers.ts b/packages/app-vscode/src/keyboard/KeyboardCommandTypeHelpers.ts index ab22202f4d5..9cf4a10debd 100644 --- a/packages/app-vscode/src/keyboard/KeyboardCommandTypeHelpers.ts +++ b/packages/app-vscode/src/keyboard/KeyboardCommandTypeHelpers.ts @@ -29,7 +29,9 @@ export type KeyboardCommand = { // may look backwards, because the arg type is contravariant, so the 'extends' // needs to be flipped. // oxlint-disable-next-line @typescript-eslint/no-unused-vars -function assertExtends() {} +function assertExtends() { + // No-op +} // oxlint-disable-next-line @typescript-eslint/no-unused-expressions assertExtends< Record never>, diff --git a/packages/app-vscode/src/keyboard/KeyboardCommandsModal.ts b/packages/app-vscode/src/keyboard/KeyboardCommandsModal.ts index b2250cbd440..c3122fc0097 100644 --- a/packages/app-vscode/src/keyboard/KeyboardCommandsModal.ts +++ b/packages/app-vscode/src/keyboard/KeyboardCommandsModal.ts @@ -1,7 +1,7 @@ import { pick, sortedUniq, toPairs } from "lodash-es"; import nearley from "nearley"; import * as vscode from "vscode"; -import { CompositeKeyMap } from "@cursorless/lib-common"; +import { CompositeKeyMap, getErrorMessage } from "@cursorless/lib-common"; import type { VscodeApi } from "@cursorless/lib-vscode-common"; import { getTokenTypeKeyMaps } from "./getTokenTypeKeyMaps"; import grammar from "./grammar/generated/grammar"; @@ -186,10 +186,10 @@ export default class KeyboardCommandsModal { void this.keyboardCommandHandler[type as keyof KeyboardCommandHandler]( arg, ); - } catch (err) { - if (!(err instanceof KeySequenceCancelledError)) { - void vscode.window.showErrorMessage((err as Error).message); - throw err; + } catch (error) { + if (!(error instanceof KeySequenceCancelledError)) { + void vscode.window.showErrorMessage(getErrorMessage(error)); + throw error; } } finally { // Always reset the parser when we're done @@ -212,9 +212,8 @@ export default class KeyboardCommandsModal { modeToggle = () => { if (this.isModeOn()) { return this.modeOff(); - } else { - return this.modeOn(); } + return this.modeOn(); }; private isModeOn() { @@ -225,5 +224,6 @@ export default class KeyboardCommandsModal { class KeySequenceCancelledError extends Error { constructor() { super("Key sequence cancelled"); + this.name = "KeySequenceCancelledError"; } } diff --git a/packages/app-vscode/src/keyboard/KeyboardCommandsTargeted.ts b/packages/app-vscode/src/keyboard/KeyboardCommandsTargeted.ts index a6da9f6e37b..dd7419c5f5b 100644 --- a/packages/app-vscode/src/keyboard/KeyboardCommandsTargeted.ts +++ b/packages/app-vscode/src/keyboard/KeyboardCommandsTargeted.ts @@ -133,6 +133,7 @@ export default class KeyboardCommandsTargeted { }; case "replace": return target; + // No default } } @@ -180,7 +181,7 @@ export default class KeyboardCommandsTargeted { * @param name The action to run * @returns A promise that resolves to the result of the cursorless command */ - performSimpleActionOnTarget = async ({ + performSimpleActionOnTarget = ({ actionId: name, exitCursorlessMode, }: SimpleKeyboardActionDescriptor) => { diff --git a/packages/app-vscode/src/keyboard/KeyboardConfig.ts b/packages/app-vscode/src/keyboard/KeyboardConfig.ts index 11b4904520a..9a2edab4916 100644 --- a/packages/app-vscode/src/keyboard/KeyboardConfig.ts +++ b/packages/app-vscode/src/keyboard/KeyboardConfig.ts @@ -20,9 +20,9 @@ const cursorStyleMap = { line: TextEditorCursorStyle.Line, block: TextEditorCursorStyle.Block, underline: TextEditorCursorStyle.Underline, - ["line-thin"]: TextEditorCursorStyle.LineThin, - ["block-outline"]: TextEditorCursorStyle.BlockOutline, - ["underline-thin"]: TextEditorCursorStyle.UnderlineThin, + "line-thin": TextEditorCursorStyle.LineThin, + "block-outline": TextEditorCursorStyle.BlockOutline, + "underline-thin": TextEditorCursorStyle.UnderlineThin, } satisfies Record; export class KeyboardConfig { diff --git a/packages/app-vscode/src/keyboard/KeyboardHandler.ts b/packages/app-vscode/src/keyboard/KeyboardHandler.ts index 06877ac27d0..d142bd81e4b 100644 --- a/packages/app-vscode/src/keyboard/KeyboardHandler.ts +++ b/packages/app-vscode/src/keyboard/KeyboardHandler.ts @@ -149,7 +149,7 @@ export default class KeyboardHandler { // Call handleCancelled on all listeners that were pushed after this // one. Eg if you're in the middle of typing a command and we turn off // the modal mode, we want to cancel the command - if (index > -1) { + if (index !== -1) { this.listeners .slice(index + 1) .reverse() @@ -200,9 +200,10 @@ export default class KeyboardHandler { const disposable = this.pushListener({ displayOptions, - async handleInput(text: string) { + handleInput(text: string) { disposable.dispose(); resolve(text); + return Promise.resolve(); }, handleCancelled() { diff --git a/packages/app-vscode/src/keyboard/buildSuffixTrie.ts b/packages/app-vscode/src/keyboard/buildSuffixTrie.ts index b6649367d40..75f4667c5dc 100644 --- a/packages/app-vscode/src/keyboard/buildSuffixTrie.ts +++ b/packages/app-vscode/src/keyboard/buildSuffixTrie.ts @@ -40,7 +40,7 @@ export function buildSuffixTrie(entries: [string, T][]): BuildTrieReturn { * including {@link entries} themselves, which have `isTopLevel: true` */ const candidateEntries = entries.flatMap(([fullKey, value]) => range(fullKey.length).map((i) => { - const key = fullKey.substring(i); + const key = fullKey.slice(i); return { isTopLevel: fullKey === key, key, diff --git a/packages/app-vscode/src/keyboard/grammar/getAcceptableTokenTypes.ts b/packages/app-vscode/src/keyboard/grammar/getAcceptableTokenTypes.ts index 0cb72a9c830..f5248feaf95 100644 --- a/packages/app-vscode/src/keyboard/grammar/getAcceptableTokenTypes.ts +++ b/packages/app-vscode/src/keyboard/grammar/getAcceptableTokenTypes.ts @@ -106,11 +106,12 @@ function computeRootStatePartialArgs( let partialArg: any; try { const argList = [...getCompletedSymbols(state), lastSymbol]; + // oxlint-disable-next-line unicorn/no-immediate-mutation argList.push( ...times(state.rule.symbols.length - argList.length, () => MISSING), ); partialArg = state.rule.postprocess?.(argList) ?? argList; - } catch (_err) { + } catch { // If we can't construct the partial argument because the rule's postprocess // wasn't designed to handle partial arguments, then we just replace it with // MISSING diff --git a/packages/app-vscode/src/logQuickActions.ts b/packages/app-vscode/src/logQuickActions.ts index e5d3c6b81b9..3d32d309298 100644 --- a/packages/app-vscode/src/logQuickActions.ts +++ b/packages/app-vscode/src/logQuickActions.ts @@ -17,21 +17,22 @@ export async function logQuickActions(kind?: string) { return; } - const availableCodeActions = ( - await commands.executeCommand( - "vscode.executeCodeActionProvider", - editor.document.uri, - editor.selections[0], - kind, - ) - ).map(({ title, kind, isPreferred }) => ({ - title, - kind: kind?.value, - isPreferred, - })); + const codeActions = await commands.executeCommand( + "vscode.executeCodeActionProvider", + editor.document.uri, + editor.selections[0], + kind, + ); + const availableCodeActions = codeActions.map( + ({ title, kind, isPreferred }) => ({ + title, + kind: kind?.value, + isPreferred, + }), + ); availableCodeActions.forEach((availableCodeAction) => { - console.log(`${JSON.stringify(availableCodeAction, null, 2)}`); + console.log(JSON.stringify(availableCodeAction, null, 2)); }); void window.showInformationMessage( diff --git a/packages/app-vscode/src/registerCommands.ts b/packages/app-vscode/src/registerCommands.ts index 77f64a4f44e..04b4c5329f6 100644 --- a/packages/app-vscode/src/registerCommands.ts +++ b/packages/app-vscode/src/registerCommands.ts @@ -8,6 +8,7 @@ import { CURSORLESS_COMMAND_ID } from "@cursorless/lib-common"; import type { CommandApi, StoredTargetMap } from "@cursorless/lib-engine"; import { analyzeCommandHistory } from "@cursorless/lib-engine"; import { showCheatsheet, updateDefaults } from "@cursorless/lib-node-common"; +import type { CheatSheetCommandArg } from "@cursorless/lib-node-common"; import type { ScopeTestRecorder, TestCaseRecorder, @@ -45,57 +46,59 @@ export function registerCommands( const runCommandWrapper = async (run: () => Promise) => { try { return await run(); - } catch (e) { + } catch (error) { if (vscodeIde.runMode !== "test") { - const err = e as Error; - console.error(err.stack); - vscodeIde.handleCommandError(err); + if (error instanceof Error) { + console.error(error.stack); + } + vscodeIde.handleCommandError(error); } - throw e; + throw error; } }; const commands: Record any> = { // The core Cursorless command - [CURSORLESS_COMMAND_ID]: async (...args: unknown[]) => { + [CURSORLESS_COMMAND_ID]: (...args: unknown[]) => { return runCommandWrapper(() => commandApi.runCommandSafe(...args)); }, - ["cursorless.repeatPreviousCommand"]: async () => { + "cursorless.repeatPreviousCommand": () => { return runCommandWrapper(() => commandApi.repeatPreviousCommand()); }, // Cheatsheet commands - ["cursorless.showCheatsheet"]: (arg) => showCheatsheet(vscodeIde, arg), - ["cursorless.internal.updateCheatsheetDefaults"]: updateDefaults, + "cursorless.showCheatsheet": (arg: CheatSheetCommandArg) => + showCheatsheet(vscodeIde, arg), + "cursorless.internal.updateCheatsheetDefaults": updateDefaults, // Testcase recorder commands - ["cursorless.recordTestCase"]: testCaseRecorder.toggle, - ["cursorless.recordOneTestCaseThenPause"]: + "cursorless.recordTestCase": testCaseRecorder.toggle, + "cursorless.recordOneTestCaseThenPause": testCaseRecorder.recordOneThenPause, - ["cursorless.pauseRecording"]: testCaseRecorder.pause, - ["cursorless.resumeRecording"]: testCaseRecorder.resume, - ["cursorless.takeSnapshot"]: testCaseRecorder.takeSnapshot, + "cursorless.pauseRecording": testCaseRecorder.pause, + "cursorless.resumeRecording": testCaseRecorder.resume, + "cursorless.takeSnapshot": testCaseRecorder.takeSnapshot, // Scope test recorder commands - ["cursorless.recordScopeTests.showUnimplementedFacets"]: + "cursorless.recordScopeTests.showUnimplementedFacets": scopeTestRecorder.showUnimplementedFacets, - ["cursorless.recordScopeTests.saveActiveDocument"]: + "cursorless.recordScopeTests.saveActiveDocument": scopeTestRecorder.saveActiveDocument, // Other commands - ["cursorless.showQuickPick"]: showQuickPick, - ["cursorless.showDocumentation"]: showDocumentation, - ["cursorless.showInstallationDependencies"]: installationDependencies.show, + "cursorless.showQuickPick": showQuickPick, + "cursorless.showDocumentation": showDocumentation, + "cursorless.showInstallationDependencies": installationDependencies.show, - ["cursorless.private.logQuickActions"]: logQuickActions, + "cursorless.private.logQuickActions": logQuickActions, // Hats - ["cursorless.toggleDecorations"]: hats.toggle, - ["cursorless.recomputeDecorationStyles"]: hats.recomputeDecorationStyles, + "cursorless.toggleDecorations": hats.toggle, + "cursorless.recomputeDecorationStyles": hats.recomputeDecorationStyles, // Scope visualizer - ["cursorless.showScopeVisualizer"]: ( + "cursorless.showScopeVisualizer": ( scopeType?: ScopeType, visualizationType?: VisualizationType, ) => { @@ -104,49 +107,48 @@ export function registerCommands( } scopeVisualizer.start(scopeType, visualizationType); }, - ["cursorless.hideScopeVisualizer"]: scopeVisualizer.stop, - ["cursorless.scopeVisualizer.openUrl"]: - showScopeVisualizerItemDocumentation, + "cursorless.hideScopeVisualizer": scopeVisualizer.stop, + "cursorless.scopeVisualizer.openUrl": showScopeVisualizerItemDocumentation, // Command history - ["cursorless.analyzeCommandHistory"]: () => + "cursorless.analyzeCommandHistory": () => analyzeCommandHistory(vscodeIde, commandHistoryStorage), // General keyboard commands - ["cursorless.keyboard.escape"]: + "cursorless.keyboard.escape": keyboardCommands.keyboardHandler.cancelActiveListener, // Targeted keyboard commands - ["cursorless.keyboard.targeted.targetHat"]: + "cursorless.keyboard.targeted.targetHat": keyboardCommands.targeted.targetDecoratedMark, - ["cursorless.keyboard.targeted.targetScope"]: + "cursorless.keyboard.targeted.targetScope": keyboardCommands.targeted.modifyTargetContainingScope, - ["cursorless.keyboard.targeted.targetSelection"]: + "cursorless.keyboard.targeted.targetSelection": keyboardCommands.targeted.targetSelection, - ["cursorless.keyboard.targeted.clearTarget"]: + "cursorless.keyboard.targeted.clearTarget": keyboardCommands.targeted.clearTarget, - ["cursorless.keyboard.targeted.runActionOnTarget"]: + "cursorless.keyboard.targeted.runActionOnTarget": keyboardCommands.targeted.performActionOnTarget, // Modal keyboard commands - ["cursorless.keyboard.modal.modeOn"]: keyboardCommands.modal.modeOn, - ["cursorless.keyboard.modal.modeOff"]: keyboardCommands.modal.modeOff, - ["cursorless.keyboard.modal.modeToggle"]: keyboardCommands.modal.modeToggle, - ["cursorless.keyboard.undoTarget"]: () => storedTargets.undo("keyboard"), - ["cursorless.keyboard.redoTarget"]: () => storedTargets.redo("keyboard"), + "cursorless.keyboard.modal.modeOn": keyboardCommands.modal.modeOn, + "cursorless.keyboard.modal.modeOff": keyboardCommands.modal.modeOff, + "cursorless.keyboard.modal.modeToggle": keyboardCommands.modal.modeToggle, + "cursorless.keyboard.undoTarget": () => storedTargets.undo("keyboard"), + "cursorless.keyboard.redoTarget": () => storedTargets.redo("keyboard"), // Tutorial commands - ["cursorless.tutorial.start"]: tutorial.start, - ["cursorless.tutorial.next"]: tutorial.next, - ["cursorless.tutorial.previous"]: tutorial.previous, - ["cursorless.tutorial.restart"]: tutorial.restart, - ["cursorless.tutorial.resume"]: tutorial.resume, - ["cursorless.tutorial.list"]: tutorial.list, - ["cursorless.documentationOpened"]: tutorial.documentationOpened, + "cursorless.tutorial.start": tutorial.start, + "cursorless.tutorial.next": tutorial.next, + "cursorless.tutorial.previous": tutorial.previous, + "cursorless.tutorial.restart": tutorial.restart, + "cursorless.tutorial.resume": tutorial.resume, + "cursorless.tutorial.list": tutorial.list, + "cursorless.documentationOpened": tutorial.documentationOpened, }; extensionContext.subscriptions.push( diff --git a/packages/app-vscode/src/scripts/hatAdjustments/lib.ts b/packages/app-vscode/src/scripts/hatAdjustments/lib.ts index edfc5aec2f8..ecd14ecc461 100644 --- a/packages/app-vscode/src/scripts/hatAdjustments/lib.ts +++ b/packages/app-vscode/src/scripts/hatAdjustments/lib.ts @@ -1,4 +1,4 @@ export function postProcessValue(value: number) { - value = Math.round(value * 10000) / 10000; + value = Math.round(value * 10_000) / 10_000; return value === 0 ? undefined : value; } diff --git a/packages/app-vscode/src/scripts/initLaunchSandbox.ts b/packages/app-vscode/src/scripts/initLaunchSandbox.ts index f232cbf07f2..eb4fc8e125b 100644 --- a/packages/app-vscode/src/scripts/initLaunchSandbox.ts +++ b/packages/app-vscode/src/scripts/initLaunchSandbox.ts @@ -1,4 +1,5 @@ import * as cp from "node:child_process"; +import { exit } from "node:process"; /** * This script creates a VSCode settings profile for Cursorless development, * allowing you to have a separate set of extensions and settings for use when @@ -7,7 +8,7 @@ import * as cp from "node:child_process"; import { extensionDependencies } from "@cursorless/lib-common"; const vsCodeToolName: string = "code"; -const validCliToolParams: Array = ["--code", "--codium"]; +const validCliToolParams = new Set(["--code", "--codium"]); async function main() { try { @@ -15,9 +16,9 @@ async function main() { let cliToolName = vsCodeToolName; process.argv.forEach((argument) => { - if (validCliToolParams.includes(argument)) { + if (validCliToolParams.has(argument)) { cliToolName = argument.replace("--", ""); - console.log("Cli tool name manually set to " + cliToolName); + console.log(`Cli tool name manually set to ${cliToolName}`); } }); @@ -64,11 +65,11 @@ async function main() { } }); }); - } catch (err) { + } catch (error) { console.error("Failed to init launch sandbox"); - console.error(err); - process.exit(1); + console.error(error); + exit(1); } } -void main(); +await main(); diff --git a/packages/app-vscode/src/scripts/populateDist/generateBuildInfo.ts b/packages/app-vscode/src/scripts/populateDist/generateBuildInfo.ts index c344fc97aa8..a614596faf8 100644 --- a/packages/app-vscode/src/scripts/populateDist/generateBuildInfo.ts +++ b/packages/app-vscode/src/scripts/populateDist/generateBuildInfo.ts @@ -15,9 +15,10 @@ export async function generateBuildInfo({ isCi }: Context) { const repository = getEnvironmentVariableStrict("GITHUB_REPOSITORY"); const runId = getEnvironmentVariableStrict("GITHUB_RUN_ID"); const githubBaseUrl = getEnvironmentVariableStrict("GITHUB_SERVER_URL"); + const gitSha = await runCommand("git rev-parse HEAD"); return JSON.stringify({ - gitSha: (await runCommand("git rev-parse HEAD")).trim(), + gitSha: gitSha.trim(), buildUrl: `${githubBaseUrl}/${repository}/actions/runs/${runId}`, }); } diff --git a/packages/app-vscode/src/scripts/populateDist/populateDist.ts b/packages/app-vscode/src/scripts/populateDist/populateDist.ts index 9c7b6feb674..17ccf07cead 100644 --- a/packages/app-vscode/src/scripts/populateDist/populateDist.ts +++ b/packages/app-vscode/src/scripts/populateDist/populateDist.ts @@ -11,7 +11,9 @@ import type { Context } from "./context"; export async function run() { const context: Context = { isForLocalInstall: process.argv.includes("--local-install"), + // oxlint-disable-next-line node/no-process-env isDeploy: "CURSORLESS_DEPLOY" in process.env, + // oxlint-disable-next-line node/no-process-env isCi: "CI" in process.env, }; @@ -73,8 +75,9 @@ export async function run() { } console.log(`Copying ${fullSource} to ${fullDestination}`); + const stat = await lstat(fullSource); // If directory, copy recursively - if ((await lstat(fullSource)).isDirectory()) { + if (stat.isDirectory()) { await rm(fullDestination, { recursive: true, force: true }); await mkdir(fullDestination, { recursive: true }); } diff --git a/packages/app-vscode/src/scripts/populateDist/transformPackageJson.ts b/packages/app-vscode/src/scripts/populateDist/transformPackageJson.ts index 39f751ad076..0e6cbe35f1a 100644 --- a/packages/app-vscode/src/scripts/populateDist/transformPackageJson.ts +++ b/packages/app-vscode/src/scripts/populateDist/transformPackageJson.ts @@ -15,7 +15,7 @@ export async function transformPackageJson( json.dependencies = []; json.devDependencies = { - ["@types/vscode"]: json.devDependencies["@types/vscode"], + "@types/vscode": json.devDependencies["@types/vscode"], }; delete json.private; @@ -24,11 +24,11 @@ export async function transformPackageJson( // During deployment, we change the package version so that the patch // number is the number of commits on the current branch const { major, minor } = semver.parse(json.version)!; - const commitCount = (await runCommand("git rev-list --count HEAD")).trim(); - json.version = `${major}.${minor}.${commitCount}`; + const commitCount = await runCommand("git rev-list --count HEAD"); + json.version = `${major}.${minor}.${commitCount.trim()}`; } else { - const gitSha = (await runCommand("git rev-parse --short HEAD")).trim(); - json.version = `${json.version}-${gitSha}`; + const gitSha = await runCommand("git rev-parse --short HEAD"); + json.version = `${json.version}-${gitSha.trim()}`; } return json; diff --git a/packages/app-vscode/src/scripts/preprocessSvgHats.ts b/packages/app-vscode/src/scripts/preprocessSvgHats.ts index 0706f92359d..be952363f43 100644 --- a/packages/app-vscode/src/scripts/preprocessSvgHats.ts +++ b/packages/app-vscode/src/scripts/preprocessSvgHats.ts @@ -34,11 +34,11 @@ async function main() { const outputSvg = dumper .build(svgJson) - .replace(/fill="(?!none)[^"]+"/g, 'fill="#666666"') - .replace(/fill:(?!none)[^;]+;/g, "fill:#666666;"); + .replaceAll(/fill="(?!none)[^"]+"/g, 'fill="#666666"') + .replaceAll(/fill:(?!none)[^;]+;/g, "fill:#666666;"); await fsp.writeFile(filePath, outputSvg); } } -void main(); +await main(); diff --git a/packages/app-web-docs/config/algolia/crawler-settings.js b/packages/app-web-docs/config/algolia/crawler-settings.js index 57665fc127c..2e5121f8ba7 100644 --- a/packages/app-web-docs/config/algolia/crawler-settings.js +++ b/packages/app-web-docs/config/algolia/crawler-settings.js @@ -1,5 +1,6 @@ /* global Crawler */ +// oxlint-disable-next-line no-new new Crawler({ rateLimit: 8, startUrls: ["https://www.cursorless.org/docs"], diff --git a/packages/app-web-docs/docusaurus.config.mts b/packages/app-web-docs/docusaurus.config.mts index e8101aedca2..d1845ff08e4 100644 --- a/packages/app-web-docs/docusaurus.config.mts +++ b/packages/app-web-docs/docusaurus.config.mts @@ -10,8 +10,8 @@ import { visit } from "unist-util-visit"; const require = createRequire(import.meta.url); const docsRelative = "packages/app-web-docs/src/docs/"; -const userRelative = docsRelative + "user"; -const contributingRelative = docsRelative + "contributing"; +const userRelative = `${docsRelative}user`; +const contributingRelative = `${docsRelative}contributing`; const repoLink = "https://github.com/cursorless-dev/cursorless/tree/main/"; /** @@ -47,8 +47,11 @@ function remarkPluginFixLinksToRepositoryArtifacts(): Transformer { "../..", ); const artifact = resolve(file.dirname!, url); - const artifactRelative = relative(repoRoot, artifact).replace(/\\/g, "/"); - const fileRelative = relative(repoRoot, file.path).replace(/\\/g, "/"); + const artifactRelative = relative(repoRoot, artifact).replaceAll( + "\\", + "/", + ); + const fileRelative = relative(repoRoot, file.path).replaceAll("\\", "/"); // We host all files under docs. Will resolve as a relative link, but // relative links pointing to a folder passing between user and @@ -59,7 +62,7 @@ function remarkPluginFixLinksToRepositoryArtifacts(): Transformer { isFolder(url) && passingBetweenUserAndContributing(fileRelative, artifactRelative) ) { - node.url = "/docs/" + artifactRelative.slice(docsRelative.length); + node.url = `/docs/${artifactRelative.slice(docsRelative.length)}`; } return; } @@ -191,7 +194,7 @@ const config: Config = { href: "https://github.com/cursorless-dev/cursorless", position: "right", className: "header-github-link", - ["aria-label"]: "GitHub repository", + "aria-label": "GitHub repository", }, ], }, diff --git a/packages/app-web-docs/sidebar.js b/packages/app-web-docs/sidebar.js index a3f8b9bc3c2..7da6acc93da 100644 --- a/packages/app-web-docs/sidebar.js +++ b/packages/app-web-docs/sidebar.js @@ -1,7 +1,9 @@ // @ts-check /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ -export default { +const config = { user: [{ type: "autogenerated", dirName: "user" }], contributing: [{ type: "autogenerated", dirName: "contributing" }], }; + +export default config; diff --git a/packages/app-web-docs/src/docs/components/Code.tsx b/packages/app-web-docs/src/docs/components/Code.tsx index 00b2a764c04..aede0948975 100644 --- a/packages/app-web-docs/src/docs/components/Code.tsx +++ b/packages/app-web-docs/src/docs/components/Code.tsx @@ -21,30 +21,34 @@ export function Code({ link, children, }: Props) { - const [html, setHtml] = React.useState(""); + const [html, setHtml] = React.useState<{ __html: string }>(); const [copied, setCopied] = useState(false); useEffect(() => { - const code = renderWhitespace - ? children.replaceAll(" ", "␣").replaceAll("\t", "⭾") - : children; - codeToHtml(code, { - lang: getFallbackLanguage(languageId), - theme: "nord", - decorations, - }) - .then((html) => { + (async () => { + const code = renderWhitespace + ? children.replaceAll(" ", "␣").replaceAll("\t", "⭾") + : children; + + try { + let html = await codeToHtml(code, { + lang: getFallbackLanguage(languageId), + theme: "nord", + decorations, + }); if (renderWhitespace) { html = html - .replace(/␣/g, '·') - .replace(/⭾/g, ' → '); + .replaceAll("␣", '·') + .replaceAll("⭾", ' → '); } - setHtml(html); - }) - .catch(console.error); + setHtml({ __html: html }); + } catch (error) { + console.error(error); + } + })(); }, [languageId, renderWhitespace, decorations, link, children]); - if (!html) { + if (html == null) { return
; } @@ -53,8 +57,8 @@ export function Code({ await navigator.clipboard.writeText(children); setCopied(true); setTimeout(() => setCopied(false), 1500); - } catch (err) { - console.error("Failed to copy!", err); + } catch (error) { + console.error("Failed to copy!", error); } }; @@ -77,10 +81,10 @@ export function Code({ return (
{renderLink()} - -
{" "} +
{" "}
); } diff --git a/packages/app-web-docs/src/docs/components/DynamicTOC.tsx b/packages/app-web-docs/src/docs/components/DynamicTOC.tsx index 9140b267fea..947219b169a 100644 --- a/packages/app-web-docs/src/docs/components/DynamicTOC.tsx +++ b/packages/app-web-docs/src/docs/components/DynamicTOC.tsx @@ -21,9 +21,9 @@ export function DynamicTOC({ // Remove existing TOC if it exists if (row.childNodes.length > 1) { - row.replaceChild(toc, row.childNodes[1]); + row.childNodes[1].replaceWith(toc); } else { - row.appendChild(toc); + row.append(toc); } }, [minHeadingLevel, maxHeadingLevel]); @@ -44,7 +44,7 @@ function getTOC(minHeadingLevel: number, maxHeadingLevel: number) { let indent = 0; getHeaderElements(minHeadingLevel, maxHeadingLevel).forEach((header) => { - const level = parseInt(header.tagName[1], 10); + const level = Number.parseInt(header.tagName[1], 10); if (level !== currentLevel) { if (currentLevel != null) { @@ -61,12 +61,12 @@ function getTOC(minHeadingLevel: number, maxHeadingLevel: number) { a.textContent = header.textContent; a.style.paddingLeft = `${indent}rem`; - li.appendChild(a); - ul.appendChild(li); + li.append(a); + ul.append(li); }); - toc.appendChild(ul); - col.appendChild(toc); + toc.append(ul); + col.append(toc); return col; } diff --git a/packages/app-web-docs/src/docs/components/Header.tsx b/packages/app-web-docs/src/docs/components/Header.tsx index e581e4f95e9..3b77324854d 100644 --- a/packages/app-web-docs/src/docs/components/Header.tsx +++ b/packages/app-web-docs/src/docs/components/Header.tsx @@ -29,6 +29,7 @@ function renderHeader( level: 2 | 3 | 4 | 5, { className, id, title, children }: Props, ): React.JSX.Element { + // oxlint-disable-next-line typescript/no-unnecessary-type-assertion const Tag = `h${level}` as "h2" | "h3" | "h4" | "h5"; const encodedId = uriEncodeHashId(id ?? children); return ( diff --git a/packages/app-web-docs/src/docs/components/ScopeVisualizer.tsx b/packages/app-web-docs/src/docs/components/ScopeVisualizer.tsx index 1e4d3bdde41..6726cc79f28 100644 --- a/packages/app-web-docs/src/docs/components/ScopeVisualizer.tsx +++ b/packages/app-web-docs/src/docs/components/ScopeVisualizer.tsx @@ -56,24 +56,6 @@ export function ScopeVisualizer({ languageId, scopeTypeType }: Props) { scopeTypeType != null, ); - const renderPublicScopesHeader = () => { - return

Scopes

; - }; - - const renderInternalScopesHeader = () => { - return ( - <> -

Internal scopes

- -

- The following are internal scopes. They are not intended for user - interaction or spoken use. These scopes exist solely for internal - Cursorless functionality. -

- - ); - }; - const renderOptions = () => { return (
@@ -182,6 +164,24 @@ function renderScope( ); } +function renderPublicScopesHeader() { + return

Scopes

; +} + +function renderInternalScopesHeader() { + return ( + <> +

Internal scopes

+ +

+ The following are internal scopes. They are not intended for user + interaction or spoken use. These scopes exist solely for internal + Cursorless functionality. +

+ + ); +} + function renderFacet( languageId: string | undefined, scopeTypeType: ScopeTypeType | undefined, @@ -230,6 +230,7 @@ function renderFacet( {renderLanguageId(fixture.languageId)} 1) { - parts[0] = parts[0] + ":"; + if (iterationIndex === -1 || iterationIndex > 1) { + parts[0] += ":"; parts[1] = capitalize(parts[1]); } diff --git a/packages/app-web-docs/src/plugins/scope-tests-plugin.ts b/packages/app-web-docs/src/plugins/scope-tests-plugin.ts index 812db729902..1b8a470f556 100644 --- a/packages/app-web-docs/src/plugins/scope-tests-plugin.ts +++ b/packages/app-web-docs/src/plugins/scope-tests-plugin.ts @@ -25,6 +25,7 @@ export default function prepareAssetsPlugin( loadContent(): ScopeTests { const repoRoot = path.join(__dirname, "../../../.."); + // oxlint-disable-next-line node/no-process-env process.env.CURSORLESS_REPO_ROOT = repoRoot; return prepareAssets(); }, @@ -66,7 +67,7 @@ function parseTest(test: ScopeTestPath) { } const code = fixture.slice(0, delimiterIndex - 1); - const lines = fixture.substring(delimiterIndex + 4).split(/\n/); + const lines = fixture.slice(delimiterIndex + 4).split(/\n/); const scopes: Scope[] = []; const unprocessedTypes: string[] = []; let currentScopeIndex = "1"; @@ -171,16 +172,16 @@ function parseLine(line: string) { return null; } - const header = line.substring(1, line.indexOf("]")); + const header = line.slice(1, line.indexOf("]")); const { scopeIndex, targetIndex, type } = (() => { if (header[0] === "#") { const spaceIndex = header.indexOf(" "); - const fullIndex = header.substring(1, spaceIndex); + const fullIndex = header.slice(1, spaceIndex); const [scopeIndex, targetIndex] = fullIndex.split("."); return { scopeIndex: scopeIndex, targetIndex: targetIndex, - type: header.substring(spaceIndex + 1), + type: header.slice(spaceIndex + 1), }; } return { @@ -190,7 +191,7 @@ function parseLine(line: string) { }; })(); - const rawValue = line.substring(line.indexOf("=") + 1).trim(); + const rawValue = line.slice(line.indexOf("=") + 1).trim(); const value = rawValue.length > 0 ? rawValue : undefined; return { scopeIndex, targetIndex, type, value }; diff --git a/packages/app-web-docs/src/theme/Root.tsx b/packages/app-web-docs/src/theme/Root.tsx index ef4fa92711d..97663ef68fb 100644 --- a/packages/app-web-docs/src/theme/Root.tsx +++ b/packages/app-web-docs/src/theme/Root.tsx @@ -3,17 +3,17 @@ import React, { useEffect } from "react"; function syncBootstrapTheme() { const root = document.documentElement; - const theme = root.getAttribute("data-theme"); + const theme = root.dataset.theme; if (theme == null) { - root.removeAttribute("data-bs-theme"); + delete root.dataset.bsTheme; return; } - root.setAttribute("data-bs-theme", theme); + root.dataset.bsTheme = theme; } -export default function Root({ children }: Props): React.JSX.Element { +export default function Root({ children }: Props): React.ReactNode { useEffect(() => { syncBootstrapTheme(); @@ -22,8 +22,10 @@ export default function Root({ children }: Props): React.JSX.Element { attributeFilter: ["data-theme"], }); - return () => observer.disconnect(); + return () => { + observer.disconnect(); + }; }, []); - return <>{children}; + return children; } diff --git a/packages/app-web/src/Button.tsx b/packages/app-web/src/Button.tsx index d163db6b10e..f7708e2b17c 100644 --- a/packages/app-web/src/Button.tsx +++ b/packages/app-web/src/Button.tsx @@ -5,18 +5,12 @@ interface Props { } export function Button({ text, href, isExternal }: Props) { - const extraProps = isExternal - ? { - target: "_blank", - rel: "noreferrer", - } - : {}; - return (
{text} diff --git a/packages/app-web/src/EmbeddedVideo.tsx b/packages/app-web/src/EmbeddedVideo.tsx index 85e49a19fa2..935d6e7d498 100644 --- a/packages/app-web/src/EmbeddedVideo.tsx +++ b/packages/app-web/src/EmbeddedVideo.tsx @@ -5,28 +5,26 @@ interface Props { youtubeSlug: string; } -const ReactPlayer = lazy(async () => import("react-player")); +const ReactPlayer = lazy(() => import("react-player")); +const containerStyle = { paddingTop: "56.25%" }; export function EmbeddedVideo({ youtubeSlug }: Props) { const [isError, setIsError] = useState(false); return ( -
+
{isError ? ( -
+
Error loading YouTube video
) : ( { console.warn(`Error loading YouTube video: ${error}`); setIsError(true); diff --git a/packages/app-web/src/LandingPage.tsx b/packages/app-web/src/LandingPage.tsx index 8eb5c93652a..11905b374f2 100644 --- a/packages/app-web/src/LandingPage.tsx +++ b/packages/app-web/src/LandingPage.tsx @@ -65,7 +65,7 @@ function Buttons() {
diff --git a/packages/app-web/vite.config.ts b/packages/app-web/vite.config.ts index 07b32107a6c..98ae2687ca2 100644 --- a/packages/app-web/vite.config.ts +++ b/packages/app-web/vite.config.ts @@ -53,6 +53,6 @@ function formatMessage(message: string): string { const lines = message .split(/\r?\n/) .map((l) => l.trimEnd()) - .map((l) => (l.length > maxLength ? l.slice(0, maxLength) + "..." : l)); + .map((l) => (l.length > maxLength ? `${l.slice(0, maxLength)}...` : l)); return lines.join("\n"); } diff --git a/packages/lib-cheatsheet-local/src/index.tsx b/packages/lib-cheatsheet-local/src/index.tsx index 437c798d3db..260317230f8 100644 --- a/packages/lib-cheatsheet-local/src/index.tsx +++ b/packages/lib-cheatsheet-local/src/index.tsx @@ -10,7 +10,7 @@ render( ); function getRoot() { - const root = document.getElementById("root"); + const root = document.querySelector("#root"); if (root == null) { throw new Error("Missing root container"); } diff --git a/packages/lib-cheatsheet-local/src/test/styleMock.ts b/packages/lib-cheatsheet-local/src/test/styleMock.ts index ff8b4c56321..b64ee9216bb 100644 --- a/packages/lib-cheatsheet-local/src/test/styleMock.ts +++ b/packages/lib-cheatsheet-local/src/test/styleMock.ts @@ -1 +1,2 @@ +// oxlint-disable-next-line import/no-anonymous-default-export export default {}; diff --git a/packages/lib-cheatsheet-local/vite.config.ts b/packages/lib-cheatsheet-local/vite.config.ts index ba2bd565ff9..b12aee1c17e 100644 --- a/packages/lib-cheatsheet-local/vite.config.ts +++ b/packages/lib-cheatsheet-local/vite.config.ts @@ -1,4 +1,5 @@ -import { defineConfig, type UserConfig } from "vite"; +import { defineConfig } from "vite"; +import type { UserConfig } from "vite"; import purgeCss from "vite-plugin-purgecss"; import { viteSingleFile } from "vite-plugin-singlefile"; import defaultCheatsheetInfo from "@cursorless/lib-cheatsheet/defaultSpokenForms"; diff --git a/packages/lib-cheatsheet/src/lib/Cheatsheet.tsx b/packages/lib-cheatsheet/src/lib/Cheatsheet.tsx index 59b18c57f5c..059d6035d89 100644 --- a/packages/lib-cheatsheet/src/lib/Cheatsheet.tsx +++ b/packages/lib-cheatsheet/src/lib/Cheatsheet.tsx @@ -38,7 +38,7 @@ function Title() { See the{" "} - + full documentation {" "} to learn more. diff --git a/packages/lib-cheatsheet/src/lib/CheatsheetNotesSection.tsx b/packages/lib-cheatsheet/src/lib/CheatsheetNotesSection.tsx index 8a9f70ffa04..1ec7b2b6b94 100644 --- a/packages/lib-cheatsheet/src/lib/CheatsheetNotesSection.tsx +++ b/packages/lib-cheatsheet/src/lib/CheatsheetNotesSection.tsx @@ -5,7 +5,7 @@ export default function CheatsheetNotesSection(): JSX.Element { return (
See the{" "} - + full documentation {" "} to learn more. diff --git a/packages/lib-cheatsheet/src/lib/utils/applyBootstrapTheme.ts b/packages/lib-cheatsheet/src/lib/utils/applyBootstrapTheme.ts index 52bd62d4a03..807db33d7fc 100644 --- a/packages/lib-cheatsheet/src/lib/utils/applyBootstrapTheme.ts +++ b/packages/lib-cheatsheet/src/lib/utils/applyBootstrapTheme.ts @@ -1,18 +1,15 @@ +// oxlint-disable unicorn/prefer-global-this export function applyBootstrapTheme() { - if ( - typeof window === "undefined" || - typeof window.matchMedia === "undefined" - ) { - return () => {}; + if (typeof window === "undefined" || window.matchMedia == null) { + return () => { + // No-op + }; } const media = window.matchMedia("(prefers-color-scheme: dark)"); function applyTheme() { - document.documentElement.setAttribute( - "data-bs-theme", - media.matches ? "dark" : "light", - ); + document.documentElement.dataset.bsTheme = media.matches ? "dark" : "light"; } applyTheme(); diff --git a/packages/lib-cheatsheet/src/lib/utils/formatCaptures.tsx b/packages/lib-cheatsheet/src/lib/utils/formatCaptures.tsx index 73769793221..b7a7d095182 100644 --- a/packages/lib-cheatsheet/src/lib/utils/formatCaptures.tsx +++ b/packages/lib-cheatsheet/src/lib/utils/formatCaptures.tsx @@ -24,10 +24,8 @@ export function formatCaptures(input: string): ComponentChildren[] { parts.push( - - {"["} - {innerElement} - {"]"} + + [{innerElement}] , ); diff --git a/packages/lib-cheatsheet/src/lib/utils/useIsHighlighted.ts b/packages/lib-cheatsheet/src/lib/utils/useIsHighlighted.ts index feb8aebea1f..2ee0badeca4 100644 --- a/packages/lib-cheatsheet/src/lib/utils/useIsHighlighted.ts +++ b/packages/lib-cheatsheet/src/lib/utils/useIsHighlighted.ts @@ -1,3 +1,4 @@ +// oxlint-disable unicorn/prefer-global-this import { useCallback, useEffect, useState } from "preact/hooks"; // Check if window is defined (so if in the browser or in node.js). diff --git a/packages/lib-cheatsheet/src/test/styleMock.ts b/packages/lib-cheatsheet/src/test/styleMock.ts index ff8b4c56321..b64ee9216bb 100644 --- a/packages/lib-cheatsheet/src/test/styleMock.ts +++ b/packages/lib-cheatsheet/src/test/styleMock.ts @@ -1 +1,2 @@ +// oxlint-disable-next-line import/no-anonymous-default-export export default {}; diff --git a/packages/lib-common/scripts/c-tsx.js b/packages/lib-common/scripts/c-tsx.js index ce50241afd7..522ab48db80 100755 --- a/packages/lib-common/scripts/c-tsx.js +++ b/packages/lib-common/scripts/c-tsx.js @@ -18,6 +18,7 @@ function runCommand(command, args, extraEnv = {}) { return spawn(command, args, { stdio: "inherit", env: { + // oxlint-disable-next-line node/no-process-env ...process.env, ...extraEnv, }, @@ -25,7 +26,7 @@ function runCommand(command, args, extraEnv = {}) { } // Main function to execute the script -async function main() { +function main() { const args = process.argv.slice(2); // Check if the input file is specified @@ -44,7 +45,7 @@ async function main() { "tsx", ["--enable-source-maps", fileToRun, ...childArgs], { - ["CURSORLESS_REPO_ROOT"]: repoRoot, + CURSORLESS_REPO_ROOT: repoRoot, }, ); nodeProcess.on("error", (error) => { @@ -54,7 +55,9 @@ async function main() { nodeProcess.on("close", (code) => process.exit(code ?? undefined)); } -main().catch((error) => { +try { + main(); +} catch (error) { console.error(error); process.exit(1); -}); +} diff --git a/packages/lib-common/src/FakeCommandServerApi.ts b/packages/lib-common/src/FakeCommandServerApi.ts index 46d555948b0..404016e594f 100644 --- a/packages/lib-common/src/FakeCommandServerApi.ts +++ b/packages/lib-common/src/FakeCommandServerApi.ts @@ -9,11 +9,15 @@ export class FakeCommandServerApi implements CommandServerApi { signals: { prePhrase: InboundSignal }; constructor() { - this.signals = { prePhrase: { getVersion: async () => null } }; + this.signals = { + prePhrase: { + getVersion: () => Promise.resolve(null), + }, + }; } - async getFocusedElementType(): Promise { - return this.focusedElementType; + getFocusedElementType(): Promise { + return Promise.resolve(this.focusedElementType); } setFocusedElementType( diff --git a/packages/lib-common/src/cursorlessCommandIds.ts b/packages/lib-common/src/cursorlessCommandIds.ts index 3d5c5a99ee0..6f366540b27 100644 --- a/packages/lib-common/src/cursorlessCommandIds.ts +++ b/packages/lib-common/src/cursorlessCommandIds.ts @@ -70,103 +70,101 @@ export const cursorlessCommandDescriptions: Record< CursorlessCommandId, CommandDescription > = { - ["cursorless.toggleDecorations"]: new VisibleCommand("Toggle decorations"), - ["cursorless.recomputeDecorationStyles"]: new VisibleCommand( + "cursorless.toggleDecorations": new VisibleCommand("Toggle decorations"), + "cursorless.recomputeDecorationStyles": new VisibleCommand( "Recompute decoration styles", ), - ["cursorless.recordTestCase"]: new VisibleCommand("Record test case"), - ["cursorless.recordOneTestCaseThenPause"]: new VisibleCommand( + "cursorless.recordTestCase": new VisibleCommand("Record test case"), + "cursorless.recordOneTestCaseThenPause": new VisibleCommand( "Record one test case, then pause", ), - ["cursorless.pauseRecording"]: new VisibleCommand( - "Pause test case recording", - ), - ["cursorless.resumeRecording"]: new VisibleCommand( + "cursorless.pauseRecording": new VisibleCommand("Pause test case recording"), + "cursorless.resumeRecording": new VisibleCommand( "Resume test case recording", ), - ["cursorless.recordScopeTests.showUnimplementedFacets"]: new VisibleCommand( + "cursorless.recordScopeTests.showUnimplementedFacets": new VisibleCommand( "Bulk record unimplemented scope facets", ), - ["cursorless.recordScopeTests.saveActiveDocument"]: new VisibleCommand( + "cursorless.recordScopeTests.saveActiveDocument": new VisibleCommand( "Bulk save scope tests for the active document", ), - ["cursorless.showDocumentation"]: new VisibleCommand("Show documentation"), - ["cursorless.showInstallationDependencies"]: new VisibleCommand( + "cursorless.showDocumentation": new VisibleCommand("Show documentation"), + "cursorless.showInstallationDependencies": new VisibleCommand( "Show installation dependencies", ), // showScopeVisualizer can't be called from the command palatte because it // requires an argument, but it still needs to be visible or the scope buttons // will be disabled in the sidebar - ["cursorless.showScopeVisualizer"]: new VisibleCommand( + "cursorless.showScopeVisualizer": new VisibleCommand( "Show the scope visualizer", ), - ["cursorless.hideScopeVisualizer"]: new VisibleCommand( + "cursorless.hideScopeVisualizer": new VisibleCommand( "Hide the scope visualizer", ), - ["cursorless.scopeVisualizer.openUrl"]: new VisibleCommand("Open in browser"), - ["cursorless.analyzeCommandHistory"]: new VisibleCommand( + "cursorless.scopeVisualizer.openUrl": new VisibleCommand("Open in browser"), + "cursorless.analyzeCommandHistory": new VisibleCommand( "Analyze collected command history", ), - ["cursorless.tutorial.start"]: new HiddenCommand("Start a tutorial"), - ["cursorless.tutorial.next"]: new VisibleCommand("Tutorial next"), - ["cursorless.tutorial.previous"]: new VisibleCommand("Tutorial previous"), - ["cursorless.tutorial.restart"]: new VisibleCommand("Tutorial restart"), - ["cursorless.tutorial.resume"]: new VisibleCommand("Tutorial resume"), - ["cursorless.tutorial.list"]: new VisibleCommand("Tutorial list"), - ["cursorless.documentationOpened"]: new HiddenCommand( + "cursorless.tutorial.start": new HiddenCommand("Start a tutorial"), + "cursorless.tutorial.next": new VisibleCommand("Tutorial next"), + "cursorless.tutorial.previous": new VisibleCommand("Tutorial previous"), + "cursorless.tutorial.restart": new VisibleCommand("Tutorial restart"), + "cursorless.tutorial.resume": new VisibleCommand("Tutorial resume"), + "cursorless.tutorial.list": new VisibleCommand("Tutorial list"), + "cursorless.documentationOpened": new HiddenCommand( "Used by talon to notify us that the docs have been opened; for use with tutorial", ), - ["cursorless.command"]: new HiddenCommand("The core cursorless command"), - ["cursorless.repeatPreviousCommand"]: new VisibleCommand( + "cursorless.command": new HiddenCommand("The core cursorless command"), + "cursorless.repeatPreviousCommand": new VisibleCommand( "Repeat the previous Cursorless command", ), - ["cursorless.showQuickPick"]: new HiddenCommand( + "cursorless.showQuickPick": new HiddenCommand( "Pop up a quick pick of all cursorless commands", ), - ["cursorless.showCheatsheet"]: new HiddenCommand( + "cursorless.showCheatsheet": new HiddenCommand( "Display the cursorless cheatsheet", ), - ["cursorless.internal.updateCheatsheetDefaults"]: new HiddenCommand( + "cursorless.internal.updateCheatsheetDefaults": new HiddenCommand( "Update the default values of the cheatsheet payload used on the website and for local development. Be sure to run this on stock community and cursorless.", ), - ["cursorless.private.logQuickActions"]: new HiddenCommand( + "cursorless.private.logQuickActions": new HiddenCommand( "Log the quick actions available at the current cursor position", ), - ["cursorless.takeSnapshot"]: new HiddenCommand( + "cursorless.takeSnapshot": new HiddenCommand( "Take a snapshot of the current editor state", ), - ["cursorless.keyboard.escape"]: new HiddenCommand( + "cursorless.keyboard.escape": new HiddenCommand( "Should be mapped to the escape key when using cursorless keyboard. By default, exits modal keyboard mode, but changes behaviour when Cursorless is expecting a continuation keystroke. For example, when you type a color and Cursorless is waiting for a character, it cancels the color and switches back to modal mode.", ), - ["cursorless.keyboard.targeted.targetHat"]: new HiddenCommand( + "cursorless.keyboard.targeted.targetHat": new HiddenCommand( "Sets the keyboard target to the given hat", ), - ["cursorless.keyboard.targeted.targetScope"]: new HiddenCommand( + "cursorless.keyboard.targeted.targetScope": new HiddenCommand( "Sets the keyboard target to the scope containing the current target", ), - ["cursorless.keyboard.targeted.targetSelection"]: new HiddenCommand( + "cursorless.keyboard.targeted.targetSelection": new HiddenCommand( "Sets the keyboard target to the current selection", ), - ["cursorless.keyboard.targeted.clearTarget"]: new HiddenCommand( + "cursorless.keyboard.targeted.clearTarget": new HiddenCommand( "Clears the current keyboard target", ), - ["cursorless.keyboard.targeted.runActionOnTarget"]: new HiddenCommand( + "cursorless.keyboard.targeted.runActionOnTarget": new HiddenCommand( "Run the given action on the current keyboard target", ), - ["cursorless.keyboard.modal.modeOn"]: new HiddenCommand( + "cursorless.keyboard.modal.modeOn": new HiddenCommand( "Turn on the cursorless modal mode", ), - ["cursorless.keyboard.modal.modeOff"]: new HiddenCommand( + "cursorless.keyboard.modal.modeOff": new HiddenCommand( "Turn off the cursorless modal mode", ), - ["cursorless.keyboard.modal.modeToggle"]: new HiddenCommand( + "cursorless.keyboard.modal.modeToggle": new HiddenCommand( "Toggle the cursorless modal mode", ), - ["cursorless.keyboard.undoTarget"]: new HiddenCommand( + "cursorless.keyboard.undoTarget": new HiddenCommand( "Undo keyboard targeting changes", ), - ["cursorless.keyboard.redoTarget"]: new HiddenCommand( + "cursorless.keyboard.redoTarget": new HiddenCommand( "Redo keyboard targeting changes", ), }; diff --git a/packages/lib-common/src/errors.ts b/packages/lib-common/src/errors.ts index 019930e5c5c..0593a51df7e 100644 --- a/packages/lib-common/src/errors.ts +++ b/packages/lib-common/src/errors.ts @@ -23,6 +23,7 @@ export class OutdatedExtensionError extends Error { super( "Cursorless Talon version is ahead of Cursorless VSCode extension version. Please update Cursorless VSCode.", ); + this.name = "OutdatedExtensionError"; } } diff --git a/packages/lib-common/src/ide/fake/FakeClipboard.ts b/packages/lib-common/src/ide/fake/FakeClipboard.ts index 94926124e77..e7302678850 100644 --- a/packages/lib-common/src/ide/fake/FakeClipboard.ts +++ b/packages/lib-common/src/ide/fake/FakeClipboard.ts @@ -3,11 +3,12 @@ import type { Clipboard } from "../types/Clipboard"; export default class FakeClipboard implements Clipboard { private clipboardContents: string = ""; - async readText(): Promise { - return this.clipboardContents; + readText(): Promise { + return Promise.resolve(this.clipboardContents); } - async writeText(value: string): Promise { + writeText(value: string): Promise { this.clipboardContents = value; + return Promise.resolve(); } } diff --git a/packages/lib-common/src/ide/fake/FakeIDE.ts b/packages/lib-common/src/ide/fake/FakeIDE.ts index a3dd9f8b3c1..a419ead5360 100644 --- a/packages/lib-common/src/ide/fake/FakeIDE.ts +++ b/packages/lib-common/src/ide/fake/FakeIDE.ts @@ -124,11 +124,11 @@ export class FakeIDE implements EmittableIDE { this.quickPickReturnValue = value; } - public async showQuickPick( + public showQuickPick( _items: readonly string[], _options?: QuickPickOptions, ): Promise { - return this.quickPickReturnValue; + return Promise.resolve(this.quickPickReturnValue); } public showInputBox(_options?: any): Promise { diff --git a/packages/lib-common/src/ide/fake/FakeMessages.ts b/packages/lib-common/src/ide/fake/FakeMessages.ts index 30d08de488a..9329dbf43fa 100644 --- a/packages/lib-common/src/ide/fake/FakeMessages.ts +++ b/packages/lib-common/src/ide/fake/FakeMessages.ts @@ -1,12 +1,12 @@ import type { MessageId, Messages, MessageType } from "../types/Messages"; export default class FakeMessages implements Messages { - async showMessage( + showMessage( _type: MessageType, _id: MessageId, _message: string, ..._options: string[] ): Promise { - return undefined; + return Promise.resolve(undefined); } } diff --git a/packages/lib-common/src/ide/inMemoryTextEditor/InMemoryTextEditor.ts b/packages/lib-common/src/ide/inMemoryTextEditor/InMemoryTextEditor.ts index 0a3516d98e3..aa16cc81b95 100644 --- a/packages/lib-common/src/ide/inMemoryTextEditor/InMemoryTextEditor.ts +++ b/packages/lib-common/src/ide/inMemoryTextEditor/InMemoryTextEditor.ts @@ -1,19 +1,20 @@ import { URI } from "vscode-uri"; +import type { Edit } from "../../types/Edit"; +import type { GeneralizedRange } from "../../types/GeneralizedRange"; +import type { Range } from "../../types/Range"; +import type { RevealLineAt } from "../../types/RevealLineAt"; +import { Selection } from "../../types/Selection"; +import type { SelectionOffsets } from "../../types/Selection"; +import type { TextDocument } from "../../types/TextDocument"; import type { - Edit, EditableTextEditor, - EmittableIDE, - GeneralizedRange, OpenLinkOptions, - Range, - RevealLineAt, - SelectionOffsets, SetSelectionsOpts, - TextDocument, TextEditor, - TextEditorOptions, -} from "@cursorless/lib-common"; -import { Selection, selectionsEqual } from "@cursorless/lib-common"; +} from "../../types/TextEditor"; +import type { TextEditorOptions } from "../../types/TextEditorOptions"; +import { selectionsEqual } from "../../util/selectionsEqual"; +import type { EmittableIDE } from "../types/ide.types"; import { InMemoryTextDocument } from "./InMemoryTextDocument"; interface Params { @@ -79,7 +80,7 @@ export class InMemoryTextEditor implements EditableTextEditor { return this.id === other.id; } - async setSelections( + setSelections( selections: Selection[], _opts?: SetSelectionsOpts, ): Promise { @@ -93,6 +94,7 @@ export class InMemoryTextEditor implements EditableTextEditor { selections: selections, }); } + return Promise.resolve(); } edit(edits: Edit[]): Promise { @@ -104,11 +106,11 @@ export class InMemoryTextEditor implements EditableTextEditor { return Promise.resolve(true); } - async clipboardCopy(_ranges: Range[]): Promise { + clipboardCopy(_ranges: Range[]): Promise { throw new Error("clipboardCopy: not implemented"); } - async clipboardPaste(): Promise { + clipboardPaste(): Promise { throw new Error("clipboardPaste: not implemented"); } @@ -200,27 +202,27 @@ export class InMemoryTextEditor implements EditableTextEditor { throw new Error("editNewNotebookCellBelow: not implemented"); } - public async gitAccept(_range?: Range): Promise { + public gitAccept(_range?: Range): Promise { throw new Error("gitAccept: not implemented"); } - public async gitRevert(_range?: Range): Promise { + public gitRevert(_range?: Range): Promise { throw new Error("gitRevert: not implemented"); } - public async gitStageFile(): Promise { + public gitStageFile(): Promise { throw new Error("gitStageFile: not implemented"); } - public async gitUnstageFile(): Promise { + public gitUnstageFile(): Promise { throw new Error("gitUnstageFile: not implemented"); } - public async gitStageRange(_range?: Range): Promise { + public gitStageRange(_range?: Range): Promise { throw new Error("gitStageRange: not implemented"); } - public async gitUnstageRange(_range?: Range): Promise { + public gitUnstageRange(_range?: Range): Promise { throw new Error("gitUnstageRange: not implemented"); } } diff --git a/packages/lib-common/src/ide/inMemoryTextEditor/performEdits.ts b/packages/lib-common/src/ide/inMemoryTextEditor/performEdits.ts index c2376bc6c10..21df2587ad5 100644 --- a/packages/lib-common/src/ide/inMemoryTextEditor/performEdits.ts +++ b/packages/lib-common/src/ide/inMemoryTextEditor/performEdits.ts @@ -72,7 +72,7 @@ function createChangeEvents( throw new Error("Overlapping ranges are not allowed!"); } - const text = edit.text.replace(/\r?\n/g, eol); + const text = edit.text.replaceAll(/\r?\n/g, eol); changes.push(createChangeEvent(document, edit.range, text)); } diff --git a/packages/lib-common/src/ide/inMemoryTextEditor/test/InMemoryTextDocument.test.ts b/packages/lib-common/src/ide/inMemoryTextEditor/test/InMemoryTextDocument.test.ts index f710101fd54..8c6964de816 100644 --- a/packages/lib-common/src/ide/inMemoryTextEditor/test/InMemoryTextDocument.test.ts +++ b/packages/lib-common/src/ide/inMemoryTextEditor/test/InMemoryTextDocument.test.ts @@ -25,7 +25,7 @@ suite("InMemoryTextDocument", () => { "", ); const document2 = new InMemoryTextDocument( - URI.file("dummy\\bar.ts"), + URI.file("dummy/bar.ts"), "", "", ); diff --git a/packages/lib-common/src/ide/inMemoryTextEditor/test/InMemoryTextDocumentEdit.test.ts b/packages/lib-common/src/ide/inMemoryTextEditor/test/InMemoryTextDocumentEdit.test.ts index 51a71535e8e..0eb77892094 100644 --- a/packages/lib-common/src/ide/inMemoryTextEditor/test/InMemoryTextDocumentEdit.test.ts +++ b/packages/lib-common/src/ide/inMemoryTextEditor/test/InMemoryTextDocumentEdit.test.ts @@ -1,5 +1,6 @@ import * as assert from "node:assert/strict"; import { Range } from "../../../types/Range"; +import { getErrorMessage } from "../../../util/getErrorMessage"; import { createTestDocument } from "./createTestDocument"; const text = "hello\nworld"; @@ -99,7 +100,7 @@ suite("InMemoryTextDocument.edit", () => { assert.fail("Expected an error"); } catch (error) { assert.equal( - (error as Error).message, + getErrorMessage(error), "Overlapping ranges are not allowed!", ); } diff --git a/packages/lib-common/src/ide/normalized/NormalizedIDE.ts b/packages/lib-common/src/ide/normalized/NormalizedIDE.ts index 04fb7cd6ddd..3e0cded0642 100644 --- a/packages/lib-common/src/ide/normalized/NormalizedIDE.ts +++ b/packages/lib-common/src/ide/normalized/NormalizedIDE.ts @@ -65,7 +65,7 @@ export class NormalizedIDE extends PassthroughIDE { : super.setHighlightRanges(highlightId, editor, ranges); } - public async showQuickPick( + public showQuickPick( _items: readonly string[], _options?: QuickPickOptions, ): Promise { diff --git a/packages/lib-common/src/ide/types/Paths.ts b/packages/lib-common/src/ide/types/Paths.ts index be010fd28f9..2b3004d48b4 100644 --- a/packages/lib-common/src/ide/types/Paths.ts +++ b/packages/lib-common/src/ide/types/Paths.ts @@ -15,7 +15,7 @@ type Join< ? R : undefined; -type Union = L extends undefined +type Union = L extends undefined ? R extends undefined ? undefined : R @@ -47,7 +47,8 @@ export type Paths< */ export type GetFieldType< T extends GenericObject, - Path extends string, // Or, if you prefer, NestedPaths + // Or, if you prefer, NestedPaths + Path extends string, > = { [K in Path]: K extends keyof T ? T[K] diff --git a/packages/lib-common/src/ide/types/RawTreeSitterQueryProvider.ts b/packages/lib-common/src/ide/types/RawTreeSitterQueryProvider.ts index ee5775a4dbb..4c6863ef03c 100644 --- a/packages/lib-common/src/ide/types/RawTreeSitterQueryProvider.ts +++ b/packages/lib-common/src/ide/types/RawTreeSitterQueryProvider.ts @@ -1,4 +1,4 @@ -import type { Disposable } from "@cursorless/lib-common"; +import type { Disposable } from "./ide.types"; /** * Provides raw tree-sitter queries. These are usually read from `.scm` files diff --git a/packages/lib-common/src/index.ts b/packages/lib-common/src/index.ts index 69b194422d4..2ed2329a15a 100644 --- a/packages/lib-common/src/index.ts +++ b/packages/lib-common/src/index.ts @@ -96,7 +96,6 @@ export * from "./types/TextLine"; export * from "./types/Token"; export * from "./types/TreeSitter"; export * from "./types/tutorial.types"; -export * from "./util"; export * from "./util/blendColors"; export * from "./util/clientSupportsFallback"; export * from "./util/CompositeKeyDefaultMap"; @@ -115,6 +114,7 @@ export * from "./util/regex"; export * from "./util/selectionsEqual"; export * from "./util/serializedMarksToTokenHats"; export * from "./util/serializeScopeType"; +export * from "./util/sleep"; export * from "./util/splitKey"; export * from "./util/stringUtils"; export * from "./util/toPlainObject"; diff --git a/packages/lib-common/src/scopeVisualizerUtil/decorationUtil.ts b/packages/lib-common/src/scopeVisualizerUtil/decorationUtil.ts index 8e0b9a298ae..98539473c42 100644 --- a/packages/lib-common/src/scopeVisualizerUtil/decorationUtil.ts +++ b/packages/lib-common/src/scopeVisualizerUtil/decorationUtil.ts @@ -30,7 +30,7 @@ export function getBorderRadius(borders: DecorationStyle): string { ].join(" "); } -export function useSingleCornerBorderRadius( +export function singleCornerBorderRadius( side1: BorderStyle, side2: BorderStyle, ): boolean { @@ -44,5 +44,5 @@ export function getSingleCornerBorderRadius( side1: BorderStyle, side2: BorderStyle, ) { - return useSingleCornerBorderRadius(side1, side2) ? BORDER_RADIUS : "0px"; + return singleCornerBorderRadius(side1, side2) ? BORDER_RADIUS : "0px"; } diff --git a/packages/lib-common/src/scopeVisualizerUtil/generateDecorationsForCharacterRange/handleMultipleLines.ts b/packages/lib-common/src/scopeVisualizerUtil/generateDecorationsForCharacterRange/handleMultipleLines.ts index d6749c3f015..cca42fc8a21 100644 --- a/packages/lib-common/src/scopeVisualizerUtil/generateDecorationsForCharacterRange/handleMultipleLines.ts +++ b/packages/lib-common/src/scopeVisualizerUtil/generateDecorationsForCharacterRange/handleMultipleLines.ts @@ -63,6 +63,7 @@ function* handleLine(lineInfo: LineInfo): Iterable { // NB: The `loop` label here allows us to break out of the loop from inside // the switch statement. + // oxlint-disable-next-line no-labels loop: for (const event of events) { if (event.offset > currentOffset) { // If we've moved forward at all since the last event, yield a decoration @@ -73,12 +74,14 @@ function* handleLine(lineInfo: LineInfo): Iterable { ...currentDecoration, // If we're done with this line, draw a right border, otherwise don't, // so that it merges in with the next decoration for this line. - right: - event.offset === currentLine.end - ? currentLine.isLast + right: (() => { + if (event.offset === currentLine.end) { + return currentLine.isLast ? BorderStyle.solid - : BorderStyle.porous - : BorderStyle.none, + : BorderStyle.porous; + } + return BorderStyle.none; + })(), }, }; yieldedAnything = true; @@ -94,13 +97,19 @@ function* handleLine(lineInfo: LineInfo): Iterable { ? BorderStyle.none : BorderStyle.porous; break; - case LineType.current: // event.isLineStart === false + // event.isLineStart === false + case LineType.current: + // oxlint-disable-next-line no-labels break loop; - case LineType.next: // event.isLineStart === false + // event.isLineStart === false + case LineType.next: currentDecoration.bottom = nextLine!.isLast ? BorderStyle.solid : BorderStyle.porous; break; + default: { + const _exhaustiveCheck: never = event; + } } } diff --git a/packages/lib-common/src/testUtil/asyncSafety.ts b/packages/lib-common/src/testUtil/asyncSafety.ts index 5cbfc553b9a..ff5f7963b9c 100644 --- a/packages/lib-common/src/testUtil/asyncSafety.ts +++ b/packages/lib-common/src/testUtil/asyncSafety.ts @@ -18,18 +18,20 @@ export function asyncSafety(fn: () => Promise) { return function (this: Context, done: Done) { const runnable = this.runnable(); - fn.bind(this)() - .then(() => { + void (async () => { + try { + await fn.bind(this)(); + // for successful I think we only need timedOut? not sure though, might have side effects // when the duration check is added it will get stuck and never complete on a second runthrough if (!runnable.timedOut) { done(); } - }) - .catch((err: unknown) => { + } catch (error) { if (!runnable.timedOut && !runnable.duration) { - done(err); + done(error); } - }); + } + })(); }; } diff --git a/packages/lib-common/src/testUtil/serialize.ts b/packages/lib-common/src/testUtil/serialize.ts index 328cb16955d..2666ec7b4a7 100644 --- a/packages/lib-common/src/testUtil/serialize.ts +++ b/packages/lib-common/src/testUtil/serialize.ts @@ -11,13 +11,10 @@ class CustomDump { ) {} represent(): string { - let result = yaml.dump( - this.data, - Object.assign({ replacer, schema }, this.opts), - ); + let result = yaml.dump(this.data, { replacer, schema, ...this.opts }); result = result.trim(); if (result.includes("\n")) { - result = "\n" + result; + result = `\n${result}`; } return result; } @@ -48,15 +45,17 @@ function hasSimpleChildren(value: unknown): boolean { } function replacer(key: string, value: unknown): unknown { + // top-level, don't change this if (key === "") { return value; - } // top-level, don't change this + } if (hasSimpleChildren(value)) { return new CustomDump(value, { flowLevel: 0 }); } - return value; // default + // default + return value; } export function serialize(obj: unknown): string { diff --git a/packages/lib-common/src/testUtil/serializeTestFixture.ts b/packages/lib-common/src/testUtil/serializeTestFixture.ts index 7acd42c28cc..cf57d4c40c7 100644 --- a/packages/lib-common/src/testUtil/serializeTestFixture.ts +++ b/packages/lib-common/src/testUtil/serializeTestFixture.ts @@ -37,6 +37,7 @@ function reorderCommandFields(command: Command): Command { throw new Error("All tests must use at least command version 7"); case 7: return reorderCommandV7Fields(command); + // No default } } diff --git a/packages/lib-common/src/types/Position.ts b/packages/lib-common/src/types/Position.ts index bdaa9bab431..f0d9f34e2cf 100644 --- a/packages/lib-common/src/types/Position.ts +++ b/packages/lib-common/src/types/Position.ts @@ -1,5 +1,4 @@ import { stringToInteger } from "../util/stringUtils"; -import { Range } from "./Range"; import type { TextDocument } from "./TextDocument"; export class Position { @@ -158,14 +157,6 @@ export class Position { ); } - /** - * Create a new empty range from this position. - * @returns A {@link Range} - */ - public toEmptyRange(): Range { - return new Range(this, this); - } - /** * Return a concise string representation of the position. 0-based. * @returns concise representation diff --git a/packages/lib-common/src/types/Range.ts b/packages/lib-common/src/types/Range.ts index 441c66f94fe..2422da1b95b 100644 --- a/packages/lib-common/src/types/Range.ts +++ b/packages/lib-common/src/types/Range.ts @@ -26,10 +26,20 @@ export class Range { `Invalid concise range format: "${concise}". Expected "start-end" format.`, ); } - const [start, end] = parts.map((s) => Position.fromConcise(s)); + const start = Position.fromConcise(parts[0]); + const end = Position.fromConcise(parts[1]); return new Range(start, end); } + /** + * Create a new empty range from a position. + * @param position A position. + * @returns A {@link Range} + */ + static fromPosition(position: Position): Range { + return new Range(position, position); + } + /** * Create a new range from two positions. * The earlier of `p1` and `p2` will be used as the start position. diff --git a/packages/lib-common/src/types/SpokenFormType.ts b/packages/lib-common/src/types/SpokenFormType.ts index f17210075a7..683d2234a74 100644 --- a/packages/lib-common/src/types/SpokenFormType.ts +++ b/packages/lib-common/src/types/SpokenFormType.ts @@ -1,9 +1,9 @@ +import type { ActionType } from "./command/ActionDescriptor"; import type { - ActionType, ModifierType, SimpleScopeTypeType, SurroundingPairName, -} from "@cursorless/lib-common"; +} from "./command/PartialTargetDescriptor.types"; /** * This interface is the source of truth for the types used in our spoken form diff --git a/packages/lib-common/src/types/TalonSpokenForms.ts b/packages/lib-common/src/types/TalonSpokenForms.ts index 452c6c78a14..a55ab61023e 100644 --- a/packages/lib-common/src/types/TalonSpokenForms.ts +++ b/packages/lib-common/src/types/TalonSpokenForms.ts @@ -1,4 +1,4 @@ -import type { Notifier } from "@cursorless/lib-common"; +import type { Notifier } from "../util/Notifier"; import type { SpokenFormMapKeyTypes, SpokenFormType } from "./SpokenFormType"; /** diff --git a/packages/lib-common/src/types/TreeSitter.ts b/packages/lib-common/src/types/TreeSitter.ts index f255374e4cd..ae247f3858e 100644 --- a/packages/lib-common/src/types/TreeSitter.ts +++ b/packages/lib-common/src/types/TreeSitter.ts @@ -1,5 +1,5 @@ import type { Query, Tree } from "web-tree-sitter"; -import type { TextDocument } from "@cursorless/lib-common"; +import type { TextDocument } from "./TextDocument"; export interface TreeSitter { /** diff --git a/packages/lib-common/src/util/disposableFrom.ts b/packages/lib-common/src/util/disposableFrom.ts index 62c2804567a..1664f1c97f0 100644 --- a/packages/lib-common/src/util/disposableFrom.ts +++ b/packages/lib-common/src/util/disposableFrom.ts @@ -12,11 +12,11 @@ export function disposableFrom(...disposables: Disposable[]): Disposable { disposables.forEach((disposable) => { try { disposable.dispose(); - } catch (e) { + } catch (error) { // just log, but don't throw; some of the VSCode disposables misbehave, // and we don't want that to prevent us from disposing the rest of the // disposables - console.error(e); + console.error(error); } }); }, diff --git a/packages/lib-common/src/util/index.ts b/packages/lib-common/src/util/index.ts deleted file mode 100644 index 3e905931666..00000000000 --- a/packages/lib-common/src/util/index.ts +++ /dev/null @@ -1,2 +0,0 @@ -export * from "./sleep"; -export { default as sleep } from "./sleep"; diff --git a/packages/lib-common/src/util/object.ts b/packages/lib-common/src/util/object.ts index c63808be915..2236cd131ea 100644 --- a/packages/lib-common/src/util/object.ts +++ b/packages/lib-common/src/util/object.ts @@ -10,7 +10,7 @@ export function mergeStrict( objects.forEach((object: object) => { for (const [key, value] of Object.entries(object)) { - if (Object.prototype.hasOwnProperty.call(returnValue, key)) { + if (Object.hasOwn(returnValue, key)) { throw new Error(`Found duplicate property ${key}`); } diff --git a/packages/lib-common/src/util/omitByDeep.ts b/packages/lib-common/src/util/omitByDeep.ts index 72d22a08a65..4b8c98fe1fe 100644 --- a/packages/lib-common/src/util/omitByDeep.ts +++ b/packages/lib-common/src/util/omitByDeep.ts @@ -18,13 +18,11 @@ export function omitByDeep( .map(([key, value]) => { if (predicate(value)) { return undefined; - } else { - return [key, omitByDeep(value, predicate)]; } + return [key, omitByDeep(value, predicate)]; }) .filter((v): v is [string, unknown] => v != null), ); - } else { - return input; } + return input; } diff --git a/packages/lib-common/src/util/sleep.ts b/packages/lib-common/src/util/sleep.ts index fe86fd90318..9b9a8e566c0 100644 --- a/packages/lib-common/src/util/sleep.ts +++ b/packages/lib-common/src/util/sleep.ts @@ -6,6 +6,8 @@ * on failure, and this function will sleep the same amount of time every time * the test is retried. Prefer {@link sleepWithBackoff} instead. */ -export default function sleep(ms: number): Promise { - return new Promise((resolve) => setTimeout(resolve, ms)); +export function sleep(ms: number): Promise { + return new Promise((resolve) => { + setTimeout(resolve, ms); + }); } diff --git a/packages/lib-common/src/util/stringUtils.ts b/packages/lib-common/src/util/stringUtils.ts index ccae6d019ea..b7bd513fed4 100644 --- a/packages/lib-common/src/util/stringUtils.ts +++ b/packages/lib-common/src/util/stringUtils.ts @@ -10,7 +10,7 @@ */ export function camelCaseToAllDown(input: string): string { return input - .replace(/(?<=[a-z0-9])([A-Z])/g, " $1") + .replaceAll(/(?<=[a-z0-9])([A-Z])/g, " $1") .split(" ") .map((word) => word.toLowerCase()) .join(" "); @@ -40,7 +40,7 @@ export function capitalize(str: string) { export function uriEncodeHashId(text: string): string { return camelCaseToAllDown(text) .replaceAll(" ", "-") - .replace(/[^a-z0-9-]/g, ""); + .replaceAll(/[^a-z0-9-]/g, ""); } /** diff --git a/packages/lib-common/src/util/type.ts b/packages/lib-common/src/util/type.ts index e55fd3cf626..13aa90ac20d 100644 --- a/packages/lib-common/src/util/type.ts +++ b/packages/lib-common/src/util/type.ts @@ -1,4 +1,5 @@ export function isString(arg: unknown): arg is string { + // oxlint-disable-next-line unicorn/no-instanceof-builtins return typeof arg === "string" || arg instanceof String; } diff --git a/packages/lib-engine/src/CommandHistory.ts b/packages/lib-engine/src/CommandHistory.ts index 9f8e5171b72..3e3ec0b0d1b 100644 --- a/packages/lib-engine/src/CommandHistory.ts +++ b/packages/lib-engine/src/CommandHistory.ts @@ -44,9 +44,10 @@ export class CommandHistory implements CommandRunnerDecorator { await this.appendToLog(commandComplete); return returnValue; - } catch (e) { - await this.appendToLog(commandComplete, e as Error); - throw e; + } catch (error) { + const err = error instanceof Error ? error : new Error(String(error)); + await this.appendToLog(commandComplete, err); + throw error; } }, }; diff --git a/packages/lib-engine/src/CommandHistoryAnalyzer.ts b/packages/lib-engine/src/CommandHistoryAnalyzer.ts index 479e65147b6..5bbbd4b6a0d 100644 --- a/packages/lib-engine/src/CommandHistoryAnalyzer.ts +++ b/packages/lib-engine/src/CommandHistoryAnalyzer.ts @@ -153,7 +153,7 @@ export async function analyzeCommandHistory( } function toPercent(value: number) { - return Intl.NumberFormat(undefined, { + return new Intl.NumberFormat(undefined, { style: "percent", minimumFractionDigits: 0, maximumFractionDigits: 1, diff --git a/packages/lib-engine/src/actions/Actions.ts b/packages/lib-engine/src/actions/Actions.ts index cef3592d6e8..f4730f2f76c 100644 --- a/packages/lib-engine/src/actions/Actions.ts +++ b/packages/lib-engine/src/actions/Actions.ts @@ -256,8 +256,8 @@ export class Actions implements ActionRecord { unfoldRegion; wrapWithPairedDelimiter; wrapWithSnippet; - ["experimental.setInstanceReference"]; - ["private.showParseTree"]; - ["private.getTargets"]; - ["private.setKeyboardTarget"]; + "experimental.setInstanceReference"; + "private.showParseTree"; + "private.getTargets"; + "private.setKeyboardTarget"; } diff --git a/packages/lib-engine/src/actions/BreakLine.ts b/packages/lib-engine/src/actions/BreakLine.ts index b7292602375..484c6f75894 100644 --- a/packages/lib-engine/src/actions/BreakLine.ts +++ b/packages/lib-engine/src/actions/BreakLine.ts @@ -65,7 +65,7 @@ function getEdits(editor: TextEditor, contentRanges: Range[]): Edit[] { new Position(line.lineNumber, characterTrailingWhitespace), position, ) - : position.toEmptyRange(); + : Range.fromPosition(position); edits.push({ range: replacementRange, diff --git a/packages/lib-engine/src/actions/BringMoveSwap.ts b/packages/lib-engine/src/actions/BringMoveSwap.ts index c5b2456e717..07d8ec6fb47 100644 --- a/packages/lib-engine/src/actions/BringMoveSwap.ts +++ b/packages/lib-engine/src/actions/BringMoveSwap.ts @@ -230,7 +230,7 @@ abstract class BringMoveSwap { }); } - protected async decorateThatMark(thatMark: MarkEntry[]) { + protected decorateThatMark(thatMark: MarkEntry[]) { const getRange = (target: Target) => { return toGeneralizedRange( target, @@ -267,7 +267,7 @@ function broadcastSource(sources: Target[], destinations: Destination[]) { if (sources.length === 1) { // If there is only one source target, expand it to same length as // destination target - return Array(destinations.length).fill(sources[0]); + return Array.from({ length: destinations.length }, () => sources[0]); } return sources; } diff --git a/packages/lib-engine/src/actions/EditNew/runEditTargets.ts b/packages/lib-engine/src/actions/EditNew/runEditTargets.ts index 3bb3068fe0d..b1fb1ed1e47 100644 --- a/packages/lib-engine/src/actions/EditNew/runEditTargets.ts +++ b/packages/lib-engine/src/actions/EditNew/runEditTargets.ts @@ -32,8 +32,11 @@ export async function runEditTargets( index, }; } + return undefined; }) - .filter((destination): destination is EditDestination => !!destination); + .filter( + (destination): destination is EditDestination => destination != null, + ); if (destinations.length === 0) { return state; diff --git a/packages/lib-engine/src/actions/EditNew/runInsertLineAfterTargets.ts b/packages/lib-engine/src/actions/EditNew/runInsertLineAfterTargets.ts index 51d7ec40533..46f98e3495d 100644 --- a/packages/lib-engine/src/actions/EditNew/runInsertLineAfterTargets.ts +++ b/packages/lib-engine/src/actions/EditNew/runInsertLineAfterTargets.ts @@ -33,8 +33,11 @@ export async function runInsertLineAfterTargets( index, }; } + return undefined; }) - .filter((destination): destination is EditDestination => !!destination); + .filter( + (destination): destination is EditDestination => destination != null, + ); if (destinations.length === 0) { return state; diff --git a/packages/lib-engine/src/actions/ExecuteCommand.ts b/packages/lib-engine/src/actions/ExecuteCommand.ts index 55b61f7025d..789b99dbb88 100644 --- a/packages/lib-engine/src/actions/ExecuteCommand.ts +++ b/packages/lib-engine/src/actions/ExecuteCommand.ts @@ -22,7 +22,7 @@ export default class ExecuteCommand { this.run = this.run.bind(this); } - async run( + run( targets: Target[], commandId: string, { diff --git a/packages/lib-engine/src/actions/Find.ts b/packages/lib-engine/src/actions/Find.ts index 0a714a4cbb0..5add372f9ac 100644 --- a/packages/lib-engine/src/actions/Find.ts +++ b/packages/lib-engine/src/actions/Find.ts @@ -22,7 +22,7 @@ abstract class Find implements SimpleAction { let query: string; if (text.length > 200) { - query = text.substring(0, 200); + query = text.slice(0, 200); void showWarning( this.ide.messages, "truncatedSearchText", diff --git a/packages/lib-engine/src/actions/GenerateSnippet/GenerateSnippet.ts b/packages/lib-engine/src/actions/GenerateSnippet/GenerateSnippet.ts index e81a3e64313..e457e19968d 100644 --- a/packages/lib-engine/src/actions/GenerateSnippet/GenerateSnippet.ts +++ b/packages/lib-engine/src/actions/GenerateSnippet/GenerateSnippet.ts @@ -195,7 +195,7 @@ export default class GenerateSnippet { const metaSnippetText = serializeSnippetFile(snippetFile) // Escape dollar signs in the snippet text so that they don't get used as // placeholders in the meta snippet - .replace(/\$/g, "\\$") + .replaceAll("$", String.raw`\$`) // Replace constant with dollar sign for meta snippet placeholders .replaceAll(PLACEHOLDER, "$"); diff --git a/packages/lib-engine/src/actions/GetTargets.ts b/packages/lib-engine/src/actions/GetTargets.ts index e4126670108..3039c06d1b2 100644 --- a/packages/lib-engine/src/actions/GetTargets.ts +++ b/packages/lib-engine/src/actions/GetTargets.ts @@ -6,12 +6,12 @@ export default class GetTargets implements SimpleAction { this.run = this.run.bind(this); } - async run(targets: Target[]): Promise { - return { + run(targets: Target[]): Promise { + return Promise.resolve({ returnValue: targets.map(({ contentRange }) => ({ contentRange, })), thatTargets: targets, - }; + }); } } diff --git a/packages/lib-engine/src/actions/IndentLine.ts b/packages/lib-engine/src/actions/IndentLine.ts index cbabde2eff5..07d5ff568bb 100644 --- a/packages/lib-engine/src/actions/IndentLine.ts +++ b/packages/lib-engine/src/actions/IndentLine.ts @@ -96,7 +96,7 @@ function getIndentEdits(editor: TextEditor, targets: Target[]) { return lineNumbers.map((lineNumber) => { const line = document.lineAt(lineNumber); return { - range: line.range.start.toEmptyRange(), + range: Range.fromPosition(line.range.start), text: indent, }; }); diff --git a/packages/lib-engine/src/actions/InsertEmptyLines.ts b/packages/lib-engine/src/actions/InsertEmptyLines.ts index 429a63c1571..4199512f411 100644 --- a/packages/lib-engine/src/actions/InsertEmptyLines.ts +++ b/packages/lib-engine/src/actions/InsertEmptyLines.ts @@ -95,14 +95,6 @@ abstract class InsertEmptyLines implements SimpleAction { } export class InsertEmptyLinesAround extends InsertEmptyLines { - constructor( - ide: IDE, - rangeUpdater: RangeUpdater, - modifierStageFactory: ModifierStageFactory, - ) { - super(ide, rangeUpdater, modifierStageFactory); - } - protected getEdits(targets: Target[]) { return targets.flatMap((target) => [ constructChangeEdit(target, "before"), @@ -112,28 +104,12 @@ export class InsertEmptyLinesAround extends InsertEmptyLines { } export class InsertEmptyLineAbove extends InsertEmptyLines { - constructor( - ide: IDE, - rangeUpdater: RangeUpdater, - modifierStageFactory: ModifierStageFactory, - ) { - super(ide, rangeUpdater, modifierStageFactory); - } - protected getEdits(targets: Target[]) { return targets.map((target) => constructChangeEdit(target, "before")); } } export class InsertEmptyLineBelow extends InsertEmptyLines { - constructor( - ide: IDE, - rangeUpdater: RangeUpdater, - modifierStageFactory: ModifierStageFactory, - ) { - super(ide, rangeUpdater, modifierStageFactory); - } - protected getEdits(targets: Target[]) { return targets.map((target) => constructChangeEdit(target, "after")); } diff --git a/packages/lib-engine/src/actions/PasteFromClipboardDirectly.ts b/packages/lib-engine/src/actions/PasteFromClipboardDirectly.ts index f3183df0c4f..65a622077f7 100644 --- a/packages/lib-engine/src/actions/PasteFromClipboardDirectly.ts +++ b/packages/lib-engine/src/actions/PasteFromClipboardDirectly.ts @@ -34,9 +34,9 @@ export class PasteFromClipboardDirectly { // action, as is done in VSCode. const destinationsWithText: DestinationWithText[] = destinations.length === textLines.length - ? zipStrict(destinations, textLines).map(([destination, text]) => ({ + ? zipStrict(destinations, textLines).map(([destination, lineText]) => ({ destination, - text, + text: lineText, })) : destinations.map((destination) => ({ destination, text })); diff --git a/packages/lib-engine/src/actions/PasteFromClipboardUsingCommand.ts b/packages/lib-engine/src/actions/PasteFromClipboardUsingCommand.ts index cbbbb89efd4..b5b23ce5724 100644 --- a/packages/lib-engine/src/actions/PasteFromClipboardUsingCommand.ts +++ b/packages/lib-engine/src/actions/PasteFromClipboardUsingCommand.ts @@ -2,8 +2,8 @@ import { FlashStyle, RangeExpansionBehavior, toCharacterRange, - type IDE, } from "@cursorless/lib-common"; +import type { IDE } from "@cursorless/lib-common"; import type { RangeUpdater } from "../core/updateSelections/RangeUpdater"; import { performEditsAndUpdateSelections } from "../core/updateSelections/updateSelections"; import type { Destination } from "../typings/target.types"; diff --git a/packages/lib-engine/src/actions/Replace.ts b/packages/lib-engine/src/actions/Replace.ts index 228627dbee5..4c6ef41605f 100644 --- a/packages/lib-engine/src/actions/Replace.ts +++ b/packages/lib-engine/src/actions/Replace.ts @@ -27,7 +27,10 @@ export default class Replace { if (Array.isArray(replaceWith)) { // Broadcast single text to each target if (replaceWith.length === 1) { - return Array(destinations.length).fill(replaceWith[0]); + return Array.from( + { length: destinations.length }, + () => replaceWith[0], + ); } return replaceWith; } diff --git a/packages/lib-engine/src/actions/SetSelection.ts b/packages/lib-engine/src/actions/SetSelection.ts index 77c1f0a6e10..52d70e66707 100644 --- a/packages/lib-engine/src/actions/SetSelection.ts +++ b/packages/lib-engine/src/actions/SetSelection.ts @@ -50,6 +50,7 @@ abstract class SetSelectionBase implements SimpleAction { (target) => new Selection(target.contentRange.end, target.contentRange.end), ); + // No default } } } diff --git a/packages/lib-engine/src/actions/SetSpecialTarget.ts b/packages/lib-engine/src/actions/SetSpecialTarget.ts index 16cabcb3392..5d5f3a3b75b 100644 --- a/packages/lib-engine/src/actions/SetSpecialTarget.ts +++ b/packages/lib-engine/src/actions/SetSpecialTarget.ts @@ -9,10 +9,10 @@ export class SetSpecialTarget implements SimpleAction { this.run = this.run.bind(this); } - async run(targets: Target[]): Promise { - return { + run(targets: Target[]): Promise { + return Promise.resolve({ thatTargets: targets, [`${this.key}Targets`]: targets, - }; + }); } } diff --git a/packages/lib-engine/src/actions/SimpleIdeCommandActions.ts b/packages/lib-engine/src/actions/SimpleIdeCommandActions.ts index 43eba585712..69d8b230af4 100644 --- a/packages/lib-engine/src/actions/SimpleIdeCommandActions.ts +++ b/packages/lib-engine/src/actions/SimpleIdeCommandActions.ts @@ -37,7 +37,7 @@ abstract class SimpleIdeCommandAction { this.run = this.run.bind(this); } - async run( + run( targets: Target[], { showDecorations }: Options = {}, ): Promise { @@ -214,6 +214,8 @@ function callback( // Unsupported as simple action case "highlight": throw new Error("Highlight command not supported as simple action"); + + // No default } } diff --git a/packages/lib-engine/src/actions/Sort.ts b/packages/lib-engine/src/actions/Sort.ts index 63285222eb8..3547cf6dd29 100644 --- a/packages/lib-engine/src/actions/Sort.ts +++ b/packages/lib-engine/src/actions/Sort.ts @@ -1,5 +1,6 @@ import { shuffle } from "lodash-es"; -import { showWarning, type IDE } from "@cursorless/lib-common"; +import { showWarning } from "@cursorless/lib-common"; +import type { IDE } from "@cursorless/lib-common"; import type { Target } from "../typings/target.types"; import type { Actions } from "./Actions"; import type { ActionReturnValue, SimpleAction } from "./actions.types"; diff --git a/packages/lib-engine/src/actions/ToggleBreakpoint.ts b/packages/lib-engine/src/actions/ToggleBreakpoint.ts index 7e585f4fed8..aeb7975f805 100644 --- a/packages/lib-engine/src/actions/ToggleBreakpoint.ts +++ b/packages/lib-engine/src/actions/ToggleBreakpoint.ts @@ -1,4 +1,5 @@ -import { FlashStyle, type IDE } from "@cursorless/lib-common"; +import { FlashStyle } from "@cursorless/lib-common"; +import type { IDE } from "@cursorless/lib-common"; import { containingLineIfUntypedModifier } from "../processTargets/modifiers/commonContainingScopeIfUntypedModifiers"; import type { ModifierStageFactory } from "../processTargets/ModifierStageFactory"; import type { Target } from "../typings/target.types"; diff --git a/packages/lib-engine/src/actions/incrementDecrement.ts b/packages/lib-engine/src/actions/incrementDecrement.ts index 3cc6b2e8324..2aee04d293b 100644 --- a/packages/lib-engine/src/actions/incrementDecrement.ts +++ b/packages/lib-engine/src/actions/incrementDecrement.ts @@ -96,7 +96,7 @@ function updateNumber(isIncrement: boolean, text: string): string { function updateInteger(isIncrement: boolean, text: string): string { const textWithoutUnderscores = text.replaceAll("_", ""); - const original = parseInt(textWithoutUnderscores); + const original = Number.parseInt(textWithoutUnderscores, 10); const diff = 1; const value = original + (isIncrement ? diff : -diff); return formatNumber(value, text, textWithoutUnderscores); @@ -104,12 +104,12 @@ function updateInteger(isIncrement: boolean, text: string): string { function updateFloat(isIncrement: boolean, text: string): string { const textWithoutUnderscores = text.replaceAll("_", ""); - const original = parseFloat(textWithoutUnderscores); - const isPercentage = Math.abs(original) <= 1.0; + const original = Number.parseFloat(textWithoutUnderscores); + const isPercentage = Math.abs(original) <= 1; const diff = isPercentage ? 0.1 : 1; const updated = original + (isIncrement ? diff : -diff); // Remove precision problems that would add a lot of extra digits - const value = parseFloat(updated.toPrecision(15)) / 1; + const value = Number.parseFloat(updated.toPrecision(15)) / 1; const decimalPlaces = textWithoutUnderscores.split(".")[1]?.length; return formatNumber(value, text, textWithoutUnderscores, decimalPlaces); } diff --git a/packages/lib-engine/src/core/Debug.ts b/packages/lib-engine/src/core/Debug.ts index d38c0ad366a..a1584ed00bd 100644 --- a/packages/lib-engine/src/core/Debug.ts +++ b/packages/lib-engine/src/core/Debug.ts @@ -28,6 +28,9 @@ export class Debug { this.disposableConfiguration = ide.configuration.onDidChangeConfiguration(this.evaluateSetting); break; + default: { + const _exhaustiveCheck: never = ide.runMode; + } } } diff --git a/packages/lib-engine/src/core/HatTokenMapImpl.ts b/packages/lib-engine/src/core/HatTokenMapImpl.ts index 34a4392652d..ab0102b349b 100644 --- a/packages/lib-engine/src/core/HatTokenMapImpl.ts +++ b/packages/lib-engine/src/core/HatTokenMapImpl.ts @@ -13,9 +13,9 @@ import { IndividualHatMap } from "./IndividualHatMap"; import type { RangeUpdater } from "./updateSelections/RangeUpdater"; /** - * Maximum age for the pre-phrase snapshot before we consider it to be stale + * Maximum age for the pre-phrase snapshot before we consider it to be stale. 60s. */ -const PRE_PHRASE_SNAPSHOT_MAX_AGE_MS = 60000; // 60 seconds +const PRE_PHRASE_SNAPSHOT_MAX_AGE_MS = 60_000; /** * Maps from (hatStyle, character) pairs to tokens diff --git a/packages/lib-engine/src/core/commandRunner/CommandRunnerImpl.ts b/packages/lib-engine/src/core/commandRunner/CommandRunnerImpl.ts index 48867ab603f..1a67e8adeba 100644 --- a/packages/lib-engine/src/core/commandRunner/CommandRunnerImpl.ts +++ b/packages/lib-engine/src/core/commandRunner/CommandRunnerImpl.ts @@ -261,6 +261,7 @@ export class CommandRunnerImpl implements CommandRunner { return this.getTargets({ type: "implicit" }).map((target) => target.toDestination("to"), ); + // No default } } } @@ -306,7 +307,6 @@ function constructStoredTarget( if (selections != null) { return selections.map(selectionToStoredTarget); - } else { - return targets; } + return targets; } diff --git a/packages/lib-engine/src/core/commandVersionUpgrades/canonicalizeAndValidateCommand.ts b/packages/lib-engine/src/core/commandVersionUpgrades/canonicalizeAndValidateCommand.ts index 24a0e8ff200..1a242cc1d0c 100644 --- a/packages/lib-engine/src/core/commandVersionUpgrades/canonicalizeAndValidateCommand.ts +++ b/packages/lib-engine/src/core/commandVersionUpgrades/canonicalizeAndValidateCommand.ts @@ -97,4 +97,6 @@ export function upgradeCommand( function validateCommand( _actionName: ActionType, _partialTargets: PartialTargetDescriptor[], -): void {} +): void { + // No-op for now +} diff --git a/packages/lib-engine/src/core/commandVersionUpgrades/upgradeV1ToV2/upgradeV1ToV2.ts b/packages/lib-engine/src/core/commandVersionUpgrades/upgradeV1ToV2/upgradeV1ToV2.ts index 99588ee8fb2..30beb8eb299 100644 --- a/packages/lib-engine/src/core/commandVersionUpgrades/upgradeV1ToV2/upgradeV1ToV2.ts +++ b/packages/lib-engine/src/core/commandVersionUpgrades/upgradeV1ToV2/upgradeV1ToV2.ts @@ -186,6 +186,7 @@ function upgradeTarget( } case "primitive": return upgradePrimitiveTarget(target, action); + // No default } } diff --git a/packages/lib-engine/src/core/commandVersionUpgrades/upgradeV2ToV3/upgradeV2ToV3.ts b/packages/lib-engine/src/core/commandVersionUpgrades/upgradeV2ToV3/upgradeV2ToV3.ts index 4a86a8b6e49..12f08974164 100644 --- a/packages/lib-engine/src/core/commandVersionUpgrades/upgradeV2ToV3/upgradeV2ToV3.ts +++ b/packages/lib-engine/src/core/commandVersionUpgrades/upgradeV2ToV3/upgradeV2ToV3.ts @@ -57,6 +57,7 @@ function upgradeTarget( } case "primitive": return upgradePrimitiveTarget(target); + // No default } } @@ -67,7 +68,7 @@ function upgradePrimitiveTarget( target.modifiers != null ? target.modifiers.map(updateModifier) : undefined; if (target.mark?.type === "lineNumber") { - const { anchor, active } = target.mark!; + const { anchor, active } = target.mark; if ( anchor.type !== active.type || anchor.lineNumber < 0 !== active.lineNumber < 0 diff --git a/packages/lib-engine/src/core/commandVersionUpgrades/upgradeV3ToV4/upgradeV3ToV4.ts b/packages/lib-engine/src/core/commandVersionUpgrades/upgradeV3ToV4/upgradeV3ToV4.ts index 0b646d2d028..daf5af1f726 100644 --- a/packages/lib-engine/src/core/commandVersionUpgrades/upgradeV3ToV4/upgradeV3ToV4.ts +++ b/packages/lib-engine/src/core/commandVersionUpgrades/upgradeV3ToV4/upgradeV3ToV4.ts @@ -41,6 +41,7 @@ function upgradeTarget( )[], }; } + // No default } } diff --git a/packages/lib-engine/src/core/commandVersionUpgrades/upgradeV4ToV5/upgradeV4ToV5.ts b/packages/lib-engine/src/core/commandVersionUpgrades/upgradeV4ToV5/upgradeV4ToV5.ts index e766716bd2c..0590e264ab4 100644 --- a/packages/lib-engine/src/core/commandVersionUpgrades/upgradeV4ToV5/upgradeV4ToV5.ts +++ b/packages/lib-engine/src/core/commandVersionUpgrades/upgradeV4ToV5/upgradeV4ToV5.ts @@ -97,6 +97,7 @@ function upgradeTarget( ? target.modifiers.map(upgradeModifier) : undefined, }; + // No default } } diff --git a/packages/lib-engine/src/core/commandVersionUpgrades/upgradeV5ToV6/upgradeV5ToV6.ts b/packages/lib-engine/src/core/commandVersionUpgrades/upgradeV5ToV6/upgradeV5ToV6.ts index 3cd1f7944d6..3ae5d018b35 100644 --- a/packages/lib-engine/src/core/commandVersionUpgrades/upgradeV5ToV6/upgradeV5ToV6.ts +++ b/packages/lib-engine/src/core/commandVersionUpgrades/upgradeV5ToV6/upgradeV5ToV6.ts @@ -152,6 +152,7 @@ function upgradeTarget( return upgradeNonImplicitTarget(target); case "implicit": return target; + // No default } } @@ -167,6 +168,7 @@ function upgradeNonImplicitTarget( case "range": case "primitive": return upgradeRangeOrPrimitiveTarget(target); + // No default } } @@ -187,6 +189,7 @@ function upgradeRangeOrPrimitiveTarget( return upgradeRangeTarget(target); case "primitive": return upgradePrimitiveTarget(target); + // No default } } @@ -236,6 +239,7 @@ function targetToDestination( return primitiveTargetToDestination(target); case "implicit": return implicitTargetToDestination(); + // No default } } @@ -336,6 +340,7 @@ function getInsertionMode( return getInsertionModeFromPrimitive(target); case "range": return getInsertionMode(target.anchor); + // No default } } diff --git a/packages/lib-engine/src/core/inferFullTargetDescriptor.ts b/packages/lib-engine/src/core/inferFullTargetDescriptor.ts index 800cbcc983c..b022ec53e49 100644 --- a/packages/lib-engine/src/core/inferFullTargetDescriptor.ts +++ b/packages/lib-engine/src/core/inferFullTargetDescriptor.ts @@ -42,6 +42,7 @@ export function inferFullTargetDescriptor( return inferPrimitiveTarget(target, previousTargets); case "implicit": return target; + // No default } } @@ -60,6 +61,10 @@ function inferListTarget( return inferRangeTargetWithHoist(element, elementPreviousTargets); case "primitive": return inferPrimitiveTarget(element, elementPreviousTargets); + default: { + const exhaustiveCheck: never = element; + throw new Error(`Unexpected target type: ${exhaustiveCheck}`); + } } }), }; @@ -146,7 +151,7 @@ function getPreservedModifiers( target.modifiers?.filter( (modifier) => modifier.type !== "inferPreviousMark", ) ?? []; - return preservedModifiers.length !== 0 ? preservedModifiers : undefined; + return preservedModifiers.length > 0 ? preservedModifiers : undefined; } /** @@ -174,7 +179,6 @@ function getLineNumberMarkModifiers( * @returns True if this target has a line number mark */ function isLineNumberMark(target: PartialPrimitiveTargetDescriptor): boolean { - const isLineNumber = (mark?: PartialMark) => mark?.type === "lineNumber"; if (isLineNumber(target.mark)) { return true; } @@ -184,6 +188,10 @@ function isLineNumberMark(target: PartialPrimitiveTargetDescriptor): boolean { return false; } +function isLineNumber(mark?: PartialMark) { + return mark?.type === "lineNumber"; +} + function getPreviousMark( previousTargets: PartialTargetDescriptor[], ): PartialMark | undefined { @@ -253,6 +261,7 @@ function getPreviousTargetAttribute( } break; } + // No default } } return undefined; diff --git a/packages/lib-engine/src/core/updateSelections/getOffsetsForEmptyRangeInsert.ts b/packages/lib-engine/src/core/updateSelections/getOffsetsForEmptyRangeInsert.ts index 43b11df4af2..ac3f225de05 100644 --- a/packages/lib-engine/src/core/updateSelections/getOffsetsForEmptyRangeInsert.ts +++ b/packages/lib-engine/src/core/updateSelections/getOffsetsForEmptyRangeInsert.ts @@ -74,6 +74,8 @@ export default function getOffsetsForEmptyRangeInsert( end: start + matches[0].length, }; } + + // No default } } else { // In this case the range moves to the right so we care about the start of the range @@ -101,6 +103,8 @@ export default function getOffsetsForEmptyRangeInsert( start: start + index, end, }; + + // No default } } } diff --git a/packages/lib-engine/src/core/updateSelections/getOffsetsForNonEmptyRangeInsert.ts b/packages/lib-engine/src/core/updateSelections/getOffsetsForNonEmptyRangeInsert.ts index d8ddfa96aee..418ea4a89ef 100644 --- a/packages/lib-engine/src/core/updateSelections/getOffsetsForNonEmptyRangeInsert.ts +++ b/packages/lib-engine/src/core/updateSelections/getOffsetsForNonEmptyRangeInsert.ts @@ -96,6 +96,8 @@ export default function getOffsetsForNonEmptyRangeInsert( end: newRangeEnd, }; } + + // No default } } else { const expansionBehavior = rangeInfo.expansionBehavior.end; @@ -136,6 +138,8 @@ export default function getOffsetsForNonEmptyRangeInsert( end: rangeStart + matchLength, }; } + + // No default } } } diff --git a/packages/lib-engine/src/core/updateSelections/getUpdatedText.ts b/packages/lib-engine/src/core/updateSelections/getUpdatedText.ts index fd3f87775f1..251c2bb43c0 100644 --- a/packages/lib-engine/src/core/updateSelections/getUpdatedText.ts +++ b/packages/lib-engine/src/core/updateSelections/getUpdatedText.ts @@ -36,7 +36,7 @@ export function getUpdatedText( // First add any text from the range before the start of the change range if (rangeOriginalOffsetsStart < changeOriginalOffsetsStart) { - result += rangeInfo.text.substring( + result += rangeInfo.text.slice( 0, changeOriginalOffsetsStart - rangeOriginalOffsetsStart, ); @@ -47,14 +47,13 @@ export function getUpdatedText( // Then add any text that was after the original change range if (changeOriginalOffsetsEnd < rangeOriginalOffsetsEnd) { - result += rangeInfo.text.substring( + result += rangeInfo.text.slice( rangeOriginalOffsetsEnd - changeOriginalOffsetsEnd, - rangeInfo.text.length, ); } // Then take a substring based on the range's new offsets - return result.substring( + return result.slice( newOffsets.start - newTextStartOffset, newOffsets.end - newTextStartOffset, ); diff --git a/packages/lib-engine/src/customCommandGrammar/CommandLexer.ts b/packages/lib-engine/src/customCommandGrammar/CommandLexer.ts index 7d2c5a20225..9a250e331e7 100644 --- a/packages/lib-engine/src/customCommandGrammar/CommandLexer.ts +++ b/packages/lib-engine/src/customCommandGrammar/CommandLexer.ts @@ -1,8 +1,9 @@ -import moo, { - type Lexer as MooLexer, - type LexerState as MooLexerState, - type Rules, - type Token as MooToken, +import moo from "moo"; +import type { + Lexer as MooLexer, + LexerState as MooLexerState, + Rules, + Token as MooToken, } from "moo"; export interface NearleyToken { diff --git a/packages/lib-engine/src/customCommandGrammar/fillPlaceholders.ts b/packages/lib-engine/src/customCommandGrammar/fillPlaceholders.ts index 2ff5e0d1cce..37675ea9e26 100644 --- a/packages/lib-engine/src/customCommandGrammar/fillPlaceholders.ts +++ b/packages/lib-engine/src/customCommandGrammar/fillPlaceholders.ts @@ -24,7 +24,7 @@ export function fillPlaceholders( const result: Partial = {}; for (const key in input) { - if (Object.prototype.hasOwnProperty.call(input, key)) { + if (Object.hasOwn(input, key)) { result[key as keyof T] = fillPlaceholders((input as any)[key], values); } } diff --git a/packages/lib-engine/src/customCommandGrammar/grammarAction.test.ts b/packages/lib-engine/src/customCommandGrammar/grammarAction.test.ts index dcec77a11ed..58a55be0767 100644 --- a/packages/lib-engine/src/customCommandGrammar/grammarAction.test.ts +++ b/packages/lib-engine/src/customCommandGrammar/grammarAction.test.ts @@ -1,5 +1,5 @@ import * as assert from "node:assert/strict"; -import { type ActionDescriptor } from "@cursorless/lib-common"; +import type { ActionDescriptor } from "@cursorless/lib-common"; import { parseAction } from "./parseCommand"; import type { WithPlaceholders } from "./WithPlaceholders"; diff --git a/packages/lib-engine/src/customCommandGrammar/grammarUtil.ts b/packages/lib-engine/src/customCommandGrammar/grammarUtil.ts index 3b62291c7b0..ebe3c75e5a6 100644 --- a/packages/lib-engine/src/customCommandGrammar/grammarUtil.ts +++ b/packages/lib-engine/src/customCommandGrammar/grammarUtil.ts @@ -111,7 +111,7 @@ export function createPlaceholderTarget( type: "target", target: { type: "placeholder", - index: index.length === 0 ? 0 : parseInt(index) - 1, + index: index.length === 0 ? 0 : Number.parseInt(index, 10) - 1, }, }; } diff --git a/packages/lib-engine/src/disabledComponents/DisabledHatTokenMap.ts b/packages/lib-engine/src/disabledComponents/DisabledHatTokenMap.ts index f0eb195ec90..66ac5799bc7 100644 --- a/packages/lib-engine/src/disabledComponents/DisabledHatTokenMap.ts +++ b/packages/lib-engine/src/disabledComponents/DisabledHatTokenMap.ts @@ -5,15 +5,15 @@ export class DisabledHatTokenMap implements HatTokenMap { // Do nothing } - async getReadableMap() { - return { + getReadableMap() { + return Promise.resolve({ getEntries() { return []; }, getToken() { throw new Error("Hat map is disabled"); }, - }; + }); } dispose() { diff --git a/packages/lib-engine/src/disabledComponents/DisabledLanguageDefinitions.ts b/packages/lib-engine/src/disabledComponents/DisabledLanguageDefinitions.ts index 113ebbf2ede..34b5bc50f37 100644 --- a/packages/lib-engine/src/disabledComponents/DisabledLanguageDefinitions.ts +++ b/packages/lib-engine/src/disabledComponents/DisabledLanguageDefinitions.ts @@ -4,7 +4,11 @@ import type { LanguageDefinitions } from "../languages/LanguageDefinitions"; export class DisabledLanguageDefinitions implements LanguageDefinitions { onDidChangeDefinition(_listener: Listener) { - return { dispose: () => {} }; + return { + dispose: () => { + // No-op + }, + }; } loadLanguage(_languageId: string): Promise { @@ -16,6 +20,6 @@ export class DisabledLanguageDefinitions implements LanguageDefinitions { } dispose(): void { - // Do nothing + // No-op } } diff --git a/packages/lib-engine/src/disabledComponents/DisabledTalonSpokenForms.ts b/packages/lib-engine/src/disabledComponents/DisabledTalonSpokenForms.ts index a6657f07e57..f9fe1094646 100644 --- a/packages/lib-engine/src/disabledComponents/DisabledTalonSpokenForms.ts +++ b/packages/lib-engine/src/disabledComponents/DisabledTalonSpokenForms.ts @@ -7,6 +7,10 @@ export class DisabledTalonSpokenForms implements TalonSpokenForms { } onDidChange() { - return { dispose: () => {} }; + return { + dispose: () => { + // No-op + }, + }; } } diff --git a/packages/lib-engine/src/generateSpokenForm/CustomSpokenFormGeneratorImpl.test.ts b/packages/lib-engine/src/generateSpokenForm/CustomSpokenFormGeneratorImpl.test.ts index 5bcc2ed5f22..4b8df6f57c5 100644 --- a/packages/lib-engine/src/generateSpokenForm/CustomSpokenFormGeneratorImpl.test.ts +++ b/packages/lib-engine/src/generateSpokenForm/CustomSpokenFormGeneratorImpl.test.ts @@ -2,13 +2,13 @@ import * as assert from "node:assert/strict"; import { FakeIDE, LATEST_VERSION, asyncSafety } from "@cursorless/lib-common"; import { CustomSpokenFormGeneratorImpl } from "./CustomSpokenFormGeneratorImpl"; -suite("CustomSpokenFormGeneratorImpl", async function () { +suite("CustomSpokenFormGeneratorImpl", function () { test( "basic", asyncSafety(async () => { const generator = new CustomSpokenFormGeneratorImpl(new FakeIDE(), { - async getSpokenFormEntries() { - return [ + getSpokenFormEntries() { + return Promise.resolve([ { type: "complexScopeTypeType", id: "glyph", @@ -24,9 +24,13 @@ suite("CustomSpokenFormGeneratorImpl", async function () { id: "a", spokenForms: ["alabaster"], }, - ]; + ]); }, - onDidChange: () => ({ dispose() {} }), + onDidChange: () => ({ + dispose() { + // no-op + }, + }), }); await generator.customSpokenFormsInitialized; diff --git a/packages/lib-engine/src/generateSpokenForm/CustomSpokenFormGeneratorImpl.ts b/packages/lib-engine/src/generateSpokenForm/CustomSpokenFormGeneratorImpl.ts index 00f411c956b..6e80633a1f7 100644 --- a/packages/lib-engine/src/generateSpokenForm/CustomSpokenFormGeneratorImpl.ts +++ b/packages/lib-engine/src/generateSpokenForm/CustomSpokenFormGeneratorImpl.ts @@ -44,7 +44,7 @@ export class CustomSpokenFormGeneratorImpl implements CustomSpokenFormGenerator ]; } - onDidChangeCustomSpokenForms(listener: Listener<[]>) { + onDidChangeCustomSpokenForms(listener: Listener) { return this.customSpokenForms.onDidChangeCustomSpokenForms(listener); } diff --git a/packages/lib-engine/src/generateSpokenForm/NoSpokenFormError.ts b/packages/lib-engine/src/generateSpokenForm/NoSpokenFormError.ts index 0f2b86f3325..498eea6af16 100644 --- a/packages/lib-engine/src/generateSpokenForm/NoSpokenFormError.ts +++ b/packages/lib-engine/src/generateSpokenForm/NoSpokenFormError.ts @@ -5,5 +5,6 @@ export class NoSpokenFormError extends Error { public isPrivate: boolean = false, ) { super(`No spoken form for: ${reason}`); + this.name = "NoSpokenFormError"; } } diff --git a/packages/lib-engine/src/generateSpokenForm/defaultSpokenForms/surroundingPairsDelimiters.ts b/packages/lib-engine/src/generateSpokenForm/defaultSpokenForms/surroundingPairsDelimiters.ts index d9e967575cd..f69c631a1e9 100644 --- a/packages/lib-engine/src/generateSpokenForm/defaultSpokenForms/surroundingPairsDelimiters.ts +++ b/packages/lib-engine/src/generateSpokenForm/defaultSpokenForms/surroundingPairsDelimiters.ts @@ -6,10 +6,10 @@ export const surroundingPairsDelimiters: Record< > = { curlyBrackets: ["{", "}"], angleBrackets: ["<", ">"], - escapedDoubleQuotes: ['\\"', '\\"'], - escapedSingleQuotes: ["\\'", "\\'"], - escapedParentheses: ["\\(", "\\)"], - escapedSquareBrackets: ["\\[", "\\]"], + escapedDoubleQuotes: [String.raw`\"`, String.raw`\"`], + escapedSingleQuotes: [String.raw`\'`, String.raw`\'`], + escapedParentheses: [String.raw`\(`, String.raw`\)`], + escapedSquareBrackets: [String.raw`\[`, String.raw`\]`], doubleQuotes: ['"', '"'], parentheses: ["(", ")"], backtickQuotes: ["`", "`"], diff --git a/packages/lib-engine/src/generateSpokenForm/generateSpokenForm.test.ts b/packages/lib-engine/src/generateSpokenForm/generateSpokenForm.test.ts index 345399f055f..0c8d5758eef 100644 --- a/packages/lib-engine/src/generateSpokenForm/generateSpokenForm.test.ts +++ b/packages/lib-engine/src/generateSpokenForm/generateSpokenForm.test.ts @@ -93,17 +93,15 @@ async function runTest(file: string) { } await fsp.writeFile(file, serializeTestFixture(fixture)); + } else if (generatedSpokenForm.type === "success") { + assert.equal( + fixture.command.spokenForm, + generatedSpokenForm.spokenForms[0], + ); + assert.equal(fixture.spokenFormError, undefined); } else { - if (generatedSpokenForm.type === "success") { - assert.equal( - fixture.command.spokenForm, - generatedSpokenForm.spokenForms[0], - ); - assert.equal(fixture.spokenFormError, undefined); - } else { - assert.equal(fixture.spokenFormError, generatedSpokenForm.reason); - // Don't care what the spoken form is in the test case if we don't know - // how to generate it - } + assert.equal(fixture.spokenFormError, generatedSpokenForm.reason); + // Don't care what the spoken form is in the test case if we don't know + // how to generate it } } diff --git a/packages/lib-engine/src/generateSpokenForm/generateSpokenForm.ts b/packages/lib-engine/src/generateSpokenForm/generateSpokenForm.ts index d828c60d874..11a35b21481 100644 --- a/packages/lib-engine/src/generateSpokenForm/generateSpokenForm.ts +++ b/packages/lib-engine/src/generateSpokenForm/generateSpokenForm.ts @@ -99,17 +99,17 @@ export class SpokenFormGenerator { type: "success", spokenForms: constructSpokenForms(getComponents()), }; - } catch (e) { - if (e instanceof NoSpokenFormError) { + } catch (error) { + if (error instanceof NoSpokenFormError) { return { type: "error", - reason: e.reason, - requiresTalonUpdate: e.requiresTalonUpdate, - isPrivate: e.isPrivate, + reason: error.reason, + requiresTalonUpdate: error.requiresTalonUpdate, + isPrivate: error.isPrivate, }; } - throw e; + throw error; } } @@ -243,6 +243,8 @@ export class SpokenFormGenerator { case "implicit": return []; + + // No default } } @@ -269,6 +271,8 @@ export class SpokenFormGenerator { case "implicit": return []; + + // No default } } @@ -280,6 +284,7 @@ export class SpokenFormGenerator { return connectives.before; case "after": return connectives.after; + // No default } } } @@ -295,7 +300,7 @@ function constructSpokenForms(component: SpokenFormComponent): string[] { } return cartesianProduct(component.map(constructSpokenForms)).map((words) => - words.filter((word) => word.length !== 0).join(" "), + words.filter((word) => word.length > 0).join(" "), ); } @@ -344,6 +349,6 @@ function cartesianProduct(arrays: T[][]): T[][] { const [first, ...rest] = arrays; const restCartesianProduct = cartesianProduct(rest); return first.flatMap((element) => - restCartesianProduct.map((restElement) => [element, ...restElement]), + restCartesianProduct.map((restElement) => [element].concat(restElement)), ); } diff --git a/packages/lib-engine/src/generateSpokenForm/primitiveTargetToSpokenForm.ts b/packages/lib-engine/src/generateSpokenForm/primitiveTargetToSpokenForm.ts index ac468edbd4f..370fc044908 100644 --- a/packages/lib-engine/src/generateSpokenForm/primitiveTargetToSpokenForm.ts +++ b/packages/lib-engine/src/generateSpokenForm/primitiveTargetToSpokenForm.ts @@ -344,6 +344,7 @@ export class PrimitiveTargetSpokenFormGenerator { numberToSpokenForm(Math.abs(mark.lineNumber)), ]; } + // No default } } } diff --git a/packages/lib-engine/src/languages/LanguageDefinitions.ts b/packages/lib-engine/src/languages/LanguageDefinitions.ts index 8d64bb196c5..03748ab883c 100644 --- a/packages/lib-engine/src/languages/LanguageDefinitions.ts +++ b/packages/lib-engine/src/languages/LanguageDefinitions.ts @@ -60,14 +60,16 @@ export class LanguageDefinitionsImpl implements LanguageDefinitions { private treeSitterQueryProvider: RawTreeSitterQueryProvider, ) { this.disposables.push( - ide.onDidOpenTextDocument((document) => { - this.loadLanguage(document.languageId).catch((err) => { + ide.onDidOpenTextDocument(async (document) => { + try { + await this.loadLanguage(document.languageId); + } catch (error) { void showError( this.ide.messages, `Failed to load language definition: ${document.languageId}`, - getErrorMessage(err), + getErrorMessage(error), ); - }); + } }), ide.onDidChangeVisibleTextEditors((editors) => { @@ -105,14 +107,14 @@ export class LanguageDefinitionsImpl implements LanguageDefinitions { await Promise.all( languageIds.map((languageId) => this.loadLanguage(languageId)), ); - } catch (err) { + } catch (error) { void showError( this.ide.messages, "Failed to load language definitions", - getErrorMessage(err), + getErrorMessage(error), ); if (this.ide.runMode === "test") { - throw err; + throw error; } } } diff --git a/packages/lib-engine/src/languages/TreeSitterQuery/QueryPredicateOperator.ts b/packages/lib-engine/src/languages/TreeSitterQuery/QueryPredicateOperator.ts index 5ec3bb09dfc..fc52f500761 100644 --- a/packages/lib-engine/src/languages/TreeSitterQuery/QueryPredicateOperator.ts +++ b/packages/lib-engine/src/languages/TreeSitterQuery/QueryPredicateOperator.ts @@ -81,15 +81,15 @@ export abstract class QueryPredicateOperator { try { const acceptArgs = this.constructAcceptArgs(result.data, match); return this.run(...acceptArgs); - } catch (err) { + } catch (error) { if ( - err instanceof CaptureNotFoundError && + error instanceof CaptureNotFoundError && this.allowMissingNode() ) { return true; } - throw err; + throw error; } }, } @@ -121,9 +121,8 @@ export abstract class QueryPredicateOperator { } return capture; - } else { - return operand.value; } + return operand.value; }) as AcceptFunctionArgs>>; } } @@ -143,5 +142,6 @@ type PredicateResult = SuccessfulPredicateResult | FailedPredicateResult; class CaptureNotFoundError extends Error { constructor(operandName: string) { super(`Could not find capture ${operandName}`); + this.name = "CaptureNotFoundError"; } } diff --git a/packages/lib-engine/src/languages/TreeSitterQuery/checkCaptureStartEnd.test.ts b/packages/lib-engine/src/languages/TreeSitterQuery/checkCaptureStartEnd.test.ts index 7845c542198..e4cc17b33f4 100644 --- a/packages/lib-engine/src/languages/TreeSitterQuery/checkCaptureStartEnd.test.ts +++ b/packages/lib-engine/src/languages/TreeSitterQuery/checkCaptureStartEnd.test.ts @@ -186,9 +186,9 @@ suite("checkCaptureStartEnd", () => { test(testCase.name, () => { const actualErrorIds: string[] = []; const messages: Messages = { - async showMessage(_type, id, _message) { + showMessage(_type, id, _message) { actualErrorIds.push(id); - return undefined; + return Promise.resolve(undefined); }, }; diff --git a/packages/lib-engine/src/languages/TreeSitterQuery/constructZodErrorMessages.ts b/packages/lib-engine/src/languages/TreeSitterQuery/constructZodErrorMessages.ts index 4288eb22b42..4e9b2e81081 100644 --- a/packages/lib-engine/src/languages/TreeSitterQuery/constructZodErrorMessages.ts +++ b/packages/lib-engine/src/languages/TreeSitterQuery/constructZodErrorMessages.ts @@ -4,7 +4,7 @@ import { operandToString } from "./predicateToString"; export function constructZodErrorMessages( inputOperands: PredicateStep[], - error: z.ZodError>, + error: z.ZodError, ): string[] { return error.issues .filter( diff --git a/packages/lib-engine/src/languages/TreeSitterQuery/queryPredicateOperators.ts b/packages/lib-engine/src/languages/TreeSitterQuery/queryPredicateOperators.ts index 17d5874564c..c003b692a10 100644 --- a/packages/lib-engine/src/languages/TreeSitterQuery/queryPredicateOperators.ts +++ b/packages/lib-engine/src/languages/TreeSitterQuery/queryPredicateOperators.ts @@ -431,11 +431,17 @@ class EmptySingleMultiDelimiter extends QueryPredicateOperator child.isNamed, ); - capture.insertionDelimiter = isEmpty - ? insertionDelimiterEmpty - : conditionCapture.range.isSingleLine - ? insertionDelimiterSingleLine - : insertionDelimiterMultiline; + let insertionDelimiter: string; + + if (isEmpty) { + insertionDelimiter = insertionDelimiterEmpty; + } else if (conditionCapture.range.isSingleLine) { + insertionDelimiter = insertionDelimiterSingleLine; + } else { + insertionDelimiter = insertionDelimiterMultiline; + } + + capture.insertionDelimiter = insertionDelimiter; return true; } diff --git a/packages/lib-engine/src/languages/TreeSitterQuery/rewriteStartOfEndOf.ts b/packages/lib-engine/src/languages/TreeSitterQuery/rewriteStartOfEndOf.ts index 266b5cb27da..394810d7381 100644 --- a/packages/lib-engine/src/languages/TreeSitterQuery/rewriteStartOfEndOf.ts +++ b/packages/lib-engine/src/languages/TreeSitterQuery/rewriteStartOfEndOf.ts @@ -1,5 +1,5 @@ import type { Node } from "web-tree-sitter"; -import type { Range } from "@cursorless/lib-common"; +import { Range } from "@cursorless/lib-common"; import { getNodeEndRange, getNodeRange, @@ -28,10 +28,10 @@ export function rewriteStartOfEndOf(captures: QueryCapture[]): QueryCapture[] { export function getStartOfEndOfRange(capture: QueryCapture): Range { if (capture.name.endsWith(START_OF)) { - return capture.range.start.toEmptyRange(); + return Range.fromPosition(capture.range.start); } if (capture.name.endsWith(END_OF)) { - return capture.range.end.toEmptyRange(); + return Range.fromPosition(capture.range.end); } return capture.range; } diff --git a/packages/lib-engine/src/languages/TreeSitterQuery/validateQueryCaptures.ts b/packages/lib-engine/src/languages/TreeSitterQuery/validateQueryCaptures.ts index 0ae2d75c4e4..ddba5080252 100644 --- a/packages/lib-engine/src/languages/TreeSitterQuery/validateQueryCaptures.ts +++ b/packages/lib-engine/src/languages/TreeSitterQuery/validateQueryCaptures.ts @@ -1,4 +1,5 @@ -import { showError, type IDE } from "@cursorless/lib-common"; +import { showError } from "@cursorless/lib-common"; +import type { IDE } from "@cursorless/lib-common"; import { isCaptureAllowed } from "./captureNames"; // Not a comment. ie line is not starting with `;;` diff --git a/packages/lib-engine/src/processTargets/TargetPipelineRunner.ts b/packages/lib-engine/src/processTargets/TargetPipelineRunner.ts index c61020df7b0..780802530f1 100644 --- a/packages/lib-engine/src/processTargets/TargetPipelineRunner.ts +++ b/packages/lib-engine/src/processTargets/TargetPipelineRunner.ts @@ -108,6 +108,7 @@ class TargetPipeline { case "primitive": case "implicit": return this.processPrimitiveTarget(target); + // No default } } @@ -137,6 +138,10 @@ class TargetPipeline { targetDesc.excludeAnchor, targetDesc.excludeActive, ); + default: { + const exhaustiveCheck: never = targetDesc.rangeType; + throw new Error(`Unknown range type: ${exhaustiveCheck}`); + } } }, ); @@ -410,6 +415,7 @@ function targetsToVerticalTarget( const activeLine = activePosition.line - (excludeActive ? delta : 0); const results: Target[] = []; + // oxlint-disable-next-line no-constant-condition for (let i = anchorLine; true; i += delta) { const contentRange = new Range( i, diff --git a/packages/lib-engine/src/processTargets/marks/LineNumberStage.ts b/packages/lib-engine/src/processTargets/marks/LineNumberStage.ts index 817f72ad585..00f3490d64f 100644 --- a/packages/lib-engine/src/processTargets/marks/LineNumberStage.ts +++ b/packages/lib-engine/src/processTargets/marks/LineNumberStage.ts @@ -37,8 +37,10 @@ const getLineNumber = ( switch (lineNumberType) { case "absolute": return lineNumber; + case "relative": return editor.selections[0].active.line + lineNumber; + case "modulo100": { const stepSize = 100; const startLine = editor.visibleRanges[0].start.line; @@ -74,5 +76,7 @@ const getLineNumber = ( } throw new Error("Line is not in viewport"); } + + // No default } }; diff --git a/packages/lib-engine/src/processTargets/modifiers/BoundaryStage.ts b/packages/lib-engine/src/processTargets/modifiers/BoundaryStage.ts index 06a7e2464b9..79b51944a5d 100644 --- a/packages/lib-engine/src/processTargets/modifiers/BoundaryStage.ts +++ b/packages/lib-engine/src/processTargets/modifiers/BoundaryStage.ts @@ -1,4 +1,4 @@ -import { type ExcludeInteriorModifier } from "@cursorless/lib-common"; +import type { ExcludeInteriorModifier } from "@cursorless/lib-common"; import type { Target } from "../../typings/target.types"; import type { ModifierStageFactory } from "../ModifierStageFactory"; import type { diff --git a/packages/lib-engine/src/processTargets/modifiers/ConditionalModifierStages.ts b/packages/lib-engine/src/processTargets/modifiers/ConditionalModifierStages.ts index dc602799ed5..237dc52d9ce 100644 --- a/packages/lib-engine/src/processTargets/modifiers/ConditionalModifierStages.ts +++ b/packages/lib-engine/src/processTargets/modifiers/ConditionalModifierStages.ts @@ -22,10 +22,10 @@ abstract class ConditionalModifierBaseStage implements ModifierStage { return this.nestedStage .run(target, options) .map((newTarget) => newTarget.withThatTarget(target)); - } catch (ex) { + } catch (error) { // suppressErrors === true => Allow this target to be returned unmodified if (!this.suppressErrors) { - throw ex; + throw error; } } } diff --git a/packages/lib-engine/src/processTargets/modifiers/FallbackStage.ts b/packages/lib-engine/src/processTargets/modifiers/FallbackStage.ts index d61aa864293..76b12e1d321 100644 --- a/packages/lib-engine/src/processTargets/modifiers/FallbackStage.ts +++ b/packages/lib-engine/src/processTargets/modifiers/FallbackStage.ts @@ -24,7 +24,7 @@ export class FallbackStage implements ModifierStage { for (const stage of stages) { try { return stage.run(target, options); - } catch (_error) { + } catch { continue; } } diff --git a/packages/lib-engine/src/processTargets/modifiers/HeadTailStage.ts b/packages/lib-engine/src/processTargets/modifiers/HeadTailStage.ts index 81747bbd19e..4aa9ed9fb10 100644 --- a/packages/lib-engine/src/processTargets/modifiers/HeadTailStage.ts +++ b/packages/lib-engine/src/processTargets/modifiers/HeadTailStage.ts @@ -1,8 +1,8 @@ -import { - NoContainingScopeError, - type HeadModifier, - type Modifier, - type TailModifier, +import { NoContainingScopeError } from "@cursorless/lib-common"; +import type { + HeadModifier, + Modifier, + TailModifier, } from "@cursorless/lib-common"; import type { Target } from "../../typings/target.types"; import type { ModifierStageFactory } from "../ModifierStageFactory"; diff --git a/packages/lib-engine/src/processTargets/modifiers/InstanceStage.ts b/packages/lib-engine/src/processTargets/modifiers/InstanceStage.ts index bc3a0a4dcc7..db758f42f63 100644 --- a/packages/lib-engine/src/processTargets/modifiers/InstanceStage.ts +++ b/packages/lib-engine/src/processTargets/modifiers/InstanceStage.ts @@ -192,7 +192,7 @@ export class InstanceStage implements ModifierStage { } return null; - } catch (_err) { + } catch { return null; } }), diff --git a/packages/lib-engine/src/processTargets/modifiers/InteriorStage.ts b/packages/lib-engine/src/processTargets/modifiers/InteriorStage.ts index 340907d4999..910de0d04a7 100644 --- a/packages/lib-engine/src/processTargets/modifiers/InteriorStage.ts +++ b/packages/lib-engine/src/processTargets/modifiers/InteriorStage.ts @@ -45,11 +45,11 @@ export class InteriorOnlyStage implements ModifierStage { try { return everyModifier.run(target, options); - } catch (e) { - if (e instanceof UnsupportedScopeError) { + } catch (error) { + if (error instanceof UnsupportedScopeError) { throw new NoContainingScopeError("interior"); } - throw e; + throw error; } } @@ -61,11 +61,11 @@ export class InteriorOnlyStage implements ModifierStage { scopeType: compoundInteriorScopeType, }) .run(target, options); - } catch (e) { - if (e instanceof NoContainingScopeError) { + } catch (error) { + if (error instanceof NoContainingScopeError) { throw new NoContainingScopeError("interior"); } - throw e; + throw error; } } } diff --git a/packages/lib-engine/src/processTargets/modifiers/PositionStage.ts b/packages/lib-engine/src/processTargets/modifiers/PositionStage.ts index f17b41337d0..037aa0cadb8 100644 --- a/packages/lib-engine/src/processTargets/modifiers/PositionStage.ts +++ b/packages/lib-engine/src/processTargets/modifiers/PositionStage.ts @@ -1,4 +1,4 @@ -import type { Range } from "@cursorless/lib-common"; +import { Range } from "@cursorless/lib-common"; import type { Target } from "../../typings/target.types"; import type { ModifierStage } from "../PipelineStages.types"; import type { CommonTargetParameters } from "../targets"; @@ -24,12 +24,12 @@ abstract class PositionStage implements ModifierStage { export class StartOfStage extends PositionStage { protected getContentRange(contentRange: Range): Range { - return contentRange.start.toEmptyRange(); + return Range.fromPosition(contentRange.start); } } export class EndOfStage extends PositionStage { protected getContentRange(contentRange: Range): Range { - return contentRange.end.toEmptyRange(); + return Range.fromPosition(contentRange.end); } } diff --git a/packages/lib-engine/src/processTargets/modifiers/PreferredScopeStage.ts b/packages/lib-engine/src/processTargets/modifiers/PreferredScopeStage.ts index 1214a70c328..6b2ce5edb31 100644 --- a/packages/lib-engine/src/processTargets/modifiers/PreferredScopeStage.ts +++ b/packages/lib-engine/src/processTargets/modifiers/PreferredScopeStage.ts @@ -30,10 +30,10 @@ export class PreferredScopeStage implements ModifierStage { try { return containingScopeStage.run(target); - } catch (ex) { + } catch (error) { // NoContainingScopeError is thrown if no containing scope was found, which is fine. - if (!(ex instanceof NoContainingScopeError)) { - throw ex; + if (!(error instanceof NoContainingScopeError)) { + throw error; } } @@ -104,6 +104,6 @@ function getClosestScope(scopes: Iterable, position: Position) { function distanceBetweenPositions(a: Position, b: Position): number { return ( // 10000 is arbitrary to always pick same-line occurrences first - Math.abs(a.line - b.line) * 10000 + Math.abs(a.character - b.character) + Math.abs(a.line - b.line) * 10_000 + Math.abs(a.character - b.character) ); } diff --git a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/CollectionItemScopeHandler/getInteriorRanges.ts b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/CollectionItemScopeHandler/getInteriorRanges.ts index e4d7944f1e0..cd10a1a394d 100644 --- a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/CollectionItemScopeHandler/getInteriorRanges.ts +++ b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/CollectionItemScopeHandler/getInteriorRanges.ts @@ -1,8 +1,8 @@ -import { - type Range, - type SurroundingPairName, - type TextEditor, - Position, +import { Position } from "@cursorless/lib-common"; +import type { + Range, + SurroundingPairName, + TextEditor, } from "@cursorless/lib-common"; import type { ScopeHandlerFactory } from "../ScopeHandlerFactory"; diff --git a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/ConditionalScopeHandler.ts b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/ConditionalScopeHandler.ts index 6c8e454a3a9..f6b89fc6696 100644 --- a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/ConditionalScopeHandler.ts +++ b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/ConditionalScopeHandler.ts @@ -1,10 +1,10 @@ import { ifilter } from "itertools"; -import { - NoContainingScopeError, - type Direction, - type Position, - type ScopeType, - type TextEditor, +import { NoContainingScopeError } from "@cursorless/lib-common"; +import type { + Direction, + Position, + ScopeType, + TextEditor, } from "@cursorless/lib-common"; import { BaseScopeHandler } from "./BaseScopeHandler"; import type { TargetScope } from "./scope.types"; diff --git a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/FallbackScopeHandler.ts b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/FallbackScopeHandler.ts index 515098135f8..1aba8e734bb 100644 --- a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/FallbackScopeHandler.ts +++ b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/FallbackScopeHandler.ts @@ -1,8 +1,4 @@ -import { - type Direction, - type Position, - type TextEditor, -} from "@cursorless/lib-common"; +import type { Direction, Position, TextEditor } from "@cursorless/lib-common"; import { BaseScopeHandler } from "./BaseScopeHandler"; import type { TargetScope } from "./scope.types"; import type { diff --git a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/IteratorInfo.ts b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/IteratorInfo.ts index deafe0ad4a3..8d4ade7256e 100644 --- a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/IteratorInfo.ts +++ b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/IteratorInfo.ts @@ -35,25 +35,26 @@ export function getInitialIteratorInfos( } /** - * Advances each iterator until {@link criterion} is `true`, pruning iterators - * that terminate without {@link criterion} becoming `true`. + * Advances each iterator until {@link predicate} is `true`, pruning iterators + * that terminate without {@link predicate} becoming `true`. * * @param iteratorInfos A list of iterator infos - * @param criterion The criterion to check + * @param predicate The predicate to check * @returns A new set of iterator infos that have been advanced until - * {@link criterion} is `true`. Any iterators that terminate without meeting - * {@link criterion} are removed + * {@link predicate} is `true`. Any iterators that terminate without meeting + * {@link predicate} are removed */ export function advanceIteratorsUntil( iteratorInfos: IteratorInfo[], - criterion: (arg: T) => boolean, + predicate: (arg: T) => boolean, ): IteratorInfo[] { + // oxlint-disable-next-line array-callback-return return iteratorInfos.flatMap((iteratorInfo) => { const { iterator, index } = iteratorInfo; let { value } = iteratorInfo; let done: boolean | undefined = false; - while (!done && !criterion(value)) { + while (!done && !predicate(value)) { ({ value, done } = iterator.next()); } diff --git a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/NotebookCellScopeHandler.ts b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/NotebookCellScopeHandler.ts index 602cbbdffba..8f0299cd8d6 100644 --- a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/NotebookCellScopeHandler.ts +++ b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/NotebookCellScopeHandler.ts @@ -1,9 +1,9 @@ -import { - type Direction, - type IDE, - type Position, - type ScopeType, - type TextEditor, +import type { + Direction, + IDE, + Position, + ScopeType, + TextEditor, } from "@cursorless/lib-common"; import type { LanguageDefinitions } from "../../../languages/LanguageDefinitions"; import { BaseScopeHandler } from "./BaseScopeHandler"; diff --git a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/RegexScopeHandler.ts b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/RegexScopeHandler.ts index aaeffc105e4..a36dcf7ea97 100644 --- a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/RegexScopeHandler.ts +++ b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/RegexScopeHandler.ts @@ -46,6 +46,7 @@ export class UrlScopeHandler extends RegexStageBase { regex = /(http(s)?:\/\/.)?(www\.)?[-a-zA-Z0-9@:%._+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_+.~#?&//=]*)/g; + // oxlint-disable-next-line no-useless-constructor constructor( scopeHandlerFactory: ScopeHandlerFactory, readonly scopeType: ScopeType, @@ -60,6 +61,7 @@ export class CustomRegexScopeHandler extends RegexStageBase { return new RegExp(this.scopeType.regex, this.scopeType.flags ?? "gu"); } + // oxlint-disable-next-line no-useless-constructor constructor( scopeHandlerFactory: ScopeHandlerFactory, readonly scopeType: CustomRegexScopeType, @@ -74,6 +76,7 @@ export class GlyphScopeHandler extends RegexStageBase { return new RegExp(escapeRegExp(this.scopeType.character), "gui"); } + // oxlint-disable-next-line no-useless-constructor constructor( scopeHandlerFactory: ScopeHandlerFactory, readonly scopeType: GlyphScopeType, diff --git a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/ScopeHandlerFactoryImpl.ts b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/ScopeHandlerFactoryImpl.ts index 8f20bc1bb04..99ddf6dc63c 100644 --- a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/ScopeHandlerFactoryImpl.ts +++ b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/ScopeHandlerFactoryImpl.ts @@ -1,9 +1,5 @@ -import { - pseudoScopes, - UnsupportedScopeError, - type IDE, - type ScopeType, -} from "@cursorless/lib-common"; +import { pseudoScopes, UnsupportedScopeError } from "@cursorless/lib-common"; +import type { IDE, ScopeType } from "@cursorless/lib-common"; import type { LanguageDefinitions } from "../../../languages/LanguageDefinitions"; import { BoundedNonWhitespaceSequenceScopeHandler, diff --git a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/SortedScopeHandler.ts b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/SortedScopeHandler.ts index 70154b16714..028368d204e 100644 --- a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/SortedScopeHandler.ts +++ b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/SortedScopeHandler.ts @@ -84,11 +84,15 @@ export class SortedScopeHandler extends BaseScopeHandler { return; } - const iterators = this.scopeHandlers.map((scopeHandler) => - scopeHandler - .generateScopes(editor, position, direction, hints) - [Symbol.iterator](), - ); + const iterators = this.scopeHandlers.map((scopeHandler) => { + const scopes = scopeHandler.generateScopes( + editor, + position, + direction, + hints, + ); + return scopes[Symbol.iterator](); + }); let iteratorInfos = getInitialIteratorInfos(iterators); diff --git a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/SurroundingPairScopeHandler/delimiterMaps.ts b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/SurroundingPairScopeHandler/delimiterMaps.ts index b51ff7c8a9b..f0a3d4d7009 100644 --- a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/SurroundingPairScopeHandler/delimiterMaps.ts +++ b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/SurroundingPairScopeHandler/delimiterMaps.ts @@ -34,10 +34,10 @@ const delimiterToText: DelimiterMap = Object.freeze({ tripleDoubleQuotes: [[], []], tripleSingleQuotes: [[], []], doubleQuotes: ['"', '"', { isSingleLine: true }], - escapedDoubleQuotes: ['\\"', '\\"', { isSingleLine: true }], - escapedParentheses: ["\\(", "\\)"], - escapedSquareBrackets: ["\\[", "\\]"], - escapedSingleQuotes: ["\\'", "\\'", { isSingleLine: true }], + escapedDoubleQuotes: [String.raw`\"`, String.raw`\"`, { isSingleLine: true }], + escapedParentheses: [String.raw`\(`, String.raw`\)`], + escapedSquareBrackets: [String.raw`\[`, String.raw`\]`], + escapedSingleQuotes: [String.raw`\'`, String.raw`\'`, { isSingleLine: true }], parentheses: [["(", "$("], ")"], backtickQuotes: ["`", "`"], singleQuotes: ["'", "'", { isSingleLine: true }], diff --git a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/SurroundingPairScopeHandler/getDelimiterOccurrences.ts b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/SurroundingPairScopeHandler/getDelimiterOccurrences.ts index 47a18602c15..5059528a14a 100644 --- a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/SurroundingPairScopeHandler/getDelimiterOccurrences.ts +++ b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/SurroundingPairScopeHandler/getDelimiterOccurrences.ts @@ -56,7 +56,7 @@ export function getDelimiterOccurrences( for (const match of regexMatches) { const text = match[0]; - const startPos = document.positionAt(match.index!); + const startPos = document.positionAt(match.index); const matchRange = new Range( startPos, startPos.translate(undefined, text.length), diff --git a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/WordScopeHandler/WordTokenizer.ts b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/WordScopeHandler/WordTokenizer.ts index 1a353cc4d82..8f147680034 100644 --- a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/WordScopeHandler/WordTokenizer.ts +++ b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/WordScopeHandler/WordTokenizer.ts @@ -19,9 +19,11 @@ export class WordTokenizer { // First try to split on non letter characters const wordMatches = matchText(text, this.wordRegex); - return wordMatches.length > 1 - ? wordMatches - : // Secondly try split on camel case - matchText(text, CAMEL_REGEX); + // Secondly try split on camel case + if (wordMatches.length === 1) { + return matchText(text, CAMEL_REGEX); + } + + return wordMatches; } } diff --git a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/compareTargetScopes.ts b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/compareTargetScopes.ts index 504187e6d64..1eb12ea7a21 100644 --- a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/compareTargetScopes.ts +++ b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/compareTargetScopes.ts @@ -56,14 +56,22 @@ function compareTargetScopesForward( // If they are tied, then start with `a` if it is empty, otherwise start // with `b` because it is ending and `a` is starting. - return value !== 0 ? value : b.isEmpty ? 1 : -1; + if (value !== 0) { + return value; + } + + return b.isEmpty ? 1 : -1; } // Otherwise `b` starts before position, but `a` does not. Apply reverse // logic to last `if` statement above const value = a.start.compareTo(b.end); - return value !== 0 ? value : a.isEmpty ? -1 : 1; + if (value !== 0) { + return value; + } + + return a.isEmpty ? -1 : 1; } // FIXME: Unify this function with compareTargetScopesForward by constructing @@ -102,12 +110,20 @@ function compareTargetScopesBackward( // If they are tied, then start with `a` if it is empty, otherwise start // with `b` because it is starting and `a` is ending. - return value !== 0 ? value : b.isEmpty ? 1 : -1; + if (value !== 0) { + return value; + } + + return b.isEmpty ? 1 : -1; } // Otherwise `b` starts before position, but `a` does not. Apply reverse // logic to last `if` statement above const value = -a.end.compareTo(b.start); - return value !== 0 ? value : a.isEmpty ? -1 : 1; + if (value !== 0) { + return value; + } + + return a.isEmpty ? -1 : 1; } diff --git a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/shouldYieldScope.ts b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/shouldYieldScope.ts index ade4afde8ee..2f6ea7f5309 100644 --- a/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/shouldYieldScope.ts +++ b/packages/lib-engine/src/processTargets/modifiers/scopeHandlers/shouldYieldScope.ts @@ -60,22 +60,27 @@ function checkRequirements( const { domain } = scope; // Simple containment checks - switch (containment) { - case "disallowed": - if (domain.contains(position)) { - return false; + if (containment != null) { + switch (containment) { + case "disallowed": + if (domain.contains(position)) { + return false; + } + break; + case "disallowedIfStrict": + if (strictlyContains(domain, position)) { + return false; + } + break; + case "required": + if (!domain.contains(position)) { + return false; + } + break; + default: { + const _exhaustiveCheck: never = containment; } - break; - case "disallowedIfStrict": - if (strictlyContains(domain, position)) { - return false; - } - break; - case "required": - if (!domain.contains(position)) { - return false; - } - break; + } } if ( diff --git a/packages/lib-engine/src/processTargets/targets/BaseTarget.ts b/packages/lib-engine/src/processTargets/targets/BaseTarget.ts index d51326c0307..23d425f0d37 100644 --- a/packages/lib-engine/src/processTargets/targets/BaseTarget.ts +++ b/packages/lib-engine/src/processTargets/targets/BaseTarget.ts @@ -118,6 +118,7 @@ export abstract class BaseTarget< private cloneWith(parameters: CloneWithParameters) { const constructor = Object.getPrototypeOf(this).constructor; + // oxlint-disable-next-line new-cap return new constructor({ ...this.getCloneParameters(), ...parameters, @@ -132,6 +133,7 @@ export abstract class BaseTarget< ): (ThisType & Target) | null { const { constructor } = Object.getPrototypeOf(this); + // oxlint-disable-next-line new-cap return new constructor({ ...this.getCloneParameters(), isReversed, diff --git a/packages/lib-engine/src/processTargets/targets/BoundedParagraphTarget.ts b/packages/lib-engine/src/processTargets/targets/BoundedParagraphTarget.ts index d0903f9f72c..7a878e453a0 100644 --- a/packages/lib-engine/src/processTargets/targets/BoundedParagraphTarget.ts +++ b/packages/lib-engine/src/processTargets/targets/BoundedParagraphTarget.ts @@ -1,4 +1,5 @@ -import { toLineRange, type Range } from "@cursorless/lib-common"; +import { toLineRange } from "@cursorless/lib-common"; +import type { Range } from "@cursorless/lib-common"; import type { InteriorTarget, ParagraphTarget } from "."; import type { TextualType } from "../../typings/target.types"; import { expandToFullLine } from "../../util/rangeUtils"; diff --git a/packages/lib-engine/src/processTargets/targets/DestinationImpl.ts b/packages/lib-engine/src/processTargets/targets/DestinationImpl.ts index 6006f3a5b4b..82b55b96863 100644 --- a/packages/lib-engine/src/processTargets/targets/DestinationImpl.ts +++ b/packages/lib-engine/src/processTargets/targets/DestinationImpl.ts @@ -216,10 +216,11 @@ function getContentRange( ): Range { switch (insertionMode) { case "before": - return contentRange.start.toEmptyRange(); + return Range.fromPosition(contentRange.start); case "after": - return contentRange.end.toEmptyRange(); + return Range.fromPosition(contentRange.end); case "to": return contentRange; + // No default } } diff --git a/packages/lib-engine/src/processTargets/targets/DocumentTarget.ts b/packages/lib-engine/src/processTargets/targets/DocumentTarget.ts index 09a1f39e853..004887bd16d 100644 --- a/packages/lib-engine/src/processTargets/targets/DocumentTarget.ts +++ b/packages/lib-engine/src/processTargets/targets/DocumentTarget.ts @@ -1,7 +1,8 @@ import type { Range } from "@cursorless/lib-common"; import type { TextualType } from "../../typings/target.types"; import { shrinkRangeToFitContent } from "../../util/selectionUtils"; -import { BaseTarget, type CommonTargetParameters } from "./BaseTarget"; +import { BaseTarget } from "./BaseTarget"; +import type { CommonTargetParameters } from "./BaseTarget"; import { PlainTarget } from "./PlainTarget"; export class DocumentTarget extends BaseTarget { @@ -9,10 +10,6 @@ export class DocumentTarget extends BaseTarget { textualType: TextualType = "line"; insertionDelimiter = "\n\n"; - constructor(parameters: CommonTargetParameters) { - super(parameters); - } - getInterior() { return [ // Use plain target instead of interior target since we want the same content and removal range for a document interior. diff --git a/packages/lib-engine/src/processTargets/targets/NotebookCellTarget.ts b/packages/lib-engine/src/processTargets/targets/NotebookCellTarget.ts index 1b655cc5a4b..59f8c99306f 100644 --- a/packages/lib-engine/src/processTargets/targets/NotebookCellTarget.ts +++ b/packages/lib-engine/src/processTargets/targets/NotebookCellTarget.ts @@ -9,10 +9,6 @@ export class NotebookCellTarget extends BaseTarget { insertionDelimiter = "\n"; isNotebookCell = true; - constructor(parameters: CommonTargetParameters) { - super(parameters); - } - getLeadingDelimiterTarget = () => undefined; getTrailingDelimiterTarget = () => undefined; getRemovalRange = () => this.contentRange; diff --git a/packages/lib-engine/src/processTargets/targets/ScopeTypeTarget.ts b/packages/lib-engine/src/processTargets/targets/ScopeTypeTarget.ts index a8603755cc5..d022956d738 100644 --- a/packages/lib-engine/src/processTargets/targets/ScopeTypeTarget.ts +++ b/packages/lib-engine/src/processTargets/targets/ScopeTypeTarget.ts @@ -45,7 +45,8 @@ export class ScopeTypeTarget extends BaseTarget { parameters.insertionDelimiter ?? getInsertionDelimiter(parameters.scopeTypeType); this.hasDelimiterRange_ = - !!this.leadingDelimiterRange_ || !!this.trailingDelimiterRange_; + this.leadingDelimiterRange_ != null || + this.trailingDelimiterRange_ != null; } getLeadingDelimiterTarget(): Target | undefined { diff --git a/packages/lib-engine/src/processTargets/targets/util/insertionRemovalBehaviors/TokenInsertionRemovalBehavior.ts b/packages/lib-engine/src/processTargets/targets/util/insertionRemovalBehaviors/TokenInsertionRemovalBehavior.ts index 7f02e3bf18e..79ad8a04dbe 100644 --- a/packages/lib-engine/src/processTargets/targets/util/insertionRemovalBehaviors/TokenInsertionRemovalBehavior.ts +++ b/packages/lib-engine/src/processTargets/targets/util/insertionRemovalBehaviors/TokenInsertionRemovalBehavior.ts @@ -4,8 +4,18 @@ import type { Target } from "../../../../typings/target.types"; import { expandToFullLine, union } from "../../../../util/rangeUtils"; import { PlainTarget } from "../../PlainTarget"; -const leadingDelimiters = ['"', "'", "(", "[", "{", "<"]; -const trailingDelimiters = ['"', "'", ")", "]", "}", ">", ",", ";", ":"]; +const leadingDelimiters = new Set(['"', "'", "(", "[", "{", "<"]); +const trailingDelimiters = new Set([ + '"', + "'", + ")", + "]", + "}", + ">", + ",", + ";", + ":", +]); export function getTokenLeadingDelimiterTarget( target: Target, @@ -86,10 +96,12 @@ export function getTokenRemovalRange(target: Target): Range { const { start, end } = contentRange; const leadingWhitespaceRange = - target.getLeadingDelimiterTarget()?.contentRange ?? start.toEmptyRange(); + target.getLeadingDelimiterTarget()?.contentRange ?? + Range.fromPosition(start); const trailingWhitespaceRange = - target.getTrailingDelimiterTarget()?.contentRange ?? end.toEmptyRange(); + target.getTrailingDelimiterTarget()?.contentRange ?? + Range.fromPosition(end); const fullLineRange = expandToFullLine(editor, contentRange); @@ -109,7 +121,7 @@ export function getTokenRemovalRange(target: Target): Range { if ( !leadingWhitespaceRange.isEmpty || contentRange.start.isEqual(fullLineRange.start) || - leadingDelimiters.includes(getLeadingCharacter(editor, contentRange)) + leadingDelimiters.has(getLeadingCharacter(editor, contentRange)) ) { return contentRange.union(trailingWhitespaceRange); } @@ -120,7 +132,7 @@ export function getTokenRemovalRange(target: Target): Range { if (!leadingWhitespaceRange.isEmpty) { if ( contentRange.end.isEqual(fullLineRange.end) || - trailingDelimiters.includes(getTrailingCharacter(editor, contentRange)) + trailingDelimiters.has(getTrailingCharacter(editor, contentRange)) ) { return contentRange.union(leadingWhitespaceRange); } diff --git a/packages/lib-engine/src/runCommand.ts b/packages/lib-engine/src/runCommand.ts index 0a83ff7de1b..341d38f83b9 100644 --- a/packages/lib-engine/src/runCommand.ts +++ b/packages/lib-engine/src/runCommand.ts @@ -81,11 +81,11 @@ export async function runCommand( return await unwrapLegacyCommandResponse(command, response); } -async function unwrapLegacyCommandResponse( +function unwrapLegacyCommandResponse( command: Command, response: CommandResponse, // oxlint-disable-next-line typescript/no-redundant-type-constituents -): Promise { +): CommandResponse | unknown { if (clientSupportsFallback(command)) { return response; } diff --git a/packages/lib-engine/src/scopeProviders/ScopeInfoProvider.ts b/packages/lib-engine/src/scopeProviders/ScopeInfoProvider.ts index f4a7c849d90..9fe28476aea 100644 --- a/packages/lib-engine/src/scopeProviders/ScopeInfoProvider.ts +++ b/packages/lib-engine/src/scopeProviders/ScopeInfoProvider.ts @@ -56,7 +56,7 @@ export class ScopeInfoProvider { }; } - private async onChange() { + private onChange() { this.updateScopeTypeInfos(); this.listeners.slice().forEach((listener) => listener(this.scopeInfos)); @@ -184,5 +184,7 @@ function isLanguageSpecific(scopeType: ScopeType): boolean { case "customRegex": case "glyph": return false; + + // No default } } diff --git a/packages/lib-engine/src/scopeProviders/ScopeRangeWatcher.ts b/packages/lib-engine/src/scopeProviders/ScopeRangeWatcher.ts index f5069a6685d..8e802718bcb 100644 --- a/packages/lib-engine/src/scopeProviders/ScopeRangeWatcher.ts +++ b/packages/lib-engine/src/scopeProviders/ScopeRangeWatcher.ts @@ -8,7 +8,7 @@ import type { ScopeRangeConfig, ScopeRanges, } from "@cursorless/lib-common"; -import { showError } from "@cursorless/lib-common"; +import { getErrorMessage, showError } from "@cursorless/lib-common"; import type { LanguageDefinitions } from "../languages/LanguageDefinitions"; import { DecorationDebouncer } from "../util/DecorationDebouncer"; import type { ScopeRangeProvider } from "./ScopeRangeProvider"; @@ -72,11 +72,11 @@ export class ScopeRangeWatcher { editor, config, ); - } catch (err) { + } catch (error) { void showError( this.ide.messages, "ScopeRangeWatcher.provide", - (err as Error).message, + getErrorMessage(error), ); // If there was a problem getting scopes for an editor, we show an // error and clear any scopes we might have shown last time. This is @@ -86,7 +86,7 @@ export class ScopeRangeWatcher { if (this.ide.runMode === "test") { // Fail hard if we're in test mode; otherwise recover - throw err; + throw error; } } @@ -145,7 +145,7 @@ export class ScopeRangeWatcher { this.disposables.forEach(({ dispose }) => { try { dispose(); - } catch (_e) { + } catch { // do nothing; some of the VSCode disposables misbehave, and we don't // want that to prevent us from disposing the rest of the disposables } diff --git a/packages/lib-engine/src/scopeProviders/ScopeSupportWatcher.ts b/packages/lib-engine/src/scopeProviders/ScopeSupportWatcher.ts index 9b94b94164b..9be585500fa 100644 --- a/packages/lib-engine/src/scopeProviders/ScopeSupportWatcher.ts +++ b/packages/lib-engine/src/scopeProviders/ScopeSupportWatcher.ts @@ -108,6 +108,7 @@ export class ScopeSupportWatcher { const scopeTypeInfos = this.scopeInfoProvider.getScopeTypeInfos(); + // oxlint-disable-next-line oxc/no-map-spread return scopeTypeInfos.map((scopeTypeInfo) => ({ ...scopeTypeInfo, support: getScopeTypeSupport(scopeTypeInfo.scopeType), diff --git a/packages/lib-engine/src/scopeProviders/getIterationScopeRanges.ts b/packages/lib-engine/src/scopeProviders/getIterationScopeRanges.ts index 55c6fc512a3..141a61f980a 100644 --- a/packages/lib-engine/src/scopeProviders/getIterationScopeRanges.ts +++ b/packages/lib-engine/src/scopeProviders/getIterationScopeRanges.ts @@ -66,11 +66,11 @@ function getEveryScopeLenient( ) { try { return everyStage.run(target, options); - } catch (err) { - if ((err as Error).name === "NoContainingScopeError") { + } catch (error) { + if (error instanceof Error && error.name === "NoContainingScopeError") { return []; } - throw err; + throw error; } } diff --git a/packages/lib-engine/src/scripts/transformRecordedTests/checkMarks.ts b/packages/lib-engine/src/scripts/transformRecordedTests/checkMarks.ts index b5638366a36..11ae9d3253d 100644 --- a/packages/lib-engine/src/scripts/transformRecordedTests/checkMarks.ts +++ b/packages/lib-engine/src/scripts/transformRecordedTests/checkMarks.ts @@ -12,9 +12,9 @@ export function checkMarks(originalFixture: TestCaseFixtureLegacy): undefined { const graphemeSplitter = new TokenGraphemeSplitter(new FakeIDE()); - const targetedMarks = getPartialTargetDescriptors(command.action) - .map(extractTargetKeys) - .flat(); + const targetedMarks = getPartialTargetDescriptors(command.action).flatMap( + extractTargetKeys, + ); const normalizeGraphemes = (key: string): string => graphemeSplitter .getTokenGraphemes(key) diff --git a/packages/lib-engine/src/scripts/transformRecordedTests/index.ts b/packages/lib-engine/src/scripts/transformRecordedTests/index.ts index b788d9f8bd0..cb907268e8f 100644 --- a/packages/lib-engine/src/scripts/transformRecordedTests/index.ts +++ b/packages/lib-engine/src/scripts/transformRecordedTests/index.ts @@ -2,7 +2,7 @@ import type { CommandVersion, TestCaseFixtureLegacy, } from "@cursorless/lib-common"; -import { LATEST_VERSION } from "@cursorless/lib-common"; +import { getErrorMessage, LATEST_VERSION } from "@cursorless/lib-common"; import { getRecordedTestPaths } from "@cursorless/lib-node-common"; import { checkMarks } from "./checkMarks"; import { canonicalize } from "./transformations/canonicalize"; @@ -16,7 +16,7 @@ const AVAILABLE_TRANSFORMATIONS: Record = { upgrade, canonicalize, format: identity, - ["check-marks"]: checkMarks, + "check-marks": checkMarks, custom: upgradeDecorations, }; @@ -46,10 +46,10 @@ async function main(args: string[]) { for (const path of testPaths) { try { await transformFile(transformation, path); - } catch (err) { + } catch (error) { failureCount++; console.log(`Error with file ${path}`); - console.log((err as Error).message); + console.log(getErrorMessage(error)); } } @@ -73,7 +73,7 @@ function parseCommandLineArguments(args: string[]) { } if (flagName === "minimum-version") { - const minimumVersionUnchecked = parseInt(args[i + 1]); + const minimumVersionUnchecked = Number.parseInt(args[i + 1], 10); if ( minimumVersionUnchecked < 0 || minimumVersionUnchecked > LATEST_VERSION @@ -95,4 +95,4 @@ function parseCommandLineArguments(args: string[]) { return { transformationName, minimumVersion, paths }; } -void main(process.argv.slice(2)); +await main(process.argv.slice(2)); diff --git a/packages/lib-engine/src/snippets/snippetParser.test.ts b/packages/lib-engine/src/snippets/snippetParser.test.ts index 0ad3c8422dc..3d731d66800 100644 --- a/packages/lib-engine/src/snippets/snippetParser.test.ts +++ b/packages/lib-engine/src/snippets/snippetParser.test.ts @@ -14,7 +14,9 @@ suite("SnippetParser", () => { } assertTextsnippetString( + // oxlint-disable-next-line no-template-curly-in-string "${1|cho\\,ices,wi\\|th,esc\\\\aping,chall\\\\\\,enges|}", + // oxlint-disable-next-line no-template-curly-in-string "${1|cho\\,ices,wi\\|th,esc\\\\aping,chall\\\\\\,enges|}", ); }); diff --git a/packages/lib-engine/src/snippets/transformSnippetVariables.ts b/packages/lib-engine/src/snippets/transformSnippetVariables.ts index f8f213715ce..a3e1d6c9b3f 100644 --- a/packages/lib-engine/src/snippets/transformSnippetVariables.ts +++ b/packages/lib-engine/src/snippets/transformSnippetVariables.ts @@ -33,7 +33,7 @@ export function transformSnippetVariables( candidate.name = "TM_SELECTED_TEXT"; } else if ( substitutions != null && - Object.prototype.hasOwnProperty.call(substitutions, candidate.name) + Object.hasOwn(substitutions, candidate.name) ) { candidate.parent.replace(candidate, [ new Text(substitutions[candidate.name]), @@ -47,6 +47,7 @@ export function transformSnippetVariables( placeholderIndexMap[candidate.name] = placeholderIndex; } const placeholder = new Placeholder(placeholderIndex); + // oxlint-disable-next-line unicorn/prefer-dom-node-append candidate.children.forEach((child) => placeholder.appendChild(child)); candidate.parent.replace(candidate, [placeholder]); } @@ -55,7 +56,7 @@ export function transformSnippetVariables( candidate.parent.replace(candidate, [new Variable("TM_SELECTED_TEXT")]); } else if ( substitutions != null && - Object.prototype.hasOwnProperty.call(substitutions, candidate.index) + Object.hasOwn(substitutions, candidate.index) ) { candidate.parent.replace(candidate, [ new Text(substitutions[candidate.index]), diff --git a/packages/lib-engine/src/spokenForms/CustomSpokenForms.ts b/packages/lib-engine/src/spokenForms/CustomSpokenForms.ts index 667b0770709..a6bf935bac6 100644 --- a/packages/lib-engine/src/spokenForms/CustomSpokenForms.ts +++ b/packages/lib-engine/src/spokenForms/CustomSpokenForms.ts @@ -13,6 +13,7 @@ import { NeedsInitialTalonUpdateError, Notifier, SUPPORTED_ENTRY_TYPES, + getErrorMessage, showError, } from "@cursorless/lib-common"; import { @@ -87,15 +88,15 @@ export class CustomSpokenForms { if (allCustomEntries.length === 0) { throw new Error("Custom spoken forms list empty"); } - } catch (err) { - if (err instanceof NeedsInitialTalonUpdateError) { + } catch (error) { + if (error instanceof NeedsInitialTalonUpdateError) { // Handle case where spokenForms.json doesn't exist yet this.needsInitialTalonUpdate_ = true; - } else if (err instanceof DisabledCustomSpokenFormsError) { + } else if (error instanceof DisabledCustomSpokenFormsError) { // Do nothing: this ide doesn't currently support custom spoken forms } else { - console.error("Error loading custom spoken forms", err); - const msg = (err as Error).message.replace(/\.$/, ""); + console.error("Error loading custom spoken forms", error); + const msg = getErrorMessage(error).replace(/\.$/, ""); void showError( this.ide.messages, "CustomSpokenForms.updateSpokenFormMaps", @@ -162,26 +163,28 @@ function updateEntriesForType( defaultEntries[id] ?? {}; const customSpokenForms = customEntries[id]; - obj[id] = - customSpokenForms == null - ? // No entry for the given id. This either means that the user needs to - // update Talon, or it's a private spoken form. - { - defaultSpokenForms, - spokenForms: [], - // If it's not a private spoken form, then it's a new scope type - requiresTalonUpdate: !isPrivate, - isCustom: false, - isPrivate, - } - : // We have an entry for the given id - { - defaultSpokenForms, - spokenForms: customSpokenForms, - requiresTalonUpdate: false, - isCustom: !isEqual(defaultSpokenForms, customSpokenForms), - isPrivate, - }; + // No entry for the given id. This either means that the user needs to + // update Talon, or it's a private spoken form. + if (customSpokenForms == null) { + obj[id] = { + defaultSpokenForms, + spokenForms: [], + // If it's not a private spoken form, then it's a new scope type + requiresTalonUpdate: !isPrivate, + isCustom: false, + isPrivate, + }; + } + // We have an entry for the given id + else { + obj[id] = { + defaultSpokenForms, + spokenForms: customSpokenForms, + requiresTalonUpdate: false, + isCustom: !isEqual(defaultSpokenForms, customSpokenForms), + isPrivate, + }; + } } spokenFormMapToUpdate[key] = obj as SpokenFormMap[T]; diff --git a/packages/lib-engine/src/spokenForms/defaultSpokenFormMapCore.ts b/packages/lib-engine/src/spokenForms/defaultSpokenFormMapCore.ts index 0131dba7859..8763460591c 100644 --- a/packages/lib-engine/src/spokenForms/defaultSpokenFormMapCore.ts +++ b/packages/lib-engine/src/spokenForms/defaultSpokenFormMapCore.ts @@ -108,7 +108,7 @@ export const defaultSpokenFormMapCore: DefaultSpokenFormMapDefinition = { disqualifyDelimiter: isPrivate("disqualify delimiter"), pairDelimiter: isPrivate("pair delimiter"), interior: isPrivate("interior"), - ["private.fieldAccess"]: isPrivate("access"), + "private.fieldAccess": isPrivate("access"), }, complexScopeTypeType: { glyph: "glyph", @@ -207,16 +207,16 @@ export const defaultSpokenFormMapCore: DefaultSpokenFormMapDefinition = { gitUnstage: "git unstage", // Was disabled by default before, but is now enabled by default - ["experimental.setInstanceReference"]: "from", + "experimental.setInstanceReference": "from", - ["private.showParseTree"]: isPrivate("parse tree"), + "private.showParseTree": isPrivate("parse tree"), editNew: isPrivate("edit new"), executeCommand: isPrivate("execute command"), parsed: isPrivate("parsed"), getText: isPrivate("get text"), replace: isPrivate("replace"), - ["private.getTargets"]: isPrivate("get targets"), - ["private.setKeyboardTarget"]: isPrivate("set keyboard target"), + "private.getTargets": isPrivate("get targets"), + "private.setKeyboardTarget": isPrivate("set keyboard target"), // These actions are implemented talon-side, usually using `getText` followed // by some other action. diff --git a/packages/lib-engine/src/spokenForms/graphemes.ts b/packages/lib-engine/src/spokenForms/graphemes.ts index 4e32aebc076..ee568f87bc7 100644 --- a/packages/lib-engine/src/spokenForms/graphemes.ts +++ b/packages/lib-engine/src/spokenForms/graphemes.ts @@ -4,7 +4,7 @@ const alphabet = Object.fromEntries( "air bat cap drum each fine gust harp sit jury crunch look made near odd pit quench red sun trap urge vest whale plex yank zip" .split(" ") .map((word, index) => [ - String.fromCharCode("a".charCodeAt(0) + index), + String.fromCodePoint("a".codePointAt(0)! + index), word, ]), ); diff --git a/packages/lib-engine/src/test/fixtures/spokenFormTest.ts b/packages/lib-engine/src/test/fixtures/spokenFormTest.ts index 84626dbd76f..adb4694daa8 100644 --- a/packages/lib-engine/src/test/fixtures/spokenFormTest.ts +++ b/packages/lib-engine/src/test/fixtures/spokenFormTest.ts @@ -1,8 +1,8 @@ -import { - LATEST_VERSION, - type ActionDescriptor, - type CommandLatest, - type CommandResponse, +import { LATEST_VERSION } from "@cursorless/lib-common"; +import type { + ActionDescriptor, + CommandLatest, + CommandResponse, } from "@cursorless/lib-common"; export interface SpokenFormTest { diff --git a/packages/lib-engine/src/test/scopes.test.ts b/packages/lib-engine/src/test/scopes.test.ts index 9b8d0d87180..39623ddb082 100644 --- a/packages/lib-engine/src/test/scopes.test.ts +++ b/packages/lib-engine/src/test/scopes.test.ts @@ -23,7 +23,7 @@ import { serializeScopeFixture, } from "../testUtil/serializeScopeFixture"; -suite("Scope test cases", async function () { +suite("Scope test cases", function () { const testPaths = getScopeTestPathsRecursively(); let testEnvironment: TestEnvironment; @@ -47,15 +47,11 @@ suite("Scope test cases", async function () { .sort() .forEach((languageId) => { const tests = languages[languageId]; - test( - `${languageId} facet coverage`, - asyncSafety(() => - testLanguageSupport( - languageId, - tests.map((test) => test.facet), - ), - ), - ); + test(`${languageId} facet coverage`, () => + testLanguageSupport( + languageId, + tests.map((test) => test.facet), + )); }); } @@ -73,7 +69,7 @@ suite("Scope test cases", async function () { * @param languageId The language to test * @param testedFacets The facets for {@link languageId} that are tested */ -async function testLanguageSupport(languageId: string, testedFacets: string[]) { +function testLanguageSupport(languageId: string, testedFacets: string[]) { const supportedFacets = (() => { if (languageId === "plaintext") { return Object.keys(plaintextScopeSupportFacetInfos); @@ -120,9 +116,8 @@ async function runTest( facetId: string, ) { const { scopeType, isIteration } = getFacetInfo(languageId, facetId); - const fixture = (await fsp.readFile(file, "utf8")) - .toString() - .replaceAll("\r\n", "\n"); + const content = await fsp.readFile(file, "utf8"); + const fixture = content.toString().replaceAll("\r\n", "\n"); const delimiterIndex = fixture.match(/^---$/m)?.index; assert.ok( @@ -130,7 +125,7 @@ async function runTest( "Can't find delimiter '---' in scope fixture", ); - const code = fixture.slice(0, delimiterIndex! - 1); + const code = fixture.slice(0, delimiterIndex - 1); const editor = await testEnvironment.openNewEditor(code, languageId); diff --git a/packages/lib-engine/src/test/spokenForms.talon.test.ts b/packages/lib-engine/src/test/spokenForms.talon.test.ts index 422e9f07a77..f09da3c87c1 100644 --- a/packages/lib-engine/src/test/spokenForms.talon.test.ts +++ b/packages/lib-engine/src/test/spokenForms.talon.test.ts @@ -16,7 +16,7 @@ import { multiActionFixture } from "./fixtures/multiAction.fixture"; import { synonymousSpokenFormsFixture } from "./fixtures/synonymousSpokenForms.fixture"; import { talonApiFixture } from "./fixtures/talonApi.fixture"; -suite("Talon spoken forms", async function () { +suite("Talon spoken forms", function () { const repl = new TalonRepl(); suiteSetup( @@ -110,8 +110,8 @@ async function runTest( const commandsActual = (() => { try { return JSON.parse(result); - } catch (e) { - throw new Error(result, { cause: e }); + } catch (error) { + throw new Error(result, { cause: error }); } })(); diff --git a/packages/lib-engine/src/testUtil/TalonRepl.ts b/packages/lib-engine/src/testUtil/TalonRepl.ts index d70b5a2192e..ff183858b04 100644 --- a/packages/lib-engine/src/testUtil/TalonRepl.ts +++ b/packages/lib-engine/src/testUtil/TalonRepl.ts @@ -20,7 +20,7 @@ export class TalonRepl { this.child = childProcess.spawn(path, { shell: true }); if (this.child?.stdin == null) { - reject("stdin is null"); + reject(new Error("stdin is null")); return; } @@ -54,7 +54,7 @@ export class TalonRepl { this.child.stdin.write(command); this.child.stdin.write("\n"); } else { - reject(); + reject(new Error("REPL not started")); } }); } @@ -71,7 +71,8 @@ export class TalonRepl { // `0` back to us (we could put any Python value in there; `0` is just a // simple one). We keep doing this until we get `0` back, which means the // REPL is responsive again. - const output = (await this.command("0")).trim(); + const result = await this.command("0"); + const output = result.trim(); if (output === "0") { break; diff --git a/packages/lib-engine/src/testUtil/TestFileSystem.ts b/packages/lib-engine/src/testUtil/TestFileSystem.ts index 58065bdac82..1fd6c4240e4 100644 --- a/packages/lib-engine/src/testUtil/TestFileSystem.ts +++ b/packages/lib-engine/src/testUtil/TestFileSystem.ts @@ -6,7 +6,10 @@ import type { PathChangeListener, RunMode, } from "@cursorless/lib-common"; -import { getCursorlessRepoRoot } from "@cursorless/lib-node-common"; +import { + getCursorlessRepoRoot, + isEnoentError, +} from "@cursorless/lib-node-common"; export class TestFileSystem implements FileSystem { public readonly cursorlessTalonStateJsonPath: string; @@ -23,17 +26,19 @@ export class TestFileSystem implements FileSystem { ); } - public async initialize(): Promise {} + public initialize(): Promise { + return Promise.resolve(); + } public async readBundledFile(path: string): Promise { const absolutePath = join(getCursorlessRepoRoot(), path); try { - return await fs.readFile(absolutePath, "utf-8"); - } catch (e) { - if (e instanceof Error && "code" in e && e.code === "ENOENT") { + return await fs.readFile(absolutePath, "utf8"); + } catch (error) { + if (isEnoentError(error)) { return undefined; } - throw e; + throw error; } } diff --git a/packages/lib-engine/src/testUtil/TestTextEditor.ts b/packages/lib-engine/src/testUtil/TestTextEditor.ts index e4f28bb5346..3966edab3bd 100644 --- a/packages/lib-engine/src/testUtil/TestTextEditor.ts +++ b/packages/lib-engine/src/testUtil/TestTextEditor.ts @@ -31,7 +31,7 @@ export class TestTextEditor implements EditableTextEditor { return this.id === other.id; } - async setSelections( + setSelections( _selections: Selection[], _opts?: SetSelectionsOpts, ): Promise { @@ -42,11 +42,11 @@ export class TestTextEditor implements EditableTextEditor { throw new Error("edit: not implemented"); } - async clipboardCopy(_ranges: Range[]): Promise { + clipboardCopy(_ranges: Range[]): Promise { throw new Error("clipboardCopy: not implemented"); } - async clipboardPaste(): Promise { + clipboardPaste(): Promise { throw new Error("clipboardPaste: not implemented"); } @@ -138,27 +138,27 @@ export class TestTextEditor implements EditableTextEditor { throw new Error("editNewNotebookCellBelow: not implemented"); } - public async gitAccept(_range?: Range): Promise { + public gitAccept(_range?: Range): Promise { throw new Error("gitAccept: not implemented"); } - public async gitRevert(_range?: Range): Promise { + public gitRevert(_range?: Range): Promise { throw new Error("gitRevert: not implemented"); } - public async gitStageFile(): Promise { + public gitStageFile(): Promise { throw new Error("gitStageFile: not implemented"); } - public async gitUnstageFile(): Promise { + public gitUnstageFile(): Promise { throw new Error("gitUnstageFile: not implemented"); } - public async gitStageRange(_range?: Range): Promise { + public gitStageRange(_range?: Range): Promise { throw new Error("gitStageRange: not implemented"); } - public async gitUnstageRange(_range?: Range): Promise { + public gitUnstageRange(_range?: Range): Promise { throw new Error("gitUnstageRange: not implemented"); } } diff --git a/packages/lib-engine/src/testUtil/createTestEnvironment.ts b/packages/lib-engine/src/testUtil/createTestEnvironment.ts index dd11f801bab..910930117eb 100644 --- a/packages/lib-engine/src/testUtil/createTestEnvironment.ts +++ b/packages/lib-engine/src/testUtil/createTestEnvironment.ts @@ -2,10 +2,13 @@ import type { EditableTextEditor, MessageId, Messages, - MessageType, ScopeProvider, } from "@cursorless/lib-common"; -import { FakeIDE, InMemoryTextEditor } from "@cursorless/lib-common"; +import { + FakeIDE, + InMemoryTextEditor, + MessageType, +} from "@cursorless/lib-common"; import { FileSystemRawTreeSitterQueryProvider } from "@cursorless/lib-node-common"; import { createCursorlessEngine } from ".."; import { TestFileSystem } from "./TestFileSystem"; @@ -53,15 +56,19 @@ class TestMessages implements Messages { ..._options: string[] ): Promise { switch (type) { - case "info": + case MessageType.info: console.log(message); break; - case "warning": + case MessageType.warning: console.log(`[warn] ${message}`); break; - case "error": + case MessageType.error: console.log(`[error] ${message}`); break; + default: { + const exhaustiveCheck: never = type; + throw new Error(`Unhandled message type: ${exhaustiveCheck}`); + } } return Promise.resolve(undefined); } diff --git a/packages/lib-engine/src/testUtil/extractTargetKeys.ts b/packages/lib-engine/src/testUtil/extractTargetKeys.ts index fd418094ad4..3829f32f0ee 100644 --- a/packages/lib-engine/src/testUtil/extractTargetKeys.ts +++ b/packages/lib-engine/src/testUtil/extractTargetKeys.ts @@ -15,7 +15,7 @@ export function extractTargetKeys(target: PartialTargetDescriptor): string[] { return extractPrimitiveTargetKeys(target); case "list": - return target.elements.map(extractTargetKeys).flat(); + return target.elements.flatMap(extractTargetKeys); case "range": return [ @@ -25,6 +25,8 @@ export function extractTargetKeys(target: PartialTargetDescriptor): string[] { case "implicit": return []; + + // No default } } diff --git a/packages/lib-engine/src/testUtil/serializeHeader.ts b/packages/lib-engine/src/testUtil/serializeHeader.ts index 0d69a5e2a1c..915a8f51a00 100644 --- a/packages/lib-engine/src/testUtil/serializeHeader.ts +++ b/packages/lib-engine/src/testUtil/serializeHeader.ts @@ -45,7 +45,7 @@ export function serializeHeader({ if (prefix != null) { if (header != null) { - parts.push(prefix + ":"); + parts.push(`${prefix}:`); } else { parts.push(prefix); } diff --git a/packages/lib-engine/src/tokenGraphemeSplitter/tokenGraphemeSplitter.test.ts b/packages/lib-engine/src/tokenGraphemeSplitter/tokenGraphemeSplitter.test.ts index caced53d5e0..71ca0359d9b 100644 --- a/packages/lib-engine/src/tokenGraphemeSplitter/tokenGraphemeSplitter.test.ts +++ b/packages/lib-engine/src/tokenGraphemeSplitter/tokenGraphemeSplitter.test.ts @@ -1,3 +1,4 @@ +// oxlint-disable no-inline-comments import * as assert from "node:assert/strict"; import type { TokenHatSplittingMode } from "@cursorless/lib-common"; import { FakeIDE } from "@cursorless/lib-common"; @@ -95,8 +96,8 @@ const tests: SplittingModeTestCases[] = [ { tokenHatSplittingMode: { lettersToPreserve: [ - "\u00e4", // ä, NFC-normalised - "\u00e5", // å, NFC-normalised + "\u00E4", // ä, NFC-normalised + "\u00E5", // å, NFC-normalised "ꝏ", "ø", "æ", @@ -120,31 +121,31 @@ const tests: SplittingModeTestCases[] = [ [["n", 0, 2]], ], [ - "\u00e4\u00e5", // äå, NFC-normalised + "\u00E4\u00E5", // äå, NFC-normalised [ - ["\u00e4", 0, 1], // ä, NFC-normalised - ["\u00e5", 1, 2], // å, NFC-normalised + ["\u00E4", 0, 1], // ä, NFC-normalised + ["\u00E5", 1, 2], // å, NFC-normalised ], ], [ - "\u0061\u0308\u0061\u030a", // äå, NFD-normalised + "\u0061\u0308\u0061\u030A", // äå, NFD-normalised [ - ["\u00e4", 0, 2], // ä, NFC-normalised - ["\u00e5", 2, 4], // å, NFC-normalised + ["\u00E4", 0, 2], // ä, NFC-normalised + ["\u00E5", 2, 4], // å, NFC-normalised ], ], [ - "\u00c4\u00c5", // ÄÅ, NFC-normalised + "\u00C4\u00C5", // ÄÅ, NFC-normalised [ - ["\u00e4", 0, 1], // ä, NFC-normalised - ["\u00e5", 1, 2], // å, NFC-normalised + ["\u00E4", 0, 1], // ä, NFC-normalised + ["\u00E5", 1, 2], // å, NFC-normalised ], ], [ - "\u0041\u0308\u0041\u030a", // ÄÅ, NFD-normalised + "\u0041\u0308\u0041\u030A", // ÄÅ, NFD-normalised [ - ["\u00e4", 0, 2], // ä, NFC-normalised - ["\u00e5", 2, 4], // å, NFC-normalised + ["\u00E4", 0, 2], // ä, NFC-normalised + ["\u00E5", 2, 4], // å, NFC-normalised ], ], ["ꝏ", [["ꝏ", 0, 1]]], @@ -159,22 +160,22 @@ const tests: SplittingModeTestCases[] = [ tokenHatSplittingMode: { lettersToPreserve: [ "\u0061\u0308", // ä, NFD-normalised - "\u0061\u030a", // å, NFD-normalised + "\u0061\u030A", // å, NFD-normalised ], }, extraTestCases: [ [ - "\u00e4\u00e5", // äå, NFC-normalised + "\u00E4\u00E5", // äå, NFC-normalised [ - ["\u00e4", 0, 1], - ["\u00e5", 1, 2], + ["\u00E4", 0, 1], + ["\u00E5", 1, 2], ], ], [ - "\u0061\u0308\u0061\u030a", // äå, NFD-normalised + "\u0061\u0308\u0061\u030A", // äå, NFD-normalised [ - ["\u00e4", 0, 2], - ["\u00e5", 2, 4], + ["\u00E4", 0, 2], + ["\u00E5", 2, 4], ], ], ], @@ -183,8 +184,8 @@ const tests: SplittingModeTestCases[] = [ tokenHatSplittingMode: { preserveCase: true, lettersToPreserve: [ - "\u00e4", // ä, NFC-normalised - "\u00e5", // å, NFC-normalised + "\u00E4", // ä, NFC-normalised + "\u00E5", // å, NFC-normalised "ꝏ", "ø", "æ", @@ -192,17 +193,17 @@ const tests: SplittingModeTestCases[] = [ }, extraTestCases: [ [ - "\u00e4\u00e5", // äå, NFC-normalised + "\u00E4\u00E5", // äå, NFC-normalised [ - ["\u00e4", 0, 1], - ["\u00e5", 1, 2], + ["\u00E4", 0, 1], + ["\u00E5", 1, 2], ], ], [ - "\u00c4\u00c5", // ÄÅ, NFC-normalised + "\u00C4\u00C5", // ÄÅ, NFC-normalised [ - ["\u00c4", 0, 1], // Ä, NFC-normalised - ["\u00c5", 1, 2], // Å, NFC-normalised + ["\u00C4", 0, 1], // Ä, NFC-normalised + ["\u00C5", 1, 2], // Å, NFC-normalised ], ], ["ꝏ", [["ꝏ", 0, 1]]], @@ -216,8 +217,8 @@ const tests: SplittingModeTestCases[] = [ { tokenHatSplittingMode: { lettersToPreserve: [ - "\u00c4", // Ä, NFC-normalised - "\u00c5", // Å, NFC-normalised + "\u00C4", // Ä, NFC-normalised + "\u00C5", // Å, NFC-normalised "Ꝏ", "Ø", "Æ", @@ -225,17 +226,17 @@ const tests: SplittingModeTestCases[] = [ }, extraTestCases: [ [ - "\u00e4\u00e5", // äå, NFC-normalised + "\u00E4\u00E5", // äå, NFC-normalised [ - ["\u00e4", 0, 1], // ä, NFC-normalised - ["\u00e5", 1, 2], // å, NFC-normalised + ["\u00E4", 0, 1], // ä, NFC-normalised + ["\u00E5", 1, 2], // å, NFC-normalised ], ], [ - "\u00c4\u00c5", // ÄÅ, NFC-normalised + "\u00C4\u00C5", // ÄÅ, NFC-normalised [ - ["\u00e4", 0, 1], // ä, NFC-normalised - ["\u00e5", 1, 2], // å, NFC-normalised + ["\u00E4", 0, 1], // ä, NFC-normalised + ["\u00E5", 1, 2], // å, NFC-normalised ], ], ["ꝏ", [["ꝏ", 0, 1]]], diff --git a/packages/lib-engine/src/tokenizer/tokenizer.test.ts b/packages/lib-engine/src/tokenizer/tokenizer.test.ts index 2fd44b0f418..7bea485cdc6 100644 --- a/packages/lib-engine/src/tokenizer/tokenizer.test.ts +++ b/packages/lib-engine/src/tokenizer/tokenizer.test.ts @@ -76,10 +76,11 @@ const globalTests: TestCase[] = [ ["#111111", ["#", "111111"]], // Unicode characters ["aåäöb", ["aåäöb"]], - ["\u006E\u0303", ["\u006E\u0303"]], // ñ using combining mark + // ñ using combining mark + ["\u006E\u0303", ["\u006E\u0303"]], // Windows filepath [ - "tests\\recorded\\typescript\\name", + String.raw`tests\recorded\typescript\name`, ["tests", "\\", "recorded", "\\", "typescript", "\\", "name"], ], ]; @@ -93,7 +94,7 @@ const cssDialectTokenizerTests: LanguageTokenizerTests = { ["prefers-reduced-motion", ["prefers-reduced-motion"]], ], // Leave kebab and dashes to css language specific tests. - exclusionPredicate: (input: string) => !!input.match("-"), + exclusionPredicate: (input: string) => input.match("-") != null, }; const shellScriptDialectTokenizerTests: LanguageTokenizerTests = { @@ -106,7 +107,7 @@ const shellScriptDialectTokenizerTests: LanguageTokenizerTests = { ], ], // Leave kebab and dashes to css language specific tests. - exclusionPredicate: (input: string) => !!input.match("-"), + exclusionPredicate: (input: string) => input.match("-") != null, }; const languageTokenizerTests: Record = { @@ -175,8 +176,8 @@ function getAsciiSymbols() { ]; return flatten( rangesToTest.map(([start, end]) => - range(start.charCodeAt(0), end.charCodeAt(0) + 1).map((charCode) => - String.fromCharCode(charCode), + range(start.codePointAt(0)!, end.codePointAt(0)! + 1).map((charCode) => + String.fromCodePoint(charCode), ), ), ); diff --git a/packages/lib-engine/src/tokenizer/tokenizer.ts b/packages/lib-engine/src/tokenizer/tokenizer.ts index 03464af1cba..f6439d16517 100644 --- a/packages/lib-engine/src/tokenizer/tokenizer.ts +++ b/packages/lib-engine/src/tokenizer/tokenizer.ts @@ -1,5 +1,6 @@ import { escapeRegExp } from "lodash-es"; -import { matchAll, type IDE } from "@cursorless/lib-common"; +import { matchAll } from "@cursorless/lib-common"; +import type { IDE } from "@cursorless/lib-common"; import type { LanguageTokenizerComponents } from "./tokenizer.types"; const REPEATABLE_SYMBOLS = [ @@ -39,12 +40,16 @@ const FIXED_TOKENS = [ "-->", ]; -export const IDENTIFIER_WORD_REGEXES = ["\\p{L}", "\\p{M}", "\\p{N}"]; -const SINGLE_SYMBOLS_REGEX = "[^\\s\\w]"; +export const IDENTIFIER_WORD_REGEXES = [ + String.raw`\p{L}`, + String.raw`\p{M}`, + String.raw`\p{N}`, +]; +const SINGLE_SYMBOLS_REGEX = String.raw`[^\s\w]`; // Accepts digits dot digits if not preceded or followed by a digit or dot. The // negative lookahead / lookbehind are to prevent matching numbers in semantic // versions (eg 1.2.3) -const NUMBERS_REGEX = "(? -(penalty < 2 ? 0 : 1); case HatStability.stable: return (_) => 0; + // No default } } diff --git a/packages/lib-engine/src/util/allocateHats/getRankedTokens.ts b/packages/lib-engine/src/util/allocateHats/getRankedTokens.ts index 88a9553a67d..d137550e8c9 100644 --- a/packages/lib-engine/src/util/allocateHats/getRankedTokens.ts +++ b/packages/lib-engine/src/util/allocateHats/getRankedTokens.ts @@ -37,6 +37,7 @@ export function getRankedTokens( const displayLineMap = getDisplayLineMap(editor, [referencePosition.line]); const tokens = flatten( editor.visibleRanges.map((range) => + // oxlint-disable-next-line oxc/no-map-spread getTokensInRange(ide, editor, range).map((partialToken) => ({ ...partialToken, displayLine: displayLineMap.get(partialToken.range.start.line)!, @@ -91,7 +92,7 @@ function getRankedEditors( editors = visibleTextEditors; } else { editors = [ - activeTextEditor!, + activeTextEditor, ...visibleTextEditors.filter((editor) => editor !== activeTextEditor), ]; } diff --git a/packages/lib-engine/src/util/allocateHats/maxByFirstDiffering.test.ts b/packages/lib-engine/src/util/allocateHats/maxByFirstDiffering.test.ts index e9a10acf761..e2d11a7d2b7 100644 --- a/packages/lib-engine/src/util/allocateHats/maxByFirstDiffering.test.ts +++ b/packages/lib-engine/src/util/allocateHats/maxByFirstDiffering.test.ts @@ -14,15 +14,15 @@ suite("maxByFirstDiffering", () => { [0], [1], [-Infinity], - [+Infinity], + [Infinity], [0, 0], [0, 1], [1, 0], [-Infinity, -Infinity], - [-Infinity, +Infinity], - [+Infinity, -Infinity], - [+Infinity, 0], - [0, +Infinity], + [-Infinity, Infinity], + [Infinity, -Infinity], + [Infinity, 0], + [0, Infinity], [-Infinity, 0], [0, -Infinity], [0, 1, 0, 1], diff --git a/packages/lib-engine/src/util/getPartialTargetDescriptors.ts b/packages/lib-engine/src/util/getPartialTargetDescriptors.ts index 8fe16f94672..b4ae36762f5 100644 --- a/packages/lib-engine/src/util/getPartialTargetDescriptors.ts +++ b/packages/lib-engine/src/util/getPartialTargetDescriptors.ts @@ -43,5 +43,6 @@ function getPartialTargetDescriptorsFromDestination( return [destination.target]; case "implicit": return []; + // No default } } diff --git a/packages/lib-engine/src/util/getPrimitiveTargets.ts b/packages/lib-engine/src/util/getPrimitiveTargets.ts index dbc341215fb..f2f9357b25a 100644 --- a/packages/lib-engine/src/util/getPrimitiveTargets.ts +++ b/packages/lib-engine/src/util/getPrimitiveTargets.ts @@ -30,6 +30,7 @@ function getPartialPrimitiveTargetsHelper( ); case "implicit": return []; + // No default } } @@ -80,5 +81,6 @@ function transformPartialPrimitiveTargetsHelper( | ImplicitTargetDescriptor, active: func(target.active), }; + // No default } } diff --git a/packages/lib-engine/src/util/targetUtils.ts b/packages/lib-engine/src/util/targetUtils.ts index 74afe736262..a18f684d465 100644 --- a/packages/lib-engine/src/util/targetUtils.ts +++ b/packages/lib-engine/src/util/targetUtils.ts @@ -41,7 +41,7 @@ export function ensureSingleTarget( return targets[0]; } -export async function runForEachEditor( +export function runForEachEditor( targets: T[], getEditor: (target: T) => TextEditor, func: (editor: TextEditor, editorTargets: T[]) => Promise, @@ -53,7 +53,7 @@ export async function runForEachEditor( ); } -export async function runOnTargetsForEachEditor( +export function runOnTargetsForEachEditor( targets: Target[], func: (editor: TextEditor, targets: Target[]) => Promise, ): Promise { diff --git a/packages/lib-engine/src/util/tryConstructTarget.ts b/packages/lib-engine/src/util/tryConstructTarget.ts index 4422df7b9be..0c4718bb29f 100644 --- a/packages/lib-engine/src/util/tryConstructTarget.ts +++ b/packages/lib-engine/src/util/tryConstructTarget.ts @@ -24,7 +24,8 @@ export function tryConstructTarget( ): T | undefined { return range == null ? undefined - : new constructor({ + : // oxlint-disable-next-line new-cap + new constructor({ editor, isReversed, contentRange: range, diff --git a/packages/lib-engine/src/util/unifyRanges.ts b/packages/lib-engine/src/util/unifyRanges.ts index 7d97039c092..fd5d09ad164 100644 --- a/packages/lib-engine/src/util/unifyRanges.ts +++ b/packages/lib-engine/src/util/unifyRanges.ts @@ -7,21 +7,24 @@ export function unifyRemovalTargets(targets: Target[]): Target[] { if (targets.length < 2) { return targets; } - return groupTargetsForEachEditor(targets).flatMap(([_editor, targets]) => { - if (targets.length < 2) { - return targets; - } - let results = [...targets]; - results.sort((a, b) => - a.contentRange.start.compareTo(b.contentRange.start), - ); - let run = true; - // Merge targets until there are no overlaps/intersections - while (run) { - [results, run] = unifyTargetsOnePass(results); - } - return results; - }); + // oxlint-disable-next-line oxc/no-map-spread + return groupTargetsForEachEditor(targets).flatMap( + ([_editor, editorTargets]) => { + if (editorTargets.length < 2) { + return editorTargets; + } + let results = [...editorTargets]; + results.sort((a, b) => + a.contentRange.start.compareTo(b.contentRange.start), + ); + let run = true; + // Merge targets until there are no overlaps/intersections + while (run) { + [results, run] = unifyTargetsOnePass(results); + } + return results; + }, + ); } function unifyTargetsOnePass(targets: Target[]): [Target[], boolean] { @@ -33,7 +36,7 @@ function unifyTargetsOnePass(targets: Target[]): [Target[], boolean] { targets.forEach((target) => { // No intersection. Mark start of new group if ( - currentGroup.length && + currentGroup.length > 0 && !intersects(currentGroup[currentGroup.length - 1], target) ) { results.push(mergeTargets(currentGroup)); diff --git a/packages/lib-neovim-common/src/getExtensionApi.ts b/packages/lib-neovim-common/src/getExtensionApi.ts index e293b2f927f..21dc1ba94f8 100644 --- a/packages/lib-neovim-common/src/getExtensionApi.ts +++ b/packages/lib-neovim-common/src/getExtensionApi.ts @@ -5,12 +5,7 @@ export interface CursorlessApi { testHelpers: NeovimTestHelpers | undefined; } -export async function getExtensionApi(extensionId: string) { - const api = getNeovimRegistry().getExtensionApi(extensionId); - return api == null ? null : (api as T); -} - -export async function getExtensionApiStrict(extensionId: string) { +function getExtensionApiStrict(extensionId: string) { const api = getNeovimRegistry().getExtensionApi(extensionId); if (api == null) { diff --git a/packages/lib-neovim-common/src/ide/neovim/NeovimEdit.ts b/packages/lib-neovim-common/src/ide/neovim/NeovimEdit.ts index 879975ede61..47836c8daa3 100644 --- a/packages/lib-neovim-common/src/ide/neovim/NeovimEdit.ts +++ b/packages/lib-neovim-common/src/ide/neovim/NeovimEdit.ts @@ -81,14 +81,13 @@ async function neovimDelete(client: NeovimClient, range: Range): Promise { console.debug(`neovimDelete(): range=${JSON.stringify(range)}`); const buffer = await client.window.buffer; + let lines = await buffer.getLines({ + start: range.end.line, + end: range.end.line + 1, + strictIndexing: true, + }); // only keep the end of the last line - const lastLine = ( - await buffer.getLines({ - start: range.end.line, - end: range.end.line + 1, - strictIndexing: true, - }) - )[0]; + const lastLine = lines[0]; const endOfLastLine = lastLine.slice(range.end.character); // are we only modifying one existing line? @@ -117,14 +116,13 @@ async function neovimDelete(client: NeovimClient, range: Range): Promise { return; } + lines = await buffer.getLines({ + start: range.start.line, + end: range.start.line + 1, + strictIndexing: true, + }); // only keep the beginning of the first line - const firstLine = ( - await buffer.getLines({ - start: range.start.line, - end: range.start.line + 1, - strictIndexing: true, - }) - )[0]; + const firstLine = lines[0]; const startOfFirstLine = firstLine.slice(0, range.start.character); // are we not including the newline at the end of the first line? @@ -154,17 +152,16 @@ async function neovimInsert( `neovimInsert(): position=${JSON.stringify(position)}, text='${text}'`, ); // standardise newlines so we can easily split the lines - const newLines = text.replace(/(?:\r\n|\r|\n)/g, "\n").split("\n"); + const newLines = text.replaceAll(/(?:\r\n|\r|\n)/g, "\n").split("\n"); const buffer = await client.window.buffer; - const lineWhereInsertion = ( - await buffer.getLines({ - start: position.line, - end: position.line + 1, - strictIndexing: true, - }) - )[0]; + const lines = await buffer.getLines({ + start: position.line, + end: position.line + 1, + strictIndexing: true, + }); + const lineWhereInsertion = lines[0]; const startOfFirstLine = lineWhereInsertion.slice(0, position.character); const endOfLastLine = lineWhereInsertion.slice(position.character); @@ -184,14 +181,11 @@ async function neovimInsert( const firstLine = startOfFirstLine + newLines[0]; const lastLine = newLines[newLines.length - 1] + endOfLastLine; - await buffer.setLines( - [firstLine, ...newLines.slice(1, newLines.length - 1), lastLine], - { - start: position.line, - end: position.line + 1, - strictIndexing: true, - }, - ); + await buffer.setLines([firstLine, ...newLines.slice(1, -1), lastLine], { + start: position.line, + end: position.line + 1, + strictIndexing: true, + }); } async function neovimReplace(client: NeovimClient, range: Range, text: string) { @@ -207,7 +201,5 @@ function isInsert(edit: Edit): boolean { } function isReplace(edit: Edit): boolean { - return ( - edit.text !== "" && (!edit.range.isEmpty || edit.isReplace ? true : false) - ); + return edit.text !== "" && (!edit.range.isEmpty || edit.isReplace != null); } diff --git a/packages/lib-neovim-common/src/ide/neovim/NeovimIDE.ts b/packages/lib-neovim-common/src/ide/neovim/NeovimIDE.ts index 024bcafcadc..2a17332e419 100644 --- a/packages/lib-neovim-common/src/ide/neovim/NeovimIDE.ts +++ b/packages/lib-neovim-common/src/ide/neovim/NeovimIDE.ts @@ -3,6 +3,7 @@ import { pull } from "lodash"; import type { Buffer, NeovimClient, Window } from "neovim"; import { v4 as uuid } from "uuid"; import { URI } from "vscode-uri"; +import { getErrorMessage } from "@cursorless/lib-common"; import type { Disposable, EditableTextEditor, @@ -84,14 +85,14 @@ export class NeovimIDE implements IDE { ); } - async showQuickPick( + showQuickPick( _items: readonly string[], _options?: QuickPickOptions, ): Promise { throw new Error("showQuickPick: not implemented"); } - async setHighlightRanges( + setHighlightRanges( _highlightId: string | undefined, _editor: TextEditor, _ranges: GeneralizedRange[], @@ -99,8 +100,9 @@ export class NeovimIDE implements IDE { throw new Error("setHighlightRanges: not implemented"); } - async flashRanges(_flashDescriptors: FlashDescriptor[]): Promise { + flashRanges(_flashDescriptors: FlashDescriptor[]): Promise { console.debug("flashRanges Not implemented"); + return Promise.resolve(); } get assetsRoot(): string { @@ -164,32 +166,29 @@ export class NeovimIDE implements IDE { return editor as EditableTextEditor; } - public async findInDocument( - _query: string, - _editor: TextEditor, - ): Promise { + public findInDocument(_query: string, _editor: TextEditor): Promise { throw new Error("findInDocument: not implemented"); } - public async findInWorkspace(_query: string): Promise { + public findInWorkspace(_query: string): Promise { throw new Error("findInWorkspace: not implemented"); } - public async openTextDocument(_path: string): Promise { + public openTextDocument(_path: string): Promise { throw new Error("openTextDocument: not implemented"); } - public async openUntitledTextDocument( + public openUntitledTextDocument( _options: OpenUntitledTextDocumentOptions, ): Promise { throw new Error("openUntitledTextDocument: not implemented"); } - public async showInputBox(_options?: any): Promise { + public showInputBox(_options?: any): Promise { throw new Error("showInputBox: not implemented"); } - public async executeCommand( + public executeCommand( _command: string, ..._args: any[] ): Promise { @@ -308,8 +307,9 @@ export class NeovimIDE implements IDE { return this.activeTextEditor as NeovimTextEditor; } - handleCommandError(err: Error) { - void showErrorMessage(this.client, err.message); + handleCommandError(error: unknown) { + const message = getErrorMessage(error); + void showErrorMessage(this.client, message); } disposeOnExit(...disposables: Disposable[]): () => void { diff --git a/packages/lib-neovim-common/src/ide/neovim/NeovimMessages.ts b/packages/lib-neovim-common/src/ide/neovim/NeovimMessages.ts index 81af7cd2b92..6d5dc41afec 100644 --- a/packages/lib-neovim-common/src/ide/neovim/NeovimMessages.ts +++ b/packages/lib-neovim-common/src/ide/neovim/NeovimMessages.ts @@ -1,12 +1,12 @@ import type { MessageId, Messages, MessageType } from "@cursorless/lib-common"; export default class NeovimMessages implements Messages { - async showMessage( + showMessage( _type: MessageType, _id: MessageId, _message: string, ..._options: string[] ): Promise { - return undefined; + return Promise.resolve(undefined); } } diff --git a/packages/lib-neovim-common/src/ide/neovim/NeovimTextDocument.ts b/packages/lib-neovim-common/src/ide/neovim/NeovimTextDocument.ts index 2f5be6254b5..17806e4c466 100644 --- a/packages/lib-neovim-common/src/ide/neovim/NeovimTextDocument.ts +++ b/packages/lib-neovim-common/src/ide/neovim/NeovimTextDocument.ts @@ -128,7 +128,7 @@ export class NeovimTextDocument implements TextDocument { } if (range.isSingleLine) { - return this._lines[range.start.line].substring( + return this._lines[range.start.line].slice( range.start.character, range.end.character, ); @@ -137,17 +137,14 @@ export class NeovimTextDocument implements TextDocument { const lineEnding = this._eol, startLineIndex = range.start.line, endLineIndex = range.end.line, - resultLines: string[] = []; + resultLines: string[] = [ + this._lines[startLineIndex].slice(range.start.character), + ]; - resultLines.push( - this._lines[startLineIndex].substring(range.start.character), - ); for (let i = startLineIndex + 1; i < endLineIndex; i++) { resultLines.push(this._lines[i]); } - resultLines.push( - this._lines[endLineIndex].substring(0, range.end.character), - ); + resultLines.push(this._lines[endLineIndex].slice(0, range.end.character)); return resultLines.join(lineEnding); } @@ -223,10 +220,12 @@ export function toUint32(v: number): number { if (v < 0) { return 0; } - const maxUint32 = 4294967295; // 2^32 - 1 + // 2^32 - 1 + const maxUint32 = 4_294_967_295; if (v > maxUint32) { return maxUint32; } + // oxlint-disable-next-line unicorn/prefer-math-trunc, no-bitwise return v | 0; } @@ -312,6 +311,7 @@ export class PrefixSumComputer { let midStop; while (low <= high) { + // oxlint-disable-next-line unicorn/prefer-math-trunc, no-bitwise mid = (low + (high - low) / 2) | 0; midStop = this.prefixSum[mid]; diff --git a/packages/lib-neovim-common/src/ide/neovim/NeovimTextEditor.ts b/packages/lib-neovim-common/src/ide/neovim/NeovimTextEditor.ts index 3be77d3127d..7d2f45a56d8 100644 --- a/packages/lib-neovim-common/src/ide/neovim/NeovimTextEditor.ts +++ b/packages/lib-neovim-common/src/ide/neovim/NeovimTextEditor.ts @@ -58,7 +58,7 @@ export class NeovimTextEditor implements EditableTextEditor { } get selections(): Selection[] { - return this._selections as Selection[]; + return this._selections; } async setSelections(selections: Selection[]): Promise { @@ -128,7 +128,7 @@ export class NeovimTextEditor implements EditableTextEditor { throw new Error("toggleBreakpoint: not implemented"); } - public async toggleLineComment(_ranges?: Range[]): Promise { + public toggleLineComment(_ranges?: Range[]): Promise { throw new Error("toggleLineComment: not implemented"); } @@ -140,15 +140,15 @@ export class NeovimTextEditor implements EditableTextEditor { await neovimClipboardPaste(this.client, this.neovimIDE); } - public async indentLine(_ranges?: Range[]): Promise { + public indentLine(_ranges?: Range[]): Promise { throw new Error("indentLine: not implemented"); } - public async outdentLine(_ranges?: Range[]): Promise { + public outdentLine(_ranges?: Range[]): Promise { throw new Error("outdentLine: not implemented"); } - public async insertLineAfter(_ranges?: Range[]): Promise { + public insertLineAfter(_ranges?: Range[]): Promise { throw new Error("insertLineAfter: not implemented"); } @@ -156,59 +156,59 @@ export class NeovimTextEditor implements EditableTextEditor { throw new Error("insertSnippet: not implemented"); } - public async rename(_range?: Range): Promise { + public rename(_range?: Range): Promise { throw new Error("rename: not implemented"); } - public async showReferences(_range?: Range): Promise { + public showReferences(_range?: Range): Promise { throw new Error("showReferences: not implemented"); } - public async quickFix(_range?: Range): Promise { + public quickFix(_range?: Range): Promise { throw new Error("quickFix: not implemented"); } - public async revealDefinition(_range?: Range): Promise { + public revealDefinition(_range?: Range): Promise { throw new Error("revealDefinition: not implemented"); } - public async revealTypeDefinition(_range?: Range): Promise { + public revealTypeDefinition(_range?: Range): Promise { throw new Error("revealTypeDefinition: not implemented"); } - public async showHover(_range?: Range): Promise { + public showHover(_range?: Range): Promise { throw new Error("showHover: not implemented"); } - public async showDebugHover(_range?: Range): Promise { + public showDebugHover(_range?: Range): Promise { throw new Error("showDebugHover: not implemented"); } - public async extractVariable(_range?: Range): Promise { + public extractVariable(_range?: Range): Promise { throw new Error("extractVariable: not implemented"); } - public async gitAccept(_range?: Range): Promise { + public gitAccept(_range?: Range): Promise { throw new Error("gitAccept: not implemented"); } - public async gitRevert(_range?: Range): Promise { + public gitRevert(_range?: Range): Promise { throw new Error("gitRevert: not implemented"); } - public async gitStageFile(): Promise { + public gitStageFile(): Promise { throw new Error("gitStageFile: not implemented"); } - public async gitUnstageFile(): Promise { + public gitUnstageFile(): Promise { throw new Error("gitUnstageFile: not implemented"); } - public async gitStageRange(_range?: Range): Promise { + public gitStageRange(_range?: Range): Promise { throw new Error("gitStageRange: not implemented"); } - public async gitUnstageRange(_range?: Range): Promise { + public gitUnstageRange(_range?: Range): Promise { throw new Error("gitUnstageRange: not implemented"); } } diff --git a/packages/lib-neovim-common/src/neovimApi.ts b/packages/lib-neovim-common/src/neovimApi.ts index 461034581f8..8b44ea05b99 100644 --- a/packages/lib-neovim-common/src/neovimApi.ts +++ b/packages/lib-neovim-common/src/neovimApi.ts @@ -26,7 +26,7 @@ export async function bufferGetSelections( ]; // subtract 1 to the lines/columns to get the correct 0-based line/column numbers let selections: Selection[]; - if (reverse === true) { + if (reverse) { selections = [ new Selection( new Position(endLine - 1, endCol - 1), diff --git a/packages/lib-neovim-common/src/neovimHelpers.ts b/packages/lib-neovim-common/src/neovimHelpers.ts index c6ff8eeb322..a80c67c53c8 100644 --- a/packages/lib-neovim-common/src/neovimHelpers.ts +++ b/packages/lib-neovim-common/src/neovimHelpers.ts @@ -2,12 +2,12 @@ import type { NeovimClient } from "neovim"; import type { IDE } from "@cursorless/lib-common"; +import type { NeovimTextEditor } from "./ide/neovim/NeovimTextEditor"; import { bufferGetSelections, pasteFromClipboard, setClipboard, -} from "@cursorless/lib-neovim-common"; -import type { NeovimTextEditor } from "./ide/neovim/NeovimTextEditor"; +} from "./neovimApi"; export async function neovimClipboardCopy( client: NeovimClient, diff --git a/packages/lib-neovim-common/src/testUtil/openNewEditor.ts b/packages/lib-neovim-common/src/testUtil/openNewEditor.ts index b115ace2c51..ce7f9b125d6 100644 --- a/packages/lib-neovim-common/src/testUtil/openNewEditor.ts +++ b/packages/lib-neovim-common/src/testUtil/openNewEditor.ts @@ -6,15 +6,15 @@ export interface NewEditorOptions { openBeside?: boolean; } -export async function openNewEditor( +export function openNewEditor( _content: string, _NewEditorOptions = {}, ): Promise { throw new Error("openNewEditor() Not implemented"); } -export async function reuseEditor( - _editor: NeovimTextDocument, // vscode.TextEditor, +export function reuseEditor( + _editor: NeovimTextDocument, _content: string, _language: string = "plaintext", ) { @@ -28,7 +28,7 @@ export async function reuseEditor( * @param _language The language id to use for all the cells in the notebook * @returns notebook */ -export async function openNewNotebookEditor( +export function openNewNotebookEditor( _cellContents: string[], _language: string = "plaintext", ) { diff --git a/packages/lib-node-common/src/Cheatsheet.ts b/packages/lib-node-common/src/Cheatsheet.ts index db71394ca73..00b9606ffd2 100644 --- a/packages/lib-node-common/src/Cheatsheet.ts +++ b/packages/lib-node-common/src/Cheatsheet.ts @@ -3,13 +3,13 @@ import * as path from "node:path"; import { produce } from "immer"; import { sortBy } from "lodash-es"; import { parse } from "node-html-parser"; -import { type IDE } from "@cursorless/lib-common"; -import { getCursorlessRepoRoot } from "@cursorless/lib-node-common"; +import type { IDE } from "@cursorless/lib-common"; +import { getCursorlessRepoRoot } from "./getCursorlessRepoRoot"; /** * The argument expected by the cheatsheet command. */ -interface CheatSheetCommandArg { +export interface CheatSheetCommandArg { /** * The version of the cheatsheet command. */ @@ -37,7 +37,7 @@ export async function showCheatsheet( const cheatsheetPath = path.join(ide.assetsRoot, "cheatsheet.html"); - const cheatsheetContent = (await readFile(cheatsheetPath)).toString(); + const cheatsheetContent = await readFile(cheatsheetPath, "utf8"); const root = parse(cheatsheetContent); diff --git a/packages/lib-node-common/src/FileSystemRawTreeSitterQueryProvider.ts b/packages/lib-node-common/src/FileSystemRawTreeSitterQueryProvider.ts index 3c82fb424f4..f1f8d31d8f8 100644 --- a/packages/lib-node-common/src/FileSystemRawTreeSitterQueryProvider.ts +++ b/packages/lib-node-common/src/FileSystemRawTreeSitterQueryProvider.ts @@ -1,10 +1,10 @@ import * as path from "node:path"; -import { - Notifier, - type Disposable, - type FileSystem, - type IDE, - type RawTreeSitterQueryProvider, +import { Notifier } from "@cursorless/lib-common"; +import type { + Disposable, + FileSystem, + IDE, + RawTreeSitterQueryProvider, } from "@cursorless/lib-common"; import { getCursorlessRepoRoot } from "./getCursorlessRepoRoot"; diff --git a/packages/lib-node-common/src/FileSystemTalonSpokenForms.ts b/packages/lib-node-common/src/FileSystemTalonSpokenForms.ts index fa2a7b1e818..430e748e317 100644 --- a/packages/lib-node-common/src/FileSystemTalonSpokenForms.ts +++ b/packages/lib-node-common/src/FileSystemTalonSpokenForms.ts @@ -8,6 +8,7 @@ import type { TalonSpokenForms, } from "@cursorless/lib-common"; import { NeedsInitialTalonUpdateError, Notifier } from "@cursorless/lib-common"; +import { isEnoentError } from "./isError"; interface TalonSpokenFormsPayload { version: number; @@ -40,16 +41,16 @@ export class FileSystemTalonSpokenForms implements TalonSpokenForms { let payload: TalonSpokenFormsPayload; try { payload = JSON.parse( - await readFile(this.fileSystem.cursorlessTalonStateJsonPath, "utf-8"), + await readFile(this.fileSystem.cursorlessTalonStateJsonPath, "utf8"), ); - } catch (err) { - if (isErrnoException(err) && err.code === "ENOENT") { + } catch (error) { + if (isEnoentError(error)) { throw new NeedsInitialTalonUpdateError( `Custom spoken forms file not found at ${this.fileSystem.cursorlessTalonStateJsonPath}. Using default spoken forms.`, ); } - throw err; + throw error; } if (payload.version !== LATEST_SPOKEN_FORMS_JSON_VERSION) { @@ -66,15 +67,3 @@ export class FileSystemTalonSpokenForms implements TalonSpokenForms { this.disposable.dispose(); } } - -/** - * A user-defined type guard function that checks if a given error is a - * `NodeJS.ErrnoException`. - * - * @param {any} error - The error to check. - * @returns {error is NodeJS.ErrnoException} - Returns `true` if the error is a - * {@link NodeJS.ErrnoException}, otherwise `false`. - */ -function isErrnoException(error: any): error is NodeJS.ErrnoException { - return error instanceof Error && "code" in error; -} diff --git a/packages/lib-node-common/src/FileSystemTutorialContentProvider.ts b/packages/lib-node-common/src/FileSystemTutorialContentProvider.ts index 8c12ee337e2..a0788aa6264 100644 --- a/packages/lib-node-common/src/FileSystemTutorialContentProvider.ts +++ b/packages/lib-node-common/src/FileSystemTutorialContentProvider.ts @@ -2,6 +2,7 @@ import { readFile, readdir } from "node:fs/promises"; import * as path from "node:path"; import type { RawTutorialContent, + TestCaseFixtureLegacy, TutorialContentProvider, TutorialId, } from "@cursorless/lib-common"; @@ -39,7 +40,10 @@ export class FileSystemTutorialContentProvider implements TutorialContentProvide }; } - async loadFixture(tutorialId: TutorialId, fixtureName: string) { + loadFixture( + tutorialId: TutorialId, + fixtureName: string, + ): Promise { return loadFixture( path.join(this.tutorialRootDir, tutorialId, fixtureName), ); diff --git a/packages/lib-node-common/src/getCursorlessRepoRoot.ts b/packages/lib-node-common/src/getCursorlessRepoRoot.ts index bd2402226f0..778c9ba41c4 100644 --- a/packages/lib-node-common/src/getCursorlessRepoRoot.ts +++ b/packages/lib-node-common/src/getCursorlessRepoRoot.ts @@ -4,6 +4,7 @@ * @returns The path to the root of the cursorless repo */ export function getCursorlessRepoRoot() { + // oxlint-disable-next-line node/no-process-env const root = process.env["CURSORLESS_REPO_ROOT"]; if (root == null) { throw new Error( diff --git a/packages/lib-node-common/src/getFixturePaths.ts b/packages/lib-node-common/src/getFixturePaths.ts index 63f1cd05ee4..1e9e993c0c2 100644 --- a/packages/lib-node-common/src/getFixturePaths.ts +++ b/packages/lib-node-common/src/getFixturePaths.ts @@ -3,7 +3,7 @@ import type { PlaintextScopeSupportFacet, ScopeSupportFacet, } from "@cursorless/lib-common"; -import { getCursorlessRepoRoot } from "@cursorless/lib-node-common"; +import { getCursorlessRepoRoot } from "./getCursorlessRepoRoot"; import { walkFilesSync } from "./walkSync"; export function getFixturesPath() { @@ -74,6 +74,6 @@ export function getScopeTestConfigPaths() { function pathToName(relativeDir: string, filePath: string) { return path - .relative(relativeDir, filePath.substring(0, filePath.lastIndexOf("."))) + .relative(relativeDir, filePath.slice(0, filePath.lastIndexOf("."))) .replaceAll("\\", "/"); } diff --git a/packages/lib-node-common/src/index.ts b/packages/lib-node-common/src/index.ts index 32ab6cd3219..b57c0873124 100644 --- a/packages/lib-node-common/src/index.ts +++ b/packages/lib-node-common/src/index.ts @@ -6,6 +6,7 @@ export * from "./FileSystemTutorialContentProvider"; export * from "./getCursorlessRepoRoot"; export * from "./getFixturePaths"; export * from "./getScopeTestPathsRecursively"; +export * from "./isError"; export * from "./isOS"; export * from "./loadFixture"; export * from "./nodeGetRunMode"; diff --git a/packages/lib-node-common/src/isError.ts b/packages/lib-node-common/src/isError.ts new file mode 100644 index 00000000000..5ec2e13af70 --- /dev/null +++ b/packages/lib-node-common/src/isError.ts @@ -0,0 +1,21 @@ +/** + * A user-defined type guard function that checks if a given error is a + * `NodeJS.ErrnoException`. + * + * @param {unknown} error - error to check. + * @returns {error is NodeJS.ErrnoException} - Returns `true` if the error is a + * {@link NodeJS.ErrnoException}, otherwise `false`. + */ +export function isErrnoException( + error: unknown, +): error is NodeJS.ErrnoException { + return error instanceof Error && "code" in error; +} + +export function isEnoentError(error: unknown): error is NodeJS.ErrnoException { + return isErrnoException(error) && error.code === "ENOENT"; +} + +export function isEexistError(error: unknown): error is NodeJS.ErrnoException { + return isErrnoException(error) && error.code === "EEXIST"; +} diff --git a/packages/lib-node-common/src/nodeGetRunMode.ts b/packages/lib-node-common/src/nodeGetRunMode.ts index 145f309f36b..8b490752940 100644 --- a/packages/lib-node-common/src/nodeGetRunMode.ts +++ b/packages/lib-node-common/src/nodeGetRunMode.ts @@ -8,6 +8,7 @@ import type { RunMode } from "@cursorless/lib-common"; * @returns The current run mode of the application */ export function nodeGetRunMode(): RunMode { + // oxlint-disable-next-line node/no-process-env const mode = process.env.CURSORLESS_MODE; switch (mode) { case undefined: diff --git a/packages/lib-node-common/src/runRecordedTest.ts b/packages/lib-node-common/src/runRecordedTest.ts index ca12cb6b1b5..b2b630bc777 100644 --- a/packages/lib-node-common/src/runRecordedTest.ts +++ b/packages/lib-node-common/src/runRecordedTest.ts @@ -43,7 +43,8 @@ function createSelection(selection: SelectionPlainObject): Selection { function normalizeRecordedReturnValue(returnValue: unknown) { // Recorded fixtures store plain serialized data rather than runtime instances. return returnValue != null && typeof returnValue === "object" - ? JSON.parse(JSON.stringify(returnValue)) + ? // oxlint-disable-next-line unicorn/prefer-structured-clone + JSON.parse(JSON.stringify(returnValue)) : returnValue; } @@ -168,8 +169,8 @@ export async function runRecordedTest({ fallback = "fallback" in commandResponse ? commandResponse.fallback : undefined; } - } catch (err) { - const error = err as Error; + } catch (error) { + const errorName = error instanceof Error ? error.name : "unknown"; if (shouldUpdateFixtures()) { const outputFixture = { @@ -177,13 +178,13 @@ export async function runRecordedTest({ finalState: undefined, decorations: undefined, returnValue: undefined, - thrownError: { name: error.name }, + thrownError: { name: errorName }, }; await fsp.writeFile(path, serializeTestFixture(outputFixture)); } else if (fixture.thrownError != null) { assert.equal( - error.name, + errorName, fixture.thrownError.name, "Unexpected thrown error", ); diff --git a/packages/lib-sentence-parser/src/Match.ts b/packages/lib-sentence-parser/src/Match.ts index 691fc4df65f..0d33088e8c6 100644 --- a/packages/lib-sentence-parser/src/Match.ts +++ b/packages/lib-sentence-parser/src/Match.ts @@ -22,7 +22,8 @@ const englishAbbreviations = [ "est", "etc", "Ex", - "ext", // + number? + // + number? + "ext", "Fig", "fig", "Figs", @@ -115,25 +116,28 @@ export function setAbbreviations(abbr: string[] | undefined) { } } -export function isCapitalized(str: string) { +export function isCapitalized(str: string): boolean { return /^[A-Z][a-z].*/.test(str) || isNumber(str); } // Start with opening quotes or capitalized letter -export function isSentenceStarter(str: string) { - return isCapitalized(str) || /``|"|'/.test(str.substring(0, 2)); +export function isSentenceStarter(str: string): boolean { + return isCapitalized(str) || /``|"|'/.test(str.slice(0, 2)); } -export function isCommonAbbreviation(str: string) { - const noSymbols = str.replace(/[-'`~!@#$%^&*()_|+=?;:'",.<>{}[\]\\/]/gi, ""); +export function isCommonAbbreviation(str: string): boolean { + const noSymbols = str.replaceAll( + /[-'`~!@#$%^&*()_|+=?;:'",.<>{}[\]\\/]/gi, + "", + ); - return ~abbreviations.indexOf(noSymbols); + return abbreviations.includes(noSymbols); } // This is going towards too much rule based -export function isTimeAbbreviation(word: string, next: string) { +export function isTimeAbbreviation(word: string, next: string): boolean { if (word === "a.m." || word === "p.m.") { - const tmp = next.replace(/\W+/g, "").slice(-3).toLowerCase(); + const tmp = next.replaceAll(/\W+/g, "").slice(-3).toLowerCase(); if (tmp === "day") { return true; @@ -144,7 +148,7 @@ export function isTimeAbbreviation(word: string, next: string) { } export function isDottedAbbreviation(word: string) { - const matches = word.replace(/[()[]{}]/g, "").match(/(.\.)*/); + const matches = word.replaceAll(/[()[]{}]/g, "").match(/(.\.)*/); return matches && matches[0].length > 0; } @@ -166,7 +170,7 @@ export function isNameAbbreviation(wordCount: number, words: string[]) { return true; } - const capitalized = words.filter(function (str) { + const capitalized = words.filter((str) => { return /[A-Z]/.test(str.charAt(0)); }); @@ -181,7 +185,7 @@ export function isNumber(str: string, dotPos?: number) { str = str.slice(dotPos - 1, dotPos + 2); } - return !isNaN(str as unknown as number); + return !Number.isNaN(Number(str)); } // Phone number matching @@ -213,7 +217,7 @@ export function isConcatenated(word: string) { const c = word.charAt(i + 1); // Check if the next word starts with a letter - if (c.match(/[a-zA-Z].*/)) { + if (/[a-zA-Z].*/.test(c)) { return [word.slice(0, i), word.slice(i + 1)]; } } diff --git a/packages/lib-sentence-parser/src/sbd.ts b/packages/lib-sentence-parser/src/sbd.ts index f8502a1e3b7..dd4c7f34e61 100644 --- a/packages/lib-sentence-parser/src/sbd.ts +++ b/packages/lib-sentence-parser/src/sbd.ts @@ -1,12 +1,13 @@ +// oxlint-disable max-depth import * as Match from "./Match"; import * as stringHelper from "./stringHelper"; const newline_placeholder = " @~@ "; const newline_placeholder_t = newline_placeholder.trim(); -const whiteSpaceCheck = new RegExp("\\S", ""); -const addNewLineBoundaries = new RegExp("\\n+|[-#=_+*]{4,}", "g"); -const splitIntoWords = new RegExp("\\S+|\\n", "g"); +const whiteSpaceCheck = new RegExp(String.raw`\S`, ""); +const addNewLineBoundaries = new RegExp(String.raw`\n+|[-#=_+*]{4,}`, "g"); +const splitIntoWords = new RegExp(String.raw`\S+|\n`, "g"); export interface SentenceParserOptions { newlineBoundaries?: boolean; @@ -55,7 +56,7 @@ export function getSentences( tokens = text.split(/(|\S+|\n+)/); // every other token is a word - words = tokens.filter(function (token, ii) { + words = tokens.filter((token, ii) => { return ii % 2; }); } else { @@ -70,7 +71,7 @@ export function getSentences( let current = []; // If given text is only whitespace (or nothing of \S+) - if (!words || !words.length) { + if (!words || words.length === 0) { return []; } @@ -81,7 +82,7 @@ export function getSentences( current.push(words[i]); // Sub-sentences, reset counter - if (~words[i].indexOf(",")) { + if (words[i].includes(",")) { wordCount = 0; } @@ -117,10 +118,7 @@ export function getSentences( // This probably needs to be improved with machine learning if (i + 1 < L) { // Single character abbr. - if ( - words[i].length === 2 && - isNaN(words[i].charAt(0) as unknown as number) - ) { + if (words[i].length === 2 && !/^\d/.test(words[i])) { continue; } @@ -199,17 +197,17 @@ export function getSentences( } } - if (current.length) { + if (current.length > 0) { sentences.push(current); } // Clear "empty" sentences - sentences = sentences.filter(function (s) { + sentences = sentences.filter((s) => { return s.length > 0; }); const result = sentences.slice(1).reduce( - function (out, sentence) { + (out, sentence) => { const lastSentence = out[out.length - 1]; // Single words, could be "enumeration lists" @@ -231,7 +229,7 @@ export function getSentences( ); // join tokens back together - return result.map(function (sentence, ii) { + return result.map((sentence, ii) => { if (options.preserveWhitespace && !options.newlineBoundaries) { // tokens looks like so: [leading-space token, non-space token, space // token, non-space token, space token... ]. In other words, the first diff --git a/packages/lib-sentence-parser/src/stringHelper.ts b/packages/lib-sentence-parser/src/stringHelper.ts index 7688c3ceb4e..4a3e053f76a 100644 --- a/packages/lib-sentence-parser/src/stringHelper.ts +++ b/packages/lib-sentence-parser/src/stringHelper.ts @@ -1,6 +1,6 @@ export function endsWithChar(word: string, c: string) { if (c.length > 1) { - return c.indexOf(word.slice(-1)) > -1; + return c.includes(word.slice(-1)); } return word.slice(-1) === c; diff --git a/packages/lib-sentence-parser/src/test/newline.test.ts b/packages/lib-sentence-parser/src/test/newline.test.ts index ce93e1d620f..f53e45209c1 100644 --- a/packages/lib-sentence-parser/src/test/newline.test.ts +++ b/packages/lib-sentence-parser/src/test/newline.test.ts @@ -34,6 +34,7 @@ suite("sentence-parser: Save newlines", function () { suite("Multiline strings", function () { const entry = + // oxlint-disable-next-line no-multi-str "How now brown cow.\ \ Peter Piper Picked a peck of pickled peppers. A peck of pickled peppers peter piper picked."; diff --git a/packages/lib-sentence-parser/src/test/preserve_whitespace.test.ts b/packages/lib-sentence-parser/src/test/preserve_whitespace.test.ts index 6378836d7cb..df1a55da09d 100644 --- a/packages/lib-sentence-parser/src/test/preserve_whitespace.test.ts +++ b/packages/lib-sentence-parser/src/test/preserve_whitespace.test.ts @@ -26,10 +26,10 @@ suite("sentence-parser: Preserve whitespace", function () { suite("No effect if newline_boundaries are specified", function () { const entry = " This is\ta sentence with funny whitespace. "; - const sentences = parser.getSentences( - entry, - Object.assign({ newlineBoundaries: true }, options), - ); + const sentences = parser.getSentences(entry, { + newlineBoundaries: true, + ...options, + }); test("should get 1 sentences", function () { assert.equal(sentences.length, 1); diff --git a/packages/lib-talonjs-core/src/extension.ts b/packages/lib-talonjs-core/src/extension.ts index 0a7c6aaba36..a3cfd8dec5a 100644 --- a/packages/lib-talonjs-core/src/extension.ts +++ b/packages/lib-talonjs-core/src/extension.ts @@ -1,4 +1,6 @@ +// oxlint-disable-next-line import/no-unassigned-import import "./polyfill"; + import type { RunMode } from "@cursorless/lib-common"; import { FakeCommandServerApi, diff --git a/packages/lib-talonjs-core/src/ide/TalonJsClipboard.ts b/packages/lib-talonjs-core/src/ide/TalonJsClipboard.ts index 18308433bae..accc457d5da 100644 --- a/packages/lib-talonjs-core/src/ide/TalonJsClipboard.ts +++ b/packages/lib-talonjs-core/src/ide/TalonJsClipboard.ts @@ -4,11 +4,12 @@ import type { Talon } from "../types/talon"; export class TalonJsClipboard implements Clipboard { constructor(private talon: Talon) {} - async readText(): Promise { - return this.talon.actions.clip.text(); + readText(): Promise { + return Promise.resolve(this.talon.actions.clip.text()); } - async writeText(value: string): Promise { + writeText(value: string): Promise { this.talon.actions.clip.set_text(value); + return Promise.resolve(); } } diff --git a/packages/lib-talonjs-core/src/ide/TalonJsConfiguration.ts b/packages/lib-talonjs-core/src/ide/TalonJsConfiguration.ts index 1f4c52c2fae..1b18389862d 100644 --- a/packages/lib-talonjs-core/src/ide/TalonJsConfiguration.ts +++ b/packages/lib-talonjs-core/src/ide/TalonJsConfiguration.ts @@ -38,9 +38,10 @@ export class TalonJsConfiguration implements Configuration { } onDidChangeConfiguration(_listener: Listener): Disposable { - // Do nothing. For now the configuration can't change return { - dispose: () => {}, + dispose: () => { + // no-op. For now the configuration can't change + }, }; } } diff --git a/packages/lib-talonjs-core/src/ide/TalonJsIDE.ts b/packages/lib-talonjs-core/src/ide/TalonJsIDE.ts index 66e549771b1..d27cad365aa 100644 --- a/packages/lib-talonjs-core/src/ide/TalonJsIDE.ts +++ b/packages/lib-talonjs-core/src/ide/TalonJsIDE.ts @@ -105,13 +105,14 @@ export class TalonJsIDE implements EmittableIDE { this.editors = [editor]; } - async findInDocument(query: string, editor?: TextEditor): Promise { + findInDocument(query: string, editor?: TextEditor): Promise { if (editor != null) { throw new Error( "findInDocument not implemented for other than active editor.", ); } this.talon.actions.edit.find(query); + return Promise.resolve(); } findInWorkspace(_query: string): Promise { @@ -206,31 +207,31 @@ export class TalonJsIDE implements EmittableIDE { onDidOpenTextDocument( _listener: (document: TextDocument) => void, ): Disposable { - return { dispose: () => {} }; + return disposable; } onDidCloseTextDocument( _listener: (document: TextDocument) => void, ): Disposable { - return { dispose: () => {} }; + return disposable; } onDidChangeActiveTextEditor( _listener: (editor: TextEditor | undefined) => void, ): Disposable { - return { dispose: () => {} }; + return disposable; } onDidChangeVisibleTextEditors( _listener: (editors: TextEditor[]) => void, ): Disposable { - return { dispose: () => {} }; + return disposable; } onDidChangeTextEditorVisibleRanges( _listener: (event: TextEditorVisibleRangesChangeEvent) => void, ): Disposable { - return { dispose: () => {} }; + return disposable; } disposeOnExit(...disposables: Disposable[]): () => void { @@ -239,3 +240,9 @@ export class TalonJsIDE implements EmittableIDE { return () => pull(this.disposables, ...disposables); } } + +const disposable: Disposable = { + dispose: () => { + // No-op + }, +}; diff --git a/packages/lib-talonjs-core/src/ide/TalonJsKeyValueStore.ts b/packages/lib-talonjs-core/src/ide/TalonJsKeyValueStore.ts index 5f916e56624..f010b199e8d 100644 --- a/packages/lib-talonjs-core/src/ide/TalonJsKeyValueStore.ts +++ b/packages/lib-talonjs-core/src/ide/TalonJsKeyValueStore.ts @@ -9,7 +9,7 @@ export class TalonJsKeyValueStore implements KeyValueStore { throw new Error("state.get: not implemented."); } - async set( + set( _key: K, _value: KeyValueStoreData[K], ): Promise { diff --git a/packages/lib-talonjs-core/src/ide/TalonJsMessages.ts b/packages/lib-talonjs-core/src/ide/TalonJsMessages.ts index e15b975a323..63f3bfd4c9c 100644 --- a/packages/lib-talonjs-core/src/ide/TalonJsMessages.ts +++ b/packages/lib-talonjs-core/src/ide/TalonJsMessages.ts @@ -5,7 +5,7 @@ import type { Talon } from "../types/talon"; export class TalonJsMessages implements Messages { constructor(private talon: Talon) {} - async showMessage( + showMessage( type: MessageType, _id: string, message: string, @@ -23,7 +23,11 @@ export class TalonJsMessages implements Messages { break; case MessageType.error: this.talon.actions.app.notify(message, "[ERROR] Cursorless"); + break; + default: { + const _exhaustiveCheck: never = type; + } } - return undefined; + return Promise.resolve(undefined); } } diff --git a/packages/lib-talonjs-core/src/ide/TalonJsTestHats.ts b/packages/lib-talonjs-core/src/ide/TalonJsTestHats.ts index e92a9af2d22..fa8e901d40e 100644 --- a/packages/lib-talonjs-core/src/ide/TalonJsTestHats.ts +++ b/packages/lib-talonjs-core/src/ide/TalonJsTestHats.ts @@ -29,15 +29,24 @@ export class TalonJsTestHats implements Hats { ]), ); - async setHatRanges(hatRanges: HatRange[]): Promise { + setHatRanges(hatRanges: HatRange[]): Promise { this.hatRanges = hatRanges; + return Promise.resolve(); } onDidChangeEnabledHatStyles(_listener: Listener<[HatStyleMap]>): Disposable { - return { dispose: () => {} }; + return { + dispose: () => { + // no-op + }, + }; } onDidChangeIsEnabled(_listener: Listener<[boolean]>): Disposable { - return { dispose: () => {} }; + return { + dispose: () => { + // no-op + }, + }; } } diff --git a/packages/lib-talonjs-core/src/polyfill.ts b/packages/lib-talonjs-core/src/polyfill.ts index bf08b80819f..44aa6659d78 100644 --- a/packages/lib-talonjs-core/src/polyfill.ts +++ b/packages/lib-talonjs-core/src/polyfill.ts @@ -34,3 +34,6 @@ if (global.setTimeout == null) { // no-op }; } + +// oxlint-disable-next-line unicorn/require-module-specifiers +export {}; diff --git a/packages/lib-test-case-recorder/src/ScopeTestRecorder.ts b/packages/lib-test-case-recorder/src/ScopeTestRecorder.ts index a66e07fd460..e34243e89af 100644 --- a/packages/lib-test-case-recorder/src/ScopeTestRecorder.ts +++ b/packages/lib-test-case-recorder/src/ScopeTestRecorder.ts @@ -7,9 +7,8 @@ import { languageScopeSupport, scopeSupportFacetInfos, showInfo, - type IDE, - type ScopeSupportFacet, } from "@cursorless/lib-common"; +import type { IDE, ScopeSupportFacet } from "@cursorless/lib-common"; import { getScopeTestPathsRecursively, getScopeTestsDirPath, @@ -103,7 +102,7 @@ export class ScopeTestRecorder { filePath = path.join(directory, `${facet}${i++}.scope`); } - await fsPromises.writeFile(filePath, fullContent, "utf-8"); + await fsPromises.writeFile(filePath, fullContent, "utf8"); } await showInfo( diff --git a/packages/lib-test-case-recorder/src/TestCase.ts b/packages/lib-test-case-recorder/src/TestCase.ts index 360af8d9d55..8cc38efe728 100644 --- a/packages/lib-test-case-recorder/src/TestCase.ts +++ b/packages/lib-test-case-recorder/src/TestCase.ts @@ -27,8 +27,8 @@ import { import { extractTargetKeys, getPartialTargetDescriptors, - type StoredTargetMap, } from "@cursorless/lib-engine"; +import type { StoredTargetMap } from "@cursorless/lib-engine"; import { takeSnapshot } from "./takeSnapshot"; export class TestCase { @@ -51,8 +51,8 @@ export class TestCase { private hatTokenMap: ReadOnlyHatMap, private storedTargets: StoredTargetMap, private spyIde: SpyIDE, - private isHatTokenMapTest: boolean = false, - private isDecorationsTest: boolean = false, + private isHatTokenMapTest: boolean, + private isDecorationsTest: boolean, private startTimestamp: bigint, private captureFinalThatMark: boolean, private extraSnapshotFields?: ExtraSnapshotField[], @@ -61,9 +61,7 @@ export class TestCase { const activeEditor = this.spyIde.activeTextEditor!; this.command = command; this.partialTargetDescriptors = getPartialTargetDescriptors(command.action); - this.targetKeys = this.partialTargetDescriptors - .map(extractTargetKeys) - .flat(); + this.targetKeys = this.partialTargetDescriptors.flatMap(extractTargetKeys); this.languageId = activeEditor.document.languageId; this._awaitingFinalMarkInfo = isHatTokenMapTest; } @@ -204,9 +202,8 @@ export class TestCase { } filterMarks() { - const marksToCheck = this.partialTargetDescriptors - .map(extractTargetKeys) - .flat(); + const marksToCheck = + this.partialTargetDescriptors.flatMap(extractTargetKeys); const keys = this.targetKeys.concat(marksToCheck); this.initialState!.marks = pick( diff --git a/packages/lib-test-case-recorder/src/TestCaseRecorder.ts b/packages/lib-test-case-recorder/src/TestCaseRecorder.ts index 8f6963036d7..b97d416bbcb 100644 --- a/packages/lib-test-case-recorder/src/TestCaseRecorder.ts +++ b/packages/lib-test-case-recorder/src/TestCaseRecorder.ts @@ -36,6 +36,7 @@ import { } from "@cursorless/lib-engine"; import { getRecordedTestsDirPath, + isEnoentError, walkDirsSync, } from "@cursorless/lib-node-common"; import type { RecordTestCaseCommandOptions } from "./RecordTestCaseCommandOptions"; @@ -111,7 +112,7 @@ export class TestCaseRecorder { } } - async pause() { + pause() { if (!this.active) { throw new Error("Asked to pause recording, but no recording active"); } @@ -119,7 +120,7 @@ export class TestCaseRecorder { this.paused = true; } - async resume() { + resume() { if (!this.active) { throw new Error("Asked to resume recording, but no recording active"); } @@ -134,7 +135,7 @@ export class TestCaseRecorder { usePrePhraseSnapshot: boolean, ) { let marks: SerializedMarks | undefined; - if (targetedMarks.length !== 0) { + if (targetedMarks.length > 0) { const keys = targetedMarks.map(({ character, symbolColor }) => getKey(symbolColor, character), ); @@ -156,7 +157,7 @@ export class TestCaseRecorder { metadata, ); - await this.writeToFile(outPath, serialize(snapshot)); + this.writeToFile(outPath, serialize(snapshot)); } isActive() { @@ -359,10 +360,10 @@ export class TestCaseRecorder { await this.finishTestCase(); } - async finishTestCase(): Promise { + finishTestCase(): void { const outPath = this.calculateFilePath(this.testCase!); const fixture = this.testCase!.toYaml(); - await this.writeToFile(outPath, fixture); + this.writeToFile(outPath, fixture); if (!this.isSilent) { let message = `"${ @@ -373,13 +374,14 @@ export class TestCaseRecorder { message += ` Spoken form error: ${this.testCase!.spokenFormError}`; } - void showInfo( - this.ide.messages, - "testCaseSaved", - message, - "View", - "Delete", - ).then(async (action) => { + void (async () => { + const action = await showInfo( + this.ide.messages, + "testCaseSaved", + message, + "View", + "Delete", + ); if (action === "View") { await this.ide.openTextDocument(outPath); } @@ -387,11 +389,11 @@ export class TestCaseRecorder { try { await unlink(outPath); console.log(`deleted ${outPath}`); - } catch (err) { - console.log(`failed to delete ${outPath}: ${err}`); + } catch (error) { + console.warn(`failed to delete ${outPath}: ${error}`); } } - }); + })(); } this.testCase = null; @@ -401,17 +403,17 @@ export class TestCaseRecorder { } } - private async writeToFile(outPath: string, fixture: string) { - fs.writeFileSync(outPath, fixture); + private writeToFile(outPath: string, fixture: string) { + fs.writeFileSync(outPath, fixture, { encoding: "utf8" }); } private async promptSubdirectory(): Promise { try { if (this.fixtureRoot == null) { - throw new Error(); + throw new Error("Missing fixture root"); } await access(this.fixtureRoot); - } catch (e) { + } catch (error) { const errorMessage = '"Cursorless record" must be run from within cursorless directory'; void showError( @@ -419,7 +421,7 @@ export class TestCaseRecorder { "promptSubdirectoryError", errorMessage, ); - throw new Error(errorMessage, { cause: e }); + throw new Error(errorMessage, { cause: error }); } const subdirectorySelection = await this.ide.showQuickPick( @@ -457,9 +459,10 @@ export class TestCaseRecorder { return filePath; } - async commandErrorHook(error: Error) { + async commandErrorHook(error: unknown) { if (this.isErrorTest && this.testCase) { - this.testCase.thrownError = { name: error.name }; + const errorName = error instanceof Error ? error.name : "unknown"; + this.testCase.thrownError = { name: errorName }; await this.finishTestCase(); } else { this.testCase = null; @@ -495,9 +498,9 @@ export class TestCaseRecorder { await this.postCommandHook(returnValue); return returnValue; - } catch (e) { - await this.commandErrorHook(e as Error); - throw e; + } catch (error) { + await this.commandErrorHook(error); + throw error; } finally { this.finallyHook(); } @@ -519,13 +522,13 @@ async function readJsonIfExists( let rawText: string; try { - rawText = await readFile(path, { encoding: "utf-8" }); - } catch (err) { - if ((err as NodeJS.ErrnoException).code === "ENOENT") { + rawText = await readFile(path, { encoding: "utf8" }); + } catch (error) { + if (isEnoentError(error)) { return {}; } - throw err; + throw error; } return JSON.parse(rawText); diff --git a/packages/lib-test-case-recorder/src/takeSnapshot.ts b/packages/lib-test-case-recorder/src/takeSnapshot.ts index 729ff634b33..ea928af60b1 100644 --- a/packages/lib-test-case-recorder/src/takeSnapshot.ts +++ b/packages/lib-test-case-recorder/src/takeSnapshot.ts @@ -17,8 +17,8 @@ import { hrtimeBigintToSeconds } from "./timeUtils"; export async function takeSnapshot( storedTargets: StoredTargetMap | undefined, - excludeFields: ExcludableSnapshotField[] = [], - extraFields: ExtraSnapshotField[] = [], + excludeFields: ExcludableSnapshotField[] | undefined, + extraFields: ExtraSnapshotField[] | undefined, editor: TextEditor, ide: IDE, marks?: SerializedMarks, @@ -38,23 +38,25 @@ export async function takeSnapshot( snapshot.metadata = metadata; } - if (!excludeFields.includes("clipboard")) { + if (!excludeFields?.includes("clipboard")) { snapshot.clipboard = await ide.clipboard.readText(); } - if (!excludeFields.includes("visibleRanges")) { + if (!excludeFields?.includes("visibleRanges")) { snapshot.visibleRanges = editor.visibleRanges.map(rangeToPlainObject); } - for (const storedTargetKey of storedTargetKeys) { - const targets = storedTargets?.get(storedTargetKey); - const key = `${storedTargetKey}Mark` as const; - if (targets != null && !excludeFields.includes(key)) { - snapshot[key] = targets.map((target) => target.toPlainObject()); + if (storedTargets != null) { + for (const storedTargetKey of storedTargetKeys) { + const targets = storedTargets.get(storedTargetKey); + const key = `${storedTargetKey}Mark` as const; + if (targets != null && !excludeFields?.includes(key)) { + snapshot[key] = targets.map((target) => target.toPlainObject()); + } } } - if (extraFields.includes("timeOffsetSeconds")) { + if (extraFields?.includes("timeOffsetSeconds")) { const startTimestamp = extraContext?.startTimestamp; if (startTimestamp == null) { diff --git a/packages/lib-test-case-recorder/src/timeUtils.ts b/packages/lib-test-case-recorder/src/timeUtils.ts index c0a5a555ca0..d60186a7e4d 100644 --- a/packages/lib-test-case-recorder/src/timeUtils.ts +++ b/packages/lib-test-case-recorder/src/timeUtils.ts @@ -1,8 +1,8 @@ -const nanosecondsPerSecond = BigInt(1000000000); +const nanosecondsPerSecond = 1_000_000_000n; export function hrtimeBigintToSeconds( nanoseconds: bigint, - precision: bigint = BigInt(1000000), + precision: bigint = 1_000_000n, ) { return ( Number((nanoseconds * precision) / nanosecondsPerSecond) / Number(precision) diff --git a/packages/lib-tutorial/src/TutorialError.ts b/packages/lib-tutorial/src/TutorialError.ts index a7042bc0117..1d2702fdaa8 100644 --- a/packages/lib-tutorial/src/TutorialError.ts +++ b/packages/lib-tutorial/src/TutorialError.ts @@ -7,6 +7,7 @@ export class TutorialError extends Error { ) { super(message); + this.name = "TutorialError"; this.requiresTalonUpdate = requiresTalonUpdate; } } diff --git a/packages/lib-tutorial/src/TutorialImpl.ts b/packages/lib-tutorial/src/TutorialImpl.ts index a62cbcee860..dcdafa5bf2c 100644 --- a/packages/lib-tutorial/src/TutorialImpl.ts +++ b/packages/lib-tutorial/src/TutorialImpl.ts @@ -73,11 +73,12 @@ export class TutorialImpl implements Tutorial, CommandRunnerDecorator { const debouncer = new Debouncer(() => this.checkPreconditions(), 100); const runDebouncer = () => debouncer.run(); - void this.loadTutorials().then(async () => { + void (async () => { + await this.loadTutorials(); if (this.state_.type === "loading") { this.setState(this.getPickingTutorialState()); } - }); + })(); this.disposables.push( this.ide.onDidChangeActiveTextEditor(runDebouncer), diff --git a/packages/lib-tutorial/src/TutorialStepParser.ts b/packages/lib-tutorial/src/TutorialStepParser.ts index bd0e7455675..3e2a9990978 100644 --- a/packages/lib-tutorial/src/TutorialStepParser.ts +++ b/packages/lib-tutorial/src/TutorialStepParser.ts @@ -59,29 +59,33 @@ export class TutorialStepParser { this.componentParsers = { command: (arg) => cursorlessCommandParser.parse(arg), - special: parseSpecialComponent, + special: (arg) => Promise.resolve(parseSpecialComponent(arg)), action: (arg) => actionParser.parse(arg), grapheme: (arg) => graphemeParser.parse(arg), - term: async (arg) => ({ - content: { - type: "term", - value: specialTerms[arg as keyof typeof specialTerms], - }, - }), - - scopeType: async (arg) => ({ - content: { - type: "term", - value: getScopeTypeSpokenFormStrict( - customSpokenFormGenerator, - parseScopeType(arg), - ), - }, - }), + term: (arg) => + Promise.resolve({ + content: { + type: "term", + value: specialTerms[arg as keyof typeof specialTerms], + }, + }), + + scopeType: (arg) => + Promise.resolve({ + content: { + type: "term", + value: getScopeTypeSpokenFormStrict( + customSpokenFormGenerator, + parseScopeType(arg), + ), + }, + }), visualize: (arg) => - parseVisualizeComponent(customSpokenFormGenerator, arg), + Promise.resolve( + parseVisualizeComponent(customSpokenFormGenerator, arg), + ), }; } diff --git a/packages/lib-tutorial/src/loadTutorial.ts b/packages/lib-tutorial/src/loadTutorial.ts index ff3445218b3..0893556aeb0 100644 --- a/packages/lib-tutorial/src/loadTutorial.ts +++ b/packages/lib-tutorial/src/loadTutorial.ts @@ -53,7 +53,7 @@ export async function loadTutorial( title: tutorialContent.title, preConditionsMet: true, }; - } catch (err) { + } catch (error) { tutorialContent = { title: rawContent.title, steps: [], @@ -67,7 +67,7 @@ export async function loadTutorial( title: tutorialContent.title, preConditionsMet: true, requiresTalonUpdate: - err instanceof TutorialError && err.requiresTalonUpdate, + error instanceof TutorialError && error.requiresTalonUpdate, }; } diff --git a/packages/lib-tutorial/src/setupStep.ts b/packages/lib-tutorial/src/setupStep.ts index 104487020ac..42b00328859 100644 --- a/packages/lib-tutorial/src/setupStep.ts +++ b/packages/lib-tutorial/src/setupStep.ts @@ -106,7 +106,7 @@ async function applySnapshot( toCharacterRange(plainObjectToRange(range)), ), }; - } catch (err) { + } catch (error) { if (retry) { return await applySnapshot( ide, @@ -115,8 +115,7 @@ async function applySnapshot( snapshot, languageId, ); - } else { - throw err; } + throw error; } } diff --git a/packages/lib-tutorial/src/stepComponentParsers/ActionComponentParser.ts b/packages/lib-tutorial/src/stepComponentParsers/ActionComponentParser.ts index b7048703ab1..a4af6b75761 100644 --- a/packages/lib-tutorial/src/stepComponentParsers/ActionComponentParser.ts +++ b/packages/lib-tutorial/src/stepComponentParsers/ActionComponentParser.ts @@ -23,13 +23,13 @@ export class ActionComponentParser implements StepComponentParser { } } - async parse(arg: string): Promise { - return { + parse(arg: string): Promise { + return Promise.resolve({ content: { type: "term", value: this.getActionSpokenForm(this.parseActionName(arg)), }, - }; + }); } private getActionSpokenForm(actionId: ActionType) { diff --git a/packages/lib-tutorial/src/stepComponentParsers/CursorlessCommandComponentParser.ts b/packages/lib-tutorial/src/stepComponentParsers/CursorlessCommandComponentParser.ts index fae36e3eda2..ef7ad5631c3 100644 --- a/packages/lib-tutorial/src/stepComponentParsers/CursorlessCommandComponentParser.ts +++ b/packages/lib-tutorial/src/stepComponentParsers/CursorlessCommandComponentParser.ts @@ -1,5 +1,5 @@ import { produce } from "immer"; -import { cloneDeep, mapKeys } from "lodash-es"; +import { mapKeys } from "lodash-es"; import type { CommandComplete, CommandLatest, @@ -93,7 +93,7 @@ function substituteMissingHats( command: CommandLatest, initialState: TestCaseSnapshot, ) { - command = cloneDeep(command); + command = structuredClone(command); // Update the hats in the command transformPartialPrimitiveTargets( diff --git a/packages/lib-tutorial/src/stepComponentParsers/GraphemeComponentParser.ts b/packages/lib-tutorial/src/stepComponentParsers/GraphemeComponentParser.ts index 191762c83a7..4331a992f64 100644 --- a/packages/lib-tutorial/src/stepComponentParsers/GraphemeComponentParser.ts +++ b/packages/lib-tutorial/src/stepComponentParsers/GraphemeComponentParser.ts @@ -12,13 +12,13 @@ import type { export class GraphemeComponentParser implements StepComponentParser { constructor(private customSpokenFormGenerator: CustomSpokenFormGenerator) {} - async parse(arg: string): Promise { - return { + parse(arg: string): Promise { + return Promise.resolve({ content: { type: "term", value: this.getGraphemeSpokenForm(arg), }, - }; + }); } private getGraphemeSpokenForm(grapheme: string) { diff --git a/packages/lib-tutorial/src/stepComponentParsers/parseSpecialComponent.ts b/packages/lib-tutorial/src/stepComponentParsers/parseSpecialComponent.ts index e030e39fb70..fb063c70f4d 100644 --- a/packages/lib-tutorial/src/stepComponentParsers/parseSpecialComponent.ts +++ b/packages/lib-tutorial/src/stepComponentParsers/parseSpecialComponent.ts @@ -11,9 +11,7 @@ const SPECIAL_COMMANDS = { * Parses components of the form `{special:help}`. These are special commands * that don't correspond to any cursorless command. */ -export async function parseSpecialComponent( - arg: string, -): Promise { +export function parseSpecialComponent(arg: string): StepComponent { let trigger: TutorialStepTrigger | undefined = undefined; switch (arg) { @@ -28,6 +26,7 @@ export async function parseSpecialComponent( scopeType: undefined, }; break; + // No default } return { diff --git a/packages/lib-tutorial/src/stepComponentParsers/parseVisualizeComponent.ts b/packages/lib-tutorial/src/stepComponentParsers/parseVisualizeComponent.ts index 647ad1172a9..ac711f1dadd 100644 --- a/packages/lib-tutorial/src/stepComponentParsers/parseVisualizeComponent.ts +++ b/packages/lib-tutorial/src/stepComponentParsers/parseVisualizeComponent.ts @@ -9,10 +9,10 @@ import type { StepComponent } from "../types/StepComponent"; * visualizing a scope type and causes the step to automatically advance when * the user visualizes the scope type. */ -export async function parseVisualizeComponent( +export function parseVisualizeComponent( customSpokenFormGenerator: CustomSpokenFormGenerator, arg: string, -): Promise { +): StepComponent { const scopeType = parseScopeType(arg); return { diff --git a/packages/lib-vscode-common/src/getExtensionApi.ts b/packages/lib-vscode-common/src/getExtensionApi.ts index 5813c41d153..641cb03d28a 100644 --- a/packages/lib-vscode-common/src/getExtensionApi.ts +++ b/packages/lib-vscode-common/src/getExtensionApi.ts @@ -3,9 +3,8 @@ import type { Query, Tree } from "web-tree-sitter"; import type { CommandServerApi } from "@cursorless/lib-common"; import type { VscodeTestHelpers } from "./TestHelpers"; -export interface CursorlessApi { - testHelpers: VscodeTestHelpers | undefined; -} +export const COMMAND_SERVER_EXTENSION_ID = "pokey.command-server"; +const EXTENSION_ID = "pokey.cursorless"; export interface ParseTreeApi { loadLanguage(languageId: string): Promise; @@ -13,34 +12,52 @@ export interface ParseTreeApi { createQuery(languageId: string, source: string): Query | undefined; } -export async function getExtensionApi(extensionId: string) { +export interface CursorlessApi { + testHelpers: VscodeTestHelpers | undefined; +} + +async function getExtensionApi(extensionId: string): Promise { const extension = vscode.extensions.getExtension(extensionId); - return extension == null ? undefined : ((await extension.activate()) as T); + if (extension == null) { + return undefined; + } + + return (await extension.activate()) as T; } -export async function getExtensionApiStrict(extensionId: string) { - const extension = vscode.extensions.getExtension(extensionId); +async function getExtensionApiStrict(extensionId: string): Promise { + const extension = await getExtensionApi(extensionId); if (extension == null) { throw new Error(`Could not get ${extensionId} extension`); } - return (await extension.activate()) as T; + return extension; } -export const EXTENSION_ID = "pokey.cursorless"; -export const COMMAND_SERVER_EXTENSION_ID = "pokey.command-server"; +export function getParseTreeApi(): Promise { + return getExtensionApiStrict("pokey.parse-tree"); +} -export const getCursorlessApi = () => - getExtensionApiStrict(EXTENSION_ID); +function getCursorlessApi(): Promise { + return getExtensionApiStrict(EXTENSION_ID); +} -export const getParseTreeApi = () => - getExtensionApiStrict("pokey.parse-tree"); +export async function getTestHelpers(): Promise { + const cursorlessApi = await getCursorlessApi(); + + if (cursorlessApi.testHelpers == null) { + throw new Error("Test helpers are not available"); + } + + return cursorlessApi.testHelpers; +} /** * - * @returns Command server API or null if not installed + * @returns Command server API or undefined if not installed */ -export const getCommandServerApi = () => - getExtensionApi(COMMAND_SERVER_EXTENSION_ID); +export function getCommandServerApi(): Promise { + return getExtensionApi(COMMAND_SERVER_EXTENSION_ID); +} diff --git a/packages/lib-vscode-common/src/runCommand.ts b/packages/lib-vscode-common/src/runCommand.ts index e7b298889f3..67320116feb 100644 --- a/packages/lib-vscode-common/src/runCommand.ts +++ b/packages/lib-vscode-common/src/runCommand.ts @@ -13,7 +13,9 @@ export async function runCursorlessCommand( return await vscode.commands.executeCommand(CURSORLESS_COMMAND_ID, command); } -export async function runCursorlessAction(action: ActionDescriptor) { +export function runCursorlessAction( + action: ActionDescriptor, +): Promise { return runCursorlessCommand({ version: LATEST_VERSION, usePrePhraseSnapshot: false, diff --git a/packages/lib-vscode-common/src/testUtil/getReusableEditor.ts b/packages/lib-vscode-common/src/testUtil/getReusableEditor.ts index 53acb1376e0..f61074c1a4f 100644 --- a/packages/lib-vscode-common/src/testUtil/getReusableEditor.ts +++ b/packages/lib-vscode-common/src/testUtil/getReusableEditor.ts @@ -1,5 +1,6 @@ -import { EndOfLine, Range, window, type TextEditor } from "vscode"; -import { getCursorlessApi } from "../getExtensionApi"; +import type { TextEditor } from "vscode"; +import { EndOfLine, Range, window } from "vscode"; +import { getTestHelpers } from "../getExtensionApi"; import { closeUiElements } from "./closeUiElements"; import { openNewEditor } from "./openNewEditor"; @@ -20,7 +21,9 @@ export async function getReusableEditor( } await closeUiElements(); - (await getCursorlessApi()).testHelpers!.clearCache(); + + const { clearCache } = await getTestHelpers(); + clearCache(); // Replace the entire contents of the editor with the new content await editor.edit((editBuilder) => { diff --git a/packages/lib-vscode-common/src/testUtil/openNewEditor.ts b/packages/lib-vscode-common/src/testUtil/openNewEditor.ts index 904b53990dc..718f2cf48b2 100644 --- a/packages/lib-vscode-common/src/testUtil/openNewEditor.ts +++ b/packages/lib-vscode-common/src/testUtil/openNewEditor.ts @@ -1,5 +1,5 @@ import * as vscode from "vscode"; -import { getCursorlessApi } from "../getExtensionApi"; +import { getTestHelpers } from "../getExtensionApi"; import { closeUiElements } from "./closeUiElements"; export async function openNewEditor( @@ -18,8 +18,10 @@ export async function openNewEditor( content, }); - (await getCursorlessApi()).testHelpers!.clearCache(); - await (await getCursorlessApi()).testHelpers!.loadLanguage(languageId); + const { clearCache, loadLanguage } = await getTestHelpers(); + + clearCache(); + await loadLanguage(languageId); const editor = await vscode.window.showTextDocument( document, @@ -63,8 +65,9 @@ export async function openNewNotebookEditor( ), ); - (await getCursorlessApi()).testHelpers!.clearCache(); - await (await getCursorlessApi()).testHelpers!.loadLanguage(languageId); + const { clearCache, loadLanguage } = await getTestHelpers(); + clearCache(); + await loadLanguage(languageId); // FIXME: There seems to be some timing issue when you create a notebook // editor @@ -84,7 +87,7 @@ function waitForEditorToOpen(): Promise { count++; if (count === 20) { clearInterval(interval); - reject("Timed out waiting for editor to open"); + reject(new Error("Timed out waiting for editor to open")); } } }, 100); diff --git a/packages/lib-vscode-tutorial-webview/src/App.tsx b/packages/lib-vscode-tutorial-webview/src/App.tsx index 9b987bb9795..38ea95bd491 100644 --- a/packages/lib-vscode-tutorial-webview/src/App.tsx +++ b/packages/lib-vscode-tutorial-webview/src/App.tsx @@ -40,6 +40,7 @@ export function App({ vscode }: Props) { {state.tutorials.map((tutorial) => (