Neovim CI tests

.github/workflows/deploy.yaml

@@ -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

.github/workflows/test.yml

@@ -16,16 +16,17 @@ jobs:
       fail-fast: false
       matrix:
         os: [macos-latest, ubuntu-latest, windows-latest]
-        vscode_version: [stable]
+        app_version: [stable]
         include:
           - os: ubuntu-latest
-            vscode_version: legacy
+            app_version: legacy
     runs-on: ${{ matrix.os }}
     env:
-      VSCODE_VERSION: ${{ matrix.vscode_version }}
+      APP_VERSION: ${{ matrix.app_version }}
       VSCODE_CRASH_DIR: ${{ github.workspace }}/artifacts/dumps
       VSCODE_LOGS_DIR: ${{ github.workspace }}/artifacts/logs
       CURSORLESS_REPO_ROOT: ${{ github.workspace }}
+      HOME_ROOT: ${{ github.workspace }}/../../../
     steps:
       - uses: actions/checkout@v4
       - run: corepack enable
@@ -38,28 +39,40 @@ jobs:
       - run: pnpm --color install
       - run: pnpm --color compile
       - run: pnpm --color --filter '!cursorless-org' --filter '!cursorless-org-*' build
-      - run: xvfb-run -a pnpm --color test
-        if: runner.os == 'Linux'
-      - run: pnpm --color test
-        if: runner.os != 'Linux'
-      - name: Create vscode dist that can be installed locally
-        run: pnpm -F @cursorless/cursorless-vscode populate-dist --local-install
-        if: runner.os == 'Linux' && matrix.vscode_version == 'stable'
-      - name: Test create vsix
-        id: createVsix
-        uses: HaaLeo/publish-vscode-extension@v1
+      # - run: xvfb-run -a pnpm --color test
+      #   if: runner.os == 'Linux'
+      # - run: pnpm --color test
+      #   if: runner.os != 'Linux'
+      - run: bash -x scripts/install-neovim-dependencies.sh
+      - uses: rhysd/action-setup-vim@v1
+        if: matrix.app_version != 'legacy'
+        id: vim
         with:
-          pat: none
-          packagePath: packages/cursorless-vscode/dist
-          dryRun: true
-      - run: mv ${{ steps.createVsix.outputs.vsixPath }} cursorless-development.vsix
-        if: runner.os == 'Linux' && matrix.vscode_version == 'stable'
-      - name: Upload vsix
-        uses: actions/upload-artifact@v4
-        if: runner.os == 'Linux' && matrix.vscode_version == 'stable'
-        with:
-          name: vsix
-          path: cursorless-development.vsix
+          version: ${{ matrix.app_version }}
+          neovim: true
+      - name: Run neovim unit tests using test-harness
+        run: xvfb-run -a pnpm -F @cursorless/test-harness testNeovim
+        if: runner.os == 'Linux' && matrix.app_version == 'stable'
+        env:
+          APP_PATH: ${{ steps.vim.outputs.executable }}
+      # - name: Create vscode dist that can be installed locally
+      #   run: pnpm -F @cursorless/cursorless-vscode populate-dist --local-install
+      #   if: runner.os == 'Linux' && matrix.app_version == 'stable'
+      # - name: Test create vsix
+      #   id: createVsix
+      #   uses: HaaLeo/publish-vscode-extension@v1
+      #   with:
+      #     pat: none
+      #     packagePath: packages/cursorless-vscode/dist
+      #     dryRun: true
+      # - run: mv ${{ steps.createVsix.outputs.vsixPath }} cursorless-development.vsix
+      #   if: runner.os == 'Linux' && matrix.app_version == 'stable'
+      # - name: Upload vsix
+      #   uses: actions/upload-artifact@v4
+      #   if: runner.os == 'Linux' && matrix.app_version == 'stable'
+      #   with:
+      #     name: vsix
+      #     path: cursorless-development.vsix
       - name: Archive logs
         uses: actions/upload-artifact@v4
         with:

.gitignore

@@ -5,6 +5,7 @@ node_modules
 *.vsix
 /package-lock.json
 *.DS_Store
+.luacheckcache
 
 # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 
@@ -42,3 +43,7 @@ next-env.d.ts
 
 # test subset config
 packages/test-harness/testSubsetGrep.properties
+
+# neovim symlinks
+cursorless.nvim/node/cursorless-neovim
+cursorless.nvim/node/test-harness

.luacheckrc

@@ -0,0 +1,8 @@
+std = luajit
+cache = true
+codes = true
+ignore = { "432" }
+
+globals = {
+    "vim",
+}

.pre-commit-config.yaml

@@ -81,3 +81,8 @@ repos:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
       - id: ruff-format
+  - repo: https://github.com/rwxcorp/pre-commit-lua.git
+    rev: v1.0.0
+    hooks:
+      - id: stylua
+      - id: luacheck

.stylua.toml

@@ -0,0 +1,5 @@
+column_width = 100
+line_endings = "Unix"
+indent_type = "Spaces"
+indent_width = 2
+quote_style = "AutoPreferSingle"

.vscode/extensions.json

@@ -7,7 +7,9 @@
     "dbaeumer.vscode-eslint",
     "esbenp.prettier-vscode",
     "jrieken.vscode-tree-sitter-query",
-    "wenkokke.tree-sitter-talon",
-    "usernamehw.commands"
+    "wenkokke.talonfmt-vscode",
+    "usernamehw.commands",
+    "sumneko.lua",
+    "JohnnyMorganz.stylua"
   ]
 }

