cursorless-dev/cursorless
1
1
Fork 0
mirror of https://github.com/cursorless-dev/cursorless.git synced 2024-10-04 12:57:58 +03:00
Code Issues Packages Projects Releases Wiki Activity
Don't let the cursor slow you down
204 Commits 29 Branches 55 Tags 37 MiB
TypeScript 83.6%
Python 6.7%
Scheme 5.4%
JavaScript 1%
Shell 0.8%
Other 2.3%
23fe4dbcdd
Go to file
Andreas Arvidsson 23fe4dbcdd
Disabled statement block on typescript (#359)
2021-12-05 16:56:12 +00:00
.github master => main (#262) 2021-09-06 18:53:06 +02:00
.vscode Snippet wrap (#296) 2021-10-25 13:15:07 +01:00
cursorless-snippets Snippet wrap (#296) 2021-10-25 13:15:07 +01:00
data/playground Delimiter selector updated (#347) 2021-12-01 16:00:25 +01:00
docs Improved update selections (#306) 2021-11-07 08:36:11 +01:00
images Snippet wrap (#296) 2021-10-25 13:15:07 +01:00
schemas Snippet wrap (#296) 2021-10-25 13:15:07 +01:00
src Disabled statement block on typescript (#359) 2021-12-05 16:56:12 +00:00
.eslintrc.json Snippet wrap (#296) 2021-10-25 13:15:07 +01:00
.gitignore Add surrounding pair modifier (#3) (#168) 2021-08-09 19:17:17 +01:00
.vscodeignore web-tree-sitter; python; icon 2021-05-12 10:53:18 +01:00
.yarnrc Skeleton 2021-02-14 15:23:21 +00:00
CHANGELOG.md Release 0.23.0 (#305) 2021-10-27 13:20:19 +01:00
CONTRIBUTING.md Add new hats and preprocessing script (#277) 2021-10-05 18:38:32 +01:00
LICENSE Add license 2021-05-04 12:07:25 +01:00
package.json Removed additional highlight before scroll (#337) 2021-11-29 14:17:38 +01:00
README.md Add new hats and preprocessing script (#277) 2021-10-05 18:38:32 +01:00
tsconfig.json Delimiter selector updated (#347) 2021-12-01 16:00:25 +01:00
vsc-extension-quickstart.md Skeleton 2021-02-14 15:23:21 +00:00
yarn.lock Snippet wrap (#296) 2021-10-25 13:15:07 +01:00

README.md

Welcome to Cursorless!

Version Tests Documentation Maintenance License: MIT

Allows cursorless editing and rapid navigation by decorating a single letter from each token.

Features

swap main-demo demo-2 demo-3

Checkout the docs, tutorial video and !!con talk to get started.

Installation

Currently depends on Talon, though a keyboard version is planned.

See cursorless-talon for installation instructions.

Extension Settings

This extension contributes the following settings:

  • cursorless.showOnStart: Whether decorations should appear on workspace start
  • cursorless.hatSizeAdjustment: Percentage to increase or decrease hat size; positive increases size
  • cursorless.hatVerticalOffset: How much to vertically shift the hats as a percentage of font size; positive is up
  • cursorless.hatEnablement.colors: Whether to enable particular hat colors.
  • cursorless.hatEnablement.shapes: Whether to enable particular hat shapes.
  • cursorless.hatPenalties.colors: How much to penalize each hat color. You will probably want to set this one to the number of syllables in the given style. Cursorless will then sort every style combination by number of syllables to refer to it.
  • cursorless.hatPenalties.shapes: How much to penalize each hat shape. You will probably want to set this one to the number of syllables in the given style. Cursorless will then sort every style combination by number of syllables to refer to it.

Known Issues

  • Cursorless calculates the position of the hats based on the characteristics of your font. If you find that the hats are off center you can try running this command: cursorless.recomputeDecorationStyles

Change Log

See CHANGELOG.md.

Contributing

See CONTRIBUTING.md.

This README was partially generated with ❤️ by readme-md-generator