NotAShelf/nvf
1
0
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2025-01-19 16:32:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

deploy: 5250f8e771

Browse source
This commit is contained in:
NotAShelf 2025-01-10 08:00:34 +00:00
parent 57b4dd2515
commit b7a8690a73
2 changed files with 66 additions and 58 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

114
options.html
View file

@ -72,30 +72,6 @@ lazy attribute set of raw value</p>
</td></tr> </td></tr>
</table> </table>
</dd> </dd>
<dt>
<span class="term">
<a id="opt-vim.enableEditorconfig"></a><a class="term" href="options.html#opt-vim.enableEditorconfig"><code class="option">vim.enableEditorconfig</code>
</a>
</span>
</dt>
<dd>
<p>Follow editorconfig rules in current directory</p>
<p><span class="emphasis"><em>Type:</em></span>
boolean</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">true</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist">
<tr><td>
<code class="filename"><a class="filename" href="https://github.com/NotAShelf/nvf/blob/main/modules/neovim/init/basic.nix" target="_top">
&lt;nvf/modules/neovim/init/basic.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt> <dt>
<span class="term"> <span class="term">
<a id="opt-vim.enableLuaLoader"></a><a class="term" href="options.html#opt-vim.enableLuaLoader"><code class="option">vim.enableLuaLoader</code> <a id="opt-vim.enableLuaLoader"></a><a class="term" href="options.html#opt-vim.enableLuaLoader"><code class="option">vim.enableLuaLoader</code>
@ -104,7 +80,7 @@ boolean</p>
</dt> </dt>
<dd> <dd>
<p>the experimental Lua module loader to speed up the start up process</p><p>If <code class="literal">true</code>, this will enable the experimental Lua module loader which:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>overrides loadfile</p></li><li class="listitem"><p>adds the lua loader using the byte-compilation cache</p></li><li class="listitem"><p>adds the libs loader</p></li><li class="listitem"><p>removes the default Neovim loader</p></li></ul></div><div class="note"><h3 class="title">Note</h3><p>The Lua module loader is <span class="emphasis"><em>disabled</em></span> by default. Before setting this option, please <p>the experimental Lua module loader to speed up the start up process</p><p>If <code class="literal">true</code>, this will enable the experimental Lua module loader which:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>overrides loadfile</p></li><li class="listitem"><p>adds the lua loader using the byte-compilation cache</p></li><li class="listitem"><p>adds the libs loader</p></li><li class="listitem"><p>removes the default Neovim loader</p></li></ul></div><div class="note"><h3 class="title">Note</h3><p>The Lua module loader is <span class="emphasis"><em>disabled</em></span> by default. Before setting this option, please
take a look at the <a class="link" href="https://neovim.io/doc/user/lua.html#vim.loader.enable()" target="_top"><code class="option">official documentation</code></a>. This option may be enabled by take a look at the <code class="option">[official documentation]</code>. This option may be enabled by
default in the future.</p></div> default in the future.</p></div>
<p><span class="emphasis"><em>Type:</em></span> <p><span class="emphasis"><em>Type:</em></span>
@ -3343,7 +3319,7 @@ list of (path or string)</p>
./nvim/my-lua-file.lua ./nvim/my-lua-file.lua
# source type path - pure and reproducible # source type path - pure and reproducible
(builtins.source { (builtins.path {
path = ./nvim/my-lua-file.lua; path = ./nvim/my-lua-file.lua;
name = &quot;my-lua-file&quot;; name = &quot;my-lua-file&quot;;
}) })
@ -8126,6 +8102,33 @@ attribute set of anything</p>
} }
</code></pre> </code></pre>
<p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist">
<tr><td>
<code class="filename"><a class="filename" href="https://github.com/NotAShelf/nvf/blob/main/modules/wrapper/rc/options.nix" target="_top">
&lt;nvf/modules/wrapper/rc/options.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="opt-vim.globals.editorconfig"></a><a class="term" href="options.html#opt-vim.globals.editorconfig"><code class="option">vim.globals.editorconfig</code>
</a>
</span>
</dt>
<dd>
<p>Whether to enable EditorConfig integration in Neovim.</p><p>This defaults to true as it is enabled by default in stock
Neovim, setting this option to false disables EditorConfig
integration entirely.</p><p>See <a class="link" href="https://neovim.io/doc/user/editorconfig.html" target="_top">Neovim documentation</a>
for more details on configuring EditorConfig behaviour.</p>
<p><span class="emphasis"><em>Type:</em></span>
boolean</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">true</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p> <p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist"> <table border="0" summary="Simple list" class="simplelist">
<tr><td> <tr><td>
@ -19234,7 +19237,7 @@ to the <code class="literal">runtimepath</code> and enable the experimental Lua
if <a class="xref" href="options.html#opt-vim.enableLuaLoader" ><code class="option">vim.enableLuaLoader</code></a> is set to true.</p> if <a class="xref" href="options.html#opt-vim.enableLuaLoader" ><code class="option">vim.enableLuaLoader</code></a> is set to true.</p>
<p><span class="emphasis"><em>Example:</em></span> <p><span class="emphasis"><em>Example:</em></span>
<code class="literal">&quot;$${builtins.readFile ./my-lua-config-pre.lua}&quot;</code></p> <code class="literal">${builtins.readFile ./my-lua-config-pre.lua}</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p> <p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist"> <table border="0" summary="Simple list" class="simplelist">
@ -23159,12 +23162,17 @@ one of “line”, “screenline”, “number”, “both”</p>
</span> </span>
</dt> </dt>
<dd> <dd>
<p>Set modes for mouse support.</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>a - all</p></li><li class="listitem"><p>n - normal</p></li><li class="listitem"><p>v - visual</p></li><li class="listitem"><p>i - insert</p></li><li class="listitem"><p>c - command</p></li></ul></div> <p>Set modes for mouse support.</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>n - normal</p></li><li class="listitem"><p>v - visual</p></li><li class="listitem"><p>i - insert</p></li><li class="listitem"><p>c - command-line</p></li><li class="listitem"><p>h - all modes when editing a help file</p></li><li class="listitem"><p>a - all modes</p></li><li class="listitem"><p>r - for hit-enter and more-prompt prompt</p></li></ul></div><p>This option takes a string to ensure proper conversion to the corresponding Lua type.
As such, we do not check the value passed to this option. Please ensure that any value
that is set here is a valid value as per <a class="link" href="https://neovim.io/doc/user/options.html#&#x27;mouse&#x27;%22" target="_top">neovim documentation</a>.</p>
<p><span class="emphasis"><em>Type:</em></span> <p><span class="emphasis"><em>Type:</em></span>
one of “a”, “n”, “v”, “i”, “c”</p> string</p>
<p><span class="emphasis"><em>Default:</em></span> <p><span class="emphasis"><em>Default:</em></span>
<code class="literal">&quot;nvi&quot;</code></p>
<p><span class="emphasis"><em>Example:</em></span>
<code class="literal">&quot;a&quot;</code></p> <code class="literal">&quot;a&quot;</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p> <p><span class="emphasis"><em>Declared by:</em></span></p>
@ -23192,6 +23200,30 @@ signed integer</p>
<p><span class="emphasis"><em>Default:</em></span> <p><span class="emphasis"><em>Default:</em></span>
<code class="literal">8</code></p> <code class="literal">8</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist">
<tr><td>
<code class="filename"><a class="filename" href="https://github.com/NotAShelf/nvf/blob/main/modules/wrapper/rc/options.nix" target="_top">
&lt;nvf/modules/wrapper/rc/options.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="opt-vim.options.signcolumn"></a><a class="term" href="options.html#opt-vim.options.signcolumn"><code class="option">vim.options.signcolumn</code>
</a>
</span>
</dt>
<dd>
<p>Show the sign column</p>
<p><span class="emphasis"><em>Type:</em></span>
string or boolean</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">true</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p> <p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist"> <table border="0" summary="Simple list" class="simplelist">
<tr><td> <tr><td>
@ -24750,30 +24782,6 @@ boolean</p>
</td></tr> </td></tr>
</table> </table>
</dd> </dd>
<dt>
<span class="term">
<a id="opt-vim.showSignColumn"></a><a class="term" href="options.html#opt-vim.showSignColumn"><code class="option">vim.showSignColumn</code>
</a>
</span>
</dt>
<dd>
<p>Show the sign column</p>
<p><span class="emphasis"><em>Type:</em></span>
boolean</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">true</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist">
<tr><td>
<code class="filename"><a class="filename" href="https://github.com/NotAShelf/nvf/blob/main/modules/neovim/init/basic.nix" target="_top">
&lt;nvf/modules/neovim/init/basic.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt> <dt>
<span class="term"> <span class="term">
<a id="opt-vim.snippets.luasnip.enable"></a><a class="term" href="options.html#opt-vim.snippets.luasnip.enable"><code class="option">vim.snippets.luasnip.enable</code> <a id="opt-vim.snippets.luasnip.enable"></a><a class="term" href="options.html#opt-vim.snippets.luasnip.enable"><code class="option">vim.snippets.luasnip.enable</code>