.vscode/launch.json

@@ -5,6 +5,22 @@
 {
   "version": "0.2.0",
   "configurations": [
+    {
+      "name": "Run neovim extension",
+      "request": "attach",
+      "processName": "node.exe",
+      "skipFiles": ["<node_internals>/**"],
+      "preLaunchTask": "Build neovim extension",
+      "type": "node"
+    },
+    {
+      "name": "Neovim extension tests",
+      "request": "attach",
+      "processName": "node.exe",
+      "skipFiles": ["<node_internals>/**"],
+      "preLaunchTask": "Build neovim extension tests",
+      "type": "node"
+    },
     {
       "name": "Run extension",
       "type": "extensionHost",

.vscode/settings.json

@@ -7,7 +7,7 @@
     "editor.defaultFormatter": "AndreasArvidsson.andreas-talon"
   },
   "[talon]": {
-    "editor.defaultFormatter": "wenkokke.tree-sitter-talon"
+    "editor.defaultFormatter": "wenkokke.talonfmt-vscode"
   },
   "editor.defaultFormatter": "esbenp.prettier-vscode",
   // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
@@ -25,5 +25,10 @@
   "files.eol": "\n",
   "typescript.enablePromptUseWorkspaceTsdk": true,
   "typescript.tsdk": "node_modules/typescript/lib",
-  "eslint.workingDirectories": [{ "pattern": "packages/*/" }]
+  "eslint.workingDirectories": [{ "pattern": "packages/*/" }],
+  "Lua.runtime.version": "Lua 5.1",
+  "Lua.diagnostics.globals": ["vim", "talon"],
+  "[lua]": {
+    "editor.defaultFormatter": "JohnnyMorganz.stylua"
+  }
 }

.vscode/tasks.json

@@ -16,6 +16,118 @@
         "isDefault": true
       }
     },
+    {
+      "label": "Build neovim extension",
+      "dependsOn": [
+        "neovim start",
+        "ESBuild-neovim-registry",
+        "ESBuild-cursorless-neovim"
+      ],
+      "group": "build"
+    },
+    {
+      "label": "Build neovim extension tests",
+      "dependsOn": [
+        "neovim test start",
+        "ESBuild-neovim-registry",
+        "ESBuild-cursorless-neovim",
+        "TSBuild",
+        "Build test harness"
+      ],
+      "group": "build"
+    },
+    {
+      "label": "ESBuild-neovim-registry",
+      "type": "npm",
+      "script": "compile",
+      "path": "packages/neovim-registry",
+      "dependsOn": [],
+      "presentation": {
+        "reveal": "silent"
+      },
+      "group": "build"
+    },
+    {
+      "label": "ESBuild-cursorless-neovim",
+      "type": "npm",
+      "script": "compile",
+      "path": "packages/cursorless-neovim",
+      "dependsOn": ["ESBuild-neovim-common"],
+      "presentation": {
+        "reveal": "silent"
+      },
+      "group": "build"
+    },
+    {
+      "label": "ESBuild-common",
+      "type": "npm",
+      "script": "compile",
+      "path": "packages/common",
+      "presentation": {
+        "reveal": "silent"
+      },
+      "group": "build"
+    },
+    {
+      "label": "ESBuild-cursorless-engine",
+      "type": "npm",
+      "script": "compile",
+      "path": "packages/cursorless-engine",
+      "presentation": {
+        "reveal": "silent"
+      },
+      "group": "build"
+    },
+    {
+      "label": "ESBuild-neovim-common",
+      "type": "npm",
+      "script": "compile",
+      "path": "packages/neovim-common",
+      "presentation": {
+        "reveal": "silent"
+      },
+      "group": "build"
+    },
+    {
+      "label": "neovim start",
+      "type": "process",
+      "windows": {
+        "command": "powershell",
+        "args": [
+          "(New-Object -ComObject WScript.Shell).Run(\"\"\"nvim\"\"\", 1, $false)"
+        ]
+      },
+      "group": "build",
+      "options": {
+        "env": {
+          "CURSORLESS_REPO_ROOT": "${workspaceFolder}",
+          "NVIM_NODE_HOST_DEBUG": "1",
+          "NVIM_NODE_LOG_FILE": "${workspaceFolder}/packages/cursorless-neovim/out/nvim_node.log",
+          "NVIM_NODE_LOG_LEVEL": "info",
+          "CURSORLESS_MODE": "development"
+        }
+      }
+    },
+    {
+      "label": "neovim test start",
+      "type": "process",
+      "windows": {
+        "command": "powershell",
+        "args": [
+          "(New-Object -ComObject WScript.Shell).Run(\"\"\"nvim\"\"\", 1, $false)"
+        ]
+      },
+      "group": "build",
+      "options": {
+        "env": {
+          "CURSORLESS_REPO_ROOT": "${workspaceFolder}",
+          "NVIM_NODE_HOST_DEBUG": "1",
+          "NVIM_NODE_LOG_FILE": "${workspaceFolder}/packages/cursorless-neovim/out/nvim_node.log",
+          "NVIM_NODE_LOG_LEVEL": "info",
+          "CURSORLESS_MODE": "test"
+        }
+      }
+    },
     {
       "label": "Build extension only",
       "dependsOn": ["Populate dist", "ESBuild"],