From 9e17a8425a3d0d83846255ada963ed919a002418 Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Sat, 28 Sep 2024 18:29:11 +0000 Subject: [PATCH] deploy: ab9a7c16003b245f0f0076aaf0480b525ad5f94b --- index.xhtml | 18 +++++++++++------- options.html | 48 ++++++++++++++++++++++++++++++++++++++++++++---- 2 files changed, 55 insertions(+), 11 deletions(-) diff --git a/index.xhtml b/index.xhtml index dff3e6db..83eb1ffd 100644 --- a/index.xhtml +++ b/index.xhtml @@ -33,7 +33,7 @@
-

Table of Contents

Preface
Try it out
Using Prebuilt Configs
Default Configs
Maximal
Nix
Installing nvf
Standalone Installation
Standalone Installation on NixOS
Standalone Installation on Home-Manager
Module Installation
NixOS Module
Home-Manager Module
Configuring nvf
Custom Neovim Package
Custom Plugins
Adding Plugins
Language Support
LSP Custom Packages/Command
Using DAGs
entryAnywhere
entryAfter
entryBefore
entryBetween
entriesAnywhere
entriesAfter
entriesBefore
entriesBetween
DAG entries in nvf
Hacking nvf
Getting Started
Guidelines
Testing Changes
Keybinds
Adding Plugins
A. Plugin specific quirks
NodeJS
B. Neovim Flake Configuration Options
C. Release Notes
Release 0.1
Release 0.2
Release 0.3
Release 0.4
Release 0.5
Release 0.6
Release 0.7
+

Table of Contents

Preface
Try it out
Using Prebuilt Configs
Default Configs
Maximal
Nix
Installing nvf
Standalone Installation
Standalone Installation on NixOS
Standalone Installation on Home-Manager
Module Installation
NixOS Module
Home-Manager Module
Configuring nvf
Custom Neovim Package
Custom Plugins
Adding Plugins
Language Support
LSP Custom Packages/Command
Using DAGs
entryAnywhere
entryAfter
entryBefore
entryBetween
entriesAnywhere
entriesAfter
entriesBefore
entriesBetween
DAG entries in nvf
vim.luaConfigRC (top-level DAG)
Hacking nvf
Getting Started
Guidelines
Testing Changes
Keybinds
Adding Plugins
A. Plugin specific quirks
NodeJS
B. Neovim Flake Configuration Options
C. Release Notes
Release 0.1
Release 0.2
Release 0.3
Release 0.4
Release 0.5
Release 0.6
Release 0.7

Preface

If you noticed a bug caused by nvf then please consider reporting it over the issue tracker.

Bugfixes, feature additions and upstreamed changes from your local configurations are always welcome in the the pull requests tab.

@@ -292,7 +292,7 @@ in the

Configuring nvf

Table of Contents

Custom Neovim Package
Custom Plugins
Adding Plugins
Language Support
LSP Custom Packages/Command
Using DAGs
entryAnywhere
entryAfter
entryBefore
entryBetween
entriesAnywhere
entriesAfter
entriesBefore
entriesBetween
DAG entries in nvf

Custom Neovim Package

As of v0.5, you may now specify the Neovim package that will be wrapped with +

Configuring nvf

Table of Contents

Custom Neovim Package
Custom Plugins
Adding Plugins
Language Support
LSP Custom Packages/Command
Using DAGs
entryAnywhere
entryAfter
entryBefore
entryBetween
entriesAnywhere
entriesAfter
entriesBefore
entriesBetween
DAG entries in nvf
vim.luaConfigRC (top-level DAG)

Custom Neovim Package

As of v0.5, you may now specify the Neovim package that will be wrapped with your configuration. This is done with the vim.package option.

