Skip to content

Support EmmyLua analyzer and brong EmmyLua annotations - #551

Draft
ligurio wants to merge 9 commits into
masterfrom
ligurio/gh-xxxx-emmylua-annotations
Draft

Support EmmyLua analyzer and brong EmmyLua annotations#551
ligurio wants to merge 9 commits into
masterfrom
ligurio/gh-xxxx-emmylua-annotations

Conversation

@ligurio

@ligurio ligurio commented Aug 11, 2026

Copy link
Copy Markdown
Member

No description provided.

The patch introduces an initial configuration file .emmyrc for
emmylua_check, it is a modern static analuzer for Lua.

The configuration file has the same excluded directories as in
.luacheckrc and config disables a number of rules. Most of them
will be enabled back in the following commits except the following
rules:
- "unresolved-require" (7 warnings) is disabled because most modules
are Tarantool builtins: `json`, `log`, `uuid`; no source code is
included in the project.
- "need-check-nil" (22 warnings) is disabled because these
warnings are not critical and I don't want to add extra checks
to the code.
- "redefined-local" is disabled because it was disabled for
luacheck in the commit 49fa005dab08a1b206771e89e5231f779cccf914
("test: add linting stage").
The patch enables rule "access-invisible" and fixes a single
warning produced by this rule.
The warning is actually is a false positive in the analyzer's
bundled std library. `math.randomseed(0)` is valid in LuaJIT
(5.1 semantics), but the analyzer's built-in `std/math.lua` tags
it with PUC Rio Lua versions only, not LuaJIT.
@ligurio
ligurio marked this pull request as draft August 11, 2026 15:19
@ligurio
ligurio force-pushed the ligurio/gh-xxxx-emmylua-annotations branch from 2e849b6 to a56f711 Compare August 11, 2026 15:22
@ligurio
ligurio force-pushed the ligurio/gh-xxxx-emmylua-annotations branch from a56f711 to 00484bf Compare August 11, 2026 15:25
The patch adds EmmyLua annotations to the public-API files and
minimal descriptions (based on the API reference) for all public
functions.

Needed for tarantool/tarantool#13020
@ligurio
ligurio force-pushed the ligurio/gh-xxxx-emmylua-annotations branch from 00484bf to 8cefd0f Compare August 11, 2026 15:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant