[LSP] `source.fixAll` code action should be `source.fixAll.pyrefly`

[rchl]

Describe the Bug

Pyrefly advertizes support for source.fixAll code action in the initialize response:

{
  "capabilities": {
    "callHierarchyProvider": true,
    "codeActionProvider": {
      "codeActionKinds": [
        "quickfix",
        "refactor.extract",
        "refactor.rewrite",
        "refactor.delete",
        "refactor.move",
        "refactor.inline",
        "source.fixAll"
      ]
    },
  },
  // ...
}

This should actually be source.fixAll.pyrefly which then would allow the editor to only target purefly-specific fixes with:

    "editor.codeActionsOnSave": {
        "source.fixAll.pyrefly": true
    },

Otherwise it's only possible to use:

    "editor.codeActionsOnSave": {
        "source.fixAll": true
    },

which then can trigger fixes from other servers that might be running on the file.

Sandbox Link

No response

(Only applicable for extension issues) IDE Information

No response

[NathanTempest]

Thanks for reporting @rchl

You're correct, this should be source.fixAll.pyrefly to follow the LSP convention used by ESLint, Ruff, Stylelint, etc. This allows users to selectively enable/disable Pyrefly's fix-all independently when multiple language servers are active. Without this, when using the automatic code actions, there is a high chance of conflicts.

PR #3039 from @Arths17 is linked to fix this

cc @kinto0 for review.

[kinto0]

thanks for the report! i'm curious - why isn't this an issue for the other code action kinds?

[NathanTempest]

For the other code actions like 'refactor' or 'quickfix' the actions need to be performed manually via clicking the lightbulb or cmd + click, these then populate the suggestions from the linters but we do not run into conflicts because we can manually select a specific linter's suggestion.

This is not the case with fixAll because the corrective actions by the linters will apply automatically on save(if that codeAction was enabled), and if we have multiple linters, it might lead to some conflicts or improper / redundant fixes. As such, we go for the fixAll.pyrefly option to only accept the changes from Pyrefly on save.

[NathanTempest]

Hello @rchl I have checked out the changes from @Arths17 PR which is linked to close this issue out, and built the Pyrefly binary locally with those changes. And in settings.json in our local code editor (VSCode) we have enabled the new code action to apply the changes automatically on save -

"editor.codeActionsOnSave": {
        "source.fixAll.pyrefly": "always"
    },

This was the test file that I created that shows the redundant casts -

After saving this file (Cmd + S), the code action should have triggered and fixed this redundant cast

Is this the behavior that we are expecting or do we need to implement this any other way.

@Arths17 would appreciate any additional insights regarding this

[rchl]

The fix should trigger on save both when using source.fixAll.pyrefly or source.fixAll.

[NathanTempest]

Setup:
Built Pyrefly from this branch, pointed VS Code to the local binary via pyrefly.lspPath, and tested fix-on-save with a file containing redundant casts.

Results:

"source.fixAll.pyrefly": "always" - Yes
"source.fixAll": "always" - No
The generic source.fixAll no longer triggers pyrefly's fix-on-save. Users who have "source.fixAll": "always" in their settings (which is a very common configuration) would lose fix-on-save after this change.

Will try to implement the fix for this on top of @Arths17 PR