10
release-notes.html
View file

@ -236,11 +236,11 @@ slightly changed. See the new <a class="link" href="/index.xhtml#ch-dag-entries"
making good use of its extensive Lua API. Additionally, Vimscript is slow and making good use of its extensive Lua API. Additionally, Vimscript is slow and
brings unnecessary performance overhead while working with different brings unnecessary performance overhead while working with different
configuration formats.</p> configuration formats.</p>
</div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-vim-maps-rewrite" class="title" ><code class="literal">vim.maps</code> rewrite </h3> </div> </div></div><p>Instead of specifying map modes using submodules (eg.: <code class="literal">vim.maps.normal</code>), a new </div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-vim-maps-rewrite" class="title" ><code class="literal">vim.maps</code> rewrite </h3> </div> </div></div><p>Instead of specifying map modes using submodules (e.g.: <code class="literal">vim.maps.normal</code>), a
<code class="literal">vim.keymaps</code> submodule with support for a <code class="literal">mode</code> option has been introduced. It new <code class="literal">vim.keymaps</code> submodule with support for a <code class="literal">mode</code> option has been
can be either a string, or a list of strings, where a string represents the introduced. It can be either a string, or a list of strings, where a string
short-name of the map mode(s), that the mapping should be set for. See represents the short-name of the map mode(s), that the mapping should be set
<code class="literal">:help map-modes</code> for more information.</p><p>For example:</p><pre><code class="programlisting nix">vim.maps.normal.&quot;&lt;leader&gt;m&quot; = { ... }; for. See <code class="literal">:help map-modes</code> for more information.</p><p>For example:</p><pre><code class="programlisting nix">vim.maps.normal.&quot;&lt;leader&gt;m&quot; = { ... };
</code></pre><p>has to be replaced by</p><pre><code class="programlisting nix">vim.keymaps = [ </code></pre><p>has to be replaced by</p><pre><code class="programlisting nix">vim.keymaps = [
{ {
key = &quot;&lt;leader&gt;m&quot;; key = &quot;&lt;leader&gt;m&quot;;