[Feature Request] Multiple-project/Monorepo support

[dljsjr]

I work with a large monorepo that contains multiple Lua project roots. You can actually see the list of Lua projects here, as an example: https://github.com/SmartThingsCommunity/SmartThingsEdgeDrivers/tree/main/drivers/SmartThings

Loading this entire repo at once doesn't work well because of how the require paths are established via runtime.path. The primary issue is that it leads to ambiguous require resolution if two of the roots have files with the same name.

Obviously, one workaround is to use a multi-root workspace and only add the folders for the projects I currently care about, but that's tedious since I'd be adding and removing folders from the workspace constantly.

One idea that I had was being able to specify an "entrypoint" glob. The plugin could traverse up the directory tree looking for a file that matches the glob, and then use that as the root for all local requires. But that might not be a good "general" solution even though it works well for my use case.

[CppCXY]

The feature request might be reasonable, but it seems difficult to implement for the current LuaLS. It requires separating the indexing/cache of the project to different projects based on URI, which might need significant changes to the current LuaLS.

[tomlau10]

(non-perfect solution)

Obviously, one workaround is to use a multi-root workspace and only add the folders for the projects I currently care about, but that's tedious since I'd be adding and removing folders from the workspace constantly.

I just found an extension Monorepo Workspace: https://marketplace.visualstudio.com/items?itemName=folke.vscode-monorepo-workspace

• it will auto search any folders containing a package.json in your root workspace (because it is designed for nodejs projects I guess)
• and then it has a command Monorepo: Select Workspace Folder for you to dynamically add / remove any detected packages folder
• but as said it requires package.json in your package folder first, you might have to write a script to create each for your sub folder. The following is a script generated by chatgpt, then modified a bit by me, which creates a package.json with a name field equals to that of the sub folder:

  #!/bin/bash
  cd drivers/SmartThing
  current_dir=$(pwd)
  for dir in */; do
  if [ -d "$dir" ]; then
  cd "$dir" || continue
  subfolder_name=${dir%/}
  echo "{ \"name\": \"SmartThings/$subfolder_name\" }" > package.json
  cd "$current_dir" || exit
  fi
  done

• finally you can have a selection UI like this when you trigger the Monorepo: Select Workspace Folder command:

---

hope that helps a bit before LuaLS can have a better support for monorepos 🙂

[dljsjr]

What I actually did was write a bash + jq script that generates a _.code-workspace JSON file instead 😅

[tomlau10]

I see, but how do you dynamically add / remove folders to the workspace? Regenerate the .code-workspace json? Or just by vscode's standard UI Add/Remove Folder to Workspace? 🤔

The above suggested plugin's selection UI can do filtering on all detected sub folders, also it provides a select/unselect all option in that UI.