Implement hovers for user-created functions & variables

[loganch]

Given that we are capable of obtaining completions and signatures, I believe that implementing hover functionality should be feasible.

[danielbarnes]

This would be really cool, I have alot of UDF and being able to navigate them with F12 like I can with SciTE would be a great time saver! Cheers

[sven-seyfert]

I have alot of UDF and being able to navigate them with F12 like I can with SciTE

Hi @danielbarnes 👋 ,

where are your UDF files located? The default AutoIt "includes" folder is already searchable / reachable by F12 ("Go to Definition" in VSCode). The included files like #include "my-fancy-udf.au3" are also reachable by F12. So where do you store your files?

In my specific case, I had to adjust the extension a little bit in my fork repo. Because I store UDFs (or simply named module au3 files) in directories like "src" and "lib". Therefore I extended the extension in this way.

Best regards
Sven

[danielbarnes]

Thanks for your comment, I did fork the source before commenting, I spent an hour trying to figure out how to get it to run in vs code as an extension but ultimately gave up. I have about 50 au3 files in another folder (eg. c:\autoit\source) and have specified that folder in settings.json: "autoit.includePaths": [
"C:\\autoit\\Source"] but I can't navigate via the includes (I use #include <myudf.au3>) or via the function names (eg. func myfunc())

I might try cloning your fork and having another go getting the extension running in vs code again as source. Cheers

[sven-seyfert]

Using my fork would not help you at all. Because with the next Release here, your extension.js file would be overwritten again.
Folder: C:\Users\your-profile-name-here\.vscode\extensions\damien.autoit-1.0.12\dist\.

I guess I can provide you an work-around for your specific directory. But this wouldn't be the best way.

I have about 50 au3 files in another folder (eg. c:\autoit\source)

In case you want a work-around that could be overwritten anytime, but would work until the next Release (they don't happen very often), let me know and let my also know in which directory you store your UDFs. Because this would be hard coded.

==> The result would be a new extension.js file which you would replace with the current one. See path above. That's it. Not elegant, but works for me since months.

Best regards
Sven

[danielbarnes]

Yea I meant more that I can see in your code where I need to modify the extension. You have pointed me in the right direction in the code.

I thought the extension would include folders in the autoit.includePaths json settings, but it doesn't appear to, So my plan is to modify it so it does... I'm not really sure what the includePaths setting is for if it isn't for this...

Any tips on how to build a vscode extension? Can you just put the source in the C:\Users\your-profile-name-here.vscode\extensions\newfolder and it will work?

I tried some Microsoft tutorials and it built and opened a new visual studio code window with [Extension Development Host] at the top but none of the extension functionality was there...

[sven-seyfert]

I thought the extension would include folders in the autoit.includePaths json settings, but it doesn't appear to, So my plan is to modify it so it does... I'm not really sure what the includePaths setting is for if it isn't for this...

I didn't check this (autoit.includePaths) setting at all, because I would have to add for each of my projects a absolute "src" and "lib" path in that json setting array. That's not what I want and so I did it another way like you could see.

But actually you're right. It would be nice to use this setting/option by absolute directory path, by partly paths like finding "src" or finding "lib" etc. from the root level of the project. I guess I will anaylze the code behind "autoit.includePaths" and hopefully come up with a proper solution.

Any tips on how to build a vscode extension? Can you just put the source in the C:\Users\your-profile-name-here.vscode\extensions\newfolder and it will work?

A - In a short explanation way, for this specific repository/project:

1. You must have node.js installed.
2. You fork the repo or do a git clone directly without fork (doesn't really matter unless you want to setup a pull request).
3. You get the node module dependencies by npm install (ensure you also get webpack)
4. Now you are able to build the VSCode extension by the package.json "scripts"-commands here

• This means you can do npm run vscode:prepublish to create a "dist" folder with the minified extension.js file in it.
• This file can simply replace the current extension file in C:\Users\your-profile-name-here\.vscode\extensions\damien.autoit-1.0.12\dist\

Of course you have to modify the extension by your code (between 3. and 4.) to get a difference to the current extension file 😅 .

B - Own VSCode extension:

⚠ More robust would it be when you create your own VSCode extension based on this project/repo. By forking and publishing in the Microsoft way (of VSCode extensions). In this way it would by a separate VSCode extension and a different folder to "damien.autoit-1.0.12" (when you install the extension from the marketplace).

I think there is also another way to register your new VSCode extension directly to your VSCode (without the marketplace action and publishing action), but I am not familiar with that.

I am sure there are video tutorials and so one to this topic 😅 .

---

==> Hopefully this wil help a bit and I will take a deeper look into "autoit.includePaths". Maybe I can simple come up with fix for this setting and create a PR. Then all other things above here are irrelevant 😂 .

Best regards
Sven