~xerool/fennel-ls

A language server for intelligent editing of the Fennel Programming Language

cf794d4 Flag that fennel-ls supports 1.4.2

~xerool pushed to ~xerool/fennel-ls git

2 days ago

#18 How to debug when failing to run?

~xerool commented on fennel-ls todo

2 days ago

#fennel-ls

A language server for fennel. Supports Go-to-definition, and a little bit of completion suggestions. Fennel-LS uses static analysis, and does not execute your code.

For now, you can ask fennel-ls to treat your file as a macro file if the very first characters in the file exactly match ;; fennel-ls: macro-file. Expect this to change at some point in the future when I come up with a better way to specify which files are meant to be macro files.

#Building / Installing

The build dependencies are make and lua. Lua 5.1 or higher is needed. Every other dependency is already included in the repository. See the License section at the bottom of the readme if you care about what other dependencies are being used.

Pick your favorite command to build and install the language server.

make && sudo make install # to install into /usr/local/bin
make && make install PREFIX=$HOME # if you have ~/bin on your $PATH

#NixOS

If you are using NixOS, you may use the included /flake.nix or /default.nix to to build the language server configure a development environment.

#LuaRocks

If you are specifically the Neovim plugin mason.nvim, or have some other reason to support building on Windows, you may want to use the command:

luarocks install fennel-ls --tree /path/to/your/new/luarocks/tree

#Set Up Your Editor

Once you've installed the binary somewhere on your computer, the next step is to set up your text editor! Each editor has a different way of doing it.

If you are using vim+lspconfig, it is pretty simple:

require('lspconfig').fennel_ls.setup()

For Emacs, (eglot, built-in to 29+):

(with-eval-after-load 'eglot
  (add-to-list 'eglot-server-programs '(fennel-mode . ("fennel-ls"))))

It should be possible to set up for other text editors, but the instructions depend on which editor you use. Generally you need to give this information to your editor:

  • "fennel-ls" is a language server program on the $PATH
  • it should be run for .fnl files.

#Batch mode

You can gather diagnostics without connecting your editor:

fennel-ls --check my-file.fnl f2.fnl # prints diagnostics for the files given

This will analyze the given files, and print out all compiler errors and lints.

#Default Settings

fennel-ls can be configured over LSP. Any setting that's not provided will be filled in with the defaults, which means that {} will be a valid configuration with default settings. You can provide different settings in the same shape as the default settings in order to override the defaults.

fennel-ls default settings:

{
  "fennel-ls": {
    "fennel-path": "./?.fnl;./?/init.fnl;src/?.fnl;src/?/init.fnl",
    "macro-path": "./?.fnl;./?/init-macros.fnl;./?/init.fnl;src/?.fnl;src/?/init-macros.fnl;src/?/init.fnl",
    "checks": {
      "unused-definition": true,
      "unknown-module-field": true
    },
    "extra-globals": ""
  }
}

extra-globals : Space separated list of allowed global identifiers; in addition to a set of predefined lua globals.

Your editor can send these settings using one of these two methods:

  • The client sends an initialize request with the structure {initializationOptions: {"fennel-ls": {...}}, ...}
  • The client sends a workspace/didChangeConfiguration notfication containing the field {settings: {"fennel-ls": {YOUR_SETTINGS}}}

#Adding a lint

You can't load external lint rules with fennel-ls, but I would love to receive patches that add new lint rules! Instructions to add a lint.

#License

fennel-ls is licensed under the MIT license. See LICENSE for more info. This project also contains files from other projects:

  • test/pl/* comes from Penlight [MIT license]
    • (LICENSE)[test/pl/LICENSE.md]
  • src/fennel-ls/json/* is modified, but is originally from json.lua [MIT license]
    • (LICENSE)[src/fennel-ls/json/LICENSE]
  • src/fennel-ls/docs/* contains information from the lua reference [MIT license]
  • test/lust.lua is modified, but originially comes from from lust [MIT license]
  • fennel and src/fennel.lua are compiled from fennel [MIT license]