Add support for reference modifier

cursorless-talon/src/cheatsheet/sections/modifiers.py

@@ -60,6 +60,8 @@ def get_modifiers() -> list[ListItemDescriptor]:
             "trailing": "Trailing delimiter range",
             "start": "Empty position at start of target",
             "end": "Empty position at end of target",
+            "filename": "File name including extension",
+            "filenameWithoutExtension": "File name without extension",
         },
     )
 

cursorless-talon/src/modifiers/modifiers.py

@@ -33,6 +33,7 @@ def cursorless_simple_modifier(m) -> dict[str, str]:
     "<user.cursorless_interior_modifier>",  # inside
     "<user.cursorless_head_tail_modifier>",  # head, tail
     "<user.cursorless_position_modifier>",  # start of, end of
+    "<user.cursorless_reference_modifier>",  # reference formats
     *head_tail_swallowed_modifiers,
 ]
 

cursorless-talon/src/modifiers/reference.py

@@ -0,0 +1,89 @@
+from typing import Any
+
+from talon import Context, Module
+
+mod = Module()
+
+mod.list(
+    "cursorless_reference_modifier",
+    desc="Cursorless reference modifiers with snippet outputs",
+)
+
+
+REFERENCE_MODIFIER_DATA: dict[str, dict[str, Any]] = {
+    "relative": [
+        {
+            "body": "$relative",
+        },
+    ],
+    "absolute": [
+        {
+            "body": "$absolute",
+        },
+    ],
+    "remote": [
+        {
+            "body": "$remote",
+        },
+    ],
+    "remoteCanonical": [
+        {
+            "body": "$remoteCanonical",
+        },
+    ],
+    "relativeText": [
+        {
+            "body": " $relative (`$content`) ",
+            "lineMode": "singleLine",
+        },
+        {
+            "body": "\n\n$relative:\n\n```$languageId\n$content\n```\n\n",
+            "lineMode": "multiLine",
+        },
+    ],
+    "remoteText": [
+        {
+            "body": " $remote (`$content`) ",
+            "lineMode": "singleLine",
+        },
+        {
+            "body": "\n\n$remote:\n\n```$languageId\n$content\n```\n\n",
+            "lineMode": "multiLine",
+        },
+    ],
+    "remoteLink": [
+        {
+            "body": "[`$name`]($remote)",
+        },
+    ],
+    "relativeLink": [
+        {
+            "body": "[`$name`]($relative)",
+        },
+    ],
+}
+
+REFERENCE_SPOKEN_FORMS: dict[str, str] = {
+    "local": "relative",
+    "absolute": "absolute",
+    "remote": "remote",
+    "canonical": "remoteCanonical",
+    "local text": "relativeText",
+    "remote text": "remoteText",
+    "local link": "relativeLink",
+    "remote link": "remoteLink",
+}
+
+ctx = Context()
+ctx.lists["user.cursorless_reference_modifier"] = REFERENCE_SPOKEN_FORMS
+
+
+@mod.capture(rule="{user.cursorless_reference_modifier}")
+def cursorless_reference_modifier(m) -> dict[str, Any]:
+    """Reference modifier snippets"""
+    modifier_id = m.cursorless_reference_modifier
+    data = REFERENCE_MODIFIER_DATA[modifier_id]
+    return {
+        "type": "reference",
+        "snippets": data,
+    }

cursorless-talon/src/spoken_forms.json

@@ -90,7 +90,10 @@
       "content": "keepContentFilter",
       "empty": "keepEmptyFilter",
       "its": "inferPreviousMark",
-      "visible": "visible"
+      "visible": "visible",
+      "reference": "reference",
+      "file name": "filename",
+      "base": "filenameWithoutExtension"
     },
     "every_scope_modifier": { "every": "every" },
     "ancestor_scope_modifier": { "grand": "ancestor" },

data/fixtures/recorded/modifiers/bringBasename.yml

@@ -0,0 +1,37 @@
+languageId: plaintext
+command:
+  version: 7
+  spokenForm: bring basename
+  action:
+    name: replaceWithTarget
+    source:
+      type: primitive
+      modifiers:
+        - {type: filenameWithoutExtension}
+    destination: {type: implicit}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: ""
+  selections:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}
+  marks: {}
+finalState:
+  documentContents: Untitled-1
+  selections:
+    - anchor: {line: 0, character: 10}
+      active: {line: 0, character: 10}
+  thatMark:
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 0, character: 0}
+        end: {line: 0, character: 10}
+      isReversed: false
+      hasExplicitRange: true
+  sourceMark:
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 0, character: 10}
+        end: {line: 0, character: 10}
+      isReversed: false
+      hasExplicitRange: true

data/fixtures/recorded/modifiers/bringFilename.yml

@@ -0,0 +1,37 @@
+languageId: plaintext
+command:
+  version: 7
+  spokenForm: bring filename
+  action:
+    name: replaceWithTarget
+    source:
+      type: primitive
+      modifiers:
+        - {type: filename}
+    destination: {type: implicit}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: ""
+  selections:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}
+  marks: {}
+finalState:
+  documentContents: Untitled-1
+  selections:
+    - anchor: {line: 0, character: 10}
+      active: {line: 0, character: 10}
+  thatMark:
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 0, character: 0}
+        end: {line: 0, character: 10}
+      isReversed: false
+      hasExplicitRange: true
+  sourceMark:
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 0, character: 10}
+        end: {line: 0, character: 10}
+      isReversed: false
+      hasExplicitRange: true

