fix(pyright): pyright.organizeimports command fails

Language server `pyright` does not support command `pyright.organizeimports`.
This command may require a client extension.

Author: michelesr

.github/ci/lint.sh

@@ -53,7 +53,7 @@ _check_lsp_cmd_prefix() {
 
 # Enforce client:exec_cmd().
 _check_exec_cmd() {
-  local exclude='eslint'
+  local exclude='eslint\|pyright\|basedpyright'
   if git grep -P 'workspace.executeCommand' -- 'lsp/*.lua' | grep -v "$exclude"  ; then
     _fail 'Use client:exec_cmd() instead of calling request("workspace/executeCommand") directly. Example: lsp/pyright.lua'
   fi

lsp/basedpyright.lua

@@ -43,10 +43,13 @@ return {
   },
   on_attach = function(client, bufnr)
     vim.api.nvim_buf_create_user_command(bufnr, 'LspPyrightOrganizeImports', function()
-      client:exec_cmd({
+      local params = {
         command = 'basedpyright.organizeimports',
         arguments = { vim.uri_from_bufnr(bufnr) },
-      })
+      }
+
+      -- cannot use client:exec_cmd() as it will fail due to the LSP command not being advertised by the server
+      client.request('workspace/executeCommand', params, nil, bufnr)
     end, {
       desc = 'Organize Imports',
     })

lsp/pyright.lua

@@ -43,10 +43,13 @@ return {
   },
   on_attach = function(client, bufnr)
     vim.api.nvim_buf_create_user_command(bufnr, 'LspPyrightOrganizeImports', function()
-      client:exec_cmd({
+      local params = {
         command = 'pyright.organizeimports',
         arguments = { vim.uri_from_bufnr(bufnr) },
-      })
+      }
+
+      -- cannot use client:exec_cmd() as it will fail due to the LSP command not being advertised by the server
+      client.request('workspace/executeCommand', params, nil, bufnr)
     end, {
       desc = 'Organize Imports',
     })