Jetbrains cursorless support

packages/cursorless-jetbrains/TERMINOLOGY.md

@@ -0,0 +1,4 @@
+# TextEditor/TextDocument vs Project/Editor
+
+1. Each Cursorless "TextDocument" corresponds to a Jetbrains "Editor" tab
+2. There is no specific handling of projects

packages/cursorless-jetbrains/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@cursorless/cursorless-jetbrains",
+  "version": "1.0.0",
+  "description": "cursorless in jetbrains",
+  "main": "./out/cursorless.js",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "build": "pnpm run esbuild:prod && pnpm run populate-dist",
+    "compile": "tsc --build",
+    "esbuild:base": "esbuild ./src/index.ts --format=esm --target=es2020 --conditions=cursorless:bundler --bundle --main-fields=main,module --outfile=./out/cursorless.js --platform=neutral --external:std --external:fs --external:path",
+    "esbuild": "pnpm run esbuild:base --sourcemap",
+    "esbuild:prod": "pnpm run esbuild:base --minify",
+    "populate-dist": "bash ./scripts/populate-dist.sh",
+    "populate-dist:prod": "bash ./scripts/populate-dist.sh",
+    "watch:tsc": "pnpm compile --watch",
+    "watch:esbuild": "pnpm esbuild --watch",
+    "watch": "pnpm run --filter @cursorless/cursorless-jetbrains --parallel '/^watch:.*/'",
+    "clean": "rm -rf ./out tsconfig.tsbuildinfo ./dist ./build"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "types": "./out/index.d.ts",
+  "exports": {
+    ".": {
+      "cursorless:bundler": "./src/index.ts",
+      "default": "./out/index.cjs"
+    }
+  },
+  "dependencies": {
+    "@cursorless/common": "workspace:*",
+    "@cursorless/cursorless-engine": "workspace:*",
+    "@cursorless/test-case-recorder": "workspace:*",
+    "lodash-es": "^4.17.21",
+    "vscode-uri": "^3.0.8",
+    "web-tree-sitter": "0.24.4"
+  },
+  "devDependencies": {
+    "@types/chai": "^5.0.0",
+    "@types/lodash-es": "4.17.12"
+  }
+}

packages/cursorless-jetbrains/scripts/buildLocal.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+npm run compile && npm run esbuild
+
+cp out/cursorless.js ../../../cursorless-jetbrains/src/main/resources/cursorless/

packages/cursorless-jetbrains/scripts/populate-dist.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+echo "Populating dist directory..."
+
+echo "Nothing to do yet..."

packages/cursorless-jetbrains/src/extension.ts

@@ -0,0 +1,34 @@
+import type { CursorlessEngine } from "@cursorless/cursorless-engine";
+import { createCursorlessEngine } from "@cursorless/cursorless-engine";
+import type { JetbrainsPlugin } from "./ide/JetbrainsPlugin";
+import Parser from "web-tree-sitter";
+import { JetbrainsTreeSitter } from "./ide/JetbrainsTreeSitter";
+import { JetbrainsTreeSitterQueryProvider } from "./ide/JetbrainsTreeSitterQueryProvider";
+import { pathJoin } from "./ide/pathJoin";
+import { JetbrainsCommandServer } from "./ide/JetbrainsCommandServer";
+
+export async function activate(
+  plugin: JetbrainsPlugin,
+  wasmDirectory: string,
+): Promise<CursorlessEngine> {
+  console.log("activate started");
+  await Parser.init({
+    locateFile(scriptName: string, _scriptDirectory: string) {
+      const fullPath = pathJoin(wasmDirectory, scriptName);
+      return fullPath;
+    },
+  });
+  console.log("Parser initialized");
+
+  const commandServerApi = new JetbrainsCommandServer(plugin.client);
+  const queryProvider = new JetbrainsTreeSitterQueryProvider(plugin.ide);
+  const engine = await createCursorlessEngine({
+    ide: plugin.ide,
+    hats: plugin.hats,
+    treeSitterQueryProvider: queryProvider,
+    treeSitter: new JetbrainsTreeSitter(wasmDirectory),
+    commandServerApi: commandServerApi,
+  });
+  console.log("activate completed");
+  return engine;
+}

packages/cursorless-jetbrains/src/ide/JetbrainsCapabilities.ts