data/fixtures/recorded/modifiers/bringReference.yml

@@ -0,0 +1,42 @@
+languageId: plaintext
+command:
+  version: 7
+  spokenForm: bring reference
+  action:
+    name: replaceWithTarget
+    source:
+      type: primitive
+      modifiers:
+        - {type: reference}
+    destination: {type: implicit}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: |+
+    aaa bbb ccc
+
+  selections:
+    - anchor: {line: 2, character: 0}
+      active: {line: 2, character: 0}
+  marks: {}
+finalState:
+  documentContents: |-
+    aaa bbb ccc
+
+    Untitled-1#L3
+  selections:
+    - anchor: {line: 2, character: 13}
+      active: {line: 2, character: 13}
+  thatMark:
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 2, character: 0}
+        end: {line: 2, character: 13}
+      isReversed: false
+      hasExplicitRange: true
+  sourceMark:
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 2, character: 13}
+        end: {line: 2, character: 13}
+      isReversed: false
+      hasExplicitRange: true

data/fixtures/recorded/modifiers/bringReferenceAir.yml

@@ -0,0 +1,46 @@
+languageId: plaintext
+command:
+  version: 7
+  spokenForm: bring reference air
+  action:
+    name: replaceWithTarget
+    source:
+      type: primitive
+      mark: {type: decoratedSymbol, symbolColor: default, character: a}
+      modifiers:
+        - {type: reference}
+    destination: {type: implicit}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: |+
+    aaa bbb ccc
+
+  selections:
+    - anchor: {line: 2, character: 0}
+      active: {line: 2, character: 0}
+  marks:
+    default.a:
+      start: {line: 0, character: 0}
+      end: {line: 0, character: 3}
+finalState:
+  documentContents: |-
+    aaa bbb ccc
+
+    Untitled-1#L1
+  selections:
+    - anchor: {line: 2, character: 13}
+      active: {line: 2, character: 13}
+  thatMark:
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 2, character: 0}
+        end: {line: 2, character: 13}
+      isReversed: false
+      hasExplicitRange: true
+  sourceMark:
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 0, character: 0}
+        end: {line: 0, character: 3}
+      isReversed: false
+      hasExplicitRange: true

data/fixtures/recorded/modifiers/bringReferenceAirAfterBat.yml

@@ -0,0 +1,51 @@
+languageId: plaintext
+command:
+  version: 7
+  spokenForm: bring reference air after bat
+  action:
+    name: replaceWithTarget
+    source:
+      type: primitive
+      mark: {type: decoratedSymbol, symbolColor: default, character: a}
+      modifiers:
+        - {type: reference}
+    destination:
+      type: primitive
+      insertionMode: after
+      target:
+        type: primitive
+        mark: {type: decoratedSymbol, symbolColor: default, character: b}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: |
+    aaa bbb
+  selections:
+    - anchor: {line: 1, character: 0}
+      active: {line: 1, character: 0}
+  marks:
+    default.a:
+      start: {line: 0, character: 0}
+      end: {line: 0, character: 3}
+    default.b:
+      start: {line: 0, character: 4}
+      end: {line: 0, character: 7}
+finalState:
+  documentContents: |
+    aaa bbb Untitled-1#L1
+  selections:
+    - anchor: {line: 1, character: 0}
+      active: {line: 1, character: 0}
+  thatMark:
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 0, character: 8}
+        end: {line: 0, character: 21}
+      isReversed: false
+      hasExplicitRange: true
+  sourceMark:
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 0, character: 0}
+        end: {line: 0, character: 3}
+      isReversed: false
+      hasExplicitRange: true

data/fixtures/recorded/modifiers/bringReferenceAirAndBat.yml

@@ -0,0 +1,59 @@
+languageId: plaintext
+command:
+  version: 7
+  spokenForm: bring reference air and bat
+  action:
+    name: replaceWithTarget
+    source:
+      type: list
+      elements:
+        - type: primitive
+          mark: {type: decoratedSymbol, symbolColor: default, character: a}
+          modifiers:
+            - {type: reference}
+        - type: primitive
+          mark: {type: decoratedSymbol, symbolColor: default, character: b}
+    destination: {type: implicit}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: |
+    aaa
+    bbb
+  selections:
+    - anchor: {line: 2, character: 0}
+      active: {line: 2, character: 0}
+  marks:
+    default.a:
+      start: {line: 0, character: 0}
+      end: {line: 0, character: 3}
+    default.b:
+      start: {line: 1, character: 0}
+      end: {line: 1, character: 3}
+finalState:
+  documentContents: |-
+    aaa
+    bbb
+    Untitled-1#L1, Untitled-1#L2
+  selections:
+    - anchor: {line: 2, character: 28}
+      active: {line: 2, character: 28}
+  thatMark:
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 2, character: 0}
+        end: {line: 2, character: 28}
+      isReversed: false
+      hasExplicitRange: true
+  sourceMark:
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 0, character: 0}
+        end: {line: 0, character: 3}
+      isReversed: false
+      hasExplicitRange: true
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 1, character: 0}
+        end: {line: 1, character: 3}
+      isReversed: false
+      hasExplicitRange: true