Merge branch 'grammar_test' of github.com:cursorless-dev/cursorless into grammar_test

Author: AndreasArvidsson

packages/common/src/errors.ts

@@ -36,3 +36,15 @@ export class NoContainingScopeError extends Error {
     this.name = "NoContainingScopeError";
   }
 }
+
+export class NoSpokenFormError extends Error {
+  constructor(type: string) {
+    super(`No spoken form for: ${type}`);
+  }
+}
+
+export class AmbiguousSpokenFormError extends Error {
+  constructor(type: string) {
+    super(`Ambiguous spoken form for: ${type}`);
+  }
+}

packages/common/src/index.ts

@@ -86,3 +86,10 @@ export * from "./getFakeCommandServerApi";
 export * from "./types/TestCaseFixture";
 export * from "./util/getEnvironmentVariableStrict";
 export * from "./util/CompositeKeyDefaultMap";
+export * from "./spokenForms/actions";
+export * from "./spokenForms/characters";
+export * from "./spokenForms/connectives";
+export * from "./spokenForms/marks";
+export * from "./spokenForms/modifiers";
+export * from "./spokenForms/numbers";
+export * from "./spokenForms/snippets";

packages/common/src/spokenForms/actions.ts

@@ -0,0 +1,74 @@
+import { ActionType } from "..";
+
+const actions: Record<ActionType, string | null> = {
+  scrollToBottom: "bottom",
+  toggleLineBreakpoint: "break point",
+  cutToClipboard: "carve",
+  scrollToCenter: "center",
+  clearAndSetSelection: "change",
+  remove: "chuck",
+  insertCopyBefore: "clone up",
+  insertCopyAfter: "clone",
+  toggleLineComment: "comment",
+  copyToClipboard: "copy",
+  scrollToTop: "crown",
+  outdentLine: "dedent",
+  revealDefinition: "define",
+  editNewLineBefore: "drink",
+  insertEmptyLineBefore: "drop",
+  extractVariable: "extract",
+  insertEmptyLineAfter: "float",
+  foldRegion: "fold",
+  followLink: "follow",
+  deselect: "give",
+  highlight: "highlight",
+  showHover: "hover",
+  indentLine: "indent",
+  showDebugHover: "inspect",
+  setSelectionAfter: "post",
+  editNewLineAfter: "pour",
+  setSelectionBefore: "pre",
+  insertEmptyLinesAround: "puff",
+  showQuickFix: "quick fix",
+  showReferences: "reference",
+  rename: "rename",
+  reverseTargets: "reverse",
+  findInWorkspace: "scout all",
+  randomizeTargets: "shuffle",
+  generateSnippet: "snippet make",
+  sortTargets: "sort",
+  setSelection: "take",
+  revealTypeDefinition: "type deaf",
+  unfoldRegion: "unfold",
+  callAsFunction: "call",
+  swapTargets: "swap",
+  replaceWithTarget: "bring",
+  moveToTarget: "move",
+  wrapWithPairedDelimiter: "wrap",
+  wrapWithSnippet: "wrap",
+  rewrapWithPairedDelimiter: "repack",
+  insertSnippet: "snippet",
+  pasteFromClipboard: "paste",
+
+  ["experimental.setInstanceReference"]: "from",
+
+  editNew: null,
+  executeCommand: null,
+  getText: null,
+  replace: null,
+
+  // applyFormatter: "format",
+  // findInDocument: "scout",
+  // nextHomophone: "phones",
+};
+
+export function actionToSpokenForm(name: ActionType): string {
+  if (name === "wrapWithSnippet") {
+    name = "wrapWithPairedDelimiter";
+  }
+  const result = actions[name];
+  if (result == null) {
+    throw Error(`Unknown action '${name}'`);
+  }
+  return result;
+}

packages/common/src/spokenForms/characters.ts

