WIP: add Triggerkey to snippets

implements [#439](https://github.com/superle3/obsidian-latex-suite/issues/439)

Author: superle3

src/features/run_snippets.ts

@@ -43,12 +43,17 @@ const runSnippetCursor = (view: EditorView, ctx: Context, key: string, range: Se
 			continue;
 		}
 
-		if (snippet.options.automatic || snippet.type === "visual") {
+		if (
+			snippet.options.automatic ||
+			(snippet.type === "visual" && !snippet.triggerKey)
+		) {
 			// If the key pressed wasn't a text character, continue
 			if (!(key.length === 1)) continue;
 			effectiveLine = updatedLine;
-		}
-		else if (!(key === settings.snippetsTrigger)) {
+		} else if (
+			!(key === settings.snippetsTrigger && !snippet.triggerKey) &&
+			snippet.triggerKey !== key
+		) {
 			// The snippet must be triggered by a key
 			continue;
 		}
@@ -82,7 +87,8 @@ const runSnippetCursor = (view: EditorView, ctx: Context, key: string, range: Se
 
 		// Expand the snippet
 		const start = triggerPos;
-		queueSnippet(view, start, to, replacement, key);
+		const triggerKey = (snippet.options.automatic && snippet.type !== "visual") ? key : undefined;
+		queueSnippet(view, start, to, replacement, triggerKey);
 
 		const containsTrigger = settings.autoEnlargeBracketsTriggers.some(word => replacement.contains("\\" + word));
 		return {success: true, shouldAutoEnlargeBrackets: containsTrigger};
@@ -148,4 +154,4 @@ const trimWhitespace = (replacement: string, ctx: Context) => {
 	}
 
 	return replacement;
-}
+}

src/latex_suite.ts

@@ -16,6 +16,7 @@ import { handleUndoRedo } from "./snippets/codemirror/history";
 import { handleMathTooltip } from "./editor_extensions/math_tooltip";
 import { isComposing } from "./utils/editor_utils";
 import { LatexSuiteCMSettings } from "./settings/settings";
+import { Snippet } from "./snippets/snippets";
 
 export const handleUpdate = (update: ViewUpdate) => {
 	const settings = getLatexSuiteConfig(update.state);
@@ -123,8 +124,9 @@ export const handleKeydown = (key: string, shiftKey: boolean, ctrlKey: boolean,
 
 
 export function getKeymaps(settings: LatexSuiteCMSettings): readonly KeyBinding[] {
-	const keybindings: KeyBinding[] = [];	
-	if (settings.autoDelete$){
+	// order matters, keybindings should be added in the order they should be triggered
+	const keybindings: KeyBinding[] = [];
+	if (settings.autoDelete$) {
 		/*
 		* When backspace is pressed, if the cursor is inside an empty inline math,
 		* delete both $ symbols, not just the first one.
@@ -148,20 +150,40 @@ export function getKeymaps(settings: LatexSuiteCMSettings): readonly KeyBinding[
 	}
 
 	if (settings.snippetsEnabled) {
-		keybindings.push(
-			{key: settings.snippetsTrigger, run: (view: EditorView) => {
-				console.debug("Snippets extension", view.composing, view.compositionStarted);
-				if (settings.suppressSnippetTriggerOnIME && view.composing) return;
+		const snippet_triggers = new Set(
+			settings.snippets.map((s) => s.triggerKey).filter((s) => s)
+		);
+		snippet_triggers.add(settings.snippetsTrigger);
+		const runMaker = (key: string) => {
+			console.debug("triggerkeys:", key)	
+			return (view: EditorView) => {
+				console.debug(
+					"Snippets extension",
+					view.composing,
+					view.compositionStarted
+				);
+				if (settings.suppressSnippetTriggerOnIME && view.composing)
+					return;
 				try {
-					const ctx = Context.fromView(view)
-					return runSnippets(view, ctx, settings.snippetsTrigger)
+					const ctx = Context.fromView(view);
+					return runSnippets(view, ctx, key);
 				} catch (e) {
-					clearSnippetQueue(view)
-					console.error(e)
-					return false
+					clearSnippetQueue(view);
+					console.error(e);
+					return false;
 				}
-			}}
-		)	
+			};
+		};
+
+			
+		keybindings.push(
+			...Array.from(snippet_triggers, (key) => {
+				return {
+					key,
+					run: runMaker(key),
+				};
+			})
+		);
 	}
 
 	keybindings.push(
@@ -221,6 +243,7 @@ export function getKeymaps(settings: LatexSuiteCMSettings): readonly KeyBinding[
 			})
 		)
 	}
+	
 	keybindings.map((keybinding) => {
 		keybinding.scope = "latex-suite"
 	})

src/snippets/parse.ts

@@ -108,6 +108,7 @@ const RawSnippetSchema = object({
 	flags: optional(string_()),
 	priority: optional(number()),
 	description: optional(string_()),
+	triggerKey: optional(string_()),
 });
 
 type RawSnippet = Output<typeof RawSnippetSchema>;
@@ -135,7 +136,7 @@ function validateRawSnippets(snippets: unknown): RawSnippet[] {
  * - if it is a regex snippet, the trigger is represented as a RegExp instance with flags set
  */
 function parseSnippet(raw: RawSnippet, snippetVariables: SnippetVariables): Snippet {
-	const { replacement, priority, description } = raw;
+	const { replacement, priority, description, triggerKey } = raw;
 	const options = Options.fromSource(raw.options);
 	let trigger;
 	let excludedEnvironments;
@@ -172,7 +173,7 @@ function parseSnippet(raw: RawSnippet, snippetVariables: SnippetVariables): Snip
 
 		options.regex = true;
 
-		const normalised = { trigger, replacement, options, priority, description, excludedEnvironments };
+		const normalised = { trigger, replacement, options, priority, description, excludedEnvironments, triggerKey };
 
 		return new RegexSnippet(normalised);
 	}
@@ -189,7 +190,7 @@ function parseSnippet(raw: RawSnippet, snippetVariables: SnippetVariables): Snip
 			options.visual = true;
 		}
 
-		const normalised = { trigger, replacement, options, priority, description, excludedEnvironments };
+		const normalised = { trigger, replacement, options, priority, description, excludedEnvironments, triggerKey };
 
 		if (options.visual) {
 			return new VisualSnippet(normalised);

src/snippets/snippets.ts

@@ -54,6 +54,7 @@ export abstract class Snippet<T extends SnippetType = SnippetType> {
 	options: Options;
 	priority?: number;
 	description?: string;
+	triggerKey: string | null;
 
 	excludedEnvironments: Environment[];
 
@@ -65,6 +66,7 @@ export abstract class Snippet<T extends SnippetType = SnippetType> {
 		priority?: number | undefined,
 		description?: string | undefined,
 		excludedEnvironments?: Environment[],
+		triggerKey?: string,
 	) {
 		this.type = type;
 		// @ts-ignore
@@ -73,6 +75,7 @@ export abstract class Snippet<T extends SnippetType = SnippetType> {
 		this.priority = priority;
 		this.description = description;
 		this.excludedEnvironments = excludedEnvironments ?? [];
+		this.triggerKey = triggerKey ?? null;
 	}
 
 	// we need to explicitly type the return value here so the derived classes,
@@ -96,8 +99,8 @@ export abstract class Snippet<T extends SnippetType = SnippetType> {
 }
 
 export class VisualSnippet extends Snippet<"visual"> {
-	constructor({ trigger, replacement, options, priority, description, excludedEnvironments }: CreateSnippet<"visual">) {
-		super("visual", trigger, replacement, options, priority, description, excludedEnvironments);
+	constructor({ trigger, replacement, options, priority, description, excludedEnvironments, triggerKey }: CreateSnippet<"visual">) {
+		super("visual", trigger, replacement, options, priority, description, excludedEnvironments, triggerKey);
 	}
 
 	process(effectiveLine: string, range: SelectionRange, sel: string): ProcessSnippetResult {
@@ -126,8 +129,8 @@ export class VisualSnippet extends Snippet<"visual"> {
 
 export class RegexSnippet extends Snippet<"regex"> {
 
-	constructor({ trigger, replacement, options, priority, description, excludedEnvironments }: CreateSnippet<"regex">) {
-		super("regex", trigger, replacement, options, priority, description, excludedEnvironments);
+	constructor({ trigger, replacement, options, priority, description, excludedEnvironments , triggerKey}: CreateSnippet<"regex">) {
+		super("regex", trigger, replacement, options, priority, description, excludedEnvironments, triggerKey);
 	}
 
 	process(effectiveLine: string, range: SelectionRange, sel: string): ProcessSnippetResult {
@@ -167,8 +170,8 @@ export class RegexSnippet extends Snippet<"regex"> {
 export class StringSnippet extends Snippet<"string"> {
 	data: SnippetData<"string">;
 
-	constructor({ trigger, replacement, options, priority, description, excludedEnvironments: excludeIn }: CreateSnippet<"string">) {
-		super("string", trigger, replacement, options, priority, description, excludeIn);
+	constructor({ trigger, replacement, options, priority, description, excludedEnvironments: excludeIn, triggerKey }: CreateSnippet<"string">) {
+		super("string", trigger, replacement, options, priority, description, excludeIn, triggerKey);
 	}
 
 	process(effectiveLine: string, range: SelectionRange, sel: string): ProcessSnippetResult {
@@ -209,6 +212,7 @@ type CreateSnippet<T extends SnippetType> = {
 	priority?: number;
 	description?: string;
 	excludedEnvironments?: Environment[];
+	triggerKey?: string;
 } & SnippetData<T>
 
 
@@ -217,4 +221,4 @@ type CreateSnippet<T extends SnippetType> = {
  */
 export function serializeSnippetLike(snippetLike: unknown) {
 	return JSON.stringify(snippetLike, replacer, 2);
-}
+}