-
-
Notifications
You must be signed in to change notification settings - Fork 85
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Cedric Halbronn
committed
Jun 13, 2024
1 parent
1abf38d
commit c22f4d5
Showing
86 changed files
with
5,144 additions
and
575 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -40,6 +40,41 @@ jobs: | |
| registryUrl: https://marketplace.visualstudio.com | ||
| extensionFile: ${{ steps.publishToOpenVSX.outputs.vsixPath }} | ||
|
|
||
| publish-neovim-extension: | ||
| runs-on: ubuntu-latest | ||
| if: ${{ github.event.workflow_run.conclusion == 'success' }} | ||
| environment: production | ||
| env: | ||
| CURSORLESS_REPO_ROOT: ${{ github.workspace }} | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
| token: ${{ secrets.CURSORLESS_BOT_TOKEN }} | ||
| - run: corepack enable | ||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version-file: .nvmrc | ||
| cache: pnpm | ||
| - run: pnpm --color install | ||
| - run: pnpm --color compile | ||
| - run: pnpm --color --filter '!cursorless-org' --filter '!cursorless-org-*' build | ||
| env: | ||
| CURSORLESS_DEPLOY: true | ||
| - name: Configure GPG Key | ||
| run: | | ||
| echo -n "$GPG_SIGNING_KEY" | base64 --decode | gpg --import | ||
| env: | ||
| GPG_SIGNING_KEY: ${{ secrets.CURSORLESS_BOT_GPG_SIGNING_KEY }} | ||
| - name: git config | ||
| run: | | ||
| git config user.name cursorless-bot | ||
| git config user.email [email protected] | ||
| git config user.signingkey A9387720AFC62221 | ||
| git config commit.gpgsign true | ||
| - name: Push compiled files to cursorless.nvim plugin repo | ||
| run: bash -x scripts/deploy-cursorless-nvim.sh | ||
|
|
||
| push-cursorless-talon: | ||
| name: Push cursorless-talon subrepo | ||
| runs-on: ubuntu-latest | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,6 +24,8 @@ jobs: | |
| node-version-file: .nvmrc | ||
| cache: pnpm | ||
| - run: pnpm --color install | ||
| - uses: leafo/gh-actions-lua@v9 | ||
| - uses: leafo/gh-actions-luarocks@v4 | ||
| - uses: pre-commit/[email protected] | ||
| - uses: pre-commit-ci/[email protected] | ||
| if: always() | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| std = luajit | ||
| cache = true | ||
| codes = true | ||
| ignore = { "432" } | ||
|
|
||
| globals = { | ||
| "vim", | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| <!-- vim-markdown-toc GFM --> | ||
|
|
||
| - [cursorless.nvim](#cursorlessnvim) | ||
| - [Prerequisites](#prerequisites) | ||
| - [Installation](#installation) | ||
| - [Configuration](#configuration) | ||
| - [Frequently asked questions](#frequently-asked-questions) | ||
| - [Contributors](#contributors) | ||
|
|
||
| <!-- vim-markdown-toc --> | ||
|
|
||
| # cursorless.nvim | ||
|
|
||
| Neovim plugin to support Cursorless | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - [neovim](https://neovim.io/.) Tested with neovim version `v0.10.0` and above, but it may work with earlier versions. | ||
| - [Talon voice](https://talonvoice.com/) | ||
| - [neovim-talon](https://github.com/hands-free-vim/neovim-talon) | ||
| - [node/npm](https://nodejs.org/en) | ||
| - [neovim node package](https://github.com/neovim/node-client) (>= 5.1.0 installed globally) | ||
| - [talon.nvim](https://github.com/hands-free-vim/talon.nvim) (likely required, unless standalone neovim | ||
| GUI (nvim-qt.exe, neovide, etc) | ||
|
|
||
| ## Installation | ||
|
|
||
| ### 1. Install Cursorless neovim plugin | ||
|
|
||
| Ideally, you want to use a neovim plugin manager like [lazy.nvim](https://github.com/folke/lazy.nvim). | ||
|
|
||
| #### Option A: Lazy installation | ||
|
|
||
| After the typical [lazy setup](https://github.com/folke/lazy.nvim?tab=readme-ov-file#-installation), you'll have to add the `cursorless.nvim` plugin to your `init.lua`. | ||
|
|
||
| ```lua | ||
| require('lazy').setup({ | ||
| 'hands-free-vim/cursorless.nvim', | ||
| }) | ||
| ``` | ||
|
|
||
| #### Option B: Manual installation | ||
|
|
||
| This method is not recommended but you can try directly cloning the plugin into your nvim data folder: | ||
|
|
||
| ``` | ||
| git clone https://github.com/hands-free-vim/cursorless.nvim | ||
| ``` | ||
|
|
||
| ### 2. Tell neovim to run the plugin | ||
|
|
||
| If you aren't using a plugin manager that automatically calls setup for you (e.g. it is needed for lazy), you will need this somewhere in your neovim config, e.g. in [init.lua](https://neovim.io/doc/user/lua-guide.html#lua-guide-config): | ||
|
|
||
| ```lua | ||
| require("cursorless").setup() | ||
| ``` | ||
|
|
||
| ### 3. Activate Cursorless commands in Talon | ||
|
|
||
| Add a `.talon` file like the following anywhere in your Talon user directory (e.g. named `cursorless_neovim.talon`): | ||
|
|
||
| ```talon | ||
| app: neovim | ||
| - | ||
| tag(): user.cursorless | ||
| ``` | ||
|
|
||
| ## Configuration | ||
|
|
||
| ### Keyboard shortcut | ||
|
|
||
| By default the keyboard shortcut used to communicate with cursorless is `<C-S-f12>`, but this might not work for | ||
| everybody and is configurable. You can change it by passing a different value in the configuration options passed to | ||
| `setup()`: | ||
|
|
||
| ```lua | ||
| require("cursorless").setup({ shortcut = `<C-Q>`}) | ||
| ``` | ||
|
|
||
| _IMPORTANT_: If you change this shortcut, be sure to set the corresponding neovim-talon setting. This can be done by | ||
| having a `.talon` file somewhere in your talon user directory that contains the following: | ||
|
|
||
| ```talon | ||
| settings(): | ||
| user.neovim_command_server_shortcut = "ctrl-q" | ||
| ``` | ||
|
|
||
| ### Absolute row numbers | ||
|
|
||
| You MUST currently use absolute row numbers in order to target rows using cursorless. The `talon.nvim` plugin will | ||
| configure this automatically, but your own config may be overriding it. Be sure to disable relative numbers. | ||
|
|
||
| ## Frequently asked questions | ||
|
|
||
| ### nvim does not support Lazy? | ||
|
|
||
| Some Linux package managers ship with a version of `nvim` too old for Lazy. If this is the case, [install nvim](https://github.com/neovim/neovim/blob/master/INSTALL.md) via another method. | ||
|
|
||
| ### nvim does not find the `neovim` globally installed package? | ||
|
|
||
| If you are on Linux, avoid using the snap package for `npm` as it may not be able to globally expose the neovim npm package due to sandboxing. If this is the case, install node via another method (nvm, brew, etc). | ||
|
|
||
| ## Contributors | ||
|
|
||
| Welcome! So glad you've decided to help make Cursorless in Neovim better. You'll want to start by getting [set up](https://github.com/saidelike/cursorless/blob/nvim-talon/docs/contributing/cursorless-in-neovim.md). You may also find the [Neovim API docs](https://neovim.io/doc/user/api.html) helpful to learn about Neovim extension development. |
Oops, something went wrong.