Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
145 changes: 145 additions & 0 deletions packages/app-web-docs/src/docs/user/actions/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
# Actions

## Cursor movement

- [`"take <target>"`](./setSelection.mdx) - Set selection to `<target>`.
- [`"pre <target>"`](./setSelectionBefore.mdx) - Set empty selection before `<target>`.
- [`"post <target>"`](./setSelectionAfter.mdx) - Set empty selection after `<target>`.
- [`"append <target>"`](./addSelection.mdx) - Adds `<target>` to the current selection set.
- [`"append pre <target>"`](./addSelectionBefore.mdx) - Adds empty selection before `<target>` to the current selection set.
- [`"append post <target>"`](./addSelectionAfter.mdx) - Adds empty selection after `<target>` to the current selection set.
- [`"give <target>"`](./deselect.mdx) - Deselect `<target>`.

## Changing a target

- [`"change <target>"`](./clearAndSetSelection.mdx) - Change `<target>` by clearing it and leaving the cursor in its place.
- [`"chuck <target>"`](./remove.mdx) - Remove `<target>`.

## Cut / copy / paste

- [`"carve <target>"`](./cutToClipboard.mdx) - Cut `<target>` to clipboard.
- [`"copy <target>"`](./copyToClipboard.mdx) - Copy `<target>` to clipboard.
- [`"paste <destination>"`](./pasteFromClipboard.mdx) - Paste from clipboard at `<destination>`.

## Insert / use / repeat

- [`"clone <target>"`](./insertCopyAfter.mdx) - Insert copy after `<target>`.
- [`"clone up <target>"`](./insertCopyBefore.mdx) - Insert copy before `<target>`.
- [`"bring <target>"`](./replaceWithTarget.mdx) - Insert copy of `<target>` at selection.
- [`"bring <target> <destination>"`](./replaceWithTarget.mdx) - Copy `<target>` to `<destination>`.
- [`"call <target>"`](./callAsFunction.mdx) - Insert call to `<target>` on selection.
- [`"call <target 1> on <target 2>"`](./callAsFunction.mdx) - Insert call to `<target 1>` on `<target 2>`.

## Swap

- [`"swap with <target>"`](./swapTargets.mdx) - Swap selection with `<target>`.
- [`"swap <target 1> with <target 2>"`](./swapTargets.mdx) - Swap `<target 1>` with `<target 2>`.

## Move / replace

- [`"move <target>"`](./moveToTarget.mdx) - Move `<target>` to selection.
- [`"move <target> <destination>"`](./moveToTarget.mdx) - Move `<target>` to `<destination>`.

## Indent / outdent

- [`"indent <target>"`](./indentLine.mdx) - Indent line containing `<target>`.
- [`"dedent <target>"`](./outdentLine.mdx) - Outdent line containing `<target>`.

## Insert empty lines / scopes

- [`"drink <target>"`](./editNewLineBefore.mdx) - Edit new line before `<target>`.
- [`"drink <scope> <target>"`](./editNewLineBefore.mdx) - Edit new `<scope>` before `<target>`.
- [`"pour <target>"`](./editNewLineAfter.mdx) - Edit new line after `<target>`.
- [`"pour <scope> <target>"`](./editNewLineAfter.mdx) - Edit new `<scope>` after `<target>`.
- [`"drop <target>"`](./insertEmptyLineBefore.mdx) - Insert empty line/scope before `<target>`.
- [`"float <target>"`](./insertEmptyLineAfter.mdx) - Insert empty line/scope after `<target>`.
- [`"puff <target>"`](./insertEmptyLinesAround.mdx) - Insert empty lines/scopes around `<target>`.

## Reverse / shuffle / sort

- [`"reverse <target>"`](./reverseTargets.mdx) - Reverse `<target>`s.
- [`"shuffle <target>"`](./randomizeTargets.mdx) - Randomize `<target>`s.
- [`"sort <target>"`](./sortTargets.mdx) - Sort `<target>`s.

## Wrap / rewrap

