Support for source.fixAll code action

[muirdm]

There apparently is a kind of code action called source.fixAll meant to be automatically run in save hooks. I learned of this via gopls, but it is mentioned here. Should we add support in lsp-mode to make it easier to set up a hook, perhaps by adding a function to invoke this kind of code action similar to lsp-organize-imports?

Have we considered automatically configuring save hooks for organizeImports/format-buffer?

[ericdallo]

I didn't know about that kind, I think we could check the source kind and run a custom lsp hook

@yyoncho what do you think?

[yyoncho]

I think it most likely narrows down to what @muirdm mentioned:

perhaps by adding a function to invoke this kind of code action similar to lsp-organize-imports

@muirdm

Have we considered automatically configuring save hooks for organizeImports/format-buffer?

IMO this should be a user option. A lot of users does like intrusive code changes because it introduces unrelated changes to what they are doing now.

[samhedin]

Alright, I have no idea how LSP or elisp works, but over summer I have time to spend some time to learn. Would this only be a matter of copy-pasting everything related lsp-organize-imports and changing some key areas?

(defun lsp-organize-imports ()
  "Perform the source.organizeImports code action, if available."
  (interactive)
  (condition-case nil
      (lsp-execute-code-action-by-kind "source.organizeImports")
    (lsp-no-code-actions
     (when (called-interactively-p 'any)
       (lsp--info "source.organizeImports action not available")))))

to

(defun lsp-fix-all ()
  "Perform the source.fixAll code action, if available."
  (interactive)
  (condition-case nil
      (lsp-execute-code-action-by-kind "source.fixAll")
    (lsp-no-code-actions
     (when (called-interactively-p 'any)
       (lsp--info "source.fixAll action not available")))))

"ro" lsp-organize-imports (lsp-feature? "textDocument/codeAction")
to
"ra" lsp-fix-all (lsp-feature? "textDocument/codeAction")?

I also added it to the list in lsp--client-capabilities.

Testing on this file:

package main

import "fmt"

func main() {
	var pow = []int{1, 2, 3, 4}
	for _ = range pow {
		fmt.Println("yes")
	}
}

Running source.fixAll from vscode results in the syntax in the for loop changing.

package main

import "fmt"

func main() {
	var pow = []int{1, 2, 3, 4}
	for range pow {
		fmt.Println("yes")
	}
}

However, running lsp-fix-all just gives LSP :: source.fixAll action not available. This might just be my setup though, as I installed go and all tools just to give this a try. lsp-organize-Imports works great though.

Suggestions and guidance welcome! I'll keep trying, about time I got into this considering how much I use LSP.

[muirdm]

When I was trying the source.fixAll action I found that it only worked for the fixes on the current line (i.e. line cursor was on). If I selected a region, it would apply all fixes in the region. I didn't look into it beyond that, so I'm not sure if it ls lsp-mode or gopls responsible for that. Of course, ideally it would apply all fixes in the current file.

[samhedin]

Works just great in vscode, no matter what line I am on with

"[go]": {
        "editor.codeActionsOnSave": {
            "source.fixAll": true,
        }
    },

[leungbk]

When I was trying the source.fixAll action I found that it only worked for the fixes on the current line (i.e. line cursor was on). If I selected a region, it would apply all fixes in the region. I didn't look into it beyond that, so I'm not sure if it ls lsp-mode or gopls responsible for that. Of course, ideally it would apply all fixes in the current file.

I'm encountering the same issue with gopls, which is weird because I'd have expected it to scan through the entire buffer and work from anywhere. I did not encounter this with the ESLint server. I don't really know Golang, so I wouldn't know how to set up the gopls server for proper debugging.

[yyoncho]

Seems like we should change lsp--text-document-code-action-params which ATM
returns only the diagnostics on the current line/region. What we should most
likely do is to check if this is fix-all request and collect all diagnostics in
the buffer.

[leungbk]

Seems like we should change lsp--text-document-code-action-params which ATM
returns only the diagnostics on the current line/region. What we should most
likely do is to check if this is fix-all request and collect all diagnostics in
the buffer.

The thing that confuses me is that ESLint's source.fixAll.eslint really does work from anywhere in the buffer for me in Emacs. Both servers have code that appears to loop through all the diagnostics for the fixAll action, so it feels like it shouldn't be the client's responsibility.

[yyoncho]

Then I guess we should check what vscode does. Fix all might be working only on
the region(we have the expected behavior) while eslint for which fix all is
much more common has introduced another method which does not require selecting
the buffer

[sethen]

Any progress on this? I am running into the same issue