From 2e69df8b9b8852a1df6cba5a6b5b7a73d82d6c63 Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Tue, 9 Jul 2024 22:25:41 +0200 Subject: [PATCH 1/5] Pass snippets as argument to engine --- .../cursorless-engine/src/actions/Actions.ts | 2 +- .../src/actions/InsertSnippet.ts | 10 +- .../src/actions/WrapWithSnippet.ts | 10 +- .../src/api/CursorlessEngineApi.ts | 2 - .../cursorless-engine/src/core/Snippets.ts | 221 +--------------- .../cursorless-engine/src/cursorlessEngine.ts | 11 +- packages/cursorless-engine/src/index.ts | 3 + packages/cursorless-engine/src/runCommand.ts | 7 +- .../cursorless-vscode/src/VscodeSnippets.ts | 249 ++++++++++++++++++ packages/cursorless-vscode/src/extension.ts | 6 +- 10 files changed, 288 insertions(+), 233 deletions(-) create mode 100644 packages/cursorless-vscode/src/VscodeSnippets.ts diff --git a/packages/cursorless-engine/src/actions/Actions.ts b/packages/cursorless-engine/src/actions/Actions.ts index 15d2e0f3b6..b801635bbe 100644 --- a/packages/cursorless-engine/src/actions/Actions.ts +++ b/packages/cursorless-engine/src/actions/Actions.ts @@ -69,7 +69,7 @@ import { Decrement, Increment } from "./incrementDecrement"; export class Actions implements ActionRecord { constructor( private treeSitter: TreeSitter, - private snippets: Snippets, + private snippets: Snippets | undefined, private rangeUpdater: RangeUpdater, private modifierStageFactory: ModifierStageFactory, ) {} diff --git a/packages/cursorless-engine/src/actions/InsertSnippet.ts b/packages/cursorless-engine/src/actions/InsertSnippet.ts index 0ae8701c9c..b9be30b927 100644 --- a/packages/cursorless-engine/src/actions/InsertSnippet.ts +++ b/packages/cursorless-engine/src/actions/InsertSnippet.ts @@ -31,7 +31,7 @@ export default class InsertSnippet { constructor( private rangeUpdater: RangeUpdater, - private snippets: Snippets, + private snippets: Snippets | undefined, private actions: Actions, private modifierStageFactory: ModifierStageFactory, ) { @@ -56,6 +56,10 @@ export default class InsertSnippet { private getScopeTypes(snippetDescription: InsertSnippetArg): ScopeType[] { if (snippetDescription.type === "named") { + if (this.snippets == null) { + return []; + } + const { name } = snippetDescription; const snippet = this.snippets.getSnippetStrict(name); @@ -76,6 +80,10 @@ export default class InsertSnippet { targets: Target[], ) { if (snippetDescription.type === "named") { + if (this.snippets == null) { + throw Error("Named snippets are not enabled"); + } + const { name } = snippetDescription; const snippet = this.snippets.getSnippetStrict(name); diff --git a/packages/cursorless-engine/src/actions/WrapWithSnippet.ts b/packages/cursorless-engine/src/actions/WrapWithSnippet.ts index 56ca6942ae..c75cc0b730 100644 --- a/packages/cursorless-engine/src/actions/WrapWithSnippet.ts +++ b/packages/cursorless-engine/src/actions/WrapWithSnippet.ts @@ -19,7 +19,7 @@ export default class WrapWithSnippet { constructor( private rangeUpdater: RangeUpdater, - private snippets: Snippets, + private snippets: Snippets | undefined, private modifierStageFactory: ModifierStageFactory, ) { this.run = this.run.bind(this); @@ -47,6 +47,10 @@ export default class WrapWithSnippet { snippetDescription: WrapWithSnippetArg, ): ScopeType | undefined { if (snippetDescription.type === "named") { + if (this.snippets == null) { + return undefined; + } + const { name, variableName } = snippetDescription; const snippet = this.snippets.getSnippetStrict(name); @@ -68,6 +72,10 @@ export default class WrapWithSnippet { targets: Target[], ): string { if (snippetDescription.type === "named") { + if (this.snippets == null) { + throw Error("Named snippets are not enabled"); + } + const { name } = snippetDescription; const snippet = this.snippets.getSnippetStrict(name); diff --git a/packages/cursorless-engine/src/api/CursorlessEngineApi.ts b/packages/cursorless-engine/src/api/CursorlessEngineApi.ts index f076bd52d6..1c17cf2661 100644 --- a/packages/cursorless-engine/src/api/CursorlessEngineApi.ts +++ b/packages/cursorless-engine/src/api/CursorlessEngineApi.ts @@ -7,7 +7,6 @@ import type { ScopeProvider, } from "@cursorless/common"; import type { CommandRunner } from "../CommandRunner"; -import type { Snippets } from "../core/Snippets"; import type { StoredTargetMap } from "../core/StoredTargets"; export interface CursorlessEngine { @@ -16,7 +15,6 @@ export interface CursorlessEngine { customSpokenFormGenerator: CustomSpokenFormGenerator; storedTargets: StoredTargetMap; hatTokenMap: HatTokenMap; - snippets: Snippets; injectIde: (ide: IDE | undefined) => void; runIntegrationTests: () => Promise; addCommandRunnerDecorator: ( diff --git a/packages/cursorless-engine/src/core/Snippets.ts b/packages/cursorless-engine/src/core/Snippets.ts index 373bdccf2f..872ab603d3 100644 --- a/packages/cursorless-engine/src/core/Snippets.ts +++ b/packages/cursorless-engine/src/core/Snippets.ts @@ -1,190 +1,12 @@ -import { showError, Snippet, SnippetMap, walkFiles } from "@cursorless/common"; -import { readFile, stat } from "fs/promises"; -import { max } from "lodash"; -import { join } from "path"; -import { ide } from "../singletons/ide.singleton"; -import { mergeStrict } from "../util/object"; -import { mergeSnippets } from "./mergeSnippets"; - -const CURSORLESS_SNIPPETS_SUFFIX = ".cursorless-snippets"; -const SNIPPET_DIR_REFRESH_INTERVAL_MS = 1000; - -interface DirectoryErrorMessage { - directory: string; - errorMessage: string; -} +import { Snippet, SnippetMap } from "@cursorless/common"; /** * Handles all cursorless snippets, including core, third-party and * user-defined. Merges these collections and allows looking up snippets by * name. */ -export class Snippets { - private coreSnippets!: SnippetMap; - private thirdPartySnippets: Record = {}; - private userSnippets!: SnippetMap[]; - - private mergedSnippets!: SnippetMap; - - private userSnippetsDir?: string; - - /** - * The maximum modification time of any snippet in user snippets dir. - * - * This variable will be set to -1 if no user snippets have yet been read or - * if the user snippets path has changed. - * - * This variable will be set to 0 if the user has no snippets dir configured and - * we've already set userSnippets to {}. - */ - private maxSnippetMtimeMs: number = -1; - - /** - * If the user has misconfigured their snippet dir, then we keep track of it - * so that we can show them the error message if we can't find a snippet - * later, and so that we don't show them the same error message every time - * we try to poll the directory. - */ - private directoryErrorMessage: DirectoryErrorMessage | null | undefined = - null; - - constructor() { - this.updateUserSnippetsPath(); - - this.updateUserSnippets = this.updateUserSnippets.bind(this); - this.registerThirdPartySnippets = - this.registerThirdPartySnippets.bind(this); - - const timer = setInterval( - this.updateUserSnippets, - SNIPPET_DIR_REFRESH_INTERVAL_MS, - ); - - ide().disposeOnExit( - ide().configuration.onDidChangeConfiguration(() => { - if (this.updateUserSnippetsPath()) { - this.updateUserSnippets(); - } - }), - { - dispose() { - clearInterval(timer); - }, - }, - ); - } - - async init() { - const extensionPath = ide().assetsRoot; - const snippetsDir = join(extensionPath, "cursorless-snippets"); - const snippetFiles = await getSnippetPaths(snippetsDir); - this.coreSnippets = mergeStrict( - ...(await Promise.all( - snippetFiles.map(async (path) => - JSON.parse(await readFile(path, "utf8")), - ), - )), - ); - await this.updateUserSnippets(); - } - - /** - * Updates the userSnippetsDir field if it has change, returning a boolean - * indicating whether there was an update. If there was an update, resets the - * maxSnippetMtime to -1 to ensure snippet update. - * @returns Boolean indicating whether path has changed - */ - private updateUserSnippetsPath(): boolean { - const newUserSnippetsDir = ide().configuration.getOwnConfiguration( - "experimental.snippetsDir", - ); - - if (newUserSnippetsDir === this.userSnippetsDir) { - return false; - } - - // Reset mtime to -1 so that next time we'll update the snippets - this.maxSnippetMtimeMs = -1; - - this.userSnippetsDir = newUserSnippetsDir; - - return true; - } - - async updateUserSnippets() { - let snippetFiles: string[]; - try { - snippetFiles = this.userSnippetsDir - ? await getSnippetPaths(this.userSnippetsDir) - : []; - } catch (err) { - if (this.directoryErrorMessage?.directory !== this.userSnippetsDir) { - // NB: We suppress error messages once we've shown it the first time - // because we poll the directory every second and want to make sure we - // don't show the same error message repeatedly - const errorMessage = `Error with cursorless snippets dir "${ - this.userSnippetsDir - }": ${(err as Error).message}`; - - showError(ide().messages, "snippetsDirError", errorMessage); - - this.directoryErrorMessage = { - directory: this.userSnippetsDir!, - errorMessage, - }; - } - - this.userSnippets = []; - this.mergeSnippets(); - - return; - } - - this.directoryErrorMessage = null; - - const maxSnippetMtime = - max( - (await Promise.all(snippetFiles.map((file) => stat(file)))).map( - (stat) => stat.mtimeMs, - ), - ) ?? 0; - - if (maxSnippetMtime <= this.maxSnippetMtimeMs) { - return; - } - - this.maxSnippetMtimeMs = maxSnippetMtime; - - this.userSnippets = await Promise.all( - snippetFiles.map(async (path) => { - try { - const content = await readFile(path, "utf8"); - - if (content.length === 0) { - // Gracefully handle an empty file - return {}; - } - - return JSON.parse(content); - } catch (err) { - showError( - ide().messages, - "snippetsFileError", - `Error with cursorless snippets file "${path}": ${ - (err as Error).message - }`, - ); - - // We don't want snippets from all files to stop working if there is - // a parse error in one file, so we just effectively ignore this file - // once we've shown an error message - return {}; - } - }), - ); - - this.mergeSnippets(); - } +export interface Snippets { + updateUserSnippets(): Promise; /** * Allows extensions to register third-party snippets. Calling this function @@ -195,22 +17,7 @@ export class Snippets { * @param extensionId The id of the extension registering the snippets. * @param snippets The snippets to be registered. */ - registerThirdPartySnippets(extensionId: string, snippets: SnippetMap) { - this.thirdPartySnippets[extensionId] = snippets; - this.mergeSnippets(); - } - - /** - * Merge core, third-party, and user snippets, with precedence user > third - * party > core. - */ - private mergeSnippets() { - this.mergedSnippets = mergeSnippets( - this.coreSnippets, - this.thirdPartySnippets, - this.userSnippets, - ); - } + registerThirdPartySnippets(extensionId: string, snippets: SnippetMap): void; /** * Looks in merged collection of snippets for a snippet with key @@ -219,23 +26,5 @@ export class Snippets { * @param snippetName The name of the snippet to look up * @returns The named snippet */ - getSnippetStrict(snippetName: string): Snippet { - const snippet = this.mergedSnippets[snippetName]; - - if (snippet == null) { - let errorMessage = `Couldn't find snippet ${snippetName}. `; - - if (this.directoryErrorMessage != null) { - errorMessage += `This could be due to: ${this.directoryErrorMessage.errorMessage}.`; - } - - throw Error(errorMessage); - } - - return snippet; - } -} - -function getSnippetPaths(snippetsDir: string) { - return walkFiles(snippetsDir, CURSORLESS_SNIPPETS_SUFFIX); + getSnippetStrict(snippetName: string): Snippet; } diff --git a/packages/cursorless-engine/src/cursorlessEngine.ts b/packages/cursorless-engine/src/cursorlessEngine.ts index 0b4eafb33f..ba65104785 100644 --- a/packages/cursorless-engine/src/cursorlessEngine.ts +++ b/packages/cursorless-engine/src/cursorlessEngine.ts @@ -1,10 +1,10 @@ import { Command, CommandServerApi, + ensureCommandShape, FileSystem, Hats, IDE, - ensureCommandShape, ScopeProvider, } from "@cursorless/common"; import { @@ -13,7 +13,8 @@ import { } from "./api/CursorlessEngineApi"; import { Debug } from "./core/Debug"; import { HatTokenMapImpl } from "./core/HatTokenMapImpl"; -import { Snippets } from "./core/Snippets"; +import { KeyboardTargetUpdater } from "./KeyboardTargetUpdater"; +import type { Snippets } from "./core/Snippets"; import { StoredTargetMap } from "./core/StoredTargets"; import { RangeUpdater } from "./core/updateSelections/RangeUpdater"; import { CustomSpokenFormGeneratorImpl } from "./generateSpokenForm/CustomSpokenFormGeneratorImpl"; @@ -30,7 +31,6 @@ import { ScopeSupportChecker } from "./scopeProviders/ScopeSupportChecker"; import { ScopeSupportWatcher } from "./scopeProviders/ScopeSupportWatcher"; import { injectIde } from "./singletons/ide.singleton"; import { TreeSitter } from "./typings/TreeSitter"; -import { KeyboardTargetUpdater } from "./KeyboardTargetUpdater"; export async function createCursorlessEngine( treeSitter: TreeSitter, @@ -38,6 +38,7 @@ export async function createCursorlessEngine( hats: Hats, commandServerApi: CommandServerApi | null, fileSystem: FileSystem, + snippets: Snippets | undefined, ): Promise { injectIde(ide); @@ -45,9 +46,6 @@ export async function createCursorlessEngine( const rangeUpdater = new RangeUpdater(); - const snippets = new Snippets(); - snippets.init(); - const hatTokenMap = new HatTokenMapImpl( rangeUpdater, debug, @@ -123,7 +121,6 @@ export async function createCursorlessEngine( customSpokenFormGenerator, storedTargets, hatTokenMap, - snippets, injectIde, runIntegrationTests: () => runIntegrationTests(treeSitter, languageDefinitions), diff --git a/packages/cursorless-engine/src/index.ts b/packages/cursorless-engine/src/index.ts index dfe8e57fd9..a4d6fa2f5a 100644 --- a/packages/cursorless-engine/src/index.ts +++ b/packages/cursorless-engine/src/index.ts @@ -12,3 +12,6 @@ export * from "./CommandHistory"; export * from "./CommandHistoryAnalyzer"; export * from "./util/grammarHelpers"; export * from "./ScopeTestRecorder"; +export * from "./core/Snippets"; +export * from "./core/mergeSnippets"; +export * from "./util/object"; diff --git a/packages/cursorless-engine/src/runCommand.ts b/packages/cursorless-engine/src/runCommand.ts index fb2a4b2abc..713158eefd 100644 --- a/packages/cursorless-engine/src/runCommand.ts +++ b/packages/cursorless-engine/src/runCommand.ts @@ -10,11 +10,10 @@ import { CommandRunner } from "./CommandRunner"; import { Actions } from "./actions/Actions"; import { CommandRunnerDecorator } from "./api/CursorlessEngineApi"; import { Debug } from "./core/Debug"; -import { Snippets } from "./core/Snippets"; import { CommandRunnerImpl } from "./core/commandRunner/CommandRunnerImpl"; import { canonicalizeAndValidateCommand } from "./core/commandVersionUpgrades/canonicalizeAndValidateCommand"; import { RangeUpdater } from "./core/updateSelections/RangeUpdater"; -import { StoredTargetMap, TreeSitter } from "./index"; +import { StoredTargetMap, TreeSitter, type Snippets } from "./index"; import { LanguageDefinitions } from "./languages/LanguageDefinitions"; import { TargetPipelineRunner } from "./processTargets"; import { MarkStageFactoryImpl } from "./processTargets/MarkStageFactoryImpl"; @@ -38,7 +37,7 @@ export async function runCommand( commandServerApi: CommandServerApi | null, debug: Debug, hatTokenMap: HatTokenMap, - snippets: Snippets, + snippets: Snippets | undefined, storedTargets: StoredTargetMap, languageDefinitions: LanguageDefinitions, rangeUpdater: RangeUpdater, @@ -96,7 +95,7 @@ function createCommandRunner( debug: Debug, storedTargets: StoredTargetMap, readableHatMap: ReadOnlyHatMap, - snippets: Snippets, + snippets: Snippets | undefined, rangeUpdater: RangeUpdater, ): CommandRunner { const modifierStageFactory = new ModifierStageFactoryImpl( diff --git a/packages/cursorless-vscode/src/VscodeSnippets.ts b/packages/cursorless-vscode/src/VscodeSnippets.ts new file mode 100644 index 0000000000..67de7523a5 --- /dev/null +++ b/packages/cursorless-vscode/src/VscodeSnippets.ts @@ -0,0 +1,249 @@ +import { + showError, + Snippet, + SnippetMap, + walkFiles, + type IDE, +} from "@cursorless/common"; +import { + mergeSnippets, + mergeStrict, + type Snippets, +} from "@cursorless/cursorless-engine"; +import { readFile, stat } from "fs/promises"; +import { max } from "lodash"; +import { join } from "path"; + +const CURSORLESS_SNIPPETS_SUFFIX = ".cursorless-snippets"; +const SNIPPET_DIR_REFRESH_INTERVAL_MS = 1000; + +interface DirectoryErrorMessage { + directory: string; + errorMessage: string; +} + +/** + * Handles all cursorless snippets, including core, third-party and + * user-defined. Merges these collections and allows looking up snippets by + * name. + */ +export class VscodeSnippets implements Snippets { + private coreSnippets!: SnippetMap; + private thirdPartySnippets: Record = {}; + private userSnippets!: SnippetMap[]; + + private mergedSnippets!: SnippetMap; + + private userSnippetsDir?: string; + + /** + * The maximum modification time of any snippet in user snippets dir. + * + * This variable will be set to -1 if no user snippets have yet been read or + * if the user snippets path has changed. + * + * This variable will be set to 0 if the user has no snippets dir configured and + * we've already set userSnippets to {}. + */ + private maxSnippetMtimeMs: number = -1; + + /** + * If the user has misconfigured their snippet dir, then we keep track of it + * so that we can show them the error message if we can't find a snippet + * later, and so that we don't show them the same error message every time + * we try to poll the directory. + */ + private directoryErrorMessage: DirectoryErrorMessage | null | undefined = + null; + + constructor(private ide: IDE) { + this.updateUserSnippetsPath(); + + this.updateUserSnippets = this.updateUserSnippets.bind(this); + this.registerThirdPartySnippets = + this.registerThirdPartySnippets.bind(this); + + const timer = setInterval( + this.updateUserSnippets, + SNIPPET_DIR_REFRESH_INTERVAL_MS, + ); + + this.ide.disposeOnExit( + this.ide.configuration.onDidChangeConfiguration(() => { + if (this.updateUserSnippetsPath()) { + this.updateUserSnippets(); + } + }), + { + dispose() { + clearInterval(timer); + }, + }, + ); + } + + async init() { + const extensionPath = this.ide.assetsRoot; + const snippetsDir = join(extensionPath, "cursorless-snippets"); + const snippetFiles = await getSnippetPaths(snippetsDir); + this.coreSnippets = mergeStrict( + ...(await Promise.all( + snippetFiles.map(async (path) => + JSON.parse(await readFile(path, "utf8")), + ), + )), + ); + await this.updateUserSnippets(); + } + + /** + * Updates the userSnippetsDir field if it has change, returning a boolean + * indicating whether there was an update. If there was an update, resets the + * maxSnippetMtime to -1 to ensure snippet update. + * @returns Boolean indicating whether path has changed + */ + private updateUserSnippetsPath(): boolean { + const newUserSnippetsDir = this.ide.configuration.getOwnConfiguration( + "experimental.snippetsDir", + ); + + if (newUserSnippetsDir === this.userSnippetsDir) { + return false; + } + + // Reset mtime to -1 so that next time we'll update the snippets + this.maxSnippetMtimeMs = -1; + + this.userSnippetsDir = newUserSnippetsDir; + + return true; + } + + async updateUserSnippets() { + let snippetFiles: string[]; + try { + snippetFiles = this.userSnippetsDir + ? await getSnippetPaths(this.userSnippetsDir) + : []; + } catch (err) { + if (this.directoryErrorMessage?.directory !== this.userSnippetsDir) { + // NB: We suppress error messages once we've shown it the first time + // because we poll the directory every second and want to make sure we + // don't show the same error message repeatedly + const errorMessage = `Error with cursorless snippets dir "${ + this.userSnippetsDir + }": ${(err as Error).message}`; + + showError(this.ide.messages, "snippetsDirError", errorMessage); + + this.directoryErrorMessage = { + directory: this.userSnippetsDir!, + errorMessage, + }; + } + + this.userSnippets = []; + this.mergeSnippets(); + + return; + } + + this.directoryErrorMessage = null; + + const maxSnippetMtime = + max( + (await Promise.all(snippetFiles.map((file) => stat(file)))).map( + (stat) => stat.mtimeMs, + ), + ) ?? 0; + + if (maxSnippetMtime <= this.maxSnippetMtimeMs) { + return; + } + + this.maxSnippetMtimeMs = maxSnippetMtime; + + this.userSnippets = await Promise.all( + snippetFiles.map(async (path) => { + try { + const content = await readFile(path, "utf8"); + + if (content.length === 0) { + // Gracefully handle an empty file + return {}; + } + + return JSON.parse(content); + } catch (err) { + showError( + this.ide.messages, + "snippetsFileError", + `Error with cursorless snippets file "${path}": ${ + (err as Error).message + }`, + ); + + // We don't want snippets from all files to stop working if there is + // a parse error in one file, so we just effectively ignore this file + // once we've shown an error message + return {}; + } + }), + ); + + this.mergeSnippets(); + } + + /** + * Allows extensions to register third-party snippets. Calling this function + * twice with the same extensionId will replace the older snippets. + * + * Note that third-party snippets take precedence over core snippets, but + * user snippets take precedence over both. + * @param extensionId The id of the extension registering the snippets. + * @param snippets The snippets to be registered. + */ + registerThirdPartySnippets(extensionId: string, snippets: SnippetMap) { + this.thirdPartySnippets[extensionId] = snippets; + this.mergeSnippets(); + } + + /** + * Merge core, third-party, and user snippets, with precedence user > third + * party > core. + */ + private mergeSnippets() { + this.mergedSnippets = mergeSnippets( + this.coreSnippets, + this.thirdPartySnippets, + this.userSnippets, + ); + } + + /** + * Looks in merged collection of snippets for a snippet with key + * `snippetName`. Throws an exception if the snippet of the given name could + * not be found + * @param snippetName The name of the snippet to look up + * @returns The named snippet + */ + getSnippetStrict(snippetName: string): Snippet { + const snippet = this.mergedSnippets[snippetName]; + + if (snippet == null) { + let errorMessage = `Couldn't find snippet ${snippetName}. `; + + if (this.directoryErrorMessage != null) { + errorMessage += `This could be due to: ${this.directoryErrorMessage.errorMessage}.`; + } + + throw Error(errorMessage); + } + + return snippet; + } +} + +function getSnippetPaths(snippetsDir: string) { + return walkFiles(snippetsDir, CURSORLESS_SNIPPETS_SUFFIX); +} diff --git a/packages/cursorless-vscode/src/extension.ts b/packages/cursorless-vscode/src/extension.ts index e6d5a3f6e5..dea800ee54 100644 --- a/packages/cursorless-vscode/src/extension.ts +++ b/packages/cursorless-vscode/src/extension.ts @@ -51,6 +51,7 @@ import { import { StatusBarItem } from "./StatusBarItem"; import { storedTargetHighlighter } from "./storedTargetHighlighter"; import { vscodeApi } from "./vscodeApi"; +import { VscodeSnippets } from "./VscodeSnippets"; /** * Extension entrypoint called by VSCode on Cursorless startup. @@ -83,12 +84,14 @@ export async function activate( const treeSitter: TreeSitter = createTreeSitter(parseTreeApi); + const snippets = new VscodeSnippets(normalizedIde); + void snippets.init(); + const { commandApi, storedTargets, hatTokenMap, scopeProvider, - snippets, injectIde, runIntegrationTests, addCommandRunnerDecorator, @@ -99,6 +102,7 @@ export async function activate( hats, commandServerApi, fileSystem, + snippets, ); addCommandRunnerDecorator( From 4fbfbb505b01d91c3e9d5432a3777c7d4b89e634 Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Thu, 11 Jul 2024 14:54:31 +0200 Subject: [PATCH 2/5] refactor --- .../cursorless-engine/src/actions/Actions.ts | 2 +- .../src/actions/InsertSnippet.ts | 10 +--------- .../src/actions/WrapWithSnippet.ts | 10 +--------- .../cursorless-engine/src/cursorlessEngine.ts | 3 ++- .../disabledComponents/DisabledSnippets.ts | 19 +++++++++++++++++++ packages/cursorless-engine/src/runCommand.ts | 4 ++-- 6 files changed, 26 insertions(+), 22 deletions(-) create mode 100644 packages/cursorless-engine/src/disabledComponents/DisabledSnippets.ts diff --git a/packages/cursorless-engine/src/actions/Actions.ts b/packages/cursorless-engine/src/actions/Actions.ts index b801635bbe..15d2e0f3b6 100644 --- a/packages/cursorless-engine/src/actions/Actions.ts +++ b/packages/cursorless-engine/src/actions/Actions.ts @@ -69,7 +69,7 @@ import { Decrement, Increment } from "./incrementDecrement"; export class Actions implements ActionRecord { constructor( private treeSitter: TreeSitter, - private snippets: Snippets | undefined, + private snippets: Snippets, private rangeUpdater: RangeUpdater, private modifierStageFactory: ModifierStageFactory, ) {} diff --git a/packages/cursorless-engine/src/actions/InsertSnippet.ts b/packages/cursorless-engine/src/actions/InsertSnippet.ts index b9be30b927..0ae8701c9c 100644 --- a/packages/cursorless-engine/src/actions/InsertSnippet.ts +++ b/packages/cursorless-engine/src/actions/InsertSnippet.ts @@ -31,7 +31,7 @@ export default class InsertSnippet { constructor( private rangeUpdater: RangeUpdater, - private snippets: Snippets | undefined, + private snippets: Snippets, private actions: Actions, private modifierStageFactory: ModifierStageFactory, ) { @@ -56,10 +56,6 @@ export default class InsertSnippet { private getScopeTypes(snippetDescription: InsertSnippetArg): ScopeType[] { if (snippetDescription.type === "named") { - if (this.snippets == null) { - return []; - } - const { name } = snippetDescription; const snippet = this.snippets.getSnippetStrict(name); @@ -80,10 +76,6 @@ export default class InsertSnippet { targets: Target[], ) { if (snippetDescription.type === "named") { - if (this.snippets == null) { - throw Error("Named snippets are not enabled"); - } - const { name } = snippetDescription; const snippet = this.snippets.getSnippetStrict(name); diff --git a/packages/cursorless-engine/src/actions/WrapWithSnippet.ts b/packages/cursorless-engine/src/actions/WrapWithSnippet.ts index c75cc0b730..56ca6942ae 100644 --- a/packages/cursorless-engine/src/actions/WrapWithSnippet.ts +++ b/packages/cursorless-engine/src/actions/WrapWithSnippet.ts @@ -19,7 +19,7 @@ export default class WrapWithSnippet { constructor( private rangeUpdater: RangeUpdater, - private snippets: Snippets | undefined, + private snippets: Snippets, private modifierStageFactory: ModifierStageFactory, ) { this.run = this.run.bind(this); @@ -47,10 +47,6 @@ export default class WrapWithSnippet { snippetDescription: WrapWithSnippetArg, ): ScopeType | undefined { if (snippetDescription.type === "named") { - if (this.snippets == null) { - return undefined; - } - const { name, variableName } = snippetDescription; const snippet = this.snippets.getSnippetStrict(name); @@ -72,10 +68,6 @@ export default class WrapWithSnippet { targets: Target[], ): string { if (snippetDescription.type === "named") { - if (this.snippets == null) { - throw Error("Named snippets are not enabled"); - } - const { name } = snippetDescription; const snippet = this.snippets.getSnippetStrict(name); diff --git a/packages/cursorless-engine/src/cursorlessEngine.ts b/packages/cursorless-engine/src/cursorlessEngine.ts index ba65104785..840deeb4f7 100644 --- a/packages/cursorless-engine/src/cursorlessEngine.ts +++ b/packages/cursorless-engine/src/cursorlessEngine.ts @@ -31,6 +31,7 @@ import { ScopeSupportChecker } from "./scopeProviders/ScopeSupportChecker"; import { ScopeSupportWatcher } from "./scopeProviders/ScopeSupportWatcher"; import { injectIde } from "./singletons/ide.singleton"; import { TreeSitter } from "./typings/TreeSitter"; +import { DisabledSnippets } from "./disabledComponents/DisabledSnippets"; export async function createCursorlessEngine( treeSitter: TreeSitter, @@ -38,7 +39,7 @@ export async function createCursorlessEngine( hats: Hats, commandServerApi: CommandServerApi | null, fileSystem: FileSystem, - snippets: Snippets | undefined, + snippets: Snippets | undefined = new DisabledSnippets(), ): Promise { injectIde(ide); diff --git a/packages/cursorless-engine/src/disabledComponents/DisabledSnippets.ts b/packages/cursorless-engine/src/disabledComponents/DisabledSnippets.ts new file mode 100644 index 0000000000..2ea35298b3 --- /dev/null +++ b/packages/cursorless-engine/src/disabledComponents/DisabledSnippets.ts @@ -0,0 +1,19 @@ +import type { SnippetMap, Snippet } from "@cursorless/common"; +import type { Snippets } from "../core/Snippets"; + +export class DisabledSnippets implements Snippets { + updateUserSnippets(): Promise { + throw new Error("Snippets are not implemented."); + } + + registerThirdPartySnippets( + _extensionId: string, + _snippets: SnippetMap, + ): void { + throw new Error("Snippets are not implemented."); + } + + getSnippetStrict(_snippetName: string): Snippet { + throw new Error("Snippets are not implemented."); + } +} diff --git a/packages/cursorless-engine/src/runCommand.ts b/packages/cursorless-engine/src/runCommand.ts index 713158eefd..3db9f42f5c 100644 --- a/packages/cursorless-engine/src/runCommand.ts +++ b/packages/cursorless-engine/src/runCommand.ts @@ -37,7 +37,7 @@ export async function runCommand( commandServerApi: CommandServerApi | null, debug: Debug, hatTokenMap: HatTokenMap, - snippets: Snippets | undefined, + snippets: Snippets, storedTargets: StoredTargetMap, languageDefinitions: LanguageDefinitions, rangeUpdater: RangeUpdater, @@ -95,7 +95,7 @@ function createCommandRunner( debug: Debug, storedTargets: StoredTargetMap, readableHatMap: ReadOnlyHatMap, - snippets: Snippets | undefined, + snippets: Snippets, rangeUpdater: RangeUpdater, ): CommandRunner { const modifierStageFactory = new ModifierStageFactoryImpl( From fb54acf40ea1d219eff23c1b4da90d7391818952 Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Thu, 11 Jul 2024 15:00:17 +0200 Subject: [PATCH 3/5] fix --- .../cursorless-engine/src/actions/Actions.ts | 2 +- .../GenerateSnippet/GenerateSnippet.ts | 10 +++---- .../GenerateSnippet/openNewSnippetFile.ts | 27 ------------------- .../cursorless-engine/src/core/Snippets.ts | 6 +++++ .../disabledComponents/DisabledSnippets.ts | 4 +++ .../cursorless-vscode/src/VscodeSnippets.ts | 21 ++++++++++++++- 6 files changed, 36 insertions(+), 34 deletions(-) delete mode 100644 packages/cursorless-engine/src/actions/GenerateSnippet/openNewSnippetFile.ts diff --git a/packages/cursorless-engine/src/actions/Actions.ts b/packages/cursorless-engine/src/actions/Actions.ts index 15d2e0f3b6..6ec25e74b0 100644 --- a/packages/cursorless-engine/src/actions/Actions.ts +++ b/packages/cursorless-engine/src/actions/Actions.ts @@ -96,7 +96,7 @@ export class Actions implements ActionRecord { foldRegion = new Fold(this.rangeUpdater); followLink = new FollowLink({ openAside: false }); followLinkAside = new FollowLink({ openAside: true }); - generateSnippet = new GenerateSnippet(); + generateSnippet = new GenerateSnippet(this.snippets); getText = new GetText(); highlight = new Highlight(); increment = new Increment(this); diff --git a/packages/cursorless-engine/src/actions/GenerateSnippet/GenerateSnippet.ts b/packages/cursorless-engine/src/actions/GenerateSnippet/GenerateSnippet.ts index ad072f7f3f..9b372a5640 100644 --- a/packages/cursorless-engine/src/actions/GenerateSnippet/GenerateSnippet.ts +++ b/packages/cursorless-engine/src/actions/GenerateSnippet/GenerateSnippet.ts @@ -1,13 +1,13 @@ import { FlashStyle, isTesting, Range } from "@cursorless/common"; +import type { Snippets } from "../../core/Snippets"; import { Offsets } from "../../processTargets/modifiers/surroundingPair/types"; import { ide } from "../../singletons/ide.singleton"; -import { Target } from "../../typings/target.types"; +import type { Target } from "../../typings/target.types"; import { matchAll } from "../../util/regex"; import { ensureSingleTarget, flashTargets } from "../../util/targetUtils"; -import { ActionReturnValue } from "../actions.types"; +import type { ActionReturnValue } from "../actions.types"; import { constructSnippetBody } from "./constructSnippetBody"; import { editText } from "./editText"; -import { openNewSnippetFile } from "./openNewSnippetFile"; import Substituter from "./Substituter"; /** @@ -46,7 +46,7 @@ import Substituter from "./Substituter"; * confusing escaping. */ export default class GenerateSnippet { - constructor() { + constructor(private snippets: Snippets) { this.run = this.run.bind(this); } @@ -228,7 +228,7 @@ export default class GenerateSnippet { } else { // Otherwise, we create and open a new document for the snippet in the // user snippets dir - await openNewSnippetFile(snippetName); + await this.snippets.openNewSnippetFile(snippetName); } // Insert the meta-snippet diff --git a/packages/cursorless-engine/src/actions/GenerateSnippet/openNewSnippetFile.ts b/packages/cursorless-engine/src/actions/GenerateSnippet/openNewSnippetFile.ts deleted file mode 100644 index 17cdf1de23..0000000000 --- a/packages/cursorless-engine/src/actions/GenerateSnippet/openNewSnippetFile.ts +++ /dev/null @@ -1,27 +0,0 @@ -import { open } from "fs/promises"; -import { join } from "path"; -import { ide } from "../../singletons/ide.singleton"; - -/** - * Creates a new empty file in the users snippet directory and opens an editor - * onto that file. - * @param snippetName The name of the snippet - */ -export async function openNewSnippetFile(snippetName: string) { - const userSnippetsDir = ide().configuration.getOwnConfiguration( - "experimental.snippetsDir", - ); - - if (!userSnippetsDir) { - throw new Error("User snippets dir not configured."); - } - - const path = join(userSnippetsDir, `${snippetName}.cursorless-snippets`); - await touch(path); - await ide().openTextDocument(path); -} - -async function touch(path: string) { - const file = await open(path, "w"); - await file.close(); -} diff --git a/packages/cursorless-engine/src/core/Snippets.ts b/packages/cursorless-engine/src/core/Snippets.ts index 872ab603d3..b4633a0472 100644 --- a/packages/cursorless-engine/src/core/Snippets.ts +++ b/packages/cursorless-engine/src/core/Snippets.ts @@ -27,4 +27,10 @@ export interface Snippets { * @returns The named snippet */ getSnippetStrict(snippetName: string): Snippet; + + /** + * Opens a new snippet file in the users snippet directory. + * @param snippetName The name of the snippet + */ + openNewSnippetFile(snippetName: string): Promise; } diff --git a/packages/cursorless-engine/src/disabledComponents/DisabledSnippets.ts b/packages/cursorless-engine/src/disabledComponents/DisabledSnippets.ts index 2ea35298b3..f9377c7251 100644 --- a/packages/cursorless-engine/src/disabledComponents/DisabledSnippets.ts +++ b/packages/cursorless-engine/src/disabledComponents/DisabledSnippets.ts @@ -16,4 +16,8 @@ export class DisabledSnippets implements Snippets { getSnippetStrict(_snippetName: string): Snippet { throw new Error("Snippets are not implemented."); } + + openNewSnippetFile(_snippetName: string): Promise { + throw new Error("Snippets are not implemented."); + } } diff --git a/packages/cursorless-vscode/src/VscodeSnippets.ts b/packages/cursorless-vscode/src/VscodeSnippets.ts index 67de7523a5..6465368f94 100644 --- a/packages/cursorless-vscode/src/VscodeSnippets.ts +++ b/packages/cursorless-vscode/src/VscodeSnippets.ts @@ -10,7 +10,7 @@ import { mergeStrict, type Snippets, } from "@cursorless/cursorless-engine"; -import { readFile, stat } from "fs/promises"; +import { readFile, stat, open } from "fs/promises"; import { max } from "lodash"; import { join } from "path"; @@ -242,8 +242,27 @@ export class VscodeSnippets implements Snippets { return snippet; } + + async openNewSnippetFile(snippetName: string) { + const userSnippetsDir = this.ide.configuration.getOwnConfiguration( + "experimental.snippetsDir", + ); + + if (!userSnippetsDir) { + throw new Error("User snippets dir not configured."); + } + + const path = join(userSnippetsDir, `${snippetName}.cursorless-snippets`); + await touch(path); + await this.ide.openTextDocument(path); + } } function getSnippetPaths(snippetsDir: string) { return walkFiles(snippetsDir, CURSORLESS_SNIPPETS_SUFFIX); } + +async function touch(path: string) { + const file = await open(path, "w"); + await file.close(); +} From 8aeef9d5e44656b751bd26c7ffa9696dbdd0470c Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Thu, 11 Jul 2024 15:40:59 +0200 Subject: [PATCH 4/5] Update packages/cursorless-engine/src/cursorlessEngine.ts Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com> --- packages/cursorless-engine/src/cursorlessEngine.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/cursorless-engine/src/cursorlessEngine.ts b/packages/cursorless-engine/src/cursorlessEngine.ts index 840deeb4f7..2b8cde45d3 100644 --- a/packages/cursorless-engine/src/cursorlessEngine.ts +++ b/packages/cursorless-engine/src/cursorlessEngine.ts @@ -39,7 +39,7 @@ export async function createCursorlessEngine( hats: Hats, commandServerApi: CommandServerApi | null, fileSystem: FileSystem, - snippets: Snippets | undefined = new DisabledSnippets(), + snippets: Snippets = new DisabledSnippets(), ): Promise { injectIde(ide); From 751497fad7f1fc5fd8fc4c35816180cc00ef31dc Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Thu, 11 Jul 2024 15:47:35 +0200 Subject: [PATCH 5/5] lodashes --- packages/cursorless-vscode/src/VscodeSnippets.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/cursorless-vscode/src/VscodeSnippets.ts b/packages/cursorless-vscode/src/VscodeSnippets.ts index 6465368f94..3b91d3793e 100644 --- a/packages/cursorless-vscode/src/VscodeSnippets.ts +++ b/packages/cursorless-vscode/src/VscodeSnippets.ts @@ -11,7 +11,7 @@ import { type Snippets, } from "@cursorless/cursorless-engine"; import { readFile, stat, open } from "fs/promises"; -import { max } from "lodash"; +import { max } from "lodash-es"; import { join } from "path"; const CURSORLESS_SNIPPETS_SUFFIX = ".cursorless-snippets";