Config.fnl

Table of contents

• cfg-fn
• config-file-path?
• default
• find
• find-and-load
• path-dirs

cfg-fn

Function signature:

(cfg-fn t opts)

Builds a cfg fetcher for the config table t. Returns a function that takes a path sequential table, it looks up the value from the config with core.get-in and falls back to a matching value in (default) if not found.

config-file-path?

Function signature:

(config-file-path? path)

Undocumented

default

Function signature:

(default opts)

Returns the default configuration that you should base your custom configuration on top of. Feel free to call this with no arguments and merge your changes on top. You can override opts.root-dir (which defaults to the dir of your .nfnl.fnl project root and the CWD as a backup) to whatever you need. The defaults with no arguments should be correct for most situations though.

opts.rtp-patterns is a sequential table of Lua patterns that match runtimepath directories you wish to include in your fennel-path and fennel-macro-path. It defaults to just ["/nfnl$"] which matches any runtimepath directory ending in /nfnl. Add any Neovim plugins you wish to use at compile or runtime here. You can also just replace it with a catch all pattern to include all directories.

• All plugins: [".*"]
• nfnl + my-cool-plugin: ["/nfnl$" "/my-cool-plugin$"]

Make sure you update the README whenever you change the default configuration!

find

Function signature:

(find dir)

Find the nearest .nfnl.fnl file to the given directory.

find-and-load

Function signature:

(find-and-load dir)

Attempt to find and load the .nfnl.fnl config file relative to the given dir. Returns an empty table when there's issues or if there isn't a config file. If there's some valid config you'll get table containing config, cfg (fn) and root-dir back.

path-dirs

Function signature:

(path-dirs {:base-dirs base-dirs :rtp-patterns rtp-patterns :runtimepath runtimepath})

Takes the current runtimepath and a sequential table of rtp-patterns. Those patterns are used to filter down all of the runtimepath directories. Returns the runtime path items that match at least one of the rtp-patterns.

Also accepts a base-dirs table that it'll concatenate onto the end of then run through core.distinct to de-duplicate.