Need help with aniseed?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

Olical
330 Stars 18 Forks The Unlicense 464 Commits 8 Opened issues

Description

Neovim configuration and plugins in Fennel (Lisp compiled to Lua)

Services available

!
?

Need anything else?

Contributors list

# 30,925
Clojure...
eventem...
Lua
Neovim
456 commits
# 115,950
Elixir
Neovim
ecto
Lisp
2 commits
# 13,231
pytorch
Flask
Socket....
topic-m...
2 commits
# 321,948
Shell
Lua
Lisp
Neovim
2 commits
# 105,276
Python
feed-re...
Lisp
Neovim
1 commit
# 395
React
CSS
Node.js
freecod...
1 commit
# 256,195
Neovim
vim-col...
viml
vim-scr...
1 commit
# 308,498
Clojure
rust-bi...
Emacs
emacs-l...
1 commit

= Aniseed https://conjure.fun/discord[image:https://img.shields.io/discord/732957595249410108.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2[Discord]]

Aniseed bridges the gap between https://fennel-lang.org/Fennel and https://neovim.io/[Neovim]. Allowing you to easily write plugins or configuration in a https://clojure.org/[Clojure]-like Lisp with great runtime performance.

https://asciinema.org/a/326401[image:https://asciinema.org/a/326401.svg[asciicast]]

Further documentation can be found in link:doc/aniseed.txt[

:help aniseed
]. There you can learn about the scripts, macros, functions and use cases of Aniseed.

== Installation

Use your favourite plugin manager, I recommend https://github.com/junegunn/vim-plug[vim-plug] if you don't have one already.

[source,viml]

Plug 'Olical/aniseed', { 'tag': 'v3.23.0' }

For interactive evaluation you need to install https://github.com/Olical/conjure[Conjure]. It'll allow you to send portions of your code off for evaluation as well as see the results in an interactive log buffer.

You may also be interested in https://github.com/Olical/nvim-local-fennel[nvim-local-fennel] which is essentially a Fennel based version of https://github.com/embear/vim-localvimrc[localvimrc].


I'm working on a Neovim + Aniseed + Conjure starter kit that contains everything you need over at https://github.com/Olical/magic-kit[Olical/magic-kit]. It's not finished yet but feel free to check it out and give me some early feedback! You can start your Neovim configuration at that point and grow it in your own direction from there.


== Loading Fennel Neovim configuration

Aniseed has a module called

aniseed.env
which will automatically compile and load Fennel code from your Neovim configuration directory as if it were natively supported by the editor, like Lua and VimL.

See https://github.com/Olical/dotfiles/tree/a950167446c656a6ba10ddf7400072cd0107c24c/stowed/.config/nvim/fnl[Olical/dotfiles] for a detailed example configuration. To enable this same automatic loading of your Fennel configuration you need to install Aniseed and add the following option. This is documented further within

:help aniseed
.

[source,viml]

let g:aniseed#env = v:true

Now the following code in

~/.config/nvim/fnl/init.fnl
will be compiled and executed when you open Neovim.

[source,clojure]

;; The name is up to you. (module nvim-config {autoload {a aniseed.core}})

(a.println "Hello, World!")

== Setting up a plugin project

scripts/seed.sh
is provided to make it a little easier to get a plugin up and running. In a new directory (because it will overwrite your
.gitignore
and
Makefile
etc) run the following command.

It will name the plugin after the directory you're currently running it from. Make sure the directory name doesn't include any spaces or special characters because it will be inserted at some points in the seed code for you.

[source,bash]

curl -fL https://raw.githubusercontent.com/Olical/aniseed/master/scripts/seed.sh | sh

This will create some example Fennel source and tests as well as a

Makefile
to help you compile and run it all. This should be enough to get you started without being overly opinionated.

== Unlicenced

The following files are excluded from my license and ownership:

  • lua/aniseed/deps/fennel.lua
  • lua/aniseed/deps/fennelview.lua
  • lua/aniseed/deps/nvim.lua

These files come from https://fennel-lang.org/[Fennel] and https://github.com/norcalli/nvim.lua[nvim.lua], I did not write them, all other files are from me and unlicenced. The aforementioned files should be considered under their respective project licences. They are copied into this repo to allow the plugin to work with systems that don't support symlinks correctly.

Find the full http://unlicense.org/[unlicense] in the

UNLICENSE
file, but here's a snippet.

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.


We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.