Merge branch 'main' into languagesSidebar

Author: AndreasArvidsson

CHANGELOG.md

@@ -0,0 +1,3 @@
+# Change log entries
+
+This directory contains the raw changelog entries that we will one day use to generate proper release notes. Until then, you can read them here, imagining them in their beautiful future form.

changelog/README.md

@@ -21,6 +21,7 @@ import {
   findMatchingSnippetDefinitionStrict,
   transformSnippetVariables,
 } from "../snippetsLegacy/snippet";
+import { showLegacySnippetsNotification } from "./legacySnippetsNotification";
 import { textFormatters, type TextFormatterName } from "./textFormatters";
 
 export default class InsertSnippetLegacy {
@@ -95,6 +96,8 @@ export default class InsertSnippetLegacy {
     destinations: Destination[],
     snippetDescription: NamedInsertSnippetArg,
   ): Promise<ActionReturnValue> {
+    showLegacySnippetsNotification();
+
     const editor = ide().getEditableTextEditor(
       ensureSingleEditor(destinations),
     );

packages/cursorless-engine/src/actions/snippetsLegacy/InsertSnippetLegacy.ts

@@ -14,6 +14,7 @@ import {
   findMatchingSnippetDefinitionStrict,
   transformSnippetVariables,
 } from "../snippetsLegacy/snippet";
+import { showLegacySnippetsNotification } from "./legacySnippetsNotification";
 
 export default class WrapWithSnippetLegacy {
   private snippetParser = new SnippetParser();
@@ -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);

packages/cursorless-engine/src/actions/snippetsLegacy/WrapWithSnippetLegacy.ts

@@ -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",
+    "Talon community snippets are now fully supported in Cursorless! Cursorless's experimental snippets are now deprecated, but in most cases we can help you migrate automatically. Update cursorless-talon and say 'cursorless migrate snippets'.",
+  );
+
+  wasShown = true;
+}

packages/cursorless-engine/src/actions/snippetsLegacy/legacySnippetsNotification.ts

@@ -1,3 +1,5 @@
 # Release notes
 
 Here we gather "release notes" with new Cursorless features, bug fixes, and improvements. Note that Cursorless is on continuous delivery, so these "releases" are just a way to highlight features that you already have, but might not have noticed 😊.
+
+Note that these release notes come out very occasionally, so if you want to know what we've been up to between releases, you can check out our raw changelog entries, which are stored in [markdown blurbs in our monorepo](https://github.com/cursorless-dev/cursorless/tree/main/changelog). In the future, we'll generate proper release notes from these blurbs. Until then, you'll have to use your imagination or wait for us to hand-write release notes.

packages/cursorless-org-docs/src/docs/user/release-notes/README.md

@@ -77,10 +77,11 @@ async function runTestsInDir(
       const failedTests: string[] = [];
 
       const runner = mocha.run((failures) => {
+        if (shouldLogFailedTests()) {
+          logFailedTests(failedTests);
+        }
+
         if (failures > 0) {
-          if (shouldLogFailedTests()) {
-            logFailedTests(failedTests);
-          }
           reject(`${failures} tests failed.`);
         } else {
           resolve();