:globe_with_meridians: Fully Compatible with the Ecosystem
Works with existing LuaRocks packages.
Have a complex rockspec that you don't want to rewrite to TOML? No problem!
Lux allows the creation of an extra.rockspec file, everything just works.
Have a very complex build script? Lux can shell out to luarocks if it detects it has
to preserve maximum compatibility.
:gear: How To Use
Feel free to consult the documentation on how to get started with Lux!
It features a tutorial and several guides to make you good at managing Lua projects.
[!NOTE]
Lux, while fully functional, is a work in progress
and does not have a 1.0 release yet.
:bar_chart: Comparison with LuaRocks
As this project is still a work in progress, some LuaRocks features
have not been fully implemented yet.
On the other hand, Lux has some features that are not present in LuaRocks.
The following table provides a brief comparison:
| | Lux | LuaRocks v3.13.0 |
| --- | --- | --- |
| Project format | TOML / Lua | Lua |
| Add/remove dependencies | :white_check_mark: | :x: |
| Parallel builds/installs | :white_check_mark: | :x: |
| Proper lockfile support with integrity checks | :white_check_mark: | :x: (basic, dependency versions only) |
| Run tests with busted | :white_check_mark: | :white_check_mark: |
| Linting with luacheck | :white_check_mark: | :x: |
| Code formatting with stylua, luafmt, or emmylua_codestyle | :white_check_mark: | :x: |
| Automatic lua detection/installation | :white_check_mark: | :x: |
| Default build specs | :white_check_mark: | :white_check_mark: |
| Custom build backends | :white_check_mark:[^1] | :white_check_mark: |
| rust-mlua build spec | :white_check_mark: (builtin) | :white_check_mark: (external build backend) |
| treesitter-parser build spec | :white_check_mark: (builtin) | :white_check_mark: (external build backend) |
| Install prebuilt binary rocks | :white_check_mark: | :white_check_mark: |
| Install multiple packages with a single command | :white_check_mark: | :x: |
| Install packages using version constraints | :white_check_mark: | :x: |
| Auto-detect external dependencies and Lua headers with pkg-config | :white_check_mark: | :x: |
| Resolve multiple versions of the same dependency at runtime | :white_check_mark: | :white_check_mark: |
| Pack and upload prebuilt binary rocks | :white_check_mark: | :white_check_mark: |
| Luarocks.org manifest namespaces | :white_check_mark: | :white_check_mark: |
| Luarocks.org dev packages | :white_check_mark: | :white_check_mark: |
| Versioning | SemVer[^2] | arbitrary |
| Rockspecs with CVS/Mercurial/SVN/SSCM sources | :x: (YAGNI[^3]) | :white_check_mark: |
| Load installed packages from multiple install trees | :x: (#1493) | :white_check_mark: |
| Static type checking | :white_check_mark: | :x: |
| Generate a .luarc file with dependencies | :white_check_mark: | :x: |
| Git dependencies in local projects | :white_check_mark: | :x: |
| Local dependencies in local projects | :white_check_mark: | :x: |
| Multiple projects in a single workspace | :white_check_mark: | :x: |
| Vendor sources for offline use | :white_check_mark: | :x: |
| Distribute install tree archives | :white_check_mark: | :x: |
| Distribute static binaries | :white_check_mark: | :x: |
| Load RockSpecs and LuaRocks manifests with full sandboxing | :white_check_mark: | :x: |
[^1]: Supported via a compatibility layer that uses LuaRocks as a backend.
[^2]: Mostly compatible with the LuaRocks version parser,
which allows an arbitrary number of version components.
To comply with SemVer, we treat anything after the third version component
(except for the specrev) as a prerelease/build version.
[^3]: You Aren't Gonna Need It.
:package: Packages
Lux includes the following packages and libraries:
lux-cli: The main CLI for interacting with projects and installing Lua packages
from the command line.
lux-lua: The Lux Lua API, which provides:
lux.loader for resolving dependencies on require at runtime.
A work-in-progress API for embedding Lux into Lua applications.
We provide builds of lux-lua for Lua 5.1, 5.2, 5.3, 5.4, 5.5 and LuaJIT.
lux-cli uses lux-lua for commands like lx lua, lx run and lx path.
lux-lib: The Lux library for Rust. A dependency of lux-cli and lux-lua.
[!NOTE]
Lux can detect a lux-lua installation using pkg-config
or via the LUX_LIB_DIR environment variable.
rocks.nvim - A Neovim plugin manager that uses luarocks under the hood, and will soon be undergoing a rewrite to use Lux instead.
:purple_heart: Credits
Credits go to the LuaRocks team for maintaining LuaRocks and luarocks.org for as long as they have.
Without their prior work Lux would not be possible.
:green_heart: Contributing
Contributions are more than welcome!
See CONTRIBUTING.md for a guide.