- [`"<pair> wrap <target>"`](./wrapWithPairedDelimiter.mdx) - Wrap `<target>` with `<pair>`.
- [`"<snippet> wrap <target>"`](./wrapWithPairedDelimiter.mdx) - Wrap `<target>` with `<snippet>`.
- [`"<pair> repack <target>"`](./rewrapWithPairedDelimiter.mdx) - Rewrap `<target>` with `<pair>`.

## Increment / decrement

- [`"increment <target>"`](./increment.mdx) - Increment number at `<target>`.
- [`"decrement <target>"`](./decrement.mdx) - Decrement number at `<target>`.

## Refactor / fix

- [`"rename <target>"`](./rename.mdx) - Rename `<target>`.
- [`"extract <target>"`](./extractVariable.mdx) - Extract variable from `<target>`.
- [`"quick fix <target>"`](./showQuickFix.mdx) - Show quick fix for `<target>`.

## Join / break

- [`"join <target>"`](./joinLines.mdx) - Join lines at `<target>`.
- [`"break <target>"`](./breakLine.mdx) - Breaks the line before `<target>`.

## Snippets

- [`"snip make <target>"`](./generateSnippet.mdx) - Generate snippet from `<target>`.
- [`"snip <snippet> <destination>"`](./insertSnippet.mdx) - Insert snippet at `<destination>`.

## Scroll

- [`"crown <target>"`](./scrollToTop.mdx) - Scroll `<target>` to top of the viewport.
- [`"center <target>"`](./scrollToCenter.mdx) - Scroll `<target>` to center of the viewport.
- [`"bottom <target>"`](./scrollToBottom.mdx) - Scroll `<target>` to bottom of the viewport.

## Fold / unfold

- [`"fold <target>"`](./foldRegion.mdx) - Fold region at `<target>`.
- [`"unfold <target>"`](./unfoldRegion.mdx) - Unfold region at `<target>`.

## Homophones

- [`"phones <target>"`](./nextHomophone.mdx) - Cycle to next homophone for `<target>`.

## Format

- [`"format <formatter> at <target>"`](./applyFormatter.mdx) - Reformat `<target>` as `<formatter>`.

## Instance reference

- [`"from <target>"`](./setInstanceReference.mdx) - Set instance reference to `<target>`.

## Comment

- [`"comment <target>"`](./toggleLineComment.mdx) - Toggle line comment at `<target>`.

## Breakpoint

- [`"break point <target>"`](./toggleLineBreakpoint.mdx) - Toggle breakpoint on line containing `<target>`.
- [`"break point token <target>"`](./toggleLineBreakpoint.mdx) - Toggle inline breakpoint at `<target>`.

## Navigate / inspect

- [`"define <target>"`](./revealDefinition.mdx) - Reveal definition of `<target>`.
- [`"type deaf <target>"`](./revealTypeDefinition.mdx) - Reveal type definition of `<target>`.
- [`"reference <target>"`](./showReferences.mdx) - Show references for `<target>`.
- [`"hover <target>"`](./showHover.mdx) - Show hover for `<target>`.
- [`"scout <target>"`](./findInDocument.mdx) - Find `<target>` in document.
- [`"scout all <target>"`](./findInWorkspace.mdx) - Find `<target>` in workspace.
- [`"follow <target>"`](./followLink.mdx) - Follow link at `<target>`.
- [`"follow split <target>"`](./followLinkAside.mdx) - Follow link at `<target>` aside (e.g. in a split view).
- [`"inspect <target>"`](./showDebugHover.mdx) - Show debug hover for `<target>`.

## Git

- [`"git accept <target>"`](./gitAccept.mdx) - Accept Git change at `<target>`.
- [`"git revert <target>"`](./gitRevert.mdx) - Revert Git change at `<target>`.
- [`"git stage <target>"`](./gitStage.mdx) - Stage Git change at `<target>`.
- [`"git unstage <target>"`](./gitUnstage.mdx) - Unstage Git change at `<target>`.

## Visual feedback

- [`"flash <target>"`](./flashTargets.mdx) - Flash `<target>`.
- [`"highlight <target>"`](./highlight.mdx) - Highlight `<target>`.
63 changes: 63 additions & 0 deletions packages/app-web-docs/src/docs/user/modifiers/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Modifiers

