Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

move definition of which actions exit cursorless mode to the config #2174

Merged
merged 16 commits into from
Jan 20, 2024
Merged

move definition of which actions exit cursorless mode to the config #2174

Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
80fb773
move definition of which actions exit cursorless mode to the config
josharian Jan 5, 2024
5366a19
[pre-commit.ci lite] apply automatic fixes
pre-commit-ci-lite[bot] Jan 17, 2024
755806c
Add enum for action ids
pokey Jan 18, 2024
998e4dd
fix schema
pokey Jan 18, 2024
95be889
fix
pokey Jan 18, 2024
57d31cc
fix action ids
pokey Jan 18, 2024
e23b6f1
cleanup
pokey Jan 18, 2024
7daa99b
Whips
pokey Jan 18, 2024
2fe21f2
refactor
pokey Jan 18, 2024
61ccc9f
[pre-commit.ci lite] apply automatic fixes
pre-commit-ci-lite[bot] Jan 18, 2024
4fbdc8c
shenanigans
pokey Jan 18, 2024
30488b8
get info from wrap action descriptor
pokey Jan 18, 2024
9b99f7b
whoops
pokey Jan 18, 2024
60831b8
use lodash's isString
josharian Jan 20, 2024
eb4fc7f
more cleanup
pokey Jan 20, 2024
1454bc6
words
josharian Jan 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
183 changes: 128 additions & 55 deletions packages/cursorless-vscode/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -864,61 +864,134 @@
"description": "Define modal keybindings for actions",
"type": "object",
"additionalProperties": {
"type": "string",
"enum": [
"callAsFunction",
"clearAndSetSelection",
"copyToClipboard",
"cutToClipboard",
"deselect",
"editNew",
"editNewLineAfter",
"editNewLineBefore",
"executeCommand",
"extractVariable",
"findInDocument",
"findInWorkspace",
"foldRegion",
"followLink",
"generateSnippet",
"getText",
"highlight",
"indentLine",
"insertCopyAfter",
"insertCopyBefore",
"insertEmptyLineAfter",
"insertEmptyLineBefore",
"insertEmptyLinesAround",
"insertSnippet",
"moveToTarget",
"outdentLine",
"pasteFromClipboard",
"randomizeTargets",
"remove",
"rename",
"replace",
"replaceWithTarget",
"revealDefinition",
"revealTypeDefinition",
"reverseTargets",
"rewrapWithPairedDelimiter",
"scrollToBottom",
"scrollToCenter",
"scrollToTop",
"setSelection",
"setSelectionAfter",
"setSelectionBefore",
"showDebugHover",
"showHover",
"showQuickFix",
"showReferences",
"sortTargets",
"swapTargets",
"toggleLineBreakpoint",
"toggleLineComment",
"unfoldRegion",
"wrapWithPairedDelimiter",
"wrapWithSnippet"
"anyOf": [
{
"type": "string",
"enum": [
"callAsFunction",
"clearAndSetSelection",
"copyToClipboard",
"cutToClipboard",
"deselect",
"editNew",
"editNewLineAfter",
"editNewLineBefore",
"executeCommand",
"extractVariable",
"findInDocument",
"findInWorkspace",
"foldRegion",
"followLink",
"generateSnippet",
"getText",
"highlight",
"indentLine",
"insertCopyAfter",
"insertCopyBefore",
"insertEmptyLineAfter",
"insertEmptyLineBefore",
"insertEmptyLinesAround",
"insertSnippet",
"moveToTarget",
"outdentLine",
"pasteFromClipboard",
"randomizeTargets",
"remove",
"rename",
"replace",
"replaceWithTarget",
"revealDefinition",
"revealTypeDefinition",
"reverseTargets",
"rewrapWithPairedDelimiter",
"scrollToBottom",
"scrollToCenter",
"scrollToTop",
"setSelection",
"setSelectionAfter",
"setSelectionBefore",
"showDebugHover",
"showHover",
"showQuickFix",
"showReferences",
"sortTargets",
"swapTargets",
"toggleLineBreakpoint",
"toggleLineComment",
"unfoldRegion",
"wrap"
]
},
{
"type": "object",
"properties": {
"actionId": {
"type": "string",
"enum": [
"callAsFunction",
"clearAndSetSelection",
"copyToClipboard",
"cutToClipboard",
"deselect",
"editNew",
"editNewLineAfter",
"editNewLineBefore",
"executeCommand",
"extractVariable",
"findInDocument",
"findInWorkspace",
"foldRegion",
"followLink",
"generateSnippet",
"getText",
"highlight",
"indentLine",
"insertCopyAfter",
"insertCopyBefore",
"insertEmptyLineAfter",
"insertEmptyLineBefore",
"insertEmptyLinesAround",
"insertSnippet",
"moveToTarget",
"outdentLine",
"pasteFromClipboard",
"randomizeTargets",
"remove",
"rename",
"replace",
"replaceWithTarget",
"revealDefinition",
"revealTypeDefinition",
"reverseTargets",
"rewrapWithPairedDelimiter",
"scrollToBottom",
"scrollToCenter",
"scrollToTop",
"setSelection",
"setSelectionAfter",
"setSelectionBefore",
"showDebugHover",
"showHover",
"showQuickFix",
"showReferences",
"sortTargets",
"swapTargets",
"toggleLineBreakpoint",
"toggleLineComment",
"unfoldRegion",
"wrap"
],
"description": "The cursorless command to run"
},
"exitCursorlessMode": {
"type": "boolean",
"description": "Indicates whether the command should exit cursorless mode after it is run, defaults false."
}
},
"required": [
"actionId"
]
}
]
}
},
Expand Down
13 changes: 13 additions & 0 deletions packages/cursorless-vscode/src/keyboard/KeyboardActionType.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,19 @@ export type SimpleKeyboardActionType = Exclude<
KeyboardActionType,
ComplexKeyboardActionType
>;

