Added paragraph scope handler

src/processTargets/modifiers/getLegacyScopeStage.ts

@@ -11,7 +11,6 @@ import ContainingSyntaxScopeStage, {
   SimpleEveryScopeModifier,
 } from "./scopeTypeStages/ContainingSyntaxScopeStage";
 import NotebookCellStage from "./scopeTypeStages/NotebookCellStage";
-import ParagraphStage from "./scopeTypeStages/ParagraphStage";
 import {
   CustomRegexModifier,
   CustomRegexStage,
@@ -39,8 +38,6 @@ export default function getLegacyScopeStage(
   switch (modifier.scopeType.type) {
     case "notebookCell":
       return new NotebookCellStage(modifier);
-    case "paragraph":
-      return new ParagraphStage(modifier);
     case "nonWhitespaceSequence":
       return new NonWhitespaceSequenceStage(modifier);
     case "boundedNonWhitespaceSequence":

src/processTargets/modifiers/scopeHandlers/ParagraphScopeHandler.ts

@@ -0,0 +1,89 @@
+import { Position, Range, TextDocument, TextEditor, TextLine } from "vscode";
+import { Direction, ScopeType } from "../../../typings/targetDescriptor.types";
+import { ParagraphTarget } from "../../targets";
+import BaseScopeHandler from "./BaseScopeHandler";
+import { fitRangeToLineContent } from "./LineScopeHandler";
+import { TargetScope } from "./scope.types";
+
+export default class TokenScopeHandler extends BaseScopeHandler {
+  public readonly scopeType: ScopeType = { type: "paragraph" };
+  public readonly iterationScopeType: ScopeType = { type: "document" };
+  protected readonly isHierarchical = false;
+
+  constructor(_scopeType: ScopeType, _languageId: string) {
+    super();
+  }
+
+  *generateScopeCandidates(
+    editor: TextEditor,
+    position: Position,
+    direction: Direction,
+  ): Iterable<TargetScope> {
+    const { document } = editor;
+    const offset = direction === "forward" ? 1 : -1;
+    const stop = direction === "forward" ? document.lineCount : -1;
+    let startLine = getStartLine(document, position, direction);
+    let previousLine = editor.document.lineAt(position);
+
+    for (let i = position.line + offset; i !== stop; i += offset) {
+      const currentLine = editor.document.lineAt(i);
+
+      if (currentLine.isEmptyOrWhitespace) {
+        // End of paragraph
+        if (startLine != null) {
+          yield createScope(editor, startLine.range.union(previousLine.range));
+          startLine = undefined;
+        }
+      }
+      // Start of paragraph
+      else if (startLine == null) {
+        startLine = currentLine;
+      }
+
+      previousLine = currentLine;
+    }
+
+    // End of last paragraph
+    if (startLine != null) {
+      yield createScope(editor, startLine.range.union(previousLine.range));
+    }
+  }
+}
+
+/** Look in opposite direction for the start/edge of the paragraph */
+function getStartLine(
+  document: TextDocument,
+  position: Position,
+  direction: Direction,
+): TextLine | undefined {
+  const offset = direction === "forward" ? -1 : 1;
+  const stop = direction === "forward" ? -1 : document.lineCount;
+  let startLine = document.lineAt(position);
+
+  if (startLine.isEmptyOrWhitespace) {
+    return undefined;
+  }
+
+  for (let i = position.line + offset; i !== stop; i += offset) {
+    const line = document.lineAt(i);
+    if (line.isEmptyOrWhitespace) {
+      break;
+    }
+    startLine = line;
+  }
+
+  return startLine;
+}
+
+function createScope(editor: TextEditor, domain: Range): TargetScope {
+  return {
+    editor,
+    domain,
+    getTarget: (isReversed) =>
+      new ParagraphTarget({
+        editor,
+        isReversed,
+        contentRange: fitRangeToLineContent(editor, domain),
+      }),
+  };
+}

src/processTargets/modifiers/scopeHandlers/getScopeHandler.ts

@@ -6,6 +6,7 @@ import {
   TokenScopeHandler,
   WordScopeHandler,
   OneOfScopeHandler,
+  ParagraphScopeHandler,
 } from ".";
 import type { ScopeType } from "../../../typings/targetDescriptor.types";
 import type { ScopeHandler } from "./scopeHandler.types";
@@ -46,6 +47,8 @@ export default function getScopeHandler(
       return new DocumentScopeHandler(scopeType, languageId);
     case "oneOf":
       return new OneOfScopeHandler(scopeType, languageId);
+    case "paragraph":
+      return new ParagraphScopeHandler(scopeType, languageId);
     default:
       return undefined;
   }

src/processTargets/modifiers/scopeHandlers/index.ts

@@ -14,5 +14,7 @@ export * from "./DocumentScopeHandler";
 export { default as DocumentScopeHandler } from "./DocumentScopeHandler";
 export * from "./OneOfScopeHandler";
 export { default as OneOfScopeHandler } from "./OneOfScopeHandler";
+export * from "./ParagraphScopeHandler";
+export { default as ParagraphScopeHandler } from "./ParagraphScopeHandler";
 export * from "./getScopeHandler";
 export { default as getScopeHandler } from "./getScopeHandler";

src/test/suite/fixtures/recorded/scopes/paragraph/clearBlock.yml

@@ -0,0 +1,27 @@
+languageId: plaintext
+command:
+  spokenForm: clear block
+  version: 3
+  targets:
+    - type: primitive
+      modifiers:
+        - type: containingScope
+          scopeType: {type: paragraph}
+  usePrePhraseSnapshot: true
+  action: {name: clearAndSetSelection}
+initialState:
+  documentContents: |
+
+    aaa
+  selections:
+    - anchor: {line: 1, character: 0}
+      active: {line: 1, character: 0}
+  marks: {}
+finalState:
+  documentContents: |+
+
+
+  selections:
+    - anchor: {line: 1, character: 0}
+      active: {line: 1, character: 0}
+fullTargets: [{type: primitive, mark: {type: cursor}, modifiers: [{type: containingScope, scopeType: {type: paragraph}}]}]

src/test/suite/fixtures/recorded/scopes/paragraph/clearBlock2.yml

@@ -0,0 +1,27 @@
+languageId: plaintext
+command:
+  spokenForm: clear block
+  version: 3
+  targets:
+    - type: primitive
+      modifiers:
+        - type: containingScope
+          scopeType: {type: paragraph}
+  usePrePhraseSnapshot: true
+  action: {name: clearAndSetSelection}
+initialState:
+  documentContents: |
+
+    aaa
+  selections:
+    - anchor: {line: 1, character: 2}
+      active: {line: 1, character: 2}
+  marks: {}
+finalState:
+  documentContents: |+
+
+
+  selections:
+    - anchor: {line: 1, character: 0}
+      active: {line: 1, character: 0}
+fullTargets: [{type: primitive, mark: {type: cursor}, modifiers: [{type: containingScope, scopeType: {type: paragraph}}]}]

src/test/suite/fixtures/recorded/scopes/paragraph/clearBlock3.yml

@@ -0,0 +1,27 @@
+languageId: plaintext
+command:
+  spokenForm: clear block
+  version: 3
+  targets:
+    - type: primitive
+      modifiers:
+        - type: containingScope
+          scopeType: {type: paragraph}
+  usePrePhraseSnapshot: true
+  action: {name: clearAndSetSelection}
+initialState:
+  documentContents: |
+
+    aaa
+  selections:
+    - anchor: {line: 1, character: 3}
+      active: {line: 1, character: 3}
+  marks: {}
+finalState:
+  documentContents: |+
+
+
+  selections:
+    - anchor: {line: 1, character: 0}
+      active: {line: 1, character: 0}
+fullTargets: [{type: primitive, mark: {type: cursor}, modifiers: [{type: containingScope, scopeType: {type: paragraph}}]}]

src/test/suite/fixtures/recorded/scopes/paragraph/clearNextBlock.yml

@@ -0,0 +1,34 @@
+languageId: plaintext
+command:
+  spokenForm: clear next block
+  version: 3
+  targets:
+    - type: primitive
+      modifiers:
+        - type: relativeScope
+          scopeType: {type: paragraph}
+          offset: 1
+          length: 1
+          direction: forward
+  usePrePhraseSnapshot: true
+  action: {name: clearAndSetSelection}
+initialState:
+  documentContents: |
+
+    aaa
+
+    bbb
+  selections:
+    - anchor: {line: 1, character: 0}
+      active: {line: 1, character: 0}
+  marks: {}
+finalState:
+  documentContents: |+
+
+    aaa
+
+
+  selections:
+    - anchor: {line: 3, character: 0}
+      active: {line: 3, character: 0}
+fullTargets: [{type: primitive, mark: {type: cursor}, modifiers: [{type: relativeScope, scopeType: {type: paragraph}, offset: 1, length: 1, direction: forward}]}]

src/test/suite/fixtures/recorded/scopes/paragraph/clearNextBlock2.yml

@@ -0,0 +1,34 @@
+languageId: plaintext
+command:
+  spokenForm: clear next block
+  version: 3
+  targets:
+    - type: primitive
+      modifiers:
+        - type: relativeScope
+          scopeType: {type: paragraph}
+          offset: 1
+          length: 1
+          direction: forward
+  usePrePhraseSnapshot: true
+  action: {name: clearAndSetSelection}
+initialState:
+  documentContents: |
+
+    aaa
+
+    bbb
+  selections:
+    - anchor: {line: 1, character: 1}
+      active: {line: 1, character: 1}
+  marks: {}
+finalState:
+  documentContents: |+
+
+    aaa
+
+
+  selections:
+    - anchor: {line: 3, character: 0}
+      active: {line: 3, character: 0}
+fullTargets: [{type: primitive, mark: {type: cursor}, modifiers: [{type: relativeScope, scopeType: {type: paragraph}, offset: 1, length: 1, direction: forward}]}]