Merge branch 'main' into pr/josharian/1723

Author: AndreasArvidsson

.envrc

@@ -0,0 +1 @@
+use flake

.eslintrc.json

@@ -4,12 +4,15 @@
   "extends": [
     "eslint:recommended",
     "plugin:@typescript-eslint/recommended",
+    // We want to enable this in the long run. For now there are a lot of errors that needs to be handled.
+    // "plugin:@typescript-eslint/recommended-requiring-type-checking",
     "plugin:import/typescript",
     "prettier"
   ],
   "parserOptions": {
     "ecmaVersion": 6,
-    "sourceType": "module"
+    "sourceType": "module",
+    "project": true
   },
   "plugins": [
     "@typescript-eslint",
@@ -20,28 +23,41 @@
   ],
   "rules": {
     "import/no-relative-packages": "error",
+    "@typescript-eslint/consistent-type-imports": "error",
     "@typescript-eslint/consistent-type-assertions": [
       "error",
       {
         "assertionStyle": "as"
       }
     ],
-    "@typescript-eslint/naming-convention": "warn",
+    "@typescript-eslint/naming-convention": [
+      "error",
+      {
+        "selector": ["objectLiteralProperty"],
+        "format": ["camelCase"],
+        "filter": {
+          "regex": "[.]",
+          "match": false
+        }
+      }
+    ],
+    "@typescript-eslint/no-floating-promises": "error",
     "@typescript-eslint/no-explicit-any": "off",
     "@typescript-eslint/no-inferrable-types": "off",
     "@typescript-eslint/no-non-null-assertion": "off",
     "unused-imports/no-unused-imports": "error",
     "@typescript-eslint/no-unused-vars": [
-      "warn",
+      "error",
       {
         "argsIgnorePattern": "^_",
         "varsIgnorePattern": "^_",
+        "caughtErrorsIgnorePattern": "^_",
         "ignoreRestSiblings": true
       }
     ],
-    "curly": "warn",
+    "curly": "error",
     "eqeqeq": [
-      "warn",
+      "error",
       "always",
       {
         "null": "never"
@@ -57,7 +73,7 @@
       "error",
       "MemberExpression[object.property.name='constructor'][property.name='name']"
     ],
-    "no-throw-literal": "warn",
+    "no-throw-literal": "error",
     "semi": "off",
     "unicorn/prefer-module": "error",
     "mocha/no-skipped-tests": "error",
@@ -68,28 +84,37 @@
       "files": ["*.tsx"],
       "rules": {
         "@typescript-eslint/naming-convention": [
-          "warn",
+          "error",
           {
             "selector": ["function"],
             "format": ["PascalCase", "camelCase"]
           }
         ]
       }
+    },
+    {
+      "files": [
+        "jest.config.ts",
+        "docusaurus.config.mts",
+        "mdx-components.tsx",
+        "typings/**"
+      ],
+      "extends": ["plugin:@typescript-eslint/disable-type-checked"]
     }
   ],
   "settings": {
     "import/resolver": {
       "typescript": {
         "alwaysTryTypes": true, // always try to resolve types under `<root>@types` directory even it doesn't contain any source code, like `@types/unist`
-
         "project": ["tsconfig.json", "packages/*/tsconfig.json"]
       }
     }
   },
   "ignorePatterns": [
-    "**/vendor/**/*.ts",
-    "**/vendor/**/*.js",
+    "**/generated/**",
     "**/out/**",
-    "**/generated/**"
+    "**/vendor/**/*.js",
+    "**/vendor/**/*.ts",
+    "/data/playground/**"
   ]
 }

.github/CODEOWNERS

@@ -1,4 +1,9 @@
-*       @pokey @AndreasArvidsson
+* @cursorless-dev/code-owners
 
-*keyboard* @pokey @AndreasArvidsson @josharian
-*Keyboard* @pokey @AndreasArvidsson @josharian
+*keyboard* @cursorless-dev/code-owners @josharian
+*Keyboard* @cursorless-dev/code-owners @josharian
+
+*neovim* @cursorless-dev/code-owners @saidelike @fidgetingbits
+*Neovim* @cursorless-dev/code-owners @saidelike @fidgetingbits
+*nvim* @cursorless-dev/code-owners @saidelike @fidgetingbits
+*Nvim* @cursorless-dev/code-owners @saidelike @fidgetingbits

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,7 +1,17 @@
+<!--
+Thanks for your change!
 
+* Remember to *add tests* if you have added a new feature, or fixed a bug.
+    Use the test case recorder: https://www.cursorless.org/docs/contributing/test-case-recorder
 
-## Checklist
+* Remember to *update the docs* if you've added a new feature.
+    Link: https://github.com/cursorless-dev/cursorless/tree/main/docs
 
