diff --git a/packages/app-web-docs/src/docs/components/ReferenceEntry.tsx b/packages/app-web-docs/src/docs/components/ReferenceEntry.tsx deleted file mode 100644 index c037a56dea..0000000000 --- a/packages/app-web-docs/src/docs/components/ReferenceEntry.tsx +++ /dev/null @@ -1,114 +0,0 @@ -import React, { Fragment } from "react"; -import { - actionReferences, - modifierReferences, - scopeReferences, -} from "@cursorless/lib-common"; -import type { ReferenceEntry } from "@cursorless/lib-common"; - -export function ActionReference({ id }: { id: keyof typeof actionReferences }) { - return ; -} - -export function ModifierReference({ - id, -}: { - id: keyof typeof modifierReferences; -}) { - return ; -} - -export function ScopeReference({ id }: { id: keyof typeof scopeReferences }) { - return ; -} - -function ReferenceEntryComponent({ - id, - entry, -}: { - id: string; - entry: ReferenceEntry; -}) { - return ( - <> - {entry.description != null &&

{entry.description}

} - -

- Cursorless ID: {id} -

- - {entry.defaultSpokenForm != null && ( -
-
- Default spoken form: {entry.defaultSpokenForm} -
- - {entry.legacySpokenForms != null && ( -
- Legacy spoken forms:{" "} - {entry.legacySpokenForms.map((s, i) => ( - - {i > 0 && ", "} - {s} - - ))} -
- )} - - {entry.disabledByDefault && ( -
- Disabled by default -
- )} -
- )} - - {entry.syntaxes.length > 0 && ( -
- Syntax: -
    - {entry.syntaxes.map((syntax, index) => ( -
  • - {formatPattern(syntax.pattern, entry.defaultSpokenForm)}:{" "} - {formatPattern(syntax.description)} -
  • - ))} -
-
- )} - - {entry.examples.length > 0 && ( -
- Examples: -
    - {entry.examples.map((example, index) => ( -
  • - - " - {formatPattern(example.command, entry.defaultSpokenForm)} - " - - : {example.description} -
  • - ))} -
-
- )} - - ); -} - -function formatPattern( - pattern: string, - defaultSpokenForm?: string, -): React.ReactNode[] { - return pattern.split(/(<[\w ]+>)/gu).map((part, index) => { - if (part.startsWith("<") && part.endsWith(">")) { - if (part === "") { - return defaultSpokenForm ?? "???"; - } - return {part}; - } - return part; - }); -} diff --git a/packages/app-web-docs/src/docs/components/ScopeVisualizer.tsx b/packages/app-web-docs/src/docs/components/ScopeVisualizer.tsx index 50497a7d8f..1aef0c21aa 100644 --- a/packages/app-web-docs/src/docs/components/ScopeVisualizer.tsx +++ b/packages/app-web-docs/src/docs/components/ScopeVisualizer.tsx @@ -46,12 +46,8 @@ export function ScopeVisualizer({ languageId, scopeTypeType }: Props) { const [scopes] = useState( getScopeFixtures(scopeTests, languageId, scopeTypeType), ); - const [rangeType, setRangeType] = useState( - scopeTypeType != null ? "blend" : "content", - ); - const [renderWhitespace, setRenderWhitespace] = useState( - scopeTypeType != null, - ); + const [rangeType, setRangeType] = useState("content"); + const [renderWhitespace, setRenderWhitespace] = useState(true); if (scopes.internal.length === 0 && scopes.public.length === 0) { return null; diff --git a/packages/app-web-docs/src/docs/user/actions/addSelection.mdx b/packages/app-web-docs/src/docs/user/actions/addSelection.mdx index 1e332101a3..2ef5495c62 100644 --- a/packages/app-web-docs/src/docs/user/actions/addSelection.mdx +++ b/packages/app-web-docs/src/docs/user/actions/addSelection.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Add selection - +Cursorless ID: `addSelection` + +## Spoken form + +Default: `append` + +## Syntax + +- append ``: Adds `` to the current selection set. diff --git a/packages/app-web-docs/src/docs/user/actions/addSelectionAfter.mdx b/packages/app-web-docs/src/docs/user/actions/addSelectionAfter.mdx index 6b51984db0..091b51f8fb 100644 --- a/packages/app-web-docs/src/docs/user/actions/addSelectionAfter.mdx +++ b/packages/app-web-docs/src/docs/user/actions/addSelectionAfter.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Add selection after - +Cursorless ID: `addSelectionAfter` + +## Spoken form + +Default: `append post` + +## Syntax + +- append post ``: Adds empty selection after `` to the current selection set. diff --git a/packages/app-web-docs/src/docs/user/actions/addSelectionBefore.mdx b/packages/app-web-docs/src/docs/user/actions/addSelectionBefore.mdx index f6c5ce8c6a..5e172dc0d2 100644 --- a/packages/app-web-docs/src/docs/user/actions/addSelectionBefore.mdx +++ b/packages/app-web-docs/src/docs/user/actions/addSelectionBefore.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Add selection before - +Cursorless ID: `addSelectionBefore` + +## Spoken form + +Default: `append pre` + +## Syntax + +- append pre ``: Adds empty selection before `` to the current selection set. diff --git a/packages/app-web-docs/src/docs/user/actions/applyFormatter.mdx b/packages/app-web-docs/src/docs/user/actions/applyFormatter.mdx index c329bc9310..eaa31b399e 100644 --- a/packages/app-web-docs/src/docs/user/actions/applyFormatter.mdx +++ b/packages/app-web-docs/src/docs/user/actions/applyFormatter.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Apply formatter - +Cursorless ID: `applyFormatter` + +## Spoken form + +Default: `format` + +## Syntax + +- format `` at ``: Reformat `` as ``. diff --git a/packages/app-web-docs/src/docs/user/actions/breakLine.mdx b/packages/app-web-docs/src/docs/user/actions/breakLine.mdx index ab71fb4059..14e970b177 100644 --- a/packages/app-web-docs/src/docs/user/actions/breakLine.mdx +++ b/packages/app-web-docs/src/docs/user/actions/breakLine.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Break line - +Cursorless ID: `breakLine` + +## Spoken form + +Default: `break` + +## Syntax + +- break ``: Breaks the line before ``. diff --git a/packages/app-web-docs/src/docs/user/actions/callAsFunction.mdx b/packages/app-web-docs/src/docs/user/actions/callAsFunction.mdx index a36b450884..ad44ceedac 100644 --- a/packages/app-web-docs/src/docs/user/actions/callAsFunction.mdx +++ b/packages/app-web-docs/src/docs/user/actions/callAsFunction.mdx @@ -1,5 +1,12 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Call as function - +Cursorless ID: `callAsFunction` + +## Spoken form + +Default: `call` + +## Syntax + +- call ``: Insert call to `` on selection. +- call `` on ``: Insert call to `` on ``. diff --git a/packages/app-web-docs/src/docs/user/actions/clearAndSetSelection.mdx b/packages/app-web-docs/src/docs/user/actions/clearAndSetSelection.mdx index 782aa36fd4..6a58fc9242 100644 --- a/packages/app-web-docs/src/docs/user/actions/clearAndSetSelection.mdx +++ b/packages/app-web-docs/src/docs/user/actions/clearAndSetSelection.mdx @@ -1,5 +1,12 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Change - +Cursorless ID: `clearAndSetSelection` + +## Spoken form + +Default: `change`\ +Legacy: `clear` + +## Syntax + +- change ``: Change `` by clearing it and leaving the cursor in its place. diff --git a/packages/app-web-docs/src/docs/user/actions/copyToClipboard.mdx b/packages/app-web-docs/src/docs/user/actions/copyToClipboard.mdx index ab83454d85..7ed55fd515 100644 --- a/packages/app-web-docs/src/docs/user/actions/copyToClipboard.mdx +++ b/packages/app-web-docs/src/docs/user/actions/copyToClipboard.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Copy to clipboard - +Cursorless ID: `copyToClipboard` + +## Spoken form + +Default: `copy` + +## Syntax + +- copy ``: Copy `` to clipboard. diff --git a/packages/app-web-docs/src/docs/user/actions/cutToClipboard.mdx b/packages/app-web-docs/src/docs/user/actions/cutToClipboard.mdx index b10138052e..f07c6a76cb 100644 --- a/packages/app-web-docs/src/docs/user/actions/cutToClipboard.mdx +++ b/packages/app-web-docs/src/docs/user/actions/cutToClipboard.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Cut to clipboard - +Cursorless ID: `cutToClipboard` + +## Spoken form + +Default: `carve` + +## Syntax + +- carve ``: Cut `` to clipboard. diff --git a/packages/app-web-docs/src/docs/user/actions/decrement.mdx b/packages/app-web-docs/src/docs/user/actions/decrement.mdx index f60ba30cb8..94bd0ebc64 100644 --- a/packages/app-web-docs/src/docs/user/actions/decrement.mdx +++ b/packages/app-web-docs/src/docs/user/actions/decrement.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Decrement - +Cursorless ID: `decrement` + +## Spoken form + +Default: `decrement` + +## Syntax + +- decrement ``: Decrement number at ``. diff --git a/packages/app-web-docs/src/docs/user/actions/deselect.mdx b/packages/app-web-docs/src/docs/user/actions/deselect.mdx index 4182c83fc5..4893b2d597 100644 --- a/packages/app-web-docs/src/docs/user/actions/deselect.mdx +++ b/packages/app-web-docs/src/docs/user/actions/deselect.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Deselect - +Cursorless ID: `deselect` + +## Spoken form + +Default: `give` + +## Syntax + +- give ``: Deselect ``. diff --git a/packages/app-web-docs/src/docs/user/actions/editNewLineAfter.mdx b/packages/app-web-docs/src/docs/user/actions/editNewLineAfter.mdx index a217ebb305..1c7e3550f7 100644 --- a/packages/app-web-docs/src/docs/user/actions/editNewLineAfter.mdx +++ b/packages/app-web-docs/src/docs/user/actions/editNewLineAfter.mdx @@ -1,5 +1,14 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Edit new line/scope after - +Scope defaults to line. + +Cursorless ID: `editNewLineAfter` + +## Spoken form + +Default: `pour` + +## Syntax + +- pour ``: Edit new line after ``. +- pour `` ``: Edit new `` after ``. diff --git a/packages/app-web-docs/src/docs/user/actions/editNewLineBefore.mdx b/packages/app-web-docs/src/docs/user/actions/editNewLineBefore.mdx index 3e601927ca..8f75f65a37 100644 --- a/packages/app-web-docs/src/docs/user/actions/editNewLineBefore.mdx +++ b/packages/app-web-docs/src/docs/user/actions/editNewLineBefore.mdx @@ -1,5 +1,14 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Edit new line/scope before - +Scope defaults to line. + +Cursorless ID: `editNewLineBefore` + +## Spoken form + +Default: `drink` + +## Syntax + +- drink ``: Edit new line before ``. +- drink `` ``: Edit new `` before ``. diff --git a/packages/app-web-docs/src/docs/user/actions/extractVariable.mdx b/packages/app-web-docs/src/docs/user/actions/extractVariable.mdx index a78d9e883c..fbbb8dcabf 100644 --- a/packages/app-web-docs/src/docs/user/actions/extractVariable.mdx +++ b/packages/app-web-docs/src/docs/user/actions/extractVariable.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Extract variable - +Cursorless ID: `extractVariable` + +## Spoken form + +Default: `extract` + +## Syntax + +- extract ``: Extract variable from ``. diff --git a/packages/app-web-docs/src/docs/user/actions/findInDocument.mdx b/packages/app-web-docs/src/docs/user/actions/findInDocument.mdx index af3fba0d0e..5fa853c783 100644 --- a/packages/app-web-docs/src/docs/user/actions/findInDocument.mdx +++ b/packages/app-web-docs/src/docs/user/actions/findInDocument.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Find in document - +Cursorless ID: `findInDocument` + +## Spoken form + +Default: `scout` + +## Syntax + +- scout ``: Find `` in document. diff --git a/packages/app-web-docs/src/docs/user/actions/findInWorkspace.mdx b/packages/app-web-docs/src/docs/user/actions/findInWorkspace.mdx index a6b01ed9b0..2a9948cb68 100644 --- a/packages/app-web-docs/src/docs/user/actions/findInWorkspace.mdx +++ b/packages/app-web-docs/src/docs/user/actions/findInWorkspace.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Find in workspace - +Cursorless ID: `findInWorkspace` + +## Spoken form + +Default: `scout all` + +## Syntax + +- scout all ``: Find `` in workspace. diff --git a/packages/app-web-docs/src/docs/user/actions/flashTargets.mdx b/packages/app-web-docs/src/docs/user/actions/flashTargets.mdx index 450fc11c46..5d31ef2123 100644 --- a/packages/app-web-docs/src/docs/user/actions/flashTargets.mdx +++ b/packages/app-web-docs/src/docs/user/actions/flashTargets.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Flash target - +Cursorless ID: `flashTargets` + +## Spoken form + +Default: `flash` + +## Syntax + +- flash ``: Flash ``. diff --git a/packages/app-web-docs/src/docs/user/actions/foldRegion.mdx b/packages/app-web-docs/src/docs/user/actions/foldRegion.mdx index d41be0ddd3..d553003331 100644 --- a/packages/app-web-docs/src/docs/user/actions/foldRegion.mdx +++ b/packages/app-web-docs/src/docs/user/actions/foldRegion.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Fold region - +Cursorless ID: `foldRegion` + +## Spoken form + +Default: `fold` + +## Syntax + +- fold ``: Fold region at ``. diff --git a/packages/app-web-docs/src/docs/user/actions/followLink.mdx b/packages/app-web-docs/src/docs/user/actions/followLink.mdx index b5a666af3b..30ff29d1a5 100644 --- a/packages/app-web-docs/src/docs/user/actions/followLink.mdx +++ b/packages/app-web-docs/src/docs/user/actions/followLink.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Follow link - +Cursorless ID: `followLink` + +## Spoken form + +Default: `follow` + +## Syntax + +- follow ``: Follow link at ``. diff --git a/packages/app-web-docs/src/docs/user/actions/followLinkAside.mdx b/packages/app-web-docs/src/docs/user/actions/followLinkAside.mdx index 9433cc795e..52517997f1 100644 --- a/packages/app-web-docs/src/docs/user/actions/followLinkAside.mdx +++ b/packages/app-web-docs/src/docs/user/actions/followLinkAside.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Follow link aside - +Cursorless ID: `followLinkAside` + +## Spoken form + +Default: `follow split` + +## Syntax + +- follow split ``: Follow link at `` aside (e.g. in a split view). diff --git a/packages/app-web-docs/src/docs/user/actions/generateSnippet.mdx b/packages/app-web-docs/src/docs/user/actions/generateSnippet.mdx index 657dd5d6f7..2fbbc64324 100644 --- a/packages/app-web-docs/src/docs/user/actions/generateSnippet.mdx +++ b/packages/app-web-docs/src/docs/user/actions/generateSnippet.mdx @@ -1,5 +1,12 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Generate snippet - +Cursorless ID: `generateSnippet` + +## Spoken form + +Default: `snip make`\ +Legacy: `snippet make` + +## Syntax + +- snip make ``: Generate snippet from ``. diff --git a/packages/app-web-docs/src/docs/user/actions/gitAccept.mdx b/packages/app-web-docs/src/docs/user/actions/gitAccept.mdx index 5e62b30897..f4332d73e0 100644 --- a/packages/app-web-docs/src/docs/user/actions/gitAccept.mdx +++ b/packages/app-web-docs/src/docs/user/actions/gitAccept.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Git accept - +Cursorless ID: `gitAccept` + +## Spoken form + +Default: `git accept` + +## Syntax + +- git accept ``: Accept Git change at ``. diff --git a/packages/app-web-docs/src/docs/user/actions/gitRevert.mdx b/packages/app-web-docs/src/docs/user/actions/gitRevert.mdx index 28545b1202..f36385c572 100644 --- a/packages/app-web-docs/src/docs/user/actions/gitRevert.mdx +++ b/packages/app-web-docs/src/docs/user/actions/gitRevert.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Git revert - +Cursorless ID: `gitRevert` + +## Spoken form + +Default: `git revert` + +## Syntax + +- git revert ``: Revert Git change at ``. diff --git a/packages/app-web-docs/src/docs/user/actions/gitStage.mdx b/packages/app-web-docs/src/docs/user/actions/gitStage.mdx index c994a443b3..89be47315d 100644 --- a/packages/app-web-docs/src/docs/user/actions/gitStage.mdx +++ b/packages/app-web-docs/src/docs/user/actions/gitStage.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Git stage - +Cursorless ID: `gitStage` + +## Spoken form + +Default: `git stage` + +## Syntax + +- git stage ``: Stage Git change at ``. diff --git a/packages/app-web-docs/src/docs/user/actions/gitUnstage.mdx b/packages/app-web-docs/src/docs/user/actions/gitUnstage.mdx index b1b21abe51..2f5459c30a 100644 --- a/packages/app-web-docs/src/docs/user/actions/gitUnstage.mdx +++ b/packages/app-web-docs/src/docs/user/actions/gitUnstage.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Git unstage - +Cursorless ID: `gitUnstage` + +## Spoken form + +Default: `git unstage` + +## Syntax + +- git unstage ``: Unstage Git change at ``. diff --git a/packages/app-web-docs/src/docs/user/actions/highlight.mdx b/packages/app-web-docs/src/docs/user/actions/highlight.mdx index 2da73aac6f..f1f6ec0edc 100644 --- a/packages/app-web-docs/src/docs/user/actions/highlight.mdx +++ b/packages/app-web-docs/src/docs/user/actions/highlight.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Highlight - +Cursorless ID: `highlight` + +## Spoken form + +Default: `highlight` + +## Syntax + +- highlight ``: Highlight ``. diff --git a/packages/app-web-docs/src/docs/user/actions/increment.mdx b/packages/app-web-docs/src/docs/user/actions/increment.mdx index 7bb6be1216..eb315f8df2 100644 --- a/packages/app-web-docs/src/docs/user/actions/increment.mdx +++ b/packages/app-web-docs/src/docs/user/actions/increment.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Increment - +Cursorless ID: `increment` + +## Spoken form + +Default: `increment` + +## Syntax + +- increment ``: Increment number at ``. diff --git a/packages/app-web-docs/src/docs/user/actions/indentLine.mdx b/packages/app-web-docs/src/docs/user/actions/indentLine.mdx index d4460ef3f3..48437ec929 100644 --- a/packages/app-web-docs/src/docs/user/actions/indentLine.mdx +++ b/packages/app-web-docs/src/docs/user/actions/indentLine.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Indent line - +Cursorless ID: `indentLine` + +## Spoken form + +Default: `indent` + +## Syntax + +- indent ``: Indent line containing ``. diff --git a/packages/app-web-docs/src/docs/user/actions/insertCopyAfter.mdx b/packages/app-web-docs/src/docs/user/actions/insertCopyAfter.mdx index 7e29faa08a..04a331ad6e 100644 --- a/packages/app-web-docs/src/docs/user/actions/insertCopyAfter.mdx +++ b/packages/app-web-docs/src/docs/user/actions/insertCopyAfter.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Insert copy after - +Cursorless ID: `insertCopyAfter` + +## Spoken form + +Default: `clone` + +## Syntax + +- clone ``: Insert copy after ``. diff --git a/packages/app-web-docs/src/docs/user/actions/insertCopyBefore.mdx b/packages/app-web-docs/src/docs/user/actions/insertCopyBefore.mdx index 5a92e80ff8..c605b362aa 100644 --- a/packages/app-web-docs/src/docs/user/actions/insertCopyBefore.mdx +++ b/packages/app-web-docs/src/docs/user/actions/insertCopyBefore.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Insert copy before - +Cursorless ID: `insertCopyBefore` + +## Spoken form + +Default: `clone up` + +## Syntax + +- clone up ``: Insert copy before ``. diff --git a/packages/app-web-docs/src/docs/user/actions/insertEmptyLineAfter.mdx b/packages/app-web-docs/src/docs/user/actions/insertEmptyLineAfter.mdx index 0fe9b3d599..a102210e61 100644 --- a/packages/app-web-docs/src/docs/user/actions/insertEmptyLineAfter.mdx +++ b/packages/app-web-docs/src/docs/user/actions/insertEmptyLineAfter.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Insert empty line after - +Cursorless ID: `insertEmptyLineAfter` + +## Spoken form + +Default: `float` + +## Syntax + +- float ``: Insert empty line after ``. diff --git a/packages/app-web-docs/src/docs/user/actions/insertEmptyLineBefore.mdx b/packages/app-web-docs/src/docs/user/actions/insertEmptyLineBefore.mdx index 898964562d..4e692773ff 100644 --- a/packages/app-web-docs/src/docs/user/actions/insertEmptyLineBefore.mdx +++ b/packages/app-web-docs/src/docs/user/actions/insertEmptyLineBefore.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Insert empty line before - +Cursorless ID: `insertEmptyLineBefore` + +## Spoken form + +Default: `drop` + +## Syntax + +- drop ``: Insert empty line before ``. diff --git a/packages/app-web-docs/src/docs/user/actions/insertEmptyLinesAround.mdx b/packages/app-web-docs/src/docs/user/actions/insertEmptyLinesAround.mdx index 50679c3c08..6fee99b741 100644 --- a/packages/app-web-docs/src/docs/user/actions/insertEmptyLinesAround.mdx +++ b/packages/app-web-docs/src/docs/user/actions/insertEmptyLinesAround.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Insert empty lines around - +Cursorless ID: `insertEmptyLinesAround` + +## Spoken form + +Default: `puff` + +## Syntax + +- puff ``: Insert empty lines around ``. diff --git a/packages/app-web-docs/src/docs/user/actions/insertSnippet.mdx b/packages/app-web-docs/src/docs/user/actions/insertSnippet.mdx index 4a89552833..4918224159 100644 --- a/packages/app-web-docs/src/docs/user/actions/insertSnippet.mdx +++ b/packages/app-web-docs/src/docs/user/actions/insertSnippet.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Insert snippet - +Cursorless ID: `insertSnippet` + +## Spoken form + +Default: `snip` + +## Syntax + +- snip `` ``: Insert snippet at ``. diff --git a/packages/app-web-docs/src/docs/user/actions/joinLines.mdx b/packages/app-web-docs/src/docs/user/actions/joinLines.mdx index 445fcab3b5..705270bcd5 100644 --- a/packages/app-web-docs/src/docs/user/actions/joinLines.mdx +++ b/packages/app-web-docs/src/docs/user/actions/joinLines.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Join lines - +Cursorless ID: `joinLines` + +## Spoken form + +Default: `join` + +## Syntax + +- join ``: Join lines at ``. diff --git a/packages/app-web-docs/src/docs/user/actions/moveToTarget.mdx b/packages/app-web-docs/src/docs/user/actions/moveToTarget.mdx index b0bcd55d68..8520895b34 100644 --- a/packages/app-web-docs/src/docs/user/actions/moveToTarget.mdx +++ b/packages/app-web-docs/src/docs/user/actions/moveToTarget.mdx @@ -1,5 +1,12 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Move to target - +Cursorless ID: `moveToTarget` + +## Spoken form + +Default: `move` + +## Syntax + +- move ``: Move `` to selection. +- move `` ``: Move `` to ``. diff --git a/packages/app-web-docs/src/docs/user/actions/nextHomophone.mdx b/packages/app-web-docs/src/docs/user/actions/nextHomophone.mdx index eda9bd2ca6..d4cf8a9e82 100644 --- a/packages/app-web-docs/src/docs/user/actions/nextHomophone.mdx +++ b/packages/app-web-docs/src/docs/user/actions/nextHomophone.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Next homophone - +Cursorless ID: `nextHomophone` + +## Spoken form + +Default: `phones` + +## Syntax + +- phones ``: Cycle to next homophone for ``. diff --git a/packages/app-web-docs/src/docs/user/actions/outdentLine.mdx b/packages/app-web-docs/src/docs/user/actions/outdentLine.mdx index 46b8717368..c84db27f07 100644 --- a/packages/app-web-docs/src/docs/user/actions/outdentLine.mdx +++ b/packages/app-web-docs/src/docs/user/actions/outdentLine.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Outdent line - +Cursorless ID: `outdentLine` + +## Spoken form + +Default: `dedent` + +## Syntax + +- dedent ``: Outdent line containing ``. diff --git a/packages/app-web-docs/src/docs/user/actions/pasteFromClipboard.mdx b/packages/app-web-docs/src/docs/user/actions/pasteFromClipboard.mdx index ef23e3111f..59da8e93ea 100644 --- a/packages/app-web-docs/src/docs/user/actions/pasteFromClipboard.mdx +++ b/packages/app-web-docs/src/docs/user/actions/pasteFromClipboard.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Paste from clipboard - +Cursorless ID: `pasteFromClipboard` + +## Spoken form + +Default: `paste` + +## Syntax + +- paste ``: Paste from clipboard at ``. diff --git a/packages/app-web-docs/src/docs/user/actions/randomizeTargets.mdx b/packages/app-web-docs/src/docs/user/actions/randomizeTargets.mdx index cb2d517bef..68ee22b054 100644 --- a/packages/app-web-docs/src/docs/user/actions/randomizeTargets.mdx +++ b/packages/app-web-docs/src/docs/user/actions/randomizeTargets.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Randomize targets - +Cursorless ID: `randomizeTargets` + +## Spoken form + +Default: `shuffle` + +## Syntax + +- shuffle ``: Randomize ``s. diff --git a/packages/app-web-docs/src/docs/user/actions/remove.mdx b/packages/app-web-docs/src/docs/user/actions/remove.mdx index 53e1977409..7eb95915ec 100644 --- a/packages/app-web-docs/src/docs/user/actions/remove.mdx +++ b/packages/app-web-docs/src/docs/user/actions/remove.mdx @@ -1,5 +1,17 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Remove - +This action can be used to remove a target without moving the cursor. + +Cursorless ID: `remove` + +## Spoken form + +Default: `chuck` + +## Syntax + +- chuck ``: Remove ``. + +## Examples + +- `"chuck blue air"`: Removes the token containing letter 'a' with a blue hat. diff --git a/packages/app-web-docs/src/docs/user/actions/rename.mdx b/packages/app-web-docs/src/docs/user/actions/rename.mdx index 06ec8b15f3..b0594228a6 100644 --- a/packages/app-web-docs/src/docs/user/actions/rename.mdx +++ b/packages/app-web-docs/src/docs/user/actions/rename.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Rename - +Cursorless ID: `rename` + +## Spoken form + +Default: `rename` + +## Syntax + +- rename ``: Rename ``. diff --git a/packages/app-web-docs/src/docs/user/actions/replaceWithTarget.mdx b/packages/app-web-docs/src/docs/user/actions/replaceWithTarget.mdx index 243baec78e..f66b2a78d5 100644 --- a/packages/app-web-docs/src/docs/user/actions/replaceWithTarget.mdx +++ b/packages/app-web-docs/src/docs/user/actions/replaceWithTarget.mdx @@ -1,5 +1,12 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Replace with target - +Cursorless ID: `replaceWithTarget` + +## Spoken form + +Default: `bring` + +## Syntax + +- bring ``: Insert copy of `` at selection. +- bring `` ``: Copy `` to ``. diff --git a/packages/app-web-docs/src/docs/user/actions/revealDefinition.mdx b/packages/app-web-docs/src/docs/user/actions/revealDefinition.mdx index 333818b755..3e5c3f4588 100644 --- a/packages/app-web-docs/src/docs/user/actions/revealDefinition.mdx +++ b/packages/app-web-docs/src/docs/user/actions/revealDefinition.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Reveal definition - +Cursorless ID: `revealDefinition` + +## Spoken form + +Default: `define` + +## Syntax + +- define ``: Reveal definition of ``. diff --git a/packages/app-web-docs/src/docs/user/actions/revealTypeDefinition.mdx b/packages/app-web-docs/src/docs/user/actions/revealTypeDefinition.mdx index 8535b694fa..551d95e992 100644 --- a/packages/app-web-docs/src/docs/user/actions/revealTypeDefinition.mdx +++ b/packages/app-web-docs/src/docs/user/actions/revealTypeDefinition.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Reveal type definition - +Cursorless ID: `revealTypeDefinition` + +## Spoken form + +Default: `type deaf` + +## Syntax + +- type deaf ``: Reveal type definition of ``. diff --git a/packages/app-web-docs/src/docs/user/actions/reverseTargets.mdx b/packages/app-web-docs/src/docs/user/actions/reverseTargets.mdx index 54e207589c..9d4f4b643e 100644 --- a/packages/app-web-docs/src/docs/user/actions/reverseTargets.mdx +++ b/packages/app-web-docs/src/docs/user/actions/reverseTargets.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Reverse targets - +Cursorless ID: `reverseTargets` + +## Spoken form + +Default: `reverse` + +## Syntax + +- reverse ``: Reverse ``s. diff --git a/packages/app-web-docs/src/docs/user/actions/rewrapWithPairedDelimiter.mdx b/packages/app-web-docs/src/docs/user/actions/rewrapWithPairedDelimiter.mdx index af662e3421..28410df99f 100644 --- a/packages/app-web-docs/src/docs/user/actions/rewrapWithPairedDelimiter.mdx +++ b/packages/app-web-docs/src/docs/user/actions/rewrapWithPairedDelimiter.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Rewrap with paired delimiter - +Cursorless ID: `rewrapWithPairedDelimiter` + +## Spoken form + +Default: `repack` + +## Syntax + +- `` repack ``: Rewrap `` with ``. diff --git a/packages/app-web-docs/src/docs/user/actions/scrollToBottom.mdx b/packages/app-web-docs/src/docs/user/actions/scrollToBottom.mdx index ab1cf7017a..fea3f9e040 100644 --- a/packages/app-web-docs/src/docs/user/actions/scrollToBottom.mdx +++ b/packages/app-web-docs/src/docs/user/actions/scrollToBottom.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Scroll to bottom - +Cursorless ID: `scrollToBottom` + +## Spoken form + +Default: `bottom` + +## Syntax + +- bottom ``: Scroll `` to bottom of the viewport. diff --git a/packages/app-web-docs/src/docs/user/actions/scrollToCenter.mdx b/packages/app-web-docs/src/docs/user/actions/scrollToCenter.mdx index 2a005e39b9..4c63dd8a87 100644 --- a/packages/app-web-docs/src/docs/user/actions/scrollToCenter.mdx +++ b/packages/app-web-docs/src/docs/user/actions/scrollToCenter.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Scroll to center - +Cursorless ID: `scrollToCenter` + +## Spoken form + +Default: `center` + +## Syntax + +- center ``: Scroll `` to center of the viewport. diff --git a/packages/app-web-docs/src/docs/user/actions/scrollToTop.mdx b/packages/app-web-docs/src/docs/user/actions/scrollToTop.mdx index 7dad52b50f..8f1a7f973e 100644 --- a/packages/app-web-docs/src/docs/user/actions/scrollToTop.mdx +++ b/packages/app-web-docs/src/docs/user/actions/scrollToTop.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Scroll to top - +Cursorless ID: `scrollToTop` + +## Spoken form + +Default: `crown` + +## Syntax + +- crown ``: Scroll `` to top of the viewport. diff --git a/packages/app-web-docs/src/docs/user/actions/setInstanceReference.mdx b/packages/app-web-docs/src/docs/user/actions/setInstanceReference.mdx index e332ef548f..c9321d93ca 100644 --- a/packages/app-web-docs/src/docs/user/actions/setInstanceReference.mdx +++ b/packages/app-web-docs/src/docs/user/actions/setInstanceReference.mdx @@ -1,5 +1,13 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Set instance reference - +Sets the instance reference for the next 'instance of' action. + +Cursorless ID: `experimental.setInstanceReference` + +## Spoken form + +Default: `from` + +## Syntax + +- from ``: Set instance reference to ``. diff --git a/packages/app-web-docs/src/docs/user/actions/setSelection.mdx b/packages/app-web-docs/src/docs/user/actions/setSelection.mdx index d4532fd3e1..70b9e362bd 100644 --- a/packages/app-web-docs/src/docs/user/actions/setSelection.mdx +++ b/packages/app-web-docs/src/docs/user/actions/setSelection.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Set selection - +Cursorless ID: `setSelection` + +## Spoken form + +Default: `take` + +## Syntax + +- take ``: Set selection to ``. diff --git a/packages/app-web-docs/src/docs/user/actions/setSelectionAfter.mdx b/packages/app-web-docs/src/docs/user/actions/setSelectionAfter.mdx index 8a7bb7f613..6336804ff6 100644 --- a/packages/app-web-docs/src/docs/user/actions/setSelectionAfter.mdx +++ b/packages/app-web-docs/src/docs/user/actions/setSelectionAfter.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Set selection after - +Cursorless ID: `setSelectionAfter` + +## Spoken form + +Default: `post` + +## Syntax + +- post ``: Set empty selection after ``. diff --git a/packages/app-web-docs/src/docs/user/actions/setSelectionBefore.mdx b/packages/app-web-docs/src/docs/user/actions/setSelectionBefore.mdx index 5335bf7af1..90a3707207 100644 --- a/packages/app-web-docs/src/docs/user/actions/setSelectionBefore.mdx +++ b/packages/app-web-docs/src/docs/user/actions/setSelectionBefore.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Set selection before - +Cursorless ID: `setSelectionBefore` + +## Spoken form + +Default: `pre` + +## Syntax + +- pre ``: Set empty selection before ``. diff --git a/packages/app-web-docs/src/docs/user/actions/showDebugHover.mdx b/packages/app-web-docs/src/docs/user/actions/showDebugHover.mdx index ea56546eb6..8ba5cd587d 100644 --- a/packages/app-web-docs/src/docs/user/actions/showDebugHover.mdx +++ b/packages/app-web-docs/src/docs/user/actions/showDebugHover.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Show debug hover - +Cursorless ID: `showDebugHover` + +## Spoken form + +Default: `inspect` + +## Syntax + +- inspect ``: Show debug hover for ``. diff --git a/packages/app-web-docs/src/docs/user/actions/showHover.mdx b/packages/app-web-docs/src/docs/user/actions/showHover.mdx index 9b337aad46..a246baf259 100644 --- a/packages/app-web-docs/src/docs/user/actions/showHover.mdx +++ b/packages/app-web-docs/src/docs/user/actions/showHover.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Show hover - +Cursorless ID: `showHover` + +## Spoken form + +Default: `hover` + +## Syntax + +- hover ``: Show hover for ``. diff --git a/packages/app-web-docs/src/docs/user/actions/showQuickFix.mdx b/packages/app-web-docs/src/docs/user/actions/showQuickFix.mdx index 8c2ff97ffa..6bb4800941 100644 --- a/packages/app-web-docs/src/docs/user/actions/showQuickFix.mdx +++ b/packages/app-web-docs/src/docs/user/actions/showQuickFix.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Show quick fix - +Cursorless ID: `showQuickFix` + +## Spoken form + +Default: `quick fix` + +## Syntax + +- quick fix ``: Show quick fix for ``. diff --git a/packages/app-web-docs/src/docs/user/actions/showReferences.mdx b/packages/app-web-docs/src/docs/user/actions/showReferences.mdx index fb67791b63..13df173051 100644 --- a/packages/app-web-docs/src/docs/user/actions/showReferences.mdx +++ b/packages/app-web-docs/src/docs/user/actions/showReferences.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Show references - +Cursorless ID: `showReferences` + +## Spoken form + +Default: `reference` + +## Syntax + +- reference ``: Show references for ``. diff --git a/packages/app-web-docs/src/docs/user/actions/sortTargets.mdx b/packages/app-web-docs/src/docs/user/actions/sortTargets.mdx index 44fd34649e..f576a458fb 100644 --- a/packages/app-web-docs/src/docs/user/actions/sortTargets.mdx +++ b/packages/app-web-docs/src/docs/user/actions/sortTargets.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Sort targets - +Cursorless ID: `sortTargets` + +## Spoken form + +Default: `sort` + +## Syntax + +- sort ``: Sort ``s. diff --git a/packages/app-web-docs/src/docs/user/actions/swapTargets.mdx b/packages/app-web-docs/src/docs/user/actions/swapTargets.mdx index 2de617b4ed..bae5c1dae6 100644 --- a/packages/app-web-docs/src/docs/user/actions/swapTargets.mdx +++ b/packages/app-web-docs/src/docs/user/actions/swapTargets.mdx @@ -1,5 +1,12 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Swap targets - +Cursorless ID: `swapTargets` + +## Spoken form + +Default: `swap` + +## Syntax + +- swap with ``: Swap selection with ``. +- swap `` with ``: Swap `` with ``. diff --git a/packages/app-web-docs/src/docs/user/actions/toggleLineBreakpoint.mdx b/packages/app-web-docs/src/docs/user/actions/toggleLineBreakpoint.mdx index d880600e67..6d0cd6a57b 100644 --- a/packages/app-web-docs/src/docs/user/actions/toggleLineBreakpoint.mdx +++ b/packages/app-web-docs/src/docs/user/actions/toggleLineBreakpoint.mdx @@ -1,5 +1,14 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Toggle line/scope breakpoint - +Scope defaults to line. + +Cursorless ID: `toggleLineBreakpoint` + +## Spoken form + +Default: `break point` + +## Syntax + +- break point ``: Toggle breakpoint on line containing ``. +- break point token ``: Toggle inline breakpoint at ``. diff --git a/packages/app-web-docs/src/docs/user/actions/toggleLineComment.mdx b/packages/app-web-docs/src/docs/user/actions/toggleLineComment.mdx index 95d5db36a4..4f58da1682 100644 --- a/packages/app-web-docs/src/docs/user/actions/toggleLineComment.mdx +++ b/packages/app-web-docs/src/docs/user/actions/toggleLineComment.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Toggle line comment - +Cursorless ID: `toggleLineComment` + +## Spoken form + +Default: `comment` + +## Syntax + +- comment ``: Toggle line comment at ``. diff --git a/packages/app-web-docs/src/docs/user/actions/unfoldRegion.mdx b/packages/app-web-docs/src/docs/user/actions/unfoldRegion.mdx index fa443bc518..4fbaf19f1f 100644 --- a/packages/app-web-docs/src/docs/user/actions/unfoldRegion.mdx +++ b/packages/app-web-docs/src/docs/user/actions/unfoldRegion.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Unfold region - +Cursorless ID: `unfoldRegion` + +## Spoken form + +Default: `unfold` + +## Syntax + +- unfold ``: Unfold region at ``. diff --git a/packages/app-web-docs/src/docs/user/actions/wrapWithPairedDelimiter.mdx b/packages/app-web-docs/src/docs/user/actions/wrapWithPairedDelimiter.mdx index 196ab1a218..eba21f3226 100644 --- a/packages/app-web-docs/src/docs/user/actions/wrapWithPairedDelimiter.mdx +++ b/packages/app-web-docs/src/docs/user/actions/wrapWithPairedDelimiter.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Wrap with paired delimiter - +Cursorless ID: `wrapWithPairedDelimiter` + +## Spoken form + +Default: `wrap` + +## Syntax + +- `` wrap ``: Wrap `` with ``. diff --git a/packages/app-web-docs/src/docs/user/actions/wrapWithSnippet.mdx b/packages/app-web-docs/src/docs/user/actions/wrapWithSnippet.mdx index d12c485f4a..1244c6e5ce 100644 --- a/packages/app-web-docs/src/docs/user/actions/wrapWithSnippet.mdx +++ b/packages/app-web-docs/src/docs/user/actions/wrapWithSnippet.mdx @@ -1,5 +1,11 @@ -import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; - # Wrap with snippet - +Cursorless ID: `wrapWithSnippet` + +## Spoken form + +Default: `wrap` + +## Syntax + +- `` wrap ``: Wrap `` with ``. diff --git a/packages/app-web-docs/src/docs/user/modifiers/ancestor.mdx b/packages/app-web-docs/src/docs/user/modifiers/ancestor.mdx index 143f8944a4..ac2c22cde8 100644 --- a/packages/app-web-docs/src/docs/user/modifiers/ancestor.mdx +++ b/packages/app-web-docs/src/docs/user/modifiers/ancestor.mdx @@ -1,5 +1,11 @@ -import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; - # Ancestor - +Cursorless ID: `ancestor` + +## Spoken form + +Default: `grand` + +## Syntax + +- grand ``: Grandparent containing instance of ``. diff --git a/packages/app-web-docs/src/docs/user/modifiers/containingScope.mdx b/packages/app-web-docs/src/docs/user/modifiers/containingScope.mdx index 3b000857aa..7656963f6e 100644 --- a/packages/app-web-docs/src/docs/user/modifiers/containingScope.mdx +++ b/packages/app-web-docs/src/docs/user/modifiers/containingScope.mdx @@ -1,5 +1,7 @@ -import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; - # Containing scope - +Cursorless ID: `containingScope` + +## Syntax + +- ``: Containing instance of ``. diff --git a/packages/app-web-docs/src/docs/user/modifiers/endOf.mdx b/packages/app-web-docs/src/docs/user/modifiers/endOf.mdx index 2834f0b375..f5854c0d55 100644 --- a/packages/app-web-docs/src/docs/user/modifiers/endOf.mdx +++ b/packages/app-web-docs/src/docs/user/modifiers/endOf.mdx @@ -1,5 +1,11 @@ -import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; - # End of - +Cursorless ID: `endOf` + +## Spoken form + +Default: `end of` + +## Syntax + +- end of: Empty position at end of target. diff --git a/packages/app-web-docs/src/docs/user/modifiers/everyScope.mdx b/packages/app-web-docs/src/docs/user/modifiers/everyScope.mdx index 2f8c4db466..f8add57226 100644 --- a/packages/app-web-docs/src/docs/user/modifiers/everyScope.mdx +++ b/packages/app-web-docs/src/docs/user/modifiers/everyScope.mdx @@ -1,5 +1,11 @@ -import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; - # Every scope - +Cursorless ID: `everyScope` + +## Spoken form + +Default: `every` + +## Syntax + +- every ``: Every instance of ``. diff --git a/packages/app-web-docs/src/docs/user/modifiers/excludeInterior.mdx b/packages/app-web-docs/src/docs/user/modifiers/excludeInterior.mdx index 18735cc316..6eb3e90a79 100644 --- a/packages/app-web-docs/src/docs/user/modifiers/excludeInterior.mdx +++ b/packages/app-web-docs/src/docs/user/modifiers/excludeInterior.mdx @@ -1,5 +1,11 @@ -import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; - # Exclude interior - +Cursorless ID: `excludeInterior` + +## Spoken form + +Default: `bounds` + +## Syntax + +- bounds: Bounding paired delimiters. diff --git a/packages/app-web-docs/src/docs/user/modifiers/extendThroughEndOf.mdx b/packages/app-web-docs/src/docs/user/modifiers/extendThroughEndOf.mdx index 20169c9500..0b503d7400 100644 --- a/packages/app-web-docs/src/docs/user/modifiers/extendThroughEndOf.mdx +++ b/packages/app-web-docs/src/docs/user/modifiers/extendThroughEndOf.mdx @@ -1,5 +1,12 @@ -import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; - # Extend through end of - +Cursorless ID: `extendThroughEndOf` + +## Spoken form + +Default: `tail` + +## Syntax + +- tail: Extend through end of line/pair. +- tail ``: Extend through end of ``. diff --git a/packages/app-web-docs/src/docs/user/modifiers/extendThroughStartOf.mdx b/packages/app-web-docs/src/docs/user/modifiers/extendThroughStartOf.mdx index 3cd78bd057..529b192626 100644 --- a/packages/app-web-docs/src/docs/user/modifiers/extendThroughStartOf.mdx +++ b/packages/app-web-docs/src/docs/user/modifiers/extendThroughStartOf.mdx @@ -1,5 +1,12 @@ -import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; - # Extend through start of - +Cursorless ID: `extendThroughStartOf` + +## Spoken form + +Default: `head` + +## Syntax + +- head: Extend through start of line/pair. +- head ``: Extend through start of ``. diff --git a/packages/app-web-docs/src/docs/user/modifiers/inferPreviousMark.mdx b/packages/app-web-docs/src/docs/user/modifiers/inferPreviousMark.mdx index dec5a55491..5d16081873 100644 --- a/packages/app-web-docs/src/docs/user/modifiers/inferPreviousMark.mdx +++ b/packages/app-web-docs/src/docs/user/modifiers/inferPreviousMark.mdx @@ -1,5 +1,11 @@ -import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; - # Infer previous mark - +Cursorless ID: `inferPreviousMark` + +## Spoken form + +Default: `its` + +## Syntax + +- its: Infer previous mark. diff --git a/packages/app-web-docs/src/docs/user/modifiers/interiorOnly.mdx b/packages/app-web-docs/src/docs/user/modifiers/interiorOnly.mdx index 93240f2a98..82a90963ba 100644 --- a/packages/app-web-docs/src/docs/user/modifiers/interiorOnly.mdx +++ b/packages/app-web-docs/src/docs/user/modifiers/interiorOnly.mdx @@ -1,5 +1,11 @@ -import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; - # Interior only - +Cursorless ID: `interiorOnly` + +## Spoken form + +Default: `inside` + +## Syntax + +- inside: Interior only. diff --git a/packages/app-web-docs/src/docs/user/modifiers/keepContentFilter.mdx b/packages/app-web-docs/src/docs/user/modifiers/keepContentFilter.mdx index 59966a274f..b7016d7a34 100644 --- a/packages/app-web-docs/src/docs/user/modifiers/keepContentFilter.mdx +++ b/packages/app-web-docs/src/docs/user/modifiers/keepContentFilter.mdx @@ -1,5 +1,11 @@ -import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; - # Keep content filter - +Cursorless ID: `keepContentFilter` + +## Spoken form + +Default: `content` + +## Syntax + +- content: Keep content filter. diff --git a/packages/app-web-docs/src/docs/user/modifiers/keepEmptyFilter.mdx b/packages/app-web-docs/src/docs/user/modifiers/keepEmptyFilter.mdx index 0f071237f2..ad485607a5 100644 --- a/packages/app-web-docs/src/docs/user/modifiers/keepEmptyFilter.mdx +++ b/packages/app-web-docs/src/docs/user/modifiers/keepEmptyFilter.mdx @@ -1,5 +1,11 @@ -import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; - # Keep empty filter - +Cursorless ID: `keepEmptyFilter` + +## Spoken form + +Default: `empty` + +## Syntax + +- empty: Keep empty filter. diff --git a/packages/app-web-docs/src/docs/user/modifiers/leading.mdx b/packages/app-web-docs/src/docs/user/modifiers/leading.mdx index 92343b63c4..8d2f97d26a 100644 --- a/packages/app-web-docs/src/docs/user/modifiers/leading.mdx +++ b/packages/app-web-docs/src/docs/user/modifiers/leading.mdx @@ -1,5 +1,11 @@ -import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; - # Leading - +Cursorless ID: `leading` + +## Spoken form + +Default: `leading` + +## Syntax + +- leading: Leading delimiter range. diff --git a/packages/app-web-docs/src/docs/user/modifiers/ordinalScope.mdx b/packages/app-web-docs/src/docs/user/modifiers/ordinalScope.mdx index 36d1abe6c6..811bda5be9 100644 --- a/packages/app-web-docs/src/docs/user/modifiers/ordinalScope.mdx +++ b/packages/app-web-docs/src/docs/user/modifiers/ordinalScope.mdx @@ -1,5 +1,12 @@ -import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; - # Ordinal scope - +Cursorless ID: `ordinalScope` + +## Syntax + +- `` ``: `` instance of `` in iteration scope. +- `` last ``: ``-to-last instance of `` in iteration scope. +- first `` ``s: First `` instances of `` in iteration scope, as contiguous range. +- every first `` ``s: First `` instances of `` in iteration scope, as individual targets. +- last `` ``s: Last `` instances of `` in iteration scope, as contiguous range. +- every last `` ``s: Last `` instances of `` in iteration scope, as individual targets. diff --git a/packages/app-web-docs/src/docs/user/modifiers/relativeScope.mdx b/packages/app-web-docs/src/docs/user/modifiers/relativeScope.mdx index f1776644c2..17f60ebbcd 100644 --- a/packages/app-web-docs/src/docs/user/modifiers/relativeScope.mdx +++ b/packages/app-web-docs/src/docs/user/modifiers/relativeScope.mdx @@ -1,5 +1,20 @@ -import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; - # Relative scope - +Cursorless ID: `relativeScope` + +## Syntax + +- previous ``: Previous instance of ``. +- `` previous ``: `` instance of `` before target. +- next ``: Next instance of ``. +- `` next ``: `` instance of `` after target. +- `` backward: Single instance of `` including target, going backwards. +- `` forward: Single instance of `` including target, going forwards. +- `` ``s backward: `` instances of `` including target, going backwards, as contiguous range. +- every `` ``s backward: `` instances of `` including target, going backwards, as individual targets. +- `` ``s: `` instances of `` including target, going forwards, as contiguous range. +- every `` ``s: `` instances of `` including target, going forwards, as individual targets. +- previous `` ``s: Previous `` instances of ``, as contiguous range. +- every previous `` ``s: Previous `` instances of ``, as individual targets. +- next `` ``s: Next `` instances of ``, as contiguous range. +- every next `` ``s: Next `` instances of ``, as individual targets. diff --git a/packages/app-web-docs/src/docs/user/modifiers/startOf.mdx b/packages/app-web-docs/src/docs/user/modifiers/startOf.mdx index 4dd5ec4e2f..aa7ea21daa 100644 --- a/packages/app-web-docs/src/docs/user/modifiers/startOf.mdx +++ b/packages/app-web-docs/src/docs/user/modifiers/startOf.mdx @@ -1,5 +1,11 @@ -import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; - # Start of - +Cursorless ID: `startOf` + +## Spoken form + +Default: `start of` + +## Syntax + +- start of: Empty position at start of target. diff --git a/packages/app-web-docs/src/docs/user/modifiers/toRawSelection.mdx b/packages/app-web-docs/src/docs/user/modifiers/toRawSelection.mdx index 92452c05ef..79aa46b991 100644 --- a/packages/app-web-docs/src/docs/user/modifiers/toRawSelection.mdx +++ b/packages/app-web-docs/src/docs/user/modifiers/toRawSelection.mdx @@ -1,5 +1,11 @@ -import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; - # Raw selection - +Cursorless ID: `toRawSelection` + +## Spoken form + +Default: `just` + +## Syntax + +- just: No inference. diff --git a/packages/app-web-docs/src/docs/user/modifiers/trailing.mdx b/packages/app-web-docs/src/docs/user/modifiers/trailing.mdx index 957d53bb13..cdf6807416 100644 --- a/packages/app-web-docs/src/docs/user/modifiers/trailing.mdx +++ b/packages/app-web-docs/src/docs/user/modifiers/trailing.mdx @@ -1,5 +1,11 @@ -import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; - # Trailing - +Cursorless ID: `trailing` + +## Spoken form + +Default: `trailing` + +## Syntax + +- trailing: Trailing delimiter range. diff --git a/packages/app-web-docs/src/docs/user/modifiers/visible.mdx b/packages/app-web-docs/src/docs/user/modifiers/visible.mdx index 959a201e34..6678e13c66 100644 --- a/packages/app-web-docs/src/docs/user/modifiers/visible.mdx +++ b/packages/app-web-docs/src/docs/user/modifiers/visible.mdx @@ -1,5 +1,11 @@ -import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; - # Visible - +Cursorless ID: `visible` + +## Spoken form + +Default: `visible` + +## Syntax + +- visible: Visible in viewport. diff --git a/packages/app-web-docs/src/docs/user/scopes/anonymousFunction.mdx b/packages/app-web-docs/src/docs/user/scopes/anonymousFunction.mdx index f3a4aed047..a47bd16c86 100644 --- a/packages/app-web-docs/src/docs/user/scopes/anonymousFunction.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/anonymousFunction.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Anonymous function - +Cursorless ID: `anonymousFunction` + +## Spoken form + +Default: `lambda` + +## Syntax + +- lambda: Anonymous function. + diff --git a/packages/app-web-docs/src/docs/user/scopes/argumentList.mdx b/packages/app-web-docs/src/docs/user/scopes/argumentList.mdx index ecb9da7a56..081766e5bc 100644 --- a/packages/app-web-docs/src/docs/user/scopes/argumentList.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/argumentList.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Argument list - +Cursorless ID: `argumentList` + +## Spoken form + +Default: `arg list` + +## Syntax + +- arg list: Argument list. + diff --git a/packages/app-web-docs/src/docs/user/scopes/argumentOrParameter.mdx b/packages/app-web-docs/src/docs/user/scopes/argumentOrParameter.mdx index bfbec123c2..a38f9d6b49 100644 --- a/packages/app-web-docs/src/docs/user/scopes/argumentOrParameter.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/argumentOrParameter.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Argument or parameter - +Cursorless ID: `argumentOrParameter` + +## Spoken form + +Default: `arg` + +## Syntax + +- arg: Argument. + diff --git a/packages/app-web-docs/src/docs/user/scopes/attribute.mdx b/packages/app-web-docs/src/docs/user/scopes/attribute.mdx index 56fb278f19..38eb84adaa 100644 --- a/packages/app-web-docs/src/docs/user/scopes/attribute.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/attribute.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Attribute - +Cursorless ID: `attribute` + +## Spoken form + +Default: `attribute` + +## Syntax + +- attribute: Attribute. + diff --git a/packages/app-web-docs/src/docs/user/scopes/boundedNonWhitespaceSequence.mdx b/packages/app-web-docs/src/docs/user/scopes/boundedNonWhitespaceSequence.mdx index f0e2921743..4aac14a632 100644 --- a/packages/app-web-docs/src/docs/user/scopes/boundedNonWhitespaceSequence.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/boundedNonWhitespaceSequence.mdx @@ -2,10 +2,18 @@ sidebar_label: Bounded non-ws sequence --- -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Bounded non-whitespace sequence - +Cursorless ID: `boundedNonWhitespaceSequence` + +## Spoken form + +Default: `short paint` + +## Syntax + +- short paint: Non-whitespace sequence bounded by surrounding pair delimiters. + diff --git a/packages/app-web-docs/src/docs/user/scopes/boundedParagraph.mdx b/packages/app-web-docs/src/docs/user/scopes/boundedParagraph.mdx index f9961c46c1..a40429b28f 100644 --- a/packages/app-web-docs/src/docs/user/scopes/boundedParagraph.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/boundedParagraph.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Bounded paragraph - +Cursorless ID: `boundedParagraph` + +## Spoken form + +Default: `short block` + +## Syntax + +- short block: Paragraph bounded by surrounding pair delimiters. + diff --git a/packages/app-web-docs/src/docs/user/scopes/branch.mdx b/packages/app-web-docs/src/docs/user/scopes/branch.mdx index 7d1cfbeb21..6319e1e520 100644 --- a/packages/app-web-docs/src/docs/user/scopes/branch.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/branch.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Branch - +Cursorless ID: `branch` + +## Spoken form + +Default: `branch` + +## Syntax + +- branch: Branch. + diff --git a/packages/app-web-docs/src/docs/user/scopes/chapter.mdx b/packages/app-web-docs/src/docs/user/scopes/chapter.mdx index 5a7baeeeb7..e40992795b 100644 --- a/packages/app-web-docs/src/docs/user/scopes/chapter.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/chapter.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Chapter - +Cursorless ID: `chapter` + +## Spoken form + +Default: `chapter` + +## Syntax + +- chapter: Chapter. + diff --git a/packages/app-web-docs/src/docs/user/scopes/character.mdx b/packages/app-web-docs/src/docs/user/scopes/character.mdx index f0e57fd647..952eb56ad2 100644 --- a/packages/app-web-docs/src/docs/user/scopes/character.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/character.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Character - +Cursorless ID: `character` + +## Spoken form + +Default: `char` + +## Syntax + +- char: Character. + diff --git a/packages/app-web-docs/src/docs/user/scopes/class.mdx b/packages/app-web-docs/src/docs/user/scopes/class.mdx index 0d36f96e64..54732d6896 100644 --- a/packages/app-web-docs/src/docs/user/scopes/class.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/class.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Class - +Cursorless ID: `class` + +## Spoken form + +Default: `class` + +## Syntax + +- class: Class. + diff --git a/packages/app-web-docs/src/docs/user/scopes/className.mdx b/packages/app-web-docs/src/docs/user/scopes/className.mdx index 0169a509fb..d7009742fe 100644 --- a/packages/app-web-docs/src/docs/user/scopes/className.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/className.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Class name - +Cursorless ID: `className` + +## Spoken form + +Default: `class name` + +## Syntax + +- class name: Class name. + diff --git a/packages/app-web-docs/src/docs/user/scopes/collectionItem.mdx b/packages/app-web-docs/src/docs/user/scopes/collectionItem.mdx index 12a7b5f755..ae9588c548 100644 --- a/packages/app-web-docs/src/docs/user/scopes/collectionItem.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/collectionItem.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Collection item - +Cursorless ID: `collectionItem` + +## Spoken form + +Default: `item` + +## Syntax + +- item: Collection item. + diff --git a/packages/app-web-docs/src/docs/user/scopes/collectionKey.mdx b/packages/app-web-docs/src/docs/user/scopes/collectionKey.mdx index b796f2a860..cfaf4c2b0c 100644 --- a/packages/app-web-docs/src/docs/user/scopes/collectionKey.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/collectionKey.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Collection key - +Cursorless ID: `collectionKey` + +## Spoken form + +Default: `key` + +## Syntax + +- key: Collection key. + diff --git a/packages/app-web-docs/src/docs/user/scopes/command.mdx b/packages/app-web-docs/src/docs/user/scopes/command.mdx index 90eb5174a4..61f1ac178a 100644 --- a/packages/app-web-docs/src/docs/user/scopes/command.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/command.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Command - +Cursorless ID: `command` + +## Spoken form + +Default: `command` + +## Syntax + +- command: Command. + diff --git a/packages/app-web-docs/src/docs/user/scopes/comment.mdx b/packages/app-web-docs/src/docs/user/scopes/comment.mdx index b0790be3ad..2dd7896494 100644 --- a/packages/app-web-docs/src/docs/user/scopes/comment.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/comment.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Comment - +Cursorless ID: `comment` + +## Spoken form + +Default: `comment` + +## Syntax + +- comment: Comment. + diff --git a/packages/app-web-docs/src/docs/user/scopes/condition.mdx b/packages/app-web-docs/src/docs/user/scopes/condition.mdx index f39241a52b..e7f45152b0 100644 --- a/packages/app-web-docs/src/docs/user/scopes/condition.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/condition.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Condition - +Cursorless ID: `condition` + +## Spoken form + +Default: `condition` + +## Syntax + +- condition: Condition. + diff --git a/packages/app-web-docs/src/docs/user/scopes/document.mdx b/packages/app-web-docs/src/docs/user/scopes/document.mdx index ff98dcf3be..e1267b8be0 100644 --- a/packages/app-web-docs/src/docs/user/scopes/document.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/document.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Document - +Cursorless ID: `document` + +## Spoken form + +Default: `file` + +## Syntax + +- file: Document. + diff --git a/packages/app-web-docs/src/docs/user/scopes/environment.mdx b/packages/app-web-docs/src/docs/user/scopes/environment.mdx index f1ebdbe002..a1b80532fe 100644 --- a/packages/app-web-docs/src/docs/user/scopes/environment.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/environment.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Environment - +Cursorless ID: `environment` + +## Spoken form + +Default: `environment` + +## Syntax + +- environment: Environment. + diff --git a/packages/app-web-docs/src/docs/user/scopes/fullLine.mdx b/packages/app-web-docs/src/docs/user/scopes/fullLine.mdx index 3653ec4be2..dae800b9b3 100644 --- a/packages/app-web-docs/src/docs/user/scopes/fullLine.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/fullLine.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Full line - +Cursorless ID: `fullLine` + +## Spoken form + +Default: `full line` + +## Syntax + +- full line: Full line. + diff --git a/packages/app-web-docs/src/docs/user/scopes/functionCall.mdx b/packages/app-web-docs/src/docs/user/scopes/functionCall.mdx index 6f3d1f7a47..ba1fc8cd8b 100644 --- a/packages/app-web-docs/src/docs/user/scopes/functionCall.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/functionCall.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Function call - +Cursorless ID: `functionCall` + +## Spoken form + +Default: `call` + +## Syntax + +- call: Function call. + diff --git a/packages/app-web-docs/src/docs/user/scopes/functionCallee.mdx b/packages/app-web-docs/src/docs/user/scopes/functionCallee.mdx index 4d015a0aef..cc809e1443 100644 --- a/packages/app-web-docs/src/docs/user/scopes/functionCallee.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/functionCallee.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Function callee - +Cursorless ID: `functionCallee` + +## Spoken form + +Default: `callee` + +## Syntax + +- callee: Function callee. + diff --git a/packages/app-web-docs/src/docs/user/scopes/functionName.mdx b/packages/app-web-docs/src/docs/user/scopes/functionName.mdx index 545aa0dd44..7ccaa99212 100644 --- a/packages/app-web-docs/src/docs/user/scopes/functionName.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/functionName.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Function name - +Cursorless ID: `functionName` + +## Spoken form + +Default: `funk name` + +## Syntax + +- funk name: Function name. + diff --git a/packages/app-web-docs/src/docs/user/scopes/glyph.mdx b/packages/app-web-docs/src/docs/user/scopes/glyph.mdx index 00f52036e4..1de8ee15a9 100644 --- a/packages/app-web-docs/src/docs/user/scopes/glyph.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/glyph.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Glyph - +Cursorless ID: `glyph` + +## Spoken form + +Default: `glyph` + +## Syntax + +- glyph ``: Instance of single character ``. + diff --git a/packages/app-web-docs/src/docs/user/scopes/identifier.mdx b/packages/app-web-docs/src/docs/user/scopes/identifier.mdx index d1d487ae8d..eb89bd9c7a 100644 --- a/packages/app-web-docs/src/docs/user/scopes/identifier.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/identifier.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Identifier - +Cursorless ID: `identifier` + +## Spoken form + +Default: `identifier` + +## Syntax + +- identifier: Identifier. + diff --git a/packages/app-web-docs/src/docs/user/scopes/ifStatement.mdx b/packages/app-web-docs/src/docs/user/scopes/ifStatement.mdx index 01d99cb476..32dd292d0e 100644 --- a/packages/app-web-docs/src/docs/user/scopes/ifStatement.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/ifStatement.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # If statement - +Cursorless ID: `ifStatement` + +## Spoken form + +Default: `if state` + +## Syntax + +- if state: If statement. + diff --git a/packages/app-web-docs/src/docs/user/scopes/instance.mdx b/packages/app-web-docs/src/docs/user/scopes/instance.mdx index 62108da08c..e90bb9e002 100644 --- a/packages/app-web-docs/src/docs/user/scopes/instance.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/instance.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Instance - +Cursorless ID: `instance` + +## Spoken form + +Default: `instance` + +## Syntax + +- instance: Instance. + diff --git a/packages/app-web-docs/src/docs/user/scopes/line.mdx b/packages/app-web-docs/src/docs/user/scopes/line.mdx index 401642cc43..e8c8689dee 100644 --- a/packages/app-web-docs/src/docs/user/scopes/line.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/line.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Line - +Cursorless ID: `line` + +## Spoken form + +Default: `line` + +## Syntax + +- line: Line. + diff --git a/packages/app-web-docs/src/docs/user/scopes/list.mdx b/packages/app-web-docs/src/docs/user/scopes/list.mdx index d3e368f538..e160b1350f 100644 --- a/packages/app-web-docs/src/docs/user/scopes/list.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/list.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # List - +Cursorless ID: `list` + +## Spoken form + +Default: `list` + +## Syntax + +- list: List. + diff --git a/packages/app-web-docs/src/docs/user/scopes/map.mdx b/packages/app-web-docs/src/docs/user/scopes/map.mdx index 919201be61..8aae8ba45c 100644 --- a/packages/app-web-docs/src/docs/user/scopes/map.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/map.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Map - +Cursorless ID: `map` + +## Spoken form + +Default: `map` + +## Syntax + +- map: Map. + diff --git a/packages/app-web-docs/src/docs/user/scopes/name.mdx b/packages/app-web-docs/src/docs/user/scopes/name.mdx index 1e173e7614..fb1bdd4313 100644 --- a/packages/app-web-docs/src/docs/user/scopes/name.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/name.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Name - +Cursorless ID: `name` + +## Spoken form + +Default: `name` + +## Syntax + +- name: Name. + diff --git a/packages/app-web-docs/src/docs/user/scopes/namedFunction.mdx b/packages/app-web-docs/src/docs/user/scopes/namedFunction.mdx index 8dff438f9c..adcc4d9545 100644 --- a/packages/app-web-docs/src/docs/user/scopes/namedFunction.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/namedFunction.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Named function - +Cursorless ID: `namedFunction` + +## Spoken form + +Default: `funk` + +## Syntax + +- funk: Named function. + diff --git a/packages/app-web-docs/src/docs/user/scopes/namedParagraph.mdx b/packages/app-web-docs/src/docs/user/scopes/namedParagraph.mdx index ca38ea13fd..00893b4277 100644 --- a/packages/app-web-docs/src/docs/user/scopes/namedParagraph.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/namedParagraph.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Named paragraph - +Cursorless ID: `namedParagraph` + +## Spoken form + +Default: `paragraph` + +## Syntax + +- paragraph: Named paragraph. + diff --git a/packages/app-web-docs/src/docs/user/scopes/nonWhitespaceSequence.mdx b/packages/app-web-docs/src/docs/user/scopes/nonWhitespaceSequence.mdx index 72a21072b1..4c191cd44a 100644 --- a/packages/app-web-docs/src/docs/user/scopes/nonWhitespaceSequence.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/nonWhitespaceSequence.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Non-whitespace sequence - +Cursorless ID: `nonWhitespaceSequence` + +## Spoken form + +Default: `paint` + +## Syntax + +- paint: Non-whitespace sequence. + diff --git a/packages/app-web-docs/src/docs/user/scopes/notebookCell.mdx b/packages/app-web-docs/src/docs/user/scopes/notebookCell.mdx index 7939ad2042..43d4cfecd7 100644 --- a/packages/app-web-docs/src/docs/user/scopes/notebookCell.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/notebookCell.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Notebook cell - +Cursorless ID: `notebookCell` + +## Spoken form + +Default: `cell` + +## Syntax + +- cell: Notebook cell. + diff --git a/packages/app-web-docs/src/docs/user/scopes/paragraph.mdx b/packages/app-web-docs/src/docs/user/scopes/paragraph.mdx index 00bd32657b..51dc0feed1 100644 --- a/packages/app-web-docs/src/docs/user/scopes/paragraph.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/paragraph.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Paragraph - +Cursorless ID: `paragraph` + +## Spoken form + +Default: `block` + +## Syntax + +- block: Paragraph. + diff --git a/packages/app-web-docs/src/docs/user/scopes/part.mdx b/packages/app-web-docs/src/docs/user/scopes/part.mdx index 3f2dd1473e..42cd85460d 100644 --- a/packages/app-web-docs/src/docs/user/scopes/part.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/part.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Part - +Cursorless ID: `part` + +## Spoken form + +Default: `part` + +## Syntax + +- part: Part. + diff --git a/packages/app-web-docs/src/docs/user/scopes/regularExpression.mdx b/packages/app-web-docs/src/docs/user/scopes/regularExpression.mdx index 13db26d17d..2fc5a46ec9 100644 --- a/packages/app-web-docs/src/docs/user/scopes/regularExpression.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/regularExpression.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Regular expression - +Cursorless ID: `regularExpression` + +## Spoken form + +Default: `regex` + +## Syntax + +- regex: Regular expression. + diff --git a/packages/app-web-docs/src/docs/user/scopes/section.mdx b/packages/app-web-docs/src/docs/user/scopes/section.mdx index 01a62de66e..1d3f7c5b97 100644 --- a/packages/app-web-docs/src/docs/user/scopes/section.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/section.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Section - +Cursorless ID: `section` + +## Spoken form + +Default: `section` + +## Syntax + +- section: Section. + diff --git a/packages/app-web-docs/src/docs/user/scopes/sectionLevelFive.mdx b/packages/app-web-docs/src/docs/user/scopes/sectionLevelFive.mdx index 6d6caf8210..7af86a3378 100644 --- a/packages/app-web-docs/src/docs/user/scopes/sectionLevelFive.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/sectionLevelFive.mdx @@ -1,7 +1,16 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Section level five - +Cursorless ID: `sectionLevelFive` + +## Spoken form + +Default: `five section`\ +**Disabled by default** + +## Syntax + +- five section: Section level five. + diff --git a/packages/app-web-docs/src/docs/user/scopes/sectionLevelFour.mdx b/packages/app-web-docs/src/docs/user/scopes/sectionLevelFour.mdx index d5efcabb4c..aeef649dfa 100644 --- a/packages/app-web-docs/src/docs/user/scopes/sectionLevelFour.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/sectionLevelFour.mdx @@ -1,7 +1,16 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Section level four - +Cursorless ID: `sectionLevelFour` + +## Spoken form + +Default: `four section`\ +**Disabled by default** + +## Syntax + +- four section: Section level four. + diff --git a/packages/app-web-docs/src/docs/user/scopes/sectionLevelOne.mdx b/packages/app-web-docs/src/docs/user/scopes/sectionLevelOne.mdx index 75557736d2..b92e71d531 100644 --- a/packages/app-web-docs/src/docs/user/scopes/sectionLevelOne.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/sectionLevelOne.mdx @@ -1,7 +1,16 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Section level one - +Cursorless ID: `sectionLevelOne` + +## Spoken form + +Default: `one section`\ +**Disabled by default** + +## Syntax + +- one section: Section level one. + diff --git a/packages/app-web-docs/src/docs/user/scopes/sectionLevelSix.mdx b/packages/app-web-docs/src/docs/user/scopes/sectionLevelSix.mdx index ba57de133a..4199611ace 100644 --- a/packages/app-web-docs/src/docs/user/scopes/sectionLevelSix.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/sectionLevelSix.mdx @@ -1,7 +1,16 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Section level six - +Cursorless ID: `sectionLevelSix` + +## Spoken form + +Default: `six section`\ +**Disabled by default** + +## Syntax + +- six section: Section level six. + diff --git a/packages/app-web-docs/src/docs/user/scopes/sectionLevelThree.mdx b/packages/app-web-docs/src/docs/user/scopes/sectionLevelThree.mdx index 9141f87946..cea79f312e 100644 --- a/packages/app-web-docs/src/docs/user/scopes/sectionLevelThree.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/sectionLevelThree.mdx @@ -1,7 +1,16 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Section level three - +Cursorless ID: `sectionLevelThree` + +## Spoken form + +Default: `three section`\ +**Disabled by default** + +## Syntax + +- three section: Section level three. + diff --git a/packages/app-web-docs/src/docs/user/scopes/sectionLevelTwo.mdx b/packages/app-web-docs/src/docs/user/scopes/sectionLevelTwo.mdx index caaa175ed8..f39cc5f990 100644 --- a/packages/app-web-docs/src/docs/user/scopes/sectionLevelTwo.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/sectionLevelTwo.mdx @@ -1,7 +1,16 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Section level two - +Cursorless ID: `sectionLevelTwo` + +## Spoken form + +Default: `two section`\ +**Disabled by default** + +## Syntax + +- two section: Section level two. + diff --git a/packages/app-web-docs/src/docs/user/scopes/selector.mdx b/packages/app-web-docs/src/docs/user/scopes/selector.mdx index 97f0d16284..1149a0905c 100644 --- a/packages/app-web-docs/src/docs/user/scopes/selector.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/selector.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Selector - +Cursorless ID: `selector` + +## Spoken form + +Default: `selector` + +## Syntax + +- selector: Selector. + diff --git a/packages/app-web-docs/src/docs/user/scopes/sentence.mdx b/packages/app-web-docs/src/docs/user/scopes/sentence.mdx index e61247b280..f5e777bdb3 100644 --- a/packages/app-web-docs/src/docs/user/scopes/sentence.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/sentence.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Sentence - +Cursorless ID: `sentence` + +## Spoken form + +Default: `sentence` + +## Syntax + +- sentence: Sentence. + diff --git a/packages/app-web-docs/src/docs/user/scopes/statement.mdx b/packages/app-web-docs/src/docs/user/scopes/statement.mdx index 547024be52..a9b721ab0e 100644 --- a/packages/app-web-docs/src/docs/user/scopes/statement.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/statement.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Statement - +Cursorless ID: `statement` + +## Spoken form + +Default: `state` + +## Syntax + +- state: Statement. + diff --git a/packages/app-web-docs/src/docs/user/scopes/subParagraph.mdx b/packages/app-web-docs/src/docs/user/scopes/subParagraph.mdx index 06d6bf6157..6e1e73abfc 100644 --- a/packages/app-web-docs/src/docs/user/scopes/subParagraph.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/subParagraph.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Subparagraph - +Cursorless ID: `subParagraph` + +## Spoken form + +Default: `subparagraph` + +## Syntax + +- subparagraph: Subparagraph. + diff --git a/packages/app-web-docs/src/docs/user/scopes/subSection.mdx b/packages/app-web-docs/src/docs/user/scopes/subSection.mdx index f0d032d1e5..a60e7c8714 100644 --- a/packages/app-web-docs/src/docs/user/scopes/subSection.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/subSection.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Subsection - +Cursorless ID: `subSection` + +## Spoken form + +Default: `subsection` + +## Syntax + +- subsection: Subsection. + diff --git a/packages/app-web-docs/src/docs/user/scopes/subSubSection.mdx b/packages/app-web-docs/src/docs/user/scopes/subSubSection.mdx index 95eed1890d..6df78a5f66 100644 --- a/packages/app-web-docs/src/docs/user/scopes/subSubSection.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/subSubSection.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Subsubsection - +Cursorless ID: `subSubSection` + +## Spoken form + +Default: `subsubsection` + +## Syntax + +- subsubsection: Subsubsection. + diff --git a/packages/app-web-docs/src/docs/user/scopes/surroundingPair.mdx b/packages/app-web-docs/src/docs/user/scopes/surroundingPair.mdx index 6217c8b259..f1f0f05eac 100644 --- a/packages/app-web-docs/src/docs/user/scopes/surroundingPair.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/surroundingPair.mdx @@ -1,7 +1,11 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Surrounding pair - +Cursorless ID: `surroundingPair` + +## Syntax + +- ``: Surrounding pair. + diff --git a/packages/app-web-docs/src/docs/user/scopes/token.mdx b/packages/app-web-docs/src/docs/user/scopes/token.mdx index 49654a0745..ad20363905 100644 --- a/packages/app-web-docs/src/docs/user/scopes/token.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/token.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Token - +Cursorless ID: `token` + +## Spoken form + +Default: `token` + +## Syntax + +- token: Token. + diff --git a/packages/app-web-docs/src/docs/user/scopes/type.mdx b/packages/app-web-docs/src/docs/user/scopes/type.mdx index 9aeb23d078..e618496344 100644 --- a/packages/app-web-docs/src/docs/user/scopes/type.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/type.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Type - +Cursorless ID: `type` + +## Spoken form + +Default: `type` + +## Syntax + +- type: Type. + diff --git a/packages/app-web-docs/src/docs/user/scopes/unit.mdx b/packages/app-web-docs/src/docs/user/scopes/unit.mdx index 83128877dd..ec8afaf7b7 100644 --- a/packages/app-web-docs/src/docs/user/scopes/unit.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/unit.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Unit - +Cursorless ID: `unit` + +## Spoken form + +Default: `unit` + +## Syntax + +- unit: Unit. + diff --git a/packages/app-web-docs/src/docs/user/scopes/url.mdx b/packages/app-web-docs/src/docs/user/scopes/url.mdx index 78f9480d8a..1a38067803 100644 --- a/packages/app-web-docs/src/docs/user/scopes/url.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/url.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # URL - +Cursorless ID: `url` + +## Spoken form + +Default: `link` + +## Syntax + +- link: URL. + diff --git a/packages/app-web-docs/src/docs/user/scopes/value.mdx b/packages/app-web-docs/src/docs/user/scopes/value.mdx index abfb5568be..340febe9d2 100644 --- a/packages/app-web-docs/src/docs/user/scopes/value.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/value.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Value - +Cursorless ID: `value` + +## Spoken form + +Default: `value` + +## Syntax + +- value: Value. + diff --git a/packages/app-web-docs/src/docs/user/scopes/word.mdx b/packages/app-web-docs/src/docs/user/scopes/word.mdx index 9e0279a1e3..9051496d9c 100644 --- a/packages/app-web-docs/src/docs/user/scopes/word.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/word.mdx @@ -1,7 +1,16 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # Sub token word - +Cursorless ID: `word` + +## Spoken form + +Default: `sub`\ +Legacy: `word` + +## Syntax + +- sub: Sub token word. + diff --git a/packages/app-web-docs/src/docs/user/scopes/xmlBothTags.mdx b/packages/app-web-docs/src/docs/user/scopes/xmlBothTags.mdx index 0aafaf8a3f..8218dfab62 100644 --- a/packages/app-web-docs/src/docs/user/scopes/xmlBothTags.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/xmlBothTags.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # XML both tags - +Cursorless ID: `xmlBothTags` + +## Spoken form + +Default: `tags` + +## Syntax + +- tags: XML both tags. + diff --git a/packages/app-web-docs/src/docs/user/scopes/xmlElement.mdx b/packages/app-web-docs/src/docs/user/scopes/xmlElement.mdx index 01a28194f2..f2582bdacd 100644 --- a/packages/app-web-docs/src/docs/user/scopes/xmlElement.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/xmlElement.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # XML element - +Cursorless ID: `xmlElement` + +## Spoken form + +Default: `element` + +## Syntax + +- element: XML element. + diff --git a/packages/app-web-docs/src/docs/user/scopes/xmlEndTag.mdx b/packages/app-web-docs/src/docs/user/scopes/xmlEndTag.mdx index 2edcecdeb9..8e28752f35 100644 --- a/packages/app-web-docs/src/docs/user/scopes/xmlEndTag.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/xmlEndTag.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # XML end tag - +Cursorless ID: `xmlEndTag` + +## Spoken form + +Default: `end tag` + +## Syntax + +- end tag: XML end tag. + diff --git a/packages/app-web-docs/src/docs/user/scopes/xmlStartTag.mdx b/packages/app-web-docs/src/docs/user/scopes/xmlStartTag.mdx index c6d491bc63..09bd6c3e28 100644 --- a/packages/app-web-docs/src/docs/user/scopes/xmlStartTag.mdx +++ b/packages/app-web-docs/src/docs/user/scopes/xmlStartTag.mdx @@ -1,7 +1,15 @@ -import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; import { Scopes } from "@site/src/docs/components/Scopes"; # XML start tag - +Cursorless ID: `xmlStartTag` + +## Spoken form + +Default: `start tag` + +## Syntax + +- start tag: XML start tag. + diff --git a/packages/tool-meta-updater/src/updateReferenceMdx.ts b/packages/tool-meta-updater/src/updateReferenceMdx.ts index 91d7fc9493..f0ca6e1aad 100644 --- a/packages/tool-meta-updater/src/updateReferenceMdx.ts +++ b/packages/tool-meta-updater/src/updateReferenceMdx.ts @@ -1,6 +1,8 @@ import type { FormatPluginFnOptions } from "@pnpm/meta-updater"; import type { ReferenceEntry } from "@cursorless/lib-common"; +const VAR_SPOKEN_FORM = ""; + export function updateReferenceMdx( kind: "action" | "modifier" | "scope", id: string, @@ -12,7 +14,6 @@ export function updateReferenceMdx( return null; } - const refComponentName = `${kind.charAt(0).toUpperCase() + kind.slice(1)}Reference`; const isScope = kind === "scope"; const expected: string[] = []; @@ -21,26 +22,111 @@ export function updateReferenceMdx( expected.push(`---`, `sidebar_label: ${entry.nameShort}`, `---`, ""); } - expected.push( - `import { ${refComponentName} } from "@site/src/docs/components/ReferenceEntry";`, - ); - if (isScope) { - expected.push(`import { Scopes } from "@site/src/docs/components/Scopes";`); + expected.push( + `import { Scopes } from "@site/src/docs/components/Scopes";`, + "", + ); } - expected.push( - "", - `# ${entry.name}`, - "", - `<${refComponentName} id="${id}" />`, - ); + expected.push(`# ${entry.name}`, ""); - if (isScope) { - expected.push(``); + if (entry.description != null) { + expected.push(entry.description, ""); } - expected.push(""); + expected.push(`Cursorless ID: ${code(id)}`, ""); + + const spokenFormLines: string[] = []; + + if (entry.defaultSpokenForm != null) { + spokenFormLines.push(`Default: ${code(entry.defaultSpokenForm)}`); + } + + if (entry.legacySpokenForms != null) { + spokenFormLines.push( + `Legacy: ${entry.legacySpokenForms.map((s) => code(s)).join(", ")}`, + ); + } + + if (entry.disabledByDefault) { + spokenFormLines.push(bold("Disabled by default")); + } + + if (spokenFormLines.length > 0) { + expected.push("## Spoken form", "", ...formatGroup(spokenFormLines), ""); + } + + if (entry.syntaxes.length > 0) { + expected.push(`## Syntax`, ""); + for (const syntax of entry.syntaxes) { + const pattern = formatVariables( + injectSpokenForm(syntax.pattern, entry.defaultSpokenForm), + ); + const description = formatVariables( + injectSpokenForm(syntax.description, entry.defaultSpokenForm), + ); + expected.push(`- ${pattern}: ${description}`); + } + expected.push(""); + } + + if (entry.examples.length > 0) { + expected.push(`## Examples`, ""); + for (const example of entry.examples) { + const command = injectSpokenForm( + example.command, + entry.defaultSpokenForm, + ); + expected.push(`- \`"${command}"\`: ${example.description}`); + } + expected.push(""); + } + + if (isScope) { + expected.push(``, ""); + } return expected.join("\n"); } + +function code(value: string) { + return `\`${value}\``; +} + +function bold(value: string) { + return `**${value}**`; +} + +function injectSpokenForm( + pattern: string, + defaultSpokenForm: string | undefined, +): string { + if (defaultSpokenForm == null) { + if (pattern.includes(VAR_SPOKEN_FORM)) { + throw new Error( + `Pattern "${pattern}" contains ${VAR_SPOKEN_FORM}, but no defaultSpokenForm is provided`, + ); + } + return pattern; + } + return pattern.replace(VAR_SPOKEN_FORM, defaultSpokenForm); +} + +function formatVariables(pattern: string): string { + return pattern + .split(/(<[\w ]+>)/gu) + .map((part) => { + if (part.startsWith("<") && part.endsWith(">")) { + return code(part); + } + return part; + }) + .join(""); +} + +function formatGroup(lines: string[]): string[] { + return lines.map((line, index) => + index < lines.length - 1 ? `${line}\\` : line, + ); +}