https://github.com/nvim-neorocks/lux
A luxurious package manager for Lua
https://github.com/nvim-neorocks/lux
luarocks package-manager
Last synced: about 1 year ago
JSON representation
A luxurious package manager for Lua
- Host: GitHub
- URL: https://github.com/nvim-neorocks/lux
- Owner: nvim-neorocks
- License: mit
- Created: 2024-01-11T08:11:52.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-03-31T11:52:18.000Z (about 1 year ago)
- Last Synced: 2025-03-31T12:28:46.220Z (about 1 year ago)
- Topics: luarocks, package-manager
- Language: Rust
- Homepage: https://nvim-neorocks.github.io/
- Size: 1.99 MB
- Stars: 93
- Watchers: 7
- Forks: 2
- Open Issues: 52
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# A [WIP] Library & Client implementation of [`luarocks`](https://github.com/luarocks/luarocks)
> [!WARNING]
>
> **lux is a work in progress
> and does not have a stable release yet.**
Lux serves as an application for:
- Installing and managing rocks
- Creating Lua projects with dependencies, build scripts and desired Lua versions
- Creating and publishing your own rocks
- Embedding rock manipulation logic into your own application
> [!NOTE]
>
> This aims to be a full rewrite of `luarocks`, with many flags altered to be more
> ergonomic. This is not a drop-in replacement for `luarocks` commands you may have in scripts.
## :books: Usage
```sh
lx
```
To view available options and their descriptions, run `lx --help`.
## Comparison with [`luarocks v3.11.1`](https://github.com/luarocks/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 (incomplete) comparison:
| | lux | luarocks v3.11.1 |
| --- | --- | --- |
| project RockSpec format | TOML | Lua |
| `builtin` build spec | :white_check_mark: | :white_check_mark: |
| `make` build spec | :white_check_mark: | :white_check_mark: |
| `cmake` build spec | :white_check_mark: | :white_check_mark: |
| `command` build spec | :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) |
| RockSpecs with CVS/Mercurial/SVN/SSCM sources | :x: (YAGNI[^2]) | :white_check_mark: |
| install pre-built binary rocks | :white_check_mark: | :white_check_mark: |
| parallel builds/installs | :white_check_mark: | :x: |
| install multiple packages with a single command | :white_check_mark: | :x: |
| install packages using version constraints | :white_check_mark: | :x: |
| proper lockfile support with integrity checks | :white_check_mark: | :x: (basic, dependency versions only) |
| auto-detect external dependencies and Lua headers with `pkg-config` | :white_check_mark: | :x: |
| automatic lua detection/installation | :white_check_mark: | :x: |
| resolve multiple versions of the same dependency at runtime | :white_check_mark: | :white_check_mark: |
| run tests with busted | :white_check_mark: | :white_check_mark: |
| code formatting with stylua | :white_check_mark: | :x: |
| linting with luacheck | :white_check_mark: | :x: |
| static type checking | :x: (planned) | :x: |
| pack and upload pre-built binary rocks | :white_check_mark: | :white_check_mark: |
| add/remove dependencies | :white_check_mark: | :x: |
| luarocks.org manifest namespaces | :white_check_mark: | :white_check_mark: |
| luarocks.org dev packages | :white_check_mark: | :white_check_mark: |
| versioning | SemVer[^3] | arbitrary |
[^1]: Supported via a compatibility layer that uses luarocks as a backend.
[^2]: [You Aren't Gonna Need It.](https://martinfowler.com/bliki/Yagni.html)
[^3]: 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.
## :book: License
Lux is licensed under [MIT](./LICENSE).
## :green_heart: Contributing
Contributions are more than welcome!
See [CONTRIBUTING.md](./CONTRIBUTING.md) for a guide.