From 92dc5d2f6f22d7d6a9666883e57cd7aafbcc9004 Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Wed, 26 Aug 2026 12:40:30 +0200 Subject: [PATCH 01/16] Added action references --- .../src/references/actionReferences.ts | 831 ++++++++++++++++++ .../lib-common/src/types/ReferenceEntry.ts | 23 + 2 files changed, 854 insertions(+) create mode 100644 packages/lib-common/src/references/actionReferences.ts create mode 100644 packages/lib-common/src/types/ReferenceEntry.ts diff --git a/packages/lib-common/src/references/actionReferences.ts b/packages/lib-common/src/references/actionReferences.ts new file mode 100644 index 0000000000..a4e0eba38d --- /dev/null +++ b/packages/lib-common/src/references/actionReferences.ts @@ -0,0 +1,831 @@ +import type { ActionType } from "../types/command/ActionDescriptor"; +import type { ReferenceEntryWithoutIdKind } from "../types/ReferenceEntry"; + +const DEFAULT_PATTERN = " "; +const DEFAULT_PATTERN_SCOPE = " "; + +type TalonSideActionType = "applyFormatter" | "nextHomophone"; + +const actionReferencesMap: Record< + ActionType | TalonSideActionType, + ReferenceEntryWithoutIdKind +> = { + addSelection: { + name: "Add selection", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Adds to the current selection set", + descriptionShort: "Add selection", + }, + ], + examples: [], + }, + addSelectionAfter: { + name: "Add selection after", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: + "Adds empty selection after to the current selection set", + descriptionShort: "Add selection after", + }, + ], + examples: [], + }, + addSelectionBefore: { + name: "Add selection before", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: + "Adds empty selection before to the current selection set", + descriptionShort: "Add selection before", + }, + ], + examples: [], + }, + breakLine: { + name: "Break line", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Breaks the line before ", + descriptionShort: "Breaks the line", + }, + ], + examples: [], + }, + clearAndSetSelection: { + name: "Change", + legacySpokenForms: ["clear"], + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: + "Change by clearing it and setting a new selection", + descriptionShort: "Change", + }, + ], + examples: [], + }, + copyToClipboard: { + name: "Copy to clipboard", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Copy to clipboard", + descriptionShort: "Copy to clipboard", + }, + ], + examples: [], + }, + cutToClipboard: { + name: "Cut to clipboard", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Cut to clipboard", + descriptionShort: "Cut to clipboard", + }, + ], + examples: [], + }, + decrement: { + name: "Decrement", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Decrement number at ", + descriptionShort: "Decrement number", + }, + ], + examples: [], + }, + deselect: { + name: "Deselect", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Deselect ", + descriptionShort: "Deselect", + }, + ], + examples: [], + }, + editNewLineAfter: { + name: "Edit new line/scope after", + description: "Scope defaults to line", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Edit new line after ", + descriptionShort: "Edit new line after", + }, + { + pattern: DEFAULT_PATTERN_SCOPE, + description: "Edit new after ", + descriptionShort: "Edit new after", + }, + ], + examples: [], + }, + editNewLineBefore: { + name: "Edit new line/scope before", + description: "Scope defaults to line", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Edit new line before ", + descriptionShort: "Edit new line before", + }, + { + pattern: DEFAULT_PATTERN_SCOPE, + description: "Edit new before ", + descriptionShort: "Edit new before", + }, + ], + examples: [], + }, + "experimental.setInstanceReference": { + name: "Set instance reference", + description: + "Sets the instance reference for the next 'instance of' action", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Set instance reference to ", + descriptionShort: "Set instance reference", + }, + ], + examples: [], + }, + extractVariable: { + name: "Extract variable", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Extract variable from ", + descriptionShort: "Extract variable", + }, + ], + examples: [], + }, + findInDocument: { + name: "Find in document", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Find in document", + descriptionShort: "Find in document", + }, + ], + examples: [], + }, + findInWorkspace: { + name: "Find in workspace", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Find in workspace", + descriptionShort: "Find in workspace", + }, + ], + examples: [], + }, + flashTargets: { + name: "Flash target", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Flash ", + descriptionShort: "Flash target", + }, + ], + examples: [], + }, + foldRegion: { + name: "Fold region", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Fold region at ", + descriptionShort: "Fold region", + }, + ], + examples: [], + }, + followLink: { + name: "Follow link", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Follow link at ", + descriptionShort: "Follow link", + }, + ], + examples: [], + }, + followLinkAside: { + name: "Follow link aside", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Follow link at aside (e.g. in a split view)", + descriptionShort: "Follow link aside", + }, + ], + examples: [], + }, + gitAccept: { + name: "Git accept", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Accept Git change at ", + descriptionShort: "Git accept", + }, + ], + examples: [], + }, + gitRevert: { + name: "Git revert", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Revert Git change at ", + descriptionShort: "Git revert", + }, + ], + examples: [], + }, + gitStage: { + name: "Git stage", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Stage Git change at ", + descriptionShort: "Git stage", + }, + ], + examples: [], + }, + gitUnstage: { + name: "Git unstage", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Unstage Git change at ", + descriptionShort: "Git unstage", + }, + ], + examples: [], + }, + increment: { + name: "Increment", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Increment number at ", + descriptionShort: "Increment number", + }, + ], + examples: [], + }, + indentLine: { + name: "Indent line", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Indent line containing ", + descriptionShort: "Indent line", + }, + ], + examples: [], + }, + insertCopyAfter: { + name: "Insert copy after", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Insert copy after ", + descriptionShort: "Insert copy after", + }, + ], + examples: [], + }, + insertCopyBefore: { + name: "Insert copy before", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Insert copy before ", + descriptionShort: "Insert copy before", + }, + ], + examples: [], + }, + insertEmptyLineAfter: { + name: "Insert empty line after", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Insert empty line after ", + descriptionShort: "Insert empty line after", + }, + ], + examples: [], + }, + insertEmptyLineBefore: { + name: "Insert empty line before", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Insert empty line before ", + descriptionShort: "Insert empty line before", + }, + ], + examples: [], + }, + insertEmptyLinesAround: { + name: "Insert empty lines around", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Insert empty lines around ", + descriptionShort: "Insert empty lines around", + }, + ], + examples: [], + }, + joinLines: { + name: "Join lines", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Join lines at ", + descriptionShort: "Join lines", + }, + ], + examples: [], + }, + outdentLine: { + name: "Outdent line", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Outdent line containing ", + descriptionShort: "Outdent line", + }, + ], + examples: [], + }, + randomizeTargets: { + name: "Randomize targets", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Randomize s", + descriptionShort: "Randomize targets", + }, + ], + examples: [], + }, + remove: { + name: "Remove", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Remove ", + descriptionShort: "Remove", + }, + ], + examples: [], + }, + rename: { + name: "Rename", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Rename ", + descriptionShort: "Rename", + }, + ], + examples: [], + }, + revealDefinition: { + name: "Reveal definition", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Reveal definition of ", + descriptionShort: "Reveal definition", + }, + ], + examples: [], + }, + revealTypeDefinition: { + name: "Reveal type definition", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Reveal type definition of ", + descriptionShort: "Reveal type definition", + }, + ], + examples: [], + }, + reverseTargets: { + name: "Reverse targets", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Reverse s", + descriptionShort: "Reverse targets", + }, + ], + examples: [], + }, + scrollToBottom: { + name: "Scroll to bottom", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Scroll to bottom of the viewport", + descriptionShort: "Scroll to bottom", + }, + ], + examples: [], + }, + scrollToCenter: { + name: "Scroll to center", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Scroll to center of the viewport", + descriptionShort: "Scroll to center", + }, + ], + examples: [], + }, + scrollToTop: { + name: "Scroll to top", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Scroll to top of the viewport", + descriptionShort: "Scroll to top", + }, + ], + examples: [], + }, + setSelection: { + name: "Set selection", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Set selection to ", + descriptionShort: "Set selection", + }, + ], + examples: [], + }, + setSelectionAfter: { + name: "Set selection after", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Set empty selection after ", + descriptionShort: "Set selection after", + }, + ], + examples: [], + }, + setSelectionBefore: { + name: "Set selection before", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Set empty selection before ", + descriptionShort: "Set selection before", + }, + ], + examples: [], + }, + showDebugHover: { + name: "Show debug hover", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Show debug hover for ", + descriptionShort: "Show debug hover", + }, + ], + examples: [], + }, + showHover: { + name: "Show hover", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Show hover for ", + descriptionShort: "Show hover", + }, + ], + examples: [], + }, + showQuickFix: { + name: "Show quick fix", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Show quick fix for ", + descriptionShort: "Show quick fix", + }, + ], + examples: [], + }, + showReferences: { + name: "Show references", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Show references for ", + descriptionShort: "Show references", + }, + ], + examples: [], + }, + sortTargets: { + name: "Sort targets", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Sort s", + descriptionShort: "Sort targets", + }, + ], + examples: [], + }, + toggleLineBreakpoint: { + name: "Toggle line/scope breakpoint", + description: "Scope defaults to line", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Toggle breakpoint on line containing ", + descriptionShort: "Toggle line breakpoint", + }, + { + pattern: " token ", + description: "Toggle inline breakpoint at ", + descriptionShort: "Toggle inline breakpoint", + }, + ], + examples: [], + }, + toggleLineComment: { + name: "Toggle line comment", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Toggle line comment at ", + descriptionShort: "Toggle line comment", + }, + ], + examples: [], + }, + unfoldRegion: { + name: "Unfold region", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Unfold region at ", + descriptionShort: "Unfold region", + }, + ], + examples: [], + }, + callAsFunction: { + name: "Call as function", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Insert call to on selection", + descriptionShort: "Insert call to on selection", + }, + { + pattern: " on ", + description: "Insert call to on ", + descriptionShort: "Insert call to on ", + }, + ], + examples: [], + }, + generateSnippet: { + name: "Generate snippet", + legacySpokenForms: ["snippet make"], + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Generate snippet from ", + descriptionShort: "Generate snippet", + }, + ], + examples: [], + }, + highlight: { + name: "Highlight", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Highlight ", + descriptionShort: "Highlight", + }, + ], + examples: [], + }, + insertSnippet: { + name: "Insert snippet", + syntaxes: [ + { + pattern: " ", + description: "Insert snippet at ", + descriptionShort: "Insert snippet at ", + }, + ], + examples: [], + }, + moveToTarget: { + name: "Move to target", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Move to selection", + descriptionShort: "Move to selection", + }, + { + pattern: " ", + description: "Move to ", + descriptionShort: "Move to ", + }, + ], + examples: [], + }, + pasteFromClipboard: { + name: "Paste from clipboard", + syntaxes: [ + { + pattern: " ", + description: "Paste from clipboard at ", + descriptionShort: "Paste from clipboard at ", + }, + ], + examples: [], + }, + replaceWithTarget: { + name: "Replace with target", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Insert copy of at selection", + descriptionShort: "Insert copy of at selection", + }, + { + pattern: " ", + description: "Copy to ", + descriptionShort: "Copy to ", + }, + ], + examples: [], + }, + rewrapWithPairedDelimiter: { + name: "Rewrap with paired delimiter", + syntaxes: [ + { + pattern: " ", + description: "Rewrap with ", + descriptionShort: "Rewrap with ", + }, + ], + examples: [], + }, + swapTargets: { + name: "Swap targets", + syntaxes: [ + { + pattern: " ", + description: "Swap selection with ", + descriptionShort: "Swap selection with ", + }, + { + pattern: " ", + description: "Swap with ", + descriptionShort: "Swap with ", + }, + ], + examples: [], + }, + wrapWithPairedDelimiter: { + name: "Wrap with paired delimiter", + syntaxes: [ + { + pattern: " ", + description: "Wrap with ", + descriptionShort: "Wrap with ", + }, + ], + examples: [], + }, + wrapWithSnippet: { + name: "Wrap with snippet", + syntaxes: [ + { + pattern: " ", + description: "Wrap with ", + descriptionShort: "Wrap with ", + }, + ], + examples: [], + }, + applyFormatter: { + name: "Apply formatter", + syntaxes: [ + { + pattern: " at ", + description: "Reformat as ", + descriptionShort: "Reformat as ", + }, + ], + examples: [], + }, + nextHomophone: { + name: "Next homophone", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Cycle to next homophone for ", + descriptionShort: "Cycle to next homophone", + }, + ], + examples: [], + }, + + // Private actions, but that has spoken forms + "private.showParseTree": { + name: "Show parse tree", + private: true, + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Show parse tree for ", + descriptionShort: "Show parse tree", + }, + ], + examples: [], + }, + + // Actions without spoken forms + parsed: { + name: "Parsed", + private: true, + syntaxes: [], + examples: [], + }, + "private.getTargets": { + name: "Get targets", + private: true, + syntaxes: [], + examples: [], + }, + "private.setKeyboardTarget": { + name: "Set keyboard target", + private: true, + syntaxes: [], + examples: [], + }, + executeCommand: { + name: "Execute command", + private: true, + syntaxes: [], + examples: [], + }, + editNew: { + name: "Edit new", + private: true, + syntaxes: [], + examples: [], + }, + getText: { + name: "Get text", + private: true, + syntaxes: [], + examples: [], + }, + replace: { + name: "Replace", + private: true, + syntaxes: [], + examples: [], + }, +}; diff --git a/packages/lib-common/src/types/ReferenceEntry.ts b/packages/lib-common/src/types/ReferenceEntry.ts new file mode 100644 index 0000000000..27e5646d8f --- /dev/null +++ b/packages/lib-common/src/types/ReferenceEntry.ts @@ -0,0 +1,23 @@ +export interface ReferenceEntry { + id: string; + kind: "action" | "modifier" | "scope" | "mark" | "destination"; + name: string; + private?: boolean; + description?: string; + legacySpokenForms?: string[]; + syntaxes: SyntaxDefinition[]; + examples: ExampleDefinition[]; +} + +export type ReferenceEntryWithoutIdKind = Omit; + +interface SyntaxDefinition { + pattern: string; + description: string; + descriptionShort: string; +} + +interface ExampleDefinition { + spokenForm: string; + description: string; +} From 94eda7a639b5e2f14da1491a18094894a120428d Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Wed, 26 Aug 2026 13:20:57 +0200 Subject: [PATCH 02/16] Added modifiers and scope references --- .../src/references/actionReferences.ts | 159 ++-- .../src/references/modifierReferences.ts | 380 +++++++++ .../src/references/scopeReferences.ts | 769 ++++++++++++++++++ .../lib-common/src/types/ReferenceEntry.ts | 4 +- 4 files changed, 1236 insertions(+), 76 deletions(-) create mode 100644 packages/lib-common/src/references/modifierReferences.ts create mode 100644 packages/lib-common/src/references/scopeReferences.ts diff --git a/packages/lib-common/src/references/actionReferences.ts b/packages/lib-common/src/references/actionReferences.ts index a4e0eba38d..076fc56cc2 100644 --- a/packages/lib-common/src/references/actionReferences.ts +++ b/packages/lib-common/src/references/actionReferences.ts @@ -1,5 +1,8 @@ import type { ActionType } from "../types/command/ActionDescriptor"; -import type { ReferenceEntryWithoutIdKind } from "../types/ReferenceEntry"; +import type { + ReferenceEntry, + ReferenceEntryWithoutIdKind, +} from "../types/ReferenceEntry"; const DEFAULT_PATTERN = " "; const DEFAULT_PATTERN_SCOPE = " "; @@ -16,7 +19,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Adds to the current selection set", - descriptionShort: "Add selection", + cheatsheet: "Add selection", }, ], examples: [], @@ -28,7 +31,7 @@ const actionReferencesMap: Record< pattern: DEFAULT_PATTERN, description: "Adds empty selection after to the current selection set", - descriptionShort: "Add selection after", + cheatsheet: "Add selection after", }, ], examples: [], @@ -40,7 +43,7 @@ const actionReferencesMap: Record< pattern: DEFAULT_PATTERN, description: "Adds empty selection before to the current selection set", - descriptionShort: "Add selection before", + cheatsheet: "Add selection before", }, ], examples: [], @@ -51,7 +54,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Breaks the line before ", - descriptionShort: "Breaks the line", + cheatsheet: "Breaks the line", }, ], examples: [], @@ -64,7 +67,7 @@ const actionReferencesMap: Record< pattern: DEFAULT_PATTERN, description: "Change by clearing it and setting a new selection", - descriptionShort: "Change", + cheatsheet: "Change", }, ], examples: [], @@ -75,7 +78,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Copy to clipboard", - descriptionShort: "Copy to clipboard", + cheatsheet: "Copy to clipboard", }, ], examples: [], @@ -86,7 +89,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Cut to clipboard", - descriptionShort: "Cut to clipboard", + cheatsheet: "Cut to clipboard", }, ], examples: [], @@ -97,7 +100,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Decrement number at ", - descriptionShort: "Decrement number", + cheatsheet: "Decrement number", }, ], examples: [], @@ -108,7 +111,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Deselect ", - descriptionShort: "Deselect", + cheatsheet: "Deselect", }, ], examples: [], @@ -120,12 +123,12 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Edit new line after ", - descriptionShort: "Edit new line after", + cheatsheet: "Edit new line after", }, { pattern: DEFAULT_PATTERN_SCOPE, description: "Edit new after ", - descriptionShort: "Edit new after", + cheatsheet: "Edit new after", }, ], examples: [], @@ -137,12 +140,12 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Edit new line before ", - descriptionShort: "Edit new line before", + cheatsheet: "Edit new line before", }, { pattern: DEFAULT_PATTERN_SCOPE, description: "Edit new before ", - descriptionShort: "Edit new before", + cheatsheet: "Edit new before", }, ], examples: [], @@ -155,7 +158,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Set instance reference to ", - descriptionShort: "Set instance reference", + cheatsheet: "Set instance reference", }, ], examples: [], @@ -166,7 +169,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Extract variable from ", - descriptionShort: "Extract variable", + cheatsheet: "Extract variable", }, ], examples: [], @@ -177,7 +180,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Find in document", - descriptionShort: "Find in document", + cheatsheet: "Find in document", }, ], examples: [], @@ -188,7 +191,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Find in workspace", - descriptionShort: "Find in workspace", + cheatsheet: "Find in workspace", }, ], examples: [], @@ -199,7 +202,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Flash ", - descriptionShort: "Flash target", + cheatsheet: "Flash target", }, ], examples: [], @@ -210,7 +213,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Fold region at ", - descriptionShort: "Fold region", + cheatsheet: "Fold region", }, ], examples: [], @@ -221,7 +224,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Follow link at ", - descriptionShort: "Follow link", + cheatsheet: "Follow link", }, ], examples: [], @@ -232,7 +235,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Follow link at aside (e.g. in a split view)", - descriptionShort: "Follow link aside", + cheatsheet: "Follow link aside", }, ], examples: [], @@ -243,7 +246,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Accept Git change at ", - descriptionShort: "Git accept", + cheatsheet: "Git accept", }, ], examples: [], @@ -254,7 +257,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Revert Git change at ", - descriptionShort: "Git revert", + cheatsheet: "Git revert", }, ], examples: [], @@ -265,7 +268,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Stage Git change at ", - descriptionShort: "Git stage", + cheatsheet: "Git stage", }, ], examples: [], @@ -276,7 +279,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Unstage Git change at ", - descriptionShort: "Git unstage", + cheatsheet: "Git unstage", }, ], examples: [], @@ -287,7 +290,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Increment number at ", - descriptionShort: "Increment number", + cheatsheet: "Increment number", }, ], examples: [], @@ -298,7 +301,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Indent line containing ", - descriptionShort: "Indent line", + cheatsheet: "Indent line", }, ], examples: [], @@ -309,7 +312,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Insert copy after ", - descriptionShort: "Insert copy after", + cheatsheet: "Insert copy after", }, ], examples: [], @@ -320,7 +323,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Insert copy before ", - descriptionShort: "Insert copy before", + cheatsheet: "Insert copy before", }, ], examples: [], @@ -331,7 +334,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Insert empty line after ", - descriptionShort: "Insert empty line after", + cheatsheet: "Insert empty line after", }, ], examples: [], @@ -342,7 +345,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Insert empty line before ", - descriptionShort: "Insert empty line before", + cheatsheet: "Insert empty line before", }, ], examples: [], @@ -353,7 +356,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Insert empty lines around ", - descriptionShort: "Insert empty lines around", + cheatsheet: "Insert empty lines around", }, ], examples: [], @@ -364,7 +367,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Join lines at ", - descriptionShort: "Join lines", + cheatsheet: "Join lines", }, ], examples: [], @@ -375,7 +378,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Outdent line containing ", - descriptionShort: "Outdent line", + cheatsheet: "Outdent line", }, ], examples: [], @@ -386,7 +389,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Randomize s", - descriptionShort: "Randomize targets", + cheatsheet: "Randomize targets", }, ], examples: [], @@ -397,7 +400,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Remove ", - descriptionShort: "Remove", + cheatsheet: "Remove", }, ], examples: [], @@ -408,7 +411,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Rename ", - descriptionShort: "Rename", + cheatsheet: "Rename", }, ], examples: [], @@ -419,7 +422,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Reveal definition of ", - descriptionShort: "Reveal definition", + cheatsheet: "Reveal definition", }, ], examples: [], @@ -430,7 +433,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Reveal type definition of ", - descriptionShort: "Reveal type definition", + cheatsheet: "Reveal type definition", }, ], examples: [], @@ -441,7 +444,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Reverse s", - descriptionShort: "Reverse targets", + cheatsheet: "Reverse targets", }, ], examples: [], @@ -452,7 +455,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Scroll to bottom of the viewport", - descriptionShort: "Scroll to bottom", + cheatsheet: "Scroll to bottom", }, ], examples: [], @@ -463,7 +466,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Scroll to center of the viewport", - descriptionShort: "Scroll to center", + cheatsheet: "Scroll to center", }, ], examples: [], @@ -474,7 +477,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Scroll to top of the viewport", - descriptionShort: "Scroll to top", + cheatsheet: "Scroll to top", }, ], examples: [], @@ -485,7 +488,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Set selection to ", - descriptionShort: "Set selection", + cheatsheet: "Set selection", }, ], examples: [], @@ -496,7 +499,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Set empty selection after ", - descriptionShort: "Set selection after", + cheatsheet: "Set selection after", }, ], examples: [], @@ -507,7 +510,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Set empty selection before ", - descriptionShort: "Set selection before", + cheatsheet: "Set selection before", }, ], examples: [], @@ -518,7 +521,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Show debug hover for ", - descriptionShort: "Show debug hover", + cheatsheet: "Show debug hover", }, ], examples: [], @@ -529,7 +532,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Show hover for ", - descriptionShort: "Show hover", + cheatsheet: "Show hover", }, ], examples: [], @@ -540,7 +543,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Show quick fix for ", - descriptionShort: "Show quick fix", + cheatsheet: "Show quick fix", }, ], examples: [], @@ -551,7 +554,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Show references for ", - descriptionShort: "Show references", + cheatsheet: "Show references", }, ], examples: [], @@ -562,7 +565,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Sort s", - descriptionShort: "Sort targets", + cheatsheet: "Sort targets", }, ], examples: [], @@ -574,12 +577,12 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Toggle breakpoint on line containing ", - descriptionShort: "Toggle line breakpoint", + cheatsheet: "Toggle line breakpoint", }, { pattern: " token ", description: "Toggle inline breakpoint at ", - descriptionShort: "Toggle inline breakpoint", + cheatsheet: "Toggle inline breakpoint", }, ], examples: [], @@ -590,7 +593,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Toggle line comment at ", - descriptionShort: "Toggle line comment", + cheatsheet: "Toggle line comment", }, ], examples: [], @@ -601,7 +604,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Unfold region at ", - descriptionShort: "Unfold region", + cheatsheet: "Unfold region", }, ], examples: [], @@ -612,12 +615,12 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Insert call to on selection", - descriptionShort: "Insert call to on selection", + cheatsheet: "Insert call to on selection", }, { pattern: " on ", description: "Insert call to on ", - descriptionShort: "Insert call to on ", + cheatsheet: "Insert call to on ", }, ], examples: [], @@ -629,7 +632,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Generate snippet from ", - descriptionShort: "Generate snippet", + cheatsheet: "Generate snippet", }, ], examples: [], @@ -640,7 +643,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Highlight ", - descriptionShort: "Highlight", + cheatsheet: "Highlight", }, ], examples: [], @@ -651,7 +654,7 @@ const actionReferencesMap: Record< { pattern: " ", description: "Insert snippet at ", - descriptionShort: "Insert snippet at ", + cheatsheet: "Insert snippet at ", }, ], examples: [], @@ -662,12 +665,12 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Move to selection", - descriptionShort: "Move to selection", + cheatsheet: "Move to selection", }, { pattern: " ", description: "Move to ", - descriptionShort: "Move to ", + cheatsheet: "Move to ", }, ], examples: [], @@ -678,7 +681,7 @@ const actionReferencesMap: Record< { pattern: " ", description: "Paste from clipboard at ", - descriptionShort: "Paste from clipboard at ", + cheatsheet: "Paste from clipboard at ", }, ], examples: [], @@ -689,12 +692,12 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Insert copy of at selection", - descriptionShort: "Insert copy of at selection", + cheatsheet: "Insert copy of at selection", }, { pattern: " ", description: "Copy to ", - descriptionShort: "Copy to ", + cheatsheet: "Copy to ", }, ], examples: [], @@ -705,7 +708,7 @@ const actionReferencesMap: Record< { pattern: " ", description: "Rewrap with ", - descriptionShort: "Rewrap with ", + cheatsheet: "Rewrap with ", }, ], examples: [], @@ -716,12 +719,12 @@ const actionReferencesMap: Record< { pattern: " ", description: "Swap selection with ", - descriptionShort: "Swap selection with ", + cheatsheet: "Swap selection with ", }, { pattern: " ", description: "Swap with ", - descriptionShort: "Swap with ", + cheatsheet: "Swap with ", }, ], examples: [], @@ -732,7 +735,7 @@ const actionReferencesMap: Record< { pattern: " ", description: "Wrap with ", - descriptionShort: "Wrap with ", + cheatsheet: "Wrap with ", }, ], examples: [], @@ -743,7 +746,7 @@ const actionReferencesMap: Record< { pattern: " ", description: "Wrap with ", - descriptionShort: "Wrap with ", + cheatsheet: "Wrap with ", }, ], examples: [], @@ -754,7 +757,7 @@ const actionReferencesMap: Record< { pattern: " at ", description: "Reformat as ", - descriptionShort: "Reformat as ", + cheatsheet: "Reformat as ", }, ], examples: [], @@ -765,7 +768,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Cycle to next homophone for ", - descriptionShort: "Cycle to next homophone", + cheatsheet: "Cycle to next homophone", }, ], examples: [], @@ -779,7 +782,7 @@ const actionReferencesMap: Record< { pattern: DEFAULT_PATTERN, description: "Show parse tree for ", - descriptionShort: "Show parse tree", + cheatsheet: "Show parse tree", }, ], examples: [], @@ -829,3 +832,11 @@ const actionReferencesMap: Record< examples: [], }, }; + +export const actionReferences: ReferenceEntry[] = Object.entries( + actionReferencesMap, +).map(([actionType, referenceEntry]) => ({ + id: actionType, + kind: "action", + ...referenceEntry, +})); diff --git a/packages/lib-common/src/references/modifierReferences.ts b/packages/lib-common/src/references/modifierReferences.ts new file mode 100644 index 0000000000..1b55486ad4 --- /dev/null +++ b/packages/lib-common/src/references/modifierReferences.ts @@ -0,0 +1,380 @@ +import type { ModifierType } from "../types/command/PartialTargetDescriptor.types"; +import type { + ReferenceEntry, + ReferenceEntryWithoutIdKind, +} from "../types/ReferenceEntry"; + +const DEFAULT_PATTERN = ""; + +type AdditionalModifierReferenceType = "ancestor"; + +const modifierReferencesMap: Record< + ModifierType | AdditionalModifierReferenceType, + ReferenceEntryWithoutIdKind +> = { + startOf: { + name: "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", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Empty position at end of target", + cheatsheet: "Empty position at end of target", + }, + ], + examples: [], + }, + interiorOnly: { + name: "Interior only", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Interior only", + cheatsheet: "Interior only", + }, + ], + examples: [], + }, + excludeInterior: { + name: "Exclude interior", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Bounding paired delimiters", + cheatsheet: "Bounding paired delimiters", + }, + ], + examples: [], + }, + visible: { + name: "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", + syntaxes: [ + { + pattern: " ", + description: "Every instance of ", + cheatsheet: "Every instance of ", + }, + ], + examples: [], + }, + ancestor: { + name: "Ancestor", + 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", + 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", + 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", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Leading delimiter range", + cheatsheet: "Leading delimiter range", + }, + ], + examples: [], + }, + trailing: { + name: "Trailing", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Trailing delimiter range", + cheatsheet: "Trailing delimiter range", + }, + ], + examples: [], + }, + toRawSelection: { + name: "Raw selection", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "No inference", + cheatsheet: "No inference", + }, + ], + examples: [], + }, + keepContentFilter: { + name: "Keep content filter", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Keep content filter", + cheatsheet: "Keep content filter", + }, + ], + examples: [], + }, + keepEmptyFilter: { + name: "Keep empty filter", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Keep empty filter", + cheatsheet: "Keep empty filter", + }, + ], + examples: [], + }, + inferPreviousMark: { + name: "Infer previous mark", + 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 modifierReferences: ReferenceEntry[] = Object.entries( + modifierReferencesMap, +).map(([modifierType, referenceEntry]) => ({ + id: modifierType, + kind: "modifier", + ...referenceEntry, +})); diff --git a/packages/lib-common/src/references/scopeReferences.ts b/packages/lib-common/src/references/scopeReferences.ts new file mode 100644 index 0000000000..cf58fdc50c --- /dev/null +++ b/packages/lib-common/src/references/scopeReferences.ts @@ -0,0 +1,769 @@ +import type { SimpleScopeTypeType } from "../types/command/PartialTargetDescriptor.types"; +import type { + ReferenceEntry, + ReferenceEntryWithoutIdKind, +} from "../types/ReferenceEntry"; + +const DEFAULT_PATTERN = ""; + +type AdditionalScopeReferenceType = "glyph" | "pair"; + +const scopeReferencesMap: Record< + SimpleScopeTypeType | AdditionalScopeReferenceType, + ReferenceEntryWithoutIdKind +> = { + argumentOrParameter: { + name: "Argument", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Argument", + cheatsheet: "Argument", + }, + ], + examples: [], + }, + argumentList: { + name: "Argument list", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Argument list", + cheatsheet: "Argument list", + }, + ], + examples: [], + }, + anonymousFunction: { + name: "Anonymous function", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Anonymous function", + cheatsheet: "Anonymous function", + }, + ], + examples: [], + }, + attribute: { + name: "Attribute", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Attribute", + cheatsheet: "Attribute", + }, + ], + examples: [], + }, + branch: { + name: "Branch", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Branch", + cheatsheet: "Branch", + }, + ], + examples: [], + }, + class: { + name: "Class", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Class", + cheatsheet: "Class", + }, + ], + examples: [], + }, + className: { + name: "Class name", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Class name", + cheatsheet: "Class name", + }, + ], + examples: [], + }, + collectionItem: { + name: "Collection item", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Collection item", + cheatsheet: "Collection item", + }, + ], + examples: [], + }, + collectionKey: { + name: "Collection key", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Collection key", + cheatsheet: "Collection key", + }, + ], + examples: [], + }, + comment: { + name: "Comment", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Comment", + cheatsheet: "Comment", + }, + ], + examples: [], + }, + "private.fieldAccess": { + name: "Field access", + private: true, + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Field access", + cheatsheet: "Field access", + }, + ], + examples: [], + }, + functionCall: { + name: "Function call", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Function call", + cheatsheet: "Function call", + }, + ], + examples: [], + }, + functionCallee: { + name: "Function callee", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Function callee", + cheatsheet: "Function callee", + }, + ], + examples: [], + }, + functionName: { + name: "Function name", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Function name", + cheatsheet: "Function name", + }, + ], + examples: [], + }, + ifStatement: { + name: "If statement", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "If statement", + cheatsheet: "If statement", + }, + ], + examples: [], + }, + instance: { + name: "Instance", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Instance", + cheatsheet: "Instance", + }, + ], + examples: [], + }, + list: { + name: "List", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "List", + cheatsheet: "List", + }, + ], + examples: [], + }, + map: { + name: "Map", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Map", + cheatsheet: "Map", + }, + ], + examples: [], + }, + name: { + name: "Name", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Name", + cheatsheet: "Name", + }, + ], + examples: [], + }, + namedFunction: { + name: "Named function", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Named function", + cheatsheet: "Named function", + }, + ], + examples: [], + }, + regularExpression: { + name: "Regular expression", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Regular expression", + cheatsheet: "Regular expression", + }, + ], + examples: [], + }, + statement: { + name: "Statement", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Statement", + cheatsheet: "Statement", + }, + ], + examples: [], + }, + string: { + name: "String", + private: true, + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "String", + cheatsheet: "String", + }, + ], + examples: [], + }, + type: { + name: "Type", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Type", + cheatsheet: "Type", + }, + ], + examples: [], + }, + value: { + name: "Value", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Value", + cheatsheet: "Value", + }, + ], + examples: [], + }, + condition: { + name: "Condition", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Condition", + cheatsheet: "Condition", + }, + ], + examples: [], + }, + section: { + name: "Section", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Section", + cheatsheet: "Section", + }, + ], + examples: [], + }, + sectionLevelOne: { + name: "Section level one", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Section level one", + cheatsheet: "Section level one", + }, + ], + examples: [], + }, + sectionLevelTwo: { + name: "Section level two", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Section level two", + cheatsheet: "Section level two", + }, + ], + examples: [], + }, + sectionLevelThree: { + name: "Section level three", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Section level three", + cheatsheet: "Section level three", + }, + ], + examples: [], + }, + sectionLevelFour: { + name: "Section level four", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Section level four", + cheatsheet: "Section level four", + }, + ], + examples: [], + }, + sectionLevelFive: { + name: "Section level five", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Section level five", + cheatsheet: "Section level five", + }, + ], + examples: [], + }, + sectionLevelSix: { + name: "Section level six", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Section level six", + cheatsheet: "Section level six", + }, + ], + examples: [], + }, + selector: { + name: "Selector", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Selector", + cheatsheet: "Selector", + }, + ], + examples: [], + }, + unit: { + name: "Unit", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Unit", + cheatsheet: "Unit", + }, + ], + examples: [], + }, + xmlBothTags: { + name: "XML both tags", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "XML both tags", + cheatsheet: "XML both tags", + }, + ], + examples: [], + }, + xmlElement: { + name: "XML element", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "XML element", + cheatsheet: "XML element", + }, + ], + examples: [], + }, + xmlEndTag: { + name: "XML end tag", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "XML end tag", + cheatsheet: "XML end tag", + }, + ], + examples: [], + }, + xmlStartTag: { + name: "XML start tag", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "XML start tag", + cheatsheet: "XML start tag", + }, + ], + examples: [], + }, + part: { + name: "Part", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Part", + cheatsheet: "Part", + }, + ], + examples: [], + }, + chapter: { + name: "Chapter", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Chapter", + cheatsheet: "Chapter", + }, + ], + examples: [], + }, + subSection: { + name: "Subsection", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Subsection", + cheatsheet: "Subsection", + }, + ], + examples: [], + }, + subSubSection: { + name: "Subsubsection", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Subsubsection", + cheatsheet: "Subsubsection", + }, + ], + examples: [], + }, + namedParagraph: { + name: "Named paragraph", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Named paragraph", + cheatsheet: "Named paragraph", + }, + ], + examples: [], + }, + subParagraph: { + name: "Subparagraph", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Subparagraph", + cheatsheet: "Subparagraph", + }, + ], + examples: [], + }, + environment: { + name: "Environment", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Environment", + cheatsheet: "Environment", + }, + ], + examples: [], + }, + character: { + name: "Character", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Character", + cheatsheet: "Character", + }, + ], + examples: [], + }, + word: { + name: "Sub token word", + legacySpokenForms: ["word"], + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Sub token word", + cheatsheet: "Sub token word", + }, + ], + examples: [], + }, + token: { + name: "Token", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Token", + cheatsheet: "Token", + }, + ], + examples: [], + }, + identifier: { + name: "Identifier", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Identifier", + cheatsheet: "Identifier", + }, + ], + examples: [], + }, + line: { + name: "Line", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Line", + cheatsheet: "Line", + }, + ], + examples: [], + }, + fullLine: { + name: "Full line", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Full line", + cheatsheet: "Full line", + }, + ], + examples: [], + }, + sentence: { + name: "Sentence", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Sentence", + cheatsheet: "Sentence", + }, + ], + examples: [], + }, + paragraph: { + name: "Paragraph", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Paragraph", + cheatsheet: "Paragraph", + }, + ], + examples: [], + }, + boundedParagraph: { + name: "Bounded paragraph", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Paragraph bounded by surrounding pair delimeters", + cheatsheet: "Paragraph bounded by surrounding pair delimeters", + }, + ], + examples: [], + }, + document: { + name: "Document", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Document", + cheatsheet: "Document", + }, + ], + examples: [], + }, + nonWhitespaceSequence: { + name: "Non-whitespace sequence", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Non-whitespace sequence", + cheatsheet: "Non-whitespace sequence", + }, + ], + examples: [], + }, + boundedNonWhitespaceSequence: { + name: "Bounded non-whitespace sequence", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: + "Non-whitespace sequence bounded by surrounding pair delimeters", + cheatsheet: + "Non-whitespace sequence bounded by surrounding pair delimeters", + }, + ], + examples: [], + }, + url: { + name: "URL", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "URL", + cheatsheet: "URL", + }, + ], + examples: [], + }, + notebookCell: { + name: "Notebook cell", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Notebook cell", + cheatsheet: "Notebook cell", + }, + ], + examples: [], + }, + command: { + name: "Command", + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Command", + cheatsheet: "Command", + }, + ], + examples: [], + }, + textFragment: { + name: "Text fragment", + private: true, + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Text fragment", + cheatsheet: "Text fragment", + }, + ], + examples: [], + }, + disqualifyDelimiter: { + name: "Disqualify delimiter", + private: true, + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Disqualify delimiter", + cheatsheet: "Disqualify delimiter", + }, + ], + examples: [], + }, + pairDelimiter: { + name: "Pair delimiter", + private: true, + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Pair delimiter", + cheatsheet: "Pair delimiter", + }, + ], + examples: [], + }, + interior: { + name: "Interior", + private: true, + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "Interior", + cheatsheet: "Interior", + }, + ], + examples: [], + }, + glyph: { + name: "Glyph", + syntaxes: [ + { + pattern: " ", + description: "Instance of single character ", + cheatsheet: "Instance of single character ", + }, + ], + examples: [], + }, + pair: { + name: "Paired delimiters", + syntaxes: [ + { + pattern: "", + description: "Paired delimiters", + cheatsheet: "Paired delimiters", + }, + ], + examples: [], + }, +}; + +export const scopeReferences: ReferenceEntry[] = Object.entries( + scopeReferencesMap, +).map(([scopeType, referenceEntry]) => ({ + id: scopeType, + kind: "scope", + ...referenceEntry, +})); diff --git a/packages/lib-common/src/types/ReferenceEntry.ts b/packages/lib-common/src/types/ReferenceEntry.ts index 27e5646d8f..69ff0d805c 100644 --- a/packages/lib-common/src/types/ReferenceEntry.ts +++ b/packages/lib-common/src/types/ReferenceEntry.ts @@ -1,6 +1,6 @@ export interface ReferenceEntry { id: string; - kind: "action" | "modifier" | "scope" | "mark" | "destination"; + kind: "action" | "modifier" | "scope" | "mark"; name: string; private?: boolean; description?: string; @@ -14,7 +14,7 @@ export type ReferenceEntryWithoutIdKind = Omit; interface SyntaxDefinition { pattern: string; description: string; - descriptionShort: string; + cheatsheet: string; } interface ExampleDefinition { From bc049528d6f260756ebe3fe333d2b829afd3c3c0 Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Wed, 26 Aug 2026 14:33:44 +0200 Subject: [PATCH 03/16] Added references entry component --- oxlint.config.mts | 7 ++ packages/app-web-docs/package.json | 1 + packages/app-web-docs/src/docs/user/README.md | 1 + .../src/docs/user/reference/_category_.json | 4 +- .../docs/user/reference/actions/remove.mdx | 5 ++ .../reference/components/ReferenceEntry.tsx | 68 +++++++++++++++++++ .../src/docs/user/reference/modifiers.md | 1 + .../src/docs/user/reference/scopes.md | 1 + .../src/docs/user/reference/targets.md | 1 + packages/lib-common/src/index.ts | 1 + .../{types => references}/ReferenceEntry.ts | 4 -- .../src/references/actionReferences.ts | 26 +++---- packages/lib-common/src/references/index.ts | 4 ++ .../src/references/modifierReferences.ts | 17 +---- .../src/references/scopeReferences.ts | 17 +---- 15 files changed, 110 insertions(+), 48 deletions(-) create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/remove.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/components/ReferenceEntry.tsx create mode 100644 packages/app-web-docs/src/docs/user/reference/modifiers.md create mode 100644 packages/app-web-docs/src/docs/user/reference/scopes.md create mode 100644 packages/app-web-docs/src/docs/user/reference/targets.md rename packages/lib-common/src/{types => references}/ReferenceEntry.ts (71%) create mode 100644 packages/lib-common/src/references/index.ts diff --git a/oxlint.config.mts b/oxlint.config.mts index 17515f40bb..a22898043b 100644 --- a/oxlint.config.mts +++ b/oxlint.config.mts @@ -216,6 +216,13 @@ export default defineConfig({ }, }, + { + files: ["**/*.mdx"], + rules: { + "react/no-array-index-key ": "off", + }, + }, + { files: ["packages/app-vscode/src/scripts/**/*.ts"], rules: { 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/docs/user/README.md b/packages/app-web-docs/src/docs/user/README.md index 096cd791ba..c390f8b325 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 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/remove.mdx b/packages/app-web-docs/src/docs/user/reference/actions/remove.mdx new file mode 100644 index 0000000000..59479cd35e --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/remove.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../components/ReferenceEntry"; + +# Remove + + diff --git a/packages/app-web-docs/src/docs/user/reference/components/ReferenceEntry.tsx b/packages/app-web-docs/src/docs/user/reference/components/ReferenceEntry.tsx new file mode 100644 index 0000000000..33121cda21 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/components/ReferenceEntry.tsx @@ -0,0 +1,68 @@ +import React 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}

} + +

