Skip to content

Show deprecation message when using legacy snippets #2857

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 19, 2025
Merged

Show deprecation message when using legacy snippets #2857

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b65b345
Show deprecation message when using legacy snippets
AndreasArvidsson Feb 19, 2025
750c726
Update packages/cursorless-engine/src/actions/snippetsLegacy/legacySn…
AndreasArvidsson Feb 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions packages/cursorless-engine/src/actions/snippetsLegacy/InsertSnippetLegacy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import {
findMatchingSnippetDefinitionStrict,
transformSnippetVariables,
} from "../snippetsLegacy/snippet";
import { showLegacySnippetsNotification } from "./legacySnippetsNotification";
import { textFormatters, type TextFormatterName } from "./textFormatters";

export default class InsertSnippetLegacy {
Expand Down Expand Up @@ -95,6 +96,8 @@ export default class InsertSnippetLegacy {
destinations: Destination[],
snippetDescription: NamedInsertSnippetArg,
): Promise<ActionReturnValue> {
showLegacySnippetsNotification();

const editor = ide().getEditableTextEditor(
ensureSingleEditor(destinations),
);
Expand Down
3 changes: 3 additions & 0 deletions packages/cursorless-engine/src/actions/snippetsLegacy/WrapWithSnippetLegacy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import {
findMatchingSnippetDefinitionStrict,
transformSnippetVariables,
} from "../snippetsLegacy/snippet";
import { showLegacySnippetsNotification } from "./legacySnippetsNotification";

export default class WrapWithSnippetLegacy {
private snippetParser = new SnippetParser();
Expand Down Expand Up @@ -81,6 +82,8 @@ export default class WrapWithSnippetLegacy {
targets: Target[],
snippetDescription: NamedWrapWithSnippetArg,
): Promise<ActionReturnValue> {
showLegacySnippetsNotification();

const editor = ide().getEditableTextEditor(ensureSingleEditor(targets));

const body = this.getBody(snippetDescription, targets);
Expand Down
19 changes: 19 additions & 0 deletions packages/cursorless-engine/src/actions/snippetsLegacy/legacySnippetsNotification.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import { showWarning } from "@cursorless/common";
import { ide } from "../../singletons/ide.singleton";

// Show only once per vscode instance
let wasShown = false;

export function showLegacySnippetsNotification() {
if (wasShown) {
return;
}

void showWarning(
ide().messages,
"legacySnippets",
"Cursorless snippets are deprecated. Please use community snippets. Update to latest cursorless-talon and say 'cursorless migrate snippets'.",
);

wasShown = true;
}
Loading