diff --git a/cursorless-talon/src/cheatsheet/sections/scopes.py b/cursorless-talon/src/cheatsheet/sections/scopes.py index 2fb8e34a47..5eedc2eb51 100644 --- a/cursorless-talon/src/cheatsheet/sections/scopes.py +++ b/cursorless-talon/src/cheatsheet/sections/scopes.py @@ -9,8 +9,8 @@ def get_scopes() -> list[ListItemDescriptor]: "scopeType", { "argumentOrParameter": "Argument", - "boundedNonWhitespaceSequence": "Non-whitespace sequence bounded by surrounding pair delimeters", - "boundedParagraph": "Paragraph bounded by surrounding pair delimeters", + "boundedNonWhitespaceSequence": "Non-whitespace sequence bounded by surrounding pair delimiters", + "boundedParagraph": "Paragraph bounded by surrounding pair delimiters", }, ) diff --git a/oxlint.config.mts b/oxlint.config.mts index 17515f40bb..9ab7d38086 100644 --- a/oxlint.config.mts +++ b/oxlint.config.mts @@ -58,6 +58,7 @@ const disabledRules = [ "react/forbid-component-props", "react/jsx-max-depth", "react/jsx-no-literals", + "react/no-array-index-key", "react/no-multi-comp", "react/only-export-components", "react/react-in-jsx-scope", diff --git a/packages/app-web-docs/package.json b/packages/app-web-docs/package.json index 4900a0a4f5..f581bfbbf6 100644 --- a/packages/app-web-docs/package.json +++ b/packages/app-web-docs/package.json @@ -42,6 +42,7 @@ "unist-util-visit": "^5.1.0" }, "devDependencies": { + "@cursorless/lib-common": "workspace:*", "@cursorless/lib-node-common": "workspace:*", "@docusaurus/module-type-aliases": "^3.10.2", "@docusaurus/types": "^3.10.2", diff --git a/packages/app-web-docs/src/css/custom.scss b/packages/app-web-docs/src/css/custom.scss index b7168287c5..45876a2b0d 100644 --- a/packages/app-web-docs/src/css/custom.scss +++ b/packages/app-web-docs/src/css/custom.scss @@ -25,3 +25,8 @@ .pointer { cursor: pointer; } + +.list-unstyled { + padding-left: 1rem; + list-style: none; +} diff --git a/packages/app-web-docs/src/docs/components/ReferenceEntry.tsx b/packages/app-web-docs/src/docs/components/ReferenceEntry.tsx new file mode 100644 index 0000000000..5c5bd12a25 --- /dev/null +++ b/packages/app-web-docs/src/docs/components/ReferenceEntry.tsx @@ -0,0 +1,114 @@ +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.spokenForm, 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 008daa3707..50497a7d8f 100644 --- a/packages/app-web-docs/src/docs/components/ScopeVisualizer.tsx +++ b/packages/app-web-docs/src/docs/components/ScopeVisualizer.tsx @@ -7,6 +7,7 @@ import type { import { prettifyLanguageName, prettifyScopeType, + scopeReferences, serializeScopeType, } from "@cursorless/lib-common"; import { generateDecorations } from "./calculateHighlights"; @@ -14,12 +15,7 @@ import { Code } from "./Code"; import { H2, H3, H4, H5 } from "./Header"; import "./ScopeSupport.css"; import type { FacetValue, Fixture, RangeType, ScopeTests } from "./types"; -import { - getFacetInfo, - isScopeInternal, - nameComparator, - prettifyFacet, -} from "./util"; +import { getFacetInfo, nameComparator, prettifyFacet } from "./util"; interface Scopes { public: Scope[]; @@ -57,6 +53,10 @@ export function ScopeVisualizer({ languageId, scopeTypeType }: Props) { scopeTypeType != null, ); + if (scopes.internal.length === 0 && scopes.public.length === 0) { + return null; + } + const renderOptions = () => { return (
@@ -322,7 +322,7 @@ function getScopeFixtures( for (const f of scope.facets) { f.fixtures.sort(nameComparator); } - if (isScopeInternal(scope.scopeTypeType)) { + if (scopeReferences[scope.scopeTypeType].private) { result.internal.push(scope); } else { result.public.push(scope); diff --git a/packages/app-web-docs/src/docs/contributing/scopes/components/Scopes.tsx b/packages/app-web-docs/src/docs/components/Scopes.tsx similarity index 62% rename from packages/app-web-docs/src/docs/contributing/scopes/components/Scopes.tsx rename to packages/app-web-docs/src/docs/components/Scopes.tsx index d50f2f185f..25449284f2 100644 --- a/packages/app-web-docs/src/docs/contributing/scopes/components/Scopes.tsx +++ b/packages/app-web-docs/src/docs/components/Scopes.tsx @@ -1,8 +1,8 @@ import React from "react"; import type { ScopeTypeType } from "@cursorless/lib-common"; -import { DynamicTOC } from "../../../components/DynamicTOC"; -import { ScopeVisualizer } from "../../../components/ScopeVisualizer"; -import { ScrollToHashId } from "../../../components/ScrollToHashId"; +import { DynamicTOC } from "./DynamicTOC"; +import { ScopeVisualizer } from "./ScopeVisualizer"; +import { ScrollToHashId } from "./ScrollToHashId"; interface Props { scopeTypeType: ScopeTypeType; diff --git a/packages/app-web-docs/src/docs/components/util.ts b/packages/app-web-docs/src/docs/components/util.ts index 1576f7a796..4202ad8c5a 100644 --- a/packages/app-web-docs/src/docs/components/util.ts +++ b/packages/app-web-docs/src/docs/components/util.ts @@ -2,7 +2,6 @@ import type { PlaintextScopeSupportFacet, ScopeSupportFacet, ScopeSupportFacetInfo, - ScopeTypeType, } from "@cursorless/lib-common"; import { camelCaseToAllDown, @@ -64,16 +63,3 @@ export function nameComparator( ): number { return a.name.localeCompare(b.name, undefined, { numeric: true }); } - -export function isScopeInternal(scope: ScopeTypeType): boolean { - switch (scope) { - case "disqualifyDelimiter": - case "pairDelimiter": - case "textFragment": - case "interior": - case "surroundingPairInterior": - return true; - default: - return false; - } -} diff --git a/packages/app-web-docs/src/docs/contributing/privateScopes/_category_.json b/packages/app-web-docs/src/docs/contributing/privateScopes/_category_.json new file mode 100644 index 0000000000..29d8c912e2 --- /dev/null +++ b/packages/app-web-docs/src/docs/contributing/privateScopes/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "Private scopes" +} diff --git a/packages/app-web-docs/src/docs/contributing/privateScopes/customRegex.mdx b/packages/app-web-docs/src/docs/contributing/privateScopes/customRegex.mdx new file mode 100644 index 0000000000..1a983c6d68 --- /dev/null +++ b/packages/app-web-docs/src/docs/contributing/privateScopes/customRegex.mdx @@ -0,0 +1,5 @@ +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Custom regex + + diff --git a/packages/app-web-docs/src/docs/contributing/scopes/disqualifyDelimiter.mdx b/packages/app-web-docs/src/docs/contributing/privateScopes/disqualifyDelimiter.mdx similarity index 54% rename from packages/app-web-docs/src/docs/contributing/scopes/disqualifyDelimiter.mdx rename to packages/app-web-docs/src/docs/contributing/privateScopes/disqualifyDelimiter.mdx index e1a7e19fc5..20be4e2e7e 100644 --- a/packages/app-web-docs/src/docs/contributing/scopes/disqualifyDelimiter.mdx +++ b/packages/app-web-docs/src/docs/contributing/privateScopes/disqualifyDelimiter.mdx @@ -1,4 +1,4 @@ -import { Scopes } from "./components/Scopes"; +import { Scopes } from "@site/src/docs/components/Scopes"; # Disqualify delimiter diff --git a/packages/app-web-docs/src/docs/contributing/privateScopes/fieldAccess.mdx b/packages/app-web-docs/src/docs/contributing/privateScopes/fieldAccess.mdx new file mode 100644 index 0000000000..5dc6e35cb8 --- /dev/null +++ b/packages/app-web-docs/src/docs/contributing/privateScopes/fieldAccess.mdx @@ -0,0 +1,5 @@ +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Field access + + diff --git a/packages/app-web-docs/src/docs/contributing/privateScopes/interior.mdx b/packages/app-web-docs/src/docs/contributing/privateScopes/interior.mdx new file mode 100644 index 0000000000..ff27b790db --- /dev/null +++ b/packages/app-web-docs/src/docs/contributing/privateScopes/interior.mdx @@ -0,0 +1,5 @@ +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Interior + + diff --git a/packages/app-web-docs/src/docs/contributing/scopes/pairDelimiter.mdx b/packages/app-web-docs/src/docs/contributing/privateScopes/pairDelimiter.mdx similarity index 50% rename from packages/app-web-docs/src/docs/contributing/scopes/pairDelimiter.mdx rename to packages/app-web-docs/src/docs/contributing/privateScopes/pairDelimiter.mdx index 1b18ea7561..6646a4f877 100644 --- a/packages/app-web-docs/src/docs/contributing/scopes/pairDelimiter.mdx +++ b/packages/app-web-docs/src/docs/contributing/privateScopes/pairDelimiter.mdx @@ -1,4 +1,4 @@ -import { Scopes } from "./components/Scopes"; +import { Scopes } from "@site/src/docs/components/Scopes"; # Pair delimiter diff --git a/packages/app-web-docs/src/docs/contributing/privateScopes/string.mdx b/packages/app-web-docs/src/docs/contributing/privateScopes/string.mdx new file mode 100644 index 0000000000..a8488ef6a5 --- /dev/null +++ b/packages/app-web-docs/src/docs/contributing/privateScopes/string.mdx @@ -0,0 +1,5 @@ +import { Scopes } from "@site/src/docs/components/Scopes"; + +# String + + diff --git a/packages/app-web-docs/src/docs/contributing/scopes/surroundingPairInterior.mdx b/packages/app-web-docs/src/docs/contributing/privateScopes/surroundingPairInterior.mdx similarity index 57% rename from packages/app-web-docs/src/docs/contributing/scopes/surroundingPairInterior.mdx rename to packages/app-web-docs/src/docs/contributing/privateScopes/surroundingPairInterior.mdx index 7c2895e51a..bf93046cb8 100644 --- a/packages/app-web-docs/src/docs/contributing/scopes/surroundingPairInterior.mdx +++ b/packages/app-web-docs/src/docs/contributing/privateScopes/surroundingPairInterior.mdx @@ -1,4 +1,4 @@ -import { Scopes } from "./components/Scopes"; +import { Scopes } from "@site/src/docs/components/Scopes"; # Surrounding pair interior diff --git a/packages/app-web-docs/src/docs/contributing/privateScopes/textFragment.mdx b/packages/app-web-docs/src/docs/contributing/privateScopes/textFragment.mdx new file mode 100644 index 0000000000..474c444683 --- /dev/null +++ b/packages/app-web-docs/src/docs/contributing/privateScopes/textFragment.mdx @@ -0,0 +1,5 @@ +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Text fragment + + diff --git a/packages/app-web-docs/src/docs/contributing/scopes/README.md b/packages/app-web-docs/src/docs/contributing/scopes/README.md deleted file mode 100644 index 4bb75a0362..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Scopes - -All available scopes in Cursorless diff --git a/packages/app-web-docs/src/docs/contributing/scopes/anonymousFunction.mdx b/packages/app-web-docs/src/docs/contributing/scopes/anonymousFunction.mdx deleted file mode 100644 index 6ccc0fe7b6..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/anonymousFunction.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Anonymous function - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/argumentList.mdx b/packages/app-web-docs/src/docs/contributing/scopes/argumentList.mdx deleted file mode 100644 index 947c2e2068..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/argumentList.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Argument list - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/argumentOrParameter.mdx b/packages/app-web-docs/src/docs/contributing/scopes/argumentOrParameter.mdx deleted file mode 100644 index 146580bbe1..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/argumentOrParameter.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Argument or parameter - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/attribute.mdx b/packages/app-web-docs/src/docs/contributing/scopes/attribute.mdx deleted file mode 100644 index 7c56329f83..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/attribute.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Attribute - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/boundedNonWhitespaceSequence.mdx b/packages/app-web-docs/src/docs/contributing/scopes/boundedNonWhitespaceSequence.mdx deleted file mode 100644 index 99cc0c13ae..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/boundedNonWhitespaceSequence.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -sidebar_label: Bounded non-ws sequence ---- - -import { Scopes } from "./components/Scopes"; - -# Bounded non-whitespace sequence - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/boundedParagraph.mdx b/packages/app-web-docs/src/docs/contributing/scopes/boundedParagraph.mdx deleted file mode 100644 index b9e1712e4b..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/boundedParagraph.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Bounded paragraph - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/branch.mdx b/packages/app-web-docs/src/docs/contributing/scopes/branch.mdx deleted file mode 100644 index a2f7da013f..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/branch.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Branch - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/chapter.mdx b/packages/app-web-docs/src/docs/contributing/scopes/chapter.mdx deleted file mode 100644 index addd422656..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/chapter.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Chapter - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/character.mdx b/packages/app-web-docs/src/docs/contributing/scopes/character.mdx deleted file mode 100644 index f79da3f5c1..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/character.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Character - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/class.mdx b/packages/app-web-docs/src/docs/contributing/scopes/class.mdx deleted file mode 100644 index cf2e18375b..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/class.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Class - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/className.mdx b/packages/app-web-docs/src/docs/contributing/scopes/className.mdx deleted file mode 100644 index aa6e0f89c0..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/className.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Class name - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/collectionItem.mdx b/packages/app-web-docs/src/docs/contributing/scopes/collectionItem.mdx deleted file mode 100644 index eee8d072cc..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/collectionItem.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Collection item - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/collectionKey.mdx b/packages/app-web-docs/src/docs/contributing/scopes/collectionKey.mdx deleted file mode 100644 index 5bc9407722..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/collectionKey.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Collection key - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/command.mdx b/packages/app-web-docs/src/docs/contributing/scopes/command.mdx deleted file mode 100644 index d7f56bbcc6..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/command.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Command - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/comment.mdx b/packages/app-web-docs/src/docs/contributing/scopes/comment.mdx deleted file mode 100644 index 4c5ab96121..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/comment.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Comment - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/condition.mdx b/packages/app-web-docs/src/docs/contributing/scopes/condition.mdx deleted file mode 100644 index bb4668c376..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/condition.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Condition - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/document.mdx b/packages/app-web-docs/src/docs/contributing/scopes/document.mdx deleted file mode 100644 index 234458d3ce..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/document.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Document - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/environment.mdx b/packages/app-web-docs/src/docs/contributing/scopes/environment.mdx deleted file mode 100644 index b8222d9cc5..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/environment.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Environment - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/fieldAccess.mdx b/packages/app-web-docs/src/docs/contributing/scopes/fieldAccess.mdx deleted file mode 100644 index ac6525d7cd..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/fieldAccess.mdx +++ /dev/null @@ -1,7 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Field access - -This scope is private for now and should not be used! - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/fullLine.mdx b/packages/app-web-docs/src/docs/contributing/scopes/fullLine.mdx deleted file mode 100644 index 8d35c2dbf7..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/fullLine.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Full line - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/functionCall.mdx b/packages/app-web-docs/src/docs/contributing/scopes/functionCall.mdx deleted file mode 100644 index 9248c6ec34..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/functionCall.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Function call - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/functionCallee.mdx b/packages/app-web-docs/src/docs/contributing/scopes/functionCallee.mdx deleted file mode 100644 index b963a2eec8..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/functionCallee.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Function callee - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/functionName.mdx b/packages/app-web-docs/src/docs/contributing/scopes/functionName.mdx deleted file mode 100644 index b75bcea216..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/functionName.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Function name - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/identifier.mdx b/packages/app-web-docs/src/docs/contributing/scopes/identifier.mdx deleted file mode 100644 index e6ffebd655..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/identifier.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Identifier - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/ifStatement.mdx b/packages/app-web-docs/src/docs/contributing/scopes/ifStatement.mdx deleted file mode 100644 index 9ef12a167d..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/ifStatement.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# If statement - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/interior.mdx b/packages/app-web-docs/src/docs/contributing/scopes/interior.mdx deleted file mode 100644 index 566ac78bbb..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/interior.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Interior - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/line.mdx b/packages/app-web-docs/src/docs/contributing/scopes/line.mdx deleted file mode 100644 index a34cd528f2..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/line.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Line - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/list.mdx b/packages/app-web-docs/src/docs/contributing/scopes/list.mdx deleted file mode 100644 index 25aa097879..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/list.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# List - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/map.mdx b/packages/app-web-docs/src/docs/contributing/scopes/map.mdx deleted file mode 100644 index c9c86f258f..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/map.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Map - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/name.mdx b/packages/app-web-docs/src/docs/contributing/scopes/name.mdx deleted file mode 100644 index 43f84e2f24..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/name.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Name - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/namedFunction.mdx b/packages/app-web-docs/src/docs/contributing/scopes/namedFunction.mdx deleted file mode 100644 index f9831c341a..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/namedFunction.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Named function - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/namedParagraph.mdx b/packages/app-web-docs/src/docs/contributing/scopes/namedParagraph.mdx deleted file mode 100644 index 17c4bea0ba..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/namedParagraph.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Named paragraph - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/nonWhitespaceSequence.mdx b/packages/app-web-docs/src/docs/contributing/scopes/nonWhitespaceSequence.mdx deleted file mode 100644 index ac94d034e1..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/nonWhitespaceSequence.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Non-whitespace sequence - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/notebookCell.mdx b/packages/app-web-docs/src/docs/contributing/scopes/notebookCell.mdx deleted file mode 100644 index 1eb26f346e..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/notebookCell.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Notebook cell - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/paragraph.mdx b/packages/app-web-docs/src/docs/contributing/scopes/paragraph.mdx deleted file mode 100644 index 64d0396bc6..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/paragraph.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Paragraph - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/part.mdx b/packages/app-web-docs/src/docs/contributing/scopes/part.mdx deleted file mode 100644 index 0579c06e4b..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/part.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Part - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/regularExpression.mdx b/packages/app-web-docs/src/docs/contributing/scopes/regularExpression.mdx deleted file mode 100644 index 71a186069d..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/regularExpression.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Regular expression - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/section.mdx b/packages/app-web-docs/src/docs/contributing/scopes/section.mdx deleted file mode 100644 index 57acef3218..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/section.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Section - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/sectionLevelFive.mdx b/packages/app-web-docs/src/docs/contributing/scopes/sectionLevelFive.mdx deleted file mode 100644 index 237028fc7f..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/sectionLevelFive.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Section level five - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/sectionLevelFour.mdx b/packages/app-web-docs/src/docs/contributing/scopes/sectionLevelFour.mdx deleted file mode 100644 index 360af0ff37..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/sectionLevelFour.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Section level four - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/sectionLevelOne.mdx b/packages/app-web-docs/src/docs/contributing/scopes/sectionLevelOne.mdx deleted file mode 100644 index 5291a8fd6b..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/sectionLevelOne.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Section level one - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/sectionLevelSix.mdx b/packages/app-web-docs/src/docs/contributing/scopes/sectionLevelSix.mdx deleted file mode 100644 index 639cac41ee..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/sectionLevelSix.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Section level six - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/sectionLevelThree.mdx b/packages/app-web-docs/src/docs/contributing/scopes/sectionLevelThree.mdx deleted file mode 100644 index 4767a18d8d..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/sectionLevelThree.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Section level three - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/sectionLevelTwo.mdx b/packages/app-web-docs/src/docs/contributing/scopes/sectionLevelTwo.mdx deleted file mode 100644 index d9f080bb86..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/sectionLevelTwo.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Section level two - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/selector.mdx b/packages/app-web-docs/src/docs/contributing/scopes/selector.mdx deleted file mode 100644 index 160f065b34..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/selector.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Selector - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/sentence.mdx b/packages/app-web-docs/src/docs/contributing/scopes/sentence.mdx deleted file mode 100644 index 6cf99889e5..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/sentence.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Sentence - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/statement.mdx b/packages/app-web-docs/src/docs/contributing/scopes/statement.mdx deleted file mode 100644 index 6ba243d6f6..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/statement.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Statement - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/string.mdx b/packages/app-web-docs/src/docs/contributing/scopes/string.mdx deleted file mode 100644 index 4e12f82591..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/string.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# String - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/subParagraph.mdx b/packages/app-web-docs/src/docs/contributing/scopes/subParagraph.mdx deleted file mode 100644 index f643933bde..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/subParagraph.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Sub paragraph - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/subSection.mdx b/packages/app-web-docs/src/docs/contributing/scopes/subSection.mdx deleted file mode 100644 index d4b143bef7..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/subSection.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Sub section - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/subSubSection.mdx b/packages/app-web-docs/src/docs/contributing/scopes/subSubSection.mdx deleted file mode 100644 index d0110763b8..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/subSubSection.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Sub sub section - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/surroundingPair.mdx b/packages/app-web-docs/src/docs/contributing/scopes/surroundingPair.mdx deleted file mode 100644 index 47f5d70ab2..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/surroundingPair.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Surrounding pair - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/textFragment.mdx b/packages/app-web-docs/src/docs/contributing/scopes/textFragment.mdx deleted file mode 100644 index 351c7be3ea..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/textFragment.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Text fragment - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/token.mdx b/packages/app-web-docs/src/docs/contributing/scopes/token.mdx deleted file mode 100644 index 5b84085308..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/token.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Token - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/type.mdx b/packages/app-web-docs/src/docs/contributing/scopes/type.mdx deleted file mode 100644 index 3ee413a1ff..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/type.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Type - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/unit.mdx b/packages/app-web-docs/src/docs/contributing/scopes/unit.mdx deleted file mode 100644 index 934b303146..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/unit.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Unit - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/url.mdx b/packages/app-web-docs/src/docs/contributing/scopes/url.mdx deleted file mode 100644 index 042f67ef22..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/url.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Url - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/value.mdx b/packages/app-web-docs/src/docs/contributing/scopes/value.mdx deleted file mode 100644 index 62ed66dbed..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/value.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Value - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/word.mdx b/packages/app-web-docs/src/docs/contributing/scopes/word.mdx deleted file mode 100644 index eba248364a..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/word.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Word - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/xmlBothTags.mdx b/packages/app-web-docs/src/docs/contributing/scopes/xmlBothTags.mdx deleted file mode 100644 index 75e7c0b706..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/xmlBothTags.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Xml both tags - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/xmlElement.mdx b/packages/app-web-docs/src/docs/contributing/scopes/xmlElement.mdx deleted file mode 100644 index ff83b0bf14..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/xmlElement.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Xml element - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/xmlEndTag.mdx b/packages/app-web-docs/src/docs/contributing/scopes/xmlEndTag.mdx deleted file mode 100644 index 1d23978db8..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/xmlEndTag.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Xml end tag - - diff --git a/packages/app-web-docs/src/docs/contributing/scopes/xmlStartTag.mdx b/packages/app-web-docs/src/docs/contributing/scopes/xmlStartTag.mdx deleted file mode 100644 index 5dd9a6244c..0000000000 --- a/packages/app-web-docs/src/docs/contributing/scopes/xmlStartTag.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Xml start tag - - diff --git a/packages/app-web-docs/src/docs/user/README.md b/packages/app-web-docs/src/docs/user/README.md index 096cd791ba..fd96d57744 100644 --- a/packages/app-web-docs/src/docs/user/README.md +++ b/packages/app-web-docs/src/docs/user/README.md @@ -1,5 +1,6 @@ --- slug: / +sidebar_position: 1 --- # Cursorless documentation @@ -438,7 +439,7 @@ Some examples: - `"chuck just air"`: deletes just the air token, leaving spaces undisturbed. - `"chuck just line"`: deletes just the content of the line, leaving a blank line. -- `"bring bat after just air"`: results in something like `aaabbb` where the bat token was copied after the air token with no delimeter between them. +- `"bring bat after just air"`: results in something like `aaabbb` where the bat token was copied after the air token with no delimiter between them. ##### Surrounding pair @@ -555,16 +556,6 @@ eg: `pre blue air` Moves the cursor to before the token containing letter 'a' with a blue hat. -### Delete - -This command can be used to delete a target without moving the cursor - -- `"chuck "` - -eg: -`chuck blue air` -Deletes the token containing letter 'a' with a blue hat. - ### Changing a target This command will delete a target and leave the cursor where the target used to be, making it easy to change a target diff --git a/packages/app-web-docs/src/docs/user/reference/_category_.json b/packages/app-web-docs/src/docs/user/reference/_category_.json index a3b4dd92ec..d8f1714e59 100644 --- a/packages/app-web-docs/src/docs/user/reference/_category_.json +++ b/packages/app-web-docs/src/docs/user/reference/_category_.json @@ -1,3 +1,5 @@ { - "label": "Reference" + "label": "Reference", + "collapsed": false, + "position": 2 } diff --git a/packages/app-web-docs/src/docs/user/reference/actions/_category_.json b/packages/app-web-docs/src/docs/user/reference/actions/_category_.json new file mode 100644 index 0000000000..c81c210e7f --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Actions", + "position": 1 +} diff --git a/packages/app-web-docs/src/docs/user/reference/actions/addSelection.mdx b/packages/app-web-docs/src/docs/user/reference/actions/addSelection.mdx new file mode 100644 index 0000000000..1e332101a3 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/addSelection.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Add selection + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/addSelectionAfter.mdx b/packages/app-web-docs/src/docs/user/reference/actions/addSelectionAfter.mdx new file mode 100644 index 0000000000..6b51984db0 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/addSelectionAfter.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Add selection after + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/addSelectionBefore.mdx b/packages/app-web-docs/src/docs/user/reference/actions/addSelectionBefore.mdx new file mode 100644 index 0000000000..f6c5ce8c6a --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/addSelectionBefore.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Add selection before + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/applyFormatter.mdx b/packages/app-web-docs/src/docs/user/reference/actions/applyFormatter.mdx new file mode 100644 index 0000000000..c329bc9310 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/applyFormatter.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Apply formatter + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/breakLine.mdx b/packages/app-web-docs/src/docs/user/reference/actions/breakLine.mdx new file mode 100644 index 0000000000..ab71fb4059 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/breakLine.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Break line + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/callAsFunction.mdx b/packages/app-web-docs/src/docs/user/reference/actions/callAsFunction.mdx new file mode 100644 index 0000000000..a36b450884 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/callAsFunction.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Call as function + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/clearAndSetSelection.mdx b/packages/app-web-docs/src/docs/user/reference/actions/clearAndSetSelection.mdx new file mode 100644 index 0000000000..782aa36fd4 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/clearAndSetSelection.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Change + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/copyToClipboard.mdx b/packages/app-web-docs/src/docs/user/reference/actions/copyToClipboard.mdx new file mode 100644 index 0000000000..ab83454d85 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/copyToClipboard.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Copy to clipboard + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/cutToClipboard.mdx b/packages/app-web-docs/src/docs/user/reference/actions/cutToClipboard.mdx new file mode 100644 index 0000000000..b10138052e --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/cutToClipboard.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Cut to clipboard + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/decrement.mdx b/packages/app-web-docs/src/docs/user/reference/actions/decrement.mdx new file mode 100644 index 0000000000..f60ba30cb8 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/decrement.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Decrement + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/deselect.mdx b/packages/app-web-docs/src/docs/user/reference/actions/deselect.mdx new file mode 100644 index 0000000000..4182c83fc5 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/deselect.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Deselect + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/editNewLineAfter.mdx b/packages/app-web-docs/src/docs/user/reference/actions/editNewLineAfter.mdx new file mode 100644 index 0000000000..a217ebb305 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/editNewLineAfter.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Edit new line/scope after + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/editNewLineBefore.mdx b/packages/app-web-docs/src/docs/user/reference/actions/editNewLineBefore.mdx new file mode 100644 index 0000000000..3e601927ca --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/editNewLineBefore.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Edit new line/scope before + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/extractVariable.mdx b/packages/app-web-docs/src/docs/user/reference/actions/extractVariable.mdx new file mode 100644 index 0000000000..a78d9e883c --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/extractVariable.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Extract variable + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/findInDocument.mdx b/packages/app-web-docs/src/docs/user/reference/actions/findInDocument.mdx new file mode 100644 index 0000000000..af3fba0d0e --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/findInDocument.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Find in document + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/findInWorkspace.mdx b/packages/app-web-docs/src/docs/user/reference/actions/findInWorkspace.mdx new file mode 100644 index 0000000000..a6b01ed9b0 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/findInWorkspace.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Find in workspace + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/flashTargets.mdx b/packages/app-web-docs/src/docs/user/reference/actions/flashTargets.mdx new file mode 100644 index 0000000000..450fc11c46 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/flashTargets.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Flash target + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/foldRegion.mdx b/packages/app-web-docs/src/docs/user/reference/actions/foldRegion.mdx new file mode 100644 index 0000000000..d41be0ddd3 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/foldRegion.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Fold region + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/followLink.mdx b/packages/app-web-docs/src/docs/user/reference/actions/followLink.mdx new file mode 100644 index 0000000000..b5a666af3b --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/followLink.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Follow link + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/followLinkAside.mdx b/packages/app-web-docs/src/docs/user/reference/actions/followLinkAside.mdx new file mode 100644 index 0000000000..9433cc795e --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/followLinkAside.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Follow link aside + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/generateSnippet.mdx b/packages/app-web-docs/src/docs/user/reference/actions/generateSnippet.mdx new file mode 100644 index 0000000000..657dd5d6f7 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/generateSnippet.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Generate snippet + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/gitAccept.mdx b/packages/app-web-docs/src/docs/user/reference/actions/gitAccept.mdx new file mode 100644 index 0000000000..5e62b30897 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/gitAccept.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Git accept + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/gitRevert.mdx b/packages/app-web-docs/src/docs/user/reference/actions/gitRevert.mdx new file mode 100644 index 0000000000..28545b1202 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/gitRevert.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Git revert + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/gitStage.mdx b/packages/app-web-docs/src/docs/user/reference/actions/gitStage.mdx new file mode 100644 index 0000000000..c994a443b3 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/gitStage.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Git stage + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/gitUnstage.mdx b/packages/app-web-docs/src/docs/user/reference/actions/gitUnstage.mdx new file mode 100644 index 0000000000..b1b21abe51 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/gitUnstage.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Git unstage + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/highlight.mdx b/packages/app-web-docs/src/docs/user/reference/actions/highlight.mdx new file mode 100644 index 0000000000..2da73aac6f --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/highlight.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Highlight + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/increment.mdx b/packages/app-web-docs/src/docs/user/reference/actions/increment.mdx new file mode 100644 index 0000000000..7bb6be1216 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/increment.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Increment + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/indentLine.mdx b/packages/app-web-docs/src/docs/user/reference/actions/indentLine.mdx new file mode 100644 index 0000000000..d4460ef3f3 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/indentLine.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Indent line + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/insertCopyAfter.mdx b/packages/app-web-docs/src/docs/user/reference/actions/insertCopyAfter.mdx new file mode 100644 index 0000000000..7e29faa08a --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/insertCopyAfter.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Insert copy after + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/insertCopyBefore.mdx b/packages/app-web-docs/src/docs/user/reference/actions/insertCopyBefore.mdx new file mode 100644 index 0000000000..5a92e80ff8 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/insertCopyBefore.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Insert copy before + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLineAfter.mdx b/packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLineAfter.mdx new file mode 100644 index 0000000000..0fe9b3d599 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLineAfter.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Insert empty line after + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLineBefore.mdx b/packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLineBefore.mdx new file mode 100644 index 0000000000..898964562d --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLineBefore.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Insert empty line before + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLinesAround.mdx b/packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLinesAround.mdx new file mode 100644 index 0000000000..50679c3c08 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLinesAround.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Insert empty lines around + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/insertSnippet.mdx b/packages/app-web-docs/src/docs/user/reference/actions/insertSnippet.mdx new file mode 100644 index 0000000000..4a89552833 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/insertSnippet.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Insert snippet + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/joinLines.mdx b/packages/app-web-docs/src/docs/user/reference/actions/joinLines.mdx new file mode 100644 index 0000000000..445fcab3b5 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/joinLines.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Join lines + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/moveToTarget.mdx b/packages/app-web-docs/src/docs/user/reference/actions/moveToTarget.mdx new file mode 100644 index 0000000000..b0bcd55d68 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/moveToTarget.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Move to target + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/nextHomophone.mdx b/packages/app-web-docs/src/docs/user/reference/actions/nextHomophone.mdx new file mode 100644 index 0000000000..eda9bd2ca6 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/nextHomophone.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Next homophone + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/outdentLine.mdx b/packages/app-web-docs/src/docs/user/reference/actions/outdentLine.mdx new file mode 100644 index 0000000000..46b8717368 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/outdentLine.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Outdent line + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/pasteFromClipboard.mdx b/packages/app-web-docs/src/docs/user/reference/actions/pasteFromClipboard.mdx new file mode 100644 index 0000000000..ef23e3111f --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/pasteFromClipboard.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Paste from clipboard + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/randomizeTargets.mdx b/packages/app-web-docs/src/docs/user/reference/actions/randomizeTargets.mdx new file mode 100644 index 0000000000..cb2d517bef --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/randomizeTargets.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Randomize targets + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/remove.mdx b/packages/app-web-docs/src/docs/user/reference/actions/remove.mdx new file mode 100644 index 0000000000..53e1977409 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/remove.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Remove + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/rename.mdx b/packages/app-web-docs/src/docs/user/reference/actions/rename.mdx new file mode 100644 index 0000000000..06ec8b15f3 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/rename.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Rename + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/replaceWithTarget.mdx b/packages/app-web-docs/src/docs/user/reference/actions/replaceWithTarget.mdx new file mode 100644 index 0000000000..243baec78e --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/replaceWithTarget.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Replace with target + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/revealDefinition.mdx b/packages/app-web-docs/src/docs/user/reference/actions/revealDefinition.mdx new file mode 100644 index 0000000000..333818b755 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/revealDefinition.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Reveal definition + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/revealTypeDefinition.mdx b/packages/app-web-docs/src/docs/user/reference/actions/revealTypeDefinition.mdx new file mode 100644 index 0000000000..8535b694fa --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/revealTypeDefinition.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Reveal type definition + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/reverseTargets.mdx b/packages/app-web-docs/src/docs/user/reference/actions/reverseTargets.mdx new file mode 100644 index 0000000000..54e207589c --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/reverseTargets.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Reverse targets + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/rewrapWithPairedDelimiter.mdx b/packages/app-web-docs/src/docs/user/reference/actions/rewrapWithPairedDelimiter.mdx new file mode 100644 index 0000000000..af662e3421 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/rewrapWithPairedDelimiter.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Rewrap with paired delimiter + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/scrollToBottom.mdx b/packages/app-web-docs/src/docs/user/reference/actions/scrollToBottom.mdx new file mode 100644 index 0000000000..ab1cf7017a --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/scrollToBottom.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Scroll to bottom + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/scrollToCenter.mdx b/packages/app-web-docs/src/docs/user/reference/actions/scrollToCenter.mdx new file mode 100644 index 0000000000..2a005e39b9 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/scrollToCenter.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Scroll to center + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/scrollToTop.mdx b/packages/app-web-docs/src/docs/user/reference/actions/scrollToTop.mdx new file mode 100644 index 0000000000..7dad52b50f --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/scrollToTop.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Scroll to top + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/setInstanceReference.mdx b/packages/app-web-docs/src/docs/user/reference/actions/setInstanceReference.mdx new file mode 100644 index 0000000000..e332ef548f --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/setInstanceReference.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Set instance reference + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/setSelection.mdx b/packages/app-web-docs/src/docs/user/reference/actions/setSelection.mdx new file mode 100644 index 0000000000..d4532fd3e1 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/setSelection.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Set selection + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/setSelectionAfter.mdx b/packages/app-web-docs/src/docs/user/reference/actions/setSelectionAfter.mdx new file mode 100644 index 0000000000..8a7bb7f613 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/setSelectionAfter.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Set selection after + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/setSelectionBefore.mdx b/packages/app-web-docs/src/docs/user/reference/actions/setSelectionBefore.mdx new file mode 100644 index 0000000000..5335bf7af1 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/setSelectionBefore.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Set selection before + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/showDebugHover.mdx b/packages/app-web-docs/src/docs/user/reference/actions/showDebugHover.mdx new file mode 100644 index 0000000000..ea56546eb6 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/showDebugHover.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Show debug hover + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/showHover.mdx b/packages/app-web-docs/src/docs/user/reference/actions/showHover.mdx new file mode 100644 index 0000000000..9b337aad46 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/showHover.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Show hover + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/showQuickFix.mdx b/packages/app-web-docs/src/docs/user/reference/actions/showQuickFix.mdx new file mode 100644 index 0000000000..8c2ff97ffa --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/showQuickFix.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Show quick fix + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/showReferences.mdx b/packages/app-web-docs/src/docs/user/reference/actions/showReferences.mdx new file mode 100644 index 0000000000..fb67791b63 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/showReferences.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Show references + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/sortTargets.mdx b/packages/app-web-docs/src/docs/user/reference/actions/sortTargets.mdx new file mode 100644 index 0000000000..44fd34649e --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/sortTargets.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Sort targets + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/swapTargets.mdx b/packages/app-web-docs/src/docs/user/reference/actions/swapTargets.mdx new file mode 100644 index 0000000000..2de617b4ed --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/swapTargets.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Swap targets + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/toggleLineBreakpoint.mdx b/packages/app-web-docs/src/docs/user/reference/actions/toggleLineBreakpoint.mdx new file mode 100644 index 0000000000..d880600e67 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/toggleLineBreakpoint.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Toggle line/scope breakpoint + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/toggleLineComment.mdx b/packages/app-web-docs/src/docs/user/reference/actions/toggleLineComment.mdx new file mode 100644 index 0000000000..95d5db36a4 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/toggleLineComment.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Toggle line comment + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/unfoldRegion.mdx b/packages/app-web-docs/src/docs/user/reference/actions/unfoldRegion.mdx new file mode 100644 index 0000000000..fa443bc518 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/unfoldRegion.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Unfold region + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/wrapWithPairedDelimiter.mdx b/packages/app-web-docs/src/docs/user/reference/actions/wrapWithPairedDelimiter.mdx new file mode 100644 index 0000000000..196ab1a218 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/wrapWithPairedDelimiter.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Wrap with paired delimiter + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/wrapWithSnippet.mdx b/packages/app-web-docs/src/docs/user/reference/actions/wrapWithSnippet.mdx new file mode 100644 index 0000000000..d12c485f4a --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/wrapWithSnippet.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; + +# Wrap with snippet + + diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/_category_.json b/packages/app-web-docs/src/docs/user/reference/modifiers/_category_.json new file mode 100644 index 0000000000..0f5ce9207f --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Modifiers", + "position": 2 +} diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/ancestor.mdx b/packages/app-web-docs/src/docs/user/reference/modifiers/ancestor.mdx new file mode 100644 index 0000000000..143f8944a4 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/ancestor.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; + +# Ancestor + + diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/containingScope.mdx b/packages/app-web-docs/src/docs/user/reference/modifiers/containingScope.mdx new file mode 100644 index 0000000000..3b000857aa --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/containingScope.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; + +# Containing scope + + diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/endOf.mdx b/packages/app-web-docs/src/docs/user/reference/modifiers/endOf.mdx new file mode 100644 index 0000000000..2834f0b375 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/endOf.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; + +# End of + + diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/everyScope.mdx b/packages/app-web-docs/src/docs/user/reference/modifiers/everyScope.mdx new file mode 100644 index 0000000000..2f8c4db466 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/everyScope.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; + +# Every scope + + diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/excludeInterior.mdx b/packages/app-web-docs/src/docs/user/reference/modifiers/excludeInterior.mdx new file mode 100644 index 0000000000..18735cc316 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/excludeInterior.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; + +# Exclude interior + + diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/extendThroughEndOf.mdx b/packages/app-web-docs/src/docs/user/reference/modifiers/extendThroughEndOf.mdx new file mode 100644 index 0000000000..20169c9500 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/extendThroughEndOf.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; + +# Extend through end of + + diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/extendThroughStartOf.mdx b/packages/app-web-docs/src/docs/user/reference/modifiers/extendThroughStartOf.mdx new file mode 100644 index 0000000000..3cd78bd057 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/extendThroughStartOf.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; + +# Extend through start of + + diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/inferPreviousMark.mdx b/packages/app-web-docs/src/docs/user/reference/modifiers/inferPreviousMark.mdx new file mode 100644 index 0000000000..dec5a55491 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/inferPreviousMark.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; + +# Infer previous mark + + diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/interiorOnly.mdx b/packages/app-web-docs/src/docs/user/reference/modifiers/interiorOnly.mdx new file mode 100644 index 0000000000..93240f2a98 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/interiorOnly.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; + +# Interior only + + diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/keepContentFilter.mdx b/packages/app-web-docs/src/docs/user/reference/modifiers/keepContentFilter.mdx new file mode 100644 index 0000000000..59966a274f --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/keepContentFilter.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; + +# Keep content filter + + diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/keepEmptyFilter.mdx b/packages/app-web-docs/src/docs/user/reference/modifiers/keepEmptyFilter.mdx new file mode 100644 index 0000000000..0f071237f2 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/keepEmptyFilter.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; + +# Keep empty filter + + diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/leading.mdx b/packages/app-web-docs/src/docs/user/reference/modifiers/leading.mdx new file mode 100644 index 0000000000..92343b63c4 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/leading.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; + +# Leading + + diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/ordinalScope.mdx b/packages/app-web-docs/src/docs/user/reference/modifiers/ordinalScope.mdx new file mode 100644 index 0000000000..36d1abe6c6 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/ordinalScope.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; + +# Ordinal scope + + diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/relativeScope.mdx b/packages/app-web-docs/src/docs/user/reference/modifiers/relativeScope.mdx new file mode 100644 index 0000000000..f1776644c2 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/relativeScope.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; + +# Relative scope + + diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/startOf.mdx b/packages/app-web-docs/src/docs/user/reference/modifiers/startOf.mdx new file mode 100644 index 0000000000..4dd5ec4e2f --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/startOf.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; + +# Start of + + diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/toRawSelection.mdx b/packages/app-web-docs/src/docs/user/reference/modifiers/toRawSelection.mdx new file mode 100644 index 0000000000..92452c05ef --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/toRawSelection.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; + +# Raw selection + + diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/trailing.mdx b/packages/app-web-docs/src/docs/user/reference/modifiers/trailing.mdx new file mode 100644 index 0000000000..957d53bb13 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/trailing.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; + +# Trailing + + diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers/visible.mdx b/packages/app-web-docs/src/docs/user/reference/modifiers/visible.mdx new file mode 100644 index 0000000000..959a201e34 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/visible.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; + +# Visible + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/_category_.json b/packages/app-web-docs/src/docs/user/reference/scopes/_category_.json new file mode 100644 index 0000000000..da14614c2d --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Scopes", + "position": 3 +} diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/anonymousFunction.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/anonymousFunction.mdx new file mode 100644 index 0000000000..f3a4aed047 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/anonymousFunction.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Anonymous function + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/argumentList.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/argumentList.mdx new file mode 100644 index 0000000000..ecb9da7a56 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/argumentList.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Argument list + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/argumentOrParameter.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/argumentOrParameter.mdx new file mode 100644 index 0000000000..bfbec123c2 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/argumentOrParameter.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Argument or parameter + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/attribute.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/attribute.mdx new file mode 100644 index 0000000000..56fb278f19 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/attribute.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Attribute + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/boundedNonWhitespaceSequence.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/boundedNonWhitespaceSequence.mdx new file mode 100644 index 0000000000..f0e2921743 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/boundedNonWhitespaceSequence.mdx @@ -0,0 +1,11 @@ +--- +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 + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/boundedParagraph.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/boundedParagraph.mdx new file mode 100644 index 0000000000..f9961c46c1 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/boundedParagraph.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Bounded paragraph + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/branch.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/branch.mdx new file mode 100644 index 0000000000..7d1cfbeb21 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/branch.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Branch + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/chapter.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/chapter.mdx new file mode 100644 index 0000000000..5a7baeeeb7 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/chapter.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Chapter + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/character.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/character.mdx new file mode 100644 index 0000000000..f0e57fd647 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/character.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Character + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/class.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/class.mdx new file mode 100644 index 0000000000..0d36f96e64 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/class.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Class + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/className.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/className.mdx new file mode 100644 index 0000000000..0169a509fb --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/className.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Class name + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/collectionItem.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/collectionItem.mdx new file mode 100644 index 0000000000..12a7b5f755 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/collectionItem.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Collection item + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/collectionKey.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/collectionKey.mdx new file mode 100644 index 0000000000..b796f2a860 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/collectionKey.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Collection key + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/command.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/command.mdx new file mode 100644 index 0000000000..90eb5174a4 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/command.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Command + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/comment.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/comment.mdx new file mode 100644 index 0000000000..b0790be3ad --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/comment.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Comment + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/condition.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/condition.mdx new file mode 100644 index 0000000000..f39241a52b --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/condition.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Condition + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/document.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/document.mdx new file mode 100644 index 0000000000..ff98dcf3be --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/document.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Document + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/environment.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/environment.mdx new file mode 100644 index 0000000000..f1ebdbe002 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/environment.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Environment + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/fullLine.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/fullLine.mdx new file mode 100644 index 0000000000..3653ec4be2 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/fullLine.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Full line + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/functionCall.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/functionCall.mdx new file mode 100644 index 0000000000..6f3d1f7a47 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/functionCall.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Function call + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/functionCallee.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/functionCallee.mdx new file mode 100644 index 0000000000..4d015a0aef --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/functionCallee.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Function callee + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/functionName.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/functionName.mdx new file mode 100644 index 0000000000..545aa0dd44 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/functionName.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Function name + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/glyph.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/glyph.mdx new file mode 100644 index 0000000000..00f52036e4 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/glyph.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Glyph + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/identifier.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/identifier.mdx new file mode 100644 index 0000000000..d1d487ae8d --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/identifier.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Identifier + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/ifStatement.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/ifStatement.mdx new file mode 100644 index 0000000000..01d99cb476 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/ifStatement.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# If statement + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/instance.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/instance.mdx new file mode 100644 index 0000000000..62108da08c --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/instance.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Instance + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/line.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/line.mdx new file mode 100644 index 0000000000..401642cc43 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/line.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Line + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/list.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/list.mdx new file mode 100644 index 0000000000..d3e368f538 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/list.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# List + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/map.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/map.mdx new file mode 100644 index 0000000000..919201be61 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/map.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Map + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/name.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/name.mdx new file mode 100644 index 0000000000..1e173e7614 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/name.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Name + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/namedFunction.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/namedFunction.mdx new file mode 100644 index 0000000000..8dff438f9c --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/namedFunction.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Named function + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/namedParagraph.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/namedParagraph.mdx new file mode 100644 index 0000000000..ca38ea13fd --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/namedParagraph.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Named paragraph + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/nonWhitespaceSequence.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/nonWhitespaceSequence.mdx new file mode 100644 index 0000000000..72a21072b1 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/nonWhitespaceSequence.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Non-whitespace sequence + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/notebookCell.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/notebookCell.mdx new file mode 100644 index 0000000000..7939ad2042 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/notebookCell.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Notebook cell + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/paragraph.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/paragraph.mdx new file mode 100644 index 0000000000..00bd32657b --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/paragraph.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Paragraph + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/part.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/part.mdx new file mode 100644 index 0000000000..3f2dd1473e --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/part.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Part + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/regularExpression.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/regularExpression.mdx new file mode 100644 index 0000000000..13db26d17d --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/regularExpression.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Regular expression + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/section.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/section.mdx new file mode 100644 index 0000000000..01a62de66e --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/section.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Section + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelFive.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelFive.mdx new file mode 100644 index 0000000000..6d6caf8210 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelFive.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Section level five + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelFour.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelFour.mdx new file mode 100644 index 0000000000..d5efcabb4c --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelFour.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Section level four + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelOne.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelOne.mdx new file mode 100644 index 0000000000..75557736d2 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelOne.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Section level one + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelSix.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelSix.mdx new file mode 100644 index 0000000000..ba57de133a --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelSix.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Section level six + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelThree.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelThree.mdx new file mode 100644 index 0000000000..9141f87946 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelThree.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Section level three + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelTwo.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelTwo.mdx new file mode 100644 index 0000000000..caaa175ed8 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelTwo.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Section level two + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/selector.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/selector.mdx new file mode 100644 index 0000000000..97f0d16284 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/selector.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Selector + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/sentence.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/sentence.mdx new file mode 100644 index 0000000000..e61247b280 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/sentence.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Sentence + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/statement.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/statement.mdx new file mode 100644 index 0000000000..547024be52 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/statement.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Statement + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/subParagraph.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/subParagraph.mdx new file mode 100644 index 0000000000..06d6bf6157 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/subParagraph.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Subparagraph + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/subSection.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/subSection.mdx new file mode 100644 index 0000000000..f0d032d1e5 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/subSection.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Subsection + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/subSubSection.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/subSubSection.mdx new file mode 100644 index 0000000000..95eed1890d --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/subSubSection.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Subsubsection + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/surroundingPair.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/surroundingPair.mdx new file mode 100644 index 0000000000..6217c8b259 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/surroundingPair.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Surrounding pair + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/token.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/token.mdx new file mode 100644 index 0000000000..49654a0745 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/token.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Token + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/type.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/type.mdx new file mode 100644 index 0000000000..9aeb23d078 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/type.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Type + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/unit.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/unit.mdx new file mode 100644 index 0000000000..83128877dd --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/unit.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Unit + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/url.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/url.mdx new file mode 100644 index 0000000000..78f9480d8a --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/url.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# URL + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/value.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/value.mdx new file mode 100644 index 0000000000..abfb5568be --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/value.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Value + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/word.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/word.mdx new file mode 100644 index 0000000000..9e0279a1e3 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/word.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# Sub token word + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/xmlBothTags.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/xmlBothTags.mdx new file mode 100644 index 0000000000..0aafaf8a3f --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/xmlBothTags.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# XML both tags + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/xmlElement.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/xmlElement.mdx new file mode 100644 index 0000000000..01a28194f2 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/xmlElement.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# XML element + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/xmlEndTag.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/xmlEndTag.mdx new file mode 100644 index 0000000000..2edcecdeb9 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/xmlEndTag.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# XML end tag + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/xmlStartTag.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/xmlStartTag.mdx new file mode 100644 index 0000000000..c6d491bc63 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/xmlStartTag.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; + +# XML start tag + + + diff --git a/packages/lib-cheatsheet/src/lib/sampleSpokenFormInfos/defaults.json b/packages/lib-cheatsheet/src/lib/sampleSpokenFormInfos/defaults.json index 64c0d9273f..a65a1c5957 100644 --- a/packages/lib-cheatsheet/src/lib/sampleSpokenFormInfos/defaults.json +++ b/packages/lib-cheatsheet/src/lib/sampleSpokenFormInfos/defaults.json @@ -1336,7 +1336,7 @@ "variations": [ { "spokenForm": "short paint", - "description": "Non-whitespace sequence bounded by surrounding pair delimeters" + "description": "Non-whitespace sequence bounded by surrounding pair delimiters" } ] }, @@ -1346,7 +1346,7 @@ "variations": [ { "spokenForm": "short block", - "description": "Paragraph bounded by surrounding pair delimeters" + "description": "Paragraph bounded by surrounding pair delimiters" } ] }, diff --git a/packages/lib-common/src/index.ts b/packages/lib-common/src/index.ts index 2ed2329a15..1b88c6acc6 100644 --- a/packages/lib-common/src/index.ts +++ b/packages/lib-common/src/index.ts @@ -32,6 +32,7 @@ export * from "./ide/types/QuickPickOptions"; export * from "./ide/types/RawTreeSitterQueryProvider"; export * from "./ide/types/TutorialContentProvider"; export * from "./ide/util/messages"; +export * from "./references"; export * from "./scopeSupportFacets/languageScopeSupport"; export * from "./scopeSupportFacets/PlaintextScopeSupportFacetInfos"; export * from "./scopeSupportFacets/scopeSupportFacetInfos"; diff --git a/packages/lib-common/src/references/ReferenceEntry.ts b/packages/lib-common/src/references/ReferenceEntry.ts new file mode 100644 index 0000000000..a3f23bf6b2 --- /dev/null +++ b/packages/lib-common/src/references/ReferenceEntry.ts @@ -0,0 +1,25 @@ +export interface SpokenFormReference { + defaultSpokenForm?: string; + private?: boolean; + disabledByDefault?: boolean; +} + +export interface ReferenceEntry extends SpokenFormReference { + name: string; + nameShort?: string; + legacySpokenForms?: string[]; + description?: string; + syntaxes: SyntaxDefinition[]; + examples: ExampleDefinition[]; +} + +interface SyntaxDefinition { + pattern: string; + description: string; + cheatsheet: string; +} + +interface ExampleDefinition { + spokenForm: string; + description: string; +} diff --git a/packages/lib-common/src/references/actionReferences.ts b/packages/lib-common/src/references/actionReferences.ts new file mode 100644 index 0000000000..3573d46e2d --- /dev/null +++ b/packages/lib-common/src/references/actionReferences.ts @@ -0,0 +1,910 @@ +import type { ActionType } from "../types/command/ActionDescriptor"; +import type { ReferenceEntry } from "./ReferenceEntry"; + +const DEFAULT_PATTERN = " "; +const DEFAULT_PATTERN_SCOPE = " "; + +type TalonSideActionType = "applyFormatter" | "nextHomophone"; + +export const actionReferences: Record< + ActionType | TalonSideActionType, + ReferenceEntry +> = { + addSelection: { + name: "Add selection", + defaultSpokenForm: "append", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Adds to the current selection set", + cheatsheet: "Add selection", + }, + ], + examples: [], + }, + addSelectionAfter: { + name: "Add selection after", + defaultSpokenForm: "append post", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: + "Adds empty selection after to the current selection set", + cheatsheet: "Add selection after", + }, + ], + examples: [], + }, + addSelectionBefore: { + name: "Add selection before", + defaultSpokenForm: "append pre", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: + "Adds empty selection before to the current selection set", + cheatsheet: "Add selection before", + }, + ], + examples: [], + }, + breakLine: { + name: "Break line", + defaultSpokenForm: "break", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Breaks the line before ", + cheatsheet: "Breaks the line", + }, + ], + examples: [], + }, + clearAndSetSelection: { + name: "Change", + defaultSpokenForm: "change", + legacySpokenForms: ["clear"], + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: + "Change by clearing it and setting a new selection", + cheatsheet: "Change", + }, + ], + examples: [], + }, + copyToClipboard: { + name: "Copy to clipboard", + defaultSpokenForm: "copy", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Copy to clipboard", + cheatsheet: "Copy to clipboard", + }, + ], + examples: [], + }, + cutToClipboard: { + name: "Cut to clipboard", + defaultSpokenForm: "carve", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Cut to clipboard", + cheatsheet: "Cut to clipboard", + }, + ], + examples: [], + }, + decrement: { + name: "Decrement", + defaultSpokenForm: "decrement", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Decrement number at ", + cheatsheet: "Decrement number", + }, + ], + examples: [], + }, + deselect: { + name: "Deselect", + defaultSpokenForm: "give", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Deselect ", + cheatsheet: "Deselect", + }, + ], + examples: [], + }, + editNewLineAfter: { + name: "Edit new line/scope after", + defaultSpokenForm: "pour", + description: "Scope defaults to line", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Edit new line after ", + cheatsheet: "Edit new line after", + }, + { + pattern: DEFAULT_PATTERN_SCOPE, + description: "Edit new after ", + cheatsheet: "Edit new after", + }, + ], + examples: [], + }, + editNewLineBefore: { + name: "Edit new line/scope before", + defaultSpokenForm: "drink", + description: "Scope defaults to line", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Edit new line before ", + cheatsheet: "Edit new line before", + }, + { + pattern: DEFAULT_PATTERN_SCOPE, + description: "Edit new before ", + cheatsheet: "Edit new before", + }, + ], + examples: [], + }, + "experimental.setInstanceReference": { + name: "Set instance reference", + defaultSpokenForm: "from", + description: + "Sets the instance reference for the next 'instance of' action", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Set instance reference to ", + cheatsheet: "Set instance reference", + }, + ], + examples: [], + }, + extractVariable: { + name: "Extract variable", + defaultSpokenForm: "extract", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Extract variable from ", + cheatsheet: "Extract variable", + }, + ], + examples: [], + }, + findInDocument: { + name: "Find in document", + defaultSpokenForm: "scout", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Find in document", + cheatsheet: "Find in document", + }, + ], + examples: [], + }, + findInWorkspace: { + name: "Find in workspace", + defaultSpokenForm: "scout all", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Find in workspace", + cheatsheet: "Find in workspace", + }, + ], + examples: [], + }, + flashTargets: { + name: "Flash target", + defaultSpokenForm: "flash", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Flash ", + cheatsheet: "Flash target", + }, + ], + examples: [], + }, + foldRegion: { + name: "Fold region", + defaultSpokenForm: "fold", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Fold region at ", + cheatsheet: "Fold region", + }, + ], + examples: [], + }, + followLink: { + name: "Follow link", + defaultSpokenForm: "follow", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Follow link at ", + cheatsheet: "Follow link", + }, + ], + examples: [], + }, + followLinkAside: { + name: "Follow link aside", + defaultSpokenForm: "follow split", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Follow link at aside (e.g. in a split view)", + cheatsheet: "Follow link aside", + }, + ], + examples: [], + }, + gitAccept: { + name: "Git accept", + defaultSpokenForm: "git accept", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Accept Git change at ", + cheatsheet: "Git accept", + }, + ], + examples: [], + }, + gitRevert: { + name: "Git revert", + defaultSpokenForm: "git revert", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Revert Git change at ", + cheatsheet: "Git revert", + }, + ], + examples: [], + }, + gitStage: { + name: "Git stage", + defaultSpokenForm: "git stage", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Stage Git change at ", + cheatsheet: "Git stage", + }, + ], + examples: [], + }, + gitUnstage: { + name: "Git unstage", + defaultSpokenForm: "git unstage", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Unstage Git change at ", + cheatsheet: "Git unstage", + }, + ], + examples: [], + }, + increment: { + name: "Increment", + defaultSpokenForm: "increment", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Increment number at ", + cheatsheet: "Increment number", + }, + ], + examples: [], + }, + indentLine: { + name: "Indent line", + defaultSpokenForm: "indent", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Indent line containing ", + cheatsheet: "Indent line", + }, + ], + examples: [], + }, + insertCopyAfter: { + name: "Insert copy after", + defaultSpokenForm: "clone", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Insert copy after ", + cheatsheet: "Insert copy after", + }, + ], + examples: [], + }, + insertCopyBefore: { + name: "Insert copy before", + defaultSpokenForm: "clone up", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Insert copy before ", + cheatsheet: "Insert copy before", + }, + ], + examples: [], + }, + insertEmptyLineAfter: { + name: "Insert empty line after", + defaultSpokenForm: "float", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Insert empty line after ", + cheatsheet: "Insert empty line after", + }, + ], + examples: [], + }, + insertEmptyLineBefore: { + name: "Insert empty line before", + defaultSpokenForm: "drop", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Insert empty line before ", + cheatsheet: "Insert empty line before", + }, + ], + examples: [], + }, + insertEmptyLinesAround: { + name: "Insert empty lines around", + defaultSpokenForm: "puff", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Insert empty lines around ", + cheatsheet: "Insert empty lines around", + }, + ], + examples: [], + }, + joinLines: { + name: "Join lines", + defaultSpokenForm: "join", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Join lines at ", + cheatsheet: "Join lines", + }, + ], + examples: [], + }, + outdentLine: { + name: "Outdent line", + defaultSpokenForm: "dedent", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Outdent line containing ", + cheatsheet: "Outdent line", + }, + ], + examples: [], + }, + randomizeTargets: { + name: "Randomize targets", + defaultSpokenForm: "shuffle", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Randomize s", + cheatsheet: "Randomize targets", + }, + ], + examples: [], + }, + remove: { + name: "Remove", + defaultSpokenForm: "chuck", + description: + "This action can be used to remove a target without moving the cursor", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Remove ", + cheatsheet: "Remove", + }, + ], + examples: [ + { + spokenForm: " blue air", + description: "Removes the token containing letter 'a' with a blue hat.", + }, + ], + }, + rename: { + name: "Rename", + defaultSpokenForm: "rename", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Rename ", + cheatsheet: "Rename", + }, + ], + examples: [], + }, + revealDefinition: { + name: "Reveal definition", + defaultSpokenForm: "define", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Reveal definition of ", + cheatsheet: "Reveal definition", + }, + ], + examples: [], + }, + revealTypeDefinition: { + name: "Reveal type definition", + defaultSpokenForm: "type deaf", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Reveal type definition of ", + cheatsheet: "Reveal type definition", + }, + ], + examples: [], + }, + reverseTargets: { + name: "Reverse targets", + defaultSpokenForm: "reverse", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Reverse s", + cheatsheet: "Reverse targets", + }, + ], + examples: [], + }, + scrollToBottom: { + name: "Scroll to bottom", + defaultSpokenForm: "bottom", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Scroll to bottom of the viewport", + cheatsheet: "Scroll to bottom", + }, + ], + examples: [], + }, + scrollToCenter: { + name: "Scroll to center", + defaultSpokenForm: "center", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Scroll to center of the viewport", + cheatsheet: "Scroll to center", + }, + ], + examples: [], + }, + scrollToTop: { + name: "Scroll to top", + defaultSpokenForm: "crown", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Scroll to top of the viewport", + cheatsheet: "Scroll to top", + }, + ], + examples: [], + }, + setSelection: { + name: "Set selection", + defaultSpokenForm: "take", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Set selection to ", + cheatsheet: "Set selection", + }, + ], + examples: [], + }, + setSelectionAfter: { + name: "Set selection after", + defaultSpokenForm: "post", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Set empty selection after ", + cheatsheet: "Set selection after", + }, + ], + examples: [], + }, + setSelectionBefore: { + name: "Set selection before", + defaultSpokenForm: "pre", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Set empty selection before ", + cheatsheet: "Set selection before", + }, + ], + examples: [], + }, + showDebugHover: { + name: "Show debug hover", + defaultSpokenForm: "inspect", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Show debug hover for ", + cheatsheet: "Show debug hover", + }, + ], + examples: [], + }, + showHover: { + name: "Show hover", + defaultSpokenForm: "hover", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Show hover for ", + cheatsheet: "Show hover", + }, + ], + examples: [], + }, + showQuickFix: { + name: "Show quick fix", + defaultSpokenForm: "quick fix", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Show quick fix for ", + cheatsheet: "Show quick fix", + }, + ], + examples: [], + }, + showReferences: { + name: "Show references", + defaultSpokenForm: "reference", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Show references for ", + cheatsheet: "Show references", + }, + ], + examples: [], + }, + sortTargets: { + name: "Sort targets", + defaultSpokenForm: "sort", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Sort s", + cheatsheet: "Sort targets", + }, + ], + examples: [], + }, + toggleLineBreakpoint: { + name: "Toggle line/scope breakpoint", + defaultSpokenForm: "break point", + description: "Scope defaults to line", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Toggle breakpoint on line containing ", + cheatsheet: "Toggle line breakpoint", + }, + { + pattern: " token ", + description: "Toggle inline breakpoint at ", + cheatsheet: "Toggle inline breakpoint", + }, + ], + examples: [], + }, + toggleLineComment: { + name: "Toggle line comment", + defaultSpokenForm: "comment", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Toggle line comment at ", + cheatsheet: "Toggle line comment", + }, + ], + examples: [], + }, + unfoldRegion: { + name: "Unfold region", + defaultSpokenForm: "unfold", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Unfold region at ", + cheatsheet: "Unfold region", + }, + ], + examples: [], + }, + callAsFunction: { + name: "Call as function", + defaultSpokenForm: "call", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Insert call to on selection", + cheatsheet: "Insert call to on selection", + }, + { + pattern: " on ", + description: "Insert call to on ", + cheatsheet: "Insert call to on ", + }, + ], + examples: [], + }, + generateSnippet: { + name: "Generate snippet", + defaultSpokenForm: "snip make", + legacySpokenForms: ["snippet make"], + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Generate snippet from ", + cheatsheet: "Generate snippet", + }, + ], + examples: [], + }, + highlight: { + name: "Highlight", + defaultSpokenForm: "highlight", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Highlight ", + cheatsheet: "Highlight", + }, + ], + examples: [], + }, + insertSnippet: { + name: "Insert snippet", + defaultSpokenForm: "snip", + syntaxes: [ + { + pattern: " ", + description: "Insert snippet at ", + cheatsheet: "Insert snippet at ", + }, + ], + examples: [], + }, + moveToTarget: { + name: "Move to target", + defaultSpokenForm: "move", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Move to selection", + cheatsheet: "Move to selection", + }, + { + pattern: " ", + description: "Move to ", + cheatsheet: "Move to ", + }, + ], + examples: [], + }, + pasteFromClipboard: { + name: "Paste from clipboard", + defaultSpokenForm: "paste", + syntaxes: [ + { + pattern: " ", + description: "Paste from clipboard at ", + cheatsheet: "Paste from clipboard at ", + }, + ], + examples: [], + }, + replaceWithTarget: { + name: "Replace with target", + defaultSpokenForm: "bring", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Insert copy of at selection", + cheatsheet: "Insert copy of at selection", + }, + { + pattern: " ", + description: "Copy to ", + cheatsheet: "Copy to ", + }, + ], + examples: [], + }, + rewrapWithPairedDelimiter: { + name: "Rewrap with paired delimiter", + defaultSpokenForm: "repack", + syntaxes: [ + { + pattern: " ", + description: "Rewrap with ", + cheatsheet: "Rewrap with ", + }, + ], + examples: [], + }, + swapTargets: { + name: "Swap targets", + defaultSpokenForm: "swap", + syntaxes: [ + { + pattern: " ", + description: "Swap selection with ", + cheatsheet: "Swap selection with ", + }, + { + pattern: " ", + description: "Swap with ", + cheatsheet: "Swap with ", + }, + ], + examples: [], + }, + wrapWithPairedDelimiter: { + name: "Wrap with paired delimiter", + defaultSpokenForm: "wrap", + syntaxes: [ + { + pattern: " ", + description: "Wrap with ", + cheatsheet: "Wrap with ", + }, + ], + examples: [], + }, + wrapWithSnippet: { + name: "Wrap with snippet", + defaultSpokenForm: "wrap", + syntaxes: [ + { + pattern: " ", + description: "Wrap with ", + cheatsheet: "Wrap with ", + }, + ], + examples: [], + }, + applyFormatter: { + name: "Apply formatter", + defaultSpokenForm: "format", + syntaxes: [ + { + pattern: " at ", + description: "Reformat as ", + cheatsheet: "Reformat as ", + }, + ], + examples: [], + }, + nextHomophone: { + name: "Next homophone", + defaultSpokenForm: "phones", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Cycle to next homophone for ", + cheatsheet: "Cycle to next homophone", + }, + ], + examples: [], + }, + + // Private actions -------------------- + + "private.showParseTree": { + name: "Show parse tree", + defaultSpokenForm: "parse tree", + private: true, + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Show parse tree for ", + cheatsheet: "Show parse tree", + }, + ], + examples: [], + }, + parsed: { + name: "Parsed", + defaultSpokenForm: "parsed", + private: true, + syntaxes: [], + examples: [], + }, + "private.getTargets": { + name: "Get targets", + defaultSpokenForm: "get targets", + private: true, + syntaxes: [], + examples: [], + }, + "private.setKeyboardTarget": { + name: "Set keyboard target", + defaultSpokenForm: "set keyboard target", + private: true, + syntaxes: [], + examples: [], + }, + executeCommand: { + name: "Execute command", + defaultSpokenForm: "execute command", + private: true, + syntaxes: [], + examples: [], + }, + editNew: { + name: "Edit new", + defaultSpokenForm: "edit new", + private: true, + syntaxes: [], + examples: [], + }, + getText: { + name: "Get text", + defaultSpokenForm: "get text", + private: true, + syntaxes: [], + examples: [], + }, + replace: { + name: "Replace", + defaultSpokenForm: "replace", + private: true, + syntaxes: [], + examples: [], + }, +}; diff --git a/packages/lib-common/src/references/index.ts b/packages/lib-common/src/references/index.ts new file mode 100644 index 0000000000..e915f5ec76 --- /dev/null +++ b/packages/lib-common/src/references/index.ts @@ -0,0 +1,4 @@ +export * from "./actionReferences"; +export * from "./modifierReferences"; +export * from "./ReferenceEntry"; +export * from "./scopeReferences"; diff --git a/packages/lib-common/src/references/modifierReferences.ts b/packages/lib-common/src/references/modifierReferences.ts new file mode 100644 index 0000000000..5feac48e26 --- /dev/null +++ b/packages/lib-common/src/references/modifierReferences.ts @@ -0,0 +1,434 @@ +import type { ModifierType } from "../types/command/PartialTargetDescriptor.types"; +import type { SpokenFormMapKeyTypes } from "../types/SpokenFormType"; +import type { ReferenceEntry, SpokenFormReference } from "./ReferenceEntry"; + +const DEFAULT_PATTERN = ""; + +type AdditionalModifierReferenceType = "ancestor"; + +export const modifierReferences: Record< + ModifierType | AdditionalModifierReferenceType, + ReferenceEntry +> = { + startOf: { + name: "Start of", + defaultSpokenForm: "start of", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Empty position at start of target", + cheatsheet: "Empty position at start of target", + }, + ], + examples: [], + }, + endOf: { + name: "End of", + defaultSpokenForm: "end of", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Empty position at end of target", + cheatsheet: "Empty position at end of target", + }, + ], + examples: [], + }, + interiorOnly: { + name: "Interior only", + defaultSpokenForm: "inside", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Interior only", + cheatsheet: "Interior only", + }, + ], + examples: [], + }, + excludeInterior: { + name: "Exclude interior", + defaultSpokenForm: "bounds", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Bounding paired delimiters", + cheatsheet: "Bounding paired delimiters", + }, + ], + examples: [], + }, + visible: { + name: "Visible", + defaultSpokenForm: "visible", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Visible in viewport", + cheatsheet: "Visible in viewport", + }, + ], + examples: [], + }, + containingScope: { + name: "Containing scope", + syntaxes: [ + { + pattern: "", + description: "Containing instance of ", + cheatsheet: "Containing instance of ", + }, + ], + examples: [], + }, + everyScope: { + name: "Every scope", + defaultSpokenForm: "every", + syntaxes: [ + { + pattern: " ", + description: "Every instance of ", + cheatsheet: "Every instance of ", + }, + ], + examples: [], + }, + ancestor: { + name: "Ancestor", + defaultSpokenForm: "grand", + syntaxes: [ + { + pattern: " ", + description: "Grandparent containing instance of ", + cheatsheet: "Grandparent containing instance of ", + }, + ], + examples: [], + }, + ordinalScope: { + name: "Ordinal scope", + syntaxes: [ + { + pattern: " ", + description: " instance of in iteration scope", + cheatsheet: " instance of in iteration scope", + }, + { + pattern: " ", + description: "-to-last instance of in iteration scope", + cheatsheet: "-to-last instance of in iteration scope", + }, + { + pattern: " s", + description: + "First instances of in iteration scope, as contiguous range", + cheatsheet: + "First instances of in iteration scope, as contiguous range", + }, + { + pattern: " s", + description: + "First instances of in iteration scope, as individual targets", + cheatsheet: + "First instances of in iteration scope, as individual targets", + }, + { + pattern: " s", + description: + "Last instances of in iteration scope, as contiguous range", + cheatsheet: + "Last instances of in iteration scope, as contiguous range", + }, + { + pattern: " s", + description: + "Last instances of in iteration scope, as individual targets", + cheatsheet: + "Last instances of in iteration scope, as individual targets", + }, + ], + examples: [], + }, + relativeScope: { + name: "Relative scope", + syntaxes: [ + { + pattern: " ", + description: "Previous instance of ", + cheatsheet: "Previous instance of ", + }, + { + pattern: " ", + description: " instance of before target", + cheatsheet: " instance of before target", + }, + { + pattern: " ", + description: "Next instance of ", + cheatsheet: "Next instance of ", + }, + { + pattern: " ", + description: " instance of after target", + cheatsheet: " instance of after target", + }, + { + pattern: " ", + description: + "Single instance of including target, going backwards", + cheatsheet: + "Single instance of including target, going backwards", + }, + { + pattern: " ", + description: + "Single instance of including target, going forwards", + cheatsheet: + "Single instance of including target, going forwards", + }, + { + pattern: " s ", + description: + " instances of including target, going backwards, as contiguous range", + cheatsheet: + " instances of including target, going backwards, as contiguous range", + }, + { + pattern: " s ", + description: + " instances of including target, going backwards, as individual targets", + cheatsheet: + " instances of including target, going backwards, as individual targets", + }, + { + pattern: " s", + description: + " instances of including target, going forwards, as contiguous range", + cheatsheet: + " instances of including target, going forwards, as contiguous range", + }, + { + pattern: " s", + description: + " instances of including target, going forwards, as individual targets", + cheatsheet: + " instances of including target, going forwards, as individual targets", + }, + { + pattern: " s", + description: + "Previous instances of , as contiguous range", + cheatsheet: + "Previous instances of , as contiguous range", + }, + { + pattern: " s", + description: + "Previous instances of , as individual targets", + cheatsheet: + "Previous instances of , as individual targets", + }, + { + pattern: " s", + description: "Next instances of , as contiguous range", + cheatsheet: "Next instances of , as contiguous range", + }, + { + pattern: " s", + description: + "Next instances of , as individual targets", + cheatsheet: "Next instances of , as individual targets", + }, + ], + examples: [], + }, + extendThroughStartOf: { + name: "Extend through start of", + defaultSpokenForm: "head", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Extend through start of line/pair", + cheatsheet: "Extend through start of line/pair", + }, + { + pattern: " ", + description: "Extend through start of ", + cheatsheet: "Extend through start of ", + }, + ], + examples: [], + }, + extendThroughEndOf: { + name: "Extend through end of", + defaultSpokenForm: "tail", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Extend through end of line/pair", + cheatsheet: "Extend through end of line/pair", + }, + { + pattern: " ", + description: "Extend through end of ", + cheatsheet: "Extend through end of ", + }, + ], + examples: [], + }, + leading: { + name: "Leading", + defaultSpokenForm: "leading", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Leading delimiter range", + cheatsheet: "Leading delimiter range", + }, + ], + examples: [], + }, + trailing: { + name: "Trailing", + defaultSpokenForm: "trailing", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Trailing delimiter range", + cheatsheet: "Trailing delimiter range", + }, + ], + examples: [], + }, + toRawSelection: { + name: "Raw selection", + defaultSpokenForm: "just", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "No inference", + cheatsheet: "No inference", + }, + ], + examples: [], + }, + keepContentFilter: { + name: "Keep content filter", + defaultSpokenForm: "content", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Keep content filter", + cheatsheet: "Keep content filter", + }, + ], + examples: [], + }, + keepEmptyFilter: { + name: "Keep empty filter", + defaultSpokenForm: "empty", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Keep empty filter", + cheatsheet: "Keep empty filter", + }, + ], + examples: [], + }, + inferPreviousMark: { + name: "Infer previous mark", + defaultSpokenForm: "its", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Infer previous mark", + cheatsheet: "Infer previous mark", + }, + ], + examples: [], + }, + + // Private modifiers, but that has spoken forms + preferredScope: { + name: "Preferred scope", + private: true, + syntaxes: [], + examples: [], + }, + + // Modifiers without spoken forms + modifyIfUntyped: { + name: "Modify if untyped", + private: true, + syntaxes: [ + { + pattern: "", + description: "Preferred instance of ", + cheatsheet: "Preferred instance of ", + }, + ], + examples: [], + }, + fallback: { + name: "Fallback", + private: true, + syntaxes: [], + examples: [], + }, + range: { + name: "Range", + private: true, + syntaxes: [], + examples: [], + }, +}; + +export const simpleModifierReferenceIds = [ + "excludeInterior", + "toRawSelection", + "leading", + "trailing", + "keepContentFilter", + "keepEmptyFilter", + "inferPreviousMark", + "startOf", + "endOf", + "interiorOnly", + "visible", + "extendThroughStartOf", + "extendThroughEndOf", + "everyScope", +] as const satisfies readonly SpokenFormMapKeyTypes["simpleModifier"][]; + +export const modifierExtraReferenceIds = [ + "first", + "last", + "previous", + "next", + "forward", + "backward", + "ancestor", +] as const satisfies readonly SpokenFormMapKeyTypes["modifierExtra"][]; + +export const modifierExtraReferences = { + first: { + defaultSpokenForm: "first", + }, + last: { + defaultSpokenForm: "last", + }, + previous: { + defaultSpokenForm: "previous", + }, + next: { + defaultSpokenForm: "next", + }, + forward: { + defaultSpokenForm: "forward", + }, + backward: { + defaultSpokenForm: "backward", + }, + ancestor: modifierReferences.ancestor, +} satisfies Record; diff --git a/packages/lib-common/src/references/scopeReferences.ts b/packages/lib-common/src/references/scopeReferences.ts new file mode 100644 index 0000000000..956154ffc2 --- /dev/null +++ b/packages/lib-common/src/references/scopeReferences.ts @@ -0,0 +1,841 @@ +import type { ScopeTypeType } from "../types/command/PartialTargetDescriptor.types"; +import type { ReferenceEntry } from "./ReferenceEntry"; + +const DEFAULT_PATTERN = ""; + +export const scopeReferences: Record = { + argumentOrParameter: { + name: "Argument or parameter", + defaultSpokenForm: "arg", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Argument", + cheatsheet: "Argument", + }, + ], + examples: [], + }, + argumentList: { + name: "Argument list", + defaultSpokenForm: "arg list", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Argument list", + cheatsheet: "Argument list", + }, + ], + examples: [], + }, + anonymousFunction: { + name: "Anonymous function", + defaultSpokenForm: "lambda", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Anonymous function", + cheatsheet: "Anonymous function", + }, + ], + examples: [], + }, + attribute: { + name: "Attribute", + defaultSpokenForm: "attribute", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Attribute", + cheatsheet: "Attribute", + }, + ], + examples: [], + }, + branch: { + name: "Branch", + defaultSpokenForm: "branch", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Branch", + cheatsheet: "Branch", + }, + ], + examples: [], + }, + class: { + name: "Class", + defaultSpokenForm: "class", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Class", + cheatsheet: "Class", + }, + ], + examples: [], + }, + className: { + name: "Class name", + defaultSpokenForm: "class name", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Class name", + cheatsheet: "Class name", + }, + ], + examples: [], + }, + collectionItem: { + name: "Collection item", + defaultSpokenForm: "item", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Collection item", + cheatsheet: "Collection item", + }, + ], + examples: [], + }, + collectionKey: { + name: "Collection key", + defaultSpokenForm: "key", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Collection key", + cheatsheet: "Collection key", + }, + ], + examples: [], + }, + comment: { + name: "Comment", + defaultSpokenForm: "comment", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Comment", + cheatsheet: "Comment", + }, + ], + examples: [], + }, + functionCall: { + name: "Function call", + defaultSpokenForm: "call", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Function call", + cheatsheet: "Function call", + }, + ], + examples: [], + }, + functionCallee: { + name: "Function callee", + defaultSpokenForm: "callee", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Function callee", + cheatsheet: "Function callee", + }, + ], + examples: [], + }, + functionName: { + name: "Function name", + defaultSpokenForm: "funk name", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Function name", + cheatsheet: "Function name", + }, + ], + examples: [], + }, + ifStatement: { + name: "If statement", + defaultSpokenForm: "if state", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "If statement", + cheatsheet: "If statement", + }, + ], + examples: [], + }, + instance: { + name: "Instance", + defaultSpokenForm: "instance", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Instance", + cheatsheet: "Instance", + }, + ], + examples: [], + }, + list: { + name: "List", + defaultSpokenForm: "list", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "List", + cheatsheet: "List", + }, + ], + examples: [], + }, + map: { + name: "Map", + defaultSpokenForm: "map", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Map", + cheatsheet: "Map", + }, + ], + examples: [], + }, + name: { + name: "Name", + defaultSpokenForm: "name", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Name", + cheatsheet: "Name", + }, + ], + examples: [], + }, + namedFunction: { + name: "Named function", + defaultSpokenForm: "funk", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Named function", + cheatsheet: "Named function", + }, + ], + examples: [], + }, + regularExpression: { + name: "Regular expression", + defaultSpokenForm: "regex", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Regular expression", + cheatsheet: "Regular expression", + }, + ], + examples: [], + }, + statement: { + name: "Statement", + defaultSpokenForm: "state", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Statement", + cheatsheet: "Statement", + }, + ], + examples: [], + }, + type: { + name: "Type", + defaultSpokenForm: "type", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Type", + cheatsheet: "Type", + }, + ], + examples: [], + }, + value: { + name: "Value", + defaultSpokenForm: "value", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Value", + cheatsheet: "Value", + }, + ], + examples: [], + }, + condition: { + name: "Condition", + defaultSpokenForm: "condition", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Condition", + cheatsheet: "Condition", + }, + ], + examples: [], + }, + section: { + name: "Section", + defaultSpokenForm: "section", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Section", + cheatsheet: "Section", + }, + ], + examples: [], + }, + sectionLevelOne: { + name: "Section level one", + defaultSpokenForm: "one section", + disabledByDefault: true, + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Section level one", + cheatsheet: "Section level one", + }, + ], + examples: [], + }, + sectionLevelTwo: { + name: "Section level two", + defaultSpokenForm: "two section", + disabledByDefault: true, + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Section level two", + cheatsheet: "Section level two", + }, + ], + examples: [], + }, + sectionLevelThree: { + name: "Section level three", + defaultSpokenForm: "three section", + disabledByDefault: true, + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Section level three", + cheatsheet: "Section level three", + }, + ], + examples: [], + }, + sectionLevelFour: { + name: "Section level four", + defaultSpokenForm: "four section", + disabledByDefault: true, + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Section level four", + cheatsheet: "Section level four", + }, + ], + examples: [], + }, + sectionLevelFive: { + name: "Section level five", + defaultSpokenForm: "five section", + disabledByDefault: true, + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Section level five", + cheatsheet: "Section level five", + }, + ], + examples: [], + }, + sectionLevelSix: { + name: "Section level six", + defaultSpokenForm: "six section", + disabledByDefault: true, + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Section level six", + cheatsheet: "Section level six", + }, + ], + examples: [], + }, + selector: { + name: "Selector", + defaultSpokenForm: "selector", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Selector", + cheatsheet: "Selector", + }, + ], + examples: [], + }, + unit: { + name: "Unit", + defaultSpokenForm: "unit", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Unit", + cheatsheet: "Unit", + }, + ], + examples: [], + }, + xmlBothTags: { + name: "XML both tags", + defaultSpokenForm: "tags", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "XML both tags", + cheatsheet: "XML both tags", + }, + ], + examples: [], + }, + xmlElement: { + name: "XML element", + defaultSpokenForm: "element", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "XML element", + cheatsheet: "XML element", + }, + ], + examples: [], + }, + xmlEndTag: { + name: "XML end tag", + defaultSpokenForm: "end tag", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "XML end tag", + cheatsheet: "XML end tag", + }, + ], + examples: [], + }, + xmlStartTag: { + name: "XML start tag", + defaultSpokenForm: "start tag", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "XML start tag", + cheatsheet: "XML start tag", + }, + ], + examples: [], + }, + part: { + name: "Part", + defaultSpokenForm: "part", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Part", + cheatsheet: "Part", + }, + ], + examples: [], + }, + chapter: { + name: "Chapter", + defaultSpokenForm: "chapter", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Chapter", + cheatsheet: "Chapter", + }, + ], + examples: [], + }, + subSection: { + name: "Subsection", + defaultSpokenForm: "subsection", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Subsection", + cheatsheet: "Subsection", + }, + ], + examples: [], + }, + subSubSection: { + name: "Subsubsection", + defaultSpokenForm: "subsubsection", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Subsubsection", + cheatsheet: "Subsubsection", + }, + ], + examples: [], + }, + namedParagraph: { + name: "Named paragraph", + defaultSpokenForm: "paragraph", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Named paragraph", + cheatsheet: "Named paragraph", + }, + ], + examples: [], + }, + subParagraph: { + name: "Subparagraph", + defaultSpokenForm: "subparagraph", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Subparagraph", + cheatsheet: "Subparagraph", + }, + ], + examples: [], + }, + environment: { + name: "Environment", + defaultSpokenForm: "environment", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Environment", + cheatsheet: "Environment", + }, + ], + examples: [], + }, + character: { + name: "Character", + defaultSpokenForm: "char", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Character", + cheatsheet: "Character", + }, + ], + examples: [], + }, + word: { + name: "Sub token word", + defaultSpokenForm: "sub", + legacySpokenForms: ["word"], + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Sub token word", + cheatsheet: "Sub token word", + }, + ], + examples: [], + }, + token: { + name: "Token", + defaultSpokenForm: "token", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Token", + cheatsheet: "Token", + }, + ], + examples: [], + }, + identifier: { + name: "Identifier", + defaultSpokenForm: "identifier", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Identifier", + cheatsheet: "Identifier", + }, + ], + examples: [], + }, + line: { + name: "Line", + defaultSpokenForm: "line", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Line", + cheatsheet: "Line", + }, + ], + examples: [], + }, + fullLine: { + name: "Full line", + defaultSpokenForm: "full line", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Full line", + cheatsheet: "Full line", + }, + ], + examples: [], + }, + sentence: { + name: "Sentence", + defaultSpokenForm: "sentence", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Sentence", + cheatsheet: "Sentence", + }, + ], + examples: [], + }, + paragraph: { + name: "Paragraph", + defaultSpokenForm: "block", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Paragraph", + cheatsheet: "Paragraph", + }, + ], + examples: [], + }, + boundedParagraph: { + name: "Bounded paragraph", + defaultSpokenForm: "short block", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Paragraph bounded by surrounding pair delimiters", + cheatsheet: "Paragraph bounded by surrounding pair delimiters", + }, + ], + examples: [], + }, + document: { + name: "Document", + defaultSpokenForm: "file", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Document", + cheatsheet: "Document", + }, + ], + examples: [], + }, + nonWhitespaceSequence: { + name: "Non-whitespace sequence", + defaultSpokenForm: "paint", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Non-whitespace sequence", + cheatsheet: "Non-whitespace sequence", + }, + ], + examples: [], + }, + boundedNonWhitespaceSequence: { + name: "Bounded non-whitespace sequence", + nameShort: "Bounded non-ws sequence", + defaultSpokenForm: "short paint", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: + "Non-whitespace sequence bounded by surrounding pair delimiters", + cheatsheet: + "Non-whitespace sequence bounded by surrounding pair delimiters", + }, + ], + examples: [], + }, + url: { + name: "URL", + defaultSpokenForm: "link", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "URL", + cheatsheet: "URL", + }, + ], + examples: [], + }, + notebookCell: { + name: "Notebook cell", + defaultSpokenForm: "cell", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Notebook cell", + cheatsheet: "Notebook cell", + }, + ], + examples: [], + }, + command: { + name: "Command", + defaultSpokenForm: "command", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Command", + cheatsheet: "Command", + }, + ], + examples: [], + }, + glyph: { + name: "Glyph", + defaultSpokenForm: "glyph", + syntaxes: [ + { + pattern: " ", + description: "Instance of single character ", + cheatsheet: "Instance of single character ", + }, + ], + examples: [], + }, + surroundingPair: { + name: "Surrounding pair", + syntaxes: [ + { + pattern: "", + description: "Surrounding pair", + cheatsheet: "Surrounding pair", + }, + ], + examples: [], + }, + + // Private scopes -------------------- + + "private.fieldAccess": { + name: "Field access", + defaultSpokenForm: "access", + private: true, + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Field access", + cheatsheet: "Field access", + }, + ], + examples: [], + }, + string: { + name: "String", + defaultSpokenForm: "parse tree string", + private: true, + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "String", + cheatsheet: "String", + }, + ], + examples: [], + }, + textFragment: { + name: "Text fragment", + defaultSpokenForm: "text fragment", + private: true, + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Text fragment", + cheatsheet: "Text fragment", + }, + ], + examples: [], + }, + disqualifyDelimiter: { + name: "Disqualify delimiter", + defaultSpokenForm: "disqualify delimiter", + private: true, + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Disqualify delimiter", + cheatsheet: "Disqualify delimiter", + }, + ], + examples: [], + }, + pairDelimiter: { + name: "Pair delimiter", + defaultSpokenForm: "pair delimiter", + private: true, + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Pair delimiter", + cheatsheet: "Pair delimiter", + }, + ], + examples: [], + }, + interior: { + name: "Interior", + defaultSpokenForm: "interior", + private: true, + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Interior", + cheatsheet: "Interior", + }, + ], + examples: [], + }, + surroundingPairInterior: { + name: "Surrounding pair interior", + private: true, + syntaxes: [], + examples: [], + }, + customRegex: { + name: "Custom regex", + private: true, + syntaxes: [], + examples: [], + }, +}; diff --git a/packages/lib-engine/src/spokenForms/defaultSpokenFormMapCore.ts b/packages/lib-engine/src/spokenForms/defaultSpokenFormMapCore.ts index 7290edc399..a0a213b28c 100644 --- a/packages/lib-engine/src/spokenForms/defaultSpokenFormMapCore.ts +++ b/packages/lib-engine/src/spokenForms/defaultSpokenFormMapCore.ts @@ -1,19 +1,60 @@ -import type { DefaultSpokenFormMapDefinition } from "./defaultSpokenFormMap.types"; +import { + actionNames, + actionReferences, + modifierExtraReferenceIds, + modifierExtraReferences, + modifierReferences, + simpleModifierReferenceIds, + simpleScopeTypeTypes, + scopeReferences, +} from "@cursorless/lib-common"; +import type { SpokenFormReference } from "@cursorless/lib-common"; +import type { + DefaultSpokenFormMapDefinition, + DefaultSpokenFormMapEntry, +} from "./defaultSpokenFormMap.types"; import { graphemeDefaultSpokenForms } from "./graphemes"; -import { isDisabledByDefault, isPrivate } from "./spokenFormMapUtil"; +import { isPrivate } from "./spokenFormMapUtil"; + +type DefaultSpokenForm = string | DefaultSpokenFormMapEntry; + +function getDefaultSpokenForm( + reference: SpokenFormReference, +): DefaultSpokenForm { + const { defaultSpokenForm } = reference; + + if (defaultSpokenForm == null) { + throw new Error("Reference has no default spoken form"); + } + + const isDisabledByDefault = reference.disabledByDefault ?? false; + const isPrivate = reference.private ?? false; + + if (!isDisabledByDefault && !isPrivate) { + return defaultSpokenForm; + } + + return { + defaultSpokenForms: [defaultSpokenForm], + isDisabledByDefault, + isPrivate, + }; +} + +function getDefaultSpokenFormMap( + keys: readonly Key[], + references: Readonly>, +): Readonly> { + return Object.fromEntries( + keys.map((key) => [key, getDefaultSpokenForm(references[key])]), + ) as Record; +} /** - * This map contains the default spoken forms for all our speakable entities, - * including scope types, paired delimiters, etc. We would like this map to - * become the sole source of truth for our default spoken forms, including the - * Talon side. Today it is only used on the extension side for testing, and as a - * fallback when we can't get the custom spoken forms from Talon. - * - * In this map, for regular entities, ie ones that are speakable by default, not - * private, and have only one spoken form, we allow a shorthand of just providing - * the spoken form as a string. For more complex cases, we can use the - * {@link isPrivate} or {@link isDisabledByDefault} helper functions to construct - * {@link DefaultSpokenFormMapEntry} objects, or just construct them manually. + * This map contains the default spoken forms for all our speakable entities. + * Actions, scopes, and modifiers are constructed from their reference + * definitions. Paired delimiters and graphemes remain defined here until they + * have corresponding reference definitions. */ export const defaultSpokenFormMapCore: DefaultSpokenFormMapDefinition = { pairedDelimiter: { @@ -38,191 +79,25 @@ export const defaultSpokenFormMapCore: DefaultSpokenFormMapDefinition = { collectionBoundary: isPrivate("collection boundary"), }, - simpleScopeTypeType: { - argumentOrParameter: "arg", - argumentList: "arg list", - attribute: "attribute", - functionCall: "call", - functionCallee: "callee", - className: "class name", - class: "class", - comment: "comment", - functionName: "funk name", - namedFunction: "funk", - ifStatement: "if state", - instance: "instance", - collectionItem: "item", - collectionKey: "key", - anonymousFunction: "lambda", - list: "list", - map: "map", - name: "name", - regularExpression: "regex", - section: "section", - sectionLevelOne: isDisabledByDefault("one section"), - sectionLevelTwo: isDisabledByDefault("two section"), - sectionLevelThree: isDisabledByDefault("three section"), - sectionLevelFour: isDisabledByDefault("four section"), - sectionLevelFive: isDisabledByDefault("five section"), - sectionLevelSix: isDisabledByDefault("six section"), - selector: "selector", - statement: "state", - branch: "branch", - type: "type", - value: "value", - condition: "condition", - unit: "unit", - // XML, JSX - xmlElement: "element", - xmlBothTags: "tags", - xmlStartTag: "start tag", - xmlEndTag: "end tag", - // LaTeX - part: "part", - chapter: "chapter", - subSection: "subsection", - subSubSection: "subsubsection", - namedParagraph: "paragraph", - subParagraph: "subparagraph", - environment: "environment", - // Talon - command: "command", - // Text-based scope types - character: "char", - word: "sub", - token: "token", - identifier: "identifier", - line: "line", - fullLine: "full line", - sentence: "sentence", - paragraph: "block", - boundedParagraph: "short block", - document: "file", - nonWhitespaceSequence: "paint", - boundedNonWhitespaceSequence: "short paint", - url: "link", - notebookCell: "cell", - - string: isPrivate("parse tree string"), - textFragment: isPrivate("text fragment"), - disqualifyDelimiter: isPrivate("disqualify delimiter"), - pairDelimiter: isPrivate("pair delimiter"), - interior: isPrivate("interior"), - "private.fieldAccess": isPrivate("access"), - }, + simpleScopeTypeType: getDefaultSpokenFormMap( + simpleScopeTypeTypes, + scopeReferences, + ), complexScopeTypeType: { - glyph: "glyph", - }, - - simpleModifier: { - excludeInterior: "bounds", - toRawSelection: "just", - leading: "leading", - trailing: "trailing", - keepContentFilter: "content", - keepEmptyFilter: "empty", - inferPreviousMark: "its", - startOf: "start of", - endOf: "end of", - interiorOnly: "inside", - visible: "visible", - extendThroughStartOf: "head", - extendThroughEndOf: "tail", - everyScope: "every", + glyph: getDefaultSpokenForm(scopeReferences.glyph), }, - modifierExtra: { - first: "first", - last: "last", - previous: "previous", - next: "next", - forward: "forward", - backward: "backward", - ancestor: "grand", - }, + simpleModifier: getDefaultSpokenFormMap( + simpleModifierReferenceIds, + modifierReferences, + ), + modifierExtra: getDefaultSpokenFormMap( + modifierExtraReferenceIds, + modifierExtraReferences, + ), customRegex: {}, - action: { - addSelection: "append", - addSelectionAfter: "append post", - addSelectionBefore: "append pre", - breakLine: "break", - scrollToBottom: "bottom", - toggleLineBreakpoint: "break point", - cutToClipboard: "carve", - scrollToCenter: "center", - clearAndSetSelection: "change", - remove: "chuck", - insertCopyBefore: "clone up", - insertCopyAfter: "clone", - toggleLineComment: "comment", - copyToClipboard: "copy", - scrollToTop: "crown", - outdentLine: "dedent", - revealDefinition: "define", - editNewLineBefore: "drink", - insertEmptyLineBefore: "drop", - extractVariable: "extract", - insertEmptyLineAfter: "float", - foldRegion: "fold", - followLink: "follow", - followLinkAside: "follow split", - flashTargets: "flash", - deselect: "give", - highlight: "highlight", - showHover: "hover", - increment: "increment", - decrement: "decrement", - indentLine: "indent", - showDebugHover: "inspect", - setSelectionAfter: "post", - editNewLineAfter: "pour", - setSelectionBefore: "pre", - insertEmptyLinesAround: "puff", - showQuickFix: "quick fix", - showReferences: "reference", - rename: "rename", - reverseTargets: "reverse", - findInDocument: "scout", - findInWorkspace: "scout all", - randomizeTargets: "shuffle", - generateSnippet: "snip make", - sortTargets: "sort", - setSelection: "take", - revealTypeDefinition: "type deaf", - unfoldRegion: "unfold", - callAsFunction: "call", - swapTargets: "swap", - replaceWithTarget: "bring", - moveToTarget: "move", - wrapWithPairedDelimiter: "wrap", - wrapWithSnippet: "wrap", - rewrapWithPairedDelimiter: "repack", - insertSnippet: "snippet", - pasteFromClipboard: "paste", - joinLines: "join", - gitAccept: "git accept", - gitRevert: "git revert", - gitStage: "git stage", - gitUnstage: "git unstage", - - // Was disabled by default before, but is now enabled by default - "experimental.setInstanceReference": "from", - - "private.showParseTree": isPrivate("parse tree"), - editNew: isPrivate("edit new"), - executeCommand: isPrivate("execute command"), - parsed: isPrivate("parsed"), - getText: isPrivate("get text"), - replace: isPrivate("replace"), - "private.getTargets": isPrivate("get targets"), - "private.setKeyboardTarget": isPrivate("set keyboard target"), - - // These actions are implemented talon-side, usually using `getText` followed - // by some other action. - // applyFormatter: "format", - // nextHomophone: "phones", - }, + action: getDefaultSpokenFormMap(actionNames, actionReferences), customAction: {}, grapheme: graphemeDefaultSpokenForms, }; diff --git a/packages/tool-meta-updater/src/metaUpdater.ts b/packages/tool-meta-updater/src/metaUpdater.ts index b4d795de39..231ca7529f 100644 --- a/packages/tool-meta-updater/src/metaUpdater.ts +++ b/packages/tool-meta-updater/src/metaUpdater.ts @@ -2,14 +2,21 @@ // https://github.com/pnpm/pnpm/tree/d583fbb2ad7e6b986d133a4eaf60824713f13c06/.meta-updater/src/index.ts // License was // https://github.com/pnpm/pnpm/blob/d583fbb2ad7e6b986d133a4eaf60824713f13c06/LICENSE + import { readWantedLockfile } from "@pnpm/lockfile-file"; import { createUpdateOptions } from "@pnpm/meta-updater"; -import { languageScopeSupport } from "@cursorless/lib-common"; +import { + actionReferences, + languageScopeSupport, + modifierReferences, + scopeReferences, +} from "@cursorless/lib-common"; import type { Context } from "./Context"; import { textFormat } from "./textFormat"; import { updateLanguageMdx } from "./updateLanguageMdx"; import { updatePackageJson } from "./updatePackageJson"; -import { getScopeTypeTypes, updateScopeMdx } from "./updateScopeMdx"; +import { updatePrivateScopeMdx } from "./updatePrivateScopeMdx"; +import { updateReferenceMdx } from "./updateReferenceMdx"; import { updatesScopeSupportFacetInfos } from "./updatesScopeSupportFacetInfos"; import { updateTSConfig } from "./updateTSConfig"; import { updateTSConfigBase } from "./updateTSConfigBase"; @@ -28,6 +35,10 @@ export const updater = async (workspaceDir: string) => { workspaceDir, }; + const userDir = "src/docs/user"; + const contributingDir = "src/docs/contributing"; + const referenceDir = `${userDir}/reference`; + return createUpdateOptions({ files: { "package.json": updatePackageJson.bind(null, context), @@ -37,14 +48,32 @@ export const updater = async (workspaceDir: string) => { updatesScopeSupportFacetInfos, ...Object.fromEntries( Object.keys(languageScopeSupport).map((languageId) => [ - `src/docs/user/languages/${languageId}.mdx`, + `${userDir}/languages/${languageId}.mdx`, updateLanguageMdx.bind(null, languageId), ]), ), ...Object.fromEntries( - getScopeTypeTypes().map(({ scopeTypeType, name }) => [ - `src/docs/contributing/scopes/${scopeTypeType.replace("private.", "")}.mdx`, - updateScopeMdx.bind(null, scopeTypeType, name), + Object.entries(actionReferences).map(([id, entry]) => [ + `${referenceDir}/actions/${cleanId(id)}.mdx`, + updateReferenceMdx.bind(null, "action", id, entry), + ]), + ), + ...Object.fromEntries( + Object.entries(modifierReferences).map(([id, entry]) => [ + `${referenceDir}/modifiers/${cleanId(id)}.mdx`, + updateReferenceMdx.bind(null, "modifier", id, entry), + ]), + ), + ...Object.fromEntries( + Object.entries(scopeReferences).map(([id, entry]) => [ + `${referenceDir}/scopes/${cleanId(id)}.mdx`, + updateReferenceMdx.bind(null, "scope", id, entry), + ]), + ), + ...Object.fromEntries( + Object.entries(scopeReferences).map(([id, entry]) => [ + `${contributingDir}/privateScopes/${cleanId(id)}.mdx`, + updatePrivateScopeMdx.bind(null, id, entry), ]), ), }, @@ -54,3 +83,7 @@ export const updater = async (workspaceDir: string) => { }, }); }; + +function cleanId(id: string): string { + return id.replace("private.", "").replace("experimental.", ""); +} diff --git a/packages/tool-meta-updater/src/updatePrivateScopeMdx.ts b/packages/tool-meta-updater/src/updatePrivateScopeMdx.ts new file mode 100644 index 0000000000..cda49c0a46 --- /dev/null +++ b/packages/tool-meta-updater/src/updatePrivateScopeMdx.ts @@ -0,0 +1,23 @@ +import type { FormatPluginFnOptions } from "@pnpm/meta-updater"; +import type { ReferenceEntry } from "@cursorless/lib-common"; + +export function updatePrivateScopeMdx( + id: string, + entry: ReferenceEntry, + actual: string | null, + options: FormatPluginFnOptions, +): string | null { + if (options.manifest.name !== "@cursorless/app-web-docs" || !entry.private) { + return null; + } + + const expected = ` +import { Scopes } from "@site/src/docs/components/Scopes"; + +# ${entry.name} + + +`.trimStart(); + + return expected; +} diff --git a/packages/tool-meta-updater/src/updateReferenceMdx.ts b/packages/tool-meta-updater/src/updateReferenceMdx.ts new file mode 100644 index 0000000000..91d7fc9493 --- /dev/null +++ b/packages/tool-meta-updater/src/updateReferenceMdx.ts @@ -0,0 +1,46 @@ +import type { FormatPluginFnOptions } from "@pnpm/meta-updater"; +import type { ReferenceEntry } from "@cursorless/lib-common"; + +export function updateReferenceMdx( + kind: "action" | "modifier" | "scope", + id: string, + entry: ReferenceEntry, + actual: string | null, + options: FormatPluginFnOptions, +): string | null { + if (options.manifest.name !== "@cursorless/app-web-docs" || entry.private) { + return null; + } + + const refComponentName = `${kind.charAt(0).toUpperCase() + kind.slice(1)}Reference`; + const isScope = kind === "scope"; + + const expected: string[] = []; + + if (entry.nameShort != null) { + 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( + "", + `# ${entry.name}`, + "", + `<${refComponentName} id="${id}" />`, + ); + + if (isScope) { + expected.push(``); + } + + expected.push(""); + + return expected.join("\n"); +} diff --git a/packages/tool-meta-updater/src/updateScopeMdx.ts b/packages/tool-meta-updater/src/updateScopeMdx.ts deleted file mode 100644 index b41a3ad7b0..0000000000 --- a/packages/tool-meta-updater/src/updateScopeMdx.ts +++ /dev/null @@ -1,57 +0,0 @@ -import type { FormatPluginFnOptions } from "@pnpm/meta-updater"; -import type { ScopeTypeType } from "@cursorless/lib-common"; -import { - plaintextScopeSupportFacetInfos, - prettifyScopeType, - scopeSupportFacetInfos, - serializeScopeType, -} from "@cursorless/lib-common"; - -export function updateScopeMdx( - scopeTypeType: ScopeTypeType, - name: string, - actual: string | null, - options: FormatPluginFnOptions, -): string | null { - if (options.manifest.name !== "@cursorless/app-web-docs") { - return null; - } - - if (actual != null) { - return actual; - } - - const expected = ` -import { Scopes } from "./components/Scopes"; - -# ${name} - - -`.trimStart(); - - return expected; -} - -export function getScopeTypeTypes() { - const scopeTypes = Object.values(scopeSupportFacetInfos) - .map((info) => info.scopeType) - .concat( - Object.values(plaintextScopeSupportFacetInfos).map( - (info) => info.scopeType, - ), - ); - - const result: { scopeTypeType: ScopeTypeType; name: string }[] = []; - const used = new Set(); - - for (const scopeType of scopeTypes) { - const scopeTypeType = serializeScopeType(scopeType); - if (used.has(scopeTypeType)) { - continue; - } - used.add(scopeTypeType); - result.push({ scopeTypeType, name: prettifyScopeType(scopeType) }); - } - - return result; -}