-- [ ] I have added [tests](https://www.cursorless.org/docs/contributing/test-case-recorder/)
-- [ ] I have updated the [docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and [cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet)
-- [ ] I have not broken the cheatsheet
+* Remember to *test the cheatsheet manually* if you've added a new action,
+  modifier, or scope -- or changed any Talon files.
+
+Remove this comment.
+-->
+
+
+## Release notes

.github/PULL_REQUEST_TEMPLATE/new_programming_language.md

@@ -0,0 +1,13 @@
+name: "Lua Language Server Lint"
+description: "Lints all lua files with lua-language-server"
+runs:
+  using: "composite"
+  steps:
+    - uses: cachix/install-nix-action@v27
+      with:
+        nix_path: nixpkgs=channel:nixos-unstable
+    - uses: DeterminateSystems/magic-nix-cache-action@v2
+    - run: nix profile install --accept-flake-config .#lua-language-server
+      shell: bash
+    - run: scripts/lint-lua-ls.sh
+      shell: bash

.github/actions/lint-lua-ls/action.yml

@@ -0,0 +1,17 @@
+name: "Neovim Lua Tests"
+description: "Set up Neovim Lua environment and run Busted tests"
+runs:
+  using: "composite"
+  steps:
+    - uses: leafo/gh-actions-lua@v10
+      with:
+        luaVersion: "luajit-openresty"
+    - uses: leafo/gh-actions-luarocks@v4
+    - shell: bash
+      run: |
+        luarocks install busted
+        luarocks install luafilesystem
+    - shell: bash
+      run: |
+        cd cursorless.nvim
+        busted --run unit

.github/actions/test-neovim-lua/action.yml

@@ -13,52 +13,130 @@ jobs:
     environment: production
     env:
       CURSORLESS_REPO_ROOT: ${{ github.workspace }}
+
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout repository
+        uses: actions/checkout@v4
         with:
+          # This is needed to get the number of commits in the current branch
           fetch-depth: 0
-      - run: corepack enable
-      - uses: actions/setup-node@v4
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+
+      - name: Set up Node.js
+        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
+
+      - name: Install dependencies
+        run: pnpm --color install
+
+      - name: Compile
+        run: pnpm --color compile
+
+      - name: Build
+        run: pnpm --color --filter '!cursorless-org' --filter '!cursorless-org-*' build
         env:
           CURSORLESS_DEPLOY: true
+
       - name: Publish to Open VSX Registry
         id: publishToOpenVSX
         uses: HaaLeo/publish-vscode-extension@v1
         with:
           pat: ${{ secrets.OPEN_VSX_TOKEN }}
           packagePath: packages/cursorless-vscode/dist
+
       - name: Publish to Visual Studio Marketplace
         uses: HaaLeo/publish-vscode-extension@v1
         with:
           pat: ${{ secrets.VS_MARKETPLACE_TOKEN }}
           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 }}
+      STAGING_DIRECTORY: ${{ github.workspace }}/cursorless.nvim-staging
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: .nvmrc
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm --color install
+
+      - name: Compile
+        run: pnpm --color compile
+
+      - name: Build
+        run: pnpm --color --filter '!cursorless-org' --filter '!cursorless-org-*' build
+        env:
+          CURSORLESS_DEPLOY: true
+
+      - name: Checkout cursorless.nvim plugin repo
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.CURSORLESS_BOT_TOKEN }}
+          repository: hands-free-vim/cursorless.nvim
+          path: ${{ env.STAGING_DIRECTORY }}
+
+      - name: Configure GPG Key
+        working-directory: ${{ env.STAGING_DIRECTORY }}
+        run: |
+          echo -n "$GPG_SIGNING_KEY" | base64 --decode | gpg --import
+        env:
+          GPG_SIGNING_KEY: ${{ secrets.CURSORLESS_BOT_GPG_SIGNING_KEY }}
+
+      - name: git config
+        working-directory: ${{ env.STAGING_DIRECTORY }}
+        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 ${{ env.STAGING_DIRECTORY }}
+
   push-cursorless-talon:
     name: Push cursorless-talon subrepo
     runs-on: ubuntu-latest
     needs: publish-extension
     environment: production
+
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout repository
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
           token: ${{ secrets.CURSORLESS_BOT_TOKEN }}
+
       - 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
-      - run: bash -x scripts/deploy-cursorless-talon.sh
+
+      - name: Push cursorless-talon subrepo
+        run: bash -x scripts/deploy-cursorless-talon.sh

.github/workflows/deploy.yaml

@@ -9,7 +9,10 @@ on:
 jobs:
   forbid-todo:
     runs-on: ubuntu-latest
+
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
       - name: Forbid TODO
         run: ./scripts/forbid-todo.sh

.github/workflows/forbid-todo.yml

@@ -0,0 +1,30 @@
+name: PR Description
+
+on:
+  pull_request:
+    types: [opened, edited, reopened, synchronize]
+  merge_group:
+    branches: [main]
+
+jobs:
+  validate-pr-description:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Validate description
+        run: |
+          # Fetch PR description from env with jq
+          PR_DESCRIPTION=$(jq -r ".pull_request.body" "$GITHUB_EVENT_PATH")
+          KEYWORD="REQUIRED_KEYWORD"
+
+          # Ensure PR author removed the welcome comment
+          if [[ $PR_DESCRIPTION = *"<!--"* ]] || [[ $PR_DESCRIPTION = *"-->"* ]]; then
+            echo "FAILED: Please remove the welcome comment from your PR description."
+            exit 1
+          else
+            echo "OK: Welcome comment is removed your PR description."
+          fi
+
+          echo "PASS: All checks OK!"