cursorless-dev/cursorless
1
1
Fork 0
mirror of https://github.com/cursorless-dev/cursorless.git synced 2024-10-05 05:17:38 +03:00
Code Issues Packages Projects Releases Wiki Activity
Don't let the cursor slow you down
172 Commits 29 Branches 55 Tags 37 MiB
TypeScript 83.6%
Python 6.7%
Scheme 5.4%
JavaScript 1%
Shell 0.8%
Other 2.3%
18488370f0
Go to file
Pokey Rule 18488370f0
Fix SVG alignment and click box (#273) 
* Fix SVG alignment and click box

* Adjust measurements to compensate for math fix
2021-09-11 19:35:01 +02:00
.github master => main (#262) 2021-09-06 18:53:06 +02:00
.vscode General cleanup (#235) 2021-08-19 17:05:03 +01:00
docs Fix "take every value" in python (#258) 2021-09-05 16:29:14 +02:00
images Add a bunch of new hats (#256) 2021-09-03 15:42:45 +02:00
src Fix SVG alignment and click box (#273) 2021-09-11 19:35:01 +02:00
.eslintrc.json Fix timing; use editor instead of documentUri 2021-04-19 20:53:17 +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.21.0 2021-08-17 17:02:07 +01:00
LICENSE Add license 2021-05-04 12:07:25 +01:00
package.json Rename purple to pink (#263) 2021-09-06 18:11:05 +01:00
README.md master => main (#262) 2021-09-06 18:53:06 +02:00
tsconfig.json First working version 2021-02-16 16:45:00 +00:00
vsc-extension-quickstart.md Skeleton 2021-02-14 15:23:21 +00:00
yarn.lock Test Case Recorder (#87) 2021-07-31 10:18:06 -07: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. Note that you'll also want to enable / disable the corresponding spoken form in Talon.
  • cursorless.hatEnablement.shapes: Whether to enable particular hat shapes. Note that you'll also want to enable / disable the corresponding spoken form in Talon.
  • 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

Installation

yarn install

Running tests

yarn run test

Adding tests

See test-case-recorder.md.

Adding a new programming language

See docs.

Adding syntactic scope types to an existing language

See parse-tree-patterns.md.

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