cursorless-dev/cursorless
1
1
Fork 0
mirror of https://github.com/cursorless-dev/cursorless.git synced 2024-10-04 21:07:21 +03:00
Code Issues Packages Projects Releases Wiki Activity
Don't let the cursor slow you down
403 Commits 29 Branches 55 Tags 37 MiB
TypeScript 83.6%
Python 6.7%
Scheme 5.4%
JavaScript 1%
Shell 0.8%
Other 2.3%
b274f1772b
Go to file
Ben Rollin b274f1772b
Documentation for row, up, down (#877) 
* row, up, down docs

* Tweaks

* up/down relative line numbers

Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com>
2022-07-19 21:30:56 +01:00
.github Switch to netlify (#856) 2022-07-12 16:54:21 +01:00
.vscode Add "callee" scope type. (#664) 2022-06-23 17:07:15 +01:00
cursorless-nx Another attempt to fix nx cache (#847) 2022-07-08 14:06:53 +01:00
cursorless-snippets Support insertSnippet action (#304) 2022-06-30 14:40:04 +01:00
cursorless-talon Switch to netlify (#856) 2022-07-12 16:54:21 +01:00
data/playground Run pre-commit 2022-04-25 11:21:26 +01:00
docs Documentation for row, up, down (#877) 2022-07-19 21:30:56 +01:00
images Remove trailing new lines in svgs (#650) 2022-04-25 16:31:09 +01:00
schemas Disallow additional properties in snippets (#808) 2022-06-30 16:09:18 +01:00
scripts Switch to netlify (#856) 2022-07-12 16:54:21 +01:00
src Add ESLint recommended rules (#776) 2022-07-16 16:36:32 +01:00
website Move netlify.toml (#865) 2022-07-13 17:31:55 +02:00
website-root Switch to netlify (#856) 2022-07-12 16:54:21 +01:00
.editorconfig Remove trailing new lines in svgs (#650) 2022-04-25 16:31:09 +01:00
.eslintrc.json Add ESLint recommended rules (#776) 2022-07-16 16:36:32 +01:00
.git-blame-ignore-revs More pre-commit integration (#649) 2022-04-26 07:41:27 +01:00
.gitignore Switch to netlify (#856) 2022-07-12 16:54:21 +01:00
.pre-commit-config.yaml [pre-commit.ci] pre-commit autoupdate (#778) 2022-06-21 07:46:43 +01:00
.prettierignore Add pre-commit (#637) 2022-04-24 17:26:32 +01:00
.vscodeignore Another attempt to fix nx cache (#847) 2022-07-08 14:06:53 +01:00
.yarnrc Run pre-commit 2022-04-25 11:21:26 +01:00
CHANGELOG.md Change cursorless-dev/cursorless-vscode to cursorless-dev/cursorless (#656) 2022-04-26 13:56:23 +01:00
CONTRIBUTING.md Serve docs folder and API reference on GitHub pages (#477) 2022-03-16 23:23:03 +00:00
LICENSE Add license 2021-05-04 12:07:25 +01:00
netlify.toml Move netlify.toml (#865) 2022-07-13 17:31:55 +02:00
NOTICE.md Clean up badges; add ratings badge (#488) 2022-01-17 14:06:49 +00:00
package.json Add more extension fields to package.json (#869) 2022-07-15 17:00:46 +01:00
README.md Add more extension fields to package.json (#869) 2022-07-15 17:00:46 +01:00
third-party-licenses.csv Create local extension sandbox (#691) 2022-05-25 19:46:15 +01:00
tsconfig.json Reimplement cheatsheet using html (#619) 2022-07-07 15:35:23 +01:00
vsc-extension-quickstart.md Run pre-commit 2022-04-25 11:21:26 +01:00
yarn.lock Reimplement cheatsheet using html (#619) 2022-07-07 15:35:23 +01:00

README.md

Welcome to Cursorless!

Version Rating Documentation Tests Maintenance License: MIT

Cursorless is a spoken language for structural code editing, enabling developers to code by voice at speeds not possible with a keyboard. Cursorless decorates every token on the screen and defines a spoken language for rapid, high-level semantic manipulation of structured text.

Checkout the docs and videos to learn more. See installation for installation instructions.

And I heard you like GIFs?

Curly repack ox Move arg air and each to after drum Chuck tail red pipe slice past end of file

Installation

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

See installation 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.
  • cursorless.maximumHatStylePenalty: The maximum allowed penalty for a hat style. Any hat style whose penalty is greater than this amount will not be used. A hat style penalty is defined to be the shape penalty plus the colour penalty. Setting this value less than or equal to zero is treated as no maximum.

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

Contributing

See contributing.

Change Log

See CHANGELOG.md.

Attributions

See NOTICE.md.