vscode-wow-api icon indicating copy to clipboard operation
vscode-wow-api copied to clipboard

Question: Is this extension making settings.json changes automatically?

Open McTalian opened this issue 9 months ago • 3 comments

When I open up my project in VSCode (or perform a window reload), my .vscode/settings.json is modified like so:

Image

As such, the other sub directory FrameXML is not loaded into the Lua Language Server and I lose all the type hints for those definitions.

Simply backing out the change causes things to go back to normal, but I can't figure out what is causing these automatic changes to begin with. I'm hoping you have an idea so I can disable this automatic change.

Thank you!

EDIT: I found this in the Wiki, reading right now

https://github.com/Ketho/vscode-wow-api/wiki/Settings#dev-mode

EDIT2: I am going to try running with devMode. I wonder if the extensions should be adding both /Core and /FrameXML to the library paths automatically. Then I wouldn't really have to mess around with it. From the wiki, it seems like that's the intent, but maybe the automatic library settings adjustment code wasn't updated since the directory structure changed in the last few updates?

Or I'm completely off base and just not following / doing something weird on my end 😅

McTalian avatar Jun 07 '25 18:06 McTalian

Ok, this can probably be closed. I looked through the code and found that wowApi.luals.frameXML was an option, so I added that and removed dev mode from my config and things are automatically updating my settings in the way I like 😄

  "wowAPI.luals.frameXML": true,
  "Lua.workspace.library": [
    "${addons}/busted/module/library",
    "${3rd}/luassert/library",
    "${addons}/luassert/module/library",
    "~/.vscode-server/extensions/ketho.wow-api-0.20.7/Annotations/Core",
    "~/.vscode-server/extensions/ketho.wow-api-0.20.7/Annotations/FrameXML"
  ]

I probably just didn't read the right portions of documentation.

I'll leave the issue open in case you want to use it as a note to update the Wiki or any docs. I did a quick retrospective scan through the README, the SETUP, and the Wiki settings portion and didn't see a mention of luals.frameXML option. But I guess if I went into the extension's options in the Settings UI instead of JSON, I may have figured this out quicker.

Thanks again for the extension! I appreciate how much it improves my developer experience with WoW addon development.

McTalian avatar Jun 07 '25 18:06 McTalian

Yes, this extension is automatically making settings.json changes and you indeed should have used the option to include the FrameXML folder.

I did not document the FrameXML option on the wiki since I assumed users would look at the options first before reading the wiki docs if at all, but I probably should now and then close the issue; including a quick overview on how the extension functions.

The devMode setting is my lazy and hands-off approach to giving the user full control over the configuration. Happy it works for you now :)

Ketho avatar Jun 07 '25 23:06 Ketho

@Ketho makes sense!

Where did you assume users would look at the options? In the settings UI in VSCode? I want to make sure I'm looking in the right places when using extensions. (I haven't authored my own extension, so some of the nuances are still a bit foreign to me).

McTalian avatar Jun 08 '25 14:06 McTalian