{inputs, pkgs, ...}: {
   # using the neovim-nightly overlay
   vim.package = inputs.neovim-overlay.packages.${pkgs.system}.neovim;
@@ -493,14 +493,18 @@ attribute names in afters. For example
-

DAG entries in nvf

From the previous chapter, it should be clear that DAGs are useful, because you +

DAG entries in nvf

Table of Contents

vim.luaConfigRC (top-level DAG)

From the previous chapter, it should be clear that DAGs are useful, because you can add code that relies on other code. However, if you don’t know what the entries are called, it’s hard to do that, so here is a list of the internal -entries in nvf:

vim.luaConfigRC (top-level DAG):

  1. (luaConfigPre) - not a part of the actual DAG, instead, it’s simply -inserted before the rest of the DAG

  2. globalsScript - used to set globals defined in vim.globals

  3. basic - used to set basic configuration options

  4. theme (this is simply placed before pluginConfigs, meaning that surrounding entries don’t depend on it) - used to set up the theme, which has to be done before other plugins

  5. pluginConfigs - the result of the nested vim.pluginRC (internal option, -see the Custom Plugins page for adding your own -plugins) DAG, used to set up internal plugins

  6. extraPluginConfigs - the result of vim.extraPlugins, which is not a +entries in nvf:

    vim.luaConfigRC (top-level DAG)

    1. (luaConfigPre) - not a part of the actual DAG, instead, it’s simply +inserted before the rest of the DAG

    2. globalsScript - used to set globals defined in vim.globals

    3. basic - used to set basic configuration options

    4. optionsScript - used to set options defined in vim.o

    5. theme (this is simply placed before pluginConfigs, meaning that +surrounding entries don’t depend on it) - used to set up the theme, which has +to be done before other plugins

    6. pluginConfigs - the result of the nested vim.pluginRC (internal option, +see the Custom Plugins page for adding your +own plugins) DAG, used to set up internal plugins

    7. extraPluginConfigs - the result of vim.extraPlugins, which is not a direct DAG, but is converted to, and resolved as one internally

    8. mappings - the result of vim.maps

    +
    +

Hacking nvf

Table of Contents

Getting Started
Guidelines
Adding Documentation
Formatting Code
Formatting Commits
Commit Style
Example Commit
Code Style
Testing Changes
Keybinds
Custom Key Mappings Support for a Plugin
Adding Plugins
Modular setup options
Details of toLuaObject

nvf is designed for developers as much as it is for the end user. I would like any potential contributor to be able to propagate their desired changes into the repository without the extra effort. As such, below are guides diff --git a/options.html b/options.html index 6c146e6a..a9608937 100644 --- a/options.html +++ b/options.html @@ -7846,10 +7846,10 @@ boolean

An attribute set containing global variable values for storing vim variables as early as possible. If populated, this option will set vim variables in the -built luaConfigRC as the first item.

E.g. {foo = “bar”} will set vim.g.foo to “bar” where -the type of bar in the resulting vimscript will be -infered from the type of the value in the {name = value} -pair.

+built luaConfigRC as the first item.

Note

{foo = "bar";} will set vim.g.foo to “bar”, where +the type of bar in the resulting Lua value will be +inferred from the type of the value in the {name = value;} +pair passed to the option.

Type: attribute set

@@ -7857,6 +7857,11 @@ attribute set

Default: { }

+

Example:

{
+  some_variable = 42;
+}
+
+

Declared by:

@@ -19015,6 +19020,41 @@ list of (null or package or one of “alpha-nvim”, “bufdelete-nvim”, “ca
+
+ + vim.options + + +
+
+

An attribute set containing vim options to be set +as early as possible. If populated, this option will +set vim options in the built luaConfigRC after basic +and before pluginConfigs DAG entries.

Note

{foo = "bar";} will set vim.o.foo to “bar”, where +the type of bar in the resulting Lua value will be +inferred from the type of the value in the{name = value;} +pair passed to the option.

+ +

Type: +attribute set

+ +

Default: +{ }

+ +

Example:

{
+  visualbell = true;
+}
+
+ +

Declared by:

+ + +
+ +<nvf/modules/wrapper/rc/options.nix> + +
+
vim.pluginRC