You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: reposition around Lua 5.1 interop rather than general scripting (#12)
The README led with 'embed Lua 5.1 in your Node.js programs', which invites a
comparison against wasmoon and fengari that this package loses: both need no
C++ toolchain, and requiring one is a real barrier.
That comparison is also the wrong one. The reason to reach for this is that you
need Lua 5.1 *exactly* -- to interoperate with a runtime you do not control,
such as firmware, Redis scripting or OpenResty -- or that you need real
filesystem and process access rather than a sandbox. No no-compile alternative
can offer either, because they target a different Lua version and run
sandboxed.
Adds an honest 'is this the right package?' section that names those
alternatives and says plainly when to prefer them. Sending the wrong users away
costs nothing; the right ones can now recognise their problem.
Also documents that this is stock PUC-Rio Lua 5.1.5 and not LuaJIT, so
precompiled bytecode is not interchangeable with a LuaJIT target -- source and
C API compatibility are unaffected. And records that Node-API is ABI-stable
across Electron as well as Node, which is what makes the addon usable inside a
VS Code extension without rebuilding per host release.
npm description and keywords updated to match, since that is what appears in
search results.
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: package.json
+5-2Lines changed: 5 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
{
2
2
"name": "node-lua-runner",
3
3
"version": "2.0.1",
4
-
"description": "Embed Lua 5.1 in Node.js. Lua and LuaFileSystem are compiled into the addon, so there is nothing to install on the system.",
4
+
"description": "Real Lua 5.1 in Node.js, for tooling that must interoperate with a Lua 5.1 runtime. A Node-API native addon with the genuine Lua 5.1.5 interpreter and LuaFileSystem compiled in.",
0 commit comments