LuaLS / LuaLS/vscode-lua

Include LuaCATS library with a dependent extension

Open
#127 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
215
Forks
62
PR merge metrics
No merged PRs in 30d

Description

Hi,

I have a set of LuaCATS types for a proprietary SDK: https://github.com/notpeter/playdate-luacats/

I would like to create a simple VSCode extension which depends upon sumneko.lua and bundles those types. Is this possible?

If it is not currently possible, I believe vscode-lua could provide a public API for other extensions by adding additional functions to the object returned from the activate(context: vscode.ExtensionContext) function:

https://github.com/LuaLS/vscode-lua/blob/7b58d50b4ea5feb1a478e6b0c18194ca1d1192a1/client/src/extension.ts#L33-L37

See: VSCode extensions API Documentation.

This exported API could be something simple like library_add(path) so I can provide a path to a subdirectory in my extension bundle for my lua ---@meta files.

I would love to attempt this myself, but I'm still struggling setup a working extension development environment. See: https://github.com/LuaLS/vscode-lua/discussions/125.

Thanks again for creating a great extension.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with client/src/extension.ts around lines 33-37 and the VS Code extensions API documentation, then review the linked extension-development discussion for setup context. Determine whether a dependent extension can bundle LuaCATS types or whether a public API is needed; done means the supported integration path is established and documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua, typescript, vscode
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.