https://github.com/alexaandru/fennel-nvim

Fennel shim for Neovim
https://github.com/alexaandru/fennel-nvim

Last synced: 11 days ago
JSON representation

Fennel shim for Neovim

• Host: GitHub
• URL: https://github.com/alexaandru/fennel-nvim
• Owner: alexaandru
• License: mit
• Created: 2022-07-02T12:20:07.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-07-20T18:44:34.000Z (over 2 years ago)
• Last Synced: 2024-04-16T00:08:29.972Z (7 months ago)
• Language: Fennel
• Size: 7.81 KB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# fennel-nvim

Yet another [Fennel](https://fennel-lang.org/) shim for [Neovim](https://neovim.io/).

## Description

A tiny(iest?) Fennel shim.

I was really curious to see what does it take to do it, specifically: what

is the least amount of work you needed to do.

That, and I wanted to write it in Fennel itself, as much as possible 😎

Inspired by [Moonwalk](https://github.com/gpanders/nvim-moonwalk).

### Design

It adds a fennel loader to `package.loaders` and it hooks up to `SourceCmd` for

`*.fnl` so it can resolve `:source` and `:runtime` commands.

It also adds a caching layer on top of that. That's it.

## Usage

Get it in your `rtp` "somehow" (use your plugin manager, git clone it, whatever)

and then load it before you attempt to run any `.fnl` code. You can see an example

of being used [here](https://github.com/alexaandru/nvim-config/blob/master/init.vim).

## Status

What works:

- `require()` any `/fnl/**/*.fnl` (from either Lua or Fennel);

- `:source` fennel scripts;

- `[/after]/plugin/**/*.fnl` automatic loading;

- optional `/ftplugin/*.fnl` filetype plugin loading (see below);

- all requests are logged to `stdpath("cache")/fennel-shim.log`, and the logfile

  is flushed async, every 1s;

- caching so that the fennel compile price is only paid once.

You can see it in action here, where it loads all my ~**700**LOC [config files](https://github.com/alexaandru/nvim-config),

as well as my four plugins and one colorscheme.

### Ftplugin support

Support for ftplugin is disabled by default as it is costly. You can enable it

by setting `vim.g.fennel_shim_ftplugin` to either true or any valid pattern

for `autocmd` (see `:he {aupat}`).

### Colorscheme support

The `:colorscheme` command is hardwired to look for `colors/.{vim,lua}`

which obviously excludes .fnl files. There is also no event similar to `SourceCmd`

to hook up to. That means one line of _lua_ code is required, to load the rest of the

_fennel_ color scheme. See [froggy](https://github.com/alexaandru/froggy) for an example.

### Benchmark

It is only 1.1 times slower than [Hotpot](https://github.com/rktjmp/hotpot.nvim) (which is what I've been previously using).

Benchmark was done by running `nvim --startuptime x +q` 10 times for each.

I got a **196**ms avg. startup time with Hotpot and **224**ms with this shim.

At the same time it is only ~**100**LOC, not counting blank lines, vs. +**6.3K**LOC for Hotpot.

## Similar Projects

- [Hotpot](https://github.com/rktjmp/hotpot.nvim);

- [Moonwalk](https://github.com/gpanders/nvim-moonwalk);

- [Tangerine](https://github.com/udayvir-singh/tangerine.nvim);

- [Aniseed](https://github.com/Olical/aniseed).