Skip to content

Add globaldefinitions to .config.luau for Luau embedders #199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tapple wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add globaldefinitions to .config.luau for Luau embedders #199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f67367
add `globaldefinitions` to .config.luau
tapple May 5, 2026
9660b5a
trailing comma
tapple May 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/config-luauconfig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ return {
linterrors = true,
typeerrors = true,
globals = {"expect"},
globaldefinitions = "./embed.d.luau",
aliases = {
src = "./src"
}
Expand Down Expand Up @@ -81,6 +82,7 @@ type LuauConfig = {
linterrors: boolean?,
typeerrors: boolean?,
globals: { string }?,
globaldefinitions: string?,
aliases: { [string]: string }?,
}

Expand Down
4 changes: 3 additions & 1 deletion docs/config-luaurc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ applied. When multiple files are used, the file closer to the .lua file override
- `"lintErrors"`: a boolean that controls whether lint issues are reported as errors or warnings (off by default)
- `"typeErrors"`: a boolean that controls whether type issues are reported as errors or warnings (on by default)
- `"globals"`: extra global values; points to an array of strings where each string names a global that the type checker and linter must assume is valid and of type `any`
- `"globalDefinitions"`: string path to a local filename. This is a file in the same luau-like language embedded inside `Analysis/src/EmbeddedBuiltinDefinitions.cpp`, and provides additional global definitions to the typechecker and linter.

Example of a valid .luaurc file:

Expand All @@ -34,7 +35,8 @@ Example of a valid .luaurc file:
"languageMode": "nonstrict",
"lint": { "*": true, "LocalUnused": false },
"lintErrors": true,
"globals": ["expect"] // TestEZ
"globals": ["expect"], // TestEZ
"globalDefinitions" = "./embed.d.luau"
}
```

Expand Down