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
305 Commits 29 Branches 55 Tags 37 MiB
TypeScript 83.6%
Python 6.7%
Scheme 5.4%
JavaScript 1%
Shell 0.8%
Other 2.3%
310f8f9b69
Go to file
Nathan Heffley 310f8f9b69
Add PHP to snippets (#612) 
Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com>
2022-03-18 15:10:53 +00:00
.github Minor Cursorless docs follow-up tweaks (#610) 2022-03-18 10:58:00 +00:00
.vscode Serve docs folder and API reference on GitHub pages (#477) 2022-03-16 23:23:03 +00:00
cursorless-snippets Add PHP to snippets (#612) 2022-03-18 15:10:53 +00:00
cursorless-talon change the default term (#596) 2022-03-09 22:22:53 +00:00
data/playground Scala support (#399) 2022-01-08 16:42:56 +00:00
docs Minor Cursorless docs follow-up tweaks (#610) 2022-03-18 10:58:00 +00:00
gh-pages-root Serve docs folder and API reference on GitHub pages (#477) 2022-03-16 23:23:03 +00:00
images Add highlight action and nothing mark (#563) 2022-02-14 14:11:09 +00:00
schemas Snippet wrap (#296) 2021-10-25 13:15:07 +01:00
scripts Minor Cursorless docs follow-up tweaks (#610) 2022-03-18 10:58:00 +00:00
src Add PHP to snippets (#612) 2022-03-18 15:10:53 +00:00
website Attempt to fix docs link (#611) 2022-03-18 12:06:00 +00:00
.eslintrc.json Added no unused rule to lint (#517) 2022-02-13 13:36:00 +00:00
.gitignore Serve docs folder and API reference on GitHub pages (#477) 2022-03-16 23:23:03 +00: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 Serve docs folder and API reference on GitHub pages (#477) 2022-03-16 23:23:03 +00: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
NOTICE.md Clean up badges; add ratings badge (#488) 2022-01-17 14:06:49 +00:00
package.json Serve docs folder and API reference on GitHub pages (#477) 2022-03-16 23:23:03 +00:00
README.md Update documentation and links to reflect monorepo (#542) 2022-02-03 18:57:58 +00:00
third-party-licenses.csv Serve docs folder and API reference on GitHub pages (#477) 2022-03-16 23:23:03 +00: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 Serve docs folder and API reference on GitHub pages (#477) 2022-03-16 23:23:03 +00:00

README.md

Welcome to Cursorless!

Version Rating Tests Documentation 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.md 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.md 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.

Attributions

See NOTICE.md.