Merge branch 'main' into pr/C-Loftus/2061

Author: AndreasArvidsson

.editorconfig

@@ -22,13 +22,13 @@ insert_final_newline = false
 # with a line that has trailing white space. Many of our recorded
 # tests use strings with trailing white space to represent the final
 # document contents. For example
-# packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/ruby/changeCondition.yml
+# data/fixtures/recorded/languages/ruby/changeCondition.yml
 trim_trailing_whitespace = false
 
 [Makefile]
 indent_style = tab
 
-[**/vendor/**]
+[**/{vendor,generated}/**]
 charset = unset
 end_of_line = unset
 indent_size = unset

.envrc

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

.eslintrc.json

@@ -4,38 +4,60 @@
   "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", "unused-imports", "import", "unicorn"],
+  "plugins": [
+    "@typescript-eslint",
+    "unused-imports",
+    "import",
+    "unicorn",
+    "mocha"
+  ],
   "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"
@@ -51,32 +73,48 @@
       "error",
       "MemberExpression[object.property.name='constructor'][property.name='name']"
     ],
-    "no-throw-literal": "warn",
+    "no-throw-literal": "error",
     "semi": "off",
-    "unicorn/prefer-module": "error"
+    "unicorn/prefer-module": "error",
+    "mocha/no-skipped-tests": "error",
+    "mocha/no-exclusive-tests": "error"
   },
   "overrides": [
     {
       "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", "**/out/**"]
+  "ignorePatterns": [
+    "**/generated/**",
+    "**/out/**",
+    "**/vendor/**/*.js",
+    "**/vendor/**/*.ts",
+    "/data/playground/**"
+  ]
 }

.github/CODEOWNERS

@@ -1 +1,9 @@
-*       @pokey @AndreasArvidsson
+* @cursorless-dev/code-owners
+
+*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/DISCUSSION_TEMPLATE/architectural-decision-record.yml

@@ -0,0 +1,27 @@
+body:
+  - type: markdown
+    attributes:
+      value: |
+        You are submitting to our Architecture Decision Record.
+        Learn more about ADRs at <https://adr.github.io>, and discussion #1211.
+
+  - type: textarea
+    attributes:
+      label: Context
+      description: The issue motivating this decision, and any context that influences or constrains the decision.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Options considered
+
+  - type: textarea
+    attributes:
+      label: Decision
+      description: "The change that we're proposing or have agreed to implement."
+
+  - type: textarea
+    attributes:
+      label: Consequences
+      description: What becomes easier or more difficult to do and any risks introduced by the change that will need to be mitigated.

.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

@@ -45,7 +45,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL

.github/workflows/codeql.yml

@@ -14,13 +14,13 @@ jobs:
     env:
       CURSORLESS_REPO_ROOT: ${{ github.workspace }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: pnpm/action-setup@v2
-      - uses: actions/setup-node@v3
+      - run: corepack enable
+      - uses: actions/setup-node@v4
         with:
-          node-version-file: package.json
+          node-version-file: .nvmrc
           cache: pnpm
       - run: pnpm --color install
       - run: pnpm --color compile
@@ -40,13 +40,53 @@ 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 }}
+      STAGING_DIRECTORY: ${{ github.workspace }}/cursorless.nvim-staging
+    steps:
+      - uses: actions/checkout@v4
+      - 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
+      - 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@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
           token: ${{ secrets.CURSORLESS_BOT_TOKEN }}