## Scope containment

- [`"<scope>"`](./containingScope.mdx) - Containing instance of `<scope>`.
- [`"every <scope>"`](./everyScope.mdx) - Every instance of `<scope>`.
- [`"grand <scope>"`](./ancestor.mdx) - Parent of the containing instance of `<scope>`.

## Ordinal scope

- [`"<ordinal> <scope>"`](./ordinalScope.mdx) - `<ordinal>` instance of `<scope>` in iteration scope.
- [`"<ordinal> last <scope>"`](./ordinalScope.mdx) - `<ordinal>`-to-last instance of `<scope>` in iteration scope.
- [`"first <number> <scope>s"`](./ordinalScope.mdx) - First `<number>` instances of `<scope>` in iteration scope, as contiguous range.
- [`"every first <number> <scope>s"`](./ordinalScope.mdx) - First `<number>` instances of `<scope>` in iteration scope, as individual targets.
- [`"last <number> <scope>s"`](./ordinalScope.mdx) - Last `<number>` instances of `<scope>` in iteration scope, as contiguous range.
- [`"every last <number> <scope>s"`](./ordinalScope.mdx) - Last `<number>` instances of `<scope>` in iteration scope, as individual targets.

## Relative scope

- [`"previous <scope>"`](./relativeScope.mdx) - Previous instance of `<scope>`.
- [`"<ordinal> previous <scope>"`](./relativeScope.mdx) - `<ordinal>` instance of `<scope>` before target.
- [`"next <scope>"`](./relativeScope.mdx) - Next instance of `<scope>`.
- [`"<ordinal> next <scope>"`](./relativeScope.mdx) - `<ordinal>` instance of `<scope>` after target.
- [`"<scope> backward"`](./relativeScope.mdx) - Single instance of `<scope>` including target, going backwards.
- [`"<scope> forward"`](./relativeScope.mdx) - Single instance of `<scope>` including target, going forwards.
- [`"<number> <scope>s backward"`](./relativeScope.mdx) - `<number>` instances of `<scope>` including target, going backwards, as contiguous range.
- [`"every <number> <scope>s backward"`](./relativeScope.mdx) - `<number>` instances of `<scope>` including target, going backwards, as individual targets.
- [`"<number> <scope>s"`](./relativeScope.mdx) - `<number>` instances of `<scope>` including target, going forwards, as contiguous range.
- [`"every <number> <scope>s"`](./relativeScope.mdx) - `<number>` instances of `<scope>` including target, going forwards, as individual targets.
- [`"previous <number> <scope>s"`](./relativeScope.mdx) - Previous `<number>` instances of `<scope>`, as contiguous range.
- [`"every previous <number> <scope>s"`](./relativeScope.mdx) - Previous `<number>` instances of `<scope>`, as individual targets.
- [`"next <number> <scope>s"`](./relativeScope.mdx) - Next `<number>` instances of `<scope>`, as contiguous range.
- [`"every next <number> <scope>s"`](./relativeScope.mdx) - Next `<number>` instances of `<scope>`, as individual targets.

## Interiors / delimiters

- [`"inside"`](./interiorOnly.mdx) - Interior only.
- [`"bounds"`](./excludeInterior.mdx) - Bounding paired delimiters.
- [`"leading"`](./leading.mdx) - Leading delimiter range.
- [`"trailing"`](./trailing.mdx) - Trailing delimiter range.

## Range extension

- [`"head"`](./extendThroughStartOf.mdx) - Extend through start of line/pair.
- [`"head <modifier>"`](./extendThroughStartOf.mdx) - Extend through start of `<modifier>`.
- [`"tail"`](./extendThroughEndOf.mdx) - Extend through end of line/pair.
- [`"tail <modifier>"`](./extendThroughEndOf.mdx) - Extend through end of `<modifier>`.

## Positions

- [`"start of"`](./startOf.mdx) - Empty position at start of target.
- [`"end of"`](./endOf.mdx) - Empty position at end of target.