+ Internal ID: {id} +

+ + {entry.legacySpokenForms != null && ( +

Legacy spoken forms: {entry.legacySpokenForms.join(", ")}

+ )} + + {entry.syntaxes.length > 0 && ( +
    + {entry.syntaxes.map((syntax, index) => ( +
  • + {syntax.pattern}: {syntax.description} +
  • + ))} +
+ )} + + {entry.examples.length > 0 && ( +

+ Examples: +

    + {entry.examples.map((example, index) => ( +
  • + {example.spokenForm}: {example.description} +
  • + ))} +
+

+ )} + + ); +} diff --git a/packages/app-web-docs/src/docs/user/reference/modifiers.md b/packages/app-web-docs/src/docs/user/reference/modifiers.md new file mode 100644 index 0000000000..4358dfdbf8 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers.md @@ -0,0 +1 @@ +# Modifiers diff --git a/packages/app-web-docs/src/docs/user/reference/scopes.md b/packages/app-web-docs/src/docs/user/reference/scopes.md new file mode 100644 index 0000000000..25cd4513bf --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes.md @@ -0,0 +1 @@ +# Scopes diff --git a/packages/app-web-docs/src/docs/user/reference/targets.md b/packages/app-web-docs/src/docs/user/reference/targets.md new file mode 100644 index 0000000000..01d0a4c8c0 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/targets.md @@ -0,0 +1 @@ +# Targets 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/types/ReferenceEntry.ts b/packages/lib-common/src/references/ReferenceEntry.ts similarity index 71% rename from packages/lib-common/src/types/ReferenceEntry.ts rename to packages/lib-common/src/references/ReferenceEntry.ts index 69ff0d805c..3819f1ab4f 100644 --- a/packages/lib-common/src/types/ReferenceEntry.ts +++ b/packages/lib-common/src/references/ReferenceEntry.ts @@ -1,6 +1,4 @@ export interface ReferenceEntry { - id: string; - kind: "action" | "modifier" | "scope" | "mark"; name: string; private?: boolean; description?: string; @@ -9,8 +7,6 @@ export interface ReferenceEntry { examples: ExampleDefinition[]; } -export type ReferenceEntryWithoutIdKind = Omit; - interface SyntaxDefinition { pattern: string; description: string; diff --git a/packages/lib-common/src/references/actionReferences.ts b/packages/lib-common/src/references/actionReferences.ts index 076fc56cc2..b2f2ceb6bc 100644 --- a/packages/lib-common/src/references/actionReferences.ts +++ b/packages/lib-common/src/references/actionReferences.ts @@ -1,17 +1,14 @@ import type { ActionType } from "../types/command/ActionDescriptor"; -import type { - ReferenceEntry, - ReferenceEntryWithoutIdKind, -} from "../types/ReferenceEntry"; +import type { ReferenceEntry } from "./ReferenceEntry"; const DEFAULT_PATTERN = " "; const DEFAULT_PATTERN_SCOPE = " "; type TalonSideActionType = "applyFormatter" | "nextHomophone"; -const actionReferencesMap: Record< +export const actionReferences: Record< ActionType | TalonSideActionType, - ReferenceEntryWithoutIdKind + ReferenceEntry > = { addSelection: { name: "Add selection", @@ -396,6 +393,8 @@ const actionReferencesMap: Record< }, remove: { name: "Remove", + description: + "This action can be used to remove a target without moving the cursor", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -403,7 +402,12 @@ const actionReferencesMap: Record< cheatsheet: "Remove", }, ], - examples: [], + examples: [ + { + spokenForm: " blue air", + description: "Removes the token containing letter 'a' with a blue hat.", + }, + ], }, rename: { name: "Rename", @@ -832,11 +836,3 @@ const actionReferencesMap: Record< examples: [], }, }; - -export const actionReferences: ReferenceEntry[] = Object.entries( - actionReferencesMap, -).map(([actionType, referenceEntry]) => ({ - id: actionType, - kind: "action", - ...referenceEntry, -})); 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 index 1b55486ad4..912b868997 100644 --- a/packages/lib-common/src/references/modifierReferences.ts +++ b/packages/lib-common/src/references/modifierReferences.ts @@ -1,16 +1,13 @@ import type { ModifierType } from "../types/command/PartialTargetDescriptor.types"; -import type { - ReferenceEntry, - ReferenceEntryWithoutIdKind, -} from "../types/ReferenceEntry"; +import type { ReferenceEntry } from "./ReferenceEntry"; const DEFAULT_PATTERN = ""; type AdditionalModifierReferenceType = "ancestor"; -const modifierReferencesMap: Record< +export const modifierReferences: Record< ModifierType | AdditionalModifierReferenceType, - ReferenceEntryWithoutIdKind + ReferenceEntry > = { startOf: { name: "Start of", @@ -370,11 +367,3 @@ const modifierReferencesMap: Record< examples: [], }, }; - -export const modifierReferences: ReferenceEntry[] = Object.entries( - modifierReferencesMap, -).map(([modifierType, referenceEntry]) => ({ - id: modifierType, - kind: "modifier", - ...referenceEntry, -})); diff --git a/packages/lib-common/src/references/scopeReferences.ts b/packages/lib-common/src/references/scopeReferences.ts index cf58fdc50c..4e51b0edd0 100644 --- a/packages/lib-common/src/references/scopeReferences.ts +++ b/packages/lib-common/src/references/scopeReferences.ts @@ -1,16 +1,13 @@ import type { SimpleScopeTypeType } from "../types/command/PartialTargetDescriptor.types"; -import type { - ReferenceEntry, - ReferenceEntryWithoutIdKind, -} from "../types/ReferenceEntry"; +import type { ReferenceEntry } from "./ReferenceEntry"; const DEFAULT_PATTERN = ""; type AdditionalScopeReferenceType = "glyph" | "pair"; -const scopeReferencesMap: Record< +export const scopeReferences: Record< SimpleScopeTypeType | AdditionalScopeReferenceType, - ReferenceEntryWithoutIdKind + ReferenceEntry > = { argumentOrParameter: { name: "Argument", @@ -759,11 +756,3 @@ const scopeReferencesMap: Record< examples: [], }, }; - -export const scopeReferences: ReferenceEntry[] = Object.entries( - scopeReferencesMap, -).map(([scopeType, referenceEntry]) => ({ - id: scopeType, - kind: "scope", - ...referenceEntry, -})); From ff5c93c5fbfbd567dcba6028bf2c99bbf1464186 Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Wed, 26 Aug 2026 15:55:09 +0200 Subject: [PATCH 04/16] Properly render actions --- oxlint.config.mts | 8 +- packages/app-web-docs/src/docs/user/README.md | 10 - .../user/reference/actions/_category_.json | 4 + .../user/reference/actions/addSelection.mdx | 5 + .../reference/actions/addSelectionAfter.mdx | 5 + .../reference/actions/addSelectionBefore.mdx | 5 + .../user/reference/actions/applyFormatter.mdx | 5 + .../docs/user/reference/actions/breakLine.mdx | 5 + .../user/reference/actions/callAsFunction.mdx | 5 + .../actions/clearAndSetSelection.mdx | 5 + .../reference/actions/copyToClipboard.mdx | 5 + .../user/reference/actions/cutToClipboard.mdx | 5 + .../docs/user/reference/actions/decrement.mdx | 5 + .../docs/user/reference/actions/deselect.mdx | 5 + .../docs/user/reference/actions/editNew.mdx | 5 + .../reference/actions/editNewLineAfter.mdx | 5 + .../reference/actions/editNewLineBefore.mdx | 5 + .../user/reference/actions/executeCommand.mdx | 5 + .../experimental.setInstanceReference.mdx | 5 + .../reference/actions/extractVariable.mdx | 5 + .../user/reference/actions/findInDocument.mdx | 5 + .../reference/actions/findInWorkspace.mdx | 5 + .../user/reference/actions/flashTargets.mdx | 5 + .../user/reference/actions/foldRegion.mdx | 5 + .../user/reference/actions/followLink.mdx | 5 + .../reference/actions/followLinkAside.mdx | 5 + .../reference/actions/generateSnippet.mdx | 5 + .../docs/user/reference/actions/getText.mdx | 5 + .../docs/user/reference/actions/gitAccept.mdx | 5 + .../docs/user/reference/actions/gitRevert.mdx | 5 + .../docs/user/reference/actions/gitStage.mdx | 5 + .../user/reference/actions/gitUnstage.mdx | 5 + .../docs/user/reference/actions/highlight.mdx | 5 + .../docs/user/reference/actions/increment.mdx | 5 + .../user/reference/actions/indentLine.mdx | 5 + .../reference/actions/insertCopyAfter.mdx | 5 + .../reference/actions/insertCopyBefore.mdx | 5 + .../actions/insertEmptyLineAfter.mdx | 5 + .../actions/insertEmptyLineBefore.mdx | 5 + .../actions/insertEmptyLinesAround.mdx | 5 + .../user/reference/actions/insertSnippet.mdx | 5 + .../docs/user/reference/actions/joinLines.mdx | 5 + .../user/reference/actions/moveToTarget.mdx | 5 + .../user/reference/actions/nextHomophone.mdx | 5 + .../user/reference/actions/outdentLine.mdx | 5 + .../docs/user/reference/actions/parsed.mdx | 5 + .../reference/actions/pasteFromClipboard.mdx | 5 + .../reference/actions/private.getTargets.mdx | 5 + .../actions/private.setKeyboardTarget.mdx | 5 + .../actions/private.showParseTree.mdx | 5 + .../reference/actions/randomizeTargets.mdx | 5 + .../docs/user/reference/actions/rename.mdx | 5 + .../docs/user/reference/actions/replace.mdx | 5 + .../reference/actions/replaceWithTarget.mdx | 5 + .../reference/actions/revealDefinition.mdx | 5 + .../actions/revealTypeDefinition.mdx | 5 + .../user/reference/actions/reverseTargets.mdx | 5 + .../actions/rewrapWithPairedDelimiter.mdx | 5 + .../user/reference/actions/scrollToBottom.mdx | 5 + .../user/reference/actions/scrollToCenter.mdx | 5 + .../user/reference/actions/scrollToTop.mdx | 5 + .../user/reference/actions/setSelection.mdx | 5 + .../reference/actions/setSelectionAfter.mdx | 5 + .../reference/actions/setSelectionBefore.mdx | 5 + .../user/reference/actions/showDebugHover.mdx | 5 + .../docs/user/reference/actions/showHover.mdx | 5 + .../user/reference/actions/showQuickFix.mdx | 5 + .../user/reference/actions/showReferences.mdx | 5 + .../user/reference/actions/sortTargets.mdx | 5 + .../user/reference/actions/swapTargets.mdx | 5 + .../actions/toggleLineBreakpoint.mdx | 5 + .../reference/actions/toggleLineComment.mdx | 5 + .../user/reference/actions/unfoldRegion.mdx | 5 + .../actions/wrapWithPairedDelimiter.mdx | 5 + .../reference/actions/wrapWithSnippet.mdx | 5 + .../reference/components/ReferenceEntry.tsx | 43 ++- .../src/docs/user/reference/modifiers.md | 1 - .../user/reference/modifiers/_category_.json | 4 + .../src/docs/user/reference/scopes.md | 1 - .../src/references/ReferenceEntry.ts | 11 +- .../src/references/actionReferences.ts | 73 +++++ .../src/references/modifierReferences.ts | 67 ++++- .../src/references/scopeReferences.ts | 72 +++++ .../spokenForms/defaultSpokenFormMapCore.ts | 261 +++++------------- packages/tool-meta-updater/src/metaUpdater.ts | 28 +- .../src/updateReferenceMdx.ts | 29 ++ 86 files changed, 751 insertions(+), 221 deletions(-) create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/_category_.json create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/addSelection.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/addSelectionAfter.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/addSelectionBefore.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/applyFormatter.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/breakLine.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/callAsFunction.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/clearAndSetSelection.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/copyToClipboard.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/cutToClipboard.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/decrement.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/deselect.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/editNew.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/editNewLineAfter.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/editNewLineBefore.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/executeCommand.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/experimental.setInstanceReference.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/extractVariable.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/findInDocument.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/findInWorkspace.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/flashTargets.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/foldRegion.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/followLink.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/followLinkAside.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/generateSnippet.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/getText.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/gitAccept.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/gitRevert.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/gitStage.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/gitUnstage.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/highlight.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/increment.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/indentLine.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/insertCopyAfter.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/insertCopyBefore.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLineAfter.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLineBefore.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLinesAround.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/insertSnippet.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/joinLines.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/moveToTarget.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/nextHomophone.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/outdentLine.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/parsed.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/pasteFromClipboard.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/private.getTargets.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/private.setKeyboardTarget.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/private.showParseTree.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/randomizeTargets.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/rename.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/replace.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/replaceWithTarget.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/revealDefinition.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/revealTypeDefinition.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/reverseTargets.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/rewrapWithPairedDelimiter.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/scrollToBottom.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/scrollToCenter.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/scrollToTop.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/setSelection.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/setSelectionAfter.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/setSelectionBefore.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/showDebugHover.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/showHover.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/showQuickFix.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/showReferences.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/sortTargets.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/swapTargets.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/toggleLineBreakpoint.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/toggleLineComment.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/unfoldRegion.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/wrapWithPairedDelimiter.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/actions/wrapWithSnippet.mdx delete mode 100644 packages/app-web-docs/src/docs/user/reference/modifiers.md create mode 100644 packages/app-web-docs/src/docs/user/reference/modifiers/_category_.json delete mode 100644 packages/app-web-docs/src/docs/user/reference/scopes.md create mode 100644 packages/tool-meta-updater/src/updateReferenceMdx.ts diff --git a/oxlint.config.mts b/oxlint.config.mts index a22898043b..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", @@ -216,13 +217,6 @@ export default defineConfig({ }, }, - { - files: ["**/*.mdx"], - rules: { - "react/no-array-index-key ": "off", - }, - }, - { files: ["packages/app-vscode/src/scripts/**/*.ts"], rules: { diff --git a/packages/app-web-docs/src/docs/user/README.md b/packages/app-web-docs/src/docs/user/README.md index c390f8b325..35298f5bd5 100644 --- a/packages/app-web-docs/src/docs/user/README.md +++ b/packages/app-web-docs/src/docs/user/README.md @@ -556,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/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..3863f2a0ef --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/addSelection.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..faa1c0fb77 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/addSelectionAfter.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..3b7f44f0e5 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/addSelectionBefore.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..a433be0622 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/applyFormatter.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..1666276553 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/breakLine.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..1562096abc --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/callAsFunction.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..235e138624 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/clearAndSetSelection.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..99e90a756c --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/copyToClipboard.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..a2d06361d7 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/cutToClipboard.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..fad7b5e3fe --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/decrement.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..ae2af3504c --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/deselect.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../components/ReferenceEntry"; + +# Deselect + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/editNew.mdx b/packages/app-web-docs/src/docs/user/reference/actions/editNew.mdx new file mode 100644 index 0000000000..b7ec3f0d4e --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/editNew.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../components/ReferenceEntry"; + +# Edit new + + 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..b4842017fc --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/editNewLineAfter.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..e2ebb5d3ee --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/editNewLineBefore.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../components/ReferenceEntry"; + +# Edit new line/scope before + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/executeCommand.mdx b/packages/app-web-docs/src/docs/user/reference/actions/executeCommand.mdx new file mode 100644 index 0000000000..567ce4ae66 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/executeCommand.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../components/ReferenceEntry"; + +# Execute command + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/experimental.setInstanceReference.mdx b/packages/app-web-docs/src/docs/user/reference/actions/experimental.setInstanceReference.mdx new file mode 100644 index 0000000000..0ee2112aa7 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/experimental.setInstanceReference.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../components/ReferenceEntry"; + +# Set instance reference + + 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..5d1d6689d7 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/extractVariable.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..00dc0a4613 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/findInDocument.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..894679195e --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/findInWorkspace.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..2bc25a7f9f --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/flashTargets.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..f97164c17f --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/foldRegion.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..b411d4831f --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/followLink.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..454dc21bfc --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/followLinkAside.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..55378b5879 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/generateSnippet.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../components/ReferenceEntry"; + +# Generate snippet + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/getText.mdx b/packages/app-web-docs/src/docs/user/reference/actions/getText.mdx new file mode 100644 index 0000000000..2bf91f457c --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/getText.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../components/ReferenceEntry"; + +# Get text + + 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..b88833fd65 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/gitAccept.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..65c6528c9c --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/gitRevert.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..25f0bcdc8a --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/gitStage.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..fe8c181619 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/gitUnstage.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..19f2f2a555 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/highlight.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..898e2d1810 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/increment.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..ae837f4122 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/indentLine.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..a7327a8b0e --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/insertCopyAfter.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..28e6eedc79 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/insertCopyBefore.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..f65eedd768 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLineAfter.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..91b40a8a27 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLineBefore.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..dd36b3c6cf --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLinesAround.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..2b23340fe7 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/insertSnippet.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..345517e4d6 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/joinLines.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..7c2d3df6a8 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/moveToTarget.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..4578ecd1f9 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/nextHomophone.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..fe2f41defd --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/outdentLine.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../components/ReferenceEntry"; + +# Outdent line + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/parsed.mdx b/packages/app-web-docs/src/docs/user/reference/actions/parsed.mdx new file mode 100644 index 0000000000..e556e5066e --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/parsed.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../components/ReferenceEntry"; + +# Parsed + + 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..fa1c9e781c --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/pasteFromClipboard.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../components/ReferenceEntry"; + +# Paste from clipboard + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/private.getTargets.mdx b/packages/app-web-docs/src/docs/user/reference/actions/private.getTargets.mdx new file mode 100644 index 0000000000..8a83a424b4 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/private.getTargets.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../components/ReferenceEntry"; + +# Get targets + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/private.setKeyboardTarget.mdx b/packages/app-web-docs/src/docs/user/reference/actions/private.setKeyboardTarget.mdx new file mode 100644 index 0000000000..90c98e45d6 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/private.setKeyboardTarget.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../components/ReferenceEntry"; + +# Set keyboard target + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/private.showParseTree.mdx b/packages/app-web-docs/src/docs/user/reference/actions/private.showParseTree.mdx new file mode 100644 index 0000000000..93b5881d5c --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/private.showParseTree.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../components/ReferenceEntry"; + +# Show parse tree + + 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..fcf3413ffe --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/randomizeTargets.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../components/ReferenceEntry"; + +# Randomize targets + + 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..20d4a6313f --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/rename.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../components/ReferenceEntry"; + +# Rename + + diff --git a/packages/app-web-docs/src/docs/user/reference/actions/replace.mdx b/packages/app-web-docs/src/docs/user/reference/actions/replace.mdx new file mode 100644 index 0000000000..b09be94de0 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/replace.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../components/ReferenceEntry"; + +# Replace + + 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..59817be4e6 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/replaceWithTarget.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..91595ef8f1 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/revealDefinition.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..32509ccda6 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/revealTypeDefinition.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..ac2903d31c --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/reverseTargets.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..eedbd1b33d --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/rewrapWithPairedDelimiter.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..35a4cf3ab1 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/scrollToBottom.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..3ec134e014 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/scrollToCenter.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..8ea3d2eabc --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/scrollToTop.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../components/ReferenceEntry"; + +# Scroll to top + + 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..8c8a9a6fa7 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/setSelection.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..673669bb16 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/setSelectionAfter.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..22abc88755 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/setSelectionBefore.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..476022e4d1 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/showDebugHover.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..d4c3c70dc4 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/showHover.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..adbb354d9a --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/showQuickFix.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..54641f5221 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/showReferences.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..f3ec09f3c4 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/sortTargets.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..5a90e58e34 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/swapTargets.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..d7b1e1dd23 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/toggleLineBreakpoint.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..751fb8c651 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/toggleLineComment.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..62d6d7eec2 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/unfoldRegion.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..92ba2593e5 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/wrapWithPairedDelimiter.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../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..091a334f25 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/actions/wrapWithSnippet.mdx @@ -0,0 +1,5 @@ +import { ActionReference } from "../components/ReferenceEntry"; + +# Wrap with snippet + + diff --git a/packages/app-web-docs/src/docs/user/reference/components/ReferenceEntry.tsx b/packages/app-web-docs/src/docs/user/reference/components/ReferenceEntry.tsx index 33121cda21..00e931bb8b 100644 --- a/packages/app-web-docs/src/docs/user/reference/components/ReferenceEntry.tsx +++ b/packages/app-web-docs/src/docs/user/reference/components/ReferenceEntry.tsx @@ -34,18 +34,33 @@ function ReferenceEntryComponent({ {entry.description != null &&

