Instructions are not clear for using in VS Code

[rboy1]

Is there a wiki or page that explains how to install the Lua extension in VS Code and then run the Lua code from within VS Code.
I've installed Lua, VSCode and this extension in VS Code: https://marketplace.visualstudio.com/items?itemName=sumneko.lua&ssr=false#overview

I've configured the Lua.library.workspace to point to the external libraries root folder

What I'm not seeing:

1. When I open a LUA file, it doesn't seem to auto complete or reference any of the classes/functions from the external library
2. How do I run the LUA code from within VS Code? There seems to be a reference to this link, but it's not exactly clear what needs to be done and how to get it running through Windows: https://github.com/sumneko/lua-language-server/wiki/Build-and-Run-%28In-VSCode%29

[sumneko]

1. It may be that your settings are wrong, please show me your settings.
2. This extension only provides language server, not running or debugging code.
   You need to install other debugging extension, such as: https://marketplace.visualstudio.com/items?itemName=actboy168.lua-debug

[rboy1]

Sure, I appreciate the response:

{
"editor.suggestSelection": "first",
"vsintellicode.modify.editor.suggestSelection": "automaticallyOverrodeDefaultValue",
"Lua.workspace.library": {
"C:/ST Lua/lua_libs-api_v0/lua_libs-api_v0": true,
}
}

I've installed the lua-debug and extension-path exntesions. Is there a wiki or can you share the steps on how to get Lua running through VS or if you can share the steps that would be brilliant!

[sumneko]

I don't know what your project is, so I can't give you an accurate answer. But you can refer to this project, see https://github.com/sumneko/lua-language-server/blob/master/.vscode/launch.json

[rboy1]

@sumneko

I'm not able to get this to work so I'm trying again from scratch. I looked at the instructions again, and I did all this:

Install sumneko.lua in VSCode
Install extension-path in VSCode
Install ninja
Clone source code
git clone https://github.com/sumneko/vscode-lua
cd vscode-lua
git submodule update --init --recursive

Then the instructions say:

Open repo and execute tasks in VSCode
PreCompile
Compile
Install

This is not clear, open "which" repo in VSCode and where do I find the tasks? I don't see any project or workspace files in either sumenko.lua or in lua-language-server.

[rboy1]

At this time I only want VSCode to be able to reference the external libraries being used and help me autocomplete the code I'm writing (like referencing members, definitions etc)

[sumneko]

In vscode, you just need to install it from market
https://github.com/sumneko/vscode-lua/raw/master/images//Install%20In%20VSCode.gif

[sumneko]

At this time I only want VSCode to be able to reference the external libraries being used and help me autocomplete the code I'm writing (like referencing members, definitions etc)

First of all, auto-completion and running your code are two completely different functions. This extension only provides the former.
After installing this extension, you can first try to use the auto-completion function in the same workspace to see if it can normally prompt content from another file in the same workspace.
If it works, you can try to use Lua.workspace.library to add files in other directories.

[rboy1]

Yes I did that. I've also set the Lua ->Workspace: Library to the directory where the third party libraries/source lua files lie. Despite that autocomplete doesn't work.

A simple example, ziglib folder (and the constants lua file is within the ziglib folder) is lying in root directory C:\Lua Libs\RadioLibs and I've included the root directory path in the workspace settings

local constants = require "ziglib.constants"
local zigSettings = constants.

When I type in the . I'm expecting it to show me the list of members from the constants object - but nothing shows up.

Here is what C:\Lua Libs\RadioLibs\ziglib\constants.lua contains:

local constants = {}
constants.PROFILE_ID = 0x0104
constants.PROFILE_ID_1 = 0xC05E
return constants

Does it automatically load files from sub-directories also within that workspace library? Is there anything else I can check?

[sumneko]

Does it automatically load files from sub-directories also within that workspace library? Is there anything else I can check?

Yes.
Please check the hover of required string, show me the hovet content

[rboy1]

Nothing pops up when I hover over constants or the require line

[rboy1]

VSCode 1.61.2 and Window 10 64 bit if that helps

[sumneko]

Nothing pops up when I hover over constants or the require line

It should at least shows 16 bytes.
Please show me your log, see wiki to find the log path.

[rboy1]

I think I figured it out, apparently closing and reopening VS Code isn't enough for the extension to take effect. I had to close the workspace and create a new workspace, reopen the file and then it loaded all the symbols/libraries. Now it's working - thanks for your help.