## Filters

- [`"visible"`](./visible.mdx) - Visible in viewport.
- [`"content"`](./keepContentFilter.mdx) - Keep content filter.
- [`"empty"`](./keepEmptyFilter.mdx) - Keep empty filter.

## Inference

- [`"just"`](./toRawSelection.mdx) - No inference.
- [`"its"`](./inferPreviousMark.mdx) - Infer previous mark.
89 changes: 89 additions & 0 deletions packages/app-web-docs/src/docs/user/scopes/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# Scopes

## Text-based scopes

- [`"char"`](./character.mdx) - Single character within a token.
- [`"sub"`](./word.mdx) - Word-like component within a token, such as part of camelCase or snake_case.
- [`"token"`](./token.mdx) - Token such as a word, number, or operator.
- [`"identifier"`](./identifier.mdx) - Identifier-style sequence, such as camelCase, snake_case, or kebab-case.
- [`"sentence"`](./sentence.mdx) - Text ending at sentence punctuation or a paragraph boundary.
- [`"line"`](./line.mdx) - Line, without indentation.
- [`"full line"`](./fullLine.mdx) - Full line, including indentation.
- [`"block"`](./paragraph.mdx) - Paragraph, contiguous non-empty lines around the target.
- [`"short block"`](./boundedParagraph.mdx) - Paragraph bounded by surrounding pair delimiters.
- [`"file"`](./document.mdx) - Entire document.
- [`"paint"`](./nonWhitespaceSequence.mdx) - Non-whitespace sequence.
- [`"short paint"`](./boundedNonWhitespaceSequence.mdx) - Non-whitespace sequence bounded by surrounding pair delimiters.
- [`"link"`](./url.mdx) - URL / Web address.
- [`"<pair>"`](./surroundingPair.mdx) - Surrounding matching delimiter pair and its contents.
- [`"glyph <character>"`](./glyph.mdx) - Instance of single character `<character>`.

## Sections

- [`"section"`](./section.mdx) - Heading and its content through the next heading of the same or higher level.
- [`"one section"`](./sectionLevelOne.mdx) - Level-one heading and its content.
- [`"two section"`](./sectionLevelTwo.mdx) - Level-two heading and its content.
- [`"three section"`](./sectionLevelThree.mdx) - Level-three heading and its content.
- [`"four section"`](./sectionLevelFour.mdx) - Level-four heading and its content.
- [`"five section"`](./sectionLevelFive.mdx) - Level-five heading and its content.
- [`"six section"`](./sectionLevelSix.mdx) - Level-six heading and its content.

## Document hierarchy

- [`"part"`](./part.mdx) - Document part and its contents.
- [`"chapter"`](./chapter.mdx) - Document chapter and its contents.
- [`"subsection"`](./subSection.mdx) - Document subsection and its contents.
- [`"subsubsection"`](./subSubSection.mdx) - Document subsubsection and its contents.
- [`"paragraph"`](./namedParagraph.mdx) - Named document paragraph and its contents.
- [`"subparagraph"`](./subParagraph.mdx) - Document subparagraph and its contents.
- [`"environment"`](./environment.mdx) - Named document environment and its contents.

## Collections

- [`"list"`](./list.mdx) - List or array.
- [`"map"`](./map.mdx) - Map, object, or dictionary.
- [`"item"`](./collectionItem.mdx) - Entry in a list, map, object, or similar collection.
- [`"key"`](./collectionKey.mdx) - Key in a map, object, or dictionary.

## Functions and calls

- [`"arg"`](./argumentOrParameter.mdx) - Function parameter or function-call argument.
- [`"arg list"`](./argumentList.mdx) - Complete parameter or argument list.
- [`"lambda"`](./anonymousFunction.mdx) - Anonymous or lambda function.
- [`"funk"`](./namedFunction.mdx) - Named function declaration.
- [`"funk name"`](./functionName.mdx) - Name in a function declaration.
- [`"call"`](./functionCall.mdx) - Function, method, or constructor call.
- [`"callee"`](./functionCallee.mdx) - Expression invoked by a function call.

## Classes and objects

