You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-18Lines changed: 7 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ configuration, this can be blank if you wish to rely on the defaults for now.
26
26
echo"{}"> .nfnl.fnl
27
27
```
28
28
29
-
The first time you open a Fennel file under this directory you'll be prompted to
29
+
The first time you write a Fennel file under this directory you'll be prompted to
30
30
trust this configuration file since it's Fennel code that's executed on your
31
31
behalf. You can put any Fennel code you want in this file, just be sure to
32
32
return a table of configuration at the end.
@@ -171,18 +171,13 @@ modules or macros.
171
171
172
172
## Installation
173
173
174
-
-[Lazy][lazy]: `{ "Olical/nfnl", ft = "fennel" }`
174
+
-[Lazy][lazy]: `{ "Olical/nfnl" }`
175
175
-[Plug][plug]: `Plug 'Olical/nfnl'`
176
176
-[Packer][packer]: `use "Olical/nfnl"`
177
177
178
-
[Lazy][lazy] will lazily load the plugin when you enter a Fennel file for the
179
-
first time. There is no need to call `require("nfnl").setup()` right now, it's
180
-
currently a noop but it may be used eventually. Some plugin managers support
181
-
this function and will call it automatically.
182
-
183
-
- Requires Neovim > v0.9.0.
184
-
- Add the dependency to your plugin manager.
185
-
- Add lazy loading rules on the Fennel filetype if you want.
178
+
Requires Neovim >= v0.9.0. nfnl uses `ftplugin` to activate when you open a
179
+
Fennel file, so there is no need to call `require("nfnl")` or add lazy loading
180
+
rules. Just install it and it works.
186
181
187
182
## Standard library
188
183
@@ -408,16 +403,10 @@ which you can read about under the next header.
408
403
409
404
### Options
410
405
411
-
nfnl's user experience can be configured by `g:nfnl#...` prefixed global variables which can also be set by `.setup()` like so:
412
-
413
-
```lua
414
-
require("nfnl").setup({ compile_on_write=false })
415
-
```
416
-
417
-
These options customise general behaviour of the plugin that aren't limited to a specific directory or project.
406
+
nfnl can be configured with `g:nfnl#...` global variables.
418
407
419
408
-`g:nfnl#compile_on_write`
420
-
Set to `false` to disable the automatic compilation on buffer write. You will then need to use the `:NfnlCompile*` commands to compile your Fennel into Lua.
409
+
Set to `false` to disable automatic compilation on buffer write. You will then need to use the `:NfnlCompile*` commands to compile your Fennel into Lua.
0 commit comments