Extract cheatsheet into separate package (#2482)

## Checklist

- [/] I have added
[tests](https://www.cursorless.org/docs/contributing/test-case-recorder/)
- [/] I have updated the
[docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and
[cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet)
- [/] I have not broken the cheatsheet

Author: AndreasArvidsson

packages/cursorless-cheatsheet/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@cursorless/cursorless-cheatsheet",
+  "version": "0.1.0",
+  "description": "Cursorless cheatsheet implementation",
+  "type": "module",
+  "main": "./out/index.js",
+  "types": "./out/index.d.ts",
+  "scripts": {
+    "compile:tsc": "tsc --build",
+    "compile:esbuild": "esbuild ./src/index.ts --sourcemap --format=esm --bundle --packages=external --outfile=./out/index.js",
+    "compile": "pnpm compile:tsc && pnpm compile:esbuild",
+    "watch:tsc": "pnpm compile:tsc --watch",
+    "watch:esbuild": "pnpm compile:esbuild --watch",
+    "watch": "pnpm run --filter @cursorless/cursorless-cheatsheet --parallel '/^watch:.*/'",
+    "clean": "rm -rf ./out tsconfig.tsbuildinfo ./dist ./build"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "exports": {
+    ".": {
+      "cursorless:bundler": "./src/index.ts",
+      "default": "./out/index.js"
+    }
+  },
+  "dependencies": {
+    "@cursorless/common": "workspace:*",
+    "immer": "^10.0.4",
+    "lodash-es": "^4.17.21",
+    "node-html-parser": "^6.1.12"
+  },
+  "devDependencies": {
+    "@types/lodash-es": "4.17.0"
+  }
+}

packages/cursorless-engine/src/core/Cheatsheet.ts renamed to packages/cursorless-cheatsheet/src/Cheatsheet.ts

@@ -1,10 +1,9 @@
+import { getCursorlessRepoRoot, type IDE } from "@cursorless/common";
 import { readFile, writeFile } from "fs/promises";
-import { parse } from "node-html-parser";
-import { sortBy } from "lodash-es";
-import { ide } from "../singletons/ide.singleton";
-import path from "path";
-import { getCursorlessRepoRoot } from "@cursorless/common";
 import { produce } from "immer";
+import { sortBy } from "lodash-es";
+import { parse } from "node-html-parser";
+import * as path from "path";
 
 /**
  * The argument expected by the cheatsheet command.
@@ -27,16 +26,15 @@ interface CheatSheetCommandArg {
   outputPath: string;
 }
 
-export async function showCheatsheet({
-  version,
-  spokenFormInfo,
-  outputPath,
-}: CheatSheetCommandArg) {
+export async function showCheatsheet(
+  ide: IDE,
+  { version, spokenFormInfo, outputPath }: CheatSheetCommandArg,
+) {
   if (version !== 0) {
     throw new Error(`Unsupported cheatsheet api version: ${version}`);
   }
 
-  const cheatsheetPath = path.join(ide().assetsRoot, "cheatsheet.html");
+  const cheatsheetPath = path.join(ide.assetsRoot, "cheatsheet.html");
 
   const cheatsheetContent = (await readFile(cheatsheetPath)).toString();
 

packages/cursorless-cheatsheet/src/index.ts

@@ -0,0 +1 @@
+export * from "./Cheatsheet";

packages/cursorless-cheatsheet/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "out",
+    "rootDir": "src"
+  },
+  "include": ["src/**/*.ts", "src/**/*.json", "../../typings/**/*.d.ts"],
+  "references": [
+    {
+      "path": "../common"
+    }
+  ]
+}

packages/cursorless-engine/package.json

@@ -29,7 +29,6 @@
     "lodash-es": "^4.17.21",
     "moo": "0.5.2",
     "nearley": "2.20.1",
-    "node-html-parser": "^6.1.12",
     "sbd": "^1.0.19",
     "uuid": "^9.0.1",
     "zod": "3.22.4"

packages/cursorless-engine/src/index.ts

@@ -1,5 +1,4 @@
 export * from "./testUtil/plainObjectToTarget";
-export * from "./core/Cheatsheet";
 export * from "./testUtil/takeSnapshot";
 export * from "./testCaseRecorder/TestCaseRecorder";
 export * from "./core/StoredTargets";

packages/cursorless-vscode/package.json

@@ -1240,6 +1240,7 @@
   },
   "dependencies": {
     "@cursorless/common": "workspace:*",
+    "@cursorless/cursorless-cheatsheet": "workspace:*",
     "@cursorless/cursorless-engine": "workspace:*",
     "@cursorless/file-system-common": "workspace:*",
     "@cursorless/vscode-common": "workspace:*",

packages/cursorless-vscode/src/registerCommands.ts

@@ -4,13 +4,15 @@ import {
   isTesting,
   type CommandHistoryStorage,
 } from "@cursorless/common";
+import {
+  showCheatsheet,
+  updateDefaults,
+} from "@cursorless/cursorless-cheatsheet";
 import {
   CommandApi,
   StoredTargetMap,
   TestCaseRecorder,
   analyzeCommandHistory,
-  showCheatsheet,
-  updateDefaults,
   type ScopeTestRecorder,
 } from "@cursorless/cursorless-engine";
 import * as vscode from "vscode";
@@ -57,7 +59,7 @@ export function registerCommands(
     },
 
     // Cheatsheet commands
-    ["cursorless.showCheatsheet"]: showCheatsheet,
+    ["cursorless.showCheatsheet"]: (arg) => showCheatsheet(vscodeIde, arg),
     ["cursorless.internal.updateCheatsheetDefaults"]: updateDefaults,
 
     // Testcase recorder commands

packages/cursorless-vscode/tsconfig.json

@@ -10,6 +10,9 @@
     {
       "path": "../common"
     },
+    {
+      "path": "../cursorless-cheatsheet"
+    },
     {
       "path": "../cursorless-engine"
     },