- [`"class"`](./class.mdx) - Class or struct declaration or definition.
- [`"class name"`](./className.mdx) - Name in a class or struct declaration.
- [`"instance"`](./instance.mdx) - Occurrence matching the current instance.
- [`"name"`](./name.mdx) - Name in a declaration, such as a variable or function name.
- [`"attribute"`](./attribute.mdx) - Attribute, such as one on an HTML element.
- [`"type"`](./type.mdx) - Type annotation or declaration.
- [`"value"`](./value.mdx) - Value in an assignment, collection entry, return statement, or similar construct.

## Statements and expressions

- [`"state"`](./statement.mdx) - Complete statement, such as a variable declaration or expression statement.
- [`"branch"`](./branch.mdx) - Branch of a control-flow construct, such as if, try, switch, or ternary.
- [`"if state"`](./ifStatement.mdx) - Complete if statement.
- [`"condition"`](./condition.mdx) - Condition of a conditional, loop, or similar construct.
- [`"comment"`](./comment.mdx) - Line or block comment.
- [`"command"`](./command.mdx) - Command, such as a Talon spoken command or shell command.
- [`"regex"`](./regularExpression.mdx) - Regular-expression literal.

## Markup and styles

- [`"element"`](./xmlElement.mdx) - Complete XML, HTML, or JSX element, or a LaTeX environment.
- [`"start tag"`](./xmlStartTag.mdx) - Opening XML, HTML, or JSX tag, or LaTeX `begin` command.
- [`"end tag"`](./xmlEndTag.mdx) - Closing XML, HTML, or JSX tag, or LaTeX `end` command.
- [`"tags"`](./xmlBothTags.mdx) - Opening and closing XML, HTML, or JSX tags, or LaTeX `begin` and `end` commands.
- [`"selector"`](./selector.mdx) - CSS selector.
- [`"unit"`](./unit.mdx) - Unit suffix in a measurement, such as `px` in `100px`.

## Notebook

- [`"cell"`](./notebookCell.mdx) - Notebook cell or Markdown fenced code block.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Default: `lambda`

## Syntax

- lambda - Anonymous function.
- lambda - Anonymous or lambda function.

## Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Default: `arg list`

## Syntax

- arg list - Argument list.
- arg list - Complete parameter or argument list.

## Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Default: `arg`

## Syntax

- arg - Argument.
- arg - Function parameter or function-call argument.

## Examples

Expand Down
2 changes: 1 addition & 1 deletion packages/app-web-docs/src/docs/user/scopes/attribute.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Default: `attribute`

## Syntax

- attribute - Attribute.
- attribute - Attribute, such as one on an HTML element.

## Examples

Expand Down
2 changes: 1 addition & 1 deletion packages/app-web-docs/src/docs/user/scopes/branch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Default: `branch`

## Syntax

- branch - Branch.
- branch - Branch of a control-flow construct, such as if, try, switch, or ternary.

## Examples

Expand Down
2 changes: 1 addition & 1 deletion packages/app-web-docs/src/docs/user/scopes/chapter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Default: `chapter`

## Syntax

- chapter - Chapter.
- chapter - Document chapter and its contents.

## Examples

Expand Down
2 changes: 1 addition & 1 deletion packages/app-web-docs/src/docs/user/scopes/character.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Default: `char`

## Syntax

- char - Character.
- char - Single character within a token.

## Examples

Expand Down
2 changes: 1 addition & 1 deletion packages/app-web-docs/src/docs/user/scopes/class.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Default: `class`

## Syntax

- class - Class.
- class - Class or struct declaration or definition.

## Examples

Expand Down
2 changes: 1 addition & 1 deletion packages/app-web-docs/src/docs/user/scopes/className.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Default: `class name`

## Syntax

- class name - Class name.
- class name - Name in a class or struct declaration.

## Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Default: `item`

## Syntax

- item - Collection item.
- item - Entry in a list, map, object, or similar collection.

## Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Default: `key`

## Syntax

- key - Collection key.
- key - Key in a map, object, or dictionary.

## Examples

Expand Down
Loading
Loading