Open Cursorless org webpage as default if no url is provided

AndreasArvidsson · AndreasArvidsson · commit a6d5ddd18dca · 2025-07-06T19:48:24.000+02:00
diff --git a/packages/common/src/constants.ts b/packages/common/src/constants.ts
@@ -0,0 +1,3 @@
+export const CURSORLESS_ORG_URL = "https://www.cursorless.org";
+export const DOCS_URL = `${CURSORLESS_ORG_URL}/docs`;
+export const GITHUB_URL = "https://github.com/cursorless-dev/cursorless";
diff --git a/packages/common/src/errors.ts b/packages/common/src/errors.ts
@@ -1,7 +1,9 @@
+import { DOCS_URL } from "./constants";
+
 export class UnsupportedLanguageError extends Error {
   constructor(languageId: string) {
     super(
-      `Language '${languageId}' is not implemented yet; See https://www.cursorless.org/docs/contributing/adding-a-new-language/`,
+      `Language '${languageId}' is not implemented yet; See ${DOCS_URL}/contributing/adding-a-new-language`,
     );
     this.name = "UnsupportedLanguageError";
   }
diff --git a/packages/common/src/index.ts b/packages/common/src/index.ts
@@ -1,3 +1,4 @@
+export * from "./constants";
 export * from "./cursorlessCommandIds";
 export * from "./cursorlessSideBarIds";
 export * from "./Debouncer";
diff --git a/packages/cursorless-engine/src/generateSpokenForm/generateSpokenForm.ts b/packages/cursorless-engine/src/generateSpokenForm/generateSpokenForm.ts
@@ -9,7 +9,7 @@ import type {
   SpokenFormMapKeyTypes,
   SpokenFormType,
 } from "@cursorless/common";
-import { camelCaseToAllDown } from "@cursorless/common";
+import { camelCaseToAllDown, DOCS_URL } from "@cursorless/common";
 import type { SpokenFormMap } from "../spokenForms/SpokenFormMap";
 import { NoSpokenFormError } from "./NoSpokenFormError";
 import type { SpokenFormComponent } from "./SpokenFormComponent";
@@ -310,11 +310,9 @@ function constructSpokenForms(component: SpokenFormComponent): string[] {
       helpInfo =
         "this is a private spoken form currently only for internal experimentation";
     } else if (component.spokenForms.requiresTalonUpdate) {
-      helpInfo =
-        "please update talon to the latest version (see https://www.cursorless.org/docs/user/updating/)";
+      helpInfo = `please update talon to the latest version (see ${DOCS_URL}/user/updating)`;
     } else {
-      helpInfo =
-        "please see https://www.cursorless.org/docs/user/customization/ for more information";
+      helpInfo = `please see ${DOCS_URL}/user/customization/ for more information`;
     }
 
     throw new NoSpokenFormError(
diff --git a/packages/cursorless-org/package.json b/packages/cursorless-org/package.json
@@ -30,6 +30,7 @@
   },
   "dependencies": {
     "@cursorless/cheatsheet": "workspace:*",
+    "@cursorless/common": "workspace:*",
     "@mdx-js/loader": "3.1.0",
     "@mdx-js/react": "3.1.0",
     "@next/mdx": "15.3.3",
diff --git a/packages/cursorless-org/src/components/BaseSocial.tsx b/packages/cursorless-org/src/components/BaseSocial.tsx
@@ -1,5 +1,5 @@
+import { CURSORLESS_ORG_URL } from "@cursorless/common";
 import {
-  BASE_URL,
   VIDEO_SHARE_THUMBNAIL_HEIGHT,
   VIDEO_SHARE_THUMBNAIL_URL,
   VIDEO_SHARE_THUMBNAIL_WIDTH,
@@ -24,7 +24,7 @@ export default function BaseSocial({
   thumbnailWidth = VIDEO_SHARE_THUMBNAIL_WIDTH,
   thumbnailHeight = VIDEO_SHARE_THUMBNAIL_HEIGHT,
 }: Props) {
-  const url = `${BASE_URL}/${relativeUrl}`;
+  const url = `${CURSORLESS_ORG_URL}/${relativeUrl}`;
 
   return (
     <>
diff --git a/packages/cursorless-org/src/components/constants.ts b/packages/cursorless-org/src/components/constants.ts
@@ -1,7 +1,8 @@
+import { CURSORLESS_ORG_URL } from "@cursorless/common";
+
 export const DESCRIPTION = "Voice coding at the speed of thought";
 export const TITLE = `Cursorless: ${DESCRIPTION}`;
-export const BASE_URL = "https://cursorless.org/";
-export const VIDEO_SHARE_THUMBNAIL_URL = `${BASE_URL}video-share-thumbnail.jpg`;
+export const VIDEO_SHARE_THUMBNAIL_URL = `${CURSORLESS_ORG_URL}/video-share-thumbnail.jpg`;
 export const VIDEO_SHARE_THUMBNAIL_WIDTH = "1280";
 export const VIDEO_SHARE_THUMBNAIL_HEIGHT = "720";
 export const YOUTUBE_SLUG = "5mAzHGM2M0k";
diff --git a/packages/cursorless-org/tsconfig.json b/packages/cursorless-org/tsconfig.json
@@ -23,6 +23,9 @@
   "references": [
     {
       "path": "../cheatsheet"
+    },
+    {
+      "path": "../common"
     }
   ],
   "exclude": ["node_modules"]
diff --git a/packages/cursorless-vscode-e2e/src/suite/scopeProvider/runCustomSpokenFormScopeInfoTest.ts b/packages/cursorless-vscode-e2e/src/suite/scopeProvider/runCustomSpokenFormScopeInfoTest.ts
@@ -1,9 +1,9 @@
-import { getCursorlessApi } from "@cursorless/vscode-common";
 import type { ScopeTypeInfo } from "@cursorless/common";
-import { sleep } from "@cursorless/common";
+import { DOCS_URL, sleep } from "@cursorless/common";
+import { getCursorlessApi } from "@cursorless/vscode-common";
+import { stat, unlink, writeFile } from "fs/promises";
 import * as sinon from "sinon";
 import { assertCalledWithScopeInfo } from "./assertCalledWithScopeInfo";
-import { stat, unlink, writeFile } from "fs/promises";
 
 /**
  * Tests that the scope provider correctly reports custom spoken forms
@@ -152,8 +152,7 @@ const squareMissing: ScopeTypeInfo = {
   scopeType: { type: "surroundingPair", delimiter: "squareBrackets" },
   spokenForm: {
     isPrivate: false,
-    reason:
-      "paired delimiter with id squareBrackets; please update talon to the latest version (see https://www.cursorless.org/docs/user/updating/)",
+    reason: `paired delimiter with id squareBrackets; please update talon to the latest version (see ${DOCS_URL}/user/updating)`,
     requiresTalonUpdate: true,
     type: "error",
   },
@@ -195,8 +194,7 @@ const lambdaCustom: ScopeTypeInfo = {
   scopeType: { type: "anonymousFunction" },
   spokenForm: {
     isPrivate: false,
-    reason:
-      "simple scope type type with id anonymousFunction; please see https://www.cursorless.org/docs/user/customization/ for more information",
+    reason: `simple scope type type with id anonymousFunction; please see ${DOCS_URL}/user/customization for more information`,
     requiresTalonUpdate: false,
     type: "error",
   },
@@ -218,8 +216,7 @@ const statementMissing: ScopeTypeInfo = {
   scopeType: { type: "statement" },
   spokenForm: {
     isPrivate: false,
-    reason:
-      "simple scope type type with id statement; please update talon to the latest version (see https://www.cursorless.org/docs/user/updating/)",
+    reason: `simple scope type type with id statement; please update talon to the latest version (see ${DOCS_URL}/user/updating)`,
     requiresTalonUpdate: true,
     type: "error",
   },
diff --git a/packages/cursorless-vscode/src/ScopeTreeProvider.ts b/packages/cursorless-vscode/src/ScopeTreeProvider.ts
@@ -6,6 +6,7 @@ import type {
 } from "@cursorless/common";
 import {
   CURSORLESS_SCOPE_TREE_VIEW_ID,
+  DOCS_URL,
   ScopeSupport,
   disposableFrom,
   serializeScopeType,
@@ -146,9 +147,7 @@ export class ScopeTreeProvider implements TreeDataProvider<MyTreeItem> {
 
     if (result === HOW_BUTTON_TEXT) {
       await this.vscodeApi.env.openExternal(
-        URI.parse(
-          "https://www.cursorless.org/docs/user/updating/#updating-the-talon-side",
-        ),
+        URI.parse(`${DOCS_URL}/user/updating/#updating-the-talon-side`),
       );
     } else if (result === DONT_SHOW_AGAIN_BUTTON_TEXT) {
       await this.context.globalState.update(
@@ -238,8 +237,8 @@ class ScopeSupportTreeItem extends TreeItem {
     } else {
       label = "-";
       tooltip = scopeTypeInfo.spokenForm.requiresTalonUpdate
-        ? "Requires Talon update; see [update instructions](https://www.cursorless.org/docs/user/updating/#updating-the-talon-side)"
-        : "Spoken form disabled; see [customization docs](https://www.cursorless.org/docs/user/customization/#talon-side-settings)";
+        ? `Requires Talon update; see [update instructions](${DOCS_URL}/user/updating/#updating-the-talon-side)`
+        : `Spoken form disabled; see [customization docs](${DOCS_URL}/user/customization/#talon-side-settings)`;
     }
 
     super(
@@ -296,7 +295,7 @@ class ScopeSupportTreeItem extends TreeItem {
     const scopeTypeType = uriEncodeHashId(
       serializeScopeType(this.scopeTypeInfo.scopeType),
     );
-    this.url = `https://www.cursorless.org/docs/user/languages/${languageId}#${scopeTypeType}`;
+    this.url = `${DOCS_URL}/user/languages/${languageId}#${scopeTypeType}`;
     this.contextValue = "scopeVisualizerTreeItem";
   }
 }
diff --git a/packages/cursorless-vscode/src/commands.ts b/packages/cursorless-vscode/src/commands.ts
@@ -1,7 +1,20 @@
+import { CURSORLESS_ORG_URL, DOCS_URL } from "@cursorless/common";
 import * as vscode from "vscode";
 
-export const showDocumentation = () =>
-  vscode.env.openExternal(vscode.Uri.parse("https://www.cursorless.org/docs/"));
+export const showDocumentation = () => {
+  return vscode.env.openExternal(vscode.Uri.parse(DOCS_URL));
+};
 
-export const showQuickPick = () =>
-  vscode.commands.executeCommand("workbench.action.quickOpen", ">Cursorless");
+export const showScopeVisualizerItemDocumentation = (item?: {
+  url: string;
+}) => {
+  const url = item?.url ?? CURSORLESS_ORG_URL;
+  return vscode.env.openExternal(vscode.Uri.parse(url));
+};
+
+export const showQuickPick = () => {
+  return vscode.commands.executeCommand(
+    "workbench.action.quickOpen",
+    ">Cursorless",
+  );
+};
diff --git a/packages/cursorless-vscode/src/ide/vscode/VSCodeScopeVisualizer/VscodeScopeVisualizer.ts b/packages/cursorless-vscode/src/ide/vscode/VSCodeScopeVisualizer/VscodeScopeVisualizer.ts
@@ -5,7 +5,7 @@ import type {
   ScopeType,
   TextEditor,
 } from "@cursorless/common";
-import { ScopeSupport, showError } from "@cursorless/common";
+import { DOCS_URL, ScopeSupport, showError } from "@cursorless/common";
 import type {
   ScopeRangeType,
   ScopeVisualizerColorConfig,
@@ -67,7 +67,7 @@ export abstract class VscodeScopeVisualizer {
         void showError(
           this.ide.messages,
           "ScopeVisualizer.scopeTypeNotSupported",
-          `Scope type not supported for ${editor.document.languageId}, or only defined using legacy API which doesn't support visualization.  See https://www.cursorless.org/docs/contributing/adding-a-new-language/ for more about how to upgrade your language.`,
+          `Scope type not supported for ${editor.document.languageId}, or only defined using legacy API which doesn't support visualization.  See ${DOCS_URL}/contributing/adding-a-new-language for more about how to upgrade your language.`,
         );
     }
   }
diff --git a/packages/cursorless-vscode/src/registerCommands.ts b/packages/cursorless-vscode/src/registerCommands.ts
@@ -21,7 +21,11 @@ import type { InstallationDependencies } from "./InstallationDependencies";
 import type { ScopeVisualizer } from "./ScopeVisualizerCommandApi";
 import type { VscodeSnippets } from "./VscodeSnippets";
 import type { VscodeTutorial } from "./VscodeTutorial";
-import { showDocumentation, showQuickPick } from "./commands";
+import {
+  showDocumentation,
+  showQuickPick,
+  showScopeVisualizerItemDocumentation,
+} from "./commands";
 import type { VscodeIDE } from "./ide/vscode/VscodeIDE";
 import type { VscodeHats } from "./ide/vscode/hats/VscodeHats";
 import type { KeyboardCommands } from "./keyboard/KeyboardCommands";
@@ -100,9 +104,8 @@ export function registerCommands(
     // Scope visualizer
     ["cursorless.showScopeVisualizer"]: scopeVisualizer.start,
     ["cursorless.hideScopeVisualizer"]: scopeVisualizer.stop,
-    ["cursorless.scopeVisualizer.openUrl"]: (item) => {
-      return vscode.env.openExternal(vscode.Uri.parse(item.url));
-    },
+    ["cursorless.scopeVisualizer.openUrl"]:
+      showScopeVisualizerItemDocumentation,
 
     // Command history
     ["cursorless.analyzeCommandHistory"]: () =>
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export const CURSORLESS_ORG_URL = "https://www.cursorless.org";`
	`2`	+export const DOCS_URL = `${CURSORLESS_ORG_URL}/docs`;
	`3`	`+export const GITHUB_URL = "https://github.com/cursorless-dev/cursorless";`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+export * from "./constants";`
`1`	`2`	`export * from "./cursorlessCommandIds";`
`2`	`3`	`export * from "./cursorlessSideBarIds";`
`3`	`4`	`export * from "./Debouncer";`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,9 @@`
`23`	`23`	`"references": [`
`24`	`24`	`{`
`25`	`25`	`"path": "../cheatsheet"`
	`26`	`+ },`
	`27`	`+ {`
	`28`	`+ "path": "../common"`
`26`	`29`	`}`
`27`	`30`	`],`
`28`	`31`	`"exclude": ["node_modules"]`