@@ -0,0 +1,73 @@
+/* eslint-disable @typescript-eslint/naming-convention */
+
+import { NoSpokenFormError } from "..";
+
+// https://github.com/talonhub/community/blob/9acb6c9659bb0c9b794a7b7126d025603b4ed726/core/keys/keys.py
+
+const alphabet =
+  "air bat cap drum each fine gust harp sit jury crunch look made near odd pit quench red sun trap urge vest whale plex yank zip"
+    .split(" ")
+    .reduce<Record<string, string>>((result, phrase, index) => {
+      const letter = String.fromCharCode("a".charCodeAt(0) + index);
+      result[letter] = phrase;
+      return result;
+    }, {});
+
+const digits = "zero one two three four five six seven eight nine"
+  .split(" ")
+  .reduce<Record<string, string>>((result, phrase, index) => {
+    result[index.toString()] = phrase;
+    return result;
+  }, {});
+
+const symbols = {
+  ".": "dot",
+  ",": "comma",
+  ";": "semicolon",
+  ":": "colon",
+  "!": "bang",
+  "*": "asterisk",
+  "@": "at sign",
+  "&": "ampersand",
+  "?": "question",
+  "/": "slash",
+  "\\": "backslash",
+  "-": "dash",
+  "=": "equals",
+  "+": "plus",
+  "~": "tilde",
+  _: "underscore",
+  "#": "hash",
+  "%": "percent",
+  "^": "caret",
+  "|": "pipe",
+  $: "dollar",
+  "£": "pound",
+
+  "'": "quote",
+  '"': "double quote",
+  "`": "back tick",
+
+  "(": "paren",
+  ")": "right paren",
+  "{": "brace",
+  "}": "right brace",
+  "[": "square",
+  "]": "right square",
+  "<": "angle",
+  ">": "right angle",
+};
+
+const characters: Record<string, string> = {
+  ...alphabet,
+  ...digits,
+  ...symbols,
+};
+
+export function characterToSpokenForm(char: string): string {
+  const result = characters[char];
+  if (result == null) {
+    throw new NoSpokenFormError(`Unknown character '${char}'`);
+  }
+  return result;
+}

packages/common/src/spokenForms/connectives.ts

@@ -0,0 +1,17 @@
+export const connectives = {
+  rangeExclusive: "between",
+  rangeInclusive: "past",
+  // "rangeExcludingStart": "-",
+  rangeExcludingEnd: "until",
+  listConnective: "and",
+  swapConnective: "with",
+  sourceDestinationConnective: "to",
+  before: "before",
+  after: "after",
+  verticalRange: "slice",
+
+  previous: "previous",
+  next: "next",
+  forward: "forward",
+  backward: "backward",
+};

packages/common/src/spokenForms/marks.ts

@@ -0,0 +1,61 @@
+const hatColors: Record<string, string> = {
+  blue: "blue",
+  green: "green",
+  red: "red",
+  pink: "pink",
+  yellow: "yellow",
+  userColor1: "navy",
+  userColor2: "apricot",
+};
+
+const hatShapes: Record<string, string> = {
+  ex: "ex",
+  fox: "fox",
+  wing: "wing",
+  hole: "hole",
+  frame: "frame",
+  curve: "curve",
+  eye: "eye",
+  play: "play",
+  crosshairs: "cross",
+  bolt: "bolt",
+};
+
+const marks: Record<string, string | null> = {
+  cursor: "this",
+  that: "that",
+  source: "source",
+  nothing: "nothing",
+
+  explicit: null,
+};
+
+export const lineDirections = {
+  modulo100: "row",
+  relativeUp: "up",
+  relativeDown: "down",
+};
+
+export function hatColorToSpokenForm(color: string): string {
+  const result = hatColors[color];
+  if (result == null) {
+    throw Error(`Unknown hat color '${color}'`);
+  }
+  return result;
+}
+
+export function hatShapeToSpokenForm(shape: string): string {
+  const result = hatShapes[shape];
+  if (result == null) {
+    throw Error(`Unknown hat shape '${shape}'`);
+  }
+  return result;
+}
+
+export function markTypeToSpokenForm(mark: string): string {
+  const result = marks[mark];
+  if (result == null) {
+    throw Error(`Unknown mark '${mark}'`);
+  }
+  return result;
+}