@@ -0,0 +1,25 @@
+import type { Capabilities, CommandCapabilityMap } from "@cursorless/common";
+
+const COMMAND_CAPABILITIES: CommandCapabilityMap = {
+  clipboardCopy: { acceptsLocation: true },
+  clipboardPaste: true,
+  toggleLineComment: { acceptsLocation: true },
+  indentLine: { acceptsLocation: true },
+  outdentLine: { acceptsLocation: true },
+  rename: { acceptsLocation: true },
+  quickFix: { acceptsLocation: true },
+  revealDefinition: { acceptsLocation: true },
+  revealTypeDefinition: { acceptsLocation: true },
+  showHover: undefined,
+  showDebugHover: undefined,
+  extractVariable: { acceptsLocation: true },
+  fold: { acceptsLocation: true },
+  highlight: { acceptsLocation: true },
+  unfold: { acceptsLocation: true },
+  showReferences: { acceptsLocation: true },
+  insertLineAfter: { acceptsLocation: true },
+};
+
+export class JetbrainsCapabilities implements Capabilities {
+  commands = COMMAND_CAPABILITIES;
+}

packages/cursorless-jetbrains/src/ide/JetbrainsClient.ts

@@ -0,0 +1,14 @@
+export interface JetbrainsClient {
+  prePhraseVersion(): string | PromiseLike<string | null> | null;
+  clipboardCopy(editorId: string, rangesJson: string): void;
+  clipboardPaste(editorId: string): void;
+  hatsUpdated(hatsJson: string): void;
+  documentUpdated(editorId: string, updateJson: string): void;
+  setSelection(editorId: string, selectionJson: string): void;
+  executeCommand(editorId: string, command: string, jsonArgs: string): string;
+  executeRangeCommand(editorId: string, commandJson: string): string;
+  insertLineAfter(editorId: string, rangesJson: string): void;
+  revealLine(editorId: string, line: number, revealAt: string): void;
+  readQuery(filename: string): string | undefined;
+  flashRanges(flashRangesJson: string): string | undefined;
+}

packages/cursorless-jetbrains/src/ide/JetbrainsClipboard.ts

@@ -0,0 +1,23 @@
+import type { Clipboard, Range } from "@cursorless/common";
+import type { JetbrainsClient } from "./JetbrainsClient";
+
+export class JetbrainsClipboard implements Clipboard {
+  constructor(private client: JetbrainsClient) {}
+
+  async readText(): Promise<string> {
+    return "";
+  }
+
+  async writeText(_value: string): Promise<void> {
+    return;
+  }
+
+  async copy(editorId: string, ranges: Range[]): Promise<void> {
+    const rangesJson = JSON.stringify(ranges);
+    this.client.clipboardCopy(editorId, rangesJson);
+  }
+
+  async paste(editorId: string): Promise<void> {
+    this.client.clipboardPaste(editorId);
+  }
+}

packages/cursorless-jetbrains/src/ide/JetbrainsCommandServer.ts

@@ -0,0 +1,25 @@
+import type { JetbrainsClient } from "./JetbrainsClient";
+import type {
+  CommandServerApi,
+  FocusedElementType,
+  InboundSignal,
+} from "@cursorless/common";
+
+export class JetbrainsCommandServer implements CommandServerApi {
+  private client!: JetbrainsClient;
+  readonly signals: { prePhrase: InboundSignal } = {
+    prePhrase: {
+      getVersion: async () => {
+        return this.client.prePhraseVersion();
+      },
+    },
+  };
+
+  constructor(client: JetbrainsClient) {
+    this.client = client;
+  }
+
+  getFocusedElementType(): Promise<FocusedElementType | undefined> {
+    return Promise.resolve(undefined);
+  }
+}

packages/cursorless-jetbrains/src/ide/JetbrainsConfiguration.ts

@@ -0,0 +1,42 @@
+import type {
+  Configuration,
+  ConfigurationScope,
+  CursorlessConfiguration,
+} from "@cursorless/common";
+import { CONFIGURATION_DEFAULTS } from "@cursorless/common";
+import type { GetFieldType, Paths } from "@cursorless/common";
+import { Notifier } from "@cursorless/common";
+import { get } from "lodash-es";
+
+export class JetbrainsConfiguration implements Configuration {
+  private notifier = new Notifier();
+  private configuration: CursorlessConfiguration = CONFIGURATION_DEFAULTS;
+
+  constructor(configuration: CursorlessConfiguration) {
+    this.configuration = configuration;
+  }
+
+  getOwnConfiguration<Path extends Paths<CursorlessConfiguration>>(
+    path: Path,
+    _scope?: ConfigurationScope,
+  ): GetFieldType<CursorlessConfiguration, Path> {
+    return get(this.configuration, path) as GetFieldType<
+      CursorlessConfiguration,
+      Path
+    >;
+  }
+
+  onDidChangeConfiguration = this.notifier.registerListener;
+
+  updateConfiguration(configuration: CursorlessConfiguration) {
+    this.configuration = configuration;
+    this.notifier.notifyListeners();
+  }
+}
+
+export function createJetbrainsConfiguration(
+  configuration: CursorlessConfiguration,
+): JetbrainsConfiguration {
+  return new JetbrainsConfiguration(configuration);
+}
+