{entry.description}

}

- Internal ID: {id} + ID: {id}

+ {entry.defaultSpokenForm != null && ( +

+ Default spoken form: {entry.defaultSpokenForm} +

+ )} + {entry.legacySpokenForms != null && ( -

Legacy spoken forms: {entry.legacySpokenForms.join(", ")}

+

+ Legacy spoken forms:{" "} + {entry.legacySpokenForms.map((s, i) => ( + <> + {i > 0 && ", "} + {s} + + ))} +

)} {entry.syntaxes.length > 0 && (
    {entry.syntaxes.map((syntax, index) => (
  • - {syntax.pattern}: {syntax.description} + {formatPattern(syntax.pattern, entry.defaultSpokenForm)}:{" "} + {formatPattern(syntax.description)}
  • ))}
@@ -57,7 +72,12 @@ function ReferenceEntryComponent({
    {entry.examples.map((example, index) => (
  • - {example.spokenForm}: {example.description} + + " + {formatPattern(example.spokenForm, entry.defaultSpokenForm)} + " + + : {example.description}
  • ))}
@@ -66,3 +86,18 @@ function ReferenceEntryComponent({ ); } + +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/user/reference/modifiers.md b/packages/app-web-docs/src/docs/user/reference/modifiers.md deleted file mode 100644 index 4358dfdbf8..0000000000 --- a/packages/app-web-docs/src/docs/user/reference/modifiers.md +++ /dev/null @@ -1 +0,0 @@ -# Modifiers 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/scopes.md b/packages/app-web-docs/src/docs/user/reference/scopes.md deleted file mode 100644 index 25cd4513bf..0000000000 --- a/packages/app-web-docs/src/docs/user/reference/scopes.md +++ /dev/null @@ -1 +0,0 @@ -# Scopes diff --git a/packages/lib-common/src/references/ReferenceEntry.ts b/packages/lib-common/src/references/ReferenceEntry.ts index 3819f1ab4f..e68536f2ea 100644 --- a/packages/lib-common/src/references/ReferenceEntry.ts +++ b/packages/lib-common/src/references/ReferenceEntry.ts @@ -1,8 +1,13 @@ -export interface ReferenceEntry { - name: string; +export interface SpokenFormReference { + defaultSpokenForm?: string; private?: boolean; - description?: string; + disabledByDefault?: boolean; +} + +export interface ReferenceEntry extends SpokenFormReference { + name: string; legacySpokenForms?: string[]; + description?: string; syntaxes: SyntaxDefinition[]; examples: ExampleDefinition[]; } diff --git a/packages/lib-common/src/references/actionReferences.ts b/packages/lib-common/src/references/actionReferences.ts index b2f2ceb6bc..f2c3f00f50 100644 --- a/packages/lib-common/src/references/actionReferences.ts +++ b/packages/lib-common/src/references/actionReferences.ts @@ -12,6 +12,7 @@ export const actionReferences: Record< > = { addSelection: { name: "Add selection", + defaultSpokenForm: "append", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -23,6 +24,7 @@ export const actionReferences: Record< }, addSelectionAfter: { name: "Add selection after", + defaultSpokenForm: "append post", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -35,6 +37,7 @@ export const actionReferences: Record< }, addSelectionBefore: { name: "Add selection before", + defaultSpokenForm: "append pre", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -47,6 +50,7 @@ export const actionReferences: Record< }, breakLine: { name: "Break line", + defaultSpokenForm: "break", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -58,6 +62,7 @@ export const actionReferences: Record< }, clearAndSetSelection: { name: "Change", + defaultSpokenForm: "change", legacySpokenForms: ["clear"], syntaxes: [ { @@ -71,6 +76,7 @@ export const actionReferences: Record< }, copyToClipboard: { name: "Copy to clipboard", + defaultSpokenForm: "copy", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -82,6 +88,7 @@ export const actionReferences: Record< }, cutToClipboard: { name: "Cut to clipboard", + defaultSpokenForm: "carve", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -93,6 +100,7 @@ export const actionReferences: Record< }, decrement: { name: "Decrement", + defaultSpokenForm: "decrement", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -104,6 +112,7 @@ export const actionReferences: Record< }, deselect: { name: "Deselect", + defaultSpokenForm: "give", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -115,6 +124,7 @@ export const actionReferences: Record< }, editNewLineAfter: { name: "Edit new line/scope after", + defaultSpokenForm: "pour", description: "Scope defaults to line", syntaxes: [ { @@ -132,6 +142,7 @@ export const actionReferences: Record< }, editNewLineBefore: { name: "Edit new line/scope before", + defaultSpokenForm: "drink", description: "Scope defaults to line", syntaxes: [ { @@ -149,6 +160,7 @@ export const actionReferences: Record< }, "experimental.setInstanceReference": { name: "Set instance reference", + defaultSpokenForm: "from", description: "Sets the instance reference for the next 'instance of' action", syntaxes: [ @@ -162,6 +174,7 @@ export const actionReferences: Record< }, extractVariable: { name: "Extract variable", + defaultSpokenForm: "extract", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -173,6 +186,7 @@ export const actionReferences: Record< }, findInDocument: { name: "Find in document", + defaultSpokenForm: "scout", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -184,6 +198,7 @@ export const actionReferences: Record< }, findInWorkspace: { name: "Find in workspace", + defaultSpokenForm: "scout all", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -195,6 +210,7 @@ export const actionReferences: Record< }, flashTargets: { name: "Flash target", + defaultSpokenForm: "flash", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -206,6 +222,7 @@ export const actionReferences: Record< }, foldRegion: { name: "Fold region", + defaultSpokenForm: "fold", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -217,6 +234,7 @@ export const actionReferences: Record< }, followLink: { name: "Follow link", + defaultSpokenForm: "follow", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -228,6 +246,7 @@ export const actionReferences: Record< }, followLinkAside: { name: "Follow link aside", + defaultSpokenForm: "follow split", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -239,6 +258,7 @@ export const actionReferences: Record< }, gitAccept: { name: "Git accept", + defaultSpokenForm: "git accept", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -250,6 +270,7 @@ export const actionReferences: Record< }, gitRevert: { name: "Git revert", + defaultSpokenForm: "git revert", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -261,6 +282,7 @@ export const actionReferences: Record< }, gitStage: { name: "Git stage", + defaultSpokenForm: "git stage", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -272,6 +294,7 @@ export const actionReferences: Record< }, gitUnstage: { name: "Git unstage", + defaultSpokenForm: "git unstage", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -283,6 +306,7 @@ export const actionReferences: Record< }, increment: { name: "Increment", + defaultSpokenForm: "increment", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -294,6 +318,7 @@ export const actionReferences: Record< }, indentLine: { name: "Indent line", + defaultSpokenForm: "indent", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -305,6 +330,7 @@ export const actionReferences: Record< }, insertCopyAfter: { name: "Insert copy after", + defaultSpokenForm: "clone", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -316,6 +342,7 @@ export const actionReferences: Record< }, insertCopyBefore: { name: "Insert copy before", + defaultSpokenForm: "clone up", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -327,6 +354,7 @@ export const actionReferences: Record< }, insertEmptyLineAfter: { name: "Insert empty line after", + defaultSpokenForm: "float", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -338,6 +366,7 @@ export const actionReferences: Record< }, insertEmptyLineBefore: { name: "Insert empty line before", + defaultSpokenForm: "drop", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -349,6 +378,7 @@ export const actionReferences: Record< }, insertEmptyLinesAround: { name: "Insert empty lines around", + defaultSpokenForm: "puff", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -360,6 +390,7 @@ export const actionReferences: Record< }, joinLines: { name: "Join lines", + defaultSpokenForm: "join", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -371,6 +402,7 @@ export const actionReferences: Record< }, outdentLine: { name: "Outdent line", + defaultSpokenForm: "dedent", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -382,6 +414,7 @@ export const actionReferences: Record< }, randomizeTargets: { name: "Randomize targets", + defaultSpokenForm: "shuffle", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -393,6 +426,7 @@ export const actionReferences: Record< }, remove: { name: "Remove", + defaultSpokenForm: "chuck", description: "This action can be used to remove a target without moving the cursor", syntaxes: [ @@ -411,6 +445,7 @@ export const actionReferences: Record< }, rename: { name: "Rename", + defaultSpokenForm: "rename", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -422,6 +457,7 @@ export const actionReferences: Record< }, revealDefinition: { name: "Reveal definition", + defaultSpokenForm: "define", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -433,6 +469,7 @@ export const actionReferences: Record< }, revealTypeDefinition: { name: "Reveal type definition", + defaultSpokenForm: "type deaf", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -444,6 +481,7 @@ export const actionReferences: Record< }, reverseTargets: { name: "Reverse targets", + defaultSpokenForm: "reverse", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -455,6 +493,7 @@ export const actionReferences: Record< }, scrollToBottom: { name: "Scroll to bottom", + defaultSpokenForm: "bottom", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -466,6 +505,7 @@ export const actionReferences: Record< }, scrollToCenter: { name: "Scroll to center", + defaultSpokenForm: "center", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -477,6 +517,7 @@ export const actionReferences: Record< }, scrollToTop: { name: "Scroll to top", + defaultSpokenForm: "crown", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -488,6 +529,7 @@ export const actionReferences: Record< }, setSelection: { name: "Set selection", + defaultSpokenForm: "take", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -499,6 +541,7 @@ export const actionReferences: Record< }, setSelectionAfter: { name: "Set selection after", + defaultSpokenForm: "post", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -510,6 +553,7 @@ export const actionReferences: Record< }, setSelectionBefore: { name: "Set selection before", + defaultSpokenForm: "pre", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -521,6 +565,7 @@ export const actionReferences: Record< }, showDebugHover: { name: "Show debug hover", + defaultSpokenForm: "inspect", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -532,6 +577,7 @@ export const actionReferences: Record< }, showHover: { name: "Show hover", + defaultSpokenForm: "hover", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -543,6 +589,7 @@ export const actionReferences: Record< }, showQuickFix: { name: "Show quick fix", + defaultSpokenForm: "quick fix", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -554,6 +601,7 @@ export const actionReferences: Record< }, showReferences: { name: "Show references", + defaultSpokenForm: "reference", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -565,6 +613,7 @@ export const actionReferences: Record< }, sortTargets: { name: "Sort targets", + defaultSpokenForm: "sort", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -576,6 +625,7 @@ export const actionReferences: Record< }, toggleLineBreakpoint: { name: "Toggle line/scope breakpoint", + defaultSpokenForm: "break point", description: "Scope defaults to line", syntaxes: [ { @@ -593,6 +643,7 @@ export const actionReferences: Record< }, toggleLineComment: { name: "Toggle line comment", + defaultSpokenForm: "comment", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -604,6 +655,7 @@ export const actionReferences: Record< }, unfoldRegion: { name: "Unfold region", + defaultSpokenForm: "unfold", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -615,6 +667,7 @@ export const actionReferences: Record< }, callAsFunction: { name: "Call as function", + defaultSpokenForm: "call", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -631,6 +684,7 @@ export const actionReferences: Record< }, generateSnippet: { name: "Generate snippet", + defaultSpokenForm: "snip make", legacySpokenForms: ["snippet make"], syntaxes: [ { @@ -643,6 +697,7 @@ export const actionReferences: Record< }, highlight: { name: "Highlight", + defaultSpokenForm: "highlight", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -654,6 +709,7 @@ export const actionReferences: Record< }, insertSnippet: { name: "Insert snippet", + defaultSpokenForm: "snippet", syntaxes: [ { pattern: " ", @@ -665,6 +721,7 @@ export const actionReferences: Record< }, moveToTarget: { name: "Move to target", + defaultSpokenForm: "move", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -681,6 +738,7 @@ export const actionReferences: Record< }, pasteFromClipboard: { name: "Paste from clipboard", + defaultSpokenForm: "paste", syntaxes: [ { pattern: " ", @@ -692,6 +750,7 @@ export const actionReferences: Record< }, replaceWithTarget: { name: "Replace with target", + defaultSpokenForm: "bring", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -708,6 +767,7 @@ export const actionReferences: Record< }, rewrapWithPairedDelimiter: { name: "Rewrap with paired delimiter", + defaultSpokenForm: "repack", syntaxes: [ { pattern: " ", @@ -719,6 +779,7 @@ export const actionReferences: Record< }, swapTargets: { name: "Swap targets", + defaultSpokenForm: "swap", syntaxes: [ { pattern: " ", @@ -735,6 +796,7 @@ export const actionReferences: Record< }, wrapWithPairedDelimiter: { name: "Wrap with paired delimiter", + defaultSpokenForm: "wrap", syntaxes: [ { pattern: " ", @@ -746,6 +808,7 @@ export const actionReferences: Record< }, wrapWithSnippet: { name: "Wrap with snippet", + defaultSpokenForm: "wrap", syntaxes: [ { pattern: " ", @@ -757,6 +820,7 @@ export const actionReferences: Record< }, applyFormatter: { name: "Apply formatter", + defaultSpokenForm: "format", syntaxes: [ { pattern: " at ", @@ -768,6 +832,7 @@ export const actionReferences: Record< }, nextHomophone: { name: "Next homophone", + defaultSpokenForm: "phones", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -781,6 +846,7 @@ export const actionReferences: Record< // Private actions, but that has spoken forms "private.showParseTree": { name: "Show parse tree", + defaultSpokenForm: "parse tree", private: true, syntaxes: [ { @@ -795,42 +861,49 @@ export const actionReferences: Record< // Actions without spoken forms 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/modifierReferences.ts b/packages/lib-common/src/references/modifierReferences.ts index 912b868997..5feac48e26 100644 --- a/packages/lib-common/src/references/modifierReferences.ts +++ b/packages/lib-common/src/references/modifierReferences.ts @@ -1,5 +1,6 @@ import type { ModifierType } from "../types/command/PartialTargetDescriptor.types"; -import type { ReferenceEntry } from "./ReferenceEntry"; +import type { SpokenFormMapKeyTypes } from "../types/SpokenFormType"; +import type { ReferenceEntry, SpokenFormReference } from "./ReferenceEntry"; const DEFAULT_PATTERN = ""; @@ -11,6 +12,7 @@ export const modifierReferences: Record< > = { startOf: { name: "Start of", + defaultSpokenForm: "start of", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -22,6 +24,7 @@ export const modifierReferences: Record< }, endOf: { name: "End of", + defaultSpokenForm: "end of", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -33,6 +36,7 @@ export const modifierReferences: Record< }, interiorOnly: { name: "Interior only", + defaultSpokenForm: "inside", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -44,6 +48,7 @@ export const modifierReferences: Record< }, excludeInterior: { name: "Exclude interior", + defaultSpokenForm: "bounds", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -55,6 +60,7 @@ export const modifierReferences: Record< }, visible: { name: "Visible", + defaultSpokenForm: "visible", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -77,6 +83,7 @@ export const modifierReferences: Record< }, everyScope: { name: "Every scope", + defaultSpokenForm: "every", syntaxes: [ { pattern: " ", @@ -88,6 +95,7 @@ export const modifierReferences: Record< }, ancestor: { name: "Ancestor", + defaultSpokenForm: "grand", syntaxes: [ { pattern: " ", @@ -236,6 +244,7 @@ export const modifierReferences: Record< }, extendThroughStartOf: { name: "Extend through start of", + defaultSpokenForm: "head", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -252,6 +261,7 @@ export const modifierReferences: Record< }, extendThroughEndOf: { name: "Extend through end of", + defaultSpokenForm: "tail", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -268,6 +278,7 @@ export const modifierReferences: Record< }, leading: { name: "Leading", + defaultSpokenForm: "leading", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -279,6 +290,7 @@ export const modifierReferences: Record< }, trailing: { name: "Trailing", + defaultSpokenForm: "trailing", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -290,6 +302,7 @@ export const modifierReferences: Record< }, toRawSelection: { name: "Raw selection", + defaultSpokenForm: "just", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -301,6 +314,7 @@ export const modifierReferences: Record< }, keepContentFilter: { name: "Keep content filter", + defaultSpokenForm: "content", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -312,6 +326,7 @@ export const modifierReferences: Record< }, keepEmptyFilter: { name: "Keep empty filter", + defaultSpokenForm: "empty", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -323,6 +338,7 @@ export const modifierReferences: Record< }, inferPreviousMark: { name: "Infer previous mark", + defaultSpokenForm: "its", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -367,3 +383,52 @@ export const modifierReferences: Record< 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 index 4e51b0edd0..1b49c36b2f 100644 --- a/packages/lib-common/src/references/scopeReferences.ts +++ b/packages/lib-common/src/references/scopeReferences.ts @@ -11,6 +11,7 @@ export const scopeReferences: Record< > = { argumentOrParameter: { name: "Argument", + defaultSpokenForm: "arg", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -22,6 +23,7 @@ export const scopeReferences: Record< }, argumentList: { name: "Argument list", + defaultSpokenForm: "arg list", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -33,6 +35,7 @@ export const scopeReferences: Record< }, anonymousFunction: { name: "Anonymous function", + defaultSpokenForm: "lambda", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -44,6 +47,7 @@ export const scopeReferences: Record< }, attribute: { name: "Attribute", + defaultSpokenForm: "attribute", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -55,6 +59,7 @@ export const scopeReferences: Record< }, branch: { name: "Branch", + defaultSpokenForm: "branch", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -66,6 +71,7 @@ export const scopeReferences: Record< }, class: { name: "Class", + defaultSpokenForm: "class", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -77,6 +83,7 @@ export const scopeReferences: Record< }, className: { name: "Class name", + defaultSpokenForm: "class name", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -88,6 +95,7 @@ export const scopeReferences: Record< }, collectionItem: { name: "Collection item", + defaultSpokenForm: "item", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -99,6 +107,7 @@ export const scopeReferences: Record< }, collectionKey: { name: "Collection key", + defaultSpokenForm: "key", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -110,6 +119,7 @@ export const scopeReferences: Record< }, comment: { name: "Comment", + defaultSpokenForm: "comment", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -121,6 +131,7 @@ export const scopeReferences: Record< }, "private.fieldAccess": { name: "Field access", + defaultSpokenForm: "access", private: true, syntaxes: [ { @@ -133,6 +144,7 @@ export const scopeReferences: Record< }, functionCall: { name: "Function call", + defaultSpokenForm: "call", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -144,6 +156,7 @@ export const scopeReferences: Record< }, functionCallee: { name: "Function callee", + defaultSpokenForm: "callee", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -155,6 +168,7 @@ export const scopeReferences: Record< }, functionName: { name: "Function name", + defaultSpokenForm: "funk name", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -166,6 +180,7 @@ export const scopeReferences: Record< }, ifStatement: { name: "If statement", + defaultSpokenForm: "if state", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -177,6 +192,7 @@ export const scopeReferences: Record< }, instance: { name: "Instance", + defaultSpokenForm: "instance", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -188,6 +204,7 @@ export const scopeReferences: Record< }, list: { name: "List", + defaultSpokenForm: "list", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -199,6 +216,7 @@ export const scopeReferences: Record< }, map: { name: "Map", + defaultSpokenForm: "map", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -210,6 +228,7 @@ export const scopeReferences: Record< }, name: { name: "Name", + defaultSpokenForm: "name", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -221,6 +240,7 @@ export const scopeReferences: Record< }, namedFunction: { name: "Named function", + defaultSpokenForm: "funk", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -232,6 +252,7 @@ export const scopeReferences: Record< }, regularExpression: { name: "Regular expression", + defaultSpokenForm: "regex", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -243,6 +264,7 @@ export const scopeReferences: Record< }, statement: { name: "Statement", + defaultSpokenForm: "state", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -254,6 +276,7 @@ export const scopeReferences: Record< }, string: { name: "String", + defaultSpokenForm: "parse tree string", private: true, syntaxes: [ { @@ -266,6 +289,7 @@ export const scopeReferences: Record< }, type: { name: "Type", + defaultSpokenForm: "type", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -277,6 +301,7 @@ export const scopeReferences: Record< }, value: { name: "Value", + defaultSpokenForm: "value", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -288,6 +313,7 @@ export const scopeReferences: Record< }, condition: { name: "Condition", + defaultSpokenForm: "condition", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -299,6 +325,7 @@ export const scopeReferences: Record< }, section: { name: "Section", + defaultSpokenForm: "section", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -310,6 +337,8 @@ export const scopeReferences: Record< }, sectionLevelOne: { name: "Section level one", + defaultSpokenForm: "one section", + disabledByDefault: true, syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -321,6 +350,8 @@ export const scopeReferences: Record< }, sectionLevelTwo: { name: "Section level two", + defaultSpokenForm: "two section", + disabledByDefault: true, syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -332,6 +363,8 @@ export const scopeReferences: Record< }, sectionLevelThree: { name: "Section level three", + defaultSpokenForm: "three section", + disabledByDefault: true, syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -343,6 +376,8 @@ export const scopeReferences: Record< }, sectionLevelFour: { name: "Section level four", + defaultSpokenForm: "four section", + disabledByDefault: true, syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -354,6 +389,8 @@ export const scopeReferences: Record< }, sectionLevelFive: { name: "Section level five", + defaultSpokenForm: "five section", + disabledByDefault: true, syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -365,6 +402,8 @@ export const scopeReferences: Record< }, sectionLevelSix: { name: "Section level six", + defaultSpokenForm: "six section", + disabledByDefault: true, syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -376,6 +415,7 @@ export const scopeReferences: Record< }, selector: { name: "Selector", + defaultSpokenForm: "selector", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -387,6 +427,7 @@ export const scopeReferences: Record< }, unit: { name: "Unit", + defaultSpokenForm: "unit", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -398,6 +439,7 @@ export const scopeReferences: Record< }, xmlBothTags: { name: "XML both tags", + defaultSpokenForm: "tags", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -409,6 +451,7 @@ export const scopeReferences: Record< }, xmlElement: { name: "XML element", + defaultSpokenForm: "element", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -420,6 +463,7 @@ export const scopeReferences: Record< }, xmlEndTag: { name: "XML end tag", + defaultSpokenForm: "end tag", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -431,6 +475,7 @@ export const scopeReferences: Record< }, xmlStartTag: { name: "XML start tag", + defaultSpokenForm: "start tag", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -442,6 +487,7 @@ export const scopeReferences: Record< }, part: { name: "Part", + defaultSpokenForm: "part", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -453,6 +499,7 @@ export const scopeReferences: Record< }, chapter: { name: "Chapter", + defaultSpokenForm: "chapter", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -464,6 +511,7 @@ export const scopeReferences: Record< }, subSection: { name: "Subsection", + defaultSpokenForm: "subsection", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -475,6 +523,7 @@ export const scopeReferences: Record< }, subSubSection: { name: "Subsubsection", + defaultSpokenForm: "subsubsection", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -486,6 +535,7 @@ export const scopeReferences: Record< }, namedParagraph: { name: "Named paragraph", + defaultSpokenForm: "paragraph", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -497,6 +547,7 @@ export const scopeReferences: Record< }, subParagraph: { name: "Subparagraph", + defaultSpokenForm: "subparagraph", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -508,6 +559,7 @@ export const scopeReferences: Record< }, environment: { name: "Environment", + defaultSpokenForm: "environment", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -519,6 +571,7 @@ export const scopeReferences: Record< }, character: { name: "Character", + defaultSpokenForm: "char", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -530,6 +583,7 @@ export const scopeReferences: Record< }, word: { name: "Sub token word", + defaultSpokenForm: "sub", legacySpokenForms: ["word"], syntaxes: [ { @@ -542,6 +596,7 @@ export const scopeReferences: Record< }, token: { name: "Token", + defaultSpokenForm: "token", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -553,6 +608,7 @@ export const scopeReferences: Record< }, identifier: { name: "Identifier", + defaultSpokenForm: "identifier", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -564,6 +620,7 @@ export const scopeReferences: Record< }, line: { name: "Line", + defaultSpokenForm: "line", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -575,6 +632,7 @@ export const scopeReferences: Record< }, fullLine: { name: "Full line", + defaultSpokenForm: "full line", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -586,6 +644,7 @@ export const scopeReferences: Record< }, sentence: { name: "Sentence", + defaultSpokenForm: "sentence", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -597,6 +656,7 @@ export const scopeReferences: Record< }, paragraph: { name: "Paragraph", + defaultSpokenForm: "block", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -608,6 +668,7 @@ export const scopeReferences: Record< }, boundedParagraph: { name: "Bounded paragraph", + defaultSpokenForm: "short block", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -619,6 +680,7 @@ export const scopeReferences: Record< }, document: { name: "Document", + defaultSpokenForm: "file", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -630,6 +692,7 @@ export const scopeReferences: Record< }, nonWhitespaceSequence: { name: "Non-whitespace sequence", + defaultSpokenForm: "paint", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -641,6 +704,7 @@ export const scopeReferences: Record< }, boundedNonWhitespaceSequence: { name: "Bounded non-whitespace sequence", + defaultSpokenForm: "short paint", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -654,6 +718,7 @@ export const scopeReferences: Record< }, url: { name: "URL", + defaultSpokenForm: "link", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -665,6 +730,7 @@ export const scopeReferences: Record< }, notebookCell: { name: "Notebook cell", + defaultSpokenForm: "cell", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -676,6 +742,7 @@ export const scopeReferences: Record< }, command: { name: "Command", + defaultSpokenForm: "command", syntaxes: [ { pattern: DEFAULT_PATTERN, @@ -687,6 +754,7 @@ export const scopeReferences: Record< }, textFragment: { name: "Text fragment", + defaultSpokenForm: "text fragment", private: true, syntaxes: [ { @@ -699,6 +767,7 @@ export const scopeReferences: Record< }, disqualifyDelimiter: { name: "Disqualify delimiter", + defaultSpokenForm: "disqualify delimiter", private: true, syntaxes: [ { @@ -711,6 +780,7 @@ export const scopeReferences: Record< }, pairDelimiter: { name: "Pair delimiter", + defaultSpokenForm: "pair delimiter", private: true, syntaxes: [ { @@ -723,6 +793,7 @@ export const scopeReferences: Record< }, interior: { name: "Interior", + defaultSpokenForm: "interior", private: true, syntaxes: [ { @@ -735,6 +806,7 @@ export const scopeReferences: Record< }, glyph: { name: "Glyph", + defaultSpokenForm: "glyph", syntaxes: [ { pattern: " ", 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..fe05d278e1 100644 --- a/packages/tool-meta-updater/src/metaUpdater.ts +++ b/packages/tool-meta-updater/src/metaUpdater.ts @@ -4,11 +4,17 @@ // 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 { updateReferenceMdx } from "./updateReferenceMdx"; import { getScopeTypeTypes, updateScopeMdx } from "./updateScopeMdx"; import { updatesScopeSupportFacetInfos } from "./updatesScopeSupportFacetInfos"; import { updateTSConfig } from "./updateTSConfig"; @@ -28,6 +34,8 @@ export const updater = async (workspaceDir: string) => { workspaceDir, }; + const referenceDir = "src/docs/user/reference"; + return createUpdateOptions({ files: { "package.json": updatePackageJson.bind(null, context), @@ -41,6 +49,24 @@ export const updater = async (workspaceDir: string) => { updateLanguageMdx.bind(null, languageId), ]), ), + ...Object.fromEntries( + Object.entries(actionReferences).map(([id, entry]) => [ + `${referenceDir}/actions/${id}.mdx`, + updateReferenceMdx.bind(null, "action", id, entry.name), + ]), + ), + ...Object.fromEntries( + Object.entries(modifierReferences).map(([id, entry]) => [ + `${referenceDir}/modifiers/${id}.mdx`, + updateReferenceMdx.bind(null, "modifier", id, entry.name), + ]), + ), + ...Object.fromEntries( + Object.entries(scopeReferences).map(([id, entry]) => [ + `${referenceDir}/scopes/${id}.mdx`, + updateReferenceMdx.bind(null, "scope", id, entry.name), + ]), + ), ...Object.fromEntries( getScopeTypeTypes().map(({ scopeTypeType, name }) => [ `src/docs/contributing/scopes/${scopeTypeType.replace("private.", "")}.mdx`, diff --git a/packages/tool-meta-updater/src/updateReferenceMdx.ts b/packages/tool-meta-updater/src/updateReferenceMdx.ts new file mode 100644 index 0000000000..1ca40f43b4 --- /dev/null +++ b/packages/tool-meta-updater/src/updateReferenceMdx.ts @@ -0,0 +1,29 @@ +import type { FormatPluginFnOptions } from "@pnpm/meta-updater"; + +export function updateReferenceMdx( + kind: "action" | "modifier" | "scope", + id: string, + 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 importName = `${kind.charAt(0).toUpperCase() + kind.slice(1)}Reference`; + + const expected = ` +import { ${importName} } from "../components/ReferenceEntry"; + +# ${name} + +<${importName} id="${id}" /> +`.trimStart(); + + return expected; +} From 749fdc1be35a6c2e65b051d8c2b565bfa65dcd28 Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Thu, 27 Aug 2026 15:42:39 +0200 Subject: [PATCH 05/16] Move scopes from contributors to users docs --- .../src/docs/user/reference/actions/editNew.mdx | 5 ----- .../docs/user/reference/actions/executeCommand.mdx | 5 ----- .../src/docs/user/reference/actions/getText.mdx | 5 ----- .../src/docs/user/reference/actions/parsed.mdx | 5 ----- .../user/reference/actions/private.getTargets.mdx | 5 ----- .../reference/actions/private.setKeyboardTarget.mdx | 5 ----- .../user/reference/actions/private.showParseTree.mdx | 5 ----- .../src/docs/user/reference/actions/replace.mdx | 5 ----- .../src/docs/user/reference/modifiers/ancestor.mdx | 5 +++++ .../docs/user/reference/modifiers/containingScope.mdx | 5 +++++ .../src/docs/user/reference/modifiers/endOf.mdx | 5 +++++ .../src/docs/user/reference/modifiers/everyScope.mdx | 5 +++++ .../docs/user/reference/modifiers/excludeInterior.mdx | 5 +++++ .../user/reference/modifiers/extendThroughEndOf.mdx | 5 +++++ .../user/reference/modifiers/extendThroughStartOf.mdx | 5 +++++ .../user/reference/modifiers/inferPreviousMark.mdx | 5 +++++ .../docs/user/reference/modifiers/interiorOnly.mdx | 5 +++++ .../user/reference/modifiers/keepContentFilter.mdx | 5 +++++ .../docs/user/reference/modifiers/keepEmptyFilter.mdx | 5 +++++ .../src/docs/user/reference/modifiers/leading.mdx | 5 +++++ .../docs/user/reference/modifiers/ordinalScope.mdx | 5 +++++ .../docs/user/reference/modifiers/relativeScope.mdx | 5 +++++ .../src/docs/user/reference/modifiers/startOf.mdx | 5 +++++ .../docs/user/reference/modifiers/toRawSelection.mdx | 5 +++++ .../src/docs/user/reference/modifiers/trailing.mdx | 5 +++++ .../src/docs/user/reference/modifiers/visible.mdx | 5 +++++ .../{contributing => user/reference}/scopes/README.md | 0 .../src/docs/user/reference/scopes/_category_.json | 4 ++++ .../reference}/scopes/anonymousFunction.mdx | 0 .../reference}/scopes/argumentList.mdx | 0 .../reference}/scopes/argumentOrParameter.mdx | 0 .../reference}/scopes/attribute.mdx | 0 .../scopes/boundedNonWhitespaceSequence.mdx | 0 .../reference}/scopes/boundedParagraph.mdx | 0 .../reference}/scopes/branch.mdx | 0 .../reference}/scopes/character.mdx | 0 .../{contributing => user/reference}/scopes/class.mdx | 0 .../reference}/scopes/className.mdx | 0 .../reference}/scopes/collectionItem.mdx | 0 .../reference}/scopes/collectionKey.mdx | 0 .../reference}/scopes/command.mdx | 0 .../reference}/scopes/comment.mdx | 0 .../reference}/scopes/components/Scopes.tsx | 0 .../reference}/scopes/condition.mdx | 0 .../reference}/scopes/disqualifyDelimiter.mdx | 0 .../reference}/scopes/document.mdx | 0 .../reference}/scopes/environment.mdx | 0 .../reference}/scopes/fieldAccess.mdx | 0 .../reference}/scopes/fullLine.mdx | 0 .../reference}/scopes/functionCall.mdx | 0 .../reference}/scopes/functionCallee.mdx | 0 .../reference}/scopes/functionName.mdx | 0 .../reference}/scopes/identifier.mdx | 0 .../reference}/scopes/ifStatement.mdx | 0 .../reference}/scopes/interior.mdx | 0 .../{contributing => user/reference}/scopes/line.mdx | 0 .../{contributing => user/reference}/scopes/list.mdx | 0 .../{contributing => user/reference}/scopes/map.mdx | 0 .../{contributing => user/reference}/scopes/name.mdx | 0 .../reference}/scopes/namedFunction.mdx | 0 .../reference}/scopes/nonWhitespaceSequence.mdx | 0 .../reference}/scopes/notebookCell.mdx | 0 .../reference}/scopes/pairDelimiter.mdx | 0 .../reference}/scopes/paragraph.mdx | 0 .../reference}/scopes/regularExpression.mdx | 0 .../reference}/scopes/section.mdx | 0 .../reference}/scopes/selector.mdx | 0 .../reference}/scopes/sentence.mdx | 0 .../reference}/scopes/statement.mdx | 0 .../reference}/scopes/string.mdx | 0 .../reference}/scopes/surroundingPair.mdx | 0 .../reference}/scopes/surroundingPairInterior.mdx | 0 .../reference}/scopes/textFragment.mdx | 0 .../{contributing => user/reference}/scopes/token.mdx | 0 .../{contributing => user/reference}/scopes/type.mdx | 0 .../{contributing => user/reference}/scopes/unit.mdx | 0 .../{contributing => user/reference}/scopes/url.mdx | 0 .../{contributing => user/reference}/scopes/value.mdx | 0 .../{contributing => user/reference}/scopes/word.mdx | 0 .../reference}/scopes/xmlBothTags.mdx | 0 .../reference}/scopes/xmlElement.mdx | 0 .../reference}/scopes/xmlEndTag.mdx | 0 .../reference}/scopes/xmlStartTag.mdx | 0 .../lib-common/src/references/actionReferences.ts | 5 ++--- packages/tool-meta-updater/src/metaUpdater.ts | 4 ++-- packages/tool-meta-updater/src/updateReferenceMdx.ts | 11 ++++------- 86 files changed, 102 insertions(+), 52 deletions(-) delete mode 100644 packages/app-web-docs/src/docs/user/reference/actions/editNew.mdx delete mode 100644 packages/app-web-docs/src/docs/user/reference/actions/executeCommand.mdx delete mode 100644 packages/app-web-docs/src/docs/user/reference/actions/getText.mdx delete mode 100644 packages/app-web-docs/src/docs/user/reference/actions/parsed.mdx delete mode 100644 packages/app-web-docs/src/docs/user/reference/actions/private.getTargets.mdx delete mode 100644 packages/app-web-docs/src/docs/user/reference/actions/private.setKeyboardTarget.mdx delete mode 100644 packages/app-web-docs/src/docs/user/reference/actions/private.showParseTree.mdx delete mode 100644 packages/app-web-docs/src/docs/user/reference/actions/replace.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/modifiers/ancestor.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/modifiers/containingScope.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/modifiers/endOf.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/modifiers/everyScope.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/modifiers/excludeInterior.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/modifiers/extendThroughEndOf.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/modifiers/extendThroughStartOf.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/modifiers/inferPreviousMark.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/modifiers/interiorOnly.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/modifiers/keepContentFilter.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/modifiers/keepEmptyFilter.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/modifiers/leading.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/modifiers/ordinalScope.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/modifiers/relativeScope.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/modifiers/startOf.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/modifiers/toRawSelection.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/modifiers/trailing.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/modifiers/visible.mdx rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/README.md (100%) create mode 100644 packages/app-web-docs/src/docs/user/reference/scopes/_category_.json rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/anonymousFunction.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/argumentList.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/argumentOrParameter.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/attribute.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/boundedNonWhitespaceSequence.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/boundedParagraph.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/branch.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/character.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/class.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/className.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/collectionItem.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/collectionKey.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/command.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/comment.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/components/Scopes.tsx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/condition.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/disqualifyDelimiter.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/document.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/environment.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/fieldAccess.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/fullLine.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/functionCall.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/functionCallee.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/functionName.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/identifier.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/ifStatement.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/interior.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/line.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/list.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/map.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/name.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/namedFunction.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/nonWhitespaceSequence.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/notebookCell.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/pairDelimiter.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/paragraph.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/regularExpression.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/section.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/selector.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/sentence.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/statement.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/string.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/surroundingPair.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/surroundingPairInterior.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/textFragment.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/token.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/type.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/unit.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/url.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/value.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/word.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/xmlBothTags.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/xmlElement.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/xmlEndTag.mdx (100%) rename packages/app-web-docs/src/docs/{contributing => user/reference}/scopes/xmlStartTag.mdx (100%) diff --git a/packages/app-web-docs/src/docs/user/reference/actions/editNew.mdx b/packages/app-web-docs/src/docs/user/reference/actions/editNew.mdx deleted file mode 100644 index b7ec3f0d4e..0000000000 --- a/packages/app-web-docs/src/docs/user/reference/actions/editNew.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { ActionReference } from "../components/ReferenceEntry"; - -# Edit new - - diff --git a/packages/app-web-docs/src/docs/user/reference/actions/executeCommand.mdx b/packages/app-web-docs/src/docs/user/reference/actions/executeCommand.mdx deleted file mode 100644 index 567ce4ae66..0000000000 --- a/packages/app-web-docs/src/docs/user/reference/actions/executeCommand.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { ActionReference } from "../components/ReferenceEntry"; - -# Execute command - - diff --git a/packages/app-web-docs/src/docs/user/reference/actions/getText.mdx b/packages/app-web-docs/src/docs/user/reference/actions/getText.mdx deleted file mode 100644 index 2bf91f457c..0000000000 --- a/packages/app-web-docs/src/docs/user/reference/actions/getText.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { ActionReference } from "../components/ReferenceEntry"; - -# Get text - - diff --git a/packages/app-web-docs/src/docs/user/reference/actions/parsed.mdx b/packages/app-web-docs/src/docs/user/reference/actions/parsed.mdx deleted file mode 100644 index e556e5066e..0000000000 --- a/packages/app-web-docs/src/docs/user/reference/actions/parsed.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { ActionReference } from "../components/ReferenceEntry"; - -# Parsed - - diff --git a/packages/app-web-docs/src/docs/user/reference/actions/private.getTargets.mdx b/packages/app-web-docs/src/docs/user/reference/actions/private.getTargets.mdx deleted file mode 100644 index 8a83a424b4..0000000000 --- a/packages/app-web-docs/src/docs/user/reference/actions/private.getTargets.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { ActionReference } from "../components/ReferenceEntry"; - -# Get targets - - diff --git a/packages/app-web-docs/src/docs/user/reference/actions/private.setKeyboardTarget.mdx b/packages/app-web-docs/src/docs/user/reference/actions/private.setKeyboardTarget.mdx deleted file mode 100644 index 90c98e45d6..0000000000 --- a/packages/app-web-docs/src/docs/user/reference/actions/private.setKeyboardTarget.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { ActionReference } from "../components/ReferenceEntry"; - -# Set keyboard target - - diff --git a/packages/app-web-docs/src/docs/user/reference/actions/private.showParseTree.mdx b/packages/app-web-docs/src/docs/user/reference/actions/private.showParseTree.mdx deleted file mode 100644 index 93b5881d5c..0000000000 --- a/packages/app-web-docs/src/docs/user/reference/actions/private.showParseTree.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { ActionReference } from "../components/ReferenceEntry"; - -# Show parse tree - - diff --git a/packages/app-web-docs/src/docs/user/reference/actions/replace.mdx b/packages/app-web-docs/src/docs/user/reference/actions/replace.mdx deleted file mode 100644 index b09be94de0..0000000000 --- a/packages/app-web-docs/src/docs/user/reference/actions/replace.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { ActionReference } from "../components/ReferenceEntry"; - -# Replace - - 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..c8ddc82ff3 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/ancestor.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "../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..ce6da947c6 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/containingScope.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "../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..d72f6af842 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/endOf.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "../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..de5b6b526b --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/everyScope.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "../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..bd5d1eee7b --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/excludeInterior.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "../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..0e5c190b13 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/extendThroughEndOf.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "../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..ec93298d50 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/extendThroughStartOf.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "../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..f86ec0e380 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/inferPreviousMark.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "../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..b3f2e89937 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/interiorOnly.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "../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..e0ebc520ba --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/keepContentFilter.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "../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..9ff3397f2b --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/keepEmptyFilter.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "../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..f980a36b8f --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/leading.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "../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..66b3e1836e --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/ordinalScope.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "../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..b43aea08d2 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/relativeScope.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "../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..d893d80fe6 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/startOf.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "../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..ff544bcb93 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/toRawSelection.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "../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..addd985610 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/trailing.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "../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..d0d11a8e10 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/visible.mdx @@ -0,0 +1,5 @@ +import { ModifierReference } from "../components/ReferenceEntry"; + +# Visible + + diff --git a/packages/app-web-docs/src/docs/contributing/scopes/README.md b/packages/app-web-docs/src/docs/user/reference/scopes/README.md similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/README.md rename to packages/app-web-docs/src/docs/user/reference/scopes/README.md 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/contributing/scopes/anonymousFunction.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/anonymousFunction.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/anonymousFunction.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/anonymousFunction.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/argumentList.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/argumentList.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/argumentList.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/argumentList.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/argumentOrParameter.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/argumentOrParameter.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/argumentOrParameter.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/argumentOrParameter.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/attribute.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/attribute.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/attribute.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/attribute.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/boundedNonWhitespaceSequence.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/boundedNonWhitespaceSequence.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/boundedNonWhitespaceSequence.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/boundedNonWhitespaceSequence.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/boundedParagraph.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/boundedParagraph.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/boundedParagraph.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/boundedParagraph.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/branch.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/branch.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/branch.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/branch.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/character.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/character.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/character.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/character.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/class.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/class.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/class.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/class.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/className.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/className.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/className.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/className.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/collectionItem.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/collectionItem.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/collectionItem.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/collectionItem.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/collectionKey.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/collectionKey.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/collectionKey.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/collectionKey.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/command.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/command.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/command.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/command.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/comment.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/comment.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/comment.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/comment.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/components/Scopes.tsx b/packages/app-web-docs/src/docs/user/reference/scopes/components/Scopes.tsx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/components/Scopes.tsx rename to packages/app-web-docs/src/docs/user/reference/scopes/components/Scopes.tsx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/condition.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/condition.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/condition.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/condition.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/disqualifyDelimiter.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/disqualifyDelimiter.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/disqualifyDelimiter.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/disqualifyDelimiter.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/document.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/document.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/document.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/document.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/environment.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/environment.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/environment.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/environment.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/fieldAccess.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/fieldAccess.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/fieldAccess.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/fieldAccess.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/fullLine.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/fullLine.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/fullLine.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/fullLine.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/functionCall.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/functionCall.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/functionCall.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/functionCall.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/functionCallee.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/functionCallee.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/functionCallee.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/functionCallee.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/functionName.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/functionName.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/functionName.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/functionName.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/identifier.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/identifier.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/identifier.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/identifier.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/ifStatement.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/ifStatement.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/ifStatement.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/ifStatement.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/interior.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/interior.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/interior.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/interior.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/line.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/line.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/line.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/line.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/list.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/list.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/list.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/list.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/map.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/map.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/map.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/map.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/name.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/name.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/name.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/name.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/namedFunction.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/namedFunction.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/namedFunction.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/namedFunction.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/nonWhitespaceSequence.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/nonWhitespaceSequence.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/nonWhitespaceSequence.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/nonWhitespaceSequence.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/notebookCell.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/notebookCell.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/notebookCell.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/notebookCell.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/pairDelimiter.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/pairDelimiter.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/pairDelimiter.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/pairDelimiter.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/paragraph.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/paragraph.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/paragraph.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/paragraph.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/regularExpression.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/regularExpression.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/regularExpression.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/regularExpression.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/section.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/section.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/section.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/section.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/selector.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/selector.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/selector.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/selector.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/sentence.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/sentence.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/sentence.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/sentence.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/statement.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/statement.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/statement.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/statement.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/string.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/string.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/string.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/string.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/surroundingPair.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/surroundingPair.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/surroundingPair.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/surroundingPair.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/surroundingPairInterior.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/surroundingPairInterior.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/surroundingPairInterior.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/surroundingPairInterior.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/textFragment.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/textFragment.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/textFragment.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/textFragment.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/token.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/token.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/token.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/token.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/type.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/type.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/type.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/type.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/unit.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/unit.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/unit.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/unit.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/url.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/url.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/url.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/url.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/value.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/value.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/value.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/value.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/word.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/word.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/word.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/word.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/xmlBothTags.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/xmlBothTags.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/xmlBothTags.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/xmlBothTags.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/xmlElement.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/xmlElement.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/xmlElement.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/xmlElement.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/xmlEndTag.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/xmlEndTag.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/xmlEndTag.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/xmlEndTag.mdx diff --git a/packages/app-web-docs/src/docs/contributing/scopes/xmlStartTag.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/xmlStartTag.mdx similarity index 100% rename from packages/app-web-docs/src/docs/contributing/scopes/xmlStartTag.mdx rename to packages/app-web-docs/src/docs/user/reference/scopes/xmlStartTag.mdx diff --git a/packages/lib-common/src/references/actionReferences.ts b/packages/lib-common/src/references/actionReferences.ts index f2c3f00f50..7db9b94899 100644 --- a/packages/lib-common/src/references/actionReferences.ts +++ b/packages/lib-common/src/references/actionReferences.ts @@ -843,7 +843,8 @@ export const actionReferences: Record< examples: [], }, - // Private actions, but that has spoken forms + // Private actions -------------------- + "private.showParseTree": { name: "Show parse tree", defaultSpokenForm: "parse tree", @@ -857,8 +858,6 @@ export const actionReferences: Record< ], examples: [], }, - - // Actions without spoken forms parsed: { name: "Parsed", defaultSpokenForm: "parsed", diff --git a/packages/tool-meta-updater/src/metaUpdater.ts b/packages/tool-meta-updater/src/metaUpdater.ts index fe05d278e1..df31c42525 100644 --- a/packages/tool-meta-updater/src/metaUpdater.ts +++ b/packages/tool-meta-updater/src/metaUpdater.ts @@ -52,13 +52,13 @@ export const updater = async (workspaceDir: string) => { ...Object.fromEntries( Object.entries(actionReferences).map(([id, entry]) => [ `${referenceDir}/actions/${id}.mdx`, - updateReferenceMdx.bind(null, "action", id, entry.name), + updateReferenceMdx.bind(null, "action", id, entry), ]), ), ...Object.fromEntries( Object.entries(modifierReferences).map(([id, entry]) => [ `${referenceDir}/modifiers/${id}.mdx`, - updateReferenceMdx.bind(null, "modifier", id, entry.name), + updateReferenceMdx.bind(null, "modifier", id, entry), ]), ), ...Object.fromEntries( diff --git a/packages/tool-meta-updater/src/updateReferenceMdx.ts b/packages/tool-meta-updater/src/updateReferenceMdx.ts index 1ca40f43b4..a2ccd5a30e 100644 --- a/packages/tool-meta-updater/src/updateReferenceMdx.ts +++ b/packages/tool-meta-updater/src/updateReferenceMdx.ts @@ -1,26 +1,23 @@ import type { FormatPluginFnOptions } from "@pnpm/meta-updater"; +import type { ReferenceEntry } from "@cursorless/lib-common"; export function updateReferenceMdx( kind: "action" | "modifier" | "scope", id: string, - name: string, + entry: ReferenceEntry, actual: string | null, options: FormatPluginFnOptions, ): string | null { - if (options.manifest.name !== "@cursorless/app-web-docs") { + if (options.manifest.name !== "@cursorless/app-web-docs" || entry.private) { return null; } - if (actual != null) { - return actual; - } - const importName = `${kind.charAt(0).toUpperCase() + kind.slice(1)}Reference`; const expected = ` import { ${importName} } from "../components/ReferenceEntry"; -# ${name} +# ${entry.name} <${importName} id="${id}" /> `.trimStart(); From 3039756e8ab575d41119976f5369a477ba1f3bd9 Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Thu, 27 Aug 2026 16:12:25 +0200 Subject: [PATCH 06/16] Combined reference and scope viewer --- .../{scopes => }/components/Scopes.tsx | 0 .../src/docs/user/reference/scopes/README.md | 3 - .../reference/scopes/anonymousFunction.mdx | 4 +- .../user/reference/scopes/argumentList.mdx | 4 +- .../reference/scopes/argumentOrParameter.mdx | 4 +- .../docs/user/reference/scopes/attribute.mdx | 4 +- .../scopes/boundedNonWhitespaceSequence.mdx | 4 +- .../reference/scopes/boundedParagraph.mdx | 4 +- .../src/docs/user/reference/scopes/branch.mdx | 4 +- .../docs/user/reference/scopes/character.mdx | 4 +- .../src/docs/user/reference/scopes/class.mdx | 4 +- .../docs/user/reference/scopes/className.mdx | 4 +- .../user/reference/scopes/collectionItem.mdx | 4 +- .../user/reference/scopes/collectionKey.mdx | 4 +- .../docs/user/reference/scopes/command.mdx | 4 +- .../docs/user/reference/scopes/comment.mdx | 4 +- .../docs/user/reference/scopes/condition.mdx | 4 +- .../docs/user/reference/scopes/document.mdx | 4 +- .../user/reference/scopes/environment.mdx | 4 +- .../docs/user/reference/scopes/fullLine.mdx | 4 +- .../user/reference/scopes/functionCall.mdx | 4 +- .../user/reference/scopes/functionCallee.mdx | 4 +- .../user/reference/scopes/functionName.mdx | 4 +- .../docs/user/reference/scopes/identifier.mdx | 4 +- .../user/reference/scopes/ifStatement.mdx | 4 +- .../src/docs/user/reference/scopes/line.mdx | 4 +- .../src/docs/user/reference/scopes/list.mdx | 4 +- .../src/docs/user/reference/scopes/map.mdx | 4 +- .../src/docs/user/reference/scopes/name.mdx | 4 +- .../user/reference/scopes/namedFunction.mdx | 4 +- .../scopes/nonWhitespaceSequence.mdx | 4 +- .../user/reference/scopes/notebookCell.mdx | 4 +- .../docs/user/reference/scopes/paragraph.mdx | 4 +- .../reference/scopes/regularExpression.mdx | 4 +- .../docs/user/reference/scopes/section.mdx | 4 +- .../docs/user/reference/scopes/selector.mdx | 4 +- .../docs/user/reference/scopes/sentence.mdx | 4 +- .../docs/user/reference/scopes/statement.mdx | 4 +- .../src/docs/user/reference/scopes/token.mdx | 4 +- .../src/docs/user/reference/scopes/type.mdx | 4 +- .../src/docs/user/reference/scopes/unit.mdx | 4 +- .../src/docs/user/reference/scopes/url.mdx | 6 +- .../src/docs/user/reference/scopes/value.mdx | 4 +- .../src/docs/user/reference/scopes/word.mdx | 6 +- .../user/reference/scopes/xmlBothTags.mdx | 6 +- .../docs/user/reference/scopes/xmlElement.mdx | 6 +- .../docs/user/reference/scopes/xmlEndTag.mdx | 6 +- .../user/reference/scopes/xmlStartTag.mdx | 6 +- .../src/references/ReferenceEntry.ts | 1 + .../src/references/scopeReferences.ts | 3 +- packages/tool-meta-updater/src/metaUpdater.ts | 10 +--- .../src/updateReferenceMdx.ts | 34 ++++++++--- .../tool-meta-updater/src/updateScopeMdx.ts | 57 ------------------- 53 files changed, 176 insertions(+), 128 deletions(-) rename packages/app-web-docs/src/docs/user/reference/{scopes => }/components/Scopes.tsx (100%) delete mode 100644 packages/app-web-docs/src/docs/user/reference/scopes/README.md delete mode 100644 packages/tool-meta-updater/src/updateScopeMdx.ts diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/components/Scopes.tsx b/packages/app-web-docs/src/docs/user/reference/components/Scopes.tsx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/scopes/components/Scopes.tsx rename to packages/app-web-docs/src/docs/user/reference/components/Scopes.tsx diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/README.md b/packages/app-web-docs/src/docs/user/reference/scopes/README.md deleted file mode 100644 index 4bb75a0362..0000000000 --- a/packages/app-web-docs/src/docs/user/reference/scopes/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Scopes - -All available scopes in Cursorless 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 index 6ccc0fe7b6..990a3868eb 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/anonymousFunction.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/anonymousFunction.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index 947c2e2068..efa6e14738 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/argumentList.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/argumentList.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index 146580bbe1..295a4db564 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/argumentOrParameter.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/argumentOrParameter.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index 7c56329f83..86922932a8 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/attribute.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/attribute.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index 99cc0c13ae..8ea5713ffa 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/boundedNonWhitespaceSequence.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/boundedNonWhitespaceSequence.mdx @@ -2,8 +2,10 @@ sidebar_label: Bounded non-ws sequence --- -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index b9e1712e4b..72c106af85 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/boundedParagraph.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/boundedParagraph.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index a2f7da013f..13b12dc5c2 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/branch.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/branch.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../components/Scopes"; # Branch + 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 index f79da3f5c1..bbd2cd7604 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/character.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/character.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index cf2e18375b..295f6e1e85 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/class.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/class.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index aa6e0f89c0..a6cdcbfb60 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/className.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/className.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index eee8d072cc..891b760af7 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/collectionItem.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/collectionItem.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index 5bc9407722..f93b4b1ea9 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/collectionKey.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/collectionKey.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index d7f56bbcc6..8a223ab7ef 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/command.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/command.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index 4c5ab96121..1f3450c1f9 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/comment.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/comment.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index bb4668c376..34e581e84a 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/condition.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/condition.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index 234458d3ce..2846ec3727 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/document.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/document.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index b8222d9cc5..298280264c 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/environment.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/environment.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index 8d35c2dbf7..f1ce30bbfe 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/fullLine.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/fullLine.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index 9248c6ec34..beadc4f3a8 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/functionCall.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/functionCall.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index b963a2eec8..f9785ac723 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/functionCallee.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/functionCallee.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index b75bcea216..eb8729012b 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/functionName.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/functionName.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../components/Scopes"; # Function name + 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 index e6ffebd655..4e3be0ead7 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/identifier.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/identifier.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index 9ef12a167d..e534bb30cb 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/ifStatement.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/ifStatement.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../components/Scopes"; # If statement + 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 index a34cd528f2..6507ad7b25 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/line.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/line.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index 25aa097879..bcfb1a4522 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/list.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/list.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index c9c86f258f..8a510be18d 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/map.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/map.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index 43f84e2f24..9b7cb7d7f3 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/name.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/name.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index f9831c341a..c2c3ad0b07 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/namedFunction.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/namedFunction.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../components/Scopes"; # Named function + 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 index ac94d034e1..cca620cf0d 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/nonWhitespaceSequence.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/nonWhitespaceSequence.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index 1eb26f346e..2e8cc6abf2 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/notebookCell.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/notebookCell.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index 64d0396bc6..7d63baf36a 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/paragraph.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/paragraph.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../components/Scopes"; # Paragraph + 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 index 71a186069d..6f593073ce 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/regularExpression.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/regularExpression.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index 57acef3218..ddcbf03c83 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/section.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/section.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../components/Scopes"; # Section + 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 index 160f065b34..2ddac3355d 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/selector.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/selector.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index 6cf99889e5..9e6edce6b0 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/sentence.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/sentence.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index 6ba243d6f6..12fa73adba 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/statement.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/statement.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../components/Scopes"; # Statement + 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 index 5b84085308..fdf866aefd 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/token.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/token.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index 3ee413a1ff..4eb5facd4f 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/type.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/type.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index 934b303146..874563e625 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/unit.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/unit.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index 042f67ef22..d4bcadf238 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/url.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/url.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../components/Scopes"; -# Url +# 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 index 62ed66dbed..d71a5d173b 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/value.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/value.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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 index eba248364a..dd31195ca2 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/word.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/word.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../components/Scopes"; -# Word +# 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 index 75e7c0b706..7ff6aafae2 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/xmlBothTags.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/xmlBothTags.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../components/Scopes"; -# Xml both tags +# 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 index ff83b0bf14..2d521c6efc 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/xmlElement.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/xmlElement.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../components/Scopes"; -# Xml element +# 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 index 1d23978db8..f0cbfc9c1d 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/xmlEndTag.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/xmlEndTag.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../components/Scopes"; -# Xml end tag +# 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 index 5dd9a6244c..d852af3c2c 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/xmlStartTag.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/xmlStartTag.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../components/Scopes"; -# Xml start tag +# XML start tag + diff --git a/packages/lib-common/src/references/ReferenceEntry.ts b/packages/lib-common/src/references/ReferenceEntry.ts index e68536f2ea..a3f23bf6b2 100644 --- a/packages/lib-common/src/references/ReferenceEntry.ts +++ b/packages/lib-common/src/references/ReferenceEntry.ts @@ -6,6 +6,7 @@ export interface SpokenFormReference { export interface ReferenceEntry extends SpokenFormReference { name: string; + nameShort?: string; legacySpokenForms?: string[]; description?: string; syntaxes: SyntaxDefinition[]; diff --git a/packages/lib-common/src/references/scopeReferences.ts b/packages/lib-common/src/references/scopeReferences.ts index 1b49c36b2f..c4548db077 100644 --- a/packages/lib-common/src/references/scopeReferences.ts +++ b/packages/lib-common/src/references/scopeReferences.ts @@ -10,7 +10,7 @@ export const scopeReferences: Record< ReferenceEntry > = { argumentOrParameter: { - name: "Argument", + name: "Argument or parameter", defaultSpokenForm: "arg", syntaxes: [ { @@ -704,6 +704,7 @@ export const scopeReferences: Record< }, boundedNonWhitespaceSequence: { name: "Bounded non-whitespace sequence", + nameShort: "Bounded non-ws sequence", defaultSpokenForm: "short paint", syntaxes: [ { diff --git a/packages/tool-meta-updater/src/metaUpdater.ts b/packages/tool-meta-updater/src/metaUpdater.ts index df31c42525..9ace8e245e 100644 --- a/packages/tool-meta-updater/src/metaUpdater.ts +++ b/packages/tool-meta-updater/src/metaUpdater.ts @@ -2,6 +2,7 @@ // 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 { @@ -15,7 +16,6 @@ import { textFormat } from "./textFormat"; import { updateLanguageMdx } from "./updateLanguageMdx"; import { updatePackageJson } from "./updatePackageJson"; import { updateReferenceMdx } from "./updateReferenceMdx"; -import { getScopeTypeTypes, updateScopeMdx } from "./updateScopeMdx"; import { updatesScopeSupportFacetInfos } from "./updatesScopeSupportFacetInfos"; import { updateTSConfig } from "./updateTSConfig"; import { updateTSConfigBase } from "./updateTSConfigBase"; @@ -64,13 +64,7 @@ export const updater = async (workspaceDir: string) => { ...Object.fromEntries( Object.entries(scopeReferences).map(([id, entry]) => [ `${referenceDir}/scopes/${id}.mdx`, - updateReferenceMdx.bind(null, "scope", id, entry.name), - ]), - ), - ...Object.fromEntries( - getScopeTypeTypes().map(({ scopeTypeType, name }) => [ - `src/docs/contributing/scopes/${scopeTypeType.replace("private.", "")}.mdx`, - updateScopeMdx.bind(null, scopeTypeType, name), + updateReferenceMdx.bind(null, "scope", id, entry), ]), ), }, diff --git a/packages/tool-meta-updater/src/updateReferenceMdx.ts b/packages/tool-meta-updater/src/updateReferenceMdx.ts index a2ccd5a30e..904ff8d1a4 100644 --- a/packages/tool-meta-updater/src/updateReferenceMdx.ts +++ b/packages/tool-meta-updater/src/updateReferenceMdx.ts @@ -12,15 +12,35 @@ export function updateReferenceMdx( return null; } - const importName = `${kind.charAt(0).toUpperCase() + kind.slice(1)}Reference`; + const refComponentName = `${kind.charAt(0).toUpperCase() + kind.slice(1)}Reference`; + const isScope = kind === "scope"; - const expected = ` -import { ${importName} } from "../components/ReferenceEntry"; + const expected: string[] = []; -# ${entry.name} + if (entry.nameShort != null) { + expected.push(`---`, `sidebar_label: ${entry.nameShort}`, `---`, ""); + } + + expected.push( + `import { ${refComponentName} } from "../components/ReferenceEntry";`, + ); + + if (isScope) { + expected.push(`import { Scopes } from "../components/Scopes";`); + } + + expected.push( + "", + `# ${entry.name}`, + "", + `<${refComponentName} id="${id}" />`, + ); + + if (isScope) { + expected.push(``); + } -<${importName} id="${id}" /> -`.trimStart(); + expected.push(""); - return expected; + 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; -} From 3ef2adf23e3702fd76bed637b18692b8d949545a Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Thu, 27 Aug 2026 16:49:09 +0200 Subject: [PATCH 07/16] Add new scope mdx files --- .../user/reference/components/ReferenceEntry.tsx | 6 ++++++ .../src/docs/user/reference/scopes/chapter.mdx | 7 +++++++ .../src/docs/user/reference/scopes/glyph.mdx | 7 +++++++ .../src/docs/user/reference/scopes/instance.mdx | 7 +++++++ .../docs/user/reference/scopes/namedParagraph.mdx | 7 +++++++ .../src/docs/user/reference/scopes/pair.mdx | 7 +++++++ .../src/docs/user/reference/scopes/part.mdx | 7 +++++++ .../docs/user/reference/scopes/sectionLevelFive.mdx | 7 +++++++ .../docs/user/reference/scopes/sectionLevelFour.mdx | 7 +++++++ .../docs/user/reference/scopes/sectionLevelOne.mdx | 7 +++++++ .../docs/user/reference/scopes/sectionLevelSix.mdx | 7 +++++++ .../user/reference/scopes/sectionLevelThree.mdx | 7 +++++++ .../docs/user/reference/scopes/sectionLevelTwo.mdx | 7 +++++++ .../src/docs/user/reference/scopes/subParagraph.mdx | 7 +++++++ .../src/docs/user/reference/scopes/subSection.mdx | 7 +++++++ .../docs/user/reference/scopes/subSubSection.mdx | 7 +++++++ .../lib-common/src/references/scopeReferences.ts | 13 +------------ 17 files changed, 112 insertions(+), 12 deletions(-) create mode 100644 packages/app-web-docs/src/docs/user/reference/scopes/chapter.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/scopes/glyph.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/scopes/instance.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/scopes/namedParagraph.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/scopes/pair.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/scopes/part.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelFive.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelFour.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelOne.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelSix.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelThree.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelTwo.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/scopes/subParagraph.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/scopes/subSection.mdx create mode 100644 packages/app-web-docs/src/docs/user/reference/scopes/subSubSection.mdx diff --git a/packages/app-web-docs/src/docs/user/reference/components/ReferenceEntry.tsx b/packages/app-web-docs/src/docs/user/reference/components/ReferenceEntry.tsx index 00e931bb8b..c1d5b5cbb7 100644 --- a/packages/app-web-docs/src/docs/user/reference/components/ReferenceEntry.tsx +++ b/packages/app-web-docs/src/docs/user/reference/components/ReferenceEntry.tsx @@ -55,6 +55,12 @@ function ReferenceEntryComponent({

)} + {entry.disabledByDefault && ( +

+ Disabled by default +

+ )} + {entry.syntaxes.length > 0 && (
    {entry.syntaxes.map((syntax, index) => ( 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..67417470dc --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/chapter.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../components/Scopes"; + +# Chapter + + + 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..5161ae797b --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/glyph.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../components/Scopes"; + +# Glyph + + + 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..cfdd79d7e4 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/instance.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../components/Scopes"; + +# Instance + + + 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..99431ccdbe --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/namedParagraph.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../components/Scopes"; + +# Named paragraph + + + diff --git a/packages/app-web-docs/src/docs/user/reference/scopes/pair.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/pair.mdx new file mode 100644 index 0000000000..5d5c1b8283 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/pair.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../components/Scopes"; + +# Paired delimiters + + + 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..852986232d --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/part.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../components/Scopes"; + +# Part + + + 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..4c7f93dcea --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelFive.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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..42e9068e3a --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelFour.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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..56e64d732c --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelOne.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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..9fc09928f4 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelSix.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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..d316f1e5bb --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelThree.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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..2dd8d89e8c --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelTwo.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../components/Scopes"; + +# Section level two + + + 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..00d0416ce5 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/subParagraph.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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..1863c326cb --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/subSection.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../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..61cf816c13 --- /dev/null +++ b/packages/app-web-docs/src/docs/user/reference/scopes/subSubSection.mdx @@ -0,0 +1,7 @@ +import { ScopeReference } from "../components/ReferenceEntry"; +import { Scopes } from "../components/Scopes"; + +# Subsubsection + + + diff --git a/packages/lib-common/src/references/scopeReferences.ts b/packages/lib-common/src/references/scopeReferences.ts index c4548db077..2cb3dfd8a2 100644 --- a/packages/lib-common/src/references/scopeReferences.ts +++ b/packages/lib-common/src/references/scopeReferences.ts @@ -3,7 +3,7 @@ import type { ReferenceEntry } from "./ReferenceEntry"; const DEFAULT_PATTERN = ""; -type AdditionalScopeReferenceType = "glyph" | "pair"; +type AdditionalScopeReferenceType = "glyph"; export const scopeReferences: Record< SimpleScopeTypeType | AdditionalScopeReferenceType, @@ -817,15 +817,4 @@ export const scopeReferences: Record< ], examples: [], }, - pair: { - name: "Paired delimiters", - syntaxes: [ - { - pattern: "", - description: "Paired delimiters", - cheatsheet: "Paired delimiters", - }, - ], - examples: [], - }, }; From 5dbca486d8c34916d0d03519f3f2960224afd205 Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Thu, 27 Aug 2026 17:49:25 +0200 Subject: [PATCH 08/16] Added private scopes to contributing --- .../components/ReferenceEntry.tsx | 0 .../src/docs/components/ScopeVisualizer.tsx | 14 +-- .../reference => }/components/Scopes.tsx | 6 +- .../app-web-docs/src/docs/components/util.ts | 14 --- .../privateScopes/_category_.json | 3 + .../privateScopes/customRegex.mdx | 5 + .../privateScopes}/disqualifyDelimiter.mdx | 2 +- .../privateScopes/fieldAccess.mdx | 5 + .../contributing/privateScopes/interior.mdx | 5 + .../privateScopes}/pairDelimiter.mdx | 2 +- .../contributing/privateScopes/string.mdx | 5 + .../surroundingPairInterior.mdx | 2 +- .../privateScopes/textFragment.mdx | 5 + .../user/reference/actions/addSelection.mdx | 2 +- .../reference/actions/addSelectionAfter.mdx | 2 +- .../reference/actions/addSelectionBefore.mdx | 2 +- .../user/reference/actions/applyFormatter.mdx | 2 +- .../docs/user/reference/actions/breakLine.mdx | 2 +- .../user/reference/actions/callAsFunction.mdx | 2 +- .../actions/clearAndSetSelection.mdx | 2 +- .../reference/actions/copyToClipboard.mdx | 2 +- .../user/reference/actions/cutToClipboard.mdx | 2 +- .../docs/user/reference/actions/decrement.mdx | 2 +- .../docs/user/reference/actions/deselect.mdx | 2 +- .../reference/actions/editNewLineAfter.mdx | 2 +- .../reference/actions/editNewLineBefore.mdx | 2 +- .../reference/actions/extractVariable.mdx | 2 +- .../user/reference/actions/findInDocument.mdx | 2 +- .../reference/actions/findInWorkspace.mdx | 2 +- .../user/reference/actions/flashTargets.mdx | 2 +- .../user/reference/actions/foldRegion.mdx | 2 +- .../user/reference/actions/followLink.mdx | 2 +- .../reference/actions/followLinkAside.mdx | 2 +- .../reference/actions/generateSnippet.mdx | 2 +- .../docs/user/reference/actions/gitAccept.mdx | 2 +- .../docs/user/reference/actions/gitRevert.mdx | 2 +- .../docs/user/reference/actions/gitStage.mdx | 2 +- .../user/reference/actions/gitUnstage.mdx | 2 +- .../docs/user/reference/actions/highlight.mdx | 2 +- .../docs/user/reference/actions/increment.mdx | 2 +- .../user/reference/actions/indentLine.mdx | 2 +- .../reference/actions/insertCopyAfter.mdx | 2 +- .../reference/actions/insertCopyBefore.mdx | 2 +- .../actions/insertEmptyLineAfter.mdx | 2 +- .../actions/insertEmptyLineBefore.mdx | 2 +- .../actions/insertEmptyLinesAround.mdx | 2 +- .../user/reference/actions/insertSnippet.mdx | 2 +- .../docs/user/reference/actions/joinLines.mdx | 2 +- .../user/reference/actions/moveToTarget.mdx | 2 +- .../user/reference/actions/nextHomophone.mdx | 2 +- .../user/reference/actions/outdentLine.mdx | 2 +- .../reference/actions/pasteFromClipboard.mdx | 2 +- .../reference/actions/randomizeTargets.mdx | 2 +- .../docs/user/reference/actions/remove.mdx | 2 +- .../docs/user/reference/actions/rename.mdx | 2 +- .../reference/actions/replaceWithTarget.mdx | 2 +- .../reference/actions/revealDefinition.mdx | 2 +- .../actions/revealTypeDefinition.mdx | 2 +- .../user/reference/actions/reverseTargets.mdx | 2 +- .../actions/rewrapWithPairedDelimiter.mdx | 2 +- .../user/reference/actions/scrollToBottom.mdx | 2 +- .../user/reference/actions/scrollToCenter.mdx | 2 +- .../user/reference/actions/scrollToTop.mdx | 2 +- ...Reference.mdx => setInstanceReference.mdx} | 2 +- .../user/reference/actions/setSelection.mdx | 2 +- .../reference/actions/setSelectionAfter.mdx | 2 +- .../reference/actions/setSelectionBefore.mdx | 2 +- .../user/reference/actions/showDebugHover.mdx | 2 +- .../docs/user/reference/actions/showHover.mdx | 2 +- .../user/reference/actions/showQuickFix.mdx | 2 +- .../user/reference/actions/showReferences.mdx | 2 +- .../user/reference/actions/sortTargets.mdx | 2 +- .../user/reference/actions/swapTargets.mdx | 2 +- .../actions/toggleLineBreakpoint.mdx | 2 +- .../reference/actions/toggleLineComment.mdx | 2 +- .../user/reference/actions/unfoldRegion.mdx | 2 +- .../actions/wrapWithPairedDelimiter.mdx | 2 +- .../reference/actions/wrapWithSnippet.mdx | 2 +- .../user/reference/modifiers/ancestor.mdx | 2 +- .../reference/modifiers/containingScope.mdx | 2 +- .../docs/user/reference/modifiers/endOf.mdx | 2 +- .../user/reference/modifiers/everyScope.mdx | 2 +- .../reference/modifiers/excludeInterior.mdx | 2 +- .../modifiers/extendThroughEndOf.mdx | 2 +- .../modifiers/extendThroughStartOf.mdx | 2 +- .../reference/modifiers/inferPreviousMark.mdx | 2 +- .../user/reference/modifiers/interiorOnly.mdx | 2 +- .../reference/modifiers/keepContentFilter.mdx | 2 +- .../reference/modifiers/keepEmptyFilter.mdx | 2 +- .../docs/user/reference/modifiers/leading.mdx | 2 +- .../user/reference/modifiers/ordinalScope.mdx | 2 +- .../reference/modifiers/relativeScope.mdx | 2 +- .../docs/user/reference/modifiers/startOf.mdx | 2 +- .../reference/modifiers/toRawSelection.mdx | 2 +- .../user/reference/modifiers/trailing.mdx | 2 +- .../docs/user/reference/modifiers/visible.mdx | 2 +- .../reference/scopes/anonymousFunction.mdx | 4 +- .../user/reference/scopes/argumentList.mdx | 4 +- .../reference/scopes/argumentOrParameter.mdx | 4 +- .../docs/user/reference/scopes/attribute.mdx | 4 +- .../scopes/boundedNonWhitespaceSequence.mdx | 4 +- .../reference/scopes/boundedParagraph.mdx | 4 +- .../src/docs/user/reference/scopes/branch.mdx | 4 +- .../docs/user/reference/scopes/chapter.mdx | 4 +- .../docs/user/reference/scopes/character.mdx | 4 +- .../src/docs/user/reference/scopes/class.mdx | 4 +- .../docs/user/reference/scopes/className.mdx | 4 +- .../user/reference/scopes/collectionItem.mdx | 4 +- .../user/reference/scopes/collectionKey.mdx | 4 +- .../docs/user/reference/scopes/command.mdx | 4 +- .../docs/user/reference/scopes/comment.mdx | 4 +- .../docs/user/reference/scopes/condition.mdx | 4 +- .../docs/user/reference/scopes/document.mdx | 4 +- .../user/reference/scopes/environment.mdx | 4 +- .../user/reference/scopes/fieldAccess.mdx | 7 -- .../docs/user/reference/scopes/fullLine.mdx | 4 +- .../user/reference/scopes/functionCall.mdx | 4 +- .../user/reference/scopes/functionCallee.mdx | 4 +- .../user/reference/scopes/functionName.mdx | 4 +- .../src/docs/user/reference/scopes/glyph.mdx | 4 +- .../docs/user/reference/scopes/identifier.mdx | 4 +- .../user/reference/scopes/ifStatement.mdx | 4 +- .../docs/user/reference/scopes/instance.mdx | 4 +- .../docs/user/reference/scopes/interior.mdx | 5 - .../src/docs/user/reference/scopes/line.mdx | 4 +- .../src/docs/user/reference/scopes/list.mdx | 4 +- .../src/docs/user/reference/scopes/map.mdx | 4 +- .../src/docs/user/reference/scopes/name.mdx | 4 +- .../user/reference/scopes/namedFunction.mdx | 4 +- .../user/reference/scopes/namedParagraph.mdx | 4 +- .../scopes/nonWhitespaceSequence.mdx | 4 +- .../user/reference/scopes/notebookCell.mdx | 4 +- .../src/docs/user/reference/scopes/pair.mdx | 7 -- .../docs/user/reference/scopes/paragraph.mdx | 4 +- .../src/docs/user/reference/scopes/part.mdx | 4 +- .../reference/scopes/regularExpression.mdx | 4 +- .../docs/user/reference/scopes/section.mdx | 4 +- .../reference/scopes/sectionLevelFive.mdx | 4 +- .../reference/scopes/sectionLevelFour.mdx | 4 +- .../user/reference/scopes/sectionLevelOne.mdx | 4 +- .../user/reference/scopes/sectionLevelSix.mdx | 4 +- .../reference/scopes/sectionLevelThree.mdx | 4 +- .../user/reference/scopes/sectionLevelTwo.mdx | 4 +- .../docs/user/reference/scopes/selector.mdx | 4 +- .../docs/user/reference/scopes/sentence.mdx | 4 +- .../docs/user/reference/scopes/statement.mdx | 4 +- .../src/docs/user/reference/scopes/string.mdx | 5 - .../user/reference/scopes/subParagraph.mdx | 4 +- .../docs/user/reference/scopes/subSection.mdx | 4 +- .../user/reference/scopes/subSubSection.mdx | 4 +- .../user/reference/scopes/surroundingPair.mdx | 4 +- .../user/reference/scopes/textFragment.mdx | 5 - .../src/docs/user/reference/scopes/token.mdx | 4 +- .../src/docs/user/reference/scopes/type.mdx | 4 +- .../src/docs/user/reference/scopes/unit.mdx | 4 +- .../src/docs/user/reference/scopes/url.mdx | 4 +- .../src/docs/user/reference/scopes/value.mdx | 4 +- .../src/docs/user/reference/scopes/word.mdx | 4 +- .../user/reference/scopes/xmlBothTags.mdx | 4 +- .../docs/user/reference/scopes/xmlElement.mdx | 4 +- .../docs/user/reference/scopes/xmlEndTag.mdx | 4 +- .../user/reference/scopes/xmlStartTag.mdx | 4 +- .../src/references/scopeReferences.ts | 107 +++++++++++------- packages/tool-meta-updater/src/metaUpdater.ts | 23 +++- .../src/updatePrivateScopeMdx.ts | 23 ++++ .../src/updateReferenceMdx.ts | 4 +- 166 files changed, 354 insertions(+), 310 deletions(-) rename packages/app-web-docs/src/docs/{user/reference => }/components/ReferenceEntry.tsx (100%) rename packages/app-web-docs/src/docs/{user/reference => }/components/Scopes.tsx (62%) create mode 100644 packages/app-web-docs/src/docs/contributing/privateScopes/_category_.json create mode 100644 packages/app-web-docs/src/docs/contributing/privateScopes/customRegex.mdx rename packages/app-web-docs/src/docs/{user/reference/scopes => contributing/privateScopes}/disqualifyDelimiter.mdx (54%) create mode 100644 packages/app-web-docs/src/docs/contributing/privateScopes/fieldAccess.mdx create mode 100644 packages/app-web-docs/src/docs/contributing/privateScopes/interior.mdx rename packages/app-web-docs/src/docs/{user/reference/scopes => contributing/privateScopes}/pairDelimiter.mdx (50%) create mode 100644 packages/app-web-docs/src/docs/contributing/privateScopes/string.mdx rename packages/app-web-docs/src/docs/{user/reference/scopes => contributing/privateScopes}/surroundingPairInterior.mdx (57%) create mode 100644 packages/app-web-docs/src/docs/contributing/privateScopes/textFragment.mdx rename packages/app-web-docs/src/docs/user/reference/actions/{experimental.setInstanceReference.mdx => setInstanceReference.mdx} (53%) delete mode 100644 packages/app-web-docs/src/docs/user/reference/scopes/fieldAccess.mdx delete mode 100644 packages/app-web-docs/src/docs/user/reference/scopes/interior.mdx delete mode 100644 packages/app-web-docs/src/docs/user/reference/scopes/pair.mdx delete mode 100644 packages/app-web-docs/src/docs/user/reference/scopes/string.mdx delete mode 100644 packages/app-web-docs/src/docs/user/reference/scopes/textFragment.mdx create mode 100644 packages/tool-meta-updater/src/updatePrivateScopeMdx.ts diff --git a/packages/app-web-docs/src/docs/user/reference/components/ReferenceEntry.tsx b/packages/app-web-docs/src/docs/components/ReferenceEntry.tsx similarity index 100% rename from packages/app-web-docs/src/docs/user/reference/components/ReferenceEntry.tsx rename to packages/app-web-docs/src/docs/components/ReferenceEntry.tsx 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/user/reference/components/Scopes.tsx b/packages/app-web-docs/src/docs/components/Scopes.tsx similarity index 62% rename from packages/app-web-docs/src/docs/user/reference/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/user/reference/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/user/reference/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/user/reference/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/user/reference/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/user/reference/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/user/reference/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/user/reference/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/user/reference/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/user/reference/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/user/reference/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/user/reference/actions/addSelection.mdx b/packages/app-web-docs/src/docs/user/reference/actions/addSelection.mdx index 3863f2a0ef..1e332101a3 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/addSelection.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/addSelection.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index faa1c0fb77..6b51984db0 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/addSelectionAfter.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/addSelectionAfter.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 3b7f44f0e5..f6c5ce8c6a 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/addSelectionBefore.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/addSelectionBefore.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index a433be0622..c329bc9310 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/applyFormatter.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/applyFormatter.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 1666276553..ab71fb4059 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/breakLine.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/breakLine.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 1562096abc..a36b450884 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/callAsFunction.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/callAsFunction.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 235e138624..782aa36fd4 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/clearAndSetSelection.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/clearAndSetSelection.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 99e90a756c..ab83454d85 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/copyToClipboard.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/copyToClipboard.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index a2d06361d7..b10138052e 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/cutToClipboard.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/cutToClipboard.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index fad7b5e3fe..f60ba30cb8 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/decrement.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/decrement.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index ae2af3504c..4182c83fc5 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/deselect.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/deselect.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index b4842017fc..a217ebb305 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/editNewLineAfter.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/editNewLineAfter.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index e2ebb5d3ee..3e601927ca 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/editNewLineBefore.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/editNewLineBefore.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 5d1d6689d7..a78d9e883c 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/extractVariable.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/extractVariable.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 00dc0a4613..af3fba0d0e 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/findInDocument.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/findInDocument.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 894679195e..a6b01ed9b0 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/findInWorkspace.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/findInWorkspace.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 2bc25a7f9f..450fc11c46 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/flashTargets.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/flashTargets.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index f97164c17f..d41be0ddd3 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/foldRegion.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/foldRegion.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index b411d4831f..b5a666af3b 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/followLink.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/followLink.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 454dc21bfc..9433cc795e 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/followLinkAside.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/followLinkAside.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 55378b5879..657dd5d6f7 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/generateSnippet.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/generateSnippet.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index b88833fd65..5e62b30897 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/gitAccept.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/gitAccept.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 65c6528c9c..28545b1202 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/gitRevert.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/gitRevert.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 25f0bcdc8a..c994a443b3 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/gitStage.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/gitStage.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index fe8c181619..b1b21abe51 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/gitUnstage.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/gitUnstage.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 19f2f2a555..2da73aac6f 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/highlight.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/highlight.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 898e2d1810..7bb6be1216 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/increment.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/increment.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index ae837f4122..d4460ef3f3 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/indentLine.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/indentLine.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index a7327a8b0e..7e29faa08a 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/insertCopyAfter.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/insertCopyAfter.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 28e6eedc79..5a92e80ff8 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/insertCopyBefore.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/insertCopyBefore.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index f65eedd768..0fe9b3d599 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLineAfter.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLineAfter.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 91b40a8a27..898964562d 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLineBefore.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLineBefore.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index dd36b3c6cf..50679c3c08 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLinesAround.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/insertEmptyLinesAround.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 2b23340fe7..4a89552833 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/insertSnippet.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/insertSnippet.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 345517e4d6..445fcab3b5 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/joinLines.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/joinLines.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 7c2d3df6a8..b0bcd55d68 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/moveToTarget.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/moveToTarget.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 4578ecd1f9..eda9bd2ca6 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/nextHomophone.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/nextHomophone.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index fe2f41defd..46b8717368 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/outdentLine.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/outdentLine.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index fa1c9e781c..ef23e3111f 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/pasteFromClipboard.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/pasteFromClipboard.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index fcf3413ffe..cb2d517bef 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/randomizeTargets.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/randomizeTargets.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 59479cd35e..53e1977409 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/remove.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/remove.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 20d4a6313f..06ec8b15f3 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/rename.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/rename.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 59817be4e6..243baec78e 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/replaceWithTarget.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/replaceWithTarget.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 91595ef8f1..333818b755 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/revealDefinition.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/revealDefinition.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 32509ccda6..8535b694fa 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/revealTypeDefinition.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/revealTypeDefinition.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index ac2903d31c..54e207589c 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/reverseTargets.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/reverseTargets.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index eedbd1b33d..af662e3421 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/rewrapWithPairedDelimiter.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/rewrapWithPairedDelimiter.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 35a4cf3ab1..ab1cf7017a 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/scrollToBottom.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/scrollToBottom.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 3ec134e014..2a005e39b9 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/scrollToCenter.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/scrollToCenter.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 8ea3d2eabc..7dad52b50f 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/scrollToTop.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/scrollToTop.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; # Scroll to top diff --git a/packages/app-web-docs/src/docs/user/reference/actions/experimental.setInstanceReference.mdx b/packages/app-web-docs/src/docs/user/reference/actions/setInstanceReference.mdx similarity index 53% rename from packages/app-web-docs/src/docs/user/reference/actions/experimental.setInstanceReference.mdx rename to packages/app-web-docs/src/docs/user/reference/actions/setInstanceReference.mdx index 0ee2112aa7..e332ef548f 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/experimental.setInstanceReference.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/setInstanceReference.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 8c8a9a6fa7..d4532fd3e1 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/setSelection.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/setSelection.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 673669bb16..8a7bb7f613 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/setSelectionAfter.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/setSelectionAfter.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 22abc88755..5335bf7af1 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/setSelectionBefore.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/setSelectionBefore.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 476022e4d1..ea56546eb6 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/showDebugHover.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/showDebugHover.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index d4c3c70dc4..9b337aad46 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/showHover.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/showHover.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index adbb354d9a..8c2ff97ffa 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/showQuickFix.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/showQuickFix.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 54641f5221..fb67791b63 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/showReferences.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/showReferences.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index f3ec09f3c4..44fd34649e 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/sortTargets.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/sortTargets.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 5a90e58e34..2de617b4ed 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/swapTargets.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/swapTargets.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index d7b1e1dd23..d880600e67 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/toggleLineBreakpoint.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/toggleLineBreakpoint.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 751fb8c651..95d5db36a4 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/toggleLineComment.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/toggleLineComment.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 62d6d7eec2..fa443bc518 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/unfoldRegion.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/unfoldRegion.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 92ba2593e5..196ab1a218 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/wrapWithPairedDelimiter.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/wrapWithPairedDelimiter.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +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 index 091a334f25..d12c485f4a 100644 --- a/packages/app-web-docs/src/docs/user/reference/actions/wrapWithSnippet.mdx +++ b/packages/app-web-docs/src/docs/user/reference/actions/wrapWithSnippet.mdx @@ -1,4 +1,4 @@ -import { ActionReference } from "../components/ReferenceEntry"; +import { ActionReference } from "@site/src/docs/components/ReferenceEntry"; # Wrap with snippet 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 index c8ddc82ff3..143f8944a4 100644 --- a/packages/app-web-docs/src/docs/user/reference/modifiers/ancestor.mdx +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/ancestor.mdx @@ -1,4 +1,4 @@ -import { ModifierReference } from "../components/ReferenceEntry"; +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 index ce6da947c6..3b000857aa 100644 --- a/packages/app-web-docs/src/docs/user/reference/modifiers/containingScope.mdx +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/containingScope.mdx @@ -1,4 +1,4 @@ -import { ModifierReference } from "../components/ReferenceEntry"; +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 index d72f6af842..2834f0b375 100644 --- a/packages/app-web-docs/src/docs/user/reference/modifiers/endOf.mdx +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/endOf.mdx @@ -1,4 +1,4 @@ -import { ModifierReference } from "../components/ReferenceEntry"; +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 index de5b6b526b..2f8c4db466 100644 --- a/packages/app-web-docs/src/docs/user/reference/modifiers/everyScope.mdx +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/everyScope.mdx @@ -1,4 +1,4 @@ -import { ModifierReference } from "../components/ReferenceEntry"; +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 index bd5d1eee7b..18735cc316 100644 --- a/packages/app-web-docs/src/docs/user/reference/modifiers/excludeInterior.mdx +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/excludeInterior.mdx @@ -1,4 +1,4 @@ -import { ModifierReference } from "../components/ReferenceEntry"; +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 index 0e5c190b13..20169c9500 100644 --- a/packages/app-web-docs/src/docs/user/reference/modifiers/extendThroughEndOf.mdx +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/extendThroughEndOf.mdx @@ -1,4 +1,4 @@ -import { ModifierReference } from "../components/ReferenceEntry"; +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 index ec93298d50..3cd78bd057 100644 --- a/packages/app-web-docs/src/docs/user/reference/modifiers/extendThroughStartOf.mdx +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/extendThroughStartOf.mdx @@ -1,4 +1,4 @@ -import { ModifierReference } from "../components/ReferenceEntry"; +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 index f86ec0e380..dec5a55491 100644 --- a/packages/app-web-docs/src/docs/user/reference/modifiers/inferPreviousMark.mdx +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/inferPreviousMark.mdx @@ -1,4 +1,4 @@ -import { ModifierReference } from "../components/ReferenceEntry"; +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 index b3f2e89937..93240f2a98 100644 --- a/packages/app-web-docs/src/docs/user/reference/modifiers/interiorOnly.mdx +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/interiorOnly.mdx @@ -1,4 +1,4 @@ -import { ModifierReference } from "../components/ReferenceEntry"; +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 index e0ebc520ba..59966a274f 100644 --- a/packages/app-web-docs/src/docs/user/reference/modifiers/keepContentFilter.mdx +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/keepContentFilter.mdx @@ -1,4 +1,4 @@ -import { ModifierReference } from "../components/ReferenceEntry"; +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 index 9ff3397f2b..0f071237f2 100644 --- a/packages/app-web-docs/src/docs/user/reference/modifiers/keepEmptyFilter.mdx +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/keepEmptyFilter.mdx @@ -1,4 +1,4 @@ -import { ModifierReference } from "../components/ReferenceEntry"; +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 index f980a36b8f..92343b63c4 100644 --- a/packages/app-web-docs/src/docs/user/reference/modifiers/leading.mdx +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/leading.mdx @@ -1,4 +1,4 @@ -import { ModifierReference } from "../components/ReferenceEntry"; +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 index 66b3e1836e..36d1abe6c6 100644 --- a/packages/app-web-docs/src/docs/user/reference/modifiers/ordinalScope.mdx +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/ordinalScope.mdx @@ -1,4 +1,4 @@ -import { ModifierReference } from "../components/ReferenceEntry"; +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 index b43aea08d2..f1776644c2 100644 --- a/packages/app-web-docs/src/docs/user/reference/modifiers/relativeScope.mdx +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/relativeScope.mdx @@ -1,4 +1,4 @@ -import { ModifierReference } from "../components/ReferenceEntry"; +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 index d893d80fe6..4dd5ec4e2f 100644 --- a/packages/app-web-docs/src/docs/user/reference/modifiers/startOf.mdx +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/startOf.mdx @@ -1,4 +1,4 @@ -import { ModifierReference } from "../components/ReferenceEntry"; +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 index ff544bcb93..92452c05ef 100644 --- a/packages/app-web-docs/src/docs/user/reference/modifiers/toRawSelection.mdx +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/toRawSelection.mdx @@ -1,4 +1,4 @@ -import { ModifierReference } from "../components/ReferenceEntry"; +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 index addd985610..957d53bb13 100644 --- a/packages/app-web-docs/src/docs/user/reference/modifiers/trailing.mdx +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/trailing.mdx @@ -1,4 +1,4 @@ -import { ModifierReference } from "../components/ReferenceEntry"; +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 index d0d11a8e10..959a201e34 100644 --- a/packages/app-web-docs/src/docs/user/reference/modifiers/visible.mdx +++ b/packages/app-web-docs/src/docs/user/reference/modifiers/visible.mdx @@ -1,4 +1,4 @@ -import { ModifierReference } from "../components/ReferenceEntry"; +import { ModifierReference } from "@site/src/docs/components/ReferenceEntry"; # Visible 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 index 990a3868eb..f3a4aed047 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/anonymousFunction.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/anonymousFunction.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index efa6e14738..ecb9da7a56 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/argumentList.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/argumentList.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 295a4db564..bfbec123c2 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/argumentOrParameter.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/argumentOrParameter.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 86922932a8..56fb278f19 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/attribute.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/attribute.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 8ea5713ffa..f0e2921743 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/boundedNonWhitespaceSequence.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/boundedNonWhitespaceSequence.mdx @@ -2,8 +2,8 @@ sidebar_label: Bounded non-ws sequence --- -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 72c106af85..f9961c46c1 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/boundedParagraph.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/boundedParagraph.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 13b12dc5c2..7d1cfbeb21 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/branch.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/branch.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 67417470dc..5a7baeeeb7 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/chapter.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/chapter.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index bbd2cd7604..f0e57fd647 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/character.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/character.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 295f6e1e85..0d36f96e64 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/class.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/class.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index a6cdcbfb60..0169a509fb 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/className.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/className.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 891b760af7..12a7b5f755 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/collectionItem.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/collectionItem.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index f93b4b1ea9..b796f2a860 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/collectionKey.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/collectionKey.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 8a223ab7ef..90eb5174a4 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/command.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/command.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 1f3450c1f9..b0790be3ad 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/comment.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/comment.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 34e581e84a..f39241a52b 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/condition.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/condition.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 2846ec3727..ff98dcf3be 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/document.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/document.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 298280264c..f1ebdbe002 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/environment.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/environment.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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/fieldAccess.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/fieldAccess.mdx deleted file mode 100644 index ac6525d7cd..0000000000 --- a/packages/app-web-docs/src/docs/user/reference/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/user/reference/scopes/fullLine.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/fullLine.mdx index f1ce30bbfe..3653ec4be2 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/fullLine.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/fullLine.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index beadc4f3a8..6f3d1f7a47 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/functionCall.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/functionCall.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index f9785ac723..4d015a0aef 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/functionCallee.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/functionCallee.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index eb8729012b..545aa0dd44 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/functionName.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/functionName.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 5161ae797b..00f52036e4 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/glyph.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/glyph.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 4e3be0ead7..d1d487ae8d 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/identifier.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/identifier.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index e534bb30cb..01d99cb476 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/ifStatement.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/ifStatement.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index cfdd79d7e4..62108da08c 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/instance.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/instance.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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/interior.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/interior.mdx deleted file mode 100644 index 566ac78bbb..0000000000 --- a/packages/app-web-docs/src/docs/user/reference/scopes/interior.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# Interior - - 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 index 6507ad7b25..401642cc43 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/line.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/line.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index bcfb1a4522..d3e368f538 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/list.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/list.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 8a510be18d..919201be61 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/map.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/map.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 9b7cb7d7f3..1e173e7614 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/name.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/name.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index c2c3ad0b07..8dff438f9c 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/namedFunction.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/namedFunction.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 99431ccdbe..ca38ea13fd 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/namedParagraph.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/namedParagraph.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index cca620cf0d..72a21072b1 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/nonWhitespaceSequence.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/nonWhitespaceSequence.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 2e8cc6abf2..7939ad2042 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/notebookCell.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/notebookCell.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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/pair.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/pair.mdx deleted file mode 100644 index 5d5c1b8283..0000000000 --- a/packages/app-web-docs/src/docs/user/reference/scopes/pair.mdx +++ /dev/null @@ -1,7 +0,0 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; - -# Paired delimiters - - - 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 index 7d63baf36a..00bd32657b 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/paragraph.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/paragraph.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 852986232d..3f2dd1473e 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/part.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/part.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 6f593073ce..13db26d17d 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/regularExpression.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/regularExpression.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index ddcbf03c83..01a62de66e 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/section.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/section.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 4c7f93dcea..6d6caf8210 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelFive.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelFive.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 42e9068e3a..d5efcabb4c 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelFour.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelFour.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 56e64d732c..75557736d2 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelOne.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelOne.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 9fc09928f4..ba57de133a 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelSix.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelSix.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index d316f1e5bb..9141f87946 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelThree.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelThree.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 2dd8d89e8c..caaa175ed8 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelTwo.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/sectionLevelTwo.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 2ddac3355d..97f0d16284 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/selector.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/selector.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 9e6edce6b0..e61247b280 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/sentence.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/sentence.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 12fa73adba..547024be52 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/statement.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/statement.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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/string.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/string.mdx deleted file mode 100644 index 4e12f82591..0000000000 --- a/packages/app-web-docs/src/docs/user/reference/scopes/string.mdx +++ /dev/null @@ -1,5 +0,0 @@ -import { Scopes } from "./components/Scopes"; - -# String - - 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 index 00d0416ce5..06d6bf6157 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/subParagraph.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/subParagraph.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 1863c326cb..f0d032d1e5 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/subSection.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/subSection.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 61cf816c13..95eed1890d 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/subSubSection.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/subSubSection.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 47f5d70ab2..6217c8b259 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/surroundingPair.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/surroundingPair.mdx @@ -1,5 +1,7 @@ -import { Scopes } from "./components/Scopes"; +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/textFragment.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/textFragment.mdx deleted file mode 100644 index 351c7be3ea..0000000000 --- a/packages/app-web-docs/src/docs/user/reference/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/user/reference/scopes/token.mdx b/packages/app-web-docs/src/docs/user/reference/scopes/token.mdx index fdf866aefd..49654a0745 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/token.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/token.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 4eb5facd4f..9aeb23d078 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/type.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/type.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 874563e625..83128877dd 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/unit.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/unit.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index d4bcadf238..78f9480d8a 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/url.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/url.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index d71a5d173b..abfb5568be 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/value.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/value.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index dd31195ca2..9e0279a1e3 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/word.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/word.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 7ff6aafae2..0aafaf8a3f 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/xmlBothTags.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/xmlBothTags.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index 2d521c6efc..01a28194f2 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/xmlElement.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/xmlElement.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index f0cbfc9c1d..2edcecdeb9 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/xmlEndTag.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/xmlEndTag.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +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 index d852af3c2c..c6d491bc63 100644 --- a/packages/app-web-docs/src/docs/user/reference/scopes/xmlStartTag.mdx +++ b/packages/app-web-docs/src/docs/user/reference/scopes/xmlStartTag.mdx @@ -1,5 +1,5 @@ -import { ScopeReference } from "../components/ReferenceEntry"; -import { Scopes } from "../components/Scopes"; +import { ScopeReference } from "@site/src/docs/components/ReferenceEntry"; +import { Scopes } from "@site/src/docs/components/Scopes"; # XML start tag diff --git a/packages/lib-common/src/references/scopeReferences.ts b/packages/lib-common/src/references/scopeReferences.ts index 2cb3dfd8a2..2af43c4a49 100644 --- a/packages/lib-common/src/references/scopeReferences.ts +++ b/packages/lib-common/src/references/scopeReferences.ts @@ -1,14 +1,9 @@ -import type { SimpleScopeTypeType } from "../types/command/PartialTargetDescriptor.types"; +import type { ScopeTypeType } from "../types/command/PartialTargetDescriptor.types"; import type { ReferenceEntry } from "./ReferenceEntry"; const DEFAULT_PATTERN = ""; -type AdditionalScopeReferenceType = "glyph"; - -export const scopeReferences: Record< - SimpleScopeTypeType | AdditionalScopeReferenceType, - ReferenceEntry -> = { +export const scopeReferences: Record = { argumentOrParameter: { name: "Argument or parameter", defaultSpokenForm: "arg", @@ -129,19 +124,6 @@ export const scopeReferences: Record< ], examples: [], }, - "private.fieldAccess": { - name: "Field access", - defaultSpokenForm: "access", - private: true, - syntaxes: [ - { - pattern: DEFAULT_PATTERN, - description: "Field access", - cheatsheet: "Field access", - }, - ], - examples: [], - }, functionCall: { name: "Function call", defaultSpokenForm: "call", @@ -274,19 +256,6 @@ export const scopeReferences: Record< ], examples: [], }, - string: { - name: "String", - defaultSpokenForm: "parse tree string", - private: true, - syntaxes: [ - { - pattern: DEFAULT_PATTERN, - description: "String", - cheatsheet: "String", - }, - ], - examples: [], - }, type: { name: "Type", defaultSpokenForm: "type", @@ -753,6 +722,58 @@ export const scopeReferences: Record< ], 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: "string", + private: true, + syntaxes: [ + { + pattern: DEFAULT_PATTERN, + description: "String", + cheatsheet: "String", + }, + ], + examples: [], + }, textFragment: { name: "Text fragment", defaultSpokenForm: "text fragment", @@ -805,16 +826,16 @@ export const scopeReferences: Record< ], examples: [], }, - glyph: { - name: "Glyph", - defaultSpokenForm: "glyph", - syntaxes: [ - { - pattern: " ", - description: "Instance of single character ", - cheatsheet: "Instance of single character ", - }, - ], + surroundingPairInterior: { + name: "Surrounding pair interior", + private: true, + syntaxes: [], + examples: [], + }, + customRegex: { + name: "Custom regex", + private: true, + syntaxes: [], examples: [], }, }; diff --git a/packages/tool-meta-updater/src/metaUpdater.ts b/packages/tool-meta-updater/src/metaUpdater.ts index 9ace8e245e..231ca7529f 100644 --- a/packages/tool-meta-updater/src/metaUpdater.ts +++ b/packages/tool-meta-updater/src/metaUpdater.ts @@ -15,6 +15,7 @@ import type { Context } from "./Context"; import { textFormat } from "./textFormat"; import { updateLanguageMdx } from "./updateLanguageMdx"; import { updatePackageJson } from "./updatePackageJson"; +import { updatePrivateScopeMdx } from "./updatePrivateScopeMdx"; import { updateReferenceMdx } from "./updateReferenceMdx"; import { updatesScopeSupportFacetInfos } from "./updatesScopeSupportFacetInfos"; import { updateTSConfig } from "./updateTSConfig"; @@ -34,7 +35,9 @@ export const updater = async (workspaceDir: string) => { workspaceDir, }; - const referenceDir = "src/docs/user/reference"; + const userDir = "src/docs/user"; + const contributingDir = "src/docs/contributing"; + const referenceDir = `${userDir}/reference`; return createUpdateOptions({ files: { @@ -45,28 +48,34 @@ 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( Object.entries(actionReferences).map(([id, entry]) => [ - `${referenceDir}/actions/${id}.mdx`, + `${referenceDir}/actions/${cleanId(id)}.mdx`, updateReferenceMdx.bind(null, "action", id, entry), ]), ), ...Object.fromEntries( Object.entries(modifierReferences).map(([id, entry]) => [ - `${referenceDir}/modifiers/${id}.mdx`, + `${referenceDir}/modifiers/${cleanId(id)}.mdx`, updateReferenceMdx.bind(null, "modifier", id, entry), ]), ), ...Object.fromEntries( Object.entries(scopeReferences).map(([id, entry]) => [ - `${referenceDir}/scopes/${id}.mdx`, + `${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), + ]), + ), }, formats: { md: textFormat, @@ -74,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 index 904ff8d1a4..91d7fc9493 100644 --- a/packages/tool-meta-updater/src/updateReferenceMdx.ts +++ b/packages/tool-meta-updater/src/updateReferenceMdx.ts @@ -22,11 +22,11 @@ export function updateReferenceMdx( } expected.push( - `import { ${refComponentName} } from "../components/ReferenceEntry";`, + `import { ${refComponentName} } from "@site/src/docs/components/ReferenceEntry";`, ); if (isScope) { - expected.push(`import { Scopes } from "../components/Scopes";`); + expected.push(`import { Scopes } from "@site/src/docs/components/Scopes";`); } expected.push( From ef9705ed043d50d0dbbf00729545ff789fdfffcc Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Thu, 27 Aug 2026 17:58:12 +0200 Subject: [PATCH 09/16] Remove empty targets doc --- packages/app-web-docs/src/docs/user/reference/targets.md | 1 - 1 file changed, 1 deletion(-) delete mode 100644 packages/app-web-docs/src/docs/user/reference/targets.md diff --git a/packages/app-web-docs/src/docs/user/reference/targets.md b/packages/app-web-docs/src/docs/user/reference/targets.md deleted file mode 100644 index 01d0a4c8c0..0000000000 --- a/packages/app-web-docs/src/docs/user/reference/targets.md +++ /dev/null @@ -1 +0,0 @@ -# Targets From f1709ad984101e33f710e514854ea60c3bf529fd Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Thu, 27 Aug 2026 18:02:09 +0200 Subject: [PATCH 10/16] Revert parse tree string spoken form --- packages/lib-common/src/references/scopeReferences.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/lib-common/src/references/scopeReferences.ts b/packages/lib-common/src/references/scopeReferences.ts index 2af43c4a49..cdcdf5dcc5 100644 --- a/packages/lib-common/src/references/scopeReferences.ts +++ b/packages/lib-common/src/references/scopeReferences.ts @@ -763,7 +763,7 @@ export const scopeReferences: Record = { }, string: { name: "String", - defaultSpokenForm: "string", + defaultSpokenForm: "parse tree string", private: true, syntaxes: [ { From 4cf395589b08a813be942e4a948ba0788910fcb4 Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Thu, 27 Aug 2026 18:03:20 +0200 Subject: [PATCH 11/16] Moved key to fragment for legacy --- .../app-web-docs/src/docs/components/ReferenceEntry.tsx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/app-web-docs/src/docs/components/ReferenceEntry.tsx b/packages/app-web-docs/src/docs/components/ReferenceEntry.tsx index c1d5b5cbb7..9b68bbf15b 100644 --- a/packages/app-web-docs/src/docs/components/ReferenceEntry.tsx +++ b/packages/app-web-docs/src/docs/components/ReferenceEntry.tsx @@ -1,4 +1,4 @@ -import React from "react"; +import React, { Fragment } from "react"; import { actionReferences, modifierReferences, @@ -47,10 +47,10 @@ function ReferenceEntryComponent({

    Legacy spoken forms:{" "} {entry.legacySpokenForms.map((s, i) => ( - <> + {i > 0 && ", "} - {s} - + {s} + ))}

    )} From 973cde106e5a1a39ac40538185aff96f3a1d49a1 Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Thu, 27 Aug 2026 18:05:05 +0200 Subject: [PATCH 12/16] Don't nest list inside of paragraph --- packages/app-web-docs/src/docs/components/ReferenceEntry.tsx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/app-web-docs/src/docs/components/ReferenceEntry.tsx b/packages/app-web-docs/src/docs/components/ReferenceEntry.tsx index 9b68bbf15b..d9774f70cc 100644 --- a/packages/app-web-docs/src/docs/components/ReferenceEntry.tsx +++ b/packages/app-web-docs/src/docs/components/ReferenceEntry.tsx @@ -73,7 +73,7 @@ function ReferenceEntryComponent({ )} {entry.examples.length > 0 && ( -

    +

    Examples:
      {entry.examples.map((example, index) => ( @@ -87,7 +87,7 @@ function ReferenceEntryComponent({ ))}
    -

    +
    )} ); From 8fa6e3d519bdd38308bfe7921bd83e55cf4cb7c0 Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Thu, 27 Aug 2026 18:15:21 +0200 Subject: [PATCH 13/16] Fix bug in regex and typos --- cursorless-talon/src/cheatsheet/sections/scopes.py | 4 ++-- .../app-web-docs/src/docs/components/ReferenceEntry.tsx | 2 +- packages/app-web-docs/src/docs/user/README.md | 2 +- .../src/lib/sampleSpokenFormInfos/defaults.json | 4 ++-- packages/lib-common/src/references/scopeReferences.ts | 8 ++++---- 5 files changed, 10 insertions(+), 10 deletions(-) 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/packages/app-web-docs/src/docs/components/ReferenceEntry.tsx b/packages/app-web-docs/src/docs/components/ReferenceEntry.tsx index d9774f70cc..f877f63e8c 100644 --- a/packages/app-web-docs/src/docs/components/ReferenceEntry.tsx +++ b/packages/app-web-docs/src/docs/components/ReferenceEntry.tsx @@ -97,7 +97,7 @@ function formatPattern( pattern: string, defaultSpokenForm?: string, ): React.ReactNode[] { - return pattern.split(/(<\w+>)/gu).map((part, index) => { + return pattern.split(/(<[\w ]+>)/gu).map((part, index) => { if (part.startsWith("<") && part.endsWith(">")) { if (part === "") { return defaultSpokenForm ?? "???"; diff --git a/packages/app-web-docs/src/docs/user/README.md b/packages/app-web-docs/src/docs/user/README.md index 35298f5bd5..fd96d57744 100644 --- a/packages/app-web-docs/src/docs/user/README.md +++ b/packages/app-web-docs/src/docs/user/README.md @@ -439,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 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/references/scopeReferences.ts b/packages/lib-common/src/references/scopeReferences.ts index cdcdf5dcc5..956154ffc2 100644 --- a/packages/lib-common/src/references/scopeReferences.ts +++ b/packages/lib-common/src/references/scopeReferences.ts @@ -641,8 +641,8 @@ export const scopeReferences: Record = { syntaxes: [ { pattern: DEFAULT_PATTERN, - description: "Paragraph bounded by surrounding pair delimeters", - cheatsheet: "Paragraph bounded by surrounding pair delimeters", + description: "Paragraph bounded by surrounding pair delimiters", + cheatsheet: "Paragraph bounded by surrounding pair delimiters", }, ], examples: [], @@ -679,9 +679,9 @@ export const scopeReferences: Record = { { pattern: DEFAULT_PATTERN, description: - "Non-whitespace sequence bounded by surrounding pair delimeters", + "Non-whitespace sequence bounded by surrounding pair delimiters", cheatsheet: - "Non-whitespace sequence bounded by surrounding pair delimeters", + "Non-whitespace sequence bounded by surrounding pair delimiters", }, ], examples: [], From 120b322ab90df0f0410085af85ed88ea263c19e4 Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Thu, 27 Aug 2026 18:17:44 +0200 Subject: [PATCH 14/16] Fixing correct spoken form for snippet --- packages/lib-common/src/references/actionReferences.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/lib-common/src/references/actionReferences.ts b/packages/lib-common/src/references/actionReferences.ts index 7db9b94899..3573d46e2d 100644 --- a/packages/lib-common/src/references/actionReferences.ts +++ b/packages/lib-common/src/references/actionReferences.ts @@ -709,7 +709,7 @@ export const actionReferences: Record< }, insertSnippet: { name: "Insert snippet", - defaultSpokenForm: "snippet", + defaultSpokenForm: "snip", syntaxes: [ { pattern: " ", From e88446c0aac8c6137e8078a23110b1a969729316 Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Thu, 27 Aug 2026 18:31:15 +0200 Subject: [PATCH 15/16] Small format in clean up --- .../src/docs/components/ReferenceEntry.tsx | 55 ++++++++++--------- 1 file changed, 28 insertions(+), 27 deletions(-) diff --git a/packages/app-web-docs/src/docs/components/ReferenceEntry.tsx b/packages/app-web-docs/src/docs/components/ReferenceEntry.tsx index f877f63e8c..d948a81fae 100644 --- a/packages/app-web-docs/src/docs/components/ReferenceEntry.tsx +++ b/packages/app-web-docs/src/docs/components/ReferenceEntry.tsx @@ -34,42 +34,43 @@ function ReferenceEntryComponent({ {entry.description != null &&

    {entry.description}

    }

    - ID: {id} + 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.legacySpokenForms != null && ( +

    + Legacy spoken forms:{" "} + {entry.legacySpokenForms.map((s, i) => ( + + {i > 0 && ", "} + {s} + + ))} +
    + )} + {entry.disabledByDefault && ( +
    + Disabled by default +
    + )}

    )} {entry.syntaxes.length > 0 && ( -
      - {entry.syntaxes.map((syntax, index) => ( -
    • - {formatPattern(syntax.pattern, entry.defaultSpokenForm)}:{" "} - {formatPattern(syntax.description)} -
    • - ))} -
    +
    + Syntax: +
      + {entry.syntaxes.map((syntax, index) => ( +
    • + {formatPattern(syntax.pattern, entry.defaultSpokenForm)}:{" "} + {formatPattern(syntax.description)} +
    • + ))} +
    +
    )} {entry.examples.length > 0 && ( From 29233f3ea97ffaff07313b27f91adb17dbdbb416 Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Thu, 27 Aug 2026 18:50:34 +0200 Subject: [PATCH 16/16] Clean up list --- packages/app-web-docs/src/css/custom.scss | 5 +++++ .../src/docs/components/ReferenceEntry.tsx | 14 +++++++++----- 2 files changed, 14 insertions(+), 5 deletions(-) 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 index d948a81fae..5c5bd12a25 100644 --- a/packages/app-web-docs/src/docs/components/ReferenceEntry.tsx +++ b/packages/app-web-docs/src/docs/components/ReferenceEntry.tsx @@ -38,8 +38,11 @@ function ReferenceEntryComponent({

    {entry.defaultSpokenForm != null && ( -

    - Default spoken form: {entry.defaultSpokenForm} +

    +
    + Default spoken form: {entry.defaultSpokenForm} +
    + {entry.legacySpokenForms != null && (
    Legacy spoken forms:{" "} @@ -51,18 +54,19 @@ function ReferenceEntryComponent({ ))}
    )} + {entry.disabledByDefault && (
    Disabled by default
    )} -

    +
    )} {entry.syntaxes.length > 0 && (
    Syntax: -
      +
        {entry.syntaxes.map((syntax, index) => (
      • {formatPattern(syntax.pattern, entry.defaultSpokenForm)}:{" "} @@ -76,7 +80,7 @@ function ReferenceEntryComponent({ {entry.examples.length > 0 && (
        Examples: -
          +
            {entry.examples.map((example, index) => (