Added increment and decrement actions (#2236)

Fixes #2192

## Checklist

- [x] I have added
[tests](https://www.cursorless.org/docs/contributing/test-case-recorder/)
- [x] 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)
- [x] I have not broken the cheatsheet

---------

Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com>

changelog/2024-02-addedIncrementAndDecrementActions.md

@@ -0,0 +1,8 @@
+---
+tags: [enhancement]
+pullRequest: 2236
+---
+
+- Added increment action. Will increment a number. eg `"increment this"` to change `1` to `2`.
+
+- Added decrement action. Will decrement a number. eg `"decrement this"` to change `2` to `1`.

cursorless-talon/src/spoken_forms.json

@@ -14,6 +14,7 @@
       "comment": "toggleLineComment",
       "copy": "copyToClipboard",
       "crown": "scrollToTop",
+      "decrement": "decrement",
       "dedent": "outdentLine",
       "define": "revealDefinition",
       "drink": "editNewLineBefore",
@@ -25,6 +26,7 @@
       "give": "deselect",
       "highlight": "highlight",
       "hover": "showHover",
+      "increment": "increment",
       "indent": "indentLine",
       "inspect": "showDebugHover",
       "join": "joinLines",

docs/user/README.md

@@ -584,6 +584,11 @@ For example:
 - `"indent air"`
 - `"dedent funk bat"`
 
+### Increment / decrement
+
+- `"increment <TARGET>"`: increment number target. eg change `1` to `2`.
+- `"decrement <TARGET>"`: decrement number target. eg change `2` to `1`.
+
 ### Insert empty lines
 
 - `"drink <TARGET>"`: Inserts a new line above the target line, and moves the cursor to the newly created line

packages/common/src/types/command/ActionDescriptor.ts

@@ -12,6 +12,7 @@ const simpleActionNames = [
   "clearAndSetSelection",
   "copyToClipboard",
   "cutToClipboard",
+  "decrement",
   "deselect",
   "editNewLineAfter",
   "editNewLineBefore",
@@ -21,6 +22,7 @@ const simpleActionNames = [
   "findInWorkspace",
   "foldRegion",
   "followLink",
+  "increment",
   "indentLine",
   "insertCopyAfter",
   "insertCopyBefore",

packages/cursorless-engine/src/CommandHistory.ts

@@ -144,6 +144,7 @@ function sanitizeActionInPlace(action: ActionDescriptor): void {
     case "clearAndSetSelection":
     case "copyToClipboard":
     case "cutToClipboard":
+    case "decrement":
     case "deselect":
     case "editNewLineAfter":
     case "editNewLineBefore":
@@ -152,6 +153,7 @@ function sanitizeActionInPlace(action: ActionDescriptor): void {
     case "findInWorkspace":
     case "foldRegion":
     case "followLink":
+    case "increment":
     case "indentLine":
     case "insertCopyAfter":
     case "insertCopyBefore":

packages/cursorless-engine/src/actions/Actions.ts

@@ -33,12 +33,12 @@ import Remove from "./Remove";
 import Replace from "./Replace";
 import Rewrap from "./Rewrap";
 import { ScrollToBottom, ScrollToCenter, ScrollToTop } from "./Scroll";
-import { SetSpecialTarget } from "./SetSpecialTarget";
 import {
   SetSelection,
   SetSelectionAfter,
   SetSelectionBefore,
 } from "./SetSelection";
+import { SetSpecialTarget } from "./SetSpecialTarget";
 import ShowParseTree from "./ShowParseTree";
 import {
   CopyToClipboard,
@@ -61,6 +61,7 @@ import ToggleBreakpoint from "./ToggleBreakpoint";
 import Wrap from "./Wrap";
 import WrapWithSnippet from "./WrapWithSnippet";
 import { ActionRecord } from "./actions.types";
+import { Decrement, Increment } from "./incrementDecrement";
 
 /**
  * Keeps a map from action names to objects that implement the given action
@@ -77,6 +78,7 @@ export class Actions implements ActionRecord {
   clearAndSetSelection = new Clear(this);
   copyToClipboard = new CopyToClipboard(this.rangeUpdater);
   cutToClipboard = new CutToClipboard(this);
+  decrement = new Decrement(this);
   deselect = new Deselect();
   editNew = new EditNew(this.rangeUpdater, this);
   editNewLineAfter: EditNewAfter = new EditNewAfter(
@@ -96,6 +98,7 @@ export class Actions implements ActionRecord {
   generateSnippet = new GenerateSnippet();
   getText = new GetText();
   highlight = new Highlight();
+  increment = new Increment(this);
   indentLine = new IndentLine(this.rangeUpdater);
   insertCopyAfter = new InsertCopyAfter(
     this.rangeUpdater,

packages/cursorless-engine/src/actions/incrementDecrement.ts

@@ -0,0 +1,110 @@
+import { Range, TextEditor } from "@cursorless/common";
+import { PlainTarget } from "../processTargets/targets";
+import { SelectionWithEditor } from "../typings/Types";
+import { Destination, Target } from "../typings/target.types";
+import { MatchedText, matchText } from "../util/regex";
+import { runForEachEditor } from "../util/targetUtils";
+import { Actions } from "./Actions";
+import { ActionReturnValue } from "./actions.types";
+
+const REGEX = /-?\d+(\.\d+)?/g;
+
+class IncrementDecrement {
+  constructor(
+    private actions: Actions,
+    private isIncrement: boolean,
+  ) {
+    this.run = this.run.bind(this);
+  }
+
+  async run(targets: Target[]): Promise<ActionReturnValue> {
+    const thatSelections: SelectionWithEditor[] = [];
+
+    await runForEachEditor(
+      targets,
+      (target) => target.editor,
+      async (editor, targets) => {
+        const selections = await this.runOnEditor(editor, targets);
+        thatSelections.push(...selections);
+      },
+    );
+
+    return { thatSelections };
+  }
+
+  private async runOnEditor(
+    editor: TextEditor,
+    targets: Target[],
+  ): Promise<SelectionWithEditor[]> {
+    const { document } = editor;
+    const destinations: Destination[] = [];
+    const replaceWith: string[] = [];
+
+    for (const target of targets) {
+      const offset = document.offsetAt(target.contentRange.start);
+      const text = target.contentText;
+      const matches = matchText(text, REGEX);
+
+      for (const match of matches) {
+        destinations.push(createDestination(editor, offset, match));
+        replaceWith.push(updateNumber(this.isIncrement, match.text));
+      }
+    }
+
+    const { thatSelections } = await this.actions.replace.run(
+      destinations,
+      replaceWith,
+    );
+
+    return thatSelections!;
+  }
+}
+
+export class Increment extends IncrementDecrement {
+  constructor(actions: Actions) {
+    super(actions, true);
+  }
+}
+
+export class Decrement extends IncrementDecrement {
+  constructor(actions: Actions) {
+    super(actions, false);
+  }
+}
+
+function createDestination(
+  editor: TextEditor,
+  offset: number,
+  match: MatchedText,
+): Destination {
+  const target = new PlainTarget({
+    editor,
+    isReversed: false,
+    contentRange: new Range(
+      editor.document.positionAt(offset + match.index),
+      editor.document.positionAt(offset + match.index + match.text.length),
+    ),
+  });
+  return target.toDestination("to");
+}
+
+function updateNumber(isIncrement: boolean, text: string): string {
+  return text.includes(".")
+    ? updateFloat(isIncrement, text).toString()
+    : updateInteger(isIncrement, text).toString();
+}
+
+function updateInteger(isIncrement: boolean, text: string): number {
+  const original = parseInt(text);
+  const diff = 1;
+  return original + (isIncrement ? diff : -diff);
+}
+
+function updateFloat(isIncrement: boolean, text: string): number {
+  const original = parseFloat(text);
+  const isPercentage = Math.abs(original) <= 1.0;
+  const diff = isPercentage ? 0.1 : 1;
+  const updated = original + (isIncrement ? diff : -diff);
+  // Remove precision problems that would add a lot of extra digits
+  return parseFloat(updated.toPrecision(15)) / 1;
+}

packages/cursorless-engine/src/generateSpokenForm/defaultSpokenForms/actions.ts

@@ -28,6 +28,8 @@ export const actions = {
   deselect: "give",
   highlight: "highlight",
   showHover: "hover",
+  increment: "increment",
+  decrement: "decrement",
   indentLine: "indent",
   showDebugHover: "inspect",
   setSelectionAfter: "post",

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/actions/decrementFile.yml

@@ -0,0 +1,162 @@
+languageId: plaintext
+command:
+  version: 6
+  spokenForm: decrement file
+  action:
+    name: decrement
+    target:
+      type: primitive
+      modifiers:
+        - type: containingScope
+          scopeType: {type: document}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: |-
+    foo
+
+    0
+    1
+    0.5
+    1.5
+
+    -0
+    -1
+    -0.5
+    -1.5
+
+    0rem
+    1rem
+    0.5rem
+    1.5rem
+
+    -0rem
+    -1rem
+    -0.5rem
+    -1.5rem
+  selections:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}
+  marks: {}
+finalState:
+  documentContents: |-
+    foo
+
+    -1
+    0
+    0.4
+    0.5
+
+    -1
+    -2
+    -0.6
+    -2.5
+
+    -1rem
+    0rem
+    0.4rem
+    0.5rem
+
+    -1rem
+    -2rem
+    -0.6rem
+    -2.5rem
+  selections:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}
+  thatMark:
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 2, character: 0}
+        end: {line: 2, character: 2}
+      isReversed: false
+      hasExplicitRange: true
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 3, character: 0}
+        end: {line: 3, character: 1}
+      isReversed: false
+      hasExplicitRange: true
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 4, character: 0}
+        end: {line: 4, character: 3}
+      isReversed: false
+      hasExplicitRange: true
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 5, character: 0}
+        end: {line: 5, character: 3}
+      isReversed: false
+      hasExplicitRange: true
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 7, character: 0}
+        end: {line: 7, character: 2}
+      isReversed: false
+      hasExplicitRange: true
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 8, character: 0}
+        end: {line: 8, character: 2}
+      isReversed: false
+      hasExplicitRange: true
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 9, character: 0}
+        end: {line: 9, character: 4}
+      isReversed: false
+      hasExplicitRange: true
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 10, character: 0}
+        end: {line: 10, character: 4}
+      isReversed: false
+      hasExplicitRange: true
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 12, character: 0}
+        end: {line: 12, character: 2}
+      isReversed: false
+      hasExplicitRange: true
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 13, character: 0}
+        end: {line: 13, character: 1}
+      isReversed: false
+      hasExplicitRange: true
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 14, character: 0}
+        end: {line: 14, character: 3}
+      isReversed: false
+      hasExplicitRange: true
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 15, character: 0}
+        end: {line: 15, character: 3}
+      isReversed: false
+      hasExplicitRange: true
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 17, character: 0}
+        end: {line: 17, character: 2}
+      isReversed: false
+      hasExplicitRange: true
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 18, character: 0}
+        end: {line: 18, character: 2}
+      isReversed: false
+      hasExplicitRange: true
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 19, character: 0}
+        end: {line: 19, character: 4}
+      isReversed: false
+      hasExplicitRange: true
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 20, character: 0}
+        end: {line: 20, character: 4}
+      isReversed: false
+      hasExplicitRange: true