[BUG]: Code actions not displaying correctly

[tashi21]

Issue Description

Codebook is not showing any code actions for spelling mistakes it is recognising. But it is only happening for .py files. It is working as expected in .go files (these are the only files I have used codebook on so far I don't know if this issue extends to other languages).

Another issue is that it is not flagging the same spelling error in the files. Please see the attached images for context.

Operating System

macOS

Editor

Zed

Codebook Version

No response

Configuration

dictionaries = [
    "en_us",
    "en_gb",
]
words = [
    "crm",
    "dbutil",
    "gst",
    "mailjet",
    "oauth",
    "ontrip",
    "pfx",
    "raaho",
    "rebalance",
    "salesorder",
    "zoho",
    "zohobooksclient",
    "zohooauthclient",
]

Steps to Reproduce

1. Open a python file.
2. Make a typo.

Expected Behavior

See code actions to replace with possible spellings or add to dictionary.

Actual Behavior

No code actions displayed.

Code Sample

Log Output

Additional Context

Python file:

Go file:

[blopker]

Hey! Thanks for raising this. It is a known issue, but I don't believe it's been documented here.

Basically, Zed is not sending the same data to Codebook with Python that other languages have. There are several open Zed issues around Python support, so it may just be an issue with Zed.

If anyone has any clues, I'd love to know.

[tashi21]

Ah, I understand. Yeah, Python support in Zed still has a bunch of bugs.

What about the issue where the same spelling mistakes are not flagged by Codebook? In this case it is flagging both in Python and missing one in Go.

[blopker]

Ah, I missed that discrepancy. Because Zed is not sending the right requests to Codebook for Python, Codebook is treating Python like a text file. For Go, there seems to be a bug in the tree sitter query we use that isn't picking up that variable

That is something we can fix! I don't use Go much, so the query can definitely be improved.

[blopker]

Hey, I dug into this some more. I assumed it was a Zed issue, but after a bunch of testing, my issue (at least) is a settings.json issue. I had set language_servers for Python and Codebook wasn't defined. I've added this to the README:

---

If quickfix code actions are not showing up for specific languages, ensure your settings.json file incudes the special "..." value in any language_servers values defined:

"languages": {
  "Python": {
    "language_servers": ["pyright", "ruff", "..."],
    "format_on_save": "on"
  }
},

---

Now my quick actions work in Python!

[blopker]

K, I just released a new version with a better Go query. Let me know if that settings.json fix doesn't work for you though.

[tashi21]

If quickfix code actions are not showing up for specific languages, ensure your settings.json file incudes the special "..." value in any language_servers values defined:

Yes this absolutely worked! And if anyone wants to keep specific LSPs only they can do this as well:

"languages": {
  "Python": {
    "language_servers": ["pyright", "ruff", "codebook"]
  }
}

[blopker]

Awesome, I've added the explicit "codebook" example to the readme too. Thanks!