export type SpecificKeyboardActionDescriptor<T extends KeyboardActionType> = {
actionId: T;
exitCursorlessMode: boolean;
};

export type PolymorphicKeyboardActionDescriptor =
| KeyboardActionType
| SpecificKeyboardActionDescriptor<KeyboardActionType>;

export type SimpleKeyboardActionDescriptor =
SpecificKeyboardActionDescriptor<SimpleKeyboardActionType>;

export type KeyboardActionType =
| Exclude<ActionType, ExcludedKeyboardActionType>
| ExtraKeyboardActionType;
Expand Down
34 changes: 21 additions & 13 deletions packages/cursorless-vscode/src/keyboard/KeyboardCommandHandler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
import { Modifier, SurroundingPairName } from "@cursorless/common";
import * as vscode from "vscode";
import { HatColor, HatShape } from "../ide/vscode/hatStyles.types";
import { SimpleKeyboardActionType } from "./KeyboardActionType";
import {
SimpleKeyboardActionDescriptor,
SpecificKeyboardActionDescriptor,
} from "./KeyboardActionType";
import KeyboardCommandsTargeted from "./KeyboardCommandsTargeted";
import { ModalVscodeCommandDescriptor } from "./TokenTypes";
import { surroundingPairsDelimiters } from "@cursorless/cursorless-engine";
import { isString } from "lodash";

/**
* This class defines the keyboard commands available to our modal keyboard
Expand Down Expand Up @@ -65,21 +69,24 @@ export class KeyboardCommandHandler {
}

performSimpleActionOnTarget({
actionName,
actionDescriptor,
}: {
actionName: SimpleKeyboardActionType;
actionDescriptor: SimpleKeyboardActionDescriptor;
}) {
this.targeted.performSimpleActionOnTarget(actionName);
this.targeted.performSimpleActionOnTarget(actionDescriptor);
}

performWrapActionOnTarget({ delimiter }: { delimiter: SurroundingPairName }) {
performWrapActionOnTarget({ actionDescriptor, delimiter }: WrapActionArg) {
const [left, right] = surroundingPairsDelimiters[delimiter]!;
this.targeted.performActionOnTarget((target) => ({
name: "wrapWithPairedDelimiter",
target,
left,
right,
}));
this.targeted.performActionOnTarget(
(target) => ({
name: "wrapWithPairedDelimiter",
target,
left,
right,
}),
actionDescriptor,
);
}

modifyTarget({ modifier }: { modifier: Modifier }) {
Expand All @@ -95,6 +102,7 @@ interface DecoratedMarkArg {
mode: "replace" | "extend" | "append";
}

function isString(input: any): input is string {
return typeof input === "string" || input instanceof String;
interface WrapActionArg {
actionDescriptor: SpecificKeyboardActionDescriptor<"wrap">;
delimiter: SurroundingPairName;
}
Loading