Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gbaptista/fnx
A package manager for the Fennel language.
https://github.com/gbaptista/fnx
fennel fnx package-manager
Last synced: 7 days ago
JSON representation
A package manager for the Fennel language.
- Host: GitHub
- URL: https://github.com/gbaptista/fnx
- Owner: gbaptista
- License: mit
- Created: 2021-12-05T14:40:18.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-04-03T15:13:49.000Z (over 2 years ago)
- Last Synced: 2024-10-11T18:57:53.893Z (about 1 month ago)
- Topics: fennel, fnx, package-manager
- Language: Fennel
- Homepage: https://github.com/gbaptista/fnx
- Size: 90.8 KB
- Stars: 24
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fnx
A package manager for the [Fennel](https://fennel-lang.org/) language.
> _**Disclaimer:** It's an early-stage project, and you should expect breaking changes._
- [1-liner Installer](#1-liner-installer)
- [.fnx.fnl File](#fnxfnl-file)
- [Usage](#usage)
- [Embedding](#embedding)
- [Installing](#installing)
- [Options](#installation-options)
- [Requirements](#requirements)
- [Performance](#performance)
- [sudo](#sudo)
- [Debugging](#debugging)
- [Inside Fennel](#inside-fennel)
- [Development](#development)
- [Not a Roadmap](#not-a-roadmap)
## 1-liner Installer
You need to have all [requirements](#requirements) first.
```sh
curl -fsSL https://raw.githubusercontent.com/gbaptista/fnx/main/get-fnx.sh -o get-fnx.sh && sh get-fnx.sh
```
## `.fnx.fnl` File
The `.fnx.fnl` file is a regular Fennel source code in the root directory of your project that should return a table.
Example:
```fennel
{:name "my-package"
:version "0.0.1"
:dependencies {
:fspec {:fennel/local "../fspec"}
:supernova {:lua/local "../supernova"}
:splah {:fennel/fnx {:path "/home/splah"}}
:radioactive {:fennel/fnx {:git/url "https://git.sr.ht/~me/radioactive"}}
:fireball {:fennel/fnx {:git/url "https://github.com/me/fireball.git"}}
:moonlight {:fennel/fnx {:git/sourcehut "~me/moonlight" :commit "a6c728b"}}
:meteor {:fennel/fnx {:git/sourcehut "~me/meteor" :branch "main"}}
:jellyfish {:fennel/fnx {:git/sourcehut "~me/jellyfish" :tag "v0.0.1"}}
:purple-rain {:fennel/fnx {:git/github "me/purple-rain"}}
:red-sauce {:fennel/fnx {:git/gitlab "me/red-sauce"}}
:lemon {:fennel/fnx {:git/bitbucket "me/lemon"}}
:dkjson {:lua/rock ">= 2.5"}}}
```
| key | description |
|-----|-------------|
| `:name` | Your package name. |
| `:version` | Your package version. Follows [Semantic Versioning 2.0.0](https://semver.org/) |
| `:dependencies` | Your package dependencies. The example above should be self explanatory. |
## Usage
> _Try the [Hello World](https://github.com/gbaptista/fnx-hello-world) example._
Start by creating a [.fnx.fnl](#fnxfnl-file) file for your project.
| command | description |
|---------|-------------|
| `fnx` | It’s an alias for the `fennel` command that wraps it with `fnx` capabilities. Just use it as a replacement for anything that you would do with `fennel`. It accept any of the options available for the `fennel` command. |
| `fnx help` | List the available `fnx` commands. |
| `fnx version` | It returns the `fnx` version. |
| `fnx config` | It returns the current `fnx` configuration. |
| `fnx debug` | It returns `fnx` injections for the current directory or file. Use `-b` if you are [embedding](#embedding). |
| `fnx env` | Generates environment variables exports to make `fnx` [embeddable](#embedding). |
| `fnx dep` | Dependencies Manager CLI. It lists the available `fnx dep` commands. Its commands accept `--global` and `--local` for `luarocks`. The default is `--local`. |
| `fnx dep install` | Install the dependencies described in the `.fnx.fnl` file. Use `-f` to force the re-installation of all dependencies. Use `--verbose` for verbose mode. |
| `fnx dep uninstall` | Uninstall the dependencies described in the `.fnx.fnl` file. Use `-f` to skip confirmation. Use `--verbose` for verbose mode. |
| `fnx dep list` | It lists the dependencies described in the `.fnx.fnl` file. |
## Embedding
As is usual for Lua, you may want to embed Fennel into another language, e.g., [_Sweet Moon_](https://github.com/gbaptista/sweet-moon). In this scenario, you wouldn't have direct access to the `fnx` terminal command.
So, you can run `fnx env` to generate the necessary environment variables:
```shell
fnx env
export FENNEL_PATH=/home/me/.local/share/.fnx/core/?.fnl
export FNX_DATA_DIRECTORY=/home/me/.local/share/.fnx/
```
To actual export the variables, you can use:
```sh
eval "$(fnx env)"
```
You can also add the above line to your `.bashrc`, `.zshrc`, etc.
Then, in your embedded script, you can add:
```fennel
(local fnx (require :fnx))
(fnx.bootstrap!)
```
It automatically injects all your dependencies according to your `.fnx.fnl` file, similar to using the `fnx` command.
You may want to set a specific path to the `.fnx.fnl`:
```fennel
(local fnx (require :fnx))
(fnx.bootstrap! "/home/me/project/.fnx.fnl")
```
Alternative code, for isolation:
```fennel
(let [fnx (require :fnx)] (fnx.bootstrap!))
```
Or, for short:
```fennel
((. (require :fnx) :bootstrap!))
```
If you need debugging, check [this](#inside-fennel).
## Installing
You need to have all [requirements](#requirements) first.
Check the [1-liner Installer](#1-liner-installer) as well.
```sh
git clone [email protected]:gbaptista/fnx.git
cd fnx
luarocks install supernova --local
fennel run/install.fnl
```
### Installation Options
Options for the `fennel run/install.fnl` command:
| option | description |
|--------|-------------|
| `-s` | Use auto-detect information and skip questions. |
| `-f` | Use auto-detect information and overwrite files without confirmation. |
| `-d` | Install in development mode as a [symbolic link](https://en.wikipedia.org/wiki/Symbolic_link) for the source code. |
### Requirements
- [Lua](https://www.lua.org/download.html) `5.1` or later.
- [Fennel](https://fennel-lang.org/setup#downloading-fennel) `1.0.0` or later.
- [LuaRocks](https://github.com/luarocks/luarocks/wiki/Download)
- [Git](https://git-scm.com/)
- [Unix](https://en.wikipedia.org/wiki/Unix)
- [`sh`](https://en.wikipedia.org/wiki/Bourne_shell) [`chmod`](https://en.wikipedia.org/wiki/Chmod) `cp` `ln` `ls` `mkdir` `rm`
## Performance
You might not be happy with the performance of the `fnx` command compared to `fennel`.
Alternatively, to keep using the `fennel` command, you can do the same configuration used for [embedding](#embedding):
Export the environment variables:
```sh
eval "$(fnx env)"
```
Add into your entrypoint source code:
```fennel
(let [fnx (require :fnx)] (fnx.bootstrap!))
```
Done. Just run `fennel source.fnl` as usual instead of `fnx source.fnl`.
## sudo
If you need to use `fnx` with the `sudo` command, you may want to install `fnx` dependencies in the superuser context for a complete experience.
You can do that with:
```
sudo fnx sudo
```
## Debugging
You can run `fnx debug` to understand what exactly is being injected:
```sh
fnx debug
```
```
fspec
--add-package-path /.local/share/.fnx/packages/fspec/default/fspec/?.lua
--add-package-path /.local/share/.fnx/packages/fspec/default/?/init.lua
--add-fennel-path /.local/share/.fnx/packages/fspec/default/fspec/?.fnl
--add-fennel-path /.local/share/.fnx/packages/fspec/default/?/init.fnl
--add-macro-path /.local/share/.fnx/packages/fspec/default/fspec/?.fnl
--add-macro-path /.local/share/.fnx/packages/fspec/default/?/init-macros.fnl
--add-macro-path /.local/share/.fnx/packages/fspec/default/?/init.fnl
```
If you are [embedding](#embedding), you can run:
```sh
fnx debug -b
```
```
fspec fspec
package.path /.local/share/.fnx/packages/fspec/default/fspec/?.lua
package.path /.local/share/.fnx/packages/fspec/default/?/init.lua
fennel.path /.local/share/.fnx/packages/fspec/default/fspec/?.fnl
fennel.path /.local/share/.fnx/packages/fspec/default/?/init.fnl
fennel.macro-path /.local/share/.fnx/packages/fspec/default/fspec/?.fnl
fennel.macro-path /.local/share/.fnx/packages/fspec/default/?/init-macros.fnl
fennel.macro-path /.local/share/.fnx/packages/fspec/default/?/init.fnl
```
### Inside Fennel
> **Warning:** The `debug` namespace is for debugging only purposes. Its API is unstable and may change anytime. Please don't use it in a way that your project depends on it.
To debug inside Fennel, you need first to ensure that your environment is ready for [embedding](#embedding).
Then, you can use the `debug` namespace:
```fnl
(local fnx (require :fnx))
(local fennel (require :fennel))
(print (fennel.view (fnx.debug.injections)))
; [{:destination "package.path"
; :package "fspec"
; :path "/home/me/.local/share/.fnx/packages/fspec/default/fspec/?.lua"}
; {:destination "package.path"
; :package "fspec"
; :path "/home/me/.local/share/.fnx/packages/fspec/default/?/init.lua"}
; {:destination "fennel.path"
; :package "fspec"
; :path "/home/me/.local/share/.fnx/packages/fspec/default/fspec/?.fnl"}
; ...
(print (fennel.view (fnx.debug.packages)))
; [{:package "fspec" :language "fennel"}
; {:package "supernova" :language "lua"}]
(print (fennel.view (fnx.debug.dot-fnx-path)))
; "/home/me/my-project/.fnx.fnl"
(fnx.bootstrap!)
```
If you are using a custom `.fnx.fnl` file:
```fnl
(local fnx (require :fnx))
(local custom-dot-fnx "/home/me/some-project/.fnx.fnl")
(fnx.debug.injections custom-dot-fnx)
(fnx.debug.packages custom-dot-fnx)
(fnx.debug.dot-fnx-path custom-dot-fnx)
(fnx.bootstrap! custom-dot-fnx)
```
## Development
```
fnx dep install
fnx run/test.fnl
```
## Not a Roadmap
A list of things that I don't have time to do or that just aren't itching me enough to do something about it, but I would like to do it someday, eventually:
- [ ] binaries;
- [ ] `fnx dep add`;
- [ ] `fnx dep remove`;
- [ ] Lock file;
- [ ] Actually use the version numbers for something;
- [ ] Improve performance;
- [ ] Get inspired by [nix](https://nixos.org) to improve the approach;
- [ ] Provide Windows Support.