cursorless/README.md

81 lines
1.9 KiB
Markdown
Raw Normal View History

2021-05-04 19:11:18 +03:00
# Cursorless
2021-03-12 20:17:43 +03:00
2021-05-04 15:03:48 +03:00
Allows cursorless editing and rapid navigation by decorating a single letter
from each token.
2021-03-12 20:17:43 +03:00
## Features
2021-05-08 19:04:38 +03:00
![swap](images/swap.gif)
2021-05-04 18:08:44 +03:00
![main-demo](images/main-demo.gif)
2021-05-04 19:23:43 +03:00
![demo-2](images/demo-2.gif)
2021-05-04 19:34:31 +03:00
![demo-3](images/demo-3.gif)
2021-03-12 20:17:43 +03:00
2021-05-04 18:11:19 +03:00
Many other marks / transformations / actions exist; documentation to follow.
2021-05-04 15:03:48 +03:00
## Installation
Currently depends on [Talon](https://talonvoice.com/), though a keyboard
version is planned.
See [cursorless-talon](https://github.com/pokey/cursorless-talon) for installation instructions.
2021-03-12 20:17:43 +03:00
## Extension Settings
This extension contributes the following settings:
* `cursorless.showOnStart`: whether decorations should appear on workspace start
2021-03-12 20:17:43 +03:00
## Known Issues
2021-05-02 18:57:42 +03:00
## Release Notes
2021-06-29 23:10:52 +03:00
### 0.15.0
- Support "character" subtoken transformation (eg "take fine third character") (thanks @brxck!)
### 0.14.0
- Support `insertLineBefore` and `insertLineAfter` actions ("drink" and "pour")
### 0.13.0
- Support "file" selection type to refer to the entire file
- Improve error messages
### 0.12.0
- Add subword support
- [python] Fix parameter transformation
- Show exceptions to user
- Properly support using "token" to select only token, eg "take funk gust and
token fine" to prevent "fine" from being inferred to have the `function`
transformation.
- Support "bring" action to use another target from elsewhere in the document
2021-05-12 20:44:08 +03:00
### 0.11.0
- Simplify token regex
2021-05-12 12:53:00 +03:00
### 0.10.0
- Add Python support
### 0.9.0
- Support "string" and "comment" scope types
2021-05-07 18:00:27 +03:00
### 0.8.0
2021-05-08 17:57:13 +03:00
- Support "fold", "unfold", and "swap" actions
2021-05-07 18:00:27 +03:00
2021-05-06 15:04:43 +03:00
### 0.7.0
- Support "cut" action (default term in vscode-talon is "carve")
2021-05-06 14:48:48 +03:00
### 0.6.0
- Support "copy" action
2021-05-04 15:04:58 +03:00
### 0.5.0
- Support "that" to refer to previous target
- Support "extract" action to extract to constant
2021-05-02 20:20:05 +03:00
### 0.4.0
- Support pair key and value nodes
- Support selecting all siblings
2021-05-02 19:13:56 +03:00
### 0.3.0
- Support wrap
2021-05-02 18:57:42 +03:00
### 0.2.0
- Add support for arguments and pairs