Shared Require Complement

Companion extension for luau-lsp focused on Luau/Lua projects that use sharedRequire("...").

What It Does

• Go to Definition for sharedRequire("...") (Ctrl+Click).
• Quick Fix for module does not return exactly 1 value.
• Automatic sharedRequire path updates on rename/move.
• Organize Imports for local X = sharedRequire("...") lines.
• sharedRequire("*.json") support with automatic .json.lua shims.
• Sync aliases and custom definition files with luau-lsp.
• Sync patched luau-lsp binary (optional).

Commands

• Shared Require: Sync Custom Luau Definition Files
• Shared Require: Sync Diagnostics Config
• Shared Require: Sync Aliases to luau-lsp
• Shared Require: Organize sharedRequire Imports
• Shared Require: Sync JSON Require Shims
• Shared Require: Sync Patched luau-lsp

Default Aliases

• @utils -> files/utils
• @classes -> files/classes
• @visuals -> files/visuals
• @services -> files/services
• @security -> files/security
• @modules -> files/modules
• @libraries -> files/libraries
• @UILibrary -> files/UILibrary

Defaults Applied to luau-lsp

• luau-lsp.platform.type = "roblox"
• luau-lsp.sourcemap.enabled = false
• luau-lsp.sourcemap.autogenerate = false

Runtime Definitions Location

On startup, the extension synchronizes sharedRequire.d.luau to VS Code global storage and points luau-lsp.types.definitionFiles.shared_require_runtime to that machine-local path:

• Windows: %APPDATA%\\Code\\User\\globalStorage\\starhub-community.shared-require-complement\\definitions
• macOS: ~/Library/Application Support/Code/User/globalStorage/starhub-community.shared-require-complement/definitions
• Linux: ~/.config/Code/User/globalStorage/starhub-community.shared-require-complement/definitions

Rojo Compatibility

This extension can interfere with Rojo-based workflows and may cause Rojo integration to behave incorrectly when both are used together. If your project depends on Rojo sourcemaps or Rojo-managed luau-lsp behavior, use this extension with caution.

Note

Community project, not official.