diff --git a/docs-preview-569/highlightjs/LICENSE b/docs-preview-569/highlightjs/LICENSE new file mode 100644 index 000000000..2250cc7ec --- /dev/null +++ b/docs-preview-569/highlightjs/LICENSE @@ -0,0 +1,29 @@ +BSD 3-Clause License + +Copyright (c) 2006, Ivan Sagalaev. +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +* Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/docs-preview-569/highlightjs/highlight.pack.js b/docs-preview-569/highlightjs/highlight.pack.js new file mode 100644 index 000000000..b8008d365 --- /dev/null +++ b/docs-preview-569/highlightjs/highlight.pack.js @@ -0,0 +1,345 @@ +/*! + Highlight.js v11.9.0 (git: b7ec4bfafc) + (c) 2006-2023 undefined and other contributors + License: BSD-3-Clause + */ +var hljs=function(){"use strict";function e(t){ +return t instanceof Map?t.clear=t.delete=t.set=()=>{ +throw Error("map is read-only")}:t instanceof Set&&(t.add=t.clear=t.delete=()=>{ +throw Error("set is read-only") +}),Object.freeze(t),Object.getOwnPropertyNames(t).forEach((n=>{ +const i=t[n],s=typeof i;"object"!==s&&"function"!==s||Object.isFrozen(i)||e(i) +})),t}class t{constructor(e){ +void 0===e.data&&(e.data={}),this.data=e.data,this.isMatchIgnored=!1} +ignoreMatch(){this.isMatchIgnored=!0}}function n(e){ +return e.replace(/&/g,"&").replace(/</g,"<").replace(/>/g,">").replace(/"/g,""").replace(/'/g,"'") +}function i(e,...t){const n=Object.create(null);for(const t in e)n[t]=e[t] +;return t.forEach((e=>{for(const t in e)n[t]=e[t]})),n}const s=e=>!!e.scope +;class o{constructor(e,t){ +this.buffer="",this.classPrefix=t.classPrefix,e.walk(this)}addText(e){ +this.buffer+=n(e)}openNode(e){if(!s(e))return;const t=((e,{prefix:t})=>{ +if(e.startsWith("language:"))return e.replace("language:","language-") +;if(e.includes(".")){const n=e.split(".") +;return[`${t}${n.shift()}`,...n.map(((e,t)=>`${e}${"_".repeat(t+1)}`))].join(" ") +}return`${t}${e}`})(e.scope,{prefix:this.classPrefix});this.span(t)} +closeNode(e){s(e)&&(this.buffer+="</span>")}value(){return this.buffer}span(e){ +this.buffer+=`<span class="${e}">`}}const r=(e={})=>{const t={children:[]} +;return Object.assign(t,e),t};class a{constructor(){ +this.rootNode=r(),this.stack=[this.rootNode]}get top(){ +return this.stack[this.stack.length-1]}get root(){return this.rootNode}add(e){ +this.top.children.push(e)}openNode(e){const t=r({scope:e}) +;this.add(t),this.stack.push(t)}closeNode(){ +if(this.stack.length>1)return this.stack.pop()}closeAllNodes(){ +for(;this.closeNode(););}toJSON(){return JSON.stringify(this.rootNode,null,4)} +walk(e){return this.constructor._walk(e,this.rootNode)}static _walk(e,t){ +return"string"==typeof t?e.addText(t):t.children&&(e.openNode(t), +t.children.forEach((t=>this._walk(e,t))),e.closeNode(t)),e}static _collapse(e){ +"string"!=typeof e&&e.children&&(e.children.every((e=>"string"==typeof e))?e.children=[e.children.join("")]:e.children.forEach((e=>{ +a._collapse(e)})))}}class c extends a{constructor(e){super(),this.options=e} +addText(e){""!==e&&this.add(e)}startScope(e){this.openNode(e)}endScope(){ +this.closeNode()}__addSublanguage(e,t){const n=e.root +;t&&(n.scope="language:"+t),this.add(n)}toHTML(){ +return new o(this,this.options).value()}finalize(){ +return this.closeAllNodes(),!0}}function l(e){ +return e?"string"==typeof e?e:e.source:null}function g(e){return h("(?=",e,")")} +function u(e){return h("(?:",e,")*")}function d(e){return h("(?:",e,")?")} +function h(...e){return e.map((e=>l(e))).join("")}function f(...e){const t=(e=>{ +const t=e[e.length-1] +;return"object"==typeof t&&t.constructor===Object?(e.splice(e.length-1,1),t):{} +})(e);return"("+(t.capture?"":"?:")+e.map((e=>l(e))).join("|")+")"} +function p(e){return RegExp(e.toString()+"|").exec("").length-1} +const b=/\[(?:[^\\\]]|\\.)*\]|\(\??|\\([1-9][0-9]*)|\\./ +;function m(e,{joinWith:t}){let n=0;return e.map((e=>{n+=1;const t=n +;let i=l(e),s="";for(;i.length>0;){const e=b.exec(i);if(!e){s+=i;break} +s+=i.substring(0,e.index), +i=i.substring(e.index+e[0].length),"\\"===e[0][0]&&e[1]?s+="\\"+(Number(e[1])+t):(s+=e[0], +"("===e[0]&&n++)}return s})).map((e=>`(${e})`)).join(t)} +const E="[a-zA-Z]\\w*",x="[a-zA-Z_]\\w*",w="\\b\\d+(\\.\\d+)?",y="(-?)(\\b0[xX][a-fA-F0-9]+|(\\b\\d+(\\.\\d*)?|\\.\\d+)([eE][-+]?\\d+)?)",_="\\b(0b[01]+)",O={ +begin:"\\\\[\\s\\S]",relevance:0},v={scope:"string",begin:"'",end:"'", +illegal:"\\n",contains:[O]},k={scope:"string",begin:'"',end:'"',illegal:"\\n", +contains:[O]},N=(e,t,n={})=>{const s=i({scope:"comment",begin:e,end:t, +contains:[]},n);s.contains.push({scope:"doctag", +begin:"[ ]*(?=(TODO|FIXME|NOTE|BUG|OPTIMIZE|HACK|XXX):)", +end:/(TODO|FIXME|NOTE|BUG|OPTIMIZE|HACK|XXX):/,excludeBegin:!0,relevance:0}) +;const o=f("I","a","is","so","us","to","at","if","in","it","on",/[A-Za-z]+['](d|ve|re|ll|t|s|n)/,/[A-Za-z]+[-][a-z]+/,/[A-Za-z][a-z]{2,}/) +;return s.contains.push({begin:h(/[ ]+/,"(",o,/[.]?[:]?([.][ ]|[ ])/,"){3}")}),s +},S=N("//","$"),M=N("/\\*","\\*/"),R=N("#","$");var j=Object.freeze({ +__proto__:null,APOS_STRING_MODE:v,BACKSLASH_ESCAPE:O,BINARY_NUMBER_MODE:{ +scope:"number",begin:_,relevance:0},BINARY_NUMBER_RE:_,COMMENT:N, +C_BLOCK_COMMENT_MODE:M,C_LINE_COMMENT_MODE:S,C_NUMBER_MODE:{scope:"number", +begin:y,relevance:0},C_NUMBER_RE:y,END_SAME_AS_BEGIN:e=>Object.assign(e,{ +"on:begin":(e,t)=>{t.data._beginMatch=e[1]},"on:end":(e,t)=>{ +t.data._beginMatch!==e[1]&&t.ignoreMatch()}}),HASH_COMMENT_MODE:R,IDENT_RE:E, +MATCH_NOTHING_RE:/\b\B/,METHOD_GUARD:{begin:"\\.\\s*"+x,relevance:0}, +NUMBER_MODE:{scope:"number",begin:w,relevance:0},NUMBER_RE:w, +PHRASAL_WORDS_MODE:{ +begin:/\b(a|an|the|are|I'm|isn't|don't|doesn't|won't|but|just|should|pretty|simply|enough|gonna|going|wtf|so|such|will|you|your|they|like|more)\b/ +},QUOTE_STRING_MODE:k,REGEXP_MODE:{scope:"regexp",begin:/\/(?=[^/\n]*\/)/, +end:/\/[gimuy]*/,contains:[O,{begin:/\[/,end:/\]/,relevance:0,contains:[O]}]}, +RE_STARTERS_RE:"!|!=|!==|%|%=|&|&&|&=|\\*|\\*=|\\+|\\+=|,|-|-=|/=|/|:|;|<<|<<=|<=|<|===|==|=|>>>=|>>=|>=|>>>|>>|>|\\?|\\[|\\{|\\(|\\^|\\^=|\\||\\|=|\\|\\||~", +SHEBANG:(e={})=>{const t=/^#![ ]*\// +;return e.binary&&(e.begin=h(t,/.*\b/,e.binary,/\b.*/)),i({scope:"meta",begin:t, +end:/$/,relevance:0,"on:begin":(e,t)=>{0!==e.index&&t.ignoreMatch()}},e)}, +TITLE_MODE:{scope:"title",begin:E,relevance:0},UNDERSCORE_IDENT_RE:x, +UNDERSCORE_TITLE_MODE:{scope:"title",begin:x,relevance:0}});function A(e,t){ +"."===e.input[e.index-1]&&t.ignoreMatch()}function I(e,t){ +void 0!==e.className&&(e.scope=e.className,delete e.className)}function T(e,t){ +t&&e.beginKeywords&&(e.begin="\\b("+e.beginKeywords.split(" ").join("|")+")(?!\\.)(?=\\b|\\s)", +e.__beforeBegin=A,e.keywords=e.keywords||e.beginKeywords,delete e.beginKeywords, +void 0===e.relevance&&(e.relevance=0))}function L(e,t){ +Array.isArray(e.illegal)&&(e.illegal=f(...e.illegal))}function B(e,t){ +if(e.match){ +if(e.begin||e.end)throw Error("begin & end are not supported with match") +;e.begin=e.match,delete e.match}}function P(e,t){ +void 0===e.relevance&&(e.relevance=1)}const D=(e,t)=>{if(!e.beforeMatch)return +;if(e.starts)throw Error("beforeMatch cannot be used with starts") +;const n=Object.assign({},e);Object.keys(e).forEach((t=>{delete e[t] +})),e.keywords=n.keywords,e.begin=h(n.beforeMatch,g(n.begin)),e.starts={ +relevance:0,contains:[Object.assign(n,{endsParent:!0})] +},e.relevance=0,delete n.beforeMatch +},H=["of","and","for","in","not","or","if","then","parent","list","value"],C="keyword" +;function $(e,t,n=C){const i=Object.create(null) +;return"string"==typeof e?s(n,e.split(" ")):Array.isArray(e)?s(n,e):Object.keys(e).forEach((n=>{ +Object.assign(i,$(e[n],t,n))})),i;function s(e,n){ +t&&(n=n.map((e=>e.toLowerCase()))),n.forEach((t=>{const n=t.split("|") +;i[n[0]]=[e,U(n[0],n[1])]}))}}function U(e,t){ +return t?Number(t):(e=>H.includes(e.toLowerCase()))(e)?0:1}const z={},W=e=>{ +console.error(e)},X=(e,...t)=>{console.log("WARN: "+e,...t)},G=(e,t)=>{ +z[`${e}/${t}`]||(console.log(`Deprecated as of ${e}. ${t}`),z[`${e}/${t}`]=!0) +},K=Error();function F(e,t,{key:n}){let i=0;const s=e[n],o={},r={} +;for(let e=1;e<=t.length;e++)r[e+i]=s[e],o[e+i]=!0,i+=p(t[e-1]) +;e[n]=r,e[n]._emit=o,e[n]._multi=!0}function Z(e){(e=>{ +e.scope&&"object"==typeof e.scope&&null!==e.scope&&(e.beginScope=e.scope, +delete e.scope)})(e),"string"==typeof e.beginScope&&(e.beginScope={ +_wrap:e.beginScope}),"string"==typeof e.endScope&&(e.endScope={_wrap:e.endScope +}),(e=>{if(Array.isArray(e.begin)){ +if(e.skip||e.excludeBegin||e.returnBegin)throw W("skip, excludeBegin, returnBegin not compatible with beginScope: {}"), +K +;if("object"!=typeof e.beginScope||null===e.beginScope)throw W("beginScope must be object"), +K;F(e,e.begin,{key:"beginScope"}),e.begin=m(e.begin,{joinWith:""})}})(e),(e=>{ +if(Array.isArray(e.end)){ +if(e.skip||e.excludeEnd||e.returnEnd)throw W("skip, excludeEnd, returnEnd not compatible with endScope: {}"), +K +;if("object"!=typeof e.endScope||null===e.endScope)throw W("endScope must be object"), +K;F(e,e.end,{key:"endScope"}),e.end=m(e.end,{joinWith:""})}})(e)}function V(e){ +function t(t,n){ +return RegExp(l(t),"m"+(e.case_insensitive?"i":"")+(e.unicodeRegex?"u":"")+(n?"g":"")) +}class n{constructor(){ +this.matchIndexes={},this.regexes=[],this.matchAt=1,this.position=0} +addRule(e,t){ +t.position=this.position++,this.matchIndexes[this.matchAt]=t,this.regexes.push([t,e]), +this.matchAt+=p(e)+1}compile(){0===this.regexes.length&&(this.exec=()=>null) +;const e=this.regexes.map((e=>e[1]));this.matcherRe=t(m(e,{joinWith:"|" +}),!0),this.lastIndex=0}exec(e){this.matcherRe.lastIndex=this.lastIndex +;const t=this.matcherRe.exec(e);if(!t)return null +;const n=t.findIndex(((e,t)=>t>0&&void 0!==e)),i=this.matchIndexes[n] +;return t.splice(0,n),Object.assign(t,i)}}class s{constructor(){ +this.rules=[],this.multiRegexes=[], +this.count=0,this.lastIndex=0,this.regexIndex=0}getMatcher(e){ +if(this.multiRegexes[e])return this.multiRegexes[e];const t=new n +;return this.rules.slice(e).forEach((([e,n])=>t.addRule(e,n))), +t.compile(),this.multiRegexes[e]=t,t}resumingScanAtSamePosition(){ +return 0!==this.regexIndex}considerAll(){this.regexIndex=0}addRule(e,t){ +this.rules.push([e,t]),"begin"===t.type&&this.count++}exec(e){ +const t=this.getMatcher(this.regexIndex);t.lastIndex=this.lastIndex +;let n=t.exec(e) +;if(this.resumingScanAtSamePosition())if(n&&n.index===this.lastIndex);else{ +const t=this.getMatcher(0);t.lastIndex=this.lastIndex+1,n=t.exec(e)} +return n&&(this.regexIndex+=n.position+1, +this.regexIndex===this.count&&this.considerAll()),n}} +if(e.compilerExtensions||(e.compilerExtensions=[]), +e.contains&&e.contains.includes("self"))throw Error("ERR: contains `self` is not supported at the top-level of a language. See documentation.") +;return e.classNameAliases=i(e.classNameAliases||{}),function n(o,r){const a=o +;if(o.isCompiled)return a +;[I,B,Z,D].forEach((e=>e(o,r))),e.compilerExtensions.forEach((e=>e(o,r))), +o.__beforeBegin=null,[T,L,P].forEach((e=>e(o,r))),o.isCompiled=!0;let c=null +;return"object"==typeof o.keywords&&o.keywords.$pattern&&(o.keywords=Object.assign({},o.keywords), +c=o.keywords.$pattern, +delete o.keywords.$pattern),c=c||/\w+/,o.keywords&&(o.keywords=$(o.keywords,e.case_insensitive)), +a.keywordPatternRe=t(c,!0), +r&&(o.begin||(o.begin=/\B|\b/),a.beginRe=t(a.begin),o.end||o.endsWithParent||(o.end=/\B|\b/), +o.end&&(a.endRe=t(a.end)), +a.terminatorEnd=l(a.end)||"",o.endsWithParent&&r.terminatorEnd&&(a.terminatorEnd+=(o.end?"|":"")+r.terminatorEnd)), +o.illegal&&(a.illegalRe=t(o.illegal)), +o.contains||(o.contains=[]),o.contains=[].concat(...o.contains.map((e=>(e=>(e.variants&&!e.cachedVariants&&(e.cachedVariants=e.variants.map((t=>i(e,{ +variants:null},t)))),e.cachedVariants?e.cachedVariants:q(e)?i(e,{ +starts:e.starts?i(e.starts):null +}):Object.isFrozen(e)?i(e):e))("self"===e?o:e)))),o.contains.forEach((e=>{n(e,a) +})),o.starts&&n(o.starts,r),a.matcher=(e=>{const t=new s +;return e.contains.forEach((e=>t.addRule(e.begin,{rule:e,type:"begin" +}))),e.terminatorEnd&&t.addRule(e.terminatorEnd,{type:"end" +}),e.illegal&&t.addRule(e.illegal,{type:"illegal"}),t})(a),a}(e)}function q(e){ +return!!e&&(e.endsWithParent||q(e.starts))}class J extends Error{ +constructor(e,t){super(e),this.name="HTMLInjectionError",this.html=t}} +const Y=n,Q=i,ee=Symbol("nomatch"),te=n=>{ +const i=Object.create(null),s=Object.create(null),o=[];let r=!0 +;const a="Could not find the language '{}', did you forget to load/include a language module?",l={ +disableAutodetect:!0,name:"Plain text",contains:[]};let p={ +ignoreUnescapedHTML:!1,throwUnescapedHTML:!1,noHighlightRe:/^(no-?highlight)$/i, +languageDetectRe:/\blang(?:uage)?-([\w-]+)\b/i,classPrefix:"hljs-", +cssSelector:"pre code",languages:null,__emitter:c};function b(e){ +return p.noHighlightRe.test(e)}function m(e,t,n){let i="",s="" +;"object"==typeof t?(i=e, +n=t.ignoreIllegals,s=t.language):(G("10.7.0","highlight(lang, code, ...args) has been deprecated."), +G("10.7.0","Please use highlight(code, options) instead.\nhttps://github.com/highlightjs/highlight.js/issues/2277"), +s=e,i=t),void 0===n&&(n=!0);const o={code:i,language:s};N("before:highlight",o) +;const r=o.result?o.result:E(o.language,o.code,n) +;return r.code=o.code,N("after:highlight",r),r}function E(e,n,s,o){ +const c=Object.create(null);function l(){if(!N.keywords)return void M.addText(R) +;let e=0;N.keywordPatternRe.lastIndex=0;let t=N.keywordPatternRe.exec(R),n="" +;for(;t;){n+=R.substring(e,t.index) +;const s=_.case_insensitive?t[0].toLowerCase():t[0],o=(i=s,N.keywords[i]);if(o){ +const[e,i]=o +;if(M.addText(n),n="",c[s]=(c[s]||0)+1,c[s]<=7&&(j+=i),e.startsWith("_"))n+=t[0];else{ +const n=_.classNameAliases[e]||e;u(t[0],n)}}else n+=t[0] +;e=N.keywordPatternRe.lastIndex,t=N.keywordPatternRe.exec(R)}var i +;n+=R.substring(e),M.addText(n)}function g(){null!=N.subLanguage?(()=>{ +if(""===R)return;let e=null;if("string"==typeof N.subLanguage){ +if(!i[N.subLanguage])return void M.addText(R) +;e=E(N.subLanguage,R,!0,S[N.subLanguage]),S[N.subLanguage]=e._top +}else e=x(R,N.subLanguage.length?N.subLanguage:null) +;N.relevance>0&&(j+=e.relevance),M.__addSublanguage(e._emitter,e.language) +})():l(),R=""}function u(e,t){ +""!==e&&(M.startScope(t),M.addText(e),M.endScope())}function d(e,t){let n=1 +;const i=t.length-1;for(;n<=i;){if(!e._emit[n]){n++;continue} +const i=_.classNameAliases[e[n]]||e[n],s=t[n];i?u(s,i):(R=s,l(),R=""),n++}} +function h(e,t){ +return e.scope&&"string"==typeof e.scope&&M.openNode(_.classNameAliases[e.scope]||e.scope), +e.beginScope&&(e.beginScope._wrap?(u(R,_.classNameAliases[e.beginScope._wrap]||e.beginScope._wrap), +R=""):e.beginScope._multi&&(d(e.beginScope,t),R="")),N=Object.create(e,{parent:{ +value:N}}),N}function f(e,n,i){let s=((e,t)=>{const n=e&&e.exec(t) +;return n&&0===n.index})(e.endRe,i);if(s){if(e["on:end"]){const i=new t(e) +;e["on:end"](n,i),i.isMatchIgnored&&(s=!1)}if(s){ +for(;e.endsParent&&e.parent;)e=e.parent;return e}} +if(e.endsWithParent)return f(e.parent,n,i)}function b(e){ +return 0===N.matcher.regexIndex?(R+=e[0],1):(T=!0,0)}function m(e){ +const t=e[0],i=n.substring(e.index),s=f(N,e,i);if(!s)return ee;const o=N +;N.endScope&&N.endScope._wrap?(g(), +u(t,N.endScope._wrap)):N.endScope&&N.endScope._multi?(g(), +d(N.endScope,e)):o.skip?R+=t:(o.returnEnd||o.excludeEnd||(R+=t), +g(),o.excludeEnd&&(R=t));do{ +N.scope&&M.closeNode(),N.skip||N.subLanguage||(j+=N.relevance),N=N.parent +}while(N!==s.parent);return s.starts&&h(s.starts,e),o.returnEnd?0:t.length} +let w={};function y(i,o){const a=o&&o[0];if(R+=i,null==a)return g(),0 +;if("begin"===w.type&&"end"===o.type&&w.index===o.index&&""===a){ +if(R+=n.slice(o.index,o.index+1),!r){const t=Error(`0 width match regex (${e})`) +;throw t.languageName=e,t.badRule=w.rule,t}return 1} +if(w=o,"begin"===o.type)return(e=>{ +const n=e[0],i=e.rule,s=new t(i),o=[i.__beforeBegin,i["on:begin"]] +;for(const t of o)if(t&&(t(e,s),s.isMatchIgnored))return b(n) +;return i.skip?R+=n:(i.excludeBegin&&(R+=n), +g(),i.returnBegin||i.excludeBegin||(R=n)),h(i,e),i.returnBegin?0:n.length})(o) +;if("illegal"===o.type&&!s){ +const e=Error('Illegal lexeme "'+a+'" for mode "'+(N.scope||"<unnamed>")+'"') +;throw e.mode=N,e}if("end"===o.type){const e=m(o);if(e!==ee)return e} +if("illegal"===o.type&&""===a)return 1 +;if(I>1e5&&I>3*o.index)throw Error("potential infinite loop, way more iterations than matches") +;return R+=a,a.length}const _=O(e) +;if(!_)throw W(a.replace("{}",e)),Error('Unknown language: "'+e+'"') +;const v=V(_);let k="",N=o||v;const S={},M=new p.__emitter(p);(()=>{const e=[] +;for(let t=N;t!==_;t=t.parent)t.scope&&e.unshift(t.scope) +;e.forEach((e=>M.openNode(e)))})();let R="",j=0,A=0,I=0,T=!1;try{ +if(_.__emitTokens)_.__emitTokens(n,M);else{for(N.matcher.considerAll();;){ +I++,T?T=!1:N.matcher.considerAll(),N.matcher.lastIndex=A +;const e=N.matcher.exec(n);if(!e)break;const t=y(n.substring(A,e.index),e) +;A=e.index+t}y(n.substring(A))}return M.finalize(),k=M.toHTML(),{language:e, +value:k,relevance:j,illegal:!1,_emitter:M,_top:N}}catch(t){ +if(t.message&&t.message.includes("Illegal"))return{language:e,value:Y(n), +illegal:!0,relevance:0,_illegalBy:{message:t.message,index:A, +context:n.slice(A-100,A+100),mode:t.mode,resultSoFar:k},_emitter:M};if(r)return{ +language:e,value:Y(n),illegal:!1,relevance:0,errorRaised:t,_emitter:M,_top:N} +;throw t}}function x(e,t){t=t||p.languages||Object.keys(i);const n=(e=>{ +const t={value:Y(e),illegal:!1,relevance:0,_top:l,_emitter:new p.__emitter(p)} +;return t._emitter.addText(e),t})(e),s=t.filter(O).filter(k).map((t=>E(t,e,!1))) +;s.unshift(n);const o=s.sort(((e,t)=>{ +if(e.relevance!==t.relevance)return t.relevance-e.relevance +;if(e.language&&t.language){if(O(e.language).supersetOf===t.language)return 1 +;if(O(t.language).supersetOf===e.language)return-1}return 0})),[r,a]=o,c=r +;return c.secondBest=a,c}function w(e){let t=null;const n=(e=>{ +let t=e.className+" ";t+=e.parentNode?e.parentNode.className:"" +;const n=p.languageDetectRe.exec(t);if(n){const t=O(n[1]) +;return t||(X(a.replace("{}",n[1])), +X("Falling back to no-highlight mode for this block.",e)),t?n[1]:"no-highlight"} +return t.split(/\s+/).find((e=>b(e)||O(e)))})(e);if(b(n))return +;if(N("before:highlightElement",{el:e,language:n +}),e.dataset.highlighted)return void console.log("Element previously highlighted. To highlight again, first unset `dataset.highlighted`.",e) +;if(e.children.length>0&&(p.ignoreUnescapedHTML||(console.warn("One of your code blocks includes unescaped HTML. This is a potentially serious security risk."), +console.warn("https://github.com/highlightjs/highlight.js/wiki/security"), +console.warn("The element with unescaped HTML:"), +console.warn(e)),p.throwUnescapedHTML))throw new J("One of your code blocks includes unescaped HTML.",e.innerHTML) +;t=e;const i=t.textContent,o=n?m(i,{language:n,ignoreIllegals:!0}):x(i) +;e.innerHTML=o.value,e.dataset.highlighted="yes",((e,t,n)=>{const i=t&&s[t]||n +;e.classList.add("hljs"),e.classList.add("language-"+i) +})(e,n,o.language),e.result={language:o.language,re:o.relevance, +relevance:o.relevance},o.secondBest&&(e.secondBest={ +language:o.secondBest.language,relevance:o.secondBest.relevance +}),N("after:highlightElement",{el:e,result:o,text:i})}let y=!1;function _(){ +"loading"!==document.readyState?document.querySelectorAll(p.cssSelector).forEach(w):y=!0 +}function O(e){return e=(e||"").toLowerCase(),i[e]||i[s[e]]} +function v(e,{languageName:t}){"string"==typeof e&&(e=[e]),e.forEach((e=>{ +s[e.toLowerCase()]=t}))}function k(e){const t=O(e) +;return t&&!t.disableAutodetect}function N(e,t){const n=e;o.forEach((e=>{ +e[n]&&e[n](t)}))} +"undefined"!=typeof window&&window.addEventListener&&window.addEventListener("DOMContentLoaded",(()=>{ +y&&_()}),!1),Object.assign(n,{highlight:m,highlightAuto:x,highlightAll:_, +highlightElement:w, +highlightBlock:e=>(G("10.7.0","highlightBlock will be removed entirely in v12.0"), +G("10.7.0","Please use highlightElement now."),w(e)),configure:e=>{p=Q(p,e)}, +initHighlighting:()=>{ +_(),G("10.6.0","initHighlighting() deprecated. Use highlightAll() now.")}, +initHighlightingOnLoad:()=>{ +_(),G("10.6.0","initHighlightingOnLoad() deprecated. Use highlightAll() now.") +},registerLanguage:(e,t)=>{let s=null;try{s=t(n)}catch(t){ +if(W("Language definition for '{}' could not be registered.".replace("{}",e)), +!r)throw t;W(t),s=l} +s.name||(s.name=e),i[e]=s,s.rawDefinition=t.bind(null,n),s.aliases&&v(s.aliases,{ +languageName:e})},unregisterLanguage:e=>{delete i[e] +;for(const t of Object.keys(s))s[t]===e&&delete s[t]}, +listLanguages:()=>Object.keys(i),getLanguage:O,registerAliases:v, +autoDetection:k,inherit:Q,addPlugin:e=>{(e=>{ +e["before:highlightBlock"]&&!e["before:highlightElement"]&&(e["before:highlightElement"]=t=>{ +e["before:highlightBlock"](Object.assign({block:t.el},t)) +}),e["after:highlightBlock"]&&!e["after:highlightElement"]&&(e["after:highlightElement"]=t=>{ +e["after:highlightBlock"](Object.assign({block:t.el},t))})})(e),o.push(e)}, +removePlugin:e=>{const t=o.indexOf(e);-1!==t&&o.splice(t,1)}}),n.debugMode=()=>{ +r=!1},n.safeMode=()=>{r=!0},n.versionString="11.9.0",n.regex={concat:h, +lookahead:g,either:f,optional:d,anyNumberOfTimes:u} +;for(const t in j)"object"==typeof j[t]&&e(j[t]);return Object.assign(n,j),n +},ne=te({});return ne.newInstance=()=>te({}),ne}() +;"object"==typeof exports&&"undefined"!=typeof module&&(module.exports=hljs);/*! `bash` grammar compiled for Highlight.js 11.9.0 */ +(()=>{var e=(()=>{"use strict";return e=>{const s=e.regex,t={},n={begin:/\$\{/, +end:/\}/,contains:["self",{begin:/:-/,contains:[t]}]};Object.assign(t,{ +className:"variable",variants:[{ +begin:s.concat(/\$[\w\d#@][\w\d_]*/,"(?![\\w\\d])(?![$])")},n]});const a={ +className:"subst",begin:/\$\(/,end:/\)/,contains:[e.BACKSLASH_ESCAPE] +},i=e.inherit(e.COMMENT(),{match:[/(^|\s)/,/#.*$/],scope:{2:"comment"}}),c={ +begin:/<<-?\s*(?=\w+)/,starts:{contains:[e.END_SAME_AS_BEGIN({begin:/(\w+)/, +end:/(\w+)/,className:"string"})]}},o={className:"string",begin:/"/,end:/"/, +contains:[e.BACKSLASH_ESCAPE,t,a]};a.contains.push(o);const r={begin:/\$?\(\(/, +end:/\)\)/,contains:[{begin:/\d+#[0-9a-f]+/,className:"number"},e.NUMBER_MODE,t] +},l=e.SHEBANG({binary:"(fish|bash|zsh|sh|csh|ksh|tcsh|dash|scsh)",relevance:10 +}),m={className:"function",begin:/\w[\w\d_]*\s*\(\s*\)\s*\{/,returnBegin:!0, +contains:[e.inherit(e.TITLE_MODE,{begin:/\w[\w\d_]*/})],relevance:0};return{ +name:"Bash",aliases:["sh"],keywords:{$pattern:/\b[a-z][a-z0-9._-]+\b/, +keyword:["if","then","else","elif","fi","for","while","until","in","do","done","case","esac","function","select"], +literal:["true","false"], +built_in:["break","cd","continue","eval","exec","exit","export","getopts","hash","pwd","readonly","return","shift","test","times","trap","umask","unset","alias","bind","builtin","caller","command","declare","echo","enable","help","let","local","logout","mapfile","printf","read","readarray","source","type","typeset","ulimit","unalias","set","shopt","autoload","bg","bindkey","bye","cap","chdir","clone","comparguments","compcall","compctl","compdescribe","compfiles","compgroups","compquote","comptags","comptry","compvalues","dirs","disable","disown","echotc","echoti","emulate","fc","fg","float","functions","getcap","getln","history","integer","jobs","kill","limit","log","noglob","popd","print","pushd","pushln","rehash","sched","setcap","setopt","stat","suspend","ttyctl","unfunction","unhash","unlimit","unsetopt","vared","wait","whence","where","which","zcompile","zformat","zftp","zle","zmodload","zparseopts","zprof","zpty","zregexparse","zsocket","zstyle","ztcp","chcon","chgrp","chown","chmod","cp","dd","df","dir","dircolors","ln","ls","mkdir","mkfifo","mknod","mktemp","mv","realpath","rm","rmdir","shred","sync","touch","truncate","vdir","b2sum","base32","base64","cat","cksum","comm","csplit","cut","expand","fmt","fold","head","join","md5sum","nl","numfmt","od","paste","ptx","pr","sha1sum","sha224sum","sha256sum","sha384sum","sha512sum","shuf","sort","split","sum","tac","tail","tr","tsort","unexpand","uniq","wc","arch","basename","chroot","date","dirname","du","echo","env","expr","factor","groups","hostid","id","link","logname","nice","nohup","nproc","pathchk","pinky","printenv","printf","pwd","readlink","runcon","seq","sleep","stat","stdbuf","stty","tee","test","timeout","tty","uname","unlink","uptime","users","who","whoami","yes"] +},contains:[l,e.SHEBANG(),m,r,i,c,{match:/(\/[a-z._-]+)+/},o,{match:/\\"/},{ +className:"string",begin:/'/,end:/'/},{match:/\\'/},t]}}})() +;hljs.registerLanguage("bash",e)})();/*! `nix` grammar compiled for Highlight.js 11.9.0 */ +(()=>{var e=(()=>{"use strict";return e=>{const n={ +keyword:["rec","with","let","in","inherit","assert","if","else","then"], +literal:["true","false","or","and","null"], +built_in:["import","abort","baseNameOf","dirOf","isNull","builtins","map","removeAttrs","throw","toString","derivation"] +},s={className:"subst",begin:/\$\{/,end:/\}/,keywords:n},a={className:"string", +contains:[{className:"char.escape",begin:/''\$/},s],variants:[{begin:"''", +end:"''"},{begin:'"',end:'"'}] +},i=[e.NUMBER_MODE,e.HASH_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,a,{ +begin:/[a-zA-Z0-9-_]+(\s*=)/,returnBegin:!0,relevance:0,contains:[{ +className:"attr",begin:/\S+/,relevance:.2}]}];return s.contains=i,{name:"Nix", +aliases:["nixos"],keywords:n,contains:i}}})();hljs.registerLanguage("nix",e) +})();/*! `shell` grammar compiled for Highlight.js 11.9.0 */ +(()=>{var s=(()=>{"use strict";return s=>({name:"Shell Session", +aliases:["console","shellsession"],contains:[{className:"meta.prompt", +begin:/^\s{0,3}[/~\w\d[\]()@-]*[>%$#][ ]?/,starts:{end:/[^\\](?=\s*$)/, +subLanguage:"bash"}}]})})();hljs.registerLanguage("shell",s)})(); \ No newline at end of file diff --git a/docs-preview-569/highlightjs/loader.js b/docs-preview-569/highlightjs/loader.js new file mode 100644 index 000000000..cf0fdac57 --- /dev/null +++ b/docs-preview-569/highlightjs/loader.js @@ -0,0 +1,6 @@ +/* This file is NOT part of highlight.js */ +document.addEventListener('DOMContentLoaded', (event) => { + document.querySelectorAll('.programlisting, .screen').forEach((element) => { + hljs.highlightElement(element); + }); +}); diff --git a/docs-preview-569/highlightjs/mono-blue.css b/docs-preview-569/highlightjs/mono-blue.css new file mode 100644 index 000000000..bc9bceae4 --- /dev/null +++ b/docs-preview-569/highlightjs/mono-blue.css @@ -0,0 +1,56 @@ +pre code.hljs { + display: block; + overflow-x: auto; + padding: 1em +} +code.hljs { + padding: 3px 5px +} +/* + Five-color theme from a single blue hue. +*/ +.hljs { + background: #eaeef3; + color: #00193a +} +.hljs-keyword, +.hljs-selector-tag, +.hljs-title, +.hljs-section, +.hljs-doctag, +.hljs-name, +.hljs-strong { + font-weight: bold +} +.hljs-comment { + color: #738191 +} +.hljs-string, +.hljs-title, +.hljs-section, +.hljs-built_in, +.hljs-literal, +.hljs-type, +.hljs-addition, +.hljs-tag, +.hljs-quote, +.hljs-name, +.hljs-selector-id, +.hljs-selector-class { + color: #0048ab +} +.hljs-meta, +.hljs-subst, +.hljs-symbol, +.hljs-regexp, +.hljs-attribute, +.hljs-deletion, +.hljs-variable, +.hljs-template-variable, +.hljs-link, +.hljs-bullet { + color: #4c81c9 +} +.hljs-emphasis { + font-style: italic +} \ No newline at end of file diff --git a/docs-preview-569/index.xhtml b/docs-preview-569/index.xhtml new file mode 100644 index 000000000..451c1e679 --- /dev/null +++ b/docs-preview-569/index.xhtml @@ -0,0 +1,1046 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + <title>nvf manual</title> +<link rel="stylesheet" type="text/css" href="style.css" /> +<script src="highlightjs/highlight.pack.js" type="text/javascript"></script><script src="highlightjs/loader.js" type="text/javascript"></script><script src="script/anchor-use.js" type="text/javascript"></script><script src="script/anchor-min.js" type="text/javascript"></script><script src="script/search.js" type="text/javascript"></script> + <meta name="generator" content="nixos-render-docs" /> + <link rel="home" href="index.xhtml" title="nvf manual" /> + <link rel="next" href="quirks.html" title="Appendix A. Known Issues and Quirks" /> + </head> + <body> + <div class="navheader"> + <table width="100%" summary="Navigation header"> + <tr> + <th colspan="3" align="center">nvf manual</th> + </tr> + <tr> + <td width="20%" align="left"> </td> + <th width="60%" align="center"> </th> + <td width="20%" align="right"> <a accesskey="n" href="quirks.html">Next</a></td> + </tr> + </table> + <hr /> + </div> + <div class="book"> + <div class="titlepage"> + <div> + <div><h1 class="title"><a id="nvf-manual"></a>nvf manual</h1></div> + <div><h2 class="subtitle">Version v0.8</h2></div> + </div> + <hr /> + </div> +<div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="preface"> <a href="index.xhtml#ch-preface">Preface</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-what-is-it">What is nvf</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-bugs-suggestions">Bugs & Suggestions</a> </span></dt></dl></dd><dt> <span class="preface"> <a href="index.xhtml#ch-try-it-out">Try it out</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-using-prebuilt-configs">Using Prebuilt Configs</a> </span></dt></dl></dd><dt> <span class="part"> <a href="index.xhtml#ch-default-configs">Default Configs</a> </span></dt><dd><dl><dt> <span class="chapter"> <a href="index.xhtml#sec-default-maximal">Maximal</a> </span></dt><dt> <span class="chapter"> <a href="index.xhtml#sec-default-nix">Nix</a> </span></dt></dl></dd><dt> <span class="part"> <a href="index.xhtml#ch-installation">Installing nvf</a> </span></dt><dd><dl><dt> <span class="chapter"> <a href="index.xhtml#ch-standalone-installation">Standalone Installation</a> </span></dt><dd><dl><dt> <span class="chapter"> <a href="index.xhtml#ch-standalone-nixos">Standalone Installation on NixOS</a> </span></dt><dt> <span class="chapter"> <a href="index.xhtml#ch-standalone-hm">Standalone Installation on Home-Manager</a> </span></dt></dl></dd><dt> <span class="chapter"> <a href="index.xhtml#ch-module-installation">Module Installation</a> </span></dt><dd><dl><dt> <span class="chapter"> <a href="index.xhtml#ch-nixos-module">NixOS Module</a> </span></dt><dt> <span class="chapter"> <a href="index.xhtml#ch-hm-module">Home-Manager Module</a> </span></dt></dl></dd></dl></dd><dt> <span class="part"> <a href="index.xhtml#ch-configuring">Configuring nvf</a> </span></dt><dd><dl><dt> <span class="chapter"> <a href="index.xhtml#ch-custom-package">Custom Neovim Package</a> </span></dt><dt> <span class="chapter"> <a href="index.xhtml#ch-custom-plugins">Custom Plugins</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#ch-adding-plugins">Adding Plugins</a> </span></dt></dl></dd><dt> <span class="chapter"> <a href="index.xhtml#ch-custom-inputs">Custom Inputs</a> </span></dt><dt> <span class="chapter"> <a href="index.xhtml#ch-languages">Language Support</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-languages-custom-lsp-packages">LSP Custom Packages/Command</a> </span></dt></dl></dd><dt> <span class="chapter"> <a href="index.xhtml#ch-using-dags">Using DAGs</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-types-dag-entryAnywhere">entryAnywhere</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#ch-types-dag-entryAfter">entryAfter</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#ch-types-dag-entryBefore">entryBefore</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-types-dag-entryBetween">entryBetween</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-types-dag-entriesAnywhere">entriesAnywhere</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-types-dag-entriesAfter">entriesAfter</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-types-dag-entriesBefore">entriesBefore</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-types-dag-entriesBetween">entriesBetween</a> </span></dt></dl></dd><dt> <span class="chapter"> <a href="index.xhtml#ch-dag-entries">DAG entries in nvf</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#ch-vim-luaconfigrc"><code class="literal">vim.luaConfigRC</code> (top-level DAG)</a> </span></dt></dl></dd></dl></dd><dt> <span class="part"> <a href="index.xhtml#ch-helpful-tips">Helpful Tips</a> </span></dt><dd><dl><dt> <span class="chapter"> <a href="index.xhtml#sec-debugging-nvf">Debugging nvf</a> </span></dt><dt> <span class="chapter"> <a href="index.xhtml#sec-offline-documentation">Offline Documentation</a> </span></dt></dl></dd><dt> <span class="chapter"> <a href="index.xhtml#ch-hacking">Hacking nvf</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-contrib-getting-started">Getting Started</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines">Guidelines</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-testing-changes">Testing Changes</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-keybinds">Keybinds</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-additional-plugins">Adding Plugins</a> </span></dt></dl></dd><dt> <span class="appendix"> <a href="quirks.html">A. Known Issues and Quirks</a> </span></dt><dd><dl><dt> <span class="chapter"> <a href="quirks.html#ch-quirks-nodejs">NodeJS</a> </span></dt></dl></dd><dt> <span class="appendix"> <a href="options.html">B. Neovim Flake Configuration Options</a> </span></dt><dt> <span class="appendix"> <a href="release-notes.html">C. Release Notes</a> </span></dt><dd><dl><dt> <span class="chapter"> <a href="release-notes.html#sec-release-0.1">Release 0.1</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.html#sec-release-0.2">Release 0.2</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.html#sec-release-0.3">Release 0.3</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.html#sec-release-0.4">Release 0.4</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.html#sec-release-0.5">Release 0.5</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.html#sec-release-0.6">Release 0.6</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.html#sec-release-0.7">Release 0.7</a> </span></dt></dl></dd> </dl></div> +<div class="preface"> <div class="titlepage"> <div> <div> <h1 id="ch-preface" class="title" >Preface </h1> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-what-is-it">What is nvf</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-bugs-suggestions">Bugs & Suggestions</a> </span></dt> </dl></div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-what-is-it" class="title" >What is nvf </h2> </div> </div></div><p>nvf is a highly modular, configurable, extensible and easy to use Neovim +configuration in Nix. Designed for flexibility and ease of use, nvf allows you +to easily configure your fully featured Neovim instance with a few lines of Nix.</p> +</div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-bugs-suggestions" class="title" >Bugs & Suggestions </h2> </div> </div></div><p>If you notice any issues with nvf, or this documentation, then please consider +reporting them over at the <a class="link" href="https://github.com/notashelf/nvf/issues" target="_top">issue tracker</a>. Issues tab, in addition to the +<a class="link" href="https://github.com/notashelf/nvf/discussions" target="_top">discussions tab</a> is a good place as any to request new features.</p><p>You may also consider submitting bugfixes, feature additions and upstreamed +changes that you think are critical over at the <a class="link" href="https://github.com/notashelf/nvf/pulls" target="_top">pull requests tab</a>.</p> +</div> + +</div><div class="preface"> <div class="titlepage"> <div> <div> <h1 id="ch-try-it-out" class="title" >Try it out </h1> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-using-prebuilt-configs">Using Prebuilt Configs</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-available-configs">Available Configs</a> </span></dt></dl></dd> </dl></div><p>Thanks to the portability of Nix, you can try out nvf without actually +installing it to your machine. Below are the commands you may run to try out +different configurations provided by this flake. As of v0.5, two specialized +configurations are provided:</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p><span class="strong"><strong>Nix</strong></span> - Nix language server + simple utility plugins</p></li><li class="listitem"><p><span class="strong"><strong>Maximal</strong></span> - Variable language servers + utility and decorative plugins</p></li></ul></div><p>You may try out any of the provided configurations using the <code class="literal">nix run</code> command +on a system where Nix is installed.</p><pre><code class="programlisting bash">$ cachix use nvf # Optional: it'll save you CPU resources and time +$ nix run github:notashelf/nvf#nix # will run the default minimal configuration +</code></pre><p>Do keep in mind that this is <span class="strong"><strong>susceptible to garbage collection</strong></span> meaning it +will be removed from your Nix store once you garbage collect.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-using-prebuilt-configs" class="title" >Using Prebuilt Configs </h2> </div> </div></div><div class="toc"> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-available-configs">Available Configs</a> </span></dt> </dl></div><pre><code class="programlisting bash">$ nix run github:notashelf/nvf#nix +$ nix run github:notashelf/nvf#maximal +</code></pre><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-available-configs" class="title" >Available Configs </h3> </div> </div></div><div class="section"> <div class="titlepage"> <div> <div> <h4 id="sec-configs-nix" class="title" >Nix </h4> </div> </div></div><p><code class="literal">Nix</code> configuration by default provides LSP/diagnostic support for Nix alongside +a set of visual and functional plugins. By running <code class="literal">nix run .#</code>, which is the +default package, you will build Neovim with this config.</p> +</div><div class="section"> <div class="titlepage"> <div> <div> <h4 id="sec-configs-maximal" class="title" >Maximal </h4> </div> </div></div><p><code class="literal">Maximal</code> is the ultimate configuration that will enable support for more +commonly used language as well as additional complementary plugins. Keep in +mind, however, that this will pull a lot of dependencies.</p><div class="tip"><h3 class="title">Tip</h3><p>You are <span class="emphasis"><em>strongly</em></span> recommended to use the binary cache if you would like to try +the Maximal configuration.</p></div> +</div> + +</div> + +</div> + +</div><div class="part"> <div class="titlepage"> <div> <div> <h1 id="ch-default-configs" class="title" >Default Configs </h1> </div> </div></div><div class="partintro"><p>While you can configure <span class="strong"><strong>nvf</strong></span> yourself using the builder, you can also use the +pre-built configs that are available. Here are a few default configurations you +can use.</p><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="chapter"> <a href="index.xhtml#sec-default-maximal">Maximal</a> </span></dt><dt> <span class="chapter"> <a href="index.xhtml#sec-default-nix">Nix</a> </span></dt> </dl></div></div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="sec-default-maximal" class="title" >Maximal </h2> </div> </div></div><pre><code class="programlisting bash">$ nix shell github:notashelf/nvf#maximal test.nix +</code></pre><p>It is the same fully configured Neovim as with the <a class="link" href="index.xhtml#sec-default-nix" title="Nix" >Nix</a> +configuration, but with every supported language enabled.</p><p>::: {.note} Running the maximal config will download <span class="emphasis"><em>a lot</em></span> of packages as it +is downloading language servers, formatters, and more. :::</p> +</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="sec-default-nix" class="title" >Nix </h2> </div> </div></div><pre><code class="programlisting bash">$ nix run github:notashelf/nvf#nix test.nix +</code></pre><p>Enables all the of Neovim plugins, with language support for specifically Nix. +This lets you see what a fully configured neovim setup looks like without +downloading a whole bunch of language servers and associated tools.</p> +</div> +</div><div class="part"> <div class="titlepage"> <div> <div> <h1 id="ch-installation" class="title" >Installing nvf </h1> </div> </div></div><div class="partintro"><p>There are multiple ways of installing nvf on your system. You may either choose +the standalone installation method, which does not depend on a module system and +may be done on any system that has the Nix package manager or the appropriate +modules for NixOS and home-manager as described in the +<a class="link" href="index.xhtml#ch-module-installation" title="Module Installation" >module installation section</a>.</p><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="chapter"> <a href="index.xhtml#ch-standalone-installation">Standalone Installation</a> </span></dt><dd><dl><dt> <span class="chapter"> <a href="index.xhtml#ch-standalone-nixos">Standalone Installation on NixOS</a> </span></dt><dt> <span class="chapter"> <a href="index.xhtml#ch-standalone-hm">Standalone Installation on Home-Manager</a> </span></dt></dl></dd><dt> <span class="chapter"> <a href="index.xhtml#ch-module-installation">Module Installation</a> </span></dt><dd><dl><dt> <span class="chapter"> <a href="index.xhtml#ch-nixos-module">NixOS Module</a> </span></dt><dt> <span class="chapter"> <a href="index.xhtml#ch-hm-module">Home-Manager Module</a> </span></dt></dl></dd> </dl></div></div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="ch-standalone-installation" class="title" >Standalone Installation </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="chapter"> <a href="index.xhtml#ch-standalone-nixos">Standalone Installation on NixOS</a> </span></dt><dt> <span class="chapter"> <a href="index.xhtml#ch-standalone-hm">Standalone Installation on Home-Manager</a> </span></dt> </dl></div><p>It is possible to install nvf without depending on NixOS or Home-Manager as the +parent module system, using the <code class="literal">neovimConfiguration</code> function exposed in the +extended library. This function will take <code class="literal">modules</code> and <code class="literal">extraSpecialArgs</code> as +arguments, and return the following schema as a result.</p><pre><code class="programlisting nix">{ + options = "The options that were available to configure"; + config = "The outputted configuration"; + pkgs = "The package set used to evaluate the module"; + neovim = "The built neovim package"; +} +</code></pre><p>An example flake that exposes your custom Neovim configuration might look like</p><pre><code class="programlisting nix">{ + inputs = { + nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable"; + nvf.url = "github:notashelf/nvf"; + }; + + outputs = { + self, + nixpkgs, + ... + } @ inputs: { + packages."x86_64-linux" = let + neovimConfigured = (inputs.nvf.lib.neovimConfiguration { + inherit (nixpkgs.legacyPackages."x86_64-linux") pkgs; + modules = [{ + config.vim = { + # Enable custom theming options + theme.enable = true; + + # Enable Treesitter + tree-sitter.enable = true; + + # Other options will go here. Refer to the config + # reference in Appendix B of the nvf manual. + # ... + }; + }]; + }); + in { + # Set the default package to the wrapped instance of Neovim. + # This will allow running your Neovim configuration with + # `nix run` and in addition, sharing your configuration with + # other users in case your repository is public. + default = neovimConfigured.neovim; + }; + }; +} +</code></pre><p>The above setup will allow to set up nvf as a standalone flake, which you can +build independently from your system configuration while also possibly sharing +it with others. The next two chapters will detail specific usage of such a setup +for a package output in the context of NixOS or Home-Manager installation.</p><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="ch-standalone-nixos" class="title" >Standalone Installation on NixOS </h2> </div> </div></div><p>Your built Neovim configuration can be exposed as a flake output to make it +easier to share across machines, repositories and so on. Or it can be added to +your system packages to make it available across your system.</p><p>The following is an example installation of <code class="literal">nvf</code> as a standalone package with +the default theme enabled. You may use other options inside <code class="literal">config.vim</code> in +<code class="literal">configModule</code>, but this example will not cover that extensively.</p><pre><code class="programlisting nix">{ + inputs = { + nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable"; + home-manager.url = "github:nix-community/home-manager"; + nvf.url = "github:notashelf/nvf"; + }; + + outputs = {nixpkgs, nvf, ...}: let + system = "x86_64-linux"; + pkgs = nixpkgs.legacyPackages.${system}; + configModule = { + # Add any custom options (and do feel free to upstream them!) + # options = { ... }; + + config.vim = { + theme.enable = true; + # and more options as you see fit... + }; + }; + + customNeovim = nvf.lib.neovimConfiguration { + inherit pkgs; + modules = [configModule]; + }; + in { + # This will make the package available as a flake output under 'packages' + packages.${system}.my-neovim = customNeovim.neovim; + + # Example nixosConfiguration using the configured Neovim package + nixosConfigurations = { + yourHostName = nixpkgs.lib.nixosSystem { + # ... + modules = [ + # This will make wrapped neovim available in your system packages + {environment.systemPackages = [customNeovim.neovim];} + ]; + # ... + }; + }; + }; +} +</code></pre> +</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="ch-standalone-hm" class="title" >Standalone Installation on Home-Manager </h2> </div> </div></div><p>Your built Neovim configuration can be exposed as a flake output to make it +easier to share across machines, repositories and so on. Or it can be added to +your system packages to make it available across your system.</p><p>The following is an example installation of <code class="literal">nvf</code> as a standalone package with +the default theme enabled. You may use other options inside <code class="literal">config.vim</code> in +<code class="literal">configModule</code>, but this example will not cover that extensively.</p><pre><code class="programlisting nix">{ + inputs = { + nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable"; + home-manager.url = "github:nix-community/home-manager"; + nvf.url = "github:notashelf/nvf"; + }; + + outputs = {nixpkgs, home-manager, nvf, ...}: let + system = "x86_64-linux"; + pkgs = nixpkgs.legacyPackages.${system}; + configModule = { + # Add any custom options (and do feel free to upstream them!) + # options = { ... }; + + config.vim = { + theme.enable = true; + # and more options as you see fit... + }; + }; + + customNeovim = nvf.lib.neovimConfiguration { + inherit pkgs; + modules = [configModule]; + }; + in { + # This will make the package available as a flake output under 'packages' + packages.${system}.my-neovim = customNeovim.neovim; + + # Example Home-Manager configuration using the configured Neovim package + homeConfigurations = { + "your-username@your-hostname" = home-manager.lib.homeManagerConfiguration { + # ... + modules = [ + # This will make Neovim available to users using the Home-Manager + # configuration. To make the package available to all users, prefer + # environment.systemPackages in your NixOS configuration. + {home.packages = [customNeovim.neovim];} + ]; + # ... + }; + }; + }; +} +</code></pre> +</div> +</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="ch-module-installation" class="title" >Module Installation </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="chapter"> <a href="index.xhtml#ch-nixos-module">NixOS Module</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-example-installation-nixos">Example Installation</a> </span></dt></dl></dd><dt> <span class="chapter"> <a href="index.xhtml#ch-hm-module">Home-Manager Module</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-example-installation-hm">Example Installation</a> </span></dt></dl></dd> </dl></div><p>The below chapters will describe installing nvf as NixOS and Home-Manager +modules. Note that those methods are mutually exclusive, and will likely cause +path collisions if used simultaneously.</p><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="ch-nixos-module" class="title" >NixOS Module </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-example-installation-nixos">Example Installation</a> </span></dt> </dl></div><p>The NixOS module allows us to customize the different <code class="literal">vim</code> options from inside +the NixOS configuration without having to call for the wrapper yourself. It is +the recommended way to use <span class="strong"><strong>nvf</strong></span> alongside the home-manager module depending +on your needs.</p><p>To use it, we first add the input flake.</p><pre><code class="programlisting nix">{ + inputs = { + # Optional, if you intend to follow nvf's obsidian-nvim input + # you must also add it as a flake input. + obsidian-nvim.url = "github:epwalsh/obsidian.nvim"; + + # Required, nvf works best and only directly supports flakes + nvf = { + url = "github:notashelf/nvf"; + # You can override the input nixpkgs to follow your system's + # instance of nixpkgs. This is safe to do as nvf does not depend + # on a binary cache. + inputs.nixpkgs.follows = "nixpkgs"; + # Optionally, you can also override individual plugins + # for example: + inputs.obsidian-nvim.follows = "obsidian-nvim"; # <- this will use the obsidian-nvim from your inputs + }; + }; +} +</code></pre><p>Followed by importing the NixOS module somewhere in your configuration.</p><pre><code class="programlisting nix">{ + # assuming nvf is in your inputs and inputs is in the argset + # see example below + imports = [ inputs.nvf.nixosModules.default ]; +} +</code></pre><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-example-installation-nixos" class="title" style="clear: both">Example Installation </h2> </div> </div></div><pre><code class="programlisting nix">{ + inputs = { + nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable"; + nvf.url = "github:notashelf/nvf"; + }; + + outputs = { nixpkgs, nvf, ... }: { + # ↓ this is your host output in the flake schema + nixosConfigurations."your-hostname" = nixpkgs.lib.nixosSystem { + modules = [ + nvf.nixosModules.default # <- this imports the NixOS module that provides the options + ./configuration.nix # <- your host entrypoint, `programs.nvf.*` may be defined here + ]; + }; + }; +} +</code></pre><p>Once the module is properly imported by your host, you will be able to use the +<code class="literal">programs.nvf</code> module option anywhere in your configuration in order to +configure <span class="strong"><strong>nvf</strong></span>.</p><pre><code class="programlisting nix{"> programs.nvf = { + enable = true; + # your settings need to go into the settings attribute set + # most settings are documented in the appendix + settings = { + vim.viAlias = false; + vim.vimAlias = true; + vim.lsp = { + enable = true; + }; + }; + }; +} +</code></pre><div class="note"><h3 class="title">Note</h3><p><span class="strong"><strong>nvf</strong></span> exposes a lot of options, most of which are not referenced in the +installation sections of the manual. You may find all available options in the +<a class="link" href="https://notashelf.github.io/nvf/options" target="_top">appendix</a></p></div> +</div> + +</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="ch-hm-module" class="title" >Home-Manager Module </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-example-installation-hm">Example Installation</a> </span></dt> </dl></div><p>The home-manager module allows us to customize the different <code class="literal">vim</code> options from +inside the home-manager configuration without having to call for the wrapper +yourself. It is the recommended way to use <span class="strong"><strong>nvf</strong></span> alongside the NixOS module +depending on your needs.</p><p>To use it, we first add the input flake.</p><pre><code class="programlisting nix">{ + inputs = { + # Optional, if you intend to follow nvf's obsidian-nvim input + # you must also add it as a flake input. + obsidian-nvim.url = "github:epwalsh/obsidian.nvim"; + + # Required, nvf works best and only directly supports flakes + nvf = { + url = "github:notashelf/nvf"; + # You can override the input nixpkgs to follow your system's + # instance of nixpkgs. This is safe to do as nvf does not depend + # on a binary cache. + inputs.nixpkgs.follows = "nixpkgs"; + # Optionally, you can also override individual plugins + # for example: + inputs.obsidian-nvim.follows = "obsidian-nvim"; # <- this will use the obsidian-nvim from your inputs + }; + }; +} +</code></pre><p>Followed by importing the home-manager module somewhere in your configuration.</p><pre><code class="programlisting nix">{ + # Assuming "nvf" is in your inputs and inputs is in the argument set. + # See example installation below + imports = [ inputs.nvf.homeManagerModules.default ]; +} +</code></pre><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-example-installation-hm" class="title" style="clear: both">Example Installation </h2> </div> </div></div><pre><code class="programlisting nix">{ + inputs = { + nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable"; + home-manager.url = "github:nix-community/home-manager"; + nvf.url = "github:notashelf/nvf"; + }; + + outputs = { nixpkgs, home-manager, nvf, ... }: let + system = "x86_64-linux"; + pkgs = nixpkgs.legacyPackages.${system}; + in { + # ↓ this is your home output in the flake schema, expected by home-manager + "your-username@your-hostname" = home-manager.lib.homeManagerConfiguration { + inherit pkgs; + modules = [ + nvf.homeManagerModules.default # <- this imports the home-manager module that provides the options + ./home.nix # <- your home entrypoint, `programs.nvf.*` may be defined here + ]; + }; + }; +} +</code></pre><p>Once the module is properly imported by your host, you will be able to use the +<code class="literal">programs.nvf</code> module option anywhere in your configuration in order to +configure <span class="strong"><strong>nvf</strong></span>.</p><pre><code class="programlisting nix{"> programs.nvf = { + enable = true; + # your settings need to go into the settings attribute set + # most settings are documented in the appendix + settings = { + vim.viAlias = false; + vim.vimAlias = true; + vim.lsp = { + enable = true; + }; + }; + }; +} +</code></pre><div class="note"><h3 class="title">Note</h3><p><span class="strong"><strong>nvf</strong></span> exposes a lot of options, most of which are not referenced in the +installation sections of the manual. You may find all available options in the +<a class="link" href="https://notashelf.github.io/nvf/options" target="_top">appendix</a></p></div> +</div> + +</div> +</div> +</div><div class="part"> <div class="titlepage"> <div> <div> <h1 id="ch-configuring" class="title" >Configuring nvf </h1> </div> </div></div><div class="partintro"><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="chapter"> <a href="index.xhtml#ch-custom-package">Custom Neovim Package</a> </span></dt><dt> <span class="chapter"> <a href="index.xhtml#ch-custom-plugins">Custom Plugins</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#ch-adding-plugins">Adding Plugins</a> </span></dt></dl></dd><dt> <span class="chapter"> <a href="index.xhtml#ch-custom-inputs">Custom Inputs</a> </span></dt><dt> <span class="chapter"> <a href="index.xhtml#ch-languages">Language Support</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-languages-custom-lsp-packages">LSP Custom Packages/Command</a> </span></dt></dl></dd><dt> <span class="chapter"> <a href="index.xhtml#ch-using-dags">Using DAGs</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-types-dag-entryAnywhere">entryAnywhere</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#ch-types-dag-entryAfter">entryAfter</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#ch-types-dag-entryBefore">entryBefore</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-types-dag-entryBetween">entryBetween</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-types-dag-entriesAnywhere">entriesAnywhere</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-types-dag-entriesAfter">entriesAfter</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-types-dag-entriesBefore">entriesBefore</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-types-dag-entriesBetween">entriesBetween</a> </span></dt></dl></dd><dt> <span class="chapter"> <a href="index.xhtml#ch-dag-entries">DAG entries in nvf</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#ch-vim-luaconfigrc"><code class="literal">vim.luaConfigRC</code> (top-level DAG)</a> </span></dt></dl></dd> </dl></div></div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="ch-custom-package" class="title" >Custom Neovim Package </h2> </div> </div></div><p>As of v0.5, you may now specify the Neovim package that will be wrapped with +your configuration. This is done with the <code class="literal">vim.package</code> option.</p><pre><code class="programlisting nix">{inputs, pkgs, ...}: { + # using the neovim-nightly overlay + vim.package = inputs.neovim-overlay.packages.${pkgs.system}.neovim; +} +</code></pre><p>The neovim-nightly-overlay always exposes an unwrapped package. If using a +different source, you are highly recommended to get an “unwrapped” version of +the neovim package, similar to <code class="literal">neovim-unwrapped</code> in nixpkgs.</p><pre><code class="programlisting nix">{ pkgs, ...}: { + # using the neovim-nightly overlay + vim.package = pkgs.neovim-unwrapped; +} +</code></pre> +</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="ch-custom-plugins" class="title" >Custom Plugins </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#ch-adding-plugins">Adding Plugins</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-configuring-plugins">Configuring</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-lazy-method">Lazy Method</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-non-lazy-method">Non-lazy Method</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-legacy-method">Legacy Method</a> </span></dt></dl></dd> </dl></div><p><span class="strong"><strong>nvf</strong></span>, by default, exposes a wide variety of plugins as module options for +your convenience and bundles necessary dependencies into <span class="strong"><strong>nvf</strong></span>’s runtime. In +case a plugin is not available in <span class="strong"><strong>nvf</strong></span>, you may consider making a pull +request to <span class="strong"><strong>nvf</strong></span> to include it as a module or you may add it to your +configuration locally.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 id="ch-adding-plugins" class="title" style="clear: both">Adding Plugins </h2> </div> </div></div><div class="toc"> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-configuring-plugins">Configuring</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-lazy-method">Lazy Method</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-non-lazy-method">Non-lazy Method</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-legacy-method">Legacy Method</a> </span></dt> </dl></div><p>There are multiple ways of adding custom plugins to your <span class="strong"><strong>nvf</strong></span> configuration.</p><p>You can use custom plugins, before they are implemented in the flake. To add a +plugin to the runtime, you need to add it to the <a class="xref" href="options.html#opt-vim.startPlugins" ><code class="option">vim.startPlugins</code></a> list +in your configuration.</p><p>Adding a plugin to <code class="literal">startPlugins</code> will not allow you to configure the plugin +that you have added, but <span class="strong"><strong>nvf</strong></span> provides multiple way of configuring any custom +plugins that you might have added to your configuration.</p><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-configuring-plugins" class="title" >Configuring </h3> </div> </div></div><p>Just making the plugin to your Neovim configuration available might not always +be enough. In that case, you can write custom lua config using either +<code class="literal">config.vim.lazy.plugins.*.setupOpts</code> <code class="literal">config.vim.extraPlugins.*.setup</code> or +<code class="literal">config.vim.luaConfigRC</code>.</p><p>The first option uses an extended version of <code class="literal">lz.n</code>’s PluginSpec. <code class="literal">setupModule</code> +and <code class="literal">setupOpt</code> can be used if the plugin uses a <code class="literal">require('module').setup(...)</code> +pattern. Otherwise, the <code class="literal">before</code> and <code class="literal">after</code> hooks should do what you need.</p><pre><code class="programlisting nix">{ + config.vim.lazy.plugins = { + aerial.nvim = { + # ^^^^^^^^^ this name should match the package.pname or package.name + package = aerial-nvim; + + setupModule = "aerial"; + setupOpts = {option_name = false;}; + + after = "print('aerial loaded')"; + }; + }; +} +</code></pre><p>The second option uses an attribute set, which maps DAG section names to a +custom type, which has the fields <code class="literal">package</code>, <code class="literal">after</code>, <code class="literal">setup</code>. They allow you to +set the package of the plugin, the sections its setup code should be after (note +that the <code class="literal">extraPlugins</code> option has its own DAG scope), and the its setup code +respectively. For example:</p><pre><code class="programlisting nix">config.vim.extraPlugins = with pkgs.vimPlugins; { + aerial = { + package = aerial-nvim; + setup = "require('aerial').setup {}"; + }; + + harpoon = { + package = harpoon; + setup = "require('harpoon').setup {}"; + after = ["aerial"]; # place harpoon configuration after aerial + }; +} +</code></pre><p>The third option also uses an attribute set, but this one is resolved as a DAG +directly. The attribute names denote the section names, and the values lua code. +For example:</p><pre><code class="programlisting nix">{ + # this will create an "aquarium" section in your init.lua with the contents of your custom config + # which will be *appended* to the rest of your configuration, inside your init.vim + config.vim.luaConfigRC.aquarium = "vim.cmd('colorscheme aquiarum')"; +} +</code></pre><div class="note"><h3 class="title">Note</h3><p>One of the greatest strengths of nvf is the ability to order +snippets of configuration via the DAG system. It will allow specifying positions +of individual sections of configuration as needed. nvf provides helper functions +in the extended library, usually under <code class="literal">inputs.nvf.lib.nvim.dag</code> that you may +use.</p><p>Please refer to the <a class="link" href="/index.xhtml#ch-dag-entries" target="_top">DAG section</a> in the nvf manual +to find out more about the DAG system.</p></div> +</div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-lazy-method" class="title" >Lazy Method </h3> </div> </div></div><p>As of version <span class="strong"><strong>0.7</strong></span>, we exposed an API for configuring lazy-loaded plugins via +<code class="literal">lz.n</code> and <code class="literal">lzn-auto-require</code>.</p><pre><code class="programlisting nix">{ + config.vim.lazy.plugins = { + "aerial.nvim" = { + package = pkgs.vimPlugins.aerial-nvim; + setupModule = "aerial"; + setupOpts = { + option_name = true; + }; + after = '' + -- custom lua code to run after plugin is loaded + print('aerial loaded') + ''; + + # Explicitly mark plugin as lazy. You don't need this if you define one of + # the trigger "events" below + lazy = true; + + # load on command + cmd = ["AerialOpen"]; + + # load on event + event = ["BufEnter"]; + + # load on keymap + keys = [ + { + key = "<leader>a"; + action = ":AerialToggle<CR>"; + } + ]; + }; + }; +} +</code></pre> +</div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-non-lazy-method" class="title" >Non-lazy Method </h3> </div> </div></div><p>As of version <span class="strong"><strong>0.5</strong></span>, we have a more extensive API for configuring plugins, +under <code class="literal">vim.extraPlugins</code>. Instead of using DAGs exposed by the library, you may +use the extra plugin module as follows:</p><pre><code class="programlisting nix">{ + config.vim.extraPlugins = with pkgs.vimPlugins; { + aerial = { + package = aerial-nvim; + setup = '' + require('aerial').setup { + -- some lua configuration here + } + ''; + }; + + harpoon = { + package = harpoon; + setup = "require('harpoon').setup {}"; + after = ["aerial"]; + }; + }; +} +</code></pre> +</div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-legacy-method" class="title" >Legacy Method </h3> </div> </div></div><p>Prior to version v0.5, the method of adding new plugins was adding the plugin +package to <code class="literal">vim.startPlugins</code> and add its configuration as a DAG under one of +<code class="literal">vim.configRC</code> or <code class="literal">vim.luaConfigRC</code>. Users who have not yet updated to 0.5, or +prefer a more hands-on approach may use the old method where the load order of +the plugins is determined by DAGs.</p><div class="section"> <div class="titlepage"> <div> <div> <h4 id="sec-adding-plugins" class="title" >Adding plugins </h4> </div> </div></div><p>To add a plugin not available in nvf as a module to your configuration, you may +add it to <a class="xref" href="options.html#opt-vim.startPlugins" ><code class="option">vim.startPlugins</code></a> in order to make it available to Neovim at +runtime.</p><pre><code class="programlisting nix">{pkgs, ...}: { + # Add a Neovim plugin from Nixpkgs to the runtime. + vim.startPlugins = [pkgs.vimPlugins.aerial-nvim]; +} +</code></pre><p>And to configure the added plugin, you can use the <code class="literal">luaConfigRC</code> option to +provide configuration as a DAG using the <span class="strong"><strong>nvf</strong></span> extended library.</p><pre><code class="programlisting nix">{inputs, ...}: let + # This assumes you have an input called 'nvf' in your flake inputs + # and 'inputs' in your specialArgs. In the case you have passed 'nvf' + # to specialArgs, the 'inputs' prefix may be omitted. + inherit (inputs.nvf.lib.nvim.dag) entryAnywhere; +in { + vim.luaConfigRC.aerial-nvim= entryAnywhere '' + require('aerial').setup { + -- your configuration here + } + ''; +} +</code></pre> +</div> + +</div> +</div> + +</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="ch-custom-inputs" class="title" >Custom Inputs </h2> </div> </div></div><p>One of the greatest strengths of <span class="strong"><strong>nvf</strong></span> is its ability to get plugins from +flake inputs and build them locally from any given source. For plugins that do +not require any kind of additional building step, this is a powerful method of +adding plugins to your configuration that are not packaged in nixpkgs, or those +you want to track from source without relying on nixpkgs.</p><p>The <a class="link" href="index.xhtml#sec-additional-plugins" title="Adding Plugins" >additional plugins section</a> details the addition +of new plugins to nvf under regular circumstances, i.e. while making a pull +request to the project. You may <span class="emphasis"><em>override</em></span> those plugin inputs in your own +<code class="literal">flake.nix</code> to change source versions, e.g., to use newer versions of plugins +that are not yet updated in <span class="strong"><strong>nvf</strong></span>.</p><pre><code class="programlisting nix">{ + + inputs = { + # ... + + # The name here is arbitrary, you can name it whatever. + # This will add a plugin input called "your-neodev-input" + # that you can reference in a `follows` line. + your-neodev-input = { + url = "github:folke/neodev.nvim"; + flake = false; + }; + + nvf = { + url = "github:notashelf/nvf"; + + # The name of the input must match for the follows line + # plugin-neodev-nvim is what the input is called inside nvf + # so you must match the exact name here. + inputs.plugin-neodev-nvim.follows = "your-neodev-input"; + }; + # ... + }; +} +</code></pre><p>This will override the source for the <code class="literal">neodev.nvim</code> plugin that is used in nvf +with your own input. You can update your new input via <code class="literal">nix flake update</code> or +more specifically <code class="literal">nix flake update <name of your input></code> to keep it up to date.</p><div class="warning"><h3 class="title">Warning</h3><p>While updating plugin inputs, make sure that any configuration that has been +deprecated in newer versions is changed in the plugin’s <code class="literal">setupOpts</code>. If you +depend on a new version, requesting a version bump in the issues section is a +more reliable option.</p></div> +</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="ch-languages" class="title" >Language Support </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-languages-custom-lsp-packages">LSP Custom Packages/Command</a> </span></dt> </dl></div><p>Language specific support means there is a combination of language specific +plugins, <code class="literal">treesitter</code> support, <code class="literal">nvim-lspconfig</code> language servers, and <code class="literal">null-ls</code> +integration. This gets you capabilities ranging from autocompletion to +formatting to diagnostics. The following languages have sections under the +<code class="literal">vim.languages</code> attribute.</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p>Rust: <a class="link" href="options.html#opt-vim.languages.rust.enable" >vim.languages.rust.enable</a></p></li><li class="listitem"><p>Nix: <a class="link" href="options.html#opt-vim.languages.nix.enable" >vim.languages.nix.enable</a></p></li><li class="listitem"><p>SQL: <a class="link" href="options.html#opt-vim.languages.sql.enable" >vim.languages.sql.enable</a></p></li><li class="listitem"><p>C/C++: <a class="link" href="options.html#opt-vim.languages.clang.enable" >vim.languages.clang.enable</a></p></li><li class="listitem"><p>Typescript/Javascript: <a class="link" href="options.html#opt-vim.languages.ts.enable" >vim.languages.ts.enable</a></p></li><li class="listitem"><p>Python: <a class="link" href="options.html#opt-vim.languages.python.enable" >vim.languages.python.enable</a>:</p></li><li class="listitem"><p>Zig: <a class="link" href="options.html#opt-vim.languages.zig.enable" >vim.languages.zig.enable</a></p></li><li class="listitem"><p>Markdown: <a class="link" href="options.html#opt-vim.languages.markdown.enable" >vim.languages.markdown.enable</a></p></li><li class="listitem"><p>HTML: <a class="link" href="options.html#opt-vim.languages.html.enable" >vim.languages.html.enable</a></p></li><li class="listitem"><p>Dart: <a class="link" href="options.html#opt-vim.languages.dart.enable" >vim.languages.dart.enable</a></p></li><li class="listitem"><p>Go: <a class="link" href="options.html#opt-vim.languages.go.enable" >vim.languages.go.enable</a></p></li><li class="listitem"><p>Lua: <a class="link" href="options.html#opt-vim.languages.lua.enable" >vim.languages.lua.enable</a></p></li><li class="listitem"><p>PHP: <a class="link" href="options.html#opt-vim.languages.php.enable" >vim.languages.php.enable</a></p></li></ul></div><p>Adding support for more languages, and improving support for existing ones are +great places where you can contribute with a PR.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-languages-custom-lsp-packages" class="title" style="clear: both">LSP Custom Packages/Command </h2> </div> </div></div><p>In any of the <code class="literal">opt.languages.<language>.lsp.package</code> options you can provide +your own LSP package, or provide the command to launch the language server, as a +list of strings. You can use this to skip automatic installation of a language +server, and instead use the one found in your <code class="literal">$PATH</code> during runtime, for +example:</p><pre><code class="programlisting nix">vim.languages.java = { + lsp = { + enable = true; + # this expects jdt-language-server to be in your PATH + # or in `vim.extraPackages` + package = ["jdt-language-server" "-data" "~/.cache/jdtls/workspace"]; + }; +} +</code></pre> +</div> +</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="ch-using-dags" class="title" >Using DAGs </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-types-dag-entryAnywhere">entryAnywhere</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#ch-types-dag-entryAfter">entryAfter</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#ch-types-dag-entryBefore">entryBefore</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-types-dag-entryBetween">entryBetween</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-types-dag-entriesAnywhere">entriesAnywhere</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-types-dag-entriesAfter">entriesAfter</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-types-dag-entriesBefore">entriesBefore</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-types-dag-entriesBetween">entriesBetween</a> </span></dt> </dl></div><p>We conform to the NixOS options types for the most part, however, a noteworthy +addition for certain options is the +<a class="link" href="https://en.wikipedia.org/wiki/Directed_acyclic_graph" target="_top"><span class="strong"><strong>DAG (Directed acyclic graph)</strong></span></a> +type which is borrowed from home-manager’s extended library. This type is most +used for topologically sorting strings. The DAG type allows the attribute set +entries to express dependency relations among themselves. This can, for example, +be used to control the order of configuration sections in your <code class="literal">luaConfigRC</code>.</p><p>The below section, mostly taken from the +<a class="link" href="https://raw.githubusercontent.com/nix-community/home-manager/master/docs/manual/writing-modules/types.md" target="_top">home-manager manual</a> +explains in more detail the overall usage logic of the DAG type.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-types-dag-entryAnywhere" class="title" style="clear: both">entryAnywhere </h2> </div> </div></div><div class="blockquote"><blockquote class="blockquote"><p><code class="literal">lib.dag.entryAnywhere (value: T) : DagEntry<T></code></p></blockquote></div><p>Indicates that <code class="literal">value</code> can be placed anywhere within the DAG. This is also the +default for plain attribute set entries, that is</p><pre><code class="programlisting nix">foo.bar = { + a = lib.dag.entryAnywhere 0; +} +</code></pre><p>and</p><pre><code class="programlisting nix">foo.bar = { + a = 0; +} +</code></pre><p>are equivalent.</p> +</div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="ch-types-dag-entryAfter" class="title" style="clear: both">entryAfter </h2> </div> </div></div><div class="blockquote"><blockquote class="blockquote"><p><code class="literal">lib.dag.entryAfter (afters: list string) (value: T) : DagEntry<T></code></p></blockquote></div><p>Indicates that <code class="literal">value</code> must be placed <span class="emphasis"><em>after</em></span> each of the attribute names in the +given list. For example</p><pre><code class="programlisting nix">foo.bar = { + a = 0; + b = lib.dag.entryAfter [ "a" ] 1; +} +</code></pre><p>would place <code class="literal">b</code> after <code class="literal">a</code> in the graph.</p> +</div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="ch-types-dag-entryBefore" class="title" style="clear: both">entryBefore </h2> </div> </div></div><div class="blockquote"><blockquote class="blockquote"><p><code class="literal">lib.dag.entryBefore (befores: list string) (value: T) : DagEntry<T></code></p></blockquote></div><p>Indicates that <code class="literal">value</code> must be placed <span class="emphasis"><em>before</em></span> each of the attribute names in +the given list. For example</p><pre><code class="programlisting nix">foo.bar = { + b = lib.dag.entryBefore [ "a" ] 1; + a = 0; +} +</code></pre><p>would place <code class="literal">b</code> before <code class="literal">a</code> in the graph.</p> +</div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-types-dag-entryBetween" class="title" style="clear: both">entryBetween </h2> </div> </div></div><div class="blockquote"><blockquote class="blockquote"><p><code class="literal">lib.dag.entryBetween (befores: list string) (afters: list string) (value: T) : DagEntry<T></code></p></blockquote></div><p>Indicates that <code class="literal">value</code> must be placed <span class="emphasis"><em>before</em></span> the attribute names in the first +list and <span class="emphasis"><em>after</em></span> the attribute names in the second list. For example</p><pre><code class="programlisting nix">foo.bar = { + a = 0; + c = lib.dag.entryBetween [ "b" ] [ "a" ] 2; + b = 1; +} +</code></pre><p>would place <code class="literal">c</code> before <code class="literal">b</code> and after <code class="literal">a</code> in the graph.</p><p>There are also a set of functions that generate a DAG from a list. These are +convenient when you just want to have a linear list of DAG entries, without +having to manually enter the relationship between each entry. Each of these +functions take a <code class="literal">tag</code> as argument and the DAG entries will be named +<code class="literal">${tag}-${index}</code>.</p> +</div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-types-dag-entriesAnywhere" class="title" style="clear: both">entriesAnywhere </h2> </div> </div></div><div class="blockquote"><blockquote class="blockquote"><p><code class="literal">lib.dag.entriesAnywhere (tag: string) (values: [T]) : Dag<T></code></p></blockquote></div><p>Creates a DAG with the given values with each entry labeled using the given tag. +For example</p><pre><code class="programlisting nix">foo.bar = lib.dag.entriesAnywhere "a" [ 0 1 ]; +</code></pre><p>is equivalent to</p><pre><code class="programlisting nix">foo.bar = { + a-0 = 0; + a-1 = lib.dag.entryAfter [ "a-0" ] 1; +} +</code></pre> +</div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-types-dag-entriesAfter" class="title" style="clear: both">entriesAfter </h2> </div> </div></div><div class="blockquote"><blockquote class="blockquote"><p><code class="literal">lib.dag.entriesAfter (tag: string) (afters: list string) (values: [T]) : Dag<T></code></p></blockquote></div><p>Creates a DAG with the given values with each entry labeled using the given tag. +The list of values are placed are placed <span class="emphasis"><em>after</em></span> each of the attribute names in +<code class="literal">afters</code>. For example</p><pre><code class="programlisting nix">foo.bar = + { b = 0; } // lib.dag.entriesAfter "a" [ "b" ] [ 1 2 ]; +</code></pre><p>is equivalent to</p><pre><code class="programlisting nix">foo.bar = { + b = 0; + a-0 = lib.dag.entryAfter [ "b" ] 1; + a-1 = lib.dag.entryAfter [ "a-0" ] 2; +} +</code></pre> +</div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-types-dag-entriesBefore" class="title" style="clear: both">entriesBefore </h2> </div> </div></div><div class="blockquote"><blockquote class="blockquote"><p><code class="literal">lib.dag.entriesBefore (tag: string) (befores: list string) (values: [T]) : Dag<T></code></p></blockquote></div><p>Creates a DAG with the given values with each entry labeled using the given tag. +The list of values are placed <span class="emphasis"><em>before</em></span> each of the attribute names in <code class="literal">befores</code>. +For example</p><pre><code class="programlisting nix">foo.bar = + { b = 0; } // lib.dag.entriesBefore "a" [ "b" ] [ 1 2 ]; +</code></pre><p>is equivalent to</p><pre><code class="programlisting nix">foo.bar = { + b = 0; + a-0 = 1; + a-1 = lib.dag.entryBetween [ "b" ] [ "a-0" ] 2; +} +</code></pre> +</div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-types-dag-entriesBetween" class="title" style="clear: both">entriesBetween </h2> </div> </div></div><div class="blockquote"><blockquote class="blockquote"><p><code class="literal">lib.dag.entriesBetween (tag: string) (befores: list string) (afters: list string) (values: [T]) : Dag<T></code></p></blockquote></div><p>Creates a DAG with the given values with each entry labeled using the given tag. +The list of values are placed <span class="emphasis"><em>before</em></span> each of the attribute names in <code class="literal">befores</code> +and <span class="emphasis"><em>after</em></span> each of the attribute names in <code class="literal">afters</code>. For example</p><pre><code class="programlisting nix">foo.bar = + { b = 0; c = 3; } // lib.dag.entriesBetween "a" [ "b" ] [ "c" ] [ 1 2 ]; +</code></pre><p>is equivalent to</p><pre><code class="programlisting nix">foo.bar = { + b = 0; + c = 3; + a-0 = lib.dag.entryAfter [ "c" ] 1; + a-1 = lib.dag.entryBetween [ "b" ] [ "a-0" ] 2; +} +</code></pre> +</div> + +</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="ch-dag-entries" class="title" >DAG entries in nvf </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#ch-vim-luaconfigrc"><code class="literal">vim.luaConfigRC</code> (top-level DAG)</a> </span></dt> </dl></div><p>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:</p><div class="section"> <div class="titlepage"> <div> <div> <h2 id="ch-vim-luaconfigrc" class="title" style="clear: both"><code class="literal">vim.luaConfigRC</code> (top-level DAG) </h2> </div> </div></div><div class="orderedlist"><ol class="orderedlist compact" type="1"><li class="listitem"><p>(<code class="literal">luaConfigPre</code>) - not a part of the actual DAG, instead, it’s simply +inserted before the rest of the DAG</p></li><li class="listitem"><p><code class="literal">globalsScript</code> - used to set globals defined in <code class="literal">vim.globals</code></p></li><li class="listitem"><p><code class="literal">basic</code> - used to set basic configuration options</p></li><li class="listitem"><p><code class="literal">optionsScript</code> - used to set options defined in <code class="literal">vim.o</code></p></li><li class="listitem"><p><code class="literal">theme</code> (this is simply placed before <code class="literal">pluginConfigs</code> and <code class="literal">lazyConfigs</code>, +meaning that surrounding entries don’t depend on it) - used to set up the +theme, which has to be done before other plugins</p></li><li class="listitem"><p><code class="literal">lazyConfigs</code> - <code class="literal">lz.n</code> and <code class="literal">lzn-auto-require</code> configs. If <code class="literal">vim.lazy.enable</code> +is false, this will contain each plugin’s config instead.</p></li><li class="listitem"><p><code class="literal">pluginConfigs</code> - the result of the nested <code class="literal">vim.pluginRC</code> (internal option, +see the <a class="link" href="/index.xhtml#ch-custom-plugins" target="_top">Custom Plugins</a> page for adding your +own plugins) DAG, used to set up internal plugins</p></li><li class="listitem"><p><code class="literal">extraPluginConfigs</code> - the result of <code class="literal">vim.extraPlugins</code>, which is not a +direct DAG, but is converted to, and resolved as one internally</p></li><li class="listitem"><p><code class="literal">mappings</code> - the result of <code class="literal">vim.maps</code></p></li></ol></div> +</div> + +</div> +</div><div class="part"> <div class="titlepage"> <div> <div> <h1 id="ch-helpful-tips" class="title" >Helpful Tips </h1> </div> </div></div><div class="partintro"><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="chapter"> <a href="index.xhtml#sec-debugging-nvf">Debugging nvf</a> </span></dt><dt> <span class="chapter"> <a href="index.xhtml#sec-offline-documentation">Offline Documentation</a> </span></dt> </dl></div></div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="sec-debugging-nvf" class="title" >Debugging nvf </h2> </div> </div></div><p>There may be instances where the your Nix configuration evaluates to invalid +Lua, or times when you will be asked to provide your built Lua configuration for +easier debugging by nvf maintainers. nvf provides two helpful utilities out of +the box.</p><p><span class="strong"><strong>nvf-print-config</strong></span> and <span class="strong"><strong>nvf-print-config-path</strong></span> will be bundled with nvf as +lightweight utilities to help you view or share your built configuration when +necessary.</p><p>To view your configuration with syntax highlighting, you may use the +<a class="link" href="https://github.com/sharkdp/bat" target="_top">bat pager</a>.</p><pre><code class="programlisting bash">nvf-print-config | bat --language=lua +</code></pre><p>Alternatively, <code class="literal">cat</code> or <code class="literal">less</code> may also be used.</p> +</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="sec-offline-documentation" class="title" >Offline Documentation </h2> </div> </div></div><p>The manpages provided by nvf contains an offline version of the option search +normally available at <a class="link" href="https://notashelf.github.io/nvf/options.html" target="_top">https://notashelf.github.io/nvf/options.html</a>. You may +use the <code class="literal">man 5 nvf</code> command to view option documentation from the comfort of +your terminal.</p><p>Note that this is only available for NixOS and Home-Manager module +installations.</p> +</div> +</div><div class="chapter"> <div class="titlepage"> <div> <div> <h1 id="ch-hacking" class="title" >Hacking nvf </h1> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-contrib-getting-started">Getting Started</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines">Guidelines</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-documentation">Adding Documentation</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-formatting">Formatting Code</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-commit-message-style">Formatting Commits</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-commit-style">Commit Style</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-ex-commit-message">Example Commit</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-code-style">Code Style</a> </span></dt></dl></dd><dt> <span class="section"> <a href="index.xhtml#sec-testing-changes">Testing Changes</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-keybinds">Keybinds</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-custom-key-mappings">Custom Key Mappings Support for a Plugin</a> </span></dt></dl></dd><dt> <span class="section"> <a href="index.xhtml#sec-additional-plugins">Adding Plugins</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-modular-setup-options">Modular setup options</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-details-of-toluaobject">Details of toLuaObject</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-lazy-plugins">Lazy plugins</a> </span></dt></dl></dd> </dl></div><p>nvf is designed for the developer as much as it is designed for the end-user. We +would like for any contributor to be able to propagate their changes, or add new +features to the project with minimum possible friction. As such, below are the +guides and guidelines written to streamline the contribution process and to +ensure that your valuable input integrates into nvf’s development as seamlessly +as possible without leaving any question marks in your head.</p><p>This section is directed mainly towards those who wish to contribute code into +the project. If you instead wish to report a bug, or discuss a potential new +feature implementation (which you do not wish to implement yourself) first look +among the already <a class="link" href="https://github.com/notashelf/nvf/issues" target="_top">open issues</a> and if no matching issue exists you may open a +<a class="link" href="https://github.com/notashelf/nvf/issues/new" target="_top">new issue</a> and describe your problem/request.</p><p>While creating an issue, please try to include as much information as you can, +ideally also include relevant context in which an issue occurs or a feature +should be implemented. If you wish to make a contribution, but feel stuck - +please do not be afraid to submit a pull request, we will help you get it in.</p><div class="section"> <div class="titlepage"> <div> <div> <h1 id="sec-contrib-getting-started" class="title" style="clear: both">Getting Started </h1> </div> </div></div><p>You, naturally, would like to start by forking the repository to get started. If +you are new to Git and GitHub, do have a look at GitHub’s +<a class="link" href="https://help.github.com/articles/fork-a-repo/" target="_top">Fork a repo guide</a> for +instructions on how you can do this. Once you have a fork of <span class="strong"><strong>nvf</strong></span>, you should +create a separate branch based on the most recent <code class="literal">main</code> branch. Give your +branch a reasonably descriptive name (e.g. <code class="literal">feature/debugger</code> or +<code class="literal">fix/pesky-bug</code>) and you are ready to work on your changes</p><p>Implement your changes and commit them to the newly created branch and when you +are happy with the result, and positive that it fulfills our +<a class="link" href="index.xhtml#sec-guidelines" title="Guidelines" >Contributing Guidelines</a>, push the branch to GitHub and +<a class="link" href="https://help.github.com/articles/creating-a-pull-request" target="_top">create a pull request</a>. +The default pull request template available on the <span class="strong"><strong>nvf</strong></span> repository will guide +you through the rest of the process, and we’ll gently nudge you in the correct +direction if there are any mistakes.</p> +</div><div class="section"> <div class="titlepage"> <div> <div> <h1 id="sec-guidelines" class="title" style="clear: both">Guidelines </h1> </div> </div></div><div class="toc"> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-guidelines-documentation">Adding Documentation</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-formatting">Formatting Code</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-commit-message-style">Formatting Commits</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-commit-style">Commit Style</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-ex-commit-message">Example Commit</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-code-style">Code Style</a> </span></dt> </dl></div><p>If your contribution tightly follows the guidelines, then there is a good chance +it will be merged without too much trouble. Some of the guidelines will be +strictly enforced, others will remain as gentle nudges towards the correct +direction. As we have no automated system enforcing those guidelines, please try +to double check your changes before making your pull request in order to avoid +“faulty” code slipping by.</p><p>If you are uncertain how these rules affect the change you would like to make +then feel free to start a discussion in the +<a class="link" href="https://github.com/NotAShelf/nvf/discussions" target="_top">discussions tab</a> ideally (but not +necessarily) before you start developing.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-guidelines-documentation" class="title" style="clear: both">Adding Documentation </h2> </div> </div></div><p>Almost all changes warrant updates to the documentation: at the very least, you +must update the changelog. Both the manual and module options use +<a class="link" href="https://github.com/NixOS/nixpkgs/blob/master/doc/README.md#syntax" target="_top">Nixpkgs Flavoured Markdown</a>.</p><p>The HTML version of this manual containing both the module option descriptions +and the documentation of <span class="strong"><strong>nvf</strong></span> (such as this page) can be generated and opened +by typing the following in a shell within a clone of the <span class="strong"><strong>nvf</strong></span> Git repository:</p><pre><code class="programlisting console">$ nix build .#docs-html +$ xdg-open $PWD/result/share/doc/nvf/index.html +</code></pre> +</div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-guidelines-formatting" class="title" style="clear: both">Formatting Code </h2> </div> </div></div><p>Make sure your code is formatted as described in +<a class="link" href="index.xhtml#sec-guidelines-code-style" title="Code Style" >code-style section</a>. To maintain consistency +throughout the project you are encouraged to browse through existing code and +adopt its style also in new code.</p> +</div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-guidelines-commit-message-style" class="title" style="clear: both">Formatting Commits </h2> </div> </div></div><p>Similar to <a class="link" href="index.xhtml#sec-guidelines-code-style" title="Code Style" >code style guidelines</a> we encourage a +consistent commit message format as described in +<a class="link" href="index.xhtml#sec-guidelines-commit-style" title="Commit Style" >commit style guidelines</a>.</p> +</div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-guidelines-commit-style" class="title" style="clear: both">Commit Style </h2> </div> </div></div><p>The commits in your pull request should be reasonably self-contained. Which +means each and every commit in a pull request should make sense both on its own +and in general context. That is, a second commit should not resolve an issue +that is introduced in an earlier commit. In particular, you will be asked to +amend any commit that introduces syntax errors or similar problems even if they +are fixed in a later commit.</p><p>The commit messages should follow the +<a class="link" href="https://chris.beams.io/posts/git-commit/#seven-rule" target="_top">seven rules</a>, except for +“Capitalize the subject line”. We also ask you to include the affected code +component or module in the first line. A commit message ideally, but not +necessarily, follow the given template from home-manager’s own documentation</p><pre><code class="programlisting"> {component}: {description} + + {long description} +</code></pre><p>where <code class="literal">{component}</code> refers to the code component (or module) your change +affects, <code class="literal">{description}</code> is a very brief description of your change, and +<code class="literal">{long description}</code> is an optional clarifying description. As a rare exception, +if there is no clear component, or your change affects many components, then the +<code class="literal">{component}</code> part is optional. See +<a class="link" href="index.xhtml#sec-guidelines-ex-commit-message" title="Example Commit" >example commit message</a> for a commit message +that fulfills these requirements.</p> +</div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-guidelines-ex-commit-message" class="title" style="clear: both">Example Commit </h2> </div> </div></div><p>The commit +<a class="link" href="https://github.com/nix-community/home-manager/commit/69f8e47e9e74c8d3d060ca22e18246b7f7d988ef" target="_top">69f8e47e9e74c8d3d060ca22e18246b7f7d988ef</a> +in home-manager contains the following commit message.</p><pre><code class="programlisting">starship: allow running in Emacs if vterm is used + +The vterm buffer is backed by libvterm and can handle Starship prompts +without issues. +</code></pre><p>Similarly, if you are contributing to <span class="strong"><strong>nvf</strong></span>, you would include the scope of +the commit followed by the description:</p><pre><code class="programlisting">languages/ruby: init module + +Adds a language module for Ruby, adds appropriate formatters and Treesitter grammars +</code></pre><p>Long description can be omitted if the change is too simple to warrant it. A +minor fix in spelling or a formatting change does not warrant long description, +however, a module addition or removal does as you would like to provide the +relevant context, i.e. the reasoning behind it, for your commit.</p><p>Finally, when adding a new module, say <code class="literal">modules/foo.nix</code>, we use the fixed +commit format <code class="literal">foo: add module</code>. You can, of course, still include a long +description if you wish.</p><p>In case of nested modules, i.e <code class="literal">modules/languages/java.nix</code> you are recommended +to contain the parent as well - for example <code class="literal">languages/java: some major change</code>.</p> +</div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-guidelines-code-style" class="title" style="clear: both">Code Style </h2> </div> </div></div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-code-style-treewide" class="title" >Treewide </h3> </div> </div></div><p>Keep lines at a reasonable width, ideally 80 characters or less. This also +applies to string literals and module descriptions and documentation.</p> +</div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-code-style-nix" class="title" >Nix </h3> </div> </div></div><p><span class="strong"><strong>nvf</strong></span> is formatted by the <a class="link" href="https://github.com/kamadorueda/alejandra" target="_top">alejandra</a> tool and the formatting is checked in +the pull request and push workflows. Run the <code class="literal">nix fmt</code> command inside the +project repository before submitting your pull request.</p><p>While Alejandra is mostly opinionated on how code looks after formatting, +certain changes are done at the user’s discretion based on how the original code +was structured.</p><p>Please use one line code for attribute sets that contain only one subset. For +example:</p><pre><code class="programlisting nix"># parent modules should always be unfolded +# which means module = { value = ... } instead of module.value = { ... } +module = { + value = mkEnableOption "some description" // { default = true; }; # merges can be done inline where possible + + # same as parent modules, unfold submodules + subModule = { + # this is an option that contains more than one nested value + # Note: try to be careful about the ordering of `mkOption` arguments. + # General rule of thumb is to order from least to most likely to change. + # This is, for most cases, type < default < description. + # Example, if present, would be between default and description + someOtherValue = mkOption { + type = lib.types.bool; + default = true; + description = "Some other description"; + }; + }; +} +</code></pre><p>If you move a line down after the merge operator, Alejandra will automatically +unfold the whole merged attrset for you, which we <span class="strong"><strong>do not</strong></span> want.</p><pre><code class="programlisting nix">module = { + key = mkEnableOption "some description" // { + default = true; # we want this to be inline + }; # ... +} +</code></pre><p>For lists, it is mostly up to your own discretion how you want to format them, +but please try to unfold lists if they contain multiple items and especially if +they are to include comments.</p><pre><code class="programlisting nix"># this is ok +acceptableList = [ + item1 # comment + item2 + item3 # some other comment + item4 +]; + +# this is not ok +listToBeAvoided = [item1 item2 /* comment */ item3 item4]; + +# this is ok +acceptableList = [item1 item2]; + +# this is also ok if the list is expected to contain more elements +acceptableList= [ + item1 + item2 + # more items if needed... +]; +</code></pre> +</div> + +</div> + +</div><div class="section"> <div class="titlepage"> <div> <div> <h1 id="sec-testing-changes" class="title" style="clear: both">Testing Changes </h1> </div> </div></div><p>Once you have made your changes, you will need to test them thoroughly. If it is +a module, add your module option to <code class="literal">configuration.nix</code> (located in the root of +this project) inside <code class="literal">neovimConfiguration</code>. Enable it, and then run the maximal +configuration with <code class="literal">nix run .#maximal -Lv</code> to check for build errors. If neovim +opens in the current directory without any error messages (you can check the +output of <code class="literal">:messages</code> inside neovim to see if there are any errors), then your +changes are good to go. Open your pull request, and it will be reviewed as soon +as possible.</p><p>If it is not a new module, but a change to an existing one, then make sure the +module you have changed is enabled in the maximal configuration by editing +<code class="literal">configuration.nix</code>, and then run it with <code class="literal">nix run .#maximal -Lv</code>. Same +procedure as adding a new module will apply here.</p> +</div><div class="section"> <div class="titlepage"> <div> <div> <h1 id="sec-keybinds" class="title" style="clear: both">Keybinds </h1> </div> </div></div><div class="toc"> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-custom-key-mappings">Custom Key Mappings Support for a Plugin</a> </span></dt> </dl></div><p>As of 0.4, there exists an API for writing your own keybinds and a couple of +useful utility functions are available in the +<a class="link" href="https://github.com/NotAShelf/nvf/tree/main/lib" target="_top">extended standard library</a>. The +following section contains a general overview to how you may utilize said +functions.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-custom-key-mappings" class="title" style="clear: both">Custom Key Mappings Support for a Plugin </h2> </div> </div></div><p>To set a mapping, you should define it in <code class="literal">vim.keymaps</code>.</p><p>An example, simple keybinding, can look like this:</p><pre><code class="programlisting nix">{ + vim.keymaps = [ + { + key = "<leader>wq"; + mode = ["n"]; + action = ":wq<CR>"; + silent = true; + desc = "Save file and quit"; + } + ]; +} +</code></pre><p>There are many settings available in the options. Please refer to the +<a class="link" href="https://notashelf.github.io/nvf/options.html#opt-vim.keymaps" target="_top">documentation</a> to +see a list of them.</p><p><span class="strong"><strong>nvf</strong></span> provides a helper function, so that you don’t have to write the +mapping attribute sets every time:</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p><code class="literal">mkKeymap</code>, which mimics neovim’s <code class="literal">vim.keymap.set</code> function</p></li></ul></div><p>You can read the source code of some modules to see them in action, but the +usage should look something like this:</p><pre><code class="programlisting nix"># plugindefinition.nix +{lib, ...}: let + inherit (lib.options) mkEnableOption; + inherit (lib.nvim.binds) mkMappingOption; +in { + options.vim.plugin = { + enable = mkEnableOption "Enable plugin"; + + # Mappings should always be inside an attrset called mappings + mappings = { + workspaceDiagnostics = mkMappingOption "Workspace diagnostics [trouble]" "<leader>lwd"; + documentDiagnostics = mkMappingOption "Document diagnostics [trouble]" "<leader>ld"; + lspReferences = mkMappingOption "LSP References [trouble]" "<leader>lr"; + quickfix = mkMappingOption "QuickFix [trouble]" "<leader>xq"; + locList = mkMappingOption "LOCList [trouble]" "<leader>xl"; + symbols = mkMappingOption "Symbols [trouble]" "<leader>xs"; + }; +} +</code></pre><pre><code class="programlisting nix"># config.nix +{ + config, + lib, + options, + ... +}: let + inherit (lib.modules) mkIf; + inherit (lib.nvim.binds) mkKeymap; + + cfg = config.vim.plugin; + + keys = cfg.mappings; + inherit (options.vim.lsp.trouble) mappings; +in { + config = mkIf cfg.enable { + vim.keymaps = [ + (mkKeymap "n" keys.workspaceDiagnostics "<cmd>Trouble toggle diagnostics<CR>" {desc = mappings.workspaceDiagnostics.description;}) + (mkKeymap "n" keys.documentDiagnostics "<cmd>Trouble toggle diagnostics filter.buf=0<CR>" {desc = mappings.documentDiagnostics.description;}) + (mkKeymap "n" keys.lspReferences "<cmd>Trouble toggle lsp_references<CR>" {desc = mappings.lspReferences.description;}) + (mkKeymap "n" keys.quickfix "<cmd>Trouble toggle quickfix<CR>" {desc = mappings.quickfix.description;}) + (mkKeymap "n" keys.locList "<cmd>Trouble toggle loclist<CR>" {desc = mappings.locList.description;}) + (mkKeymap "n" keys.symbols "<cmd>Trouble toggle symbols<CR>" {desc = mappings.symbols.description;}) + ]; + }; +} +</code></pre><div class="note"><h3 class="title">Note</h3><p>If you have come across a plugin that has an API that doesn’t seem to easily +allow custom keybindings, don’t be scared to implement a draft PR. We’ll help +you get it done.</p></div> +</div> + +</div><div class="section"> <div class="titlepage"> <div> <div> <h1 id="sec-additional-plugins" class="title" style="clear: both">Adding Plugins </h1> </div> </div></div><div class="toc"> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-modular-setup-options">Modular setup options</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-details-of-toluaobject">Details of toLuaObject</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-lazy-plugins">Lazy plugins</a> </span></dt> </dl></div><p>To add a new Neovim plugin, first add the source url in the inputs section of +<code class="literal">flake.nix</code> with the prefix <code class="literal">plugin-</code></p><pre><code class="programlisting nix">{ + inputs = { + # ... + plugin-neodev-nvim = { + url = "github:folke/neodev.nvim"; + flake = false; + }; + # ... + }; +} +</code></pre><p>Prepending <code class="literal">plugin-</code> to the name of the input will allow nvf to automatically +discover inputs that are marked as plugins, and make them available in +<code class="literal">vim.startPlugins</code> or other areas that require a very specific plugin type as it +is defined in <code class="literal">https://github.com/notashelf/nvf/blob/v0.8/lib/types/plugins.nix</code></p><p>The addition of the <code class="literal">plugin-</code> prefix will allow <span class="strong"><strong>nvf</strong></span> to autodiscover the +input from the flake inputs automatically, allowing you to refer to it in areas +that require a very specific plugin type as defined in <code class="literal">lib/types/plugins.nix</code></p><p>You can now reference this plugin using its string name, the plugin will be +built with the name and source URL from the flake input, allowing you to refer +to it as a <span class="strong"><strong>string</strong></span>.</p><pre><code class="programlisting nix">config.vim.startPlugins = ["neodev-nvim"]; +</code></pre><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-modular-setup-options" class="title" style="clear: both">Modular setup options </h2> </div> </div></div><p>Most plugins is initialized with a call to <code class="literal">require('plugin').setup({...})</code>.</p><p>We use a special function that lets you easily add support for such setup +options in a modular way: <code class="literal">mkPluginSetupOption</code>.</p><p>Once you have added the source of the plugin as shown above, you can define the +setup options like this:</p><pre><code class="programlisting nix"># in modules/.../your-plugin/your-plugin.nix + +{lib, ...}: +let + inherit (lib.types) bool int; + inherit (lib.nvim.types) mkPluginSetupOption; +in { + options.vim.your-plugin = { + setupOpts = mkPluginSetupOption "plugin name" { + enable_feature_a = mkOption { + type = bool; + default = false; + # ... + }; + + number_option = mkOption { + type = int; + default = 3; + # ... + }; + }; + }; +} +</code></pre><pre><code class="programlisting nix"># in modules/.../your-plugin/config.nix +{lib, config, ...}: +let + cfg = config.vim.your-plugin; +in { + vim.luaConfigRC = lib.nvim.dag.entryAnywhere '' + require('plugin-name').setup(${lib.nvim.lua.toLuaObject cfg.setupOpts}) + ''; +} +</code></pre><p>This above config will result in this lua script:</p><pre><code class="programlisting lua">require('plugin-name').setup({ + enable_feature_a = false, + number_option = 3, +}) +</code></pre><p>Now users can set any of the pre-defined option field, and can also add their +own fields!</p><pre><code class="programlisting nix"># in user's config +{ + vim.your-plugin.setupOpts = { + enable_feature_a = true; + number_option = 4; + another_field = "hello"; + size = { # nested fields work as well + top = 10; + }; + }; +} +</code></pre> +</div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-details-of-toluaobject" class="title" style="clear: both">Details of toLuaObject </h2> </div> </div></div><p>As you’ve seen above, <code class="literal">toLuaObject</code> is used to convert our nix attrSet +<code class="literal">cfg.setupOpts</code>, into a lua table. Here are some rules of the conversion:</p><div class="orderedlist"><ol class="orderedlist compact" type="1"><li class="listitem"><p>nix <code class="literal">null</code> converts to lua <code class="literal">nil</code></p></li><li class="listitem"><p>number and strings convert to their lua counterparts</p></li><li class="listitem"><p>nix attrSet/list convert into lua tables</p></li><li class="listitem"><p>you can write raw lua code using <code class="literal">lib.generators.mkLuaInline</code>. This function +is part of nixpkgs.</p></li></ol></div><p>Example:</p><pre><code class="programlisting nix">vim.your-plugin.setupOpts = { + on_init = lib.generators.mkLuaInline '' + function() + print('we can write lua!') + end + ''; +} +</code></pre> +</div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-lazy-plugins" class="title" style="clear: both">Lazy plugins </h2> </div> </div></div><p>If the plugin can be lazy-loaded, <code class="literal">vim.lazy.plugins</code> should be used to add it. +Lazy plugins are managed by <code class="literal">lz.n</code>.</p><pre><code class="programlisting nix"># in modules/.../your-plugin/config.nix +{lib, config, ...}: +let + cfg = config.vim.your-plugin; +in { + vim.lazy.plugins.your-plugin = { + # instead of vim.startPlugins, use this: + package = "your-plugin"; + + # if your plugin uses the `require('your-plugin').setup{...}` pattern + setupModule = "your-plugin"; + inherit (cfg) setupOpts; + + # events that trigger this plugin to be loaded + event = ["DirChanged"]; + cmd = ["YourPluginCommand"]; + + # keymaps + keys = [ + # we'll cover this in detail in the keymaps section + { + key = "<leader>d"; + mode = "n"; + action = ":YourPluginCommand"; + } + ]; + }; +; +} +</code></pre><p>This results in the following lua code:</p><pre><code class="programlisting lua">require('lz.n').load({ + { + "name-of-your-plugin", + after = function() + require('your-plugin').setup({--[[ your setupOpts ]]}) + end, + + event = {"DirChanged"}, + cmd = {"YourPluginCommand"}, + keys = { + {"<leader>d", ":YourPluginCommand", mode = {"n"}}, + }, + } +}) +</code></pre><p>A full list of options can be found +[here](https://notashelf.github.io/nvf/options.html#opt-vim.lazy.plugins</p> +</div> + +</div> +</div> + </div> + <div class="navfooter"> + <hr /> + <table width="100%" summary="Navigation footer"> + <tr> + <td width="40%" align="left"> </td> + <td width="20%" align="center"> </td> + <td width="40%" align="right"> <a accesskey="n" href="quirks.html">Next</a></td> + </tr> + <tr> + <td width="40%" align="left" valign="top"> </td> + <td width="20%" align="center"> </td> + <td width="40%" align="right" valign="top"> Appendix A. Known Issues and Quirks</td> + </tr> + </table> + </div> + </body> +</html> \ No newline at end of file diff --git a/docs-preview-569/options.html b/docs-preview-569/options.html new file mode 100644 index 000000000..60b69c59e --- /dev/null +++ b/docs-preview-569/options.html @@ -0,0 +1,42661 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + <title>Appendix B. Neovim Flake Configuration Options</title> +<link rel="stylesheet" type="text/css" href="style.css" /> +<script src="highlightjs/highlight.pack.js" type="text/javascript"></script><script src="highlightjs/loader.js" type="text/javascript"></script><script src="script/anchor-use.js" type="text/javascript"></script><script src="script/anchor-min.js" type="text/javascript"></script><script src="script/search.js" type="text/javascript"></script> + <meta name="generator" content="nixos-render-docs" /> + <link rel="home" href="index.xhtml" title="nvf manual" /> + <link rel="up" href="index.xhtml" title="nvf manual" /><link rel="prev" href="quirks.html" title="Appendix A. Known Issues and Quirks" /><link rel="next" href="release-notes.html" title="Appendix C. Release Notes" /> + </head> + <body> + <div class="navheader"> + <table width="100%" summary="Navigation header"> + <tr> + <th colspan="3" align="center">Appendix B. Neovim Flake Configuration Options</th> + </tr> + <tr> + <td width="20%" align="left"><a accesskey="p" href="quirks.html">Prev</a> </td> + <th width="60%" align="center"> </th> + <td width="20%" align="right"> <a accesskey="n" href="release-notes.html">Next</a></td> + </tr> + </table> + <hr /> + </div><div class="appendix"> <div class="titlepage"> <div> <div> <h1 id="ch-options" class="title" >Appendix B. Neovim Flake Configuration Options </h1> </div> </div></div><p>Below are the module options provided by nvf, in no particular order. Most +options will include useful comments, warnings or setup tips on how a module +option is meant to be used as well as examples in complex cases.</p><div class="variablelist"> +<a id="nvf-options"></a> + <dl class="variablelist"> +<dt> + <span class="term"> + <a id="opt-_module.args"></a><a class="term" href="options.html#opt-_module.args"><code class="option">_module.args</code> + </a> + </span> +</dt> +<dd> +<p>Additional arguments passed to each module in addition to ones +like <code class="literal">lib</code>, <code class="literal">config</code>, +and <code class="literal">pkgs</code>, <code class="literal">modulesPath</code>.</p><p>This option is also available to all submodules. Submodules do not +inherit args from their parent module, nor do they provide args to +their parent module or sibling submodules. The sole exception to +this is the argument <code class="literal">name</code> which is provided by +parent modules to a submodule and contains the attribute name +the submodule is bound to, or a unique generated name if it is +not bound to an attribute.</p><p>Some arguments are already passed by default, of which the +following <span class="emphasis"><em>cannot</em></span> be changed with this option:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p><code class="varname">lib</code>: The nixpkgs library.</p></li><li class="listitem"><p><code class="varname">config</code>: The results of all options after merging the values from all modules together.</p></li><li class="listitem"><p><code class="varname">options</code>: The options declared in all modules.</p></li><li class="listitem"><p><code class="varname">specialArgs</code>: The <code class="literal">specialArgs</code> argument passed to <code class="literal">evalModules</code>.</p></li><li class="listitem"><p>All attributes of <code class="varname">specialArgs</code></p><p>Whereas option values can generally depend on other option values +thanks to laziness, this does not apply to <code class="literal">imports</code>, which +must be computed statically before anything else.</p><p>For this reason, callers of the module system can provide <code class="literal">specialArgs</code> +which are available during import resolution.</p><p>For NixOS, <code class="literal">specialArgs</code> includes +<code class="varname">modulesPath</code>, which allows you to import +extra modules from the nixpkgs package tree without having to +somehow make the module aware of the location of the +<code class="literal">nixpkgs</code> or NixOS directories.</p><pre><code class="programlisting">{ modulesPath, ... }: { + imports = [ + (modulesPath + "/profiles/minimal.nix") + ]; +} +</code></pre></li></ul></div><p>For NixOS, the default value for this option includes at least this argument:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p><code class="varname">pkgs</code>: The nixpkgs package set according to +the <code class="option">nixpkgs.pkgs</code> option.</p></li></ul></div> + +<p><span class="emphasis"><em>Type:</em></span> +lazy attribute set of raw value</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/NixOS/nixpkgs/blob/master/lib/modules.nix" target="_top"> +<nixpkgs/lib/modules.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <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> + </span> +</dt> +<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 +take a look at the <code class="option">[official documentation]</code>. This option may be enabled by +default in the future.</p></div> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/wrapper/rc/options.nix" target="_top"> +<nvf/modules/wrapper/rc/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.package"></a><a class="term" href="options.html#opt-vim.package"><code class="option">vim.package</code> + </a> + </span> +</dt> +<dd> +<p>The neovim package to use for the wrapper. This +corresponds to the package that will be wrapped +with your plugins and settings.</p><div class="warning"><h3 class="title">Warning</h3><p>You will need to use an unwrapped package for this +option to work as intended. Using an already wrapped +package here may yield undesirable results.</p></div> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation neovim-unwrapped-0.10.3></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/environment/options.nix" target="_top"> +<nvf/modules/wrapper/environment/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.additionalRuntimePaths"></a><a class="term" href="options.html#opt-vim.additionalRuntimePaths"><code class="option">vim.additionalRuntimePaths</code> + </a> + </span> +</dt> +<dd> +<p>Additional runtime paths that will be appended to the +active runtimepath of the Neovim. This can be used to +add additional lookup paths for configs, plugins, spell +languages and other things you would generally place in +your <code class="filename">$HOME/.config/nvim</code>.</p><p>This is meant as a declarative alternative to throwing +files into <code class="filename">~/.config/nvim</code> and having the Neovim +wrapper pick them up. For more details on +<code class="literal">vim.o.runtimepath</code>, and what paths to use; please see +<a class="link" href="https://neovim.io/doc/user/options.html#'runtimepath'" target="_top">the official documentation</a></p> + +<p><span class="emphasis"><em>Type:</em></span> +list of (path or string)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</code></p> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">[ + # absolute path, as a string - impure + "$HOME/.config/nvim-extra" + + # relative path, as a path - pure + ./nvim + + # source type path - pure and reproducible + (builtins.source { + path = ./runtime; + name = "nvim-runtime"; + }) +] + +</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"> +<nvf/modules/wrapper/rc/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.chatgpt.enable"></a><a class="term" href="options.html#opt-vim.assistant.chatgpt.enable"><code class="option">vim.assistant.chatgpt.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable ChatGPT AI assistant. Requires the environment variable OPENAI_API_KEY to be set.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/assistant/chatgpt/chatgpt.nix" target="_top"> +<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.chatgpt.mappings.addTests"></a><a class="term" href="options.html#opt-vim.assistant.chatgpt.mappings.addTests"><code class="option">vim.assistant.chatgpt.mappings.addTests</code> + </a> + </span> +</dt> +<dd> +<p>[ChatGPT] Add tests</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>aa"</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/plugins/assistant/chatgpt/chatgpt.nix" target="_top"> +<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.chatgpt.mappings.chatGpt"></a><a class="term" href="options.html#opt-vim.assistant.chatgpt.mappings.chatGpt"><code class="option">vim.assistant.chatgpt.mappings.chatGpt</code> + </a> + </span> +</dt> +<dd> +<p>ChatGPT</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>ac"</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/plugins/assistant/chatgpt/chatgpt.nix" target="_top"> +<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.chatgpt.mappings.docstring"></a><a class="term" href="options.html#opt-vim.assistant.chatgpt.mappings.docstring"><code class="option">vim.assistant.chatgpt.mappings.docstring</code> + </a> + </span> +</dt> +<dd> +<p>[ChatGPT] Docstring</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>ad"</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/plugins/assistant/chatgpt/chatgpt.nix" target="_top"> +<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.chatgpt.mappings.editWithInstructions"></a><a class="term" href="options.html#opt-vim.assistant.chatgpt.mappings.editWithInstructions"><code class="option">vim.assistant.chatgpt.mappings.editWithInstructions</code> + </a> + </span> +</dt> +<dd> +<p>[ChatGPT] Edit with instructions</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>ae"</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/plugins/assistant/chatgpt/chatgpt.nix" target="_top"> +<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.chatgpt.mappings.explain"></a><a class="term" href="options.html#opt-vim.assistant.chatgpt.mappings.explain"><code class="option">vim.assistant.chatgpt.mappings.explain</code> + </a> + </span> +</dt> +<dd> +<p>[ChatGPT] Explain code</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>ax"</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/plugins/assistant/chatgpt/chatgpt.nix" target="_top"> +<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.chatgpt.mappings.fixBugs"></a><a class="term" href="options.html#opt-vim.assistant.chatgpt.mappings.fixBugs"><code class="option">vim.assistant.chatgpt.mappings.fixBugs</code> + </a> + </span> +</dt> +<dd> +<p>[ChatGPT] Fix bugs</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>af"</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/plugins/assistant/chatgpt/chatgpt.nix" target="_top"> +<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.chatgpt.mappings.grammarCorrection"></a><a class="term" href="options.html#opt-vim.assistant.chatgpt.mappings.grammarCorrection"><code class="option">vim.assistant.chatgpt.mappings.grammarCorrection</code> + </a> + </span> +</dt> +<dd> +<p>[ChatGPT] Grammar correction</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>ag"</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/plugins/assistant/chatgpt/chatgpt.nix" target="_top"> +<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.chatgpt.mappings.keyword"></a><a class="term" href="options.html#opt-vim.assistant.chatgpt.mappings.keyword"><code class="option">vim.assistant.chatgpt.mappings.keyword</code> + </a> + </span> +</dt> +<dd> +<p>[ChatGPT] Keywords</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>ak"</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/plugins/assistant/chatgpt/chatgpt.nix" target="_top"> +<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.chatgpt.mappings.optimize"></a><a class="term" href="options.html#opt-vim.assistant.chatgpt.mappings.optimize"><code class="option">vim.assistant.chatgpt.mappings.optimize</code> + </a> + </span> +</dt> +<dd> +<p>[ChatGPT] Optimize code</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>ao"</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/plugins/assistant/chatgpt/chatgpt.nix" target="_top"> +<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.chatgpt.mappings.readabilityanalysis"></a><a class="term" href="options.html#opt-vim.assistant.chatgpt.mappings.readabilityanalysis"><code class="option">vim.assistant.chatgpt.mappings.readabilityanalysis</code> + </a> + </span> +</dt> +<dd> +<p>[ChatGPT] Code reability analysis</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>al"</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/plugins/assistant/chatgpt/chatgpt.nix" target="_top"> +<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.chatgpt.mappings.roxygenEdit"></a><a class="term" href="options.html#opt-vim.assistant.chatgpt.mappings.roxygenEdit"><code class="option">vim.assistant.chatgpt.mappings.roxygenEdit</code> + </a> + </span> +</dt> +<dd> +<p>[ChatGPT] Roxygen edit</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>ar"</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/plugins/assistant/chatgpt/chatgpt.nix" target="_top"> +<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.chatgpt.mappings.summarize"></a><a class="term" href="options.html#opt-vim.assistant.chatgpt.mappings.summarize"><code class="option">vim.assistant.chatgpt.mappings.summarize</code> + </a> + </span> +</dt> +<dd> +<p>[ChatGPT] Summarize</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>as"</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/plugins/assistant/chatgpt/chatgpt.nix" target="_top"> +<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.chatgpt.mappings.translate"></a><a class="term" href="options.html#opt-vim.assistant.chatgpt.mappings.translate"><code class="option">vim.assistant.chatgpt.mappings.translate</code> + </a> + </span> +</dt> +<dd> +<p>[ChatGPT] Translate</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>at"</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/plugins/assistant/chatgpt/chatgpt.nix" target="_top"> +<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.chatgpt.setupOpts"></a><a class="term" href="options.html#opt-vim.assistant.chatgpt.setupOpts"><code class="option">vim.assistant.chatgpt.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of chatgpt</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/assistant/chatgpt/chatgpt.nix" target="_top"> +<nvf/modules/plugins/assistant/chatgpt/chatgpt.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.copilot.enable"></a><a class="term" href="options.html#opt-vim.assistant.copilot.enable"><code class="option">vim.assistant.copilot.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable GitHub Copilot AI assistant.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/assistant/copilot/copilot.nix" target="_top"> +<nvf/modules/plugins/assistant/copilot/copilot.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.copilot.cmp.enable"></a><a class="term" href="options.html#opt-vim.assistant.copilot.cmp.enable"><code class="option">vim.assistant.copilot.cmp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable nvim-cmp integration for GitHub Copilot.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/assistant/copilot/copilot.nix" target="_top"> +<nvf/modules/plugins/assistant/copilot/copilot.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.copilot.mappings.panel.accept"></a><a class="term" href="options.html#opt-vim.assistant.copilot.mappings.panel.accept"><code class="option">vim.assistant.copilot.mappings.panel.accept</code> + </a> + </span> +</dt> +<dd> +<p>Accept suggestion</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<CR>"</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/plugins/assistant/copilot/copilot.nix" target="_top"> +<nvf/modules/plugins/assistant/copilot/copilot.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.copilot.mappings.panel.jumpNext"></a><a class="term" href="options.html#opt-vim.assistant.copilot.mappings.panel.jumpNext"><code class="option">vim.assistant.copilot.mappings.panel.jumpNext</code> + </a> + </span> +</dt> +<dd> +<p>Jump to next suggestion</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"]]"</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/plugins/assistant/copilot/copilot.nix" target="_top"> +<nvf/modules/plugins/assistant/copilot/copilot.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.copilot.mappings.panel.jumpPrev"></a><a class="term" href="options.html#opt-vim.assistant.copilot.mappings.panel.jumpPrev"><code class="option">vim.assistant.copilot.mappings.panel.jumpPrev</code> + </a> + </span> +</dt> +<dd> +<p>Jump to previous suggestion</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"[["</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/plugins/assistant/copilot/copilot.nix" target="_top"> +<nvf/modules/plugins/assistant/copilot/copilot.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.copilot.mappings.panel.open"></a><a class="term" href="options.html#opt-vim.assistant.copilot.mappings.panel.open"><code class="option">vim.assistant.copilot.mappings.panel.open</code> + </a> + </span> +</dt> +<dd> +<p>Open suggestions</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<M-CR>"</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/plugins/assistant/copilot/copilot.nix" target="_top"> +<nvf/modules/plugins/assistant/copilot/copilot.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.copilot.mappings.panel.refresh"></a><a class="term" href="options.html#opt-vim.assistant.copilot.mappings.panel.refresh"><code class="option">vim.assistant.copilot.mappings.panel.refresh</code> + </a> + </span> +</dt> +<dd> +<p>Refresh suggestions</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"gr"</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/plugins/assistant/copilot/copilot.nix" target="_top"> +<nvf/modules/plugins/assistant/copilot/copilot.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.copilot.mappings.suggestion.accept"></a><a class="term" href="options.html#opt-vim.assistant.copilot.mappings.suggestion.accept"><code class="option">vim.assistant.copilot.mappings.suggestion.accept</code> + </a> + </span> +</dt> +<dd> +<p>Accept suggetion</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<M-l>"</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/plugins/assistant/copilot/copilot.nix" target="_top"> +<nvf/modules/plugins/assistant/copilot/copilot.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.copilot.mappings.suggestion.acceptLine"></a><a class="term" href="options.html#opt-vim.assistant.copilot.mappings.suggestion.acceptLine"><code class="option">vim.assistant.copilot.mappings.suggestion.acceptLine</code> + </a> + </span> +</dt> +<dd> +<p>Accept next line</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/assistant/copilot/copilot.nix" target="_top"> +<nvf/modules/plugins/assistant/copilot/copilot.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.copilot.mappings.suggestion.acceptWord"></a><a class="term" href="options.html#opt-vim.assistant.copilot.mappings.suggestion.acceptWord"><code class="option">vim.assistant.copilot.mappings.suggestion.acceptWord</code> + </a> + </span> +</dt> +<dd> +<p>Accept next word</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/assistant/copilot/copilot.nix" target="_top"> +<nvf/modules/plugins/assistant/copilot/copilot.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.copilot.mappings.suggestion.dismiss"></a><a class="term" href="options.html#opt-vim.assistant.copilot.mappings.suggestion.dismiss"><code class="option">vim.assistant.copilot.mappings.suggestion.dismiss</code> + </a> + </span> +</dt> +<dd> +<p>Dismiss suggestion</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<C-]>"</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/plugins/assistant/copilot/copilot.nix" target="_top"> +<nvf/modules/plugins/assistant/copilot/copilot.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.copilot.mappings.suggestion.next"></a><a class="term" href="options.html#opt-vim.assistant.copilot.mappings.suggestion.next"><code class="option">vim.assistant.copilot.mappings.suggestion.next</code> + </a> + </span> +</dt> +<dd> +<p>Next suggestion</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<M-]>"</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/plugins/assistant/copilot/copilot.nix" target="_top"> +<nvf/modules/plugins/assistant/copilot/copilot.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.copilot.mappings.suggestion.prev"></a><a class="term" href="options.html#opt-vim.assistant.copilot.mappings.suggestion.prev"><code class="option">vim.assistant.copilot.mappings.suggestion.prev</code> + </a> + </span> +</dt> +<dd> +<p>Previous suggestion</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<M-[>"</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/plugins/assistant/copilot/copilot.nix" target="_top"> +<nvf/modules/plugins/assistant/copilot/copilot.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.copilot.setupOpts"></a><a class="term" href="options.html#opt-vim.assistant.copilot.setupOpts"><code class="option">vim.assistant.copilot.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of Copilot</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/assistant/copilot/copilot.nix" target="_top"> +<nvf/modules/plugins/assistant/copilot/copilot.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.copilot.setupOpts.copilot_node_command"></a><a class="term" href="options.html#opt-vim.assistant.copilot.setupOpts.copilot_node_command"><code class="option">vim.assistant.copilot.setupOpts.copilot_node_command</code> + </a> + </span> +</dt> +<dd> +<p>The command that will be executed to initiate nodejs for GitHub Copilot. +Recommended to leave as default.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"\${pkgs.nodejs-slim.out}/bin/node"</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/plugins/assistant/copilot/copilot.nix" target="_top"> +<nvf/modules/plugins/assistant/copilot/copilot.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.copilot.setupOpts.panel.enabled"></a><a class="term" href="options.html#opt-vim.assistant.copilot.setupOpts.panel.enabled"><code class="option">vim.assistant.copilot.setupOpts.panel.enabled</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Completion Panel.</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>Example:</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/plugins/assistant/copilot/copilot.nix" target="_top"> +<nvf/modules/plugins/assistant/copilot/copilot.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.copilot.setupOpts.panel.layout.position"></a><a class="term" href="options.html#opt-vim.assistant.copilot.setupOpts.panel.layout.position"><code class="option">vim.assistant.copilot.setupOpts.panel.layout.position</code> + </a> + </span> +</dt> +<dd> +<p>Panel position</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “bottom”, “top”, “left”, “right”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"bottom"</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/plugins/assistant/copilot/copilot.nix" target="_top"> +<nvf/modules/plugins/assistant/copilot/copilot.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.copilot.setupOpts.panel.layout.ratio"></a><a class="term" href="options.html#opt-vim.assistant.copilot.setupOpts.panel.layout.ratio"><code class="option">vim.assistant.copilot.setupOpts.panel.layout.ratio</code> + </a> + </span> +</dt> +<dd> +<p>Panel size</p> + +<p><span class="emphasis"><em>Type:</em></span> +floating point number</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">0.4</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/plugins/assistant/copilot/copilot.nix" target="_top"> +<nvf/modules/plugins/assistant/copilot/copilot.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.assistant.copilot.setupOpts.suggestion.enabled"></a><a class="term" href="options.html#opt-vim.assistant.copilot.setupOpts.suggestion.enabled"><code class="option">vim.assistant.copilot.setupOpts.suggestion.enabled</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Suggestions.</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>Example:</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/plugins/assistant/copilot/copilot.nix" target="_top"> +<nvf/modules/plugins/assistant/copilot/copilot.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.autocomplete.nvim-cmp.enable"></a><a class="term" href="options.html#opt-vim.autocomplete.nvim-cmp.enable"><code class="option">vim.autocomplete.nvim-cmp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable nvim-cmp.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/completion/nvim-cmp/nvim-cmp.nix" target="_top"> +<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.autocomplete.nvim-cmp.format"></a><a class="term" href="options.html#opt-vim.autocomplete.nvim-cmp.format"><code class="option">vim.autocomplete.nvim-cmp.format</code> + </a> + </span> +</dt> +<dd> +<p>The function used to customize the completion menu entries. This is +outside of <code class="literal">setupOpts</code> to allow for an easier integration with +lspkind.nvim.</p><p>See <code class="literal">:help cmp-config.formatting.format</code>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or (luaInline)</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting lua">function(entry, vim_item) + vim_item.menu = (${toLuaObject config.vim.autocomplete.nvim-cmp.sources})[entry.source.name] + return vim_item +end +</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/plugins/completion/nvim-cmp/nvim-cmp.nix" target="_top"> +<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.autocomplete.nvim-cmp.mappings.close"></a><a class="term" href="options.html#opt-vim.autocomplete.nvim-cmp.mappings.close"><code class="option">vim.autocomplete.nvim-cmp.mappings.close</code> + </a> + </span> +</dt> +<dd> +<p>Close [nvim-cmp]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<C-e>"</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/plugins/completion/nvim-cmp/nvim-cmp.nix" target="_top"> +<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.autocomplete.nvim-cmp.mappings.complete"></a><a class="term" href="options.html#opt-vim.autocomplete.nvim-cmp.mappings.complete"><code class="option">vim.autocomplete.nvim-cmp.mappings.complete</code> + </a> + </span> +</dt> +<dd> +<p>Complete [nvim-cmp]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<C-Space>"</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/plugins/completion/nvim-cmp/nvim-cmp.nix" target="_top"> +<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.autocomplete.nvim-cmp.mappings.confirm"></a><a class="term" href="options.html#opt-vim.autocomplete.nvim-cmp.mappings.confirm"><code class="option">vim.autocomplete.nvim-cmp.mappings.confirm</code> + </a> + </span> +</dt> +<dd> +<p>Confirm [nvim-cmp]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<CR>"</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/plugins/completion/nvim-cmp/nvim-cmp.nix" target="_top"> +<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.autocomplete.nvim-cmp.mappings.next"></a><a class="term" href="options.html#opt-vim.autocomplete.nvim-cmp.mappings.next"><code class="option">vim.autocomplete.nvim-cmp.mappings.next</code> + </a> + </span> +</dt> +<dd> +<p>Next item [nvim-cmp]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<Tab>"</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/plugins/completion/nvim-cmp/nvim-cmp.nix" target="_top"> +<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.autocomplete.nvim-cmp.mappings.previous"></a><a class="term" href="options.html#opt-vim.autocomplete.nvim-cmp.mappings.previous"><code class="option">vim.autocomplete.nvim-cmp.mappings.previous</code> + </a> + </span> +</dt> +<dd> +<p>Previous item [nvim-cmp]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<S-Tab>"</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/plugins/completion/nvim-cmp/nvim-cmp.nix" target="_top"> +<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.autocomplete.nvim-cmp.mappings.scrollDocsDown"></a><a class="term" href="options.html#opt-vim.autocomplete.nvim-cmp.mappings.scrollDocsDown"><code class="option">vim.autocomplete.nvim-cmp.mappings.scrollDocsDown</code> + </a> + </span> +</dt> +<dd> +<p>Scroll docs down [nvim-cmp]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<C-f>"</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/plugins/completion/nvim-cmp/nvim-cmp.nix" target="_top"> +<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.autocomplete.nvim-cmp.mappings.scrollDocsUp"></a><a class="term" href="options.html#opt-vim.autocomplete.nvim-cmp.mappings.scrollDocsUp"><code class="option">vim.autocomplete.nvim-cmp.mappings.scrollDocsUp</code> + </a> + </span> +</dt> +<dd> +<p>Scroll docs up [nvim-cmp]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<C-d>"</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/plugins/completion/nvim-cmp/nvim-cmp.nix" target="_top"> +<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.autocomplete.nvim-cmp.setupOpts"></a><a class="term" href="options.html#opt-vim.autocomplete.nvim-cmp.setupOpts"><code class="option">vim.autocomplete.nvim-cmp.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of the autocomplete plugin</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/completion/nvim-cmp/nvim-cmp.nix" target="_top"> +<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.autocomplete.nvim-cmp.setupOpts.completion.completeopt"></a><a class="term" href="options.html#opt-vim.autocomplete.nvim-cmp.setupOpts.completion.completeopt"><code class="option">vim.autocomplete.nvim-cmp.setupOpts.completion.completeopt</code> + </a> + </span> +</dt> +<dd> +<p>A comma-separated list of options for completion.</p><p>See <code class="literal">:help completeopt</code> for the complete list.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"menu,menuone,noinsert"</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/plugins/completion/nvim-cmp/nvim-cmp.nix" target="_top"> +<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.autocomplete.nvim-cmp.setupOpts.sorting.comparators"></a><a class="term" href="options.html#opt-vim.autocomplete.nvim-cmp.setupOpts.sorting.comparators"><code class="option">vim.autocomplete.nvim-cmp.setupOpts.sorting.comparators</code> + </a> + </span> +</dt> +<dd> +<p>The comparator functions used for sorting completions.</p><p>You can either pass a valid inline lua function +(see <code class="literal">:help cmp-config.sorting.comparators</code>), +or a string, in which case the builtin comparator with that name will +be used.</p><p>A <code class="literal">deprio</code> function and a <code class="literal">kinds</code> +(<code class="literal">require("cmp.types").lsp.CompletionItemKind</code>) variable is provided +above <code class="literal">setupOpts</code>. By passing a type to the function, the returned +function will be a comparator that always ranks the specified kind the +lowest.</p> + +<p><span class="emphasis"><em>Type:</em></span> +mergeless list of (string or (luaInline))</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + { + _type = "lua-inline"; + expr = "deprio(kinds.Text)"; + } + { + _type = "lua-inline"; + expr = "deprio(kinds.Snippet)"; + } + "offset" + "exact" + "score" + "kind" + "length" + "sort_text" +] +</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/plugins/completion/nvim-cmp/nvim-cmp.nix" target="_top"> +<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.autocomplete.nvim-cmp.sourcePlugins"></a><a class="term" href="options.html#opt-vim.autocomplete.nvim-cmp.sourcePlugins"><code class="option">vim.autocomplete.nvim-cmp.sourcePlugins</code> + </a> + </span> +</dt> +<dd> +<p>List of source plugins used by nvim-cmp.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of (null or package or one of “aerial-nvim”, “alpha-nvim”, “base16”, “bufdelete-nvim”, “catppuccin”, “ccc”, “cellular-automaton”, “chatgpt”, “cheatsheet-nvim”, “cinnamon-nvim”, “cmp-buffer”, “cmp-luasnip”, “cmp-nvim-lsp”, “cmp-path”, “cmp-treesitter”, “codewindow-nvim”, “comment-nvim”, “copilot-cmp”, “copilot-lua”, “crates-nvim”, “csharpls-extended”, “dashboard-nvim”, “diffview-nvim”, “dracula”, “dressing-nvim”, “elixir-tools”, “fastaction-nvim”, “fidget-nvim”, “flutter-tools”, “friendly-snippets”, “fzf-lua”, “gesture-nvim”, “gitsigns-nvim”, “glow-nvim”, “gruvbox”, “haskell-tools-nvim”, “highlight-undo”, “hop-nvim”, “icon-picker-nvim”, “image-nvim”, “indent-blankline”, “leap-nvim”, “lsp-lines”, “lsp-signature”, “lspkind”, “lspsaga”, “lua-utils-nvim”, “lualine”, “luasnip”, “lz-n”, “lzn-auto-require”, “mind-nvim”, “mini-ai”, “mini-align”, “mini-animate”, “mini-base16”, “mini-basics”, “mini-bracketed”, “mini-bufremove”, “mini-clue”, “mini-colors”, “mini-comment”, “mini-completion”, “mini-diff”, “mini-doc”, “mini-extra”, “mini-files”, “mini-fuzzy”, “mini-git”, “mini-hipatterns”, “mini-hues”, “mini-icons”, “mini-indentscope”, “mini-jump”, “mini-jump2d”, “mini-map”, “mini-misc”, “mini-move”, “mini-notify”, “mini-operators”, “mini-pairs”, “mini-pick”, “mini-sessions”, “mini-snippets”, “mini-splitjoin”, “mini-starter”, “mini-statusline”, “mini-surround”, “mini-tabline”, “mini-test”, “mini-trailspace”, “mini-visits”, “minimap-vim”, “modes-nvim”, “neo-tree-nvim”, “neocord”, “neodev-nvim”, “neorg”, “neorg-telescope”, “new-file-template-nvim”, “noice-nvim”, “none-ls”, “nord”, “nui-nvim”, “nvim-autopairs”, “nvim-bufferline-lua”, “nvim-cmp”, “nvim-colorizer-lua”, “nvim-cursorline”, “nvim-dap”, “nvim-dap-go”, “nvim-dap-ui”, “nvim-docs-view”, “nvim-lightbulb”, “nvim-lspconfig”, “nvim-metals”, “nvim-navbuddy”, “nvim-navic”, “nvim-neoclip”, “nvim-nio”, “nvim-notify”, “nvim-scrollbar”, “nvim-session-manager”, “nvim-surround”, “nvim-tree-lua”, “nvim-treesitter-context”, “nvim-ts-autotag”, “nvim-ufo”, “nvim-web-devicons”, “obsidian-nvim”, “omnisharp-extended”, “onedark”, “orgmode-nvim”, “otter-nvim”, “oxocarbon”, “pathlib-nvim”, “plenary-nvim”, “precognition-nvim”, “project-nvim”, “promise-async”, “registers”, “render-markdown-nvim”, “rose-pine”, “rtp-nvim”, “run-nvim”, “rustaceanvim”, “smartcolumn”, “sqls-nvim”, “tabular”, “telescope”, “tiny-devicons-auto-colors”, “todo-comments”, “toggleterm-nvim”, “tokyonight”, “trouble”, “ts-error-translator”, “typst-preview-nvim”, “vim-dirtytalk”, “vim-fugitive”, “vim-illuminate”, “vim-markdown”, “vim-repeat”, “vim-startify”, “which-key”, “nvim-treesitter”, “flutter-tools-patched”, “vim-repeat”)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/completion/nvim-cmp/nvim-cmp.nix" target="_top"> +<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.autocomplete.nvim-cmp.sources"></a><a class="term" href="options.html#opt-vim.autocomplete.nvim-cmp.sources"><code class="option">vim.autocomplete.nvim-cmp.sources</code> + </a> + </span> +</dt> +<dd> +<p>The list of sources used by nvim-cmp</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of (null or string)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</code></p> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">{ + nvim-cmp = null; + buffer = "[Buffer]"; +} + +</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/plugins/completion/nvim-cmp/nvim-cmp.nix" target="_top"> +<nvf/modules/plugins/completion/nvim-cmp/nvim-cmp.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.autopairs.nvim-autopairs.enable"></a><a class="term" href="options.html#opt-vim.autopairs.nvim-autopairs.enable"><code class="option">vim.autopairs.nvim-autopairs.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable autopairs.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/autopairs/nvim-autopairs/nvim-autopairs.nix" target="_top"> +<nvf/modules/plugins/autopairs/nvim-autopairs/nvim-autopairs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.autopairs.nvim-autopairs.setupOpts"></a><a class="term" href="options.html#opt-vim.autopairs.nvim-autopairs.setupOpts"><code class="option">vim.autopairs.nvim-autopairs.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of nvim-autopairs</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/autopairs/nvim-autopairs/nvim-autopairs.nix" target="_top"> +<nvf/modules/plugins/autopairs/nvim-autopairs/nvim-autopairs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.bell"></a><a class="term" href="options.html#opt-vim.bell"><code class="option">vim.bell</code> + </a> + </span> +</dt> +<dd> +<p>Set how bells are handled. Options: on, visual or none</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “none”, “visual”, “on”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"none"</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"> +<nvf/modules/neovim/init/basic.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.binds.cheatsheet.enable"></a><a class="term" href="options.html#opt-vim.binds.cheatsheet.enable"><code class="option">vim.binds.cheatsheet.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable cheatsheet-nvim: searchable cheatsheet for nvim using telescope.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/utility/binds/cheatsheet/cheatsheet.nix" target="_top"> +<nvf/modules/plugins/utility/binds/cheatsheet/cheatsheet.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.binds.whichKey.enable"></a><a class="term" href="options.html#opt-vim.binds.whichKey.enable"><code class="option">vim.binds.whichKey.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable which-key keybind helper menu.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/utility/binds/which-key/which-key.nix" target="_top"> +<nvf/modules/plugins/utility/binds/which-key/which-key.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.binds.whichKey.register"></a><a class="term" href="options.html#opt-vim.binds.whichKey.register"><code class="option">vim.binds.whichKey.register</code> + </a> + </span> +</dt> +<dd> +<p>Register label for which-key keybind helper menu</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of (null or string)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/utility/binds/which-key/which-key.nix" target="_top"> +<nvf/modules/plugins/utility/binds/which-key/which-key.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.binds.whichKey.setupOpts"></a><a class="term" href="options.html#opt-vim.binds.whichKey.setupOpts"><code class="option">vim.binds.whichKey.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of which-key</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/utility/binds/which-key/which-key.nix" target="_top"> +<nvf/modules/plugins/utility/binds/which-key/which-key.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.binds.whichKey.setupOpts.notify"></a><a class="term" href="options.html#opt-vim.binds.whichKey.setupOpts.notify"><code class="option">vim.binds.whichKey.setupOpts.notify</code> + </a> + </span> +</dt> +<dd> +<p>Show a warning when issues were detected with mappings</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/plugins/utility/binds/which-key/which-key.nix" target="_top"> +<nvf/modules/plugins/utility/binds/which-key/which-key.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.binds.whichKey.setupOpts.preset"></a><a class="term" href="options.html#opt-vim.binds.whichKey.setupOpts.preset"><code class="option">vim.binds.whichKey.setupOpts.preset</code> + </a> + </span> +</dt> +<dd> +<p>The default preset for the which-key window</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “classic”, “modern”, “helix”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"modern"</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/plugins/utility/binds/which-key/which-key.nix" target="_top"> +<nvf/modules/plugins/utility/binds/which-key/which-key.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.binds.whichKey.setupOpts.replace"></a><a class="term" href="options.html#opt-vim.binds.whichKey.setupOpts.replace"><code class="option">vim.binds.whichKey.setupOpts.replace</code> + </a> + </span> +</dt> +<dd> +<p>Functions/Lua Patterns for formatting the labels</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + "<cr>" = "RETURN"; + "<leader>" = "SPACE"; + "<space>" = "SPACE"; + "<tab>" = "TAB"; +} +</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/plugins/utility/binds/which-key/which-key.nix" target="_top"> +<nvf/modules/plugins/utility/binds/which-key/which-key.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.binds.whichKey.setupOpts.win.border"></a><a class="term" href="options.html#opt-vim.binds.whichKey.setupOpts.win.border"><code class="option">vim.binds.whichKey.setupOpts.win.border</code> + </a> + </span> +</dt> +<dd> +<p>Which-key window border style</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"rounded"</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/plugins/utility/binds/which-key/which-key.nix" target="_top"> +<nvf/modules/plugins/utility/binds/which-key/which-key.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.build.finalPackage"></a><a class="term" href="options.html#opt-vim.build.finalPackage"><code class="option">vim.build.finalPackage</code> + </a> + </span> +</dt> +<dd> +<p>final output package</p> + +<p><span class="emphasis"><em>Type:</em></span> +package <span class="emphasis"><em>(read only)</em></span></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/build/options.nix" target="_top"> +<nvf/modules/wrapper/build/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.comments.comment-nvim.enable"></a><a class="term" href="options.html#opt-vim.comments.comment-nvim.enable"><code class="option">vim.comments.comment-nvim.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable smart and powerful comment plugin for neovim comment-nvim.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/comments/comment-nvim/comment-nvim.nix" target="_top"> +<nvf/modules/plugins/comments/comment-nvim/comment-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.comments.comment-nvim.mappings.toggleCurrentBlock"></a><a class="term" href="options.html#opt-vim.comments.comment-nvim.mappings.toggleCurrentBlock"><code class="option">vim.comments.comment-nvim.mappings.toggleCurrentBlock</code> + </a> + </span> +</dt> +<dd> +<p>Toggle current block comment</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"gbc"</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/plugins/comments/comment-nvim/comment-nvim.nix" target="_top"> +<nvf/modules/plugins/comments/comment-nvim/comment-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.comments.comment-nvim.mappings.toggleCurrentLine"></a><a class="term" href="options.html#opt-vim.comments.comment-nvim.mappings.toggleCurrentLine"><code class="option">vim.comments.comment-nvim.mappings.toggleCurrentLine</code> + </a> + </span> +</dt> +<dd> +<p>Toggle current line comment</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"gcc"</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/plugins/comments/comment-nvim/comment-nvim.nix" target="_top"> +<nvf/modules/plugins/comments/comment-nvim/comment-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.comments.comment-nvim.mappings.toggleOpLeaderBlock"></a><a class="term" href="options.html#opt-vim.comments.comment-nvim.mappings.toggleOpLeaderBlock"><code class="option">vim.comments.comment-nvim.mappings.toggleOpLeaderBlock</code> + </a> + </span> +</dt> +<dd> +<p>Toggle block comment</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"gb"</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/plugins/comments/comment-nvim/comment-nvim.nix" target="_top"> +<nvf/modules/plugins/comments/comment-nvim/comment-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.comments.comment-nvim.mappings.toggleOpLeaderLine"></a><a class="term" href="options.html#opt-vim.comments.comment-nvim.mappings.toggleOpLeaderLine"><code class="option">vim.comments.comment-nvim.mappings.toggleOpLeaderLine</code> + </a> + </span> +</dt> +<dd> +<p>Toggle line comment</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"gc"</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/plugins/comments/comment-nvim/comment-nvim.nix" target="_top"> +<nvf/modules/plugins/comments/comment-nvim/comment-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.comments.comment-nvim.mappings.toggleSelectedBlock"></a><a class="term" href="options.html#opt-vim.comments.comment-nvim.mappings.toggleSelectedBlock"><code class="option">vim.comments.comment-nvim.mappings.toggleSelectedBlock</code> + </a> + </span> +</dt> +<dd> +<p>Toggle selected block</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"gb"</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/plugins/comments/comment-nvim/comment-nvim.nix" target="_top"> +<nvf/modules/plugins/comments/comment-nvim/comment-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.comments.comment-nvim.mappings.toggleSelectedLine"></a><a class="term" href="options.html#opt-vim.comments.comment-nvim.mappings.toggleSelectedLine"><code class="option">vim.comments.comment-nvim.mappings.toggleSelectedLine</code> + </a> + </span> +</dt> +<dd> +<p>Toggle selected comment</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"gc"</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/plugins/comments/comment-nvim/comment-nvim.nix" target="_top"> +<nvf/modules/plugins/comments/comment-nvim/comment-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.comments.comment-nvim.setupOpts"></a><a class="term" href="options.html#opt-vim.comments.comment-nvim.setupOpts"><code class="option">vim.comments.comment-nvim.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of Comment-nvim</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/comments/comment-nvim/comment-nvim.nix" target="_top"> +<nvf/modules/plugins/comments/comment-nvim/comment-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.comments.comment-nvim.setupOpts.mappings.basic"></a><a class="term" href="options.html#opt-vim.comments.comment-nvim.setupOpts.mappings.basic"><code class="option">vim.comments.comment-nvim.setupOpts.mappings.basic</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable basic mappings.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/comments/comment-nvim/comment-nvim.nix" target="_top"> +<nvf/modules/plugins/comments/comment-nvim/comment-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.comments.comment-nvim.setupOpts.mappings.extra"></a><a class="term" href="options.html#opt-vim.comments.comment-nvim.setupOpts.mappings.extra"><code class="option">vim.comments.comment-nvim.setupOpts.mappings.extra</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable extra mappings.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/comments/comment-nvim/comment-nvim.nix" target="_top"> +<nvf/modules/plugins/comments/comment-nvim/comment-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.alpha.enable"></a><a class="term" href="options.html#opt-vim.dashboard.alpha.enable"><code class="option">vim.dashboard.alpha.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable fast and fully programmable greeter for neovim [alpha.mvim].</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/dashboard/alpha/alpha.nix" target="_top"> +<nvf/modules/plugins/dashboard/alpha/alpha.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.dashboard-nvim.enable"></a><a class="term" href="options.html#opt-vim.dashboard.dashboard-nvim.enable"><code class="option">vim.dashboard.dashboard-nvim.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Fancy and Blazing Fast start screen plugin of neovim [dashboard.nvim].</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/dashboard/dashboard-nvim/dashboard-nvim.nix" target="_top"> +<nvf/modules/plugins/dashboard/dashboard-nvim/dashboard-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.dashboard-nvim.setupOpts"></a><a class="term" href="options.html#opt-vim.dashboard.dashboard-nvim.setupOpts"><code class="option">vim.dashboard.dashboard-nvim.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of dashboard.nvim</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/dashboard/dashboard-nvim/dashboard-nvim.nix" target="_top"> +<nvf/modules/plugins/dashboard/dashboard-nvim/dashboard-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.enable"></a><a class="term" href="options.html#opt-vim.dashboard.startify.enable"><code class="option">vim.dashboard.startify.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable dashboard via vim-startify.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.bookmarks"></a><a class="term" href="options.html#opt-vim.dashboard.startify.bookmarks"><code class="option">vim.dashboard.startify.bookmarks</code> + </a> + </span> +</dt> +<dd> +<p>List of book marks to disaply on start page</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of (attribute set)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</code></p> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">{ + c = "~/.vimrc"; +} +</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.changeDirCmd"></a><a class="term" href="options.html#opt-vim.dashboard.startify.changeDirCmd"><code class="option">vim.dashboard.startify.changeDirCmd</code> + </a> + </span> +</dt> +<dd> +<p>Command to change the current window with. Can be cd, lcd or tcd</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “cd”, “lcd”, “tcd”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"lcd"</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.changeToDir"></a><a class="term" href="options.html#opt-vim.dashboard.startify.changeToDir"><code class="option">vim.dashboard.startify.changeToDir</code> + </a> + </span> +</dt> +<dd> +<p>Should vim change to the directory of the file you open</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.changeToVCRoot"></a><a class="term" href="options.html#opt-vim.dashboard.startify.changeToVCRoot"><code class="option">vim.dashboard.startify.changeToVCRoot</code> + </a> + </span> +</dt> +<dd> +<p>Should vim change to the version control root when opening a file</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.commands"></a><a class="term" href="options.html#opt-vim.dashboard.startify.commands"><code class="option">vim.dashboard.startify.commands</code> + </a> + </span> +</dt> +<dd> +<p>Commands that are presented to the user on startify page</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of (string or (attribute set) or list of string)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.customFooter"></a><a class="term" href="options.html#opt-vim.dashboard.startify.customFooter"><code class="option">vim.dashboard.startify.customFooter</code> + </a> + </span> +</dt> +<dd> +<p>Text to place in the footer</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.customHeader"></a><a class="term" href="options.html#opt-vim.dashboard.startify.customHeader"><code class="option">vim.dashboard.startify.customHeader</code> + </a> + </span> +</dt> +<dd> +<p>Text to place in the header</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.customIndices"></a><a class="term" href="options.html#opt-vim.dashboard.startify.customIndices"><code class="option">vim.dashboard.startify.customIndices</code> + </a> + </span> +</dt> +<dd> +<p>Specify a list of default characters to use instead of numbers</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.disableOnStartup"></a><a class="term" href="options.html#opt-vim.dashboard.startify.disableOnStartup"><code class="option">vim.dashboard.startify.disableOnStartup</code> + </a> + </span> +</dt> +<dd> +<p>Prevent startify from opening on startup but can be called with :Startify</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.filesNumber"></a><a class="term" href="options.html#opt-vim.dashboard.startify.filesNumber"><code class="option">vim.dashboard.startify.filesNumber</code> + </a> + </span> +</dt> +<dd> +<p>How many files to list</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">10</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.lists"></a><a class="term" href="options.html#opt-vim.dashboard.startify.lists"><code class="option">vim.dashboard.startify.lists</code> + </a> + </span> +</dt> +<dd> +<p>Specify the lists and in what order they are displayed on startify.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of (attribute set)</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + { + header = [ + "MRU" + ]; + type = "files"; + } + { + header = [ + "MRU Current Directory" + ]; + type = "dir"; + } + { + header = [ + "Sessions" + ]; + type = "sessions"; + } + { + header = [ + "Bookmarks" + ]; + type = "bookmarks"; + } + { + header = [ + "Commands" + ]; + type = "commands"; + } +] +</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.paddingLeft"></a><a class="term" href="options.html#opt-vim.dashboard.startify.paddingLeft"><code class="option">vim.dashboard.startify.paddingLeft</code> + </a> + </span> +</dt> +<dd> +<p>Number of spaces used for left padding.</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">3</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.sessionAutoload"></a><a class="term" href="options.html#opt-vim.dashboard.startify.sessionAutoload"><code class="option">vim.dashboard.startify.sessionAutoload</code> + </a> + </span> +</dt> +<dd> +<p>Make startify auto load Session.vim files from the current directory</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.sessionBeforeSave"></a><a class="term" href="options.html#opt-vim.dashboard.startify.sessionBeforeSave"><code class="option">vim.dashboard.startify.sessionBeforeSave</code> + </a> + </span> +</dt> +<dd> +<p>Commands to run before saving a session</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.sessionDeleteBuffers"></a><a class="term" href="options.html#opt-vim.dashboard.startify.sessionDeleteBuffers"><code class="option">vim.dashboard.startify.sessionDeleteBuffers</code> + </a> + </span> +</dt> +<dd> +<p>Delete all buffers when loading or closing a session</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.sessionDir"></a><a class="term" href="options.html#opt-vim.dashboard.startify.sessionDir"><code class="option">vim.dashboard.startify.sessionDir</code> + </a> + </span> +</dt> +<dd> +<p>Directory to save and load sessions from</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"~/.vim/session"</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.sessionPersistence"></a><a class="term" href="options.html#opt-vim.dashboard.startify.sessionPersistence"><code class="option">vim.dashboard.startify.sessionPersistence</code> + </a> + </span> +</dt> +<dd> +<p>Persist session before leaving vim or switching session</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.sessionRemoveLines"></a><a class="term" href="options.html#opt-vim.dashboard.startify.sessionRemoveLines"><code class="option">vim.dashboard.startify.sessionRemoveLines</code> + </a> + </span> +</dt> +<dd> +<p>Patterns to remove from session files</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.sessionSavecmds"></a><a class="term" href="options.html#opt-vim.dashboard.startify.sessionSavecmds"><code class="option">vim.dashboard.startify.sessionSavecmds</code> + </a> + </span> +</dt> +<dd> +<p>List of commands to run when loading a session.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.sessionSavevars"></a><a class="term" href="options.html#opt-vim.dashboard.startify.sessionSavevars"><code class="option">vim.dashboard.startify.sessionSavevars</code> + </a> + </span> +</dt> +<dd> +<p>List of variables to save into a session file.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.sessionSort"></a><a class="term" href="options.html#opt-vim.dashboard.startify.sessionSort"><code class="option">vim.dashboard.startify.sessionSort</code> + </a> + </span> +</dt> +<dd> +<p>Set if you want items sorted by date rather than alphabetically</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.skipList"></a><a class="term" href="options.html#opt-vim.dashboard.startify.skipList"><code class="option">vim.dashboard.startify.skipList</code> + </a> + </span> +</dt> +<dd> +<p>List of regex patterns to exclude from MRU lists</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.skipListServer"></a><a class="term" href="options.html#opt-vim.dashboard.startify.skipListServer"><code class="option">vim.dashboard.startify.skipListServer</code> + </a> + </span> +</dt> +<dd> +<p>List of vim servers to not load startify for</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.unsafe"></a><a class="term" href="options.html#opt-vim.dashboard.startify.unsafe"><code class="option">vim.dashboard.startify.unsafe</code> + </a> + </span> +</dt> +<dd> +<p>Turns on unsafe mode for Startify. Stops resolving links, checking files are readable and filtering bookmark list</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.updateOldFiles"></a><a class="term" href="options.html#opt-vim.dashboard.startify.updateOldFiles"><code class="option">vim.dashboard.startify.updateOldFiles</code> + </a> + </span> +</dt> +<dd> +<p>Set if you want startify to always update and not just when neovim closes</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.dashboard.startify.useEnv"></a><a class="term" href="options.html#opt-vim.dashboard.startify.useEnv"><code class="option">vim.dashboard.startify.useEnv</code> + </a> + </span> +</dt> +<dd> +<p>Show environment variables in path if name is shorter than value</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/dashboard/startify/startify.nix" target="_top"> +<nvf/modules/plugins/dashboard/startify/startify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.debugMode.enable"></a><a class="term" href="options.html#opt-vim.debugMode.enable"><code class="option">vim.debugMode.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable debug mode.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/debug.nix" target="_top"> +<nvf/modules/neovim/init/debug.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.debugMode.level"></a><a class="term" href="options.html#opt-vim.debugMode.level"><code class="option">vim.debugMode.level</code> + </a> + </span> +</dt> +<dd> +<p>Set verbosity level of Neovim while debug mode is enabled.</p><p>Value must be be one of the levels expected by Neovim’s +<a class="link" href="https://neovim.io/doc/user/options.html#'verbose'" target="_top"><code class="literal">verbose</code> option</a></p> + +<p><span class="emphasis"><em>Type:</em></span> +one of 2, 3, 4, 5, 8, 9, 11, 12, 13, 14, 15, 16</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">16</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/debug.nix" target="_top"> +<nvf/modules/neovim/init/debug.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.debugMode.logFile"></a><a class="term" href="options.html#opt-vim.debugMode.logFile"><code class="option">vim.debugMode.logFile</code> + </a> + </span> +</dt> +<dd> +<p>Set the log file that will be used to store verbose messages +set by the <code class="literal">verbose</code> option.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or path</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/debug.nix" target="_top"> +<nvf/modules/neovim/init/debug.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.debugger.nvim-dap.enable"></a><a class="term" href="options.html#opt-vim.debugger.nvim-dap.enable"><code class="option">vim.debugger.nvim-dap.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable debugging via nvim-dap.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/debugger/nvim-dap/nvim-dap.nix" target="_top"> +<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.debugger.nvim-dap.mappings.continue"></a><a class="term" href="options.html#opt-vim.debugger.nvim-dap.mappings.continue"><code class="option">vim.debugger.nvim-dap.mappings.continue</code> + </a> + </span> +</dt> +<dd> +<p>Continue</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>dc"</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/plugins/debugger/nvim-dap/nvim-dap.nix" target="_top"> +<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.debugger.nvim-dap.mappings.goDown"></a><a class="term" href="options.html#opt-vim.debugger.nvim-dap.mappings.goDown"><code class="option">vim.debugger.nvim-dap.mappings.goDown</code> + </a> + </span> +</dt> +<dd> +<p>Go down stacktrace</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>dvi"</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/plugins/debugger/nvim-dap/nvim-dap.nix" target="_top"> +<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.debugger.nvim-dap.mappings.goUp"></a><a class="term" href="options.html#opt-vim.debugger.nvim-dap.mappings.goUp"><code class="option">vim.debugger.nvim-dap.mappings.goUp</code> + </a> + </span> +</dt> +<dd> +<p>Go up stacktrace</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>dvo"</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/plugins/debugger/nvim-dap/nvim-dap.nix" target="_top"> +<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.debugger.nvim-dap.mappings.hover"></a><a class="term" href="options.html#opt-vim.debugger.nvim-dap.mappings.hover"><code class="option">vim.debugger.nvim-dap.mappings.hover</code> + </a> + </span> +</dt> +<dd> +<p>Hover</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>dh"</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/plugins/debugger/nvim-dap/nvim-dap.nix" target="_top"> +<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.debugger.nvim-dap.mappings.restart"></a><a class="term" href="options.html#opt-vim.debugger.nvim-dap.mappings.restart"><code class="option">vim.debugger.nvim-dap.mappings.restart</code> + </a> + </span> +</dt> +<dd> +<p>Restart</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>dR"</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/plugins/debugger/nvim-dap/nvim-dap.nix" target="_top"> +<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.debugger.nvim-dap.mappings.runLast"></a><a class="term" href="options.html#opt-vim.debugger.nvim-dap.mappings.runLast"><code class="option">vim.debugger.nvim-dap.mappings.runLast</code> + </a> + </span> +</dt> +<dd> +<p>Re-run Last Debug Session</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>d."</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/plugins/debugger/nvim-dap/nvim-dap.nix" target="_top"> +<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.debugger.nvim-dap.mappings.runToCursor"></a><a class="term" href="options.html#opt-vim.debugger.nvim-dap.mappings.runToCursor"><code class="option">vim.debugger.nvim-dap.mappings.runToCursor</code> + </a> + </span> +</dt> +<dd> +<p>Continue to the current cursor</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>dgc"</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/plugins/debugger/nvim-dap/nvim-dap.nix" target="_top"> +<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.debugger.nvim-dap.mappings.stepBack"></a><a class="term" href="options.html#opt-vim.debugger.nvim-dap.mappings.stepBack"><code class="option">vim.debugger.nvim-dap.mappings.stepBack</code> + </a> + </span> +</dt> +<dd> +<p>Step back</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>dgk"</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/plugins/debugger/nvim-dap/nvim-dap.nix" target="_top"> +<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.debugger.nvim-dap.mappings.stepInto"></a><a class="term" href="options.html#opt-vim.debugger.nvim-dap.mappings.stepInto"><code class="option">vim.debugger.nvim-dap.mappings.stepInto</code> + </a> + </span> +</dt> +<dd> +<p>Step into function</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>dgi"</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/plugins/debugger/nvim-dap/nvim-dap.nix" target="_top"> +<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.debugger.nvim-dap.mappings.stepOut"></a><a class="term" href="options.html#opt-vim.debugger.nvim-dap.mappings.stepOut"><code class="option">vim.debugger.nvim-dap.mappings.stepOut</code> + </a> + </span> +</dt> +<dd> +<p>Step out of function</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>dgo"</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/plugins/debugger/nvim-dap/nvim-dap.nix" target="_top"> +<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.debugger.nvim-dap.mappings.stepOver"></a><a class="term" href="options.html#opt-vim.debugger.nvim-dap.mappings.stepOver"><code class="option">vim.debugger.nvim-dap.mappings.stepOver</code> + </a> + </span> +</dt> +<dd> +<p>Next step</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>dgj"</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/plugins/debugger/nvim-dap/nvim-dap.nix" target="_top"> +<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.debugger.nvim-dap.mappings.terminate"></a><a class="term" href="options.html#opt-vim.debugger.nvim-dap.mappings.terminate"><code class="option">vim.debugger.nvim-dap.mappings.terminate</code> + </a> + </span> +</dt> +<dd> +<p>Terminate</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>dq"</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/plugins/debugger/nvim-dap/nvim-dap.nix" target="_top"> +<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.debugger.nvim-dap.mappings.toggleBreakpoint"></a><a class="term" href="options.html#opt-vim.debugger.nvim-dap.mappings.toggleBreakpoint"><code class="option">vim.debugger.nvim-dap.mappings.toggleBreakpoint</code> + </a> + </span> +</dt> +<dd> +<p>Toggle breakpoint</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>db"</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/plugins/debugger/nvim-dap/nvim-dap.nix" target="_top"> +<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.debugger.nvim-dap.mappings.toggleDapUI"></a><a class="term" href="options.html#opt-vim.debugger.nvim-dap.mappings.toggleDapUI"><code class="option">vim.debugger.nvim-dap.mappings.toggleDapUI</code> + </a> + </span> +</dt> +<dd> +<p>Toggle DAP-UI</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>du"</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/plugins/debugger/nvim-dap/nvim-dap.nix" target="_top"> +<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.debugger.nvim-dap.mappings.toggleRepl"></a><a class="term" href="options.html#opt-vim.debugger.nvim-dap.mappings.toggleRepl"><code class="option">vim.debugger.nvim-dap.mappings.toggleRepl</code> + </a> + </span> +</dt> +<dd> +<p>Toggle Repl</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>dr"</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/plugins/debugger/nvim-dap/nvim-dap.nix" target="_top"> +<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.debugger.nvim-dap.sources"></a><a class="term" href="options.html#opt-vim.debugger.nvim-dap.sources"><code class="option">vim.debugger.nvim-dap.sources</code> + </a> + </span> +</dt> +<dd> +<p>List of debuggers to install</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/debugger/nvim-dap/nvim-dap.nix" target="_top"> +<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.debugger.nvim-dap.ui.enable"></a><a class="term" href="options.html#opt-vim.debugger.nvim-dap.ui.enable"><code class="option">vim.debugger.nvim-dap.ui.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable UI extension for nvim-dap.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/debugger/nvim-dap/nvim-dap.nix" target="_top"> +<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.debugger.nvim-dap.ui.autoStart"></a><a class="term" href="options.html#opt-vim.debugger.nvim-dap.ui.autoStart"><code class="option">vim.debugger.nvim-dap.ui.autoStart</code> + </a> + </span> +</dt> +<dd> +<p>Automatically Opens and Closes DAP-UI upon starting/closing a debugging session</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/plugins/debugger/nvim-dap/nvim-dap.nix" target="_top"> +<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.debugger.nvim-dap.ui.setupOpts"></a><a class="term" href="options.html#opt-vim.debugger.nvim-dap.ui.setupOpts"><code class="option">vim.debugger.nvim-dap.ui.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of nvim-dap-ui</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/debugger/nvim-dap/nvim-dap.nix" target="_top"> +<nvf/modules/plugins/debugger/nvim-dap/nvim-dap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.disableArrows"></a><a class="term" href="options.html#opt-vim.disableArrows"><code class="option">vim.disableArrows</code> + </a> + </span> +</dt> +<dd> +<p>Set to prevent arrow keys from moving cursor</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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"> +<nvf/modules/neovim/init/basic.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.extraLuaFiles"></a><a class="term" href="options.html#opt-vim.extraLuaFiles"><code class="option">vim.extraLuaFiles</code> + </a> + </span> +</dt> +<dd> +<p>Additional lua files that will be sourced by Neovim. +Takes both absolute and relative paths, all of which +will be called via the <code class="literal">luafile</code> command in Neovim.</p><p>See <a class="link" href="https://neovim.io/doc/user/lua.html#lua-commands" target="_top">lua-commands</a> +on the Neovim documentation for more details.</p><div class="warning"><h3 class="title">Warning</h3><p>All paths passed to this option must be valid. If Neovim cannot +resolve the path you are attempting to source, then your configuration +will error, and Neovim will not start. Please ensure that all paths +are correct before using this option.</p></div> + +<p><span class="emphasis"><em>Type:</em></span> +list of (path or string)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</code></p> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">[ + # absolute path, as a string - impure + "$HOME/.config/nvim/my-lua-file.lua" + + # relative path, as a path - pure + ./nvim/my-lua-file.lua + + # source type path - pure and reproducible + (builtins.path { + path = ./nvim/my-lua-file.lua; + name = "my-lua-file"; + }) +] + +</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"> +<nvf/modules/wrapper/rc/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.extraPackages"></a><a class="term" href="options.html#opt-vim.extraPackages"><code class="option">vim.extraPackages</code> + </a> + </span> +</dt> +<dd> +<p>List of additional packages to make available to the Neovim +wrapper.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"[pkgs.fzf pkgs.ripgrep]"</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/environment/options.nix" target="_top"> +<nvf/modules/wrapper/environment/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.extraPlugins"></a><a class="term" href="options.html#opt-vim.extraPlugins"><code class="option">vim.extraPlugins</code> + </a> + </span> +</dt> +<dd> +<p>A list of plugins and their configurations that will be +set up after builtin plugins.</p><p>This option takes a special type that allows you to order +your custom plugins using nvf’s modified DAG library.</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of (submodule)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</code></p> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting nix">with pkgs.vimPlugins; { + aerial = { + package = aerial-nvim; + setup = "require('aerial').setup {}"; + }; + + harpoon = { + package = harpoon; + setup = "require('harpoon').setup {}"; + after = ["aerial"]; # place harpoon configuration after aerial + }; +} +</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/environment/options.nix" target="_top"> +<nvf/modules/wrapper/environment/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.extraPlugins._name_.package"></a><a class="term" href="options.html#opt-vim.extraPlugins._name_.package"><code class="option">vim.extraPlugins.<name>.package</code> + </a> + </span> +</dt> +<dd> +<p>Plugin Package.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or package or one of “aerial-nvim”, “alpha-nvim”, “base16”, “bufdelete-nvim”, “catppuccin”, “ccc”, “cellular-automaton”, “chatgpt”, “cheatsheet-nvim”, “cinnamon-nvim”, “cmp-buffer”, “cmp-luasnip”, “cmp-nvim-lsp”, “cmp-path”, “cmp-treesitter”, “codewindow-nvim”, “comment-nvim”, “copilot-cmp”, “copilot-lua”, “crates-nvim”, “csharpls-extended”, “dashboard-nvim”, “diffview-nvim”, “dracula”, “dressing-nvim”, “elixir-tools”, “fastaction-nvim”, “fidget-nvim”, “flutter-tools”, “friendly-snippets”, “fzf-lua”, “gesture-nvim”, “gitsigns-nvim”, “glow-nvim”, “gruvbox”, “haskell-tools-nvim”, “highlight-undo”, “hop-nvim”, “icon-picker-nvim”, “image-nvim”, “indent-blankline”, “leap-nvim”, “lsp-lines”, “lsp-signature”, “lspkind”, “lspsaga”, “lua-utils-nvim”, “lualine”, “luasnip”, “lz-n”, “lzn-auto-require”, “mind-nvim”, “mini-ai”, “mini-align”, “mini-animate”, “mini-base16”, “mini-basics”, “mini-bracketed”, “mini-bufremove”, “mini-clue”, “mini-colors”, “mini-comment”, “mini-completion”, “mini-diff”, “mini-doc”, “mini-extra”, “mini-files”, “mini-fuzzy”, “mini-git”, “mini-hipatterns”, “mini-hues”, “mini-icons”, “mini-indentscope”, “mini-jump”, “mini-jump2d”, “mini-map”, “mini-misc”, “mini-move”, “mini-notify”, “mini-operators”, “mini-pairs”, “mini-pick”, “mini-sessions”, “mini-snippets”, “mini-splitjoin”, “mini-starter”, “mini-statusline”, “mini-surround”, “mini-tabline”, “mini-test”, “mini-trailspace”, “mini-visits”, “minimap-vim”, “modes-nvim”, “neo-tree-nvim”, “neocord”, “neodev-nvim”, “neorg”, “neorg-telescope”, “new-file-template-nvim”, “noice-nvim”, “none-ls”, “nord”, “nui-nvim”, “nvim-autopairs”, “nvim-bufferline-lua”, “nvim-cmp”, “nvim-colorizer-lua”, “nvim-cursorline”, “nvim-dap”, “nvim-dap-go”, “nvim-dap-ui”, “nvim-docs-view”, “nvim-lightbulb”, “nvim-lspconfig”, “nvim-metals”, “nvim-navbuddy”, “nvim-navic”, “nvim-neoclip”, “nvim-nio”, “nvim-notify”, “nvim-scrollbar”, “nvim-session-manager”, “nvim-surround”, “nvim-tree-lua”, “nvim-treesitter-context”, “nvim-ts-autotag”, “nvim-ufo”, “nvim-web-devicons”, “obsidian-nvim”, “omnisharp-extended”, “onedark”, “orgmode-nvim”, “otter-nvim”, “oxocarbon”, “pathlib-nvim”, “plenary-nvim”, “precognition-nvim”, “project-nvim”, “promise-async”, “registers”, “render-markdown-nvim”, “rose-pine”, “rtp-nvim”, “run-nvim”, “rustaceanvim”, “smartcolumn”, “sqls-nvim”, “tabular”, “telescope”, “tiny-devicons-auto-colors”, “todo-comments”, “toggleterm-nvim”, “tokyonight”, “trouble”, “ts-error-translator”, “typst-preview-nvim”, “vim-dirtytalk”, “vim-fugitive”, “vim-illuminate”, “vim-markdown”, “vim-repeat”, “vim-startify”, “which-key”, “nvim-treesitter”, “flutter-tools-patched”, “vim-repeat”</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/environment/options.nix" target="_top"> +<nvf/modules/wrapper/environment/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.extraPlugins._name_.after"></a><a class="term" href="options.html#opt-vim.extraPlugins._name_.after"><code class="option">vim.extraPlugins.<name>.after</code> + </a> + </span> +</dt> +<dd> +<p>Setup this plugin after the following ones.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/environment/options.nix" target="_top"> +<nvf/modules/wrapper/environment/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.extraPlugins._name_.setup"></a><a class="term" href="options.html#opt-vim.extraPlugins._name_.setup"><code class="option">vim.extraPlugins.<name>.setup</code> + </a> + </span> +</dt> +<dd> +<p>Lua code to run during setup.</p> + +<p><span class="emphasis"><em>Type:</em></span> +strings concatenated with “\n”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">""</code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"require('aerial').setup {}"</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/environment/options.nix" target="_top"> +<nvf/modules/wrapper/environment/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.neo-tree.enable"></a><a class="term" href="options.html#opt-vim.filetree.neo-tree.enable"><code class="option">vim.filetree.neo-tree.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable filetree via neo-tree.nvim.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/filetree/neo-tree/neo-tree.nix" target="_top"> +<nvf/modules/plugins/filetree/neo-tree/neo-tree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.neo-tree.setupOpts"></a><a class="term" href="options.html#opt-vim.filetree.neo-tree.setupOpts"><code class="option">vim.filetree.neo-tree.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of neo-tree</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/filetree/neo-tree/neo-tree.nix" target="_top"> +<nvf/modules/plugins/filetree/neo-tree/neo-tree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.neo-tree.setupOpts.enable_cursor_hijack"></a><a class="term" href="options.html#opt-vim.filetree.neo-tree.setupOpts.enable_cursor_hijack"><code class="option">vim.filetree.neo-tree.setupOpts.enable_cursor_hijack</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable cursor hijacking.</p><p>If enabled neotree will keep the cursor on the first letter of the filename when moving in the tree +.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/filetree/neo-tree/neo-tree.nix" target="_top"> +<nvf/modules/plugins/filetree/neo-tree/neo-tree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.neo-tree.setupOpts.enable_diagnostics"></a><a class="term" href="options.html#opt-vim.filetree.neo-tree.setupOpts.enable_diagnostics"><code class="option">vim.filetree.neo-tree.setupOpts.enable_diagnostics</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable diagnostics.</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>Example:</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/plugins/filetree/neo-tree/neo-tree.nix" target="_top"> +<nvf/modules/plugins/filetree/neo-tree/neo-tree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.neo-tree.setupOpts.enable_git_status"></a><a class="term" href="options.html#opt-vim.filetree.neo-tree.setupOpts.enable_git_status"><code class="option">vim.filetree.neo-tree.setupOpts.enable_git_status</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable git status.</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>Example:</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/plugins/filetree/neo-tree/neo-tree.nix" target="_top"> +<nvf/modules/plugins/filetree/neo-tree/neo-tree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.neo-tree.setupOpts.enable_modified_markers"></a><a class="term" href="options.html#opt-vim.filetree.neo-tree.setupOpts.enable_modified_markers"><code class="option">vim.filetree.neo-tree.setupOpts.enable_modified_markers</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable markers for files with unsaved changes…</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>Example:</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/plugins/filetree/neo-tree/neo-tree.nix" target="_top"> +<nvf/modules/plugins/filetree/neo-tree/neo-tree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.neo-tree.setupOpts.enable_opened_markers"></a><a class="term" href="options.html#opt-vim.filetree.neo-tree.setupOpts.enable_opened_markers"><code class="option">vim.filetree.neo-tree.setupOpts.enable_opened_markers</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable tracking of opened files.</p><p>Required for <code class="literal">components.name.highlight_opened_files</code> +.</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>Example:</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/plugins/filetree/neo-tree/neo-tree.nix" target="_top"> +<nvf/modules/plugins/filetree/neo-tree/neo-tree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.neo-tree.setupOpts.enable_refresh_on_write"></a><a class="term" href="options.html#opt-vim.filetree.neo-tree.setupOpts.enable_refresh_on_write"><code class="option">vim.filetree.neo-tree.setupOpts.enable_refresh_on_write</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Refresh the tree when a file is written.</p><p>Only used if <code class="literal">use_libuv_file_watcher</code> is false. +.</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>Example:</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/plugins/filetree/neo-tree/neo-tree.nix" target="_top"> +<nvf/modules/plugins/filetree/neo-tree/neo-tree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.neo-tree.setupOpts.add_blank_line_at_top"></a><a class="term" href="options.html#opt-vim.filetree.neo-tree.setupOpts.add_blank_line_at_top"><code class="option">vim.filetree.neo-tree.setupOpts.add_blank_line_at_top</code> + </a> + </span> +</dt> +<dd> +<p>Whether to add a blank line at the top of the tree</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/neo-tree/neo-tree.nix" target="_top"> +<nvf/modules/plugins/filetree/neo-tree/neo-tree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.neo-tree.setupOpts.auto_clean_after_session_restore"></a><a class="term" href="options.html#opt-vim.filetree.neo-tree.setupOpts.auto_clean_after_session_restore"><code class="option">vim.filetree.neo-tree.setupOpts.auto_clean_after_session_restore</code> + </a> + </span> +</dt> +<dd> +<p>Whether to automatically clean up broken neo-tree buffers +saved in sessions</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/neo-tree/neo-tree.nix" target="_top"> +<nvf/modules/plugins/filetree/neo-tree/neo-tree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.neo-tree.setupOpts.default_source"></a><a class="term" href="options.html#opt-vim.filetree.neo-tree.setupOpts.default_source"><code class="option">vim.filetree.neo-tree.setupOpts.default_source</code> + </a> + </span> +</dt> +<dd> +<p>You can choose a specific source.</p><p><code class="literal">last</code> here which indicates the last used source</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"filesystem"</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/plugins/filetree/neo-tree/neo-tree.nix" target="_top"> +<nvf/modules/plugins/filetree/neo-tree/neo-tree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.neo-tree.setupOpts.filesystem.hijack_netrw_behavior"></a><a class="term" href="options.html#opt-vim.filetree.neo-tree.setupOpts.filesystem.hijack_netrw_behavior"><code class="option">vim.filetree.neo-tree.setupOpts.filesystem.hijack_netrw_behavior</code> + </a> + </span> +</dt> +<dd> +<p>Hijack Netrw behavior</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “disabled”, “open_default”, “open_current”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"open_default"</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/plugins/filetree/neo-tree/neo-tree.nix" target="_top"> +<nvf/modules/plugins/filetree/neo-tree/neo-tree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.neo-tree.setupOpts.git_status_async"></a><a class="term" href="options.html#opt-vim.filetree.neo-tree.setupOpts.git_status_async"><code class="option">vim.filetree.neo-tree.setupOpts.git_status_async</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable async git status.</p><p>This will make the git status check async and will not block the UI. +.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/filetree/neo-tree/neo-tree.nix" target="_top"> +<nvf/modules/plugins/filetree/neo-tree/neo-tree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.neo-tree.setupOpts.hide_root_node"></a><a class="term" href="options.html#opt-vim.filetree.neo-tree.setupOpts.hide_root_node"><code class="option">vim.filetree.neo-tree.setupOpts.hide_root_node</code> + </a> + </span> +</dt> +<dd> +<p>Whether to hide the root node of the tree</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/neo-tree/neo-tree.nix" target="_top"> +<nvf/modules/plugins/filetree/neo-tree/neo-tree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.neo-tree.setupOpts.log_level"></a><a class="term" href="options.html#opt-vim.filetree.neo-tree.setupOpts.log_level"><code class="option">vim.filetree.neo-tree.setupOpts.log_level</code> + </a> + </span> +</dt> +<dd> +<p>Log level for the plugin.</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “trace”, “debug”, “info”, “warn”, “error”, “fatal”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"info"</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/plugins/filetree/neo-tree/neo-tree.nix" target="_top"> +<nvf/modules/plugins/filetree/neo-tree/neo-tree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.neo-tree.setupOpts.log_to_file"></a><a class="term" href="options.html#opt-vim.filetree.neo-tree.setupOpts.log_to_file"><code class="option">vim.filetree.neo-tree.setupOpts.log_to_file</code> + </a> + </span> +</dt> +<dd> +<p>Must be either a boolean or a path to your log file.</p><p>Use :NeoTreeLogs to show the file</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">/tmp/neo-tree.log</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/plugins/filetree/neo-tree/neo-tree.nix" target="_top"> +<nvf/modules/plugins/filetree/neo-tree/neo-tree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.neo-tree.setupOpts.open_files_do_not_replace_types"></a><a class="term" href="options.html#opt-vim.filetree.neo-tree.setupOpts.open_files_do_not_replace_types"><code class="option">vim.filetree.neo-tree.setupOpts.open_files_do_not_replace_types</code> + </a> + </span> +</dt> +<dd> +<p>A list of filetypes that should not be replaced when opening a file</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "terminal" + "Trouble" + "qf" + "edgy" +] +</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/plugins/filetree/neo-tree/neo-tree.nix" target="_top"> +<nvf/modules/plugins/filetree/neo-tree/neo-tree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.neo-tree.setupOpts.open_files_in_last_window"></a><a class="term" href="options.html#opt-vim.filetree.neo-tree.setupOpts.open_files_in_last_window"><code class="option">vim.filetree.neo-tree.setupOpts.open_files_in_last_window</code> + </a> + </span> +</dt> +<dd> +<p>Whether to open files in the last window</p><p>If disabled, neo-tree will open files in top left window</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/plugins/filetree/neo-tree/neo-tree.nix" target="_top"> +<nvf/modules/plugins/filetree/neo-tree/neo-tree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.neo-tree.setupOpts.retain_hidden_root_indent"></a><a class="term" href="options.html#opt-vim.filetree.neo-tree.setupOpts.retain_hidden_root_indent"><code class="option">vim.filetree.neo-tree.setupOpts.retain_hidden_root_indent</code> + </a> + </span> +</dt> +<dd> +<p>Whether to retain the indent of the hidden root node</p><p>IF the root node is hidden, keep the indentation anyhow. +This is needed if you use expanders because they render in the indent.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/neo-tree/neo-tree.nix" target="_top"> +<nvf/modules/plugins/filetree/neo-tree/neo-tree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.enable"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.enable"><code class="option">vim.filetree.nvimTree.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable filetree via nvim-tree.lua.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.mappings.findFile"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.mappings.findFile"><code class="option">vim.filetree.nvimTree.mappings.findFile</code> + </a> + </span> +</dt> +<dd> +<p>Find file in NvimTree</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>tg"</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.mappings.focus"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.mappings.focus"><code class="option">vim.filetree.nvimTree.mappings.focus</code> + </a> + </span> +</dt> +<dd> +<p>Focus NvimTree</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>tf"</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.mappings.refresh"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.mappings.refresh"><code class="option">vim.filetree.nvimTree.mappings.refresh</code> + </a> + </span> +</dt> +<dd> +<p>Refresh NvimTree</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>tr"</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.mappings.toggle"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.mappings.toggle"><code class="option">vim.filetree.nvimTree.mappings.toggle</code> + </a> + </span> +</dt> +<dd> +<p>Toggle NvimTree</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>t"</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.openOnSetup"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.openOnSetup"><code class="option">vim.filetree.nvimTree.openOnSetup</code> + </a> + </span> +</dt> +<dd> +<p>Open when vim is started on a 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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts"><code class="option">vim.filetree.nvimTree.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of Nvim Tree</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.actions"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.actions"><code class="option">vim.filetree.nvimTree.setupOpts.actions</code> + </a> + </span> +</dt> +<dd> +<p>Configuration for various actions.</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.actions.change_dir"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.actions.change_dir"><code class="option">vim.filetree.nvimTree.setupOpts.actions.change_dir</code> + </a> + </span> +</dt> +<dd> +<p>vim <code class="literal">change-directory</code> behaviour</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.actions.change_dir.enable"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.actions.change_dir.enable"><code class="option">vim.filetree.nvimTree.setupOpts.actions.change_dir.enable</code> + </a> + </span> +</dt> +<dd> +<p>Change the working directory when changing directories in the tree.</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.actions.change_dir.global"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.actions.change_dir.global"><code class="option">vim.filetree.nvimTree.setupOpts.actions.change_dir.global</code> + </a> + </span> +</dt> +<dd> +<p>Use <code class="literal">:cd</code> instead of <code class="literal">:lcd</code> when changing directories. +Consider that this might cause issues with the <code class="literal">nvimTree.syncRootWithCwd</code> option.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.actions.change_dir.restrict_above_cwd"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.actions.change_dir.restrict_above_cwd"><code class="option">vim.filetree.nvimTree.setupOpts.actions.change_dir.restrict_above_cwd</code> + </a> + </span> +</dt> +<dd> +<p>Restrict changing to a directory above the global current working directory.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.actions.expand_all"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.actions.expand_all"><code class="option">vim.filetree.nvimTree.setupOpts.actions.expand_all</code> + </a> + </span> +</dt> +<dd> +<p>Configuration for expand_all behaviour.</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.actions.expand_all.exclude"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.actions.expand_all.exclude"><code class="option">vim.filetree.nvimTree.setupOpts.actions.expand_all.exclude</code> + </a> + </span> +</dt> +<dd> +<p>A list of directories that should not be expanded automatically.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + ".git" + "target" + "build" + "result" +] +</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.actions.expand_all.max_folder_discovery"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.actions.expand_all.max_folder_discovery"><code class="option">vim.filetree.nvimTree.setupOpts.actions.expand_all.max_folder_discovery</code> + </a> + </span> +</dt> +<dd> +<p>Limit the number of folders being explored when expanding every folders. +Avoids hanging neovim when running this action on very large folders.</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">300</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.actions.file_popup"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.actions.file_popup"><code class="option">vim.filetree.nvimTree.setupOpts.actions.file_popup</code> + </a> + </span> +</dt> +<dd> +<p>Configuration for file_popup behaviour.</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.actions.file_popup.open_win_config"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.actions.file_popup.open_win_config"><code class="option">vim.filetree.nvimTree.setupOpts.actions.file_popup.open_win_config</code> + </a> + </span> +</dt> +<dd> +<p>Floating window config for file_popup. See |nvim_open_win| for more details.</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + border = "rounded"; + col = 1; + relative = "cursor"; + row = 1; + style = "minimal"; +} +</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.actions.open_file"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.actions.open_file"><code class="option">vim.filetree.nvimTree.setupOpts.actions.open_file</code> + </a> + </span> +</dt> +<dd> +<p>Configuration options for opening a file from nvim-tree.</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.actions.open_file.eject"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.actions.open_file.eject"><code class="option">vim.filetree.nvimTree.setupOpts.actions.open_file.eject</code> + </a> + </span> +</dt> +<dd> +<p>Prevent new opened file from opening in the same window as the tree.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.actions.open_file.quit_on_open"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.actions.open_file.quit_on_open"><code class="option">vim.filetree.nvimTree.setupOpts.actions.open_file.quit_on_open</code> + </a> + </span> +</dt> +<dd> +<p>Closes the explorer when opening a file.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.actions.open_file.resize_window"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.actions.open_file.resize_window"><code class="option">vim.filetree.nvimTree.setupOpts.actions.open_file.resize_window</code> + </a> + </span> +</dt> +<dd> +<p>Resizes the tree when opening a file. Previously <code class="literal">view.auto_resize</code></p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.actions.open_file.window_picker"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.actions.open_file.window_picker"><code class="option">vim.filetree.nvimTree.setupOpts.actions.open_file.window_picker</code> + </a> + </span> +</dt> +<dd> +<p>window_picker</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.actions.open_file.window_picker.enable"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.actions.open_file.window_picker.enable"><code class="option">vim.filetree.nvimTree.setupOpts.actions.open_file.window_picker.enable</code> + </a> + </span> +</dt> +<dd> +<p>Enable the window picker. If this feature is not enabled, files will open in window from which you last opened the tree.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.actions.open_file.window_picker.chars"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.actions.open_file.window_picker.chars"><code class="option">vim.filetree.nvimTree.setupOpts.actions.open_file.window_picker.chars</code> + </a> + </span> +</dt> +<dd> +<p>A string of chars used as identifiers by the window picker.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890"</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.actions.open_file.window_picker.exclude.buftype"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.actions.open_file.window_picker.exclude.buftype"><code class="option">vim.filetree.nvimTree.setupOpts.actions.open_file.window_picker.exclude.buftype</code> + </a> + </span> +</dt> +<dd> +<p>A list of buftypes to exclude from the window picker.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "nofile" + "terminal" + "help" +] +</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.actions.open_file.window_picker.exclude.filetype"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.actions.open_file.window_picker.exclude.filetype"><code class="option">vim.filetree.nvimTree.setupOpts.actions.open_file.window_picker.exclude.filetype</code> + </a> + </span> +</dt> +<dd> +<p>A list of filetypes to exclude from the window picker.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "notify" + "packer" + "qf" + "diff" + "fugitive" + "fugitiveblame" +] +</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.actions.open_file.window_picker.picker"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.actions.open_file.window_picker.picker"><code class="option">vim.filetree.nvimTree.setupOpts.actions.open_file.window_picker.picker</code> + </a> + </span> +</dt> +<dd> +<p>Change the default window picker, can be a string <code class="literal">"default"</code> or a function. +The function should return the window id that will open the node, +or <code class="literal">nil</code> if an invalid window is picked or user cancelled the action.</p><p>The picker may create a new window.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"default"</code></p> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">-- with s1n7ax/nvim-window-picker plugin +require('window-picker').pick_window, + +</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.actions.remove_file.close_window"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.actions.remove_file.close_window"><code class="option">vim.filetree.nvimTree.setupOpts.actions.remove_file.close_window</code> + </a> + </span> +</dt> +<dd> +<p>Close any window displaying a file when removing the file from the tree</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.actions.use_system_clipboard"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.actions.use_system_clipboard"><code class="option">vim.filetree.nvimTree.setupOpts.actions.use_system_clipboard</code> + </a> + </span> +</dt> +<dd> +<p>A boolean value that toggle the use of system clipboard when copy/paste +function are invoked. When enabled, copied text will be stored in registers +‘+’ (system), otherwise, it will be stored in ‘1’ and ‘"’.</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.auto_reload_on_write"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.auto_reload_on_write"><code class="option">vim.filetree.nvimTree.setupOpts.auto_reload_on_write</code> + </a> + </span> +</dt> +<dd> +<p>Auto reload tree on write</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.diagnostics"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.diagnostics"><code class="option">vim.filetree.nvimTree.setupOpts.diagnostics</code> + </a> + </span> +</dt> +<dd> +<p>Show LSP and COC diagnostics in the signcolumn +Note that the modified sign will take precedence over the diagnostics signs.</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.diagnostics.enable"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.diagnostics.enable"><code class="option">vim.filetree.nvimTree.setupOpts.diagnostics.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable diagnostics view in the signcolumn…</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.diagnostics.debounce_delay"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.diagnostics.debounce_delay"><code class="option">vim.filetree.nvimTree.setupOpts.diagnostics.debounce_delay</code> + </a> + </span> +</dt> +<dd> +<p>Idle milliseconds between diagnostic event and update.</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">50</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.diagnostics.icons"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.diagnostics.icons"><code class="option">vim.filetree.nvimTree.setupOpts.diagnostics.icons</code> + </a> + </span> +</dt> +<dd> +<p>Icons for diagnostic severity.</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.diagnostics.icons.error"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.diagnostics.icons.error"><code class="option">vim.filetree.nvimTree.setupOpts.diagnostics.icons.error</code> + </a> + </span> +</dt> +<dd> +<p>Icon used for <code class="literal">error</code> diagnostic.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">""</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.diagnostics.icons.hint"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.diagnostics.icons.hint"><code class="option">vim.filetree.nvimTree.setupOpts.diagnostics.icons.hint</code> + </a> + </span> +</dt> +<dd> +<p>Icon used for <code class="literal">hint</code> diagnostic.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">""</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.diagnostics.icons.info"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.diagnostics.icons.info"><code class="option">vim.filetree.nvimTree.setupOpts.diagnostics.icons.info</code> + </a> + </span> +</dt> +<dd> +<p>Icon used for <code class="literal">info</code> diagnostic.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">""</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.diagnostics.icons.warning"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.diagnostics.icons.warning"><code class="option">vim.filetree.nvimTree.setupOpts.diagnostics.icons.warning</code> + </a> + </span> +</dt> +<dd> +<p>Icon used for <code class="literal">warning</code> diagnostic.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">""</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.diagnostics.severity"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.diagnostics.severity"><code class="option">vim.filetree.nvimTree.setupOpts.diagnostics.severity</code> + </a> + </span> +</dt> +<dd> +<p>Severity for which the diagnostics will be displayed. See <code class="literal">:help diagnostic-severity</code></p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.diagnostics.severity.max"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.diagnostics.severity.max"><code class="option">vim.filetree.nvimTree.setupOpts.diagnostics.severity.max</code> + </a> + </span> +</dt> +<dd> +<p>Maximum severity.</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “HINT”, “INFO”, “WARNING”, “ERROR”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"ERROR"</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.diagnostics.severity.min"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.diagnostics.severity.min"><code class="option">vim.filetree.nvimTree.setupOpts.diagnostics.severity.min</code> + </a> + </span> +</dt> +<dd> +<p>Minimum severity.</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “HINT”, “INFO”, “WARNING”, “ERROR”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"HINT"</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.diagnostics.show_on_dirs"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.diagnostics.show_on_dirs"><code class="option">vim.filetree.nvimTree.setupOpts.diagnostics.show_on_dirs</code> + </a> + </span> +</dt> +<dd> +<p>Show diagnostic icons on parent directories.</p> + +<p><span class="emphasis"><em>Type:</em></span> +unspecified value</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.diagnostics.show_on_open_dirs"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.diagnostics.show_on_open_dirs"><code class="option">vim.filetree.nvimTree.setupOpts.diagnostics.show_on_open_dirs</code> + </a> + </span> +</dt> +<dd> +<p>Show diagnostics icons on directories that are open. +Only relevant when <code class="literal">diagnostics.show_on_dirs</code> is <code class="literal">true</code>.</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.disable_netrw"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.disable_netrw"><code class="option">vim.filetree.nvimTree.setupOpts.disable_netrw</code> + </a> + </span> +</dt> +<dd> +<p>Disables netrw and replaces it with tree</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.filesystem_watchers"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.filesystem_watchers"><code class="option">vim.filetree.nvimTree.setupOpts.filesystem_watchers</code> + </a> + </span> +</dt> +<dd> +<p>Will use file system watcher (libuv fs_event) to watch the filesystem for changes. +Using this will disable BufEnter / BufWritePost events in nvim-tree which +were used to update the whole tree. With this feature, the tree will be +updated only for the appropriate folder change, resulting in better +performance.</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.filesystem_watchers.enable"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.filesystem_watchers.enable"><code class="option">vim.filetree.nvimTree.setupOpts.filesystem_watchers.enable</code> + </a> + </span> +</dt> +<dd> +<p>Enable filesystem watchers.</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.filesystem_watchers.debounce_delay"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.filesystem_watchers.debounce_delay"><code class="option">vim.filetree.nvimTree.setupOpts.filesystem_watchers.debounce_delay</code> + </a> + </span> +</dt> +<dd> +<p>Idle milliseconds between filesystem change and action.</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">50</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.filesystem_watchers.ignore_dirs"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.filesystem_watchers.ignore_dirs"><code class="option">vim.filetree.nvimTree.setupOpts.filesystem_watchers.ignore_dirs</code> + </a> + </span> +</dt> +<dd> +<p>List of vim regex for absolute directory paths that will not be watched. +Backslashes must be escaped e.g. <code class="literal">"my-project/\\.build$"</code>. +Useful when path is not in <code class="literal">.gitignore</code> or git integration is disabled.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.filters"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.filters"><code class="option">vim.filetree.nvimTree.setupOpts.filters</code> + </a> + </span> +</dt> +<dd> +<p>Filtering options.</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + dotfiles = false; + exclude = [ ]; + git_clean = false; + git_ignored = false; + no_buffer = false; +} +</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.filters.dotfiles"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.filters.dotfiles"><code class="option">vim.filetree.nvimTree.setupOpts.filters.dotfiles</code> + </a> + </span> +</dt> +<dd> +<p>Do not show dotfiles: files starting with a <code class="literal">.</code></p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.filters.exclude"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.filters.exclude"><code class="option">vim.filetree.nvimTree.setupOpts.filters.exclude</code> + </a> + </span> +</dt> +<dd> +<p>List of directories or files to exclude from filtering: always show them.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.filters.git_clean"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.filters.git_clean"><code class="option">vim.filetree.nvimTree.setupOpts.filters.git_clean</code> + </a> + </span> +</dt> +<dd> +<p>Do not show files with no git status. This will show ignored files when +<code class="literal">nvimTree.filters.gitIgnored</code> is set, as they are effectively dirty.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.filters.git_ignored"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.filters.git_ignored"><code class="option">vim.filetree.nvimTree.setupOpts.filters.git_ignored</code> + </a> + </span> +</dt> +<dd> +<p>Ignore files based on <code class="literal">.gitignore</code>. Requires git.enable<code class="literal">to be</code>true`</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.filters.no_buffer"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.filters.no_buffer"><code class="option">vim.filetree.nvimTree.setupOpts.filters.no_buffer</code> + </a> + </span> +</dt> +<dd> +<p>Do not show files that have no <code class="literal">buflisted()</code> buffer.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.git.enable"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.git.enable"><code class="option">vim.filetree.nvimTree.setupOpts.git.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Git integration with icons and colors…</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.git.disable_for_dirs"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.git.disable_for_dirs"><code class="option">vim.filetree.nvimTree.setupOpts.git.disable_for_dirs</code> + </a> + </span> +</dt> +<dd> +<p>Disable git integration when git top-level matches these paths. +May be relative, evaluated via <code class="literal">":p"</code></p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.git.show_on_dirs"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.git.show_on_dirs"><code class="option">vim.filetree.nvimTree.setupOpts.git.show_on_dirs</code> + </a> + </span> +</dt> +<dd> +<p>Show git icons on parent directories.</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.git.show_on_open_dirs"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.git.show_on_open_dirs"><code class="option">vim.filetree.nvimTree.setupOpts.git.show_on_open_dirs</code> + </a> + </span> +</dt> +<dd> +<p>Show git icons on directories that are open.</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.git.timeout"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.git.timeout"><code class="option">vim.filetree.nvimTree.setupOpts.git.timeout</code> + </a> + </span> +</dt> +<dd> +<p>Kills the git process after some time if it takes too long. +Git integration will be disabled after 10 git jobs exceed this timeout.</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">400</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.hijack_cursor"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.hijack_cursor"><code class="option">vim.filetree.nvimTree.setupOpts.hijack_cursor</code> + </a> + </span> +</dt> +<dd> +<p>Hijack the cursor in the tree to put it at the start of the filename</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.hijack_directories.enable"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.hijack_directories.enable"><code class="option">vim.filetree.nvimTree.setupOpts.hijack_directories.enable</code> + </a> + </span> +</dt> +<dd> +<p>Enable the <code class="literal">hijack_directories</code> feature. Disable this option if you use vim-dirvish or dirbuf.nvim. +If <code class="literal">hijack_netrw</code> and <code class="literal">disable_netrw</code> are <code class="literal">false</code>, this feature will be disabled.</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.hijack_directories.auto_open"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.hijack_directories.auto_open"><code class="option">vim.filetree.nvimTree.setupOpts.hijack_directories.auto_open</code> + </a> + </span> +</dt> +<dd> +<p>Opens the tree if the tree was previously closed.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.hijack_netrw"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.hijack_netrw"><code class="option">vim.filetree.nvimTree.setupOpts.hijack_netrw</code> + </a> + </span> +</dt> +<dd> +<p>Prevents netrw from automatically opening when opening directories</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.hijack_unnamed_buffer_when_opening"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.hijack_unnamed_buffer_when_opening"><code class="option">vim.filetree.nvimTree.setupOpts.hijack_unnamed_buffer_when_opening</code> + </a> + </span> +</dt> +<dd> +<p>Open nvimtree in place of the unnamed buffer if it’s empty.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.live_filter"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.live_filter"><code class="option">vim.filetree.nvimTree.setupOpts.live_filter</code> + </a> + </span> +</dt> +<dd> +<p>Configurations for the live_filtering feature. +The live filter allows you to filter the tree nodes dynamically, based on +regex matching (see <code class="literal">vim.regex</code>). +This feature is bound to the <code class="literal">f</code> key by default. +The filter can be cleared with the <code class="literal">F</code> key by default.</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.live_filter.always_show_folders"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.live_filter.always_show_folders"><code class="option">vim.filetree.nvimTree.setupOpts.live_filter.always_show_folders</code> + </a> + </span> +</dt> +<dd> +<p>Whether to filter folders or not.</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.live_filter.prefix"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.live_filter.prefix"><code class="option">vim.filetree.nvimTree.setupOpts.live_filter.prefix</code> + </a> + </span> +</dt> +<dd> +<p>Prefix of the filter displayed in the buffer.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"[FILTER]: "</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.modified"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.modified"><code class="option">vim.filetree.nvimTree.setupOpts.modified</code> + </a> + </span> +</dt> +<dd> +<p>Indicate which file have unsaved modification.</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.modified.enable"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.modified.enable"><code class="option">vim.filetree.nvimTree.setupOpts.modified.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Modified files with icons and color highlight…</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.modified.show_on_dirs"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.modified.show_on_dirs"><code class="option">vim.filetree.nvimTree.setupOpts.modified.show_on_dirs</code> + </a> + </span> +</dt> +<dd> +<p>Show modified icons on parent directories.</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.modified.show_on_open_dirs"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.modified.show_on_open_dirs"><code class="option">vim.filetree.nvimTree.setupOpts.modified.show_on_open_dirs</code> + </a> + </span> +</dt> +<dd> +<p>Show modified icons on directories that are open.</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.notify"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.notify"><code class="option">vim.filetree.nvimTree.setupOpts.notify</code> + </a> + </span> +</dt> +<dd> +<p>Configuration for notifications.</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.notify.absolute_path"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.notify.absolute_path"><code class="option">vim.filetree.nvimTree.setupOpts.notify.absolute_path</code> + </a> + </span> +</dt> +<dd> +<p>Whether to use absolute paths or item names in fs action notifications.</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.notify.threshold"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.notify.threshold"><code class="option">vim.filetree.nvimTree.setupOpts.notify.threshold</code> + </a> + </span> +</dt> +<dd> +<p>Specify minimum notification level, uses the values from <code class="literal">vim.log.levels</code></p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “ERROR”, “WARNING”, “INFO”, “DEBUG”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"INFO"</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.prefer_startup_root"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.prefer_startup_root"><code class="option">vim.filetree.nvimTree.setupOpts.prefer_startup_root</code> + </a> + </span> +</dt> +<dd> +<p>Prefer startup root directory when updating root directory of the tree. +Only relevant when <code class="literal">update_focused_file.update_root</code> is <code class="literal">true</code></p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.reload_on_bufenter"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.reload_on_bufenter"><code class="option">vim.filetree.nvimTree.setupOpts.reload_on_bufenter</code> + </a> + </span> +</dt> +<dd> +<p>Automatically reloads the tree on <code class="literal">BufEnter</code> nvim-tree.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.add_trailing"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.add_trailing"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.add_trailing</code> + </a> + </span> +</dt> +<dd> +<p>Appends a trailing slash to folder names.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.full_name"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.full_name"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.full_name</code> + </a> + </span> +</dt> +<dd> +<p>Display node whose name length is wider than the width of nvim-tree window in floating window.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.group_empty"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.group_empty"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.group_empty</code> + </a> + </span> +</dt> +<dd> +<p>Compact folders that only contain a single folder into one node in the file tree.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.highlight_git"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.highlight_git"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.highlight_git</code> + </a> + </span> +</dt> +<dd> +<p>Enable file highlight for git attributes using <code class="literal">NvimTreeGit</code> highlight groups. +Requires <code class="literal">nvimTree.git.enable</code> +This can be used with or without the icons.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.highlight_modified"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.highlight_modified"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.highlight_modified</code> + </a> + </span> +</dt> +<dd> +<p>Highlight modified files in the tree using <code class="literal">NvimTreeNormal</code> highlight group. +Requires <code class="literal">nvimTree.view.highlightOpenedFiles</code></p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “none”, “icon”, “name”, “all”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"none"</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.highlight_opened_files"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.highlight_opened_files"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.highlight_opened_files</code> + </a> + </span> +</dt> +<dd> +<p>Highlight icons and/or names for bufloaded() files using the +<code class="literal">NvimTreeOpenedFile</code> highlight group.</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “none”, “icon”, “name”, “all”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"none"</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.icons"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.icons"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.icons</code> + </a> + </span> +</dt> +<dd> +<p>Configuration options for icons.</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.icons.git_placement"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.icons.git_placement"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.icons.git_placement</code> + </a> + </span> +</dt> +<dd> +<p>Place where the git icons will be rendered. <code class="literal">signcolumn</code> requires <code class="literal">view.signcolumn</code> to be enabled.</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “before”, “after”, “signcolumn”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"before"</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.icons.glyphs"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.icons.glyphs"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.icons.glyphs</code> + </a> + </span> +</dt> +<dd> +<p>Configuration options for icon glyphs. +NOTE: Do not set any glyphs to more than two characters if it’s going +to appear in the signcolumn.</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.icons.glyphs.default"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.icons.glyphs.default"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.icons.glyphs.default</code> + </a> + </span> +</dt> +<dd> +<p>Glyph for files. Will be overridden by <code class="literal">nvim-web-devicons</code> if available.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">""</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.icons.glyphs.folder"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.icons.glyphs.folder"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.icons.glyphs.folder</code> + </a> + </span> +</dt> +<dd> +<p>Glyphs for directories. Recommended to use the defaults unless you know what you are doing.</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + arrow_closed = ""; + arrow_open = ""; + default = ""; + empty = ""; + empty_open = ""; + open = ""; + symlink = ""; + symlink_open = ""; +} +</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.icons.glyphs.git"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.icons.glyphs.git"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.icons.glyphs.git</code> + </a> + </span> +</dt> +<dd> +<p>Glyphs for git status.</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + deleted = ""; + ignored = "◌"; + renamed = "➜"; + staged = "✓"; + unmerged = ""; + unstaged = "✗"; + untracked = "★"; +} +</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.icons.glyphs.modified"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.icons.glyphs.modified"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.icons.glyphs.modified</code> + </a> + </span> +</dt> +<dd> +<p>Icon to display for modified files.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">""</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.icons.glyphs.symlink"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.icons.glyphs.symlink"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.icons.glyphs.symlink</code> + </a> + </span> +</dt> +<dd> +<p>Glyph for symlinks.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">""</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.icons.modified_placement"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.icons.modified_placement"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.icons.modified_placement</code> + </a> + </span> +</dt> +<dd> +<p>Place where the modified icons will be rendered. <code class="literal">signcolumn</code> requires <code class="literal">view.signcolumn</code> to be enabled.</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “before”, “after”, “signcolumn”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"after"</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.icons.padding"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.icons.padding"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.icons.padding</code> + </a> + </span> +</dt> +<dd> +<p>Inserted between icon and filename</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.icons.show.file"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.icons.show.file"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.icons.show.file</code> + </a> + </span> +</dt> +<dd> +<p>Show an icon before the file name. <code class="literal">nvim-web-devicons</code> will be used if available.</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.icons.show.folder"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.icons.show.folder"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.icons.show.folder</code> + </a> + </span> +</dt> +<dd> +<p>Show an icon before the folder name.</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.icons.show.folder_arrow"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.icons.show.folder_arrow"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.icons.show.folder_arrow</code> + </a> + </span> +</dt> +<dd> +<p>Show a small arrow before the folder node. Arrow will be a part of the +node when using <code class="literal">renderer.indent_markers</code>.</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.icons.show.git"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.icons.show.git"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.icons.show.git</code> + </a> + </span> +</dt> +<dd> +<p>Show a git status icon, see <code class="literal">renderer.icons.gitPlacement</code> +Requires <code class="literal">git.enable</code> to be true.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.icons.show.modified"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.icons.show.modified"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.icons.show.modified</code> + </a> + </span> +</dt> +<dd> +<p>Show a modified icon, see <code class="literal">renderer.icons.modifiedPlacement</code> +Requires <code class="literal">modified.enable</code> to be true.</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.icons.symlink_arrow"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.icons.symlink_arrow"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.icons.symlink_arrow</code> + </a> + </span> +</dt> +<dd> +<p>Used as a separator between symlinks’ source and target.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" ➛ "</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.icons.webdev_colors"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.icons.webdev_colors"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.icons.webdev_colors</code> + </a> + </span> +</dt> +<dd> +<p>Use the webdev icon colors, otherwise <code class="literal">NvimTreeFileIcon</code></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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.indent_markers"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.indent_markers"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.indent_markers</code> + </a> + </span> +</dt> +<dd> +<p>Configuration options for tree indent markers.</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.indent_markers.enable"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.indent_markers.enable"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.indent_markers.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Display indent markers when folders are open…</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.indent_markers.icons"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.indent_markers.icons"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.indent_markers.icons</code> + </a> + </span> +</dt> +<dd> +<p>Individual elements of the indent markers</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + bottom = "─"; + corner = "└"; + edge = "│"; + item = "│"; + none = ""; +} +</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.indent_markers.inline_arrows"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.indent_markers.inline_arrows"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.indent_markers.inline_arrows</code> + </a> + </span> +</dt> +<dd> +<p>Display folder arrows in the same column as indent marker when using <code class="literal">renderer.icons.show.folder_arrow</code></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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.indent_width"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.indent_width"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.indent_width</code> + </a> + </span> +</dt> +<dd> +<p>Number of spaces for an each tree nesting level. Minimum 1.</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">2</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.root_folder_label"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.root_folder_label"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.root_folder_label</code> + </a> + </span> +</dt> +<dd> +<p>In what format to show root folder. See <code class="literal">:help filename-modifiers</code> for +available <code class="literal">string</code> options. +Set to <code class="literal">false</code> to hide the root folder.</p><p>Function is passed the absolute path of the root folder and should +return a string. e.g. +my_root_folder_label = function(path) +return “…/” … vim.fn.fnamemodify(path, “:t”) +end</p> + +<p><span class="emphasis"><em>Type:</em></span> +string or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"\"\":~:s?$?/..?\""</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.special_files"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.special_files"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.special_files</code> + </a> + </span> +</dt> +<dd> +<p>A list of filenames that gets highlighted with `NvimTreeSpecialFile</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "Cargo.toml" + "README.md" + "readme.md" + "Makefile" + "MAKEFILE" + "flake.nix" +] +</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.renderer.symlink_destination"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.renderer.symlink_destination"><code class="option">vim.filetree.nvimTree.setupOpts.renderer.symlink_destination</code> + </a> + </span> +</dt> +<dd> +<p>Whether to show the destination of the symlink.</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.respect_buf_cwd"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.respect_buf_cwd"><code class="option">vim.filetree.nvimTree.setupOpts.respect_buf_cwd</code> + </a> + </span> +</dt> +<dd> +<p>Will change cwd of nvim-tree to that of new buffer’s when opening nvim-tree.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.root_dirs"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.root_dirs"><code class="option">vim.filetree.nvimTree.setupOpts.root_dirs</code> + </a> + </span> +</dt> +<dd> +<p>Preferred root directories. Only relevant when <code class="literal">updateFocusedFile.updateRoot</code> is <code class="literal">true</code></p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.select_prompts"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.select_prompts"><code class="option">vim.filetree.nvimTree.setupOpts.select_prompts</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Use <code class="literal">vim.ui.select</code> style prompts. Necessary when using a UI prompt decorator such as dressing.nvim or telescope-ui-select.nvim +.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.sort.folders_first"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.sort.folders_first"><code class="option">vim.filetree.nvimTree.setupOpts.sort.folders_first</code> + </a> + </span> +</dt> +<dd> +<p>Sort folders before files. Has no effect when <code class="literal">sort.sorter</code> is a function.</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.sort.sorter"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.sort.sorter"><code class="option">vim.filetree.nvimTree.setupOpts.sort.sorter</code> + </a> + </span> +</dt> +<dd> +<p>How files within the same directory are sorted.</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “name”, “extension”, “modification_time”, “case_sensitive”, “suffix”, “filetype”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"name"</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.sync_root_with_cwd"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.sync_root_with_cwd"><code class="option">vim.filetree.nvimTree.setupOpts.sync_root_with_cwd</code> + </a> + </span> +</dt> +<dd> +<p>Changes the tree root directory on <code class="literal">DirChanged</code> and refreshes the tree. +Only relevant when <code class="literal">updateFocusedFile.updateRoot</code> is <code class="literal">true</code></p><p>(previously <code class="literal">update_cwd</code>)</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.system_open.args"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.system_open.args"><code class="option">vim.filetree.nvimTree.setupOpts.system_open.args</code> + </a> + </span> +</dt> +<dd> +<p>Optional argument list.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.system_open.cmd"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.system_open.cmd"><code class="option">vim.filetree.nvimTree.setupOpts.system_open.cmd</code> + </a> + </span> +</dt> +<dd> +<p>The open command itself</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"\${pkgs.xdg-utils}/bin/xdg-open"</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.tab"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.tab"><code class="option">vim.filetree.nvimTree.setupOpts.tab</code> + </a> + </span> +</dt> +<dd> +<p>Configuration for tab behaviour.</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.tab.sync"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.tab.sync"><code class="option">vim.filetree.nvimTree.setupOpts.tab.sync</code> + </a> + </span> +</dt> +<dd> +<p>Configuration for syncing nvim-tree across tabs.</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.tab.sync.close"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.tab.sync.close"><code class="option">vim.filetree.nvimTree.setupOpts.tab.sync.close</code> + </a> + </span> +</dt> +<dd> +<p>Closes the tree across all tabpages when the tree is closed.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.tab.sync.ignore"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.tab.sync.ignore"><code class="option">vim.filetree.nvimTree.setupOpts.tab.sync.ignore</code> + </a> + </span> +</dt> +<dd> +<p>List of filetypes or buffer names on new tab that will prevent +<code class="literal">nvimTree.tab.sync.open</code> and <code class="literal">nvimTree.tab.sync.close</code></p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.tab.sync.open"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.tab.sync.open"><code class="option">vim.filetree.nvimTree.setupOpts.tab.sync.open</code> + </a> + </span> +</dt> +<dd> +<p>Opens the tree automatically when switching tabpage or opening a new +tabpage if the tree was previously open.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.trash"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.trash"><code class="option">vim.filetree.nvimTree.setupOpts.trash</code> + </a> + </span> +</dt> +<dd> +<p>Configuration options for trashing.</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + cmd = "\${pkgs.glib}/bin/gio trash"; +} +</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.trash.cmd"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.trash.cmd"><code class="option">vim.filetree.nvimTree.setupOpts.trash.cmd</code> + </a> + </span> +</dt> +<dd> +<p>The command used to trash items</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.ui"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.ui"><code class="option">vim.filetree.nvimTree.setupOpts.ui</code> + </a> + </span> +</dt> +<dd> +<p>General UI configuration.</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.ui.confirm.remove"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.ui.confirm.remove"><code class="option">vim.filetree.nvimTree.setupOpts.ui.confirm.remove</code> + </a> + </span> +</dt> +<dd> +<p>Prompt before removing.</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.ui.confirm.trash"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.ui.confirm.trash"><code class="option">vim.filetree.nvimTree.setupOpts.ui.confirm.trash</code> + </a> + </span> +</dt> +<dd> +<p>Prompt before trash.</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.update_focused_file"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.update_focused_file"><code class="option">vim.filetree.nvimTree.setupOpts.update_focused_file</code> + </a> + </span> +</dt> +<dd> +<p>Update the focused file on <code class="literal">BufEnter</code>, un-collapses the folders recursively +until it finds the file.</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.update_focused_file.enable"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.update_focused_file.enable"><code class="option">vim.filetree.nvimTree.setupOpts.update_focused_file.enable</code> + </a> + </span> +</dt> +<dd> +<p>update focused file</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.update_focused_file.ignore_list"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.update_focused_file.ignore_list"><code class="option">vim.filetree.nvimTree.setupOpts.update_focused_file.ignore_list</code> + </a> + </span> +</dt> +<dd> +<p>List of buffer names and filetypes that will not update the root dir +of the tree if the file isn’t found under the current root directory. +Only relevant when <code class="literal">update_focused_file.update_root</code> and +<code class="literal">update_focused_file.enable</code> are <code class="literal">true</code>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.update_focused_file.update_root"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.update_focused_file.update_root"><code class="option">vim.filetree.nvimTree.setupOpts.update_focused_file.update_root</code> + </a> + </span> +</dt> +<dd> +<p>Update the root directory of the tree if the file is not under current +root directory. It prefers vim’s cwd and <code class="literal">root_dirs</code>. +Otherwise it falls back to the folder containing the file. +Only relevant when <code class="literal">update_focused_file.enable</code> is <code class="literal">true</code></p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.view"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.view"><code class="option">vim.filetree.nvimTree.setupOpts.view</code> + </a> + </span> +</dt> +<dd> +<p>Window / buffer setup.</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.view.centralize_selection"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.view.centralize_selection"><code class="option">vim.filetree.nvimTree.setupOpts.view.centralize_selection</code> + </a> + </span> +</dt> +<dd> +<p>If true, reposition the view so that the current node is initially centralized when entering nvim-tree.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.view.cursorline"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.view.cursorline"><code class="option">vim.filetree.nvimTree.setupOpts.view.cursorline</code> + </a> + </span> +</dt> +<dd> +<p>Enable cursorline in nvim-tree window.</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.view.debounce_delay"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.view.debounce_delay"><code class="option">vim.filetree.nvimTree.setupOpts.view.debounce_delay</code> + </a> + </span> +</dt> +<dd> +<p>Idle milliseconds before some reload / refresh operations. +Increase if you experience performance issues around screen refresh.</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">15</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.view.float"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.view.float"><code class="option">vim.filetree.nvimTree.setupOpts.view.float</code> + </a> + </span> +</dt> +<dd> +<p>Configuration options for floating window.</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.view.float.enable"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.view.float.enable"><code class="option">vim.filetree.nvimTree.setupOpts.view.float.enable</code> + </a> + </span> +</dt> +<dd> +<p>If true, tree window will be floating.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.view.float.open_win_config"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.view.float.open_win_config"><code class="option">vim.filetree.nvimTree.setupOpts.view.float.open_win_config</code> + </a> + </span> +</dt> +<dd> +<p>Floating window config. See <code class="literal">:h nvim_open_win()</code> for more details.</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + border = "rounded"; + col = 1; + height = 30; + relative = "editor"; + row = 1; + width = 30; +} +</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.view.float.quit_on_focus_loss"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.view.float.quit_on_focus_loss"><code class="option">vim.filetree.nvimTree.setupOpts.view.float.quit_on_focus_loss</code> + </a> + </span> +</dt> +<dd> +<p>Close the floating tree window when it loses focus.</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.view.number"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.view.number"><code class="option">vim.filetree.nvimTree.setupOpts.view.number</code> + </a> + </span> +</dt> +<dd> +<p>Print the line number in front of each line.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.view.preserve_window_proportions"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.view.preserve_window_proportions"><code class="option">vim.filetree.nvimTree.setupOpts.view.preserve_window_proportions</code> + </a> + </span> +</dt> +<dd> +<p>Preserves window proportions when opening a file. +If <code class="literal">false</code>, the height and width of windows other than nvim-tree will be equalized.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.view.relativenumber"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.view.relativenumber"><code class="option">vim.filetree.nvimTree.setupOpts.view.relativenumber</code> + </a> + </span> +</dt> +<dd> +<p>Show the line number relative to the line with the cursor in front of each line. +If the option <code class="literal">view.number</code> is also <code class="literal">true</code>, the number on the cursor line +will be the line number instead of <code class="literal">0</code>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.view.side"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.view.side"><code class="option">vim.filetree.nvimTree.setupOpts.view.side</code> + </a> + </span> +</dt> +<dd> +<p>Side of the tree.</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “left”, “right”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"left"</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.view.signcolumn"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.view.signcolumn"><code class="option">vim.filetree.nvimTree.setupOpts.view.signcolumn</code> + </a> + </span> +</dt> +<dd> +<p>Show diagnostic sign column. Value can be <code class="literal">"yes"</code>, <code class="literal">"auto"</code> or<code class="literal">"no"</code>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “yes”, “auto”, “no”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"yes"</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.filetree.nvimTree.setupOpts.view.width"></a><a class="term" href="options.html#opt-vim.filetree.nvimTree.setupOpts.view.width"><code class="option">vim.filetree.nvimTree.setupOpts.view.width</code> + </a> + </span> +</dt> +<dd> +<p>Width of the window: can be a <code class="literal">%</code> string, a number representing columns, a +function or a table.</p><p>A table (an attribute set in our case, see example) indicates that the view should be dynamically sized based on the +longest line.</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer or (attribute set)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">30</code></p> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">{ + min = 30; + max = -1; + padding = 1; +} + +</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/plugins/filetree/nvimtree/nvimtree.nix" target="_top"> +<nvf/modules/plugins/filetree/nvimtree/nvimtree.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.fzf-lua.enable"></a><a class="term" href="options.html#opt-vim.fzf-lua.enable"><code class="option">vim.fzf-lua.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable fzf-lua.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/utility/fzf-lua/fzf-lua.nix" target="_top"> +<nvf/modules/plugins/utility/fzf-lua/fzf-lua.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.fzf-lua.profile"></a><a class="term" href="options.html#opt-vim.fzf-lua.profile"><code class="option">vim.fzf-lua.profile</code> + </a> + </span> +</dt> +<dd> +<p>The configuration profile to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “default”, “default-title”, “fzf-native”, “fzf-tmux”, “fzf-vim”, “max-perf”, “telescope”, “skim”, “borderless”, “borderless-full”, “border-fused”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"default"</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/plugins/utility/fzf-lua/fzf-lua.nix" target="_top"> +<nvf/modules/plugins/utility/fzf-lua/fzf-lua.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.fzf-lua.setupOpts"></a><a class="term" href="options.html#opt-vim.fzf-lua.setupOpts"><code class="option">vim.fzf-lua.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of fzf-lua</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/utility/fzf-lua/fzf-lua.nix" target="_top"> +<nvf/modules/plugins/utility/fzf-lua/fzf-lua.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.fzf-lua.setupOpts.winopts.border"></a><a class="term" href="options.html#opt-vim.fzf-lua.setupOpts.winopts.border"><code class="option">vim.fzf-lua.setupOpts.winopts.border</code> + </a> + </span> +</dt> +<dd> +<p>Border type for the fzf-lua picker window</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “none”, “single”, “double”, “rounded”, “solid”, “shadow” or list of (string or list of string)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"rounded"</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/plugins/utility/fzf-lua/fzf-lua.nix" target="_top"> +<nvf/modules/plugins/utility/fzf-lua/fzf-lua.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.gestures.gesture-nvim.enable"></a><a class="term" href="options.html#opt-vim.gestures.gesture-nvim.enable"><code class="option">vim.gestures.gesture-nvim.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable gesture-nvim: mouse gestures.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/utility/gestures/gesture-nvim/gesture-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/gestures/gesture-nvim/gesture-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.gestures.gesture-nvim.mappings.draw"></a><a class="term" href="options.html#opt-vim.gestures.gesture-nvim.mappings.draw"><code class="option">vim.gestures.gesture-nvim.mappings.draw</code> + </a> + </span> +</dt> +<dd> +<p>Start drawing [gesture.nvim]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<LeftDrag>"</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/plugins/utility/gestures/gesture-nvim/gesture-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/gestures/gesture-nvim/gesture-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.gestures.gesture-nvim.mappings.finish"></a><a class="term" href="options.html#opt-vim.gestures.gesture-nvim.mappings.finish"><code class="option">vim.gestures.gesture-nvim.mappings.finish</code> + </a> + </span> +</dt> +<dd> +<p>Finish drawing [gesture.nvim]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<LeftRelease>"</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/plugins/utility/gestures/gesture-nvim/gesture-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/gestures/gesture-nvim/gesture-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.git.enable"></a><a class="term" href="options.html#opt-vim.git.enable"><code class="option">vim.git.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable git integration suite.</p><p>Enabling this option will enable the following plugins:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>gitsigns</p></li><li class="listitem"><p>vim-fugitive +.</p></li></ul></div> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/git" target="_top"> +<nvf/modules/plugins/git> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.git.gitsigns.enable"></a><a class="term" href="options.html#opt-vim.git.gitsigns.enable"><code class="option">vim.git.gitsigns.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable gitsigns.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/git/gitsigns/gitsigns.nix" target="_top"> +<nvf/modules/plugins/git/gitsigns/gitsigns.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.git.gitsigns.codeActions.enable"></a><a class="term" href="options.html#opt-vim.git.gitsigns.codeActions.enable"><code class="option">vim.git.gitsigns.codeActions.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable gitsigns codeactions through null-ls.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/git/gitsigns/gitsigns.nix" target="_top"> +<nvf/modules/plugins/git/gitsigns/gitsigns.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.git.gitsigns.mappings.blameLine"></a><a class="term" href="options.html#opt-vim.git.gitsigns.mappings.blameLine"><code class="option">vim.git.gitsigns.mappings.blameLine</code> + </a> + </span> +</dt> +<dd> +<p>Blame line [Gitsigns]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>hb"</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/plugins/git/gitsigns/gitsigns.nix" target="_top"> +<nvf/modules/plugins/git/gitsigns/gitsigns.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.git.gitsigns.mappings.diffProject"></a><a class="term" href="options.html#opt-vim.git.gitsigns.mappings.diffProject"><code class="option">vim.git.gitsigns.mappings.diffProject</code> + </a> + </span> +</dt> +<dd> +<p>Diff project [Gitsigns]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>hD"</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/plugins/git/gitsigns/gitsigns.nix" target="_top"> +<nvf/modules/plugins/git/gitsigns/gitsigns.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.git.gitsigns.mappings.diffThis"></a><a class="term" href="options.html#opt-vim.git.gitsigns.mappings.diffThis"><code class="option">vim.git.gitsigns.mappings.diffThis</code> + </a> + </span> +</dt> +<dd> +<p>Diff this [Gitsigns]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>hd"</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/plugins/git/gitsigns/gitsigns.nix" target="_top"> +<nvf/modules/plugins/git/gitsigns/gitsigns.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.git.gitsigns.mappings.nextHunk"></a><a class="term" href="options.html#opt-vim.git.gitsigns.mappings.nextHunk"><code class="option">vim.git.gitsigns.mappings.nextHunk</code> + </a> + </span> +</dt> +<dd> +<p>Next hunk [Gitsigns]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"]c"</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/plugins/git/gitsigns/gitsigns.nix" target="_top"> +<nvf/modules/plugins/git/gitsigns/gitsigns.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.git.gitsigns.mappings.previewHunk"></a><a class="term" href="options.html#opt-vim.git.gitsigns.mappings.previewHunk"><code class="option">vim.git.gitsigns.mappings.previewHunk</code> + </a> + </span> +</dt> +<dd> +<p>Preview hunk [Gitsigns]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>hP"</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/plugins/git/gitsigns/gitsigns.nix" target="_top"> +<nvf/modules/plugins/git/gitsigns/gitsigns.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.git.gitsigns.mappings.previousHunk"></a><a class="term" href="options.html#opt-vim.git.gitsigns.mappings.previousHunk"><code class="option">vim.git.gitsigns.mappings.previousHunk</code> + </a> + </span> +</dt> +<dd> +<p>Previous hunk [Gitsigns]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"[c"</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/plugins/git/gitsigns/gitsigns.nix" target="_top"> +<nvf/modules/plugins/git/gitsigns/gitsigns.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.git.gitsigns.mappings.resetBuffer"></a><a class="term" href="options.html#opt-vim.git.gitsigns.mappings.resetBuffer"><code class="option">vim.git.gitsigns.mappings.resetBuffer</code> + </a> + </span> +</dt> +<dd> +<p>Reset buffer [Gitsigns]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>hR"</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/plugins/git/gitsigns/gitsigns.nix" target="_top"> +<nvf/modules/plugins/git/gitsigns/gitsigns.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.git.gitsigns.mappings.resetHunk"></a><a class="term" href="options.html#opt-vim.git.gitsigns.mappings.resetHunk"><code class="option">vim.git.gitsigns.mappings.resetHunk</code> + </a> + </span> +</dt> +<dd> +<p>Reset hunk [Gitsigns]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>hr"</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/plugins/git/gitsigns/gitsigns.nix" target="_top"> +<nvf/modules/plugins/git/gitsigns/gitsigns.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.git.gitsigns.mappings.stageBuffer"></a><a class="term" href="options.html#opt-vim.git.gitsigns.mappings.stageBuffer"><code class="option">vim.git.gitsigns.mappings.stageBuffer</code> + </a> + </span> +</dt> +<dd> +<p>Stage buffer [Gitsigns]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>hS"</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/plugins/git/gitsigns/gitsigns.nix" target="_top"> +<nvf/modules/plugins/git/gitsigns/gitsigns.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.git.gitsigns.mappings.stageHunk"></a><a class="term" href="options.html#opt-vim.git.gitsigns.mappings.stageHunk"><code class="option">vim.git.gitsigns.mappings.stageHunk</code> + </a> + </span> +</dt> +<dd> +<p>Stage hunk [Gitsigns]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>hs"</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/plugins/git/gitsigns/gitsigns.nix" target="_top"> +<nvf/modules/plugins/git/gitsigns/gitsigns.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.git.gitsigns.mappings.toggleBlame"></a><a class="term" href="options.html#opt-vim.git.gitsigns.mappings.toggleBlame"><code class="option">vim.git.gitsigns.mappings.toggleBlame</code> + </a> + </span> +</dt> +<dd> +<p>Toggle blame [Gitsigns]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>tb"</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/plugins/git/gitsigns/gitsigns.nix" target="_top"> +<nvf/modules/plugins/git/gitsigns/gitsigns.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.git.gitsigns.mappings.toggleDeleted"></a><a class="term" href="options.html#opt-vim.git.gitsigns.mappings.toggleDeleted"><code class="option">vim.git.gitsigns.mappings.toggleDeleted</code> + </a> + </span> +</dt> +<dd> +<p>Toggle deleted [Gitsigns]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>td"</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/plugins/git/gitsigns/gitsigns.nix" target="_top"> +<nvf/modules/plugins/git/gitsigns/gitsigns.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.git.gitsigns.mappings.undoStageHunk"></a><a class="term" href="options.html#opt-vim.git.gitsigns.mappings.undoStageHunk"><code class="option">vim.git.gitsigns.mappings.undoStageHunk</code> + </a> + </span> +</dt> +<dd> +<p>Undo stage hunk [Gitsigns]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>hu"</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/plugins/git/gitsigns/gitsigns.nix" target="_top"> +<nvf/modules/plugins/git/gitsigns/gitsigns.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.git.gitsigns.setupOpts"></a><a class="term" href="options.html#opt-vim.git.gitsigns.setupOpts"><code class="option">vim.git.gitsigns.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of gitsigns</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/git/gitsigns/gitsigns.nix" target="_top"> +<nvf/modules/plugins/git/gitsigns/gitsigns.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.git.vim-fugitive.enable"></a><a class="term" href="options.html#opt-vim.git.vim-fugitive.enable"><code class="option">vim.git.vim-fugitive.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable vim-fugitive.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/git/vim-fugitive/vim-fugitive.nix" target="_top"> +<nvf/modules/plugins/git/vim-fugitive/vim-fugitive.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.globals"></a><a class="term" href="options.html#opt-vim.globals"><code class="option">vim.globals</code> + </a> + </span> +</dt> +<dd> +<p>A freeform attribute set containing global variable values for setting vim +variables as early as possible. If populated, this option will set vim variables +in the built <code class="option">luaConfigRC</code> as the first item.</p><div class="note"><h3 class="title">Note</h3><p><code class="literal">{foo = "bar";}</code> will set <code class="literal">vim.g.foo</code> to “bar”, where the type of <code class="literal">bar</code> in the +resulting Lua value will be inferred from the type of the value in the +<code class="literal">{name = value;}</code> pair passed to the option.</p></div> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</code></p> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">{ + some_variable = 42; +} +</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"> +<nvf/modules/wrapper/rc/options.nix> +</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> +<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"> +<nvf/modules/wrapper/rc/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.globals.mapleader"></a><a class="term" href="options.html#opt-vim.globals.mapleader"><code class="option">vim.globals.mapleader</code> + </a> + </span> +</dt> +<dd> +<p>The key used for <code class="literal"><leader></code> mappings</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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"> +<nvf/modules/wrapper/rc/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.globals.maplocalleader"></a><a class="term" href="options.html#opt-vim.globals.maplocalleader"><code class="option">vim.globals.maplocalleader</code> + </a> + </span> +</dt> +<dd> +<p>The key used for <code class="literal"><localleader></code> mappings</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">","</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"> +<nvf/modules/wrapper/rc/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.hideSearchHighlight"></a><a class="term" href="options.html#opt-vim.hideSearchHighlight"><code class="option">vim.hideSearchHighlight</code> + </a> + </span> +</dt> +<dd> +<p>Hide search highlight so it doesn’t stay highlighted</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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"> +<nvf/modules/neovim/init/basic.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.keymaps"></a><a class="term" href="options.html#opt-vim.keymaps"><code class="option">vim.keymaps</code> + </a> + </span> +</dt> +<dd> +<p>Custom keybindings.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of (submodule)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</code></p> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">'' + vim.keymaps = [ + { + key = "<leader>m"; + mode = "n"; + silent = true; + action = ":make<CR>"; + } + { + key = "<leader>l"; + mode = ["n" "x"]; + silent = true; + action = "<cmd>cnext<CR>"; + } + ]; +'' +</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/neovim/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.keymaps._.action"></a><a class="term" href="options.html#opt-vim.keymaps._.action"><code class="option">vim.keymaps.*.action</code> + </a> + </span> +</dt> +<dd> +<p>The command to execute.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.keymaps._.desc"></a><a class="term" href="options.html#opt-vim.keymaps._.desc"><code class="option">vim.keymaps.*.desc</code> + </a> + </span> +</dt> +<dd> +<p>A description of this keybind, to be shown in which-key, if you have it enabled.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.keymaps._.expr"></a><a class="term" href="options.html#opt-vim.keymaps._.expr"><code class="option">vim.keymaps.*.expr</code> + </a> + </span> +</dt> +<dd> +<p>Means that the action is actually an expression. Equivalent to adding <expr> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.keymaps._.key"></a><a class="term" href="options.html#opt-vim.keymaps._.key"><code class="option">vim.keymaps.*.key</code> + </a> + </span> +</dt> +<dd> +<p>The key that triggers this keybind.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.keymaps._.lua"></a><a class="term" href="options.html#opt-vim.keymaps._.lua"><code class="option">vim.keymaps.*.lua</code> + </a> + </span> +</dt> +<dd> +<p>If true, <code class="literal">action</code> is considered to be lua code. +Thus, it will not be wrapped in <code class="literal">""</code>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.keymaps._.mode"></a><a class="term" href="options.html#opt-vim.keymaps._.mode"><code class="option">vim.keymaps.*.mode</code> + </a> + </span> +</dt> +<dd> +<p>The short-name of the mode to set the keymapping for. Passing an empty string is the equivalent of <code class="literal">:map</code>.</p><p>See <code class="literal">:help map-modes</code> for a list of modes.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string or list of string</p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">["n" "v" "c"]</code> for normal, visual and command mode</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.keymaps._.noremap"></a><a class="term" href="options.html#opt-vim.keymaps._.noremap"><code class="option">vim.keymaps.*.noremap</code> + </a> + </span> +</dt> +<dd> +<p>Whether to use the ‘noremap’ variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.keymaps._.nowait"></a><a class="term" href="options.html#opt-vim.keymaps._.nowait"><code class="option">vim.keymaps.*.nowait</code> + </a> + </span> +</dt> +<dd> +<p>Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.keymaps._.script"></a><a class="term" href="options.html#opt-vim.keymaps._.script"><code class="option">vim.keymaps.*.script</code> + </a> + </span> +</dt> +<dd> +<p>Equivalent to adding <script> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.keymaps._.silent"></a><a class="term" href="options.html#opt-vim.keymaps._.silent"><code class="option">vim.keymaps.*.silent</code> + </a> + </span> +</dt> +<dd> +<p>Whether this mapping should be silent. Equivalent to adding <silent> to a map.</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.keymaps._.unique"></a><a class="term" href="options.html#opt-vim.keymaps._.unique"><code class="option">vim.keymaps.*.unique</code> + </a> + </span> +</dt> +<dd> +<p>Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.enableDAP"></a><a class="term" href="options.html#opt-vim.languages.enableDAP"><code class="option">vim.languages.enableDAP</code> + </a> + </span> +</dt> +<dd> +<p>Turn on Debug Adapter for enabled languages by default</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/languages" target="_top"> +<nvf/modules/plugins/languages> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.enableExtraDiagnostics"></a><a class="term" href="options.html#opt-vim.languages.enableExtraDiagnostics"><code class="option">vim.languages.enableExtraDiagnostics</code> + </a> + </span> +</dt> +<dd> +<p>Turn on extra diagnostics for enabled languages by default</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/languages" target="_top"> +<nvf/modules/plugins/languages> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.enableFormat"></a><a class="term" href="options.html#opt-vim.languages.enableFormat"><code class="option">vim.languages.enableFormat</code> + </a> + </span> +</dt> +<dd> +<p>Turn on Formatting for enabled languages by default</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/languages" target="_top"> +<nvf/modules/plugins/languages> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.enableLSP"></a><a class="term" href="options.html#opt-vim.languages.enableLSP"><code class="option">vim.languages.enableLSP</code> + </a> + </span> +</dt> +<dd> +<p>Turn on LSP for enabled languages by default</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/languages" target="_top"> +<nvf/modules/plugins/languages> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.enableTreesitter"></a><a class="term" href="options.html#opt-vim.languages.enableTreesitter"><code class="option">vim.languages.enableTreesitter</code> + </a> + </span> +</dt> +<dd> +<p>Turn on Treesitter for enabled languages by default</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/languages" target="_top"> +<nvf/modules/plugins/languages> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.assembly.enable"></a><a class="term" href="options.html#opt-vim.languages.assembly.enable"><code class="option">vim.languages.assembly.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Assembly support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/asm.nix" target="_top"> +<nvf/modules/plugins/languages/asm.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.assembly.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.assembly.lsp.enable"><code class="option">vim.languages.assembly.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Assembly LSP support (asm-lsp).</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/asm.nix" target="_top"> +<nvf/modules/plugins/languages/asm.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.assembly.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.assembly.lsp.package"><code class="option">vim.languages.assembly.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>asm-lsp package</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation asm-lsp-0.9.0></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/plugins/languages/asm.nix" target="_top"> +<nvf/modules/plugins/languages/asm.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.assembly.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.assembly.treesitter.enable"><code class="option">vim.languages.assembly.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Assembly treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/asm.nix" target="_top"> +<nvf/modules/plugins/languages/asm.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.assembly.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.assembly.treesitter.package"><code class="option">vim.languages.assembly.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The asm treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.asm</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/plugins/languages/asm.nix" target="_top"> +<nvf/modules/plugins/languages/asm.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.astro.enable"></a><a class="term" href="options.html#opt-vim.languages.astro.enable"><code class="option">vim.languages.astro.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Astro language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/astro.nix" target="_top"> +<nvf/modules/plugins/languages/astro.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.astro.extraDiagnostics.enable"></a><a class="term" href="options.html#opt-vim.languages.astro.extraDiagnostics.enable"><code class="option">vim.languages.astro.extraDiagnostics.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable extra Astro diagnostics.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/astro.nix" target="_top"> +<nvf/modules/plugins/languages/astro.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.astro.extraDiagnostics.types"></a><a class="term" href="options.html#opt-vim.languages.astro.extraDiagnostics.types"><code class="option">vim.languages.astro.extraDiagnostics.types</code> + </a> + </span> +</dt> +<dd> +<p>List of Astro diagnostics to enable</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of (value “eslint_d” (singular enum) or (submodule))</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "eslint_d" +] +</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/plugins/languages/astro.nix" target="_top"> +<nvf/modules/plugins/languages/astro.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.astro.format.enable"></a><a class="term" href="options.html#opt-vim.languages.astro.format.enable"><code class="option">vim.languages.astro.format.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Astro formatting.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/astro.nix" target="_top"> +<nvf/modules/plugins/languages/astro.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.astro.format.package"></a><a class="term" href="options.html#opt-vim.languages.astro.format.package"><code class="option">vim.languages.astro.format.package</code> + </a> + </span> +</dt> +<dd> +<p>Astro formatter package</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation prettier-3.3.3></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/plugins/languages/astro.nix" target="_top"> +<nvf/modules/plugins/languages/astro.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.astro.format.type"></a><a class="term" href="options.html#opt-vim.languages.astro.format.type"><code class="option">vim.languages.astro.format.type</code> + </a> + </span> +</dt> +<dd> +<p>Astro formatter to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “biome”, “prettier”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"prettier"</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/plugins/languages/astro.nix" target="_top"> +<nvf/modules/plugins/languages/astro.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.astro.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.astro.lsp.enable"><code class="option">vim.languages.astro.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Astro LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/astro.nix" target="_top"> +<nvf/modules/plugins/languages/astro.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.astro.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.astro.lsp.package"><code class="option">vim.languages.astro.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>Astro LSP server package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation astro-language-server-2.15.4></code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"[lib.getExe pkgs.astro-language-server \"--minify\" \"--stdio\"]"</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/plugins/languages/astro.nix" target="_top"> +<nvf/modules/plugins/languages/astro.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.astro.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.astro.lsp.server"><code class="option">vim.languages.astro.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>Astro LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “astro” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"astro"</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/plugins/languages/astro.nix" target="_top"> +<nvf/modules/plugins/languages/astro.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.astro.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.astro.treesitter.enable"><code class="option">vim.languages.astro.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Astro treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/astro.nix" target="_top"> +<nvf/modules/plugins/languages/astro.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.astro.treesitter.astroPackage"></a><a class="term" href="options.html#opt-vim.languages.astro.treesitter.astroPackage"><code class="option">vim.languages.astro.treesitter.astroPackage</code> + </a> + </span> +</dt> +<dd> +<p>The astro treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.astro</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/plugins/languages/astro.nix" target="_top"> +<nvf/modules/plugins/languages/astro.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.bash.enable"></a><a class="term" href="options.html#opt-vim.languages.bash.enable"><code class="option">vim.languages.bash.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Bash language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/bash.nix" target="_top"> +<nvf/modules/plugins/languages/bash.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.bash.extraDiagnostics.enable"></a><a class="term" href="options.html#opt-vim.languages.bash.extraDiagnostics.enable"><code class="option">vim.languages.bash.extraDiagnostics.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable extra Bash diagnostics.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/bash.nix" target="_top"> +<nvf/modules/plugins/languages/bash.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.bash.extraDiagnostics.types"></a><a class="term" href="options.html#opt-vim.languages.bash.extraDiagnostics.types"><code class="option">vim.languages.bash.extraDiagnostics.types</code> + </a> + </span> +</dt> +<dd> +<p>List of Bash diagnostics to enable</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of (value “shellcheck” (singular enum) or (submodule))</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "shellcheck" +] +</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/plugins/languages/bash.nix" target="_top"> +<nvf/modules/plugins/languages/bash.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.bash.format.enable"></a><a class="term" href="options.html#opt-vim.languages.bash.format.enable"><code class="option">vim.languages.bash.format.enable</code> + </a> + </span> +</dt> +<dd> +<p>Enable Bash formatting</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/languages/bash.nix" target="_top"> +<nvf/modules/plugins/languages/bash.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.bash.format.package"></a><a class="term" href="options.html#opt-vim.languages.bash.format.package"><code class="option">vim.languages.bash.format.package</code> + </a> + </span> +</dt> +<dd> +<p>Bash formatter package</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation shfmt-3.10.0></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/plugins/languages/bash.nix" target="_top"> +<nvf/modules/plugins/languages/bash.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.bash.format.type"></a><a class="term" href="options.html#opt-vim.languages.bash.format.type"><code class="option">vim.languages.bash.format.type</code> + </a> + </span> +</dt> +<dd> +<p>Bash formatter to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “shfmt” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"shfmt"</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/plugins/languages/bash.nix" target="_top"> +<nvf/modules/plugins/languages/bash.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.bash.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.bash.lsp.enable"><code class="option">vim.languages.bash.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Enable Bash LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/bash.nix" target="_top"> +<nvf/modules/plugins/languages/bash.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.bash.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.bash.lsp.package"><code class="option">vim.languages.bash.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>bash-language-server package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation bash-language-server-5.4.0></code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">[lib.getExe pkgs.nodePackages.bash-language-server "start"]</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/plugins/languages/bash.nix" target="_top"> +<nvf/modules/plugins/languages/bash.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.bash.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.bash.lsp.server"><code class="option">vim.languages.bash.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>Bash LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “bash-ls” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"bash-ls"</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/plugins/languages/bash.nix" target="_top"> +<nvf/modules/plugins/languages/bash.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.bash.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.bash.treesitter.enable"><code class="option">vim.languages.bash.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Bash treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/bash.nix" target="_top"> +<nvf/modules/plugins/languages/bash.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.bash.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.bash.treesitter.package"><code class="option">vim.languages.bash.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The bash treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.bash</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/plugins/languages/bash.nix" target="_top"> +<nvf/modules/plugins/languages/bash.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.clang.enable"></a><a class="term" href="options.html#opt-vim.languages.clang.enable"><code class="option">vim.languages.clang.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable C/C++ language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/clang.nix" target="_top"> +<nvf/modules/plugins/languages/clang.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.clang.cHeader"></a><a class="term" href="options.html#opt-vim.languages.clang.cHeader"><code class="option">vim.languages.clang.cHeader</code> + </a> + </span> +</dt> +<dd> +<p>C syntax for headers. Can fix treesitter errors, see: +https://www.reddit.com/r/neovim/comments/orfpcd/question_does_the_c_parser_from_nvimtreesitter/</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/languages/clang.nix" target="_top"> +<nvf/modules/plugins/languages/clang.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.clang.dap.enable"></a><a class="term" href="options.html#opt-vim.languages.clang.dap.enable"><code class="option">vim.languages.clang.dap.enable</code> + </a> + </span> +</dt> +<dd> +<p>Enable clang Debug Adapter</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/languages/clang.nix" target="_top"> +<nvf/modules/plugins/languages/clang.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.clang.dap.package"></a><a class="term" href="options.html#opt-vim.languages.clang.dap.package"><code class="option">vim.languages.clang.dap.package</code> + </a> + </span> +</dt> +<dd> +<p>clang debugger package.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation lldb-19.1.5></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/plugins/languages/clang.nix" target="_top"> +<nvf/modules/plugins/languages/clang.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.clang.dap.debugger"></a><a class="term" href="options.html#opt-vim.languages.clang.dap.debugger"><code class="option">vim.languages.clang.dap.debugger</code> + </a> + </span> +</dt> +<dd> +<p>clang debugger to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “lldb-vscode” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"lldb-vscode"</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/plugins/languages/clang.nix" target="_top"> +<nvf/modules/plugins/languages/clang.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.clang.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.clang.lsp.enable"><code class="option">vim.languages.clang.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable clang LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/clang.nix" target="_top"> +<nvf/modules/plugins/languages/clang.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.clang.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.clang.lsp.package"><code class="option">vim.languages.clang.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>clang LSP server package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation clang-tools-19.1.5></code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"[lib.getExe pkgs.jdt-language-server \" - data \" \" ~/.cache/jdtls/workspace \"]"</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/plugins/languages/clang.nix" target="_top"> +<nvf/modules/plugins/languages/clang.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.clang.lsp.opts"></a><a class="term" href="options.html#opt-vim.languages.clang.lsp.opts"><code class="option">vim.languages.clang.lsp.opts</code> + </a> + </span> +</dt> +<dd> +<p>Options to pass to clang LSP server</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/languages/clang.nix" target="_top"> +<nvf/modules/plugins/languages/clang.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.clang.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.clang.lsp.server"><code class="option">vim.languages.clang.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>The clang LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “ccls”, “clangd”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"clangd"</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/plugins/languages/clang.nix" target="_top"> +<nvf/modules/plugins/languages/clang.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.clang.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.clang.treesitter.enable"><code class="option">vim.languages.clang.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable C/C++ treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/clang.nix" target="_top"> +<nvf/modules/plugins/languages/clang.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.clang.treesitter.cPackage"></a><a class="term" href="options.html#opt-vim.languages.clang.treesitter.cPackage"><code class="option">vim.languages.clang.treesitter.cPackage</code> + </a> + </span> +</dt> +<dd> +<p>The c treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.c</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/plugins/languages/clang.nix" target="_top"> +<nvf/modules/plugins/languages/clang.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.clang.treesitter.cppPackage"></a><a class="term" href="options.html#opt-vim.languages.clang.treesitter.cppPackage"><code class="option">vim.languages.clang.treesitter.cppPackage</code> + </a> + </span> +</dt> +<dd> +<p>The cpp treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.cpp</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/plugins/languages/clang.nix" target="_top"> +<nvf/modules/plugins/languages/clang.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.csharp.enable"></a><a class="term" href="options.html#opt-vim.languages.csharp.enable"><code class="option">vim.languages.csharp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable C# language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/csharp.nix" target="_top"> +<nvf/modules/plugins/languages/csharp.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.csharp.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.csharp.lsp.enable"><code class="option">vim.languages.csharp.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable C# LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/csharp.nix" target="_top"> +<nvf/modules/plugins/languages/csharp.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.csharp.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.csharp.lsp.package"><code class="option">vim.languages.csharp.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>C# LSP server package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation csharp-ls-0.16.0></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/plugins/languages/csharp.nix" target="_top"> +<nvf/modules/plugins/languages/csharp.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.csharp.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.csharp.lsp.server"><code class="option">vim.languages.csharp.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>C# LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “csharp_ls”, “omnisharp”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"csharp_ls"</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/plugins/languages/csharp.nix" target="_top"> +<nvf/modules/plugins/languages/csharp.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.csharp.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.csharp.treesitter.enable"><code class="option">vim.languages.csharp.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable C# treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/csharp.nix" target="_top"> +<nvf/modules/plugins/languages/csharp.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.csharp.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.csharp.treesitter.package"><code class="option">vim.languages.csharp.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The c-sharp treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.c-sharp</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/plugins/languages/csharp.nix" target="_top"> +<nvf/modules/plugins/languages/csharp.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.css.enable"></a><a class="term" href="options.html#opt-vim.languages.css.enable"><code class="option">vim.languages.css.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable CSS language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/css.nix" target="_top"> +<nvf/modules/plugins/languages/css.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.css.format.enable"></a><a class="term" href="options.html#opt-vim.languages.css.format.enable"><code class="option">vim.languages.css.format.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable CSS formatting.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/css.nix" target="_top"> +<nvf/modules/plugins/languages/css.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.css.format.package"></a><a class="term" href="options.html#opt-vim.languages.css.format.package"><code class="option">vim.languages.css.format.package</code> + </a> + </span> +</dt> +<dd> +<p>CSS formatter package</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation prettier-3.3.3></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/plugins/languages/css.nix" target="_top"> +<nvf/modules/plugins/languages/css.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.css.format.type"></a><a class="term" href="options.html#opt-vim.languages.css.format.type"><code class="option">vim.languages.css.format.type</code> + </a> + </span> +</dt> +<dd> +<p>CSS formatter to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “biome”, “prettier”, “prettierd”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"prettier"</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/plugins/languages/css.nix" target="_top"> +<nvf/modules/plugins/languages/css.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.css.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.css.lsp.enable"><code class="option">vim.languages.css.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable CSS LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/css.nix" target="_top"> +<nvf/modules/plugins/languages/css.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.css.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.css.lsp.package"><code class="option">vim.languages.css.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>CSS LSP server package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation vscode-langservers-extracted-4.10.0></code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"[lib.getExe pkgs.jdt-language-server \" - data \" \" ~/.cache/jdtls/workspace \"]"</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/plugins/languages/css.nix" target="_top"> +<nvf/modules/plugins/languages/css.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.css.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.css.lsp.server"><code class="option">vim.languages.css.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>CSS LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “vscode-langservers-extracted” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"vscode-langservers-extracted"</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/plugins/languages/css.nix" target="_top"> +<nvf/modules/plugins/languages/css.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.css.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.css.treesitter.enable"><code class="option">vim.languages.css.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable CSS treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/css.nix" target="_top"> +<nvf/modules/plugins/languages/css.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.css.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.css.treesitter.package"><code class="option">vim.languages.css.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The css treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.css</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/plugins/languages/css.nix" target="_top"> +<nvf/modules/plugins/languages/css.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.dart.enable"></a><a class="term" href="options.html#opt-vim.languages.dart.enable"><code class="option">vim.languages.dart.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Dart language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/dart.nix" target="_top"> +<nvf/modules/plugins/languages/dart.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.dart.dap.enable"></a><a class="term" href="options.html#opt-vim.languages.dart.dap.enable"><code class="option">vim.languages.dart.dap.enable</code> + </a> + </span> +</dt> +<dd> +<p>Enable Dart DAP support via flutter-tools</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/languages/dart.nix" target="_top"> +<nvf/modules/plugins/languages/dart.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.dart.flutter-tools.enable"></a><a class="term" href="options.html#opt-vim.languages.dart.flutter-tools.enable"><code class="option">vim.languages.dart.flutter-tools.enable</code> + </a> + </span> +</dt> +<dd> +<p>Enable flutter-tools for flutter support</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/languages/dart.nix" target="_top"> +<nvf/modules/plugins/languages/dart.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.dart.flutter-tools.enableNoResolvePatch"></a><a class="term" href="options.html#opt-vim.languages.dart.flutter-tools.enableNoResolvePatch"><code class="option">vim.languages.dart.flutter-tools.enableNoResolvePatch</code> + </a> + </span> +</dt> +<dd> +<p>Whether to patch flutter-tools so that it doesn’t resolve +symlinks when detecting flutter path.</p><p>This is required if you want to use a flutter package built with nix. +If you are using a flutter SDK installed from a different source +and encounter the error “<code class="literal">dart</code> missing from PATH”, disable this option.</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/plugins/languages/dart.nix" target="_top"> +<nvf/modules/plugins/languages/dart.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.dart.flutter-tools.color.enable"></a><a class="term" href="options.html#opt-vim.languages.dart.flutter-tools.color.enable"><code class="option">vim.languages.dart.flutter-tools.color.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable highlighting color variables.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/dart.nix" target="_top"> +<nvf/modules/plugins/languages/dart.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.dart.flutter-tools.color.highlightBackground"></a><a class="term" href="options.html#opt-vim.languages.dart.flutter-tools.color.highlightBackground"><code class="option">vim.languages.dart.flutter-tools.color.highlightBackground</code> + </a> + </span> +</dt> +<dd> +<p>Highlight the background</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/languages/dart.nix" target="_top"> +<nvf/modules/plugins/languages/dart.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.dart.flutter-tools.color.highlightForeground"></a><a class="term" href="options.html#opt-vim.languages.dart.flutter-tools.color.highlightForeground"><code class="option">vim.languages.dart.flutter-tools.color.highlightForeground</code> + </a> + </span> +</dt> +<dd> +<p>Highlight the foreground</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/languages/dart.nix" target="_top"> +<nvf/modules/plugins/languages/dart.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.dart.flutter-tools.color.virtualText.enable"></a><a class="term" href="options.html#opt-vim.languages.dart.flutter-tools.color.virtualText.enable"><code class="option">vim.languages.dart.flutter-tools.color.virtualText.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Show the highlight using virtual text.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/dart.nix" target="_top"> +<nvf/modules/plugins/languages/dart.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.dart.flutter-tools.color.virtualText.character"></a><a class="term" href="options.html#opt-vim.languages.dart.flutter-tools.color.virtualText.character"><code class="option">vim.languages.dart.flutter-tools.color.virtualText.character</code> + </a> + </span> +</dt> +<dd> +<p>Virtual text character to highlight</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"■"</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/plugins/languages/dart.nix" target="_top"> +<nvf/modules/plugins/languages/dart.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.dart.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.dart.lsp.enable"><code class="option">vim.languages.dart.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Dart LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/dart.nix" target="_top"> +<nvf/modules/plugins/languages/dart.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.dart.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.dart.lsp.package"><code class="option">vim.languages.dart.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>Dart LSP server package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation dart-3.5.4></code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"</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/plugins/languages/dart.nix" target="_top"> +<nvf/modules/plugins/languages/dart.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.dart.lsp.opts"></a><a class="term" href="options.html#opt-vim.languages.dart.lsp.opts"><code class="option">vim.languages.dart.lsp.opts</code> + </a> + </span> +</dt> +<dd> +<p>Options to pass to Dart LSP server</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/languages/dart.nix" target="_top"> +<nvf/modules/plugins/languages/dart.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.dart.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.dart.lsp.server"><code class="option">vim.languages.dart.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>The Dart LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “dart” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"dart"</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/plugins/languages/dart.nix" target="_top"> +<nvf/modules/plugins/languages/dart.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.dart.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.dart.treesitter.enable"><code class="option">vim.languages.dart.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Dart treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/dart.nix" target="_top"> +<nvf/modules/plugins/languages/dart.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.dart.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.dart.treesitter.package"><code class="option">vim.languages.dart.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The dart treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.dart</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/plugins/languages/dart.nix" target="_top"> +<nvf/modules/plugins/languages/dart.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.elixir.enable"></a><a class="term" href="options.html#opt-vim.languages.elixir.enable"><code class="option">vim.languages.elixir.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Elixir language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/elixir.nix" target="_top"> +<nvf/modules/plugins/languages/elixir.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.elixir.elixir-tools.enable"></a><a class="term" href="options.html#opt-vim.languages.elixir.elixir-tools.enable"><code class="option">vim.languages.elixir.elixir-tools.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Elixir tools.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/elixir.nix" target="_top"> +<nvf/modules/plugins/languages/elixir.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.elixir.format.enable"></a><a class="term" href="options.html#opt-vim.languages.elixir.format.enable"><code class="option">vim.languages.elixir.format.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Elixir formatting.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/elixir.nix" target="_top"> +<nvf/modules/plugins/languages/elixir.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.elixir.format.package"></a><a class="term" href="options.html#opt-vim.languages.elixir.format.package"><code class="option">vim.languages.elixir.format.package</code> + </a> + </span> +</dt> +<dd> +<p>Elixir formatter package</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation elixir-1.18.1></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/plugins/languages/elixir.nix" target="_top"> +<nvf/modules/plugins/languages/elixir.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.elixir.format.type"></a><a class="term" href="options.html#opt-vim.languages.elixir.format.type"><code class="option">vim.languages.elixir.format.type</code> + </a> + </span> +</dt> +<dd> +<p>Elixir formatter to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “mix” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"mix"</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/plugins/languages/elixir.nix" target="_top"> +<nvf/modules/plugins/languages/elixir.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.elixir.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.elixir.lsp.enable"><code class="option">vim.languages.elixir.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Elixir LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/elixir.nix" target="_top"> +<nvf/modules/plugins/languages/elixir.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.elixir.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.elixir.lsp.package"><code class="option">vim.languages.elixir.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>Elixir LSP server package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation elixir-ls-0.25.0></code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"[lib.getExe pkgs.jdt-language-server \" - data \" \" ~/.cache/jdtls/workspace \"]"</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/plugins/languages/elixir.nix" target="_top"> +<nvf/modules/plugins/languages/elixir.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.elixir.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.elixir.lsp.server"><code class="option">vim.languages.elixir.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>Elixir LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “elixirls” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"elixirls"</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/plugins/languages/elixir.nix" target="_top"> +<nvf/modules/plugins/languages/elixir.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.elixir.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.elixir.treesitter.enable"><code class="option">vim.languages.elixir.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Elixir treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/elixir.nix" target="_top"> +<nvf/modules/plugins/languages/elixir.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.elixir.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.elixir.treesitter.package"><code class="option">vim.languages.elixir.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The elixir treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.elixir</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/plugins/languages/elixir.nix" target="_top"> +<nvf/modules/plugins/languages/elixir.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.gleam.enable"></a><a class="term" href="options.html#opt-vim.languages.gleam.enable"><code class="option">vim.languages.gleam.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Gleam language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/gleam.nix" target="_top"> +<nvf/modules/plugins/languages/gleam.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.gleam.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.gleam.lsp.enable"><code class="option">vim.languages.gleam.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Gleam LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/gleam.nix" target="_top"> +<nvf/modules/plugins/languages/gleam.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.gleam.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.gleam.lsp.package"><code class="option">vim.languages.gleam.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>Gleam LSP server package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation gleam-1.6.3></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/plugins/languages/gleam.nix" target="_top"> +<nvf/modules/plugins/languages/gleam.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.gleam.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.gleam.lsp.server"><code class="option">vim.languages.gleam.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>Gleam LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “gleam” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"gleam"</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/plugins/languages/gleam.nix" target="_top"> +<nvf/modules/plugins/languages/gleam.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.gleam.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.gleam.treesitter.enable"><code class="option">vim.languages.gleam.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Gleam treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/gleam.nix" target="_top"> +<nvf/modules/plugins/languages/gleam.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.gleam.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.gleam.treesitter.package"><code class="option">vim.languages.gleam.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The gleam treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.gleam</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/plugins/languages/gleam.nix" target="_top"> +<nvf/modules/plugins/languages/gleam.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.go.enable"></a><a class="term" href="options.html#opt-vim.languages.go.enable"><code class="option">vim.languages.go.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Go language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/go.nix" target="_top"> +<nvf/modules/plugins/languages/go.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.go.dap.enable"></a><a class="term" href="options.html#opt-vim.languages.go.dap.enable"><code class="option">vim.languages.go.dap.enable</code> + </a> + </span> +</dt> +<dd> +<p>Enable Go Debug Adapter via nvim-dap-go plugin</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/languages/go.nix" target="_top"> +<nvf/modules/plugins/languages/go.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.go.dap.package"></a><a class="term" href="options.html#opt-vim.languages.go.dap.package"><code class="option">vim.languages.go.dap.package</code> + </a> + </span> +</dt> +<dd> +<p>Go debugger package.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation delve-1.24.0></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/plugins/languages/go.nix" target="_top"> +<nvf/modules/plugins/languages/go.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.go.dap.debugger"></a><a class="term" href="options.html#opt-vim.languages.go.dap.debugger"><code class="option">vim.languages.go.dap.debugger</code> + </a> + </span> +</dt> +<dd> +<p>Go debugger to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “delve” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"delve"</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/plugins/languages/go.nix" target="_top"> +<nvf/modules/plugins/languages/go.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.go.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.go.lsp.enable"><code class="option">vim.languages.go.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Go LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/go.nix" target="_top"> +<nvf/modules/plugins/languages/go.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.go.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.go.lsp.package"><code class="option">vim.languages.go.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>Go LSP server package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation gopls-0.17.1></code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"[lib.getExe pkgs.jdt-language-server \" - data \" \" ~/.cache/jdtls/workspace \"]"</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/plugins/languages/go.nix" target="_top"> +<nvf/modules/plugins/languages/go.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.go.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.go.lsp.server"><code class="option">vim.languages.go.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>Go LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “gopls” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"gopls"</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/plugins/languages/go.nix" target="_top"> +<nvf/modules/plugins/languages/go.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.go.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.go.treesitter.enable"><code class="option">vim.languages.go.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Go treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/go.nix" target="_top"> +<nvf/modules/plugins/languages/go.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.go.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.go.treesitter.package"><code class="option">vim.languages.go.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The go treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.go</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/plugins/languages/go.nix" target="_top"> +<nvf/modules/plugins/languages/go.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.haskell.enable"></a><a class="term" href="options.html#opt-vim.languages.haskell.enable"><code class="option">vim.languages.haskell.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Haskell support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/haskell.nix" target="_top"> +<nvf/modules/plugins/languages/haskell.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.haskell.dap.enable"></a><a class="term" href="options.html#opt-vim.languages.haskell.dap.enable"><code class="option">vim.languages.haskell.dap.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable DAP support for Haskell.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/haskell.nix" target="_top"> +<nvf/modules/plugins/languages/haskell.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.haskell.dap.package"></a><a class="term" href="options.html#opt-vim.languages.haskell.dap.package"><code class="option">vim.languages.haskell.dap.package</code> + </a> + </span> +</dt> +<dd> +<p>Haskell DAP package or command to run the Haskell DAP</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation haskell-debug-adapter-0.0.40.0></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/plugins/languages/haskell.nix" target="_top"> +<nvf/modules/plugins/languages/haskell.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.haskell.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.haskell.lsp.enable"><code class="option">vim.languages.haskell.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable LSP support for Haskell.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/haskell.nix" target="_top"> +<nvf/modules/plugins/languages/haskell.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.haskell.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.haskell.lsp.package"><code class="option">vim.languages.haskell.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>Haskell LSP package or command to run the Haskell LSP</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation haskell-language-server-2.9.0.0></code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"[ (lib.getExe pkgs.haskellPackages.haskell-language-server) \"--debug\" ]"</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/plugins/languages/haskell.nix" target="_top"> +<nvf/modules/plugins/languages/haskell.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.haskell.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.haskell.treesitter.enable"><code class="option">vim.languages.haskell.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Treesitter support for Haskell.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/haskell.nix" target="_top"> +<nvf/modules/plugins/languages/haskell.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.haskell.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.haskell.treesitter.package"><code class="option">vim.languages.haskell.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The haskell treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.haskell</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/plugins/languages/haskell.nix" target="_top"> +<nvf/modules/plugins/languages/haskell.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.hcl.enable"></a><a class="term" href="options.html#opt-vim.languages.hcl.enable"><code class="option">vim.languages.hcl.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable HCL support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/hcl.nix" target="_top"> +<nvf/modules/plugins/languages/hcl.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.hcl.format.enable"></a><a class="term" href="options.html#opt-vim.languages.hcl.format.enable"><code class="option">vim.languages.hcl.format.enable</code> + </a> + </span> +</dt> +<dd> +<p>Enable HCL formatting</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/languages/hcl.nix" target="_top"> +<nvf/modules/plugins/languages/hcl.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.hcl.format.package"></a><a class="term" href="options.html#opt-vim.languages.hcl.format.package"><code class="option">vim.languages.hcl.format.package</code> + </a> + </span> +</dt> +<dd> +<p>HCL formatter package</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation hclfmt-2.23.0></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/plugins/languages/hcl.nix" target="_top"> +<nvf/modules/plugins/languages/hcl.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.hcl.format.type"></a><a class="term" href="options.html#opt-vim.languages.hcl.format.type"><code class="option">vim.languages.hcl.format.type</code> + </a> + </span> +</dt> +<dd> +<p>HCL formatter to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “hclfmt” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"hclfmt"</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/plugins/languages/hcl.nix" target="_top"> +<nvf/modules/plugins/languages/hcl.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.hcl.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.hcl.lsp.enable"><code class="option">vim.languages.hcl.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable HCL LSP support (terraform-ls).</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/hcl.nix" target="_top"> +<nvf/modules/plugins/languages/hcl.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.hcl.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.hcl.lsp.package"><code class="option">vim.languages.hcl.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>HCL language server package (terraform-ls)</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation terraform-ls-0.36.2></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/plugins/languages/hcl.nix" target="_top"> +<nvf/modules/plugins/languages/hcl.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.hcl.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.hcl.treesitter.enable"><code class="option">vim.languages.hcl.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable HCL treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/hcl.nix" target="_top"> +<nvf/modules/plugins/languages/hcl.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.hcl.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.hcl.treesitter.package"><code class="option">vim.languages.hcl.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The hcl treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.hcl</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/plugins/languages/hcl.nix" target="_top"> +<nvf/modules/plugins/languages/hcl.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.html.enable"></a><a class="term" href="options.html#opt-vim.languages.html.enable"><code class="option">vim.languages.html.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable HTML language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/html.nix" target="_top"> +<nvf/modules/plugins/languages/html.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.html.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.html.treesitter.enable"><code class="option">vim.languages.html.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable HTML treesitter support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/html.nix" target="_top"> +<nvf/modules/plugins/languages/html.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.html.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.html.treesitter.package"><code class="option">vim.languages.html.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The html treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.html</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/plugins/languages/html.nix" target="_top"> +<nvf/modules/plugins/languages/html.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.html.treesitter.autotagHtml"></a><a class="term" href="options.html#opt-vim.languages.html.treesitter.autotagHtml"><code class="option">vim.languages.html.treesitter.autotagHtml</code> + </a> + </span> +</dt> +<dd> +<p>Enable autoclose/autorename of html tags (nvim-ts-autotag)</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/plugins/languages/html.nix" target="_top"> +<nvf/modules/plugins/languages/html.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.java.enable"></a><a class="term" href="options.html#opt-vim.languages.java.enable"><code class="option">vim.languages.java.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Java language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/java.nix" target="_top"> +<nvf/modules/plugins/languages/java.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.java.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.java.lsp.enable"><code class="option">vim.languages.java.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Java LSP support (java-language-server).</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/java.nix" target="_top"> +<nvf/modules/plugins/languages/java.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.java.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.java.lsp.package"><code class="option">vim.languages.java.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>java language server package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation jdt-language-server-1.42.0></code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"</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/plugins/languages/java.nix" target="_top"> +<nvf/modules/plugins/languages/java.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.java.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.java.treesitter.enable"><code class="option">vim.languages.java.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Java treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/java.nix" target="_top"> +<nvf/modules/plugins/languages/java.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.java.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.java.treesitter.package"><code class="option">vim.languages.java.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The java treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.java</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/plugins/languages/java.nix" target="_top"> +<nvf/modules/plugins/languages/java.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.julia.enable"></a><a class="term" href="options.html#opt-vim.languages.julia.enable"><code class="option">vim.languages.julia.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Julia language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/julia.nix" target="_top"> +<nvf/modules/plugins/languages/julia.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.julia.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.julia.lsp.enable"><code class="option">vim.languages.julia.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Julia LSP support.</p><div class="note"><h3 class="title">Note</h3><p>The entirety of Julia is bundled with nvf, if you enable this +option, since there is no way to provide only the LSP server.</p><p>If you want to avoid that, you have to change +<a class="xref" href="options.html#opt-vim.languages.julia.lsp.package" ><code class="option">vim.languages.julia.lsp.package</code></a> to use the Julia binary +in <code class="envar">PATH</code> (set it to <code class="literal">null</code>), and add the <code class="literal">LanguageServer</code> package to +Julia in your devshells.</p></div> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/languages/julia.nix" target="_top"> +<nvf/modules/plugins/languages/julia.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.julia.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.julia.lsp.package"><code class="option">vim.languages.julia.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>Julia LSP server package, <code class="literal">null</code> to use the Julia binary in <code class="envar">PATH</code>, or +the command to run as a list of strings.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation julia-1.11.2-env></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/plugins/languages/julia.nix" target="_top"> +<nvf/modules/plugins/languages/julia.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.julia.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.julia.lsp.server"><code class="option">vim.languages.julia.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>Julia LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “julials” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"julials"</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/plugins/languages/julia.nix" target="_top"> +<nvf/modules/plugins/languages/julia.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.julia.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.julia.treesitter.enable"><code class="option">vim.languages.julia.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Julia treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/julia.nix" target="_top"> +<nvf/modules/plugins/languages/julia.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.julia.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.julia.treesitter.package"><code class="option">vim.languages.julia.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The julia treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.julia</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/plugins/languages/julia.nix" target="_top"> +<nvf/modules/plugins/languages/julia.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.kotlin.enable"></a><a class="term" href="options.html#opt-vim.languages.kotlin.enable"><code class="option">vim.languages.kotlin.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Kotlin/HCL support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/kotlin.nix" target="_top"> +<nvf/modules/plugins/languages/kotlin.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.kotlin.extraDiagnostics.enable"></a><a class="term" href="options.html#opt-vim.languages.kotlin.extraDiagnostics.enable"><code class="option">vim.languages.kotlin.extraDiagnostics.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable extra Kotlin diagnostics.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/kotlin.nix" target="_top"> +<nvf/modules/plugins/languages/kotlin.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.kotlin.extraDiagnostics.types"></a><a class="term" href="options.html#opt-vim.languages.kotlin.extraDiagnostics.types"><code class="option">vim.languages.kotlin.extraDiagnostics.types</code> + </a> + </span> +</dt> +<dd> +<p>List of Kotlin diagnostics to enable</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of (value “ktlint” (singular enum) or (submodule))</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "ktlint" +] +</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/plugins/languages/kotlin.nix" target="_top"> +<nvf/modules/plugins/languages/kotlin.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.kotlin.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.kotlin.lsp.enable"><code class="option">vim.languages.kotlin.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Kotlin LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/kotlin.nix" target="_top"> +<nvf/modules/plugins/languages/kotlin.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.kotlin.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.kotlin.lsp.package"><code class="option">vim.languages.kotlin.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>kotlin_language_server package with Kotlin runtime</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation kotlin-language-server-1.3.12></code></p> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">pkgs.symlinkJoin { + name = "kotlin-language-server-wrapped"; + paths = [pkgs.kotlin-language-server]; + nativeBuildInputs = [pkgs.makeBinaryWrapper]; + postBuild = '' + wrapProgram $out/bin/kotlin-language-server \ + --prefix PATH : ${pkgs.kotlin}/bin + ''; +}; + +</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/plugins/languages/kotlin.nix" target="_top"> +<nvf/modules/plugins/languages/kotlin.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.kotlin.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.kotlin.treesitter.enable"><code class="option">vim.languages.kotlin.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Kotlin treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/kotlin.nix" target="_top"> +<nvf/modules/plugins/languages/kotlin.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.kotlin.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.kotlin.treesitter.package"><code class="option">vim.languages.kotlin.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The kotlin treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.kotlin</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/plugins/languages/kotlin.nix" target="_top"> +<nvf/modules/plugins/languages/kotlin.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.lua.enable"></a><a class="term" href="options.html#opt-vim.languages.lua.enable"><code class="option">vim.languages.lua.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Lua language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/lua.nix" target="_top"> +<nvf/modules/plugins/languages/lua.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.lua.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.lua.lsp.enable"><code class="option">vim.languages.lua.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Lua LSP support via LuaLS.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/lua.nix" target="_top"> +<nvf/modules/plugins/languages/lua.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.lua.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.lua.lsp.package"><code class="option">vim.languages.lua.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>LuaLS package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation lua-language-server-3.13.4></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/plugins/languages/lua.nix" target="_top"> +<nvf/modules/plugins/languages/lua.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.lua.lsp.neodev.enable"></a><a class="term" href="options.html#opt-vim.languages.lua.lsp.neodev.enable"><code class="option">vim.languages.lua.lsp.neodev.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable neodev.nvim integration, useful for neovim plugin developers.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/lua.nix" target="_top"> +<nvf/modules/plugins/languages/lua.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.lua.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.lua.treesitter.enable"><code class="option">vim.languages.lua.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Lua Treesitter support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/lua.nix" target="_top"> +<nvf/modules/plugins/languages/lua.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.lua.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.lua.treesitter.package"><code class="option">vim.languages.lua.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The lua treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.lua</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/plugins/languages/lua.nix" target="_top"> +<nvf/modules/plugins/languages/lua.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.markdown.enable"></a><a class="term" href="options.html#opt-vim.languages.markdown.enable"><code class="option">vim.languages.markdown.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Markdown markup language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/markdown.nix" target="_top"> +<nvf/modules/plugins/languages/markdown.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.markdown.extensions.render-markdown-nvim.enable"></a><a class="term" href="options.html#opt-vim.languages.markdown.extensions.render-markdown-nvim.enable"><code class="option">vim.languages.markdown.extensions.render-markdown-nvim.enable</code> + </a> + </span> +</dt> +<dd> +<p>Inline Markdown rendering with <a class="link" href="https://github.com/MeanderingProgrammer/render-markdown.nvim" target="_top">render-markdown.nvim</a></p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/markdown.nix" target="_top"> +<nvf/modules/plugins/languages/markdown.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.markdown.extensions.render-markdown-nvim.setupOpts"></a><a class="term" href="options.html#opt-vim.languages.markdown.extensions.render-markdown-nvim.setupOpts"><code class="option">vim.languages.markdown.extensions.render-markdown-nvim.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of render-markdown</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/languages/markdown.nix" target="_top"> +<nvf/modules/plugins/languages/markdown.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.markdown.extensions.render-markdown-nvim.setupOpts.auto_override_publish_diagnostics"></a><a class="term" href="options.html#opt-vim.languages.markdown.extensions.render-markdown-nvim.setupOpts.auto_override_publish_diagnostics"><code class="option">vim.languages.markdown.extensions.render-markdown-nvim.setupOpts.auto_override_publish_diagnostics</code> + </a> + </span> +</dt> +<dd> +<p>Automatically override the publish_diagnostics handler</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/plugins/languages/markdown.nix" target="_top"> +<nvf/modules/plugins/languages/markdown.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.markdown.format.enable"></a><a class="term" href="options.html#opt-vim.languages.markdown.format.enable"><code class="option">vim.languages.markdown.format.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Markdown formatting.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/markdown.nix" target="_top"> +<nvf/modules/plugins/languages/markdown.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.markdown.format.package"></a><a class="term" href="options.html#opt-vim.languages.markdown.format.package"><code class="option">vim.languages.markdown.format.package</code> + </a> + </span> +</dt> +<dd> +<p>Markdown formatter package</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation deno-2.1.4></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/plugins/languages/markdown.nix" target="_top"> +<nvf/modules/plugins/languages/markdown.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.markdown.format.extraFiletypes"></a><a class="term" href="options.html#opt-vim.languages.markdown.format.extraFiletypes"><code class="option">vim.languages.markdown.format.extraFiletypes</code> + </a> + </span> +</dt> +<dd> +<p>Extra filetypes to format with the Markdown formatter</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/languages/markdown.nix" target="_top"> +<nvf/modules/plugins/languages/markdown.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.markdown.format.type"></a><a class="term" href="options.html#opt-vim.languages.markdown.format.type"><code class="option">vim.languages.markdown.format.type</code> + </a> + </span> +</dt> +<dd> +<p>Markdown formatter to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “denofmt”, “prettierd”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"denofmt"</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/plugins/languages/markdown.nix" target="_top"> +<nvf/modules/plugins/languages/markdown.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.markdown.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.markdown.lsp.enable"><code class="option">vim.languages.markdown.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Enable Markdown LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/markdown.nix" target="_top"> +<nvf/modules/plugins/languages/markdown.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.markdown.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.markdown.lsp.package"><code class="option">vim.languages.markdown.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>Markdown LSP server package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation marksman-2024-12-18></code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"[lib.getExe pkgs.jdt-language-server \" - data \" \" ~/.cache/jdtls/workspace \"]"</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/plugins/languages/markdown.nix" target="_top"> +<nvf/modules/plugins/languages/markdown.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.markdown.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.markdown.lsp.server"><code class="option">vim.languages.markdown.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>Markdown LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “marksman” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"marksman"</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/plugins/languages/markdown.nix" target="_top"> +<nvf/modules/plugins/languages/markdown.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.markdown.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.markdown.treesitter.enable"><code class="option">vim.languages.markdown.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Enable Markdown treesitter</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/languages/markdown.nix" target="_top"> +<nvf/modules/plugins/languages/markdown.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.markdown.treesitter.mdInlinePackage"></a><a class="term" href="options.html#opt-vim.languages.markdown.treesitter.mdInlinePackage"><code class="option">vim.languages.markdown.treesitter.mdInlinePackage</code> + </a> + </span> +</dt> +<dd> +<p>The markdown-inline treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.markdown-inline</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/plugins/languages/markdown.nix" target="_top"> +<nvf/modules/plugins/languages/markdown.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.markdown.treesitter.mdPackage"></a><a class="term" href="options.html#opt-vim.languages.markdown.treesitter.mdPackage"><code class="option">vim.languages.markdown.treesitter.mdPackage</code> + </a> + </span> +</dt> +<dd> +<p>The markdown treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.markdown</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/plugins/languages/markdown.nix" target="_top"> +<nvf/modules/plugins/languages/markdown.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nim.enable"></a><a class="term" href="options.html#opt-vim.languages.nim.enable"><code class="option">vim.languages.nim.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Nim language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/nim.nix" target="_top"> +<nvf/modules/plugins/languages/nim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nim.format.enable"></a><a class="term" href="options.html#opt-vim.languages.nim.format.enable"><code class="option">vim.languages.nim.format.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Nim formatting.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/nim.nix" target="_top"> +<nvf/modules/plugins/languages/nim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nim.format.package"></a><a class="term" href="options.html#opt-vim.languages.nim.format.package"><code class="option">vim.languages.nim.format.package</code> + </a> + </span> +</dt> +<dd> +<p>Nim formatter package</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation x86_64-unknown-linux-gnu-nim-wrapper-2.2.0></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/plugins/languages/nim.nix" target="_top"> +<nvf/modules/plugins/languages/nim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nim.format.type"></a><a class="term" href="options.html#opt-vim.languages.nim.format.type"><code class="option">vim.languages.nim.format.type</code> + </a> + </span> +</dt> +<dd> +<p>Nim formatter to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “nimpretty” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"nimpretty"</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/plugins/languages/nim.nix" target="_top"> +<nvf/modules/plugins/languages/nim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nim.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.nim.lsp.enable"><code class="option">vim.languages.nim.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Nim LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/nim.nix" target="_top"> +<nvf/modules/plugins/languages/nim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nim.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.nim.lsp.package"><code class="option">vim.languages.nim.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>Nim LSP server package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation nimlsp-0.4.6></code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"[lib.getExe pkgs.nimlsp]"</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/plugins/languages/nim.nix" target="_top"> +<nvf/modules/plugins/languages/nim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nim.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.nim.lsp.server"><code class="option">vim.languages.nim.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>Nim LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"nimlsp"</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/plugins/languages/nim.nix" target="_top"> +<nvf/modules/plugins/languages/nim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nim.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.nim.treesitter.enable"><code class="option">vim.languages.nim.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Nim treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/nim.nix" target="_top"> +<nvf/modules/plugins/languages/nim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nim.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.nim.treesitter.package"><code class="option">vim.languages.nim.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The nim treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.nim</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/plugins/languages/nim.nix" target="_top"> +<nvf/modules/plugins/languages/nim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nix.enable"></a><a class="term" href="options.html#opt-vim.languages.nix.enable"><code class="option">vim.languages.nix.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Nix language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/nix.nix" target="_top"> +<nvf/modules/plugins/languages/nix.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nix.extraDiagnostics.enable"></a><a class="term" href="options.html#opt-vim.languages.nix.extraDiagnostics.enable"><code class="option">vim.languages.nix.extraDiagnostics.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable extra Nix diagnostics.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/nix.nix" target="_top"> +<nvf/modules/plugins/languages/nix.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nix.extraDiagnostics.types"></a><a class="term" href="options.html#opt-vim.languages.nix.extraDiagnostics.types"><code class="option">vim.languages.nix.extraDiagnostics.types</code> + </a> + </span> +</dt> +<dd> +<p>List of Nix diagnostics to enable</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of (one of “deadnix”, “statix” or (submodule))</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "statix" + "deadnix" +] +</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/plugins/languages/nix.nix" target="_top"> +<nvf/modules/plugins/languages/nix.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nix.format.enable"></a><a class="term" href="options.html#opt-vim.languages.nix.format.enable"><code class="option">vim.languages.nix.format.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Nix formatting.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/nix.nix" target="_top"> +<nvf/modules/plugins/languages/nix.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nix.format.package"></a><a class="term" href="options.html#opt-vim.languages.nix.format.package"><code class="option">vim.languages.nix.format.package</code> + </a> + </span> +</dt> +<dd> +<p>Nix formatter package</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation alejandra-3.1.0></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/plugins/languages/nix.nix" target="_top"> +<nvf/modules/plugins/languages/nix.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nix.format.type"></a><a class="term" href="options.html#opt-vim.languages.nix.format.type"><code class="option">vim.languages.nix.format.type</code> + </a> + </span> +</dt> +<dd> +<p>Nix formatter to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “alejandra”, “nixfmt”, “nixpkgs-fmt”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"alejandra"</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/plugins/languages/nix.nix" target="_top"> +<nvf/modules/plugins/languages/nix.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nix.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.nix.lsp.enable"><code class="option">vim.languages.nix.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Nix LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/nix.nix" target="_top"> +<nvf/modules/plugins/languages/nix.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nix.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.nix.lsp.package"><code class="option">vim.languages.nix.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>Nix LSP server package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation nil-2024-08-06></code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"</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/plugins/languages/nix.nix" target="_top"> +<nvf/modules/plugins/languages/nix.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nix.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.nix.lsp.server"><code class="option">vim.languages.nix.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>Nix LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “nil” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"nil"</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/plugins/languages/nix.nix" target="_top"> +<nvf/modules/plugins/languages/nix.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nix.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.nix.treesitter.enable"><code class="option">vim.languages.nix.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Nix treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/nix.nix" target="_top"> +<nvf/modules/plugins/languages/nix.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nix.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.nix.treesitter.package"><code class="option">vim.languages.nix.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The nix treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.nix</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/plugins/languages/nix.nix" target="_top"> +<nvf/modules/plugins/languages/nix.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nu.enable"></a><a class="term" href="options.html#opt-vim.languages.nu.enable"><code class="option">vim.languages.nu.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Nu language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/nu.nix" target="_top"> +<nvf/modules/plugins/languages/nu.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nu.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.nu.lsp.enable"><code class="option">vim.languages.nu.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Nu LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/nu.nix" target="_top"> +<nvf/modules/plugins/languages/nu.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nu.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.nu.lsp.package"><code class="option">vim.languages.nu.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>Nu LSP server package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation nushell-0.101.0></code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"[(lib.getExe pkgs.nushell) \"--lsp\"]"</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/plugins/languages/nu.nix" target="_top"> +<nvf/modules/plugins/languages/nu.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nu.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.nu.lsp.server"><code class="option">vim.languages.nu.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>Nu LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"nushell"</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/plugins/languages/nu.nix" target="_top"> +<nvf/modules/plugins/languages/nu.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nu.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.nu.treesitter.enable"><code class="option">vim.languages.nu.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Nu treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/nu.nix" target="_top"> +<nvf/modules/plugins/languages/nu.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.nu.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.nu.treesitter.package"><code class="option">vim.languages.nu.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The nu treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.nu</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/plugins/languages/nu.nix" target="_top"> +<nvf/modules/plugins/languages/nu.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ocaml.enable"></a><a class="term" href="options.html#opt-vim.languages.ocaml.enable"><code class="option">vim.languages.ocaml.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable OCaml language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/ocaml.nix" target="_top"> +<nvf/modules/plugins/languages/ocaml.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ocaml.format.enable"></a><a class="term" href="options.html#opt-vim.languages.ocaml.format.enable"><code class="option">vim.languages.ocaml.format.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable OCaml formatting support (ocamlformat).</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/ocaml.nix" target="_top"> +<nvf/modules/plugins/languages/ocaml.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ocaml.format.package"></a><a class="term" href="options.html#opt-vim.languages.ocaml.format.package"><code class="option">vim.languages.ocaml.format.package</code> + </a> + </span> +</dt> +<dd> +<p>OCaml formatter package</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation ocaml5.2.1-ocamlformat-0.27.0></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/plugins/languages/ocaml.nix" target="_top"> +<nvf/modules/plugins/languages/ocaml.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ocaml.format.type"></a><a class="term" href="options.html#opt-vim.languages.ocaml.format.type"><code class="option">vim.languages.ocaml.format.type</code> + </a> + </span> +</dt> +<dd> +<p>OCaml formatter to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “ocamlformat” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"ocamlformat"</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/plugins/languages/ocaml.nix" target="_top"> +<nvf/modules/plugins/languages/ocaml.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ocaml.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.ocaml.lsp.enable"><code class="option">vim.languages.ocaml.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable OCaml LSP support (ocaml-lsp).</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/ocaml.nix" target="_top"> +<nvf/modules/plugins/languages/ocaml.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ocaml.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.ocaml.lsp.package"><code class="option">vim.languages.ocaml.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>OCaml language server package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation ocaml5.2.1-ocaml-lsp-server-1.19.0></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/plugins/languages/ocaml.nix" target="_top"> +<nvf/modules/plugins/languages/ocaml.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ocaml.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.ocaml.lsp.server"><code class="option">vim.languages.ocaml.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>OCaml LSP server to user</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “ocaml-lsp” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"ocaml-lsp"</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/plugins/languages/ocaml.nix" target="_top"> +<nvf/modules/plugins/languages/ocaml.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ocaml.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.ocaml.treesitter.enable"><code class="option">vim.languages.ocaml.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable OCaml treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/ocaml.nix" target="_top"> +<nvf/modules/plugins/languages/ocaml.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ocaml.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.ocaml.treesitter.package"><code class="option">vim.languages.ocaml.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The ocaml treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.ocaml</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/plugins/languages/ocaml.nix" target="_top"> +<nvf/modules/plugins/languages/ocaml.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.odin.enable"></a><a class="term" href="options.html#opt-vim.languages.odin.enable"><code class="option">vim.languages.odin.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Odin language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/odin.nix" target="_top"> +<nvf/modules/plugins/languages/odin.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.odin.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.odin.lsp.enable"><code class="option">vim.languages.odin.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Odin LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/odin.nix" target="_top"> +<nvf/modules/plugins/languages/odin.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.odin.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.odin.lsp.package"><code class="option">vim.languages.odin.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>Ols package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation ols-0-unstable-2024-11-30></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/plugins/languages/odin.nix" target="_top"> +<nvf/modules/plugins/languages/odin.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.odin.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.odin.lsp.server"><code class="option">vim.languages.odin.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>Odin LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “ols” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"ols"</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/plugins/languages/odin.nix" target="_top"> +<nvf/modules/plugins/languages/odin.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.odin.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.odin.treesitter.enable"><code class="option">vim.languages.odin.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Odin treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/odin.nix" target="_top"> +<nvf/modules/plugins/languages/odin.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.odin.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.odin.treesitter.package"><code class="option">vim.languages.odin.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The odin treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.odin</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/plugins/languages/odin.nix" target="_top"> +<nvf/modules/plugins/languages/odin.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.php.enable"></a><a class="term" href="options.html#opt-vim.languages.php.enable"><code class="option">vim.languages.php.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable PHP language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/php.nix" target="_top"> +<nvf/modules/plugins/languages/php.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.php.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.php.lsp.enable"><code class="option">vim.languages.php.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable PHP LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/php.nix" target="_top"> +<nvf/modules/plugins/languages/php.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.php.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.php.lsp.package"><code class="option">vim.languages.php.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>PHP LSP server package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation phpactor-2024.11.28.1></code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"[lib.getExe pkgs.jdt-language-server \" - data \" \" ~/.cache/jdtls/workspace \"]"</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/plugins/languages/php.nix" target="_top"> +<nvf/modules/plugins/languages/php.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.php.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.php.lsp.server"><code class="option">vim.languages.php.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>PHP LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “phan”, “phpactor”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"phpactor"</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/plugins/languages/php.nix" target="_top"> +<nvf/modules/plugins/languages/php.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.php.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.php.treesitter.enable"><code class="option">vim.languages.php.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable PHP treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/php.nix" target="_top"> +<nvf/modules/plugins/languages/php.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.php.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.php.treesitter.package"><code class="option">vim.languages.php.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The php treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.php</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/plugins/languages/php.nix" target="_top"> +<nvf/modules/plugins/languages/php.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.python.enable"></a><a class="term" href="options.html#opt-vim.languages.python.enable"><code class="option">vim.languages.python.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Python language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/python.nix" target="_top"> +<nvf/modules/plugins/languages/python.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.python.dap.enable"></a><a class="term" href="options.html#opt-vim.languages.python.dap.enable"><code class="option">vim.languages.python.dap.enable</code> + </a> + </span> +</dt> +<dd> +<p>Enable Python Debug Adapter</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/languages/python.nix" target="_top"> +<nvf/modules/plugins/languages/python.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.python.dap.package"></a><a class="term" href="options.html#opt-vim.languages.python.dap.package"><code class="option">vim.languages.python.dap.package</code> + </a> + </span> +</dt> +<dd> +<p>Python debugger package. +This is a python package with debugpy installed, see https://nixos.wiki/wiki/Python#Install_Python_Packages.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation python3-3.12.8-env></code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">with pkgs; python39.withPackages (ps: with ps; [debugpy])</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/plugins/languages/python.nix" target="_top"> +<nvf/modules/plugins/languages/python.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.python.dap.debugger"></a><a class="term" href="options.html#opt-vim.languages.python.dap.debugger"><code class="option">vim.languages.python.dap.debugger</code> + </a> + </span> +</dt> +<dd> +<p>Python debugger to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “debugpy” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"debugpy"</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/plugins/languages/python.nix" target="_top"> +<nvf/modules/plugins/languages/python.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.python.format.enable"></a><a class="term" href="options.html#opt-vim.languages.python.format.enable"><code class="option">vim.languages.python.format.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Python formatting.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/python.nix" target="_top"> +<nvf/modules/plugins/languages/python.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.python.format.package"></a><a class="term" href="options.html#opt-vim.languages.python.format.package"><code class="option">vim.languages.python.format.package</code> + </a> + </span> +</dt> +<dd> +<p>Python formatter package</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation black-24.8.0></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/plugins/languages/python.nix" target="_top"> +<nvf/modules/plugins/languages/python.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.python.format.type"></a><a class="term" href="options.html#opt-vim.languages.python.format.type"><code class="option">vim.languages.python.format.type</code> + </a> + </span> +</dt> +<dd> +<p>Python formatter to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “black”, “black-and-isort”, “isort”, “ruff”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"black"</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/plugins/languages/python.nix" target="_top"> +<nvf/modules/plugins/languages/python.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.python.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.python.lsp.enable"><code class="option">vim.languages.python.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Python LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/python.nix" target="_top"> +<nvf/modules/plugins/languages/python.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.python.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.python.lsp.package"><code class="option">vim.languages.python.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>python LSP server package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation basedpyright-1.23.1></code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"</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/plugins/languages/python.nix" target="_top"> +<nvf/modules/plugins/languages/python.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.python.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.python.lsp.server"><code class="option">vim.languages.python.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>Python LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “basedpyright”, “pyright”, “python-lsp-server”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"basedpyright"</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/plugins/languages/python.nix" target="_top"> +<nvf/modules/plugins/languages/python.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.python.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.python.treesitter.enable"><code class="option">vim.languages.python.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Python treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/python.nix" target="_top"> +<nvf/modules/plugins/languages/python.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.python.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.python.treesitter.package"><code class="option">vim.languages.python.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>Python treesitter grammar to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation python-grammar-0.0.0+rev=bffb65a></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/plugins/languages/python.nix" target="_top"> +<nvf/modules/plugins/languages/python.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.r.enable"></a><a class="term" href="options.html#opt-vim.languages.r.enable"><code class="option">vim.languages.r.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable R language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/r.nix" target="_top"> +<nvf/modules/plugins/languages/r.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.r.format.enable"></a><a class="term" href="options.html#opt-vim.languages.r.format.enable"><code class="option">vim.languages.r.format.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable R formatting.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/r.nix" target="_top"> +<nvf/modules/plugins/languages/r.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.r.format.package"></a><a class="term" href="options.html#opt-vim.languages.r.format.package"><code class="option">vim.languages.r.format.package</code> + </a> + </span> +</dt> +<dd> +<p>R formatter package</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation R-4.4.1-wrapper></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/plugins/languages/r.nix" target="_top"> +<nvf/modules/plugins/languages/r.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.r.format.type"></a><a class="term" href="options.html#opt-vim.languages.r.format.type"><code class="option">vim.languages.r.format.type</code> + </a> + </span> +</dt> +<dd> +<p>R formatter to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “format_r”, “styler”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"format_r"</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/plugins/languages/r.nix" target="_top"> +<nvf/modules/plugins/languages/r.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.r.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.r.lsp.enable"><code class="option">vim.languages.r.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable R LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/r.nix" target="_top"> +<nvf/modules/plugins/languages/r.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.r.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.r.lsp.package"><code class="option">vim.languages.r.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>R LSP server package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation r_lsp></code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">[ (lib.getExe pkgs.jdt-language-server) "-data" "~/.cache/jdtls/workspace" ]</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/plugins/languages/r.nix" target="_top"> +<nvf/modules/plugins/languages/r.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.r.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.r.lsp.server"><code class="option">vim.languages.r.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>R LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “r_language_server” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"r_language_server"</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/plugins/languages/r.nix" target="_top"> +<nvf/modules/plugins/languages/r.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.r.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.r.treesitter.enable"><code class="option">vim.languages.r.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable R treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/r.nix" target="_top"> +<nvf/modules/plugins/languages/r.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.r.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.r.treesitter.package"><code class="option">vim.languages.r.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The r treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.r</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/plugins/languages/r.nix" target="_top"> +<nvf/modules/plugins/languages/r.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ruby.enable"></a><a class="term" href="options.html#opt-vim.languages.ruby.enable"><code class="option">vim.languages.ruby.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Ruby language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/ruby.nix" target="_top"> +<nvf/modules/plugins/languages/ruby.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ruby.extraDiagnostics.enable"></a><a class="term" href="options.html#opt-vim.languages.ruby.extraDiagnostics.enable"><code class="option">vim.languages.ruby.extraDiagnostics.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Ruby extra diagnostics support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/ruby.nix" target="_top"> +<nvf/modules/plugins/languages/ruby.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ruby.extraDiagnostics.types"></a><a class="term" href="options.html#opt-vim.languages.ruby.extraDiagnostics.types"><code class="option">vim.languages.ruby.extraDiagnostics.types</code> + </a> + </span> +</dt> +<dd> +<p>List of Ruby diagnostics to enable</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of (value “rubocop” (singular enum) or (submodule))</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "rubocop" +] +</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/plugins/languages/ruby.nix" target="_top"> +<nvf/modules/plugins/languages/ruby.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ruby.format.enable"></a><a class="term" href="options.html#opt-vim.languages.ruby.format.enable"><code class="option">vim.languages.ruby.format.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Ruby formatter support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/ruby.nix" target="_top"> +<nvf/modules/plugins/languages/ruby.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ruby.format.package"></a><a class="term" href="options.html#opt-vim.languages.ruby.format.package"><code class="option">vim.languages.ruby.format.package</code> + </a> + </span> +</dt> +<dd> +<p>Ruby formatter package</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation ruby3.3-rubocop-1.65.1></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/plugins/languages/ruby.nix" target="_top"> +<nvf/modules/plugins/languages/ruby.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ruby.format.type"></a><a class="term" href="options.html#opt-vim.languages.ruby.format.type"><code class="option">vim.languages.ruby.format.type</code> + </a> + </span> +</dt> +<dd> +<p>Ruby formatter to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “rubocop” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"rubocop"</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/plugins/languages/ruby.nix" target="_top"> +<nvf/modules/plugins/languages/ruby.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ruby.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.ruby.lsp.enable"><code class="option">vim.languages.ruby.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Ruby LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/ruby.nix" target="_top"> +<nvf/modules/plugins/languages/ruby.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ruby.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.ruby.lsp.package"><code class="option">vim.languages.ruby.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>Ruby LSP server package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation ruby3.3-solargraph-0.50.0></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/plugins/languages/ruby.nix" target="_top"> +<nvf/modules/plugins/languages/ruby.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ruby.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.ruby.lsp.server"><code class="option">vim.languages.ruby.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>Ruby LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “rubyserver” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"rubyserver"</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/plugins/languages/ruby.nix" target="_top"> +<nvf/modules/plugins/languages/ruby.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ruby.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.ruby.treesitter.enable"><code class="option">vim.languages.ruby.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Ruby treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/ruby.nix" target="_top"> +<nvf/modules/plugins/languages/ruby.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ruby.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.ruby.treesitter.package"><code class="option">vim.languages.ruby.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The ruby treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.ruby</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/plugins/languages/ruby.nix" target="_top"> +<nvf/modules/plugins/languages/ruby.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.rust.enable"></a><a class="term" href="options.html#opt-vim.languages.rust.enable"><code class="option">vim.languages.rust.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Rust language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/rust.nix" target="_top"> +<nvf/modules/plugins/languages/rust.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.rust.crates.enable"></a><a class="term" href="options.html#opt-vim.languages.rust.crates.enable"><code class="option">vim.languages.rust.crates.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable crates-nvim, tools for managing dependencies.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/rust.nix" target="_top"> +<nvf/modules/plugins/languages/rust.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.rust.crates.codeActions"></a><a class="term" href="options.html#opt-vim.languages.rust.crates.codeActions"><code class="option">vim.languages.rust.crates.codeActions</code> + </a> + </span> +</dt> +<dd> +<p>Enable code actions through null-ls</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/plugins/languages/rust.nix" target="_top"> +<nvf/modules/plugins/languages/rust.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.rust.dap.enable"></a><a class="term" href="options.html#opt-vim.languages.rust.dap.enable"><code class="option">vim.languages.rust.dap.enable</code> + </a> + </span> +</dt> +<dd> +<p>Rust Debug Adapter support</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/languages/rust.nix" target="_top"> +<nvf/modules/plugins/languages/rust.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.rust.dap.package"></a><a class="term" href="options.html#opt-vim.languages.rust.dap.package"><code class="option">vim.languages.rust.dap.package</code> + </a> + </span> +</dt> +<dd> +<p>lldb package</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation lldb-19.1.5></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/plugins/languages/rust.nix" target="_top"> +<nvf/modules/plugins/languages/rust.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.rust.format.enable"></a><a class="term" href="options.html#opt-vim.languages.rust.format.enable"><code class="option">vim.languages.rust.format.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Rust formatting.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/rust.nix" target="_top"> +<nvf/modules/plugins/languages/rust.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.rust.format.package"></a><a class="term" href="options.html#opt-vim.languages.rust.format.package"><code class="option">vim.languages.rust.format.package</code> + </a> + </span> +</dt> +<dd> +<p>Rust formatter package</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation rustfmt-1.83.0></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/plugins/languages/rust.nix" target="_top"> +<nvf/modules/plugins/languages/rust.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.rust.format.type"></a><a class="term" href="options.html#opt-vim.languages.rust.format.type"><code class="option">vim.languages.rust.format.type</code> + </a> + </span> +</dt> +<dd> +<p>Rust formatter to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “rustfmt” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"rustfmt"</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/plugins/languages/rust.nix" target="_top"> +<nvf/modules/plugins/languages/rust.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.rust.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.rust.lsp.enable"><code class="option">vim.languages.rust.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Rust LSP support (rust-analyzer with extra tools).</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/rust.nix" target="_top"> +<nvf/modules/plugins/languages/rust.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.rust.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.rust.lsp.package"><code class="option">vim.languages.rust.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>rust-analyzer package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation rust-analyzer-2024-12-23></code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"</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/plugins/languages/rust.nix" target="_top"> +<nvf/modules/plugins/languages/rust.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.rust.lsp.opts"></a><a class="term" href="options.html#opt-vim.languages.rust.lsp.opts"><code class="option">vim.languages.rust.lsp.opts</code> + </a> + </span> +</dt> +<dd> +<p>Options to pass to rust analyzer</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">""</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/plugins/languages/rust.nix" target="_top"> +<nvf/modules/plugins/languages/rust.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.rust.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.rust.treesitter.enable"><code class="option">vim.languages.rust.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Rust treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/rust.nix" target="_top"> +<nvf/modules/plugins/languages/rust.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.rust.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.rust.treesitter.package"><code class="option">vim.languages.rust.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The rust treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.rust</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/plugins/languages/rust.nix" target="_top"> +<nvf/modules/plugins/languages/rust.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.scala.enable"></a><a class="term" href="options.html#opt-vim.languages.scala.enable"><code class="option">vim.languages.scala.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Scala language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/scala.nix" target="_top"> +<nvf/modules/plugins/languages/scala.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.scala.dap.enable"></a><a class="term" href="options.html#opt-vim.languages.scala.dap.enable"><code class="option">vim.languages.scala.dap.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Scala Debug Adapter support (metals).</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/scala.nix" target="_top"> +<nvf/modules/plugins/languages/scala.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.scala.dap.config"></a><a class="term" href="options.html#opt-vim.languages.scala.dap.config"><code class="option">vim.languages.scala.dap.config</code> + </a> + </span> +</dt> +<dd> +<p>Lua configuration for dap</p> + +<p><span class="emphasis"><em>Type:</em></span> +luaInline</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + _type = "lua-inline"; + expr = '' + dap.configurations.scala = { + { + type = "scala", + request = "launch", + name = "RunOrTest", + metals = { + runType = "runOrTestFile", + --args = { "firstArg", "secondArg", "thirdArg" }, -- here just as an example + }, + }, + { + type = "scala", + request = "launch", + name = "Test Target", + metals = { + runType = "testTarget", + }, + }, + } + ''; +} +</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/plugins/languages/scala.nix" target="_top"> +<nvf/modules/plugins/languages/scala.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.scala.fixShortmess"></a><a class="term" href="options.html#opt-vim.languages.scala.fixShortmess"><code class="option">vim.languages.scala.fixShortmess</code> + </a> + </span> +</dt> +<dd> +<p>Remove the ‘F’ flag from shortmess to allow messages to be shown. Without doing this, autocommands that deal with filetypes prohibit messages from being shown</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/plugins/languages/scala.nix" target="_top"> +<nvf/modules/plugins/languages/scala.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.scala.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.scala.lsp.enable"><code class="option">vim.languages.scala.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Scala LSP support (metals).</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/scala.nix" target="_top"> +<nvf/modules/plugins/languages/scala.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.scala.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.scala.lsp.package"><code class="option">vim.languages.scala.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>The metals package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.metals</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/plugins/languages/scala.nix" target="_top"> +<nvf/modules/plugins/languages/scala.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.scala.lsp.extraMappings.listCommands"></a><a class="term" href="options.html#opt-vim.languages.scala.lsp.extraMappings.listCommands"><code class="option">vim.languages.scala.lsp.extraMappings.listCommands</code> + </a> + </span> +</dt> +<dd> +<p>List Metals commands</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>lc"</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/plugins/languages/scala.nix" target="_top"> +<nvf/modules/plugins/languages/scala.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.scala.lsp.extraSettings"></a><a class="term" href="options.html#opt-vim.languages.scala.lsp.extraSettings"><code class="option">vim.languages.scala.lsp.extraSettings</code> + </a> + </span> +</dt> +<dd> +<p>Extra settings passed to the metals config. Check nvim-metals docs for available options</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of anything</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + excludedPackages = [ + "akka.actor.typed.javadsl" + "com.github.swagger.akka.javadsl" + ]; + showImplicitArguments = true; + showImplicitConversionsAndClasses = true; + showInferredType = true; +} +</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/plugins/languages/scala.nix" target="_top"> +<nvf/modules/plugins/languages/scala.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.scala.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.scala.treesitter.enable"><code class="option">vim.languages.scala.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Scala treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/scala.nix" target="_top"> +<nvf/modules/plugins/languages/scala.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.scala.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.scala.treesitter.package"><code class="option">vim.languages.scala.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The scala treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.scala</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/plugins/languages/scala.nix" target="_top"> +<nvf/modules/plugins/languages/scala.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.sql.enable"></a><a class="term" href="options.html#opt-vim.languages.sql.enable"><code class="option">vim.languages.sql.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable SQL language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/sql.nix" target="_top"> +<nvf/modules/plugins/languages/sql.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.sql.dialect"></a><a class="term" href="options.html#opt-vim.languages.sql.dialect"><code class="option">vim.languages.sql.dialect</code> + </a> + </span> +</dt> +<dd> +<p>SQL dialect for sqlfluff (if used)</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"ansi"</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/plugins/languages/sql.nix" target="_top"> +<nvf/modules/plugins/languages/sql.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.sql.extraDiagnostics.enable"></a><a class="term" href="options.html#opt-vim.languages.sql.extraDiagnostics.enable"><code class="option">vim.languages.sql.extraDiagnostics.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable extra SQL diagnostics.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/sql.nix" target="_top"> +<nvf/modules/plugins/languages/sql.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.sql.extraDiagnostics.types"></a><a class="term" href="options.html#opt-vim.languages.sql.extraDiagnostics.types"><code class="option">vim.languages.sql.extraDiagnostics.types</code> + </a> + </span> +</dt> +<dd> +<p>List of SQL diagnostics to enable</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of (value “sqlfluff” (singular enum) or (submodule))</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "sqlfluff" +] +</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/plugins/languages/sql.nix" target="_top"> +<nvf/modules/plugins/languages/sql.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.sql.format.enable"></a><a class="term" href="options.html#opt-vim.languages.sql.format.enable"><code class="option">vim.languages.sql.format.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable SQL formatting.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/sql.nix" target="_top"> +<nvf/modules/plugins/languages/sql.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.sql.format.package"></a><a class="term" href="options.html#opt-vim.languages.sql.format.package"><code class="option">vim.languages.sql.format.package</code> + </a> + </span> +</dt> +<dd> +<p>SQL formatter package</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation sqlfluff-3.2.5></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/plugins/languages/sql.nix" target="_top"> +<nvf/modules/plugins/languages/sql.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.sql.format.type"></a><a class="term" href="options.html#opt-vim.languages.sql.format.type"><code class="option">vim.languages.sql.format.type</code> + </a> + </span> +</dt> +<dd> +<p>SQL formatter to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “sqlfluff” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"sqlfluff"</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/plugins/languages/sql.nix" target="_top"> +<nvf/modules/plugins/languages/sql.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.sql.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.sql.lsp.enable"><code class="option">vim.languages.sql.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable SQL LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/sql.nix" target="_top"> +<nvf/modules/plugins/languages/sql.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.sql.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.sql.lsp.package"><code class="option">vim.languages.sql.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>SQL LSP server package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation sqls-0.2.28></code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"</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/plugins/languages/sql.nix" target="_top"> +<nvf/modules/plugins/languages/sql.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.sql.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.sql.lsp.server"><code class="option">vim.languages.sql.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>SQL LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “sqls” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"sqls"</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/plugins/languages/sql.nix" target="_top"> +<nvf/modules/plugins/languages/sql.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.sql.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.sql.treesitter.enable"><code class="option">vim.languages.sql.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable SQL treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/sql.nix" target="_top"> +<nvf/modules/plugins/languages/sql.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.sql.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.sql.treesitter.package"><code class="option">vim.languages.sql.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>SQL treesitter grammar to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation sql-grammar-0.0.0+rev=f2a6b6f></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/plugins/languages/sql.nix" target="_top"> +<nvf/modules/plugins/languages/sql.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.svelte.enable"></a><a class="term" href="options.html#opt-vim.languages.svelte.enable"><code class="option">vim.languages.svelte.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Svelte language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/svelte.nix" target="_top"> +<nvf/modules/plugins/languages/svelte.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.svelte.extraDiagnostics.enable"></a><a class="term" href="options.html#opt-vim.languages.svelte.extraDiagnostics.enable"><code class="option">vim.languages.svelte.extraDiagnostics.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable extra Svelte diagnostics.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/svelte.nix" target="_top"> +<nvf/modules/plugins/languages/svelte.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.svelte.extraDiagnostics.types"></a><a class="term" href="options.html#opt-vim.languages.svelte.extraDiagnostics.types"><code class="option">vim.languages.svelte.extraDiagnostics.types</code> + </a> + </span> +</dt> +<dd> +<p>List of Svelte diagnostics to enable</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of (value “eslint_d” (singular enum) or (submodule))</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "eslint_d" +] +</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/plugins/languages/svelte.nix" target="_top"> +<nvf/modules/plugins/languages/svelte.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.svelte.format.enable"></a><a class="term" href="options.html#opt-vim.languages.svelte.format.enable"><code class="option">vim.languages.svelte.format.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Svelte formatting.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/svelte.nix" target="_top"> +<nvf/modules/plugins/languages/svelte.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.svelte.format.package"></a><a class="term" href="options.html#opt-vim.languages.svelte.format.package"><code class="option">vim.languages.svelte.format.package</code> + </a> + </span> +</dt> +<dd> +<p>Svelte formatter package</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation prettier-3.3.3></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/plugins/languages/svelte.nix" target="_top"> +<nvf/modules/plugins/languages/svelte.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.svelte.format.type"></a><a class="term" href="options.html#opt-vim.languages.svelte.format.type"><code class="option">vim.languages.svelte.format.type</code> + </a> + </span> +</dt> +<dd> +<p>Svelte formatter to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “biome”, “prettier”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"prettier"</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/plugins/languages/svelte.nix" target="_top"> +<nvf/modules/plugins/languages/svelte.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.svelte.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.svelte.lsp.enable"><code class="option">vim.languages.svelte.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Svelte LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/svelte.nix" target="_top"> +<nvf/modules/plugins/languages/svelte.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.svelte.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.svelte.lsp.package"><code class="option">vim.languages.svelte.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>Svelte LSP server package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation svelte-language-server-0.17.8></code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"</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/plugins/languages/svelte.nix" target="_top"> +<nvf/modules/plugins/languages/svelte.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.svelte.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.svelte.lsp.server"><code class="option">vim.languages.svelte.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>Svelte LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “svelte” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"svelte"</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/plugins/languages/svelte.nix" target="_top"> +<nvf/modules/plugins/languages/svelte.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.svelte.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.svelte.treesitter.enable"><code class="option">vim.languages.svelte.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Svelte treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/svelte.nix" target="_top"> +<nvf/modules/plugins/languages/svelte.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.svelte.treesitter.sveltePackage"></a><a class="term" href="options.html#opt-vim.languages.svelte.treesitter.sveltePackage"><code class="option">vim.languages.svelte.treesitter.sveltePackage</code> + </a> + </span> +</dt> +<dd> +<p>The svelte treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.svelte</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/plugins/languages/svelte.nix" target="_top"> +<nvf/modules/plugins/languages/svelte.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.tailwind.enable"></a><a class="term" href="options.html#opt-vim.languages.tailwind.enable"><code class="option">vim.languages.tailwind.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Tailwindcss language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/tailwind.nix" target="_top"> +<nvf/modules/plugins/languages/tailwind.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.tailwind.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.tailwind.lsp.enable"><code class="option">vim.languages.tailwind.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Tailwindcss LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/tailwind.nix" target="_top"> +<nvf/modules/plugins/languages/tailwind.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.tailwind.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.tailwind.lsp.package"><code class="option">vim.languages.tailwind.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>Tailwindcss LSP server package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation tailwindcss-language-server-0.0.27></code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"[lib.getExe pkgs.jdt-language-server \" - data \" \" ~/.cache/jdtls/workspace \"]"</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/plugins/languages/tailwind.nix" target="_top"> +<nvf/modules/plugins/languages/tailwind.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.tailwind.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.tailwind.lsp.server"><code class="option">vim.languages.tailwind.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>Tailwindcss LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “tailwindcss-language-server” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"tailwindcss-language-server"</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/plugins/languages/tailwind.nix" target="_top"> +<nvf/modules/plugins/languages/tailwind.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.terraform.enable"></a><a class="term" href="options.html#opt-vim.languages.terraform.enable"><code class="option">vim.languages.terraform.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Terraform/HCL support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/terraform.nix" target="_top"> +<nvf/modules/plugins/languages/terraform.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.terraform.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.terraform.lsp.enable"><code class="option">vim.languages.terraform.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Terraform LSP support (terraform-ls).</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/terraform.nix" target="_top"> +<nvf/modules/plugins/languages/terraform.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.terraform.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.terraform.lsp.package"><code class="option">vim.languages.terraform.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>terraform-ls package</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation terraform-ls-0.36.2></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/plugins/languages/terraform.nix" target="_top"> +<nvf/modules/plugins/languages/terraform.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.terraform.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.terraform.treesitter.enable"><code class="option">vim.languages.terraform.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Terraform treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/terraform.nix" target="_top"> +<nvf/modules/plugins/languages/terraform.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.terraform.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.terraform.treesitter.package"><code class="option">vim.languages.terraform.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The terraform treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.terraform</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/plugins/languages/terraform.nix" target="_top"> +<nvf/modules/plugins/languages/terraform.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ts.enable"></a><a class="term" href="options.html#opt-vim.languages.ts.enable"><code class="option">vim.languages.ts.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Typescript/Javascript language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/ts.nix" target="_top"> +<nvf/modules/plugins/languages/ts.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ts.extensions.ts-error-translator.enable"></a><a class="term" href="options.html#opt-vim.languages.ts.extensions.ts-error-translator.enable"><code class="option">vim.languages.ts.extensions.ts-error-translator.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable [ts-error-translator.nvim]: https://github.com/dmmulroy/ts-error-translator.nvim</p><p>Typescript error translation with [ts-error-translator.nvim]</p><p>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/ts.nix" target="_top"> +<nvf/modules/plugins/languages/ts.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ts.extensions.ts-error-translator.setupOpts"></a><a class="term" href="options.html#opt-vim.languages.ts.extensions.ts-error-translator.setupOpts"><code class="option">vim.languages.ts.extensions.ts-error-translator.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of ts-error-translator</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/languages/ts.nix" target="_top"> +<nvf/modules/plugins/languages/ts.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ts.extensions.ts-error-translator.setupOpts.auto_override_publish_diagnostics"></a><a class="term" href="options.html#opt-vim.languages.ts.extensions.ts-error-translator.setupOpts.auto_override_publish_diagnostics"><code class="option">vim.languages.ts.extensions.ts-error-translator.setupOpts.auto_override_publish_diagnostics</code> + </a> + </span> +</dt> +<dd> +<p>Automatically override the publish_diagnostics handler</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/plugins/languages/ts.nix" target="_top"> +<nvf/modules/plugins/languages/ts.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ts.extraDiagnostics.enable"></a><a class="term" href="options.html#opt-vim.languages.ts.extraDiagnostics.enable"><code class="option">vim.languages.ts.extraDiagnostics.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable extra Typescript/Javascript diagnostics.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/ts.nix" target="_top"> +<nvf/modules/plugins/languages/ts.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ts.extraDiagnostics.types"></a><a class="term" href="options.html#opt-vim.languages.ts.extraDiagnostics.types"><code class="option">vim.languages.ts.extraDiagnostics.types</code> + </a> + </span> +</dt> +<dd> +<p>List of Typescript/Javascript diagnostics to enable</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of (value “eslint_d” (singular enum) or (submodule))</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "eslint_d" +] +</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/plugins/languages/ts.nix" target="_top"> +<nvf/modules/plugins/languages/ts.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ts.format.enable"></a><a class="term" href="options.html#opt-vim.languages.ts.format.enable"><code class="option">vim.languages.ts.format.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Typescript/Javascript formatting.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/ts.nix" target="_top"> +<nvf/modules/plugins/languages/ts.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ts.format.package"></a><a class="term" href="options.html#opt-vim.languages.ts.format.package"><code class="option">vim.languages.ts.format.package</code> + </a> + </span> +</dt> +<dd> +<p>Typescript/Javascript formatter package</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation prettier-3.3.3></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/plugins/languages/ts.nix" target="_top"> +<nvf/modules/plugins/languages/ts.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ts.format.type"></a><a class="term" href="options.html#opt-vim.languages.ts.format.type"><code class="option">vim.languages.ts.format.type</code> + </a> + </span> +</dt> +<dd> +<p>Typescript/Javascript formatter to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “biome”, “prettier”, “prettierd”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"prettier"</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/plugins/languages/ts.nix" target="_top"> +<nvf/modules/plugins/languages/ts.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ts.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.ts.lsp.enable"><code class="option">vim.languages.ts.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Typescript/Javascript LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/ts.nix" target="_top"> +<nvf/modules/plugins/languages/ts.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ts.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.ts.lsp.package"><code class="option">vim.languages.ts.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>Typescript/Javascript LSP server package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation typescript-language-server-4.3.3></code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"</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/plugins/languages/ts.nix" target="_top"> +<nvf/modules/plugins/languages/ts.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ts.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.ts.lsp.server"><code class="option">vim.languages.ts.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>Typescript/Javascript LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “denols”, “ts_ls”, “tsserver”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"ts_ls"</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/plugins/languages/ts.nix" target="_top"> +<nvf/modules/plugins/languages/ts.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ts.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.ts.treesitter.enable"><code class="option">vim.languages.ts.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Typescript/Javascript treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/ts.nix" target="_top"> +<nvf/modules/plugins/languages/ts.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ts.treesitter.jsPackage"></a><a class="term" href="options.html#opt-vim.languages.ts.treesitter.jsPackage"><code class="option">vim.languages.ts.treesitter.jsPackage</code> + </a> + </span> +</dt> +<dd> +<p>The javascript treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.javascript</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/plugins/languages/ts.nix" target="_top"> +<nvf/modules/plugins/languages/ts.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.ts.treesitter.tsPackage"></a><a class="term" href="options.html#opt-vim.languages.ts.treesitter.tsPackage"><code class="option">vim.languages.ts.treesitter.tsPackage</code> + </a> + </span> +</dt> +<dd> +<p>The tsx treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.tsx</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/plugins/languages/ts.nix" target="_top"> +<nvf/modules/plugins/languages/ts.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.typst.enable"></a><a class="term" href="options.html#opt-vim.languages.typst.enable"><code class="option">vim.languages.typst.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Typst language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/typst.nix" target="_top"> +<nvf/modules/plugins/languages/typst.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.typst.extensions.typst-preview-nvim.enable"></a><a class="term" href="options.html#opt-vim.languages.typst.extensions.typst-preview-nvim.enable"><code class="option">vim.languages.typst.extensions.typst-preview-nvim.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable [typst-preview.nvim]: https://github.com/chomosuke/typst-preview.nvim</p><p>Low latency typst preview for Neovim via [typst-preview.nvim] +.</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>Example:</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/plugins/languages/typst.nix" target="_top"> +<nvf/modules/plugins/languages/typst.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.typst.extensions.typst-preview-nvim.setupOpts"></a><a class="term" href="options.html#opt-vim.languages.typst.extensions.typst-preview-nvim.setupOpts"><code class="option">vim.languages.typst.extensions.typst-preview-nvim.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of typst-preview-nvim</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/languages/typst.nix" target="_top"> +<nvf/modules/plugins/languages/typst.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.typst.extensions.typst-preview-nvim.setupOpts.dependencies_bin"></a><a class="term" href="options.html#opt-vim.languages.typst.extensions.typst-preview-nvim.setupOpts.dependencies_bin"><code class="option">vim.languages.typst.extensions.typst-preview-nvim.setupOpts.dependencies_bin</code> + </a> + </span> +</dt> +<dd> +<p>Provide the path to binaries for dependencies. Setting this +to a non-null value will skip the download of the binary by +the plugin.</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + tinymist = "\${pkgs.tinymist.out}/bin/tinymist"; + websocat = "\${pkgs.websocat.out}/bin/websocat"; +} +</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/plugins/languages/typst.nix" target="_top"> +<nvf/modules/plugins/languages/typst.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.typst.extensions.typst-preview-nvim.setupOpts.extra_args"></a><a class="term" href="options.html#opt-vim.languages.typst.extensions.typst-preview-nvim.setupOpts.extra_args"><code class="option">vim.languages.typst.extensions.typst-preview-nvim.setupOpts.extra_args</code> + </a> + </span> +</dt> +<dd> +<p>A list of extra arguments (or <code class="literal">null</code>) to be passed to previewer</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or (list of string)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</code></p> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">[ + "--input=ver=draft" + "--ignore-system-fonts" +] +</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/plugins/languages/typst.nix" target="_top"> +<nvf/modules/plugins/languages/typst.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.typst.extensions.typst-preview-nvim.setupOpts.open_cmd"></a><a class="term" href="options.html#opt-vim.languages.typst.extensions.typst-preview-nvim.setupOpts.open_cmd"><code class="option">vim.languages.typst.extensions.typst-preview-nvim.setupOpts.open_cmd</code> + </a> + </span> +</dt> +<dd> +<p>Custom format string to open the output link provided with <code class="literal">%s</code></p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"firefox %s -P typst-preview --class typst-preview"</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/plugins/languages/typst.nix" target="_top"> +<nvf/modules/plugins/languages/typst.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.typst.format.enable"></a><a class="term" href="options.html#opt-vim.languages.typst.format.enable"><code class="option">vim.languages.typst.format.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Typst document formatting.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/typst.nix" target="_top"> +<nvf/modules/plugins/languages/typst.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.typst.format.package"></a><a class="term" href="options.html#opt-vim.languages.typst.format.package"><code class="option">vim.languages.typst.format.package</code> + </a> + </span> +</dt> +<dd> +<p>Typst formatter package</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation typstfmt-0.2.9></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/plugins/languages/typst.nix" target="_top"> +<nvf/modules/plugins/languages/typst.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.typst.format.type"></a><a class="term" href="options.html#opt-vim.languages.typst.format.type"><code class="option">vim.languages.typst.format.type</code> + </a> + </span> +</dt> +<dd> +<p>Typst formatter to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “typstfmt”, “typstyle”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"typstfmt"</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/plugins/languages/typst.nix" target="_top"> +<nvf/modules/plugins/languages/typst.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.typst.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.typst.lsp.enable"><code class="option">vim.languages.typst.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Typst LSP support (typst-lsp).</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/typst.nix" target="_top"> +<nvf/modules/plugins/languages/typst.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.typst.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.typst.lsp.package"><code class="option">vim.languages.typst.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>typst-lsp package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation tinymist-0.12.14></code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"</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/plugins/languages/typst.nix" target="_top"> +<nvf/modules/plugins/languages/typst.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.typst.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.typst.lsp.server"><code class="option">vim.languages.typst.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>Typst LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “tinymist”, “typst-lsp”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"tinymist"</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/plugins/languages/typst.nix" target="_top"> +<nvf/modules/plugins/languages/typst.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.typst.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.typst.treesitter.enable"><code class="option">vim.languages.typst.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Typst treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/typst.nix" target="_top"> +<nvf/modules/plugins/languages/typst.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.typst.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.typst.treesitter.package"><code class="option">vim.languages.typst.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The typst treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.typst</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/plugins/languages/typst.nix" target="_top"> +<nvf/modules/plugins/languages/typst.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.vala.enable"></a><a class="term" href="options.html#opt-vim.languages.vala.enable"><code class="option">vim.languages.vala.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Vala language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/vala.nix" target="_top"> +<nvf/modules/plugins/languages/vala.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.vala.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.vala.lsp.enable"><code class="option">vim.languages.vala.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Vala LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/vala.nix" target="_top"> +<nvf/modules/plugins/languages/vala.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.vala.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.vala.lsp.package"><code class="option">vim.languages.vala.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>Vala LSP server package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation vala-language-server-wrapper></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/plugins/languages/vala.nix" target="_top"> +<nvf/modules/plugins/languages/vala.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.vala.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.vala.lsp.server"><code class="option">vim.languages.vala.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>Vala LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “vala_ls” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"vala_ls"</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/plugins/languages/vala.nix" target="_top"> +<nvf/modules/plugins/languages/vala.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.vala.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.vala.treesitter.enable"><code class="option">vim.languages.vala.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Vala treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/vala.nix" target="_top"> +<nvf/modules/plugins/languages/vala.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.vala.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.vala.treesitter.package"><code class="option">vim.languages.vala.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The vala treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.vala</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/plugins/languages/vala.nix" target="_top"> +<nvf/modules/plugins/languages/vala.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.wgsl.enable"></a><a class="term" href="options.html#opt-vim.languages.wgsl.enable"><code class="option">vim.languages.wgsl.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable WGSL language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/wgsl.nix" target="_top"> +<nvf/modules/plugins/languages/wgsl.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.wgsl.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.wgsl.lsp.enable"><code class="option">vim.languages.wgsl.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable WGSL LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/wgsl.nix" target="_top"> +<nvf/modules/plugins/languages/wgsl.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.wgsl.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.wgsl.lsp.package"><code class="option">vim.languages.wgsl.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>wgsl-analyzer package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation wgsl-analyzer-0.8.1></code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">[(lib.getExe pkgs.wgsl-analyzer)]</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/plugins/languages/wgsl.nix" target="_top"> +<nvf/modules/plugins/languages/wgsl.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.wgsl.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.wgsl.lsp.server"><code class="option">vim.languages.wgsl.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>WGSL LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “wgsl-analyzer” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"wgsl-analyzer"</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/plugins/languages/wgsl.nix" target="_top"> +<nvf/modules/plugins/languages/wgsl.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.wgsl.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.wgsl.treesitter.enable"><code class="option">vim.languages.wgsl.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable WGSL treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/wgsl.nix" target="_top"> +<nvf/modules/plugins/languages/wgsl.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.wgsl.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.wgsl.treesitter.package"><code class="option">vim.languages.wgsl.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The wgsl treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.wgsl</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/plugins/languages/wgsl.nix" target="_top"> +<nvf/modules/plugins/languages/wgsl.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.zig.enable"></a><a class="term" href="options.html#opt-vim.languages.zig.enable"><code class="option">vim.languages.zig.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Zig language support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/zig.nix" target="_top"> +<nvf/modules/plugins/languages/zig.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.zig.lsp.enable"></a><a class="term" href="options.html#opt-vim.languages.zig.lsp.enable"><code class="option">vim.languages.zig.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Zig LSP support.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/zig.nix" target="_top"> +<nvf/modules/plugins/languages/zig.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.zig.lsp.package"></a><a class="term" href="options.html#opt-vim.languages.zig.lsp.package"><code class="option">vim.languages.zig.lsp.package</code> + </a> + </span> +</dt> +<dd> +<p>ZLS package, or the command to run as a list of strings</p> + +<p><span class="emphasis"><em>Type:</em></span> +package or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation zls-0.13.0></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/plugins/languages/zig.nix" target="_top"> +<nvf/modules/plugins/languages/zig.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.zig.lsp.server"></a><a class="term" href="options.html#opt-vim.languages.zig.lsp.server"><code class="option">vim.languages.zig.lsp.server</code> + </a> + </span> +</dt> +<dd> +<p>Zig LSP server to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “zls” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"zls"</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/plugins/languages/zig.nix" target="_top"> +<nvf/modules/plugins/languages/zig.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.zig.treesitter.enable"></a><a class="term" href="options.html#opt-vim.languages.zig.treesitter.enable"><code class="option">vim.languages.zig.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Zig treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/languages/zig.nix" target="_top"> +<nvf/modules/plugins/languages/zig.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.languages.zig.treesitter.package"></a><a class="term" href="options.html#opt-vim.languages.zig.treesitter.package"><code class="option">vim.languages.zig.treesitter.package</code> + </a> + </span> +</dt> +<dd> +<p>The zig treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.zig</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/plugins/languages/zig.nix" target="_top"> +<nvf/modules/plugins/languages/zig.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lazy.enable"></a><a class="term" href="options.html#opt-vim.lazy.enable"><code class="option">vim.lazy.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable plugin lazy-loading via lz.n and lzn-auto-require.</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>Example:</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/wrapper/lazy/lazy.nix" target="_top"> +<nvf/modules/wrapper/lazy/lazy.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lazy.enableLznAutoRequire"></a><a class="term" href="options.html#opt-vim.lazy.enableLznAutoRequire"><code class="option">vim.lazy.enableLznAutoRequire</code> + </a> + </span> +</dt> +<dd> +<p>Enable lzn-auto-require. Since builtin plugins rely on this, only turn +off for debugging.</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/wrapper/lazy/lazy.nix" target="_top"> +<nvf/modules/wrapper/lazy/lazy.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lazy.loader"></a><a class="term" href="options.html#opt-vim.lazy.loader"><code class="option">vim.lazy.loader</code> + </a> + </span> +</dt> +<dd> +<p>Lazy loader to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +value “lz.n” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"lz.n"</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/lazy/lazy.nix" target="_top"> +<nvf/modules/wrapper/lazy/lazy.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lazy.plugins"></a><a class="term" href="options.html#opt-vim.lazy.plugins"><code class="option">vim.lazy.plugins</code> + </a> + </span> +</dt> +<dd> +<p>Plugins to lazy load.</p><p>The attribute key is used as the plugin name: for the default <code class="literal">vim.g.lz_n.load</code> +function this should be either the <code class="literal">package.pname</code> or <code class="literal">package.name</code>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of (submodule)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</code></p> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">'' + { + toggleterm-nvim = { + package = "toggleterm-nvim"; + setupModule = "toggleterm"; + setupOpts = cfg.setupOpts; + + after = "require('toggleterm').do_something()"; + cmd = ["ToggleTerm"]; + }; + + $''${pkgs.vimPlugins.vim-bbye.pname} = { + package = pkgs.vimPlugins.vim-bbye; + cmd = ["Bdelete" "Bwipeout"]; + }; + } +'' +</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/lazy/lazy.nix" target="_top"> +<nvf/modules/wrapper/lazy/lazy.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lazy.plugins._name_.enabled"></a><a class="term" href="options.html#opt-vim.lazy.plugins._name_.enabled"><code class="option">vim.lazy.plugins.<name>.enabled</code> + </a> + </span> +</dt> +<dd> +<p>When false, or if the lua function returns false, this plugin will not be included in the spec</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/lazy/lazy.nix" target="_top"> +<nvf/modules/wrapper/lazy/lazy.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lazy.plugins._name_.package"></a><a class="term" href="options.html#opt-vim.lazy.plugins._name_.package"><code class="option">vim.lazy.plugins.<name>.package</code> + </a> + </span> +</dt> +<dd> +<p>Plugin package.</p><p>If null, a custom load function must be provided</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or null or package or one of “aerial-nvim”, “alpha-nvim”, “base16”, “bufdelete-nvim”, “catppuccin”, “ccc”, “cellular-automaton”, “chatgpt”, “cheatsheet-nvim”, “cinnamon-nvim”, “cmp-buffer”, “cmp-luasnip”, “cmp-nvim-lsp”, “cmp-path”, “cmp-treesitter”, “codewindow-nvim”, “comment-nvim”, “copilot-cmp”, “copilot-lua”, “crates-nvim”, “csharpls-extended”, “dashboard-nvim”, “diffview-nvim”, “dracula”, “dressing-nvim”, “elixir-tools”, “fastaction-nvim”, “fidget-nvim”, “flutter-tools”, “friendly-snippets”, “fzf-lua”, “gesture-nvim”, “gitsigns-nvim”, “glow-nvim”, “gruvbox”, “haskell-tools-nvim”, “highlight-undo”, “hop-nvim”, “icon-picker-nvim”, “image-nvim”, “indent-blankline”, “leap-nvim”, “lsp-lines”, “lsp-signature”, “lspkind”, “lspsaga”, “lua-utils-nvim”, “lualine”, “luasnip”, “lz-n”, “lzn-auto-require”, “mind-nvim”, “mini-ai”, “mini-align”, “mini-animate”, “mini-base16”, “mini-basics”, “mini-bracketed”, “mini-bufremove”, “mini-clue”, “mini-colors”, “mini-comment”, “mini-completion”, “mini-diff”, “mini-doc”, “mini-extra”, “mini-files”, “mini-fuzzy”, “mini-git”, “mini-hipatterns”, “mini-hues”, “mini-icons”, “mini-indentscope”, “mini-jump”, “mini-jump2d”, “mini-map”, “mini-misc”, “mini-move”, “mini-notify”, “mini-operators”, “mini-pairs”, “mini-pick”, “mini-sessions”, “mini-snippets”, “mini-splitjoin”, “mini-starter”, “mini-statusline”, “mini-surround”, “mini-tabline”, “mini-test”, “mini-trailspace”, “mini-visits”, “minimap-vim”, “modes-nvim”, “neo-tree-nvim”, “neocord”, “neodev-nvim”, “neorg”, “neorg-telescope”, “new-file-template-nvim”, “noice-nvim”, “none-ls”, “nord”, “nui-nvim”, “nvim-autopairs”, “nvim-bufferline-lua”, “nvim-cmp”, “nvim-colorizer-lua”, “nvim-cursorline”, “nvim-dap”, “nvim-dap-go”, “nvim-dap-ui”, “nvim-docs-view”, “nvim-lightbulb”, “nvim-lspconfig”, “nvim-metals”, “nvim-navbuddy”, “nvim-navic”, “nvim-neoclip”, “nvim-nio”, “nvim-notify”, “nvim-scrollbar”, “nvim-session-manager”, “nvim-surround”, “nvim-tree-lua”, “nvim-treesitter-context”, “nvim-ts-autotag”, “nvim-ufo”, “nvim-web-devicons”, “obsidian-nvim”, “omnisharp-extended”, “onedark”, “orgmode-nvim”, “otter-nvim”, “oxocarbon”, “pathlib-nvim”, “plenary-nvim”, “precognition-nvim”, “project-nvim”, “promise-async”, “registers”, “render-markdown-nvim”, “rose-pine”, “rtp-nvim”, “run-nvim”, “rustaceanvim”, “smartcolumn”, “sqls-nvim”, “tabular”, “telescope”, “tiny-devicons-auto-colors”, “todo-comments”, “toggleterm-nvim”, “tokyonight”, “trouble”, “ts-error-translator”, “typst-preview-nvim”, “vim-dirtytalk”, “vim-fugitive”, “vim-illuminate”, “vim-markdown”, “vim-repeat”, “vim-startify”, “which-key”, “nvim-treesitter”, “flutter-tools-patched”, “vim-repeat”</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/lazy/lazy.nix" target="_top"> +<nvf/modules/wrapper/lazy/lazy.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lazy.plugins._name_.after"></a><a class="term" href="options.html#opt-vim.lazy.plugins._name_.after"><code class="option">vim.lazy.plugins.<name>.after</code> + </a> + </span> +</dt> +<dd> +<p>Lua code to run after plugin is loaded. This will be wrapped in a function.</p><p>If <a class="xref" href="options.html#opt-vim.lazy.plugins._name_.setupModule" ><code class="option">vim.lazy.plugins.<name>.setupModule</code></a> is provided, the setup will be ran before <code class="literal">after</code>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or strings concatenated with “\n”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/lazy/lazy.nix" target="_top"> +<nvf/modules/wrapper/lazy/lazy.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lazy.plugins._name_.before"></a><a class="term" href="options.html#opt-vim.lazy.plugins._name_.before"><code class="option">vim.lazy.plugins.<name>.before</code> + </a> + </span> +</dt> +<dd> +<p>Lua code to run before plugin is loaded. This will be wrapped in a function.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or strings concatenated with “\n”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/lazy/lazy.nix" target="_top"> +<nvf/modules/wrapper/lazy/lazy.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lazy.plugins._name_.beforeAll"></a><a class="term" href="options.html#opt-vim.lazy.plugins._name_.beforeAll"><code class="option">vim.lazy.plugins.<name>.beforeAll</code> + </a> + </span> +</dt> +<dd> +<p>Lua code to run before any plugins are loaded. This will be wrapped in a function.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or strings concatenated with “\n”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/lazy/lazy.nix" target="_top"> +<nvf/modules/wrapper/lazy/lazy.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lazy.plugins._name_.beforeSetup"></a><a class="term" href="options.html#opt-vim.lazy.plugins._name_.beforeSetup"><code class="option">vim.lazy.plugins.<name>.beforeSetup</code> + </a> + </span> +</dt> +<dd> +<p>Lua code to run after the plugin is loaded, but before the setup +function is called.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or strings concatenated with “\n”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/lazy/lazy.nix" target="_top"> +<nvf/modules/wrapper/lazy/lazy.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lazy.plugins._name_.cmd"></a><a class="term" href="options.html#opt-vim.lazy.plugins._name_.cmd"><code class="option">vim.lazy.plugins.<name>.cmd</code> + </a> + </span> +</dt> +<dd> +<p>Lazy-load on command</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/lazy/lazy.nix" target="_top"> +<nvf/modules/wrapper/lazy/lazy.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lazy.plugins._name_.colorscheme"></a><a class="term" href="options.html#opt-vim.lazy.plugins._name_.colorscheme"><code class="option">vim.lazy.plugins.<name>.colorscheme</code> + </a> + </span> +</dt> +<dd> +<p>Lazy-load on colorscheme.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/lazy/lazy.nix" target="_top"> +<nvf/modules/wrapper/lazy/lazy.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lazy.plugins._name_.event"></a><a class="term" href="options.html#opt-vim.lazy.plugins._name_.event"><code class="option">vim.lazy.plugins.<name>.event</code> + </a> + </span> +</dt> +<dd> +<p>Lazy-load on event</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string or list of string or (submodule)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/lazy/lazy.nix" target="_top"> +<nvf/modules/wrapper/lazy/lazy.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lazy.plugins._name_.ft"></a><a class="term" href="options.html#opt-vim.lazy.plugins._name_.ft"><code class="option">vim.lazy.plugins.<name>.ft</code> + </a> + </span> +</dt> +<dd> +<p>Lazy-load on filetype</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/lazy/lazy.nix" target="_top"> +<nvf/modules/wrapper/lazy/lazy.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lazy.plugins._name_.keys"></a><a class="term" href="options.html#opt-vim.lazy.plugins._name_.keys"><code class="option">vim.lazy.plugins.<name>.keys</code> + </a> + </span> +</dt> +<dd> +<p>Lazy-load on key mapping</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string or list of (submodule) or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</code></p> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">'' + keys = [ + { + mode = "n"; + key = "<leader>s"; + action = ":DapStepOver<cr>"; + desc = "DAP Step Over"; + } + { + mode = ["n", "x"]; + key = "<leader>dc"; + action = "function() require('dap').continue() end"; + lua = true; + desc = "DAP Continue"; + } + ] +'' +</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/lazy/lazy.nix" target="_top"> +<nvf/modules/wrapper/lazy/lazy.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lazy.plugins._name_.lazy"></a><a class="term" href="options.html#opt-vim.lazy.plugins._name_.lazy"><code class="option">vim.lazy.plugins.<name>.lazy</code> + </a> + </span> +</dt> +<dd> +<p>Lazy-load manually, e.g. using <code class="literal">trigger_load</code>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/lazy/lazy.nix" target="_top"> +<nvf/modules/wrapper/lazy/lazy.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lazy.plugins._name_.load"></a><a class="term" href="options.html#opt-vim.lazy.plugins._name_.load"><code class="option">vim.lazy.plugins.<name>.load</code> + </a> + </span> +</dt> +<dd> +<p>Lua code to override the <code class="literal">vim.g.lz_n.load()</code> function for a single plugin.</p><p>This will be wrapped in a <code class="literal">function(name) ... end</code>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or strings concatenated with “\n”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/lazy/lazy.nix" target="_top"> +<nvf/modules/wrapper/lazy/lazy.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lazy.plugins._name_.priority"></a><a class="term" href="options.html#opt-vim.lazy.plugins._name_.priority"><code class="option">vim.lazy.plugins.<name>.priority</code> + </a> + </span> +</dt> +<dd> +<p>Only useful for stat plugins (not lazy-loaded) to force loading certain plugins first.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/lazy/lazy.nix" target="_top"> +<nvf/modules/wrapper/lazy/lazy.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lazy.plugins._name_.setupModule"></a><a class="term" href="options.html#opt-vim.lazy.plugins._name_.setupModule"><code class="option">vim.lazy.plugins.<name>.setupModule</code> + </a> + </span> +</dt> +<dd> +<p>Lua module to run setup function on.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/lazy/lazy.nix" target="_top"> +<nvf/modules/wrapper/lazy/lazy.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lazy.plugins._name_.setupOpts"></a><a class="term" href="options.html#opt-vim.lazy.plugins._name_.setupOpts"><code class="option">vim.lazy.plugins.<name>.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Options to pass to the setup function</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/lazy/lazy.nix" target="_top"> +<nvf/modules/wrapper/lazy/lazy.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lineNumberMode"></a><a class="term" href="options.html#opt-vim.lineNumberMode"><code class="option">vim.lineNumberMode</code> + </a> + </span> +</dt> +<dd> +<p>How line numbers are displayed.</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “relative”, “number”, “relNumber”, “none”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"relNumber"</code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"none"</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"> +<nvf/modules/neovim/init/basic.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.enable"></a><a class="term" href="options.html#opt-vim.lsp.enable"><code class="option">vim.lsp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable LSP, also enabled automatically through null-ls and lspconfig options.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/lsp/module.nix" target="_top"> +<nvf/modules/plugins/lsp/module.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.formatOnSave"></a><a class="term" href="options.html#opt-vim.lsp.formatOnSave"><code class="option">vim.lsp.formatOnSave</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable format on save.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/lsp/module.nix" target="_top"> +<nvf/modules/plugins/lsp/module.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.lightbulb.enable"></a><a class="term" href="options.html#opt-vim.lsp.lightbulb.enable"><code class="option">vim.lsp.lightbulb.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Lightbulb for code actions. Requires an emoji font.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/lsp/lightbulb/lightbulb.nix" target="_top"> +<nvf/modules/plugins/lsp/lightbulb/lightbulb.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.lightbulb.setupOpts"></a><a class="term" href="options.html#opt-vim.lsp.lightbulb.setupOpts"><code class="option">vim.lsp.lightbulb.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of nvim-lightbulb</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/lsp/lightbulb/lightbulb.nix" target="_top"> +<nvf/modules/plugins/lsp/lightbulb/lightbulb.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.lspSignature.enable"></a><a class="term" href="options.html#opt-vim.lsp.lspSignature.enable"><code class="option">vim.lsp.lspSignature.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable lsp signature viewer.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/lsp/lsp-signature/lsp-signature.nix" target="_top"> +<nvf/modules/plugins/lsp/lsp-signature/lsp-signature.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.lspSignature.setupOpts"></a><a class="term" href="options.html#opt-vim.lsp.lspSignature.setupOpts"><code class="option">vim.lsp.lspSignature.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of lsp-signature</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/lsp/lsp-signature/lsp-signature.nix" target="_top"> +<nvf/modules/plugins/lsp/lsp-signature/lsp-signature.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.lspconfig.enable"></a><a class="term" href="options.html#opt-vim.lsp.lspconfig.enable"><code class="option">vim.lsp.lspconfig.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable nvim-lspconfig, also enabled automatically.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/lsp/lspconfig/lspconfig.nix" target="_top"> +<nvf/modules/plugins/lsp/lspconfig/lspconfig.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.lspconfig.sources"></a><a class="term" href="options.html#opt-vim.lsp.lspconfig.sources"><code class="option">vim.lsp.lspconfig.sources</code> + </a> + </span> +</dt> +<dd> +<p>nvim-lspconfig sources</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/lsp/lspconfig/lspconfig.nix" target="_top"> +<nvf/modules/plugins/lsp/lspconfig/lspconfig.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.lspkind.enable"></a><a class="term" href="options.html#opt-vim.lsp.lspkind.enable"><code class="option">vim.lsp.lspkind.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable vscode-like pictograms for lsp [lspkind].</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/lsp/lspkind/lspkind.nix" target="_top"> +<nvf/modules/plugins/lsp/lspkind/lspkind.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.lspkind.setupOpts"></a><a class="term" href="options.html#opt-vim.lsp.lspkind.setupOpts"><code class="option">vim.lsp.lspkind.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of lspkind.nvim</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/lsp/lspkind/lspkind.nix" target="_top"> +<nvf/modules/plugins/lsp/lspkind/lspkind.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.lspkind.setupOpts.before"></a><a class="term" href="options.html#opt-vim.lsp.lspkind.setupOpts.before"><code class="option">vim.lsp.lspkind.setupOpts.before</code> + </a> + </span> +</dt> +<dd> +<p>The function that will be called before lspkind’s modifications are applied</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or (luaInline)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/lsp/lspkind/lspkind.nix" target="_top"> +<nvf/modules/plugins/lsp/lspkind/lspkind.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.lspkind.setupOpts.mode"></a><a class="term" href="options.html#opt-vim.lsp.lspkind.setupOpts.mode"><code class="option">vim.lsp.lspkind.setupOpts.mode</code> + </a> + </span> +</dt> +<dd> +<p>Defines how annotations are shown</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “text”, “text_symbol”, “symbol_text”, “symbol”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"symbol_text"</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/plugins/lsp/lspkind/lspkind.nix" target="_top"> +<nvf/modules/plugins/lsp/lspkind/lspkind.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.lsplines.enable"></a><a class="term" href="options.html#opt-vim.lsp.lsplines.enable"><code class="option">vim.lsp.lsplines.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable diagnostics using virtual lines on top of the real line of code. [lsp_lines] +.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/lsp/lsplines/lsplines.nix" target="_top"> +<nvf/modules/plugins/lsp/lsplines/lsplines.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.lspsaga.enable"></a><a class="term" href="options.html#opt-vim.lsp.lspsaga.enable"><code class="option">vim.lsp.lspsaga.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable LSP Saga.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/lsp/lspsaga/lspsaga.nix" target="_top"> +<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.lspsaga.mappings.codeAction"></a><a class="term" href="options.html#opt-vim.lsp.lspsaga.mappings.codeAction"><code class="option">vim.lsp.lspsaga.mappings.codeAction</code> + </a> + </span> +</dt> +<dd> +<p>Code action [LSPSaga]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>ca"</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/plugins/lsp/lspsaga/lspsaga.nix" target="_top"> +<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.lspsaga.mappings.lspFinder"></a><a class="term" href="options.html#opt-vim.lsp.lspsaga.mappings.lspFinder"><code class="option">vim.lsp.lspsaga.mappings.lspFinder</code> + </a> + </span> +</dt> +<dd> +<p>LSP Finder [LSPSaga]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>lf"</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/plugins/lsp/lspsaga/lspsaga.nix" target="_top"> +<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.lspsaga.mappings.nextDiagnostic"></a><a class="term" href="options.html#opt-vim.lsp.lspsaga.mappings.nextDiagnostic"><code class="option">vim.lsp.lspsaga.mappings.nextDiagnostic</code> + </a> + </span> +</dt> +<dd> +<p>Next diagnostic [LSPSaga]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>ln"</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/plugins/lsp/lspsaga/lspsaga.nix" target="_top"> +<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.lspsaga.mappings.previewDefinition"></a><a class="term" href="options.html#opt-vim.lsp.lspsaga.mappings.previewDefinition"><code class="option">vim.lsp.lspsaga.mappings.previewDefinition</code> + </a> + </span> +</dt> +<dd> +<p>Preview definition [LSPSaga]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>ld"</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/plugins/lsp/lspsaga/lspsaga.nix" target="_top"> +<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.lspsaga.mappings.previousDiagnostic"></a><a class="term" href="options.html#opt-vim.lsp.lspsaga.mappings.previousDiagnostic"><code class="option">vim.lsp.lspsaga.mappings.previousDiagnostic</code> + </a> + </span> +</dt> +<dd> +<p>Previous diagnostic [LSPSaga]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>lp"</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/plugins/lsp/lspsaga/lspsaga.nix" target="_top"> +<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.lspsaga.mappings.rename"></a><a class="term" href="options.html#opt-vim.lsp.lspsaga.mappings.rename"><code class="option">vim.lsp.lspsaga.mappings.rename</code> + </a> + </span> +</dt> +<dd> +<p>Rename [LSPSaga]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>lr"</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/plugins/lsp/lspsaga/lspsaga.nix" target="_top"> +<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.lspsaga.mappings.renderHoveredDoc"></a><a class="term" href="options.html#opt-vim.lsp.lspsaga.mappings.renderHoveredDoc"><code class="option">vim.lsp.lspsaga.mappings.renderHoveredDoc</code> + </a> + </span> +</dt> +<dd> +<p>Rendered hovered docs [LSPSaga]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>lh"</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/plugins/lsp/lspsaga/lspsaga.nix" target="_top"> +<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.lspsaga.mappings.showCursorDiagnostics"></a><a class="term" href="options.html#opt-vim.lsp.lspsaga.mappings.showCursorDiagnostics"><code class="option">vim.lsp.lspsaga.mappings.showCursorDiagnostics</code> + </a> + </span> +</dt> +<dd> +<p>Show cursor diagnostics [LSPSaga]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>lc"</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/plugins/lsp/lspsaga/lspsaga.nix" target="_top"> +<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.lspsaga.mappings.showLineDiagnostics"></a><a class="term" href="options.html#opt-vim.lsp.lspsaga.mappings.showLineDiagnostics"><code class="option">vim.lsp.lspsaga.mappings.showLineDiagnostics</code> + </a> + </span> +</dt> +<dd> +<p>Show line diagnostics [LSPSaga]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>ll"</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/plugins/lsp/lspsaga/lspsaga.nix" target="_top"> +<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.lspsaga.mappings.signatureHelp"></a><a class="term" href="options.html#opt-vim.lsp.lspsaga.mappings.signatureHelp"><code class="option">vim.lsp.lspsaga.mappings.signatureHelp</code> + </a> + </span> +</dt> +<dd> +<p>Signature help [LSPSaga]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>ls"</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/plugins/lsp/lspsaga/lspsaga.nix" target="_top"> +<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.lspsaga.mappings.smartScrollDown"></a><a class="term" href="options.html#opt-vim.lsp.lspsaga.mappings.smartScrollDown"><code class="option">vim.lsp.lspsaga.mappings.smartScrollDown</code> + </a> + </span> +</dt> +<dd> +<p>Smart scroll up [LSPSaga]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<C-b>"</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/plugins/lsp/lspsaga/lspsaga.nix" target="_top"> +<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.lspsaga.mappings.smartScrollUp"></a><a class="term" href="options.html#opt-vim.lsp.lspsaga.mappings.smartScrollUp"><code class="option">vim.lsp.lspsaga.mappings.smartScrollUp</code> + </a> + </span> +</dt> +<dd> +<p>Smart scroll up [LSPSaga]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<C-f>"</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/plugins/lsp/lspsaga/lspsaga.nix" target="_top"> +<nvf/modules/plugins/lsp/lspsaga/lspsaga.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.mappings.addWorkspaceFolder"></a><a class="term" href="options.html#opt-vim.lsp.mappings.addWorkspaceFolder"><code class="option">vim.lsp.mappings.addWorkspaceFolder</code> + </a> + </span> +</dt> +<dd> +<p>Add workspace folder</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>lwa"</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/plugins/lsp/module.nix" target="_top"> +<nvf/modules/plugins/lsp/module.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.mappings.codeAction"></a><a class="term" href="options.html#opt-vim.lsp.mappings.codeAction"><code class="option">vim.lsp.mappings.codeAction</code> + </a> + </span> +</dt> +<dd> +<p>Code action</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>la"</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/plugins/lsp/module.nix" target="_top"> +<nvf/modules/plugins/lsp/module.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.mappings.documentHighlight"></a><a class="term" href="options.html#opt-vim.lsp.mappings.documentHighlight"><code class="option">vim.lsp.mappings.documentHighlight</code> + </a> + </span> +</dt> +<dd> +<p>Document highlight</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>lH"</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/plugins/lsp/module.nix" target="_top"> +<nvf/modules/plugins/lsp/module.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.mappings.format"></a><a class="term" href="options.html#opt-vim.lsp.mappings.format"><code class="option">vim.lsp.mappings.format</code> + </a> + </span> +</dt> +<dd> +<p>Format</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>lf"</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/plugins/lsp/module.nix" target="_top"> +<nvf/modules/plugins/lsp/module.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.mappings.goToDeclaration"></a><a class="term" href="options.html#opt-vim.lsp.mappings.goToDeclaration"><code class="option">vim.lsp.mappings.goToDeclaration</code> + </a> + </span> +</dt> +<dd> +<p>Go to declaration</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>lgD"</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/plugins/lsp/module.nix" target="_top"> +<nvf/modules/plugins/lsp/module.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.mappings.goToDefinition"></a><a class="term" href="options.html#opt-vim.lsp.mappings.goToDefinition"><code class="option">vim.lsp.mappings.goToDefinition</code> + </a> + </span> +</dt> +<dd> +<p>Go to definition</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>lgd"</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/plugins/lsp/module.nix" target="_top"> +<nvf/modules/plugins/lsp/module.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.mappings.goToType"></a><a class="term" href="options.html#opt-vim.lsp.mappings.goToType"><code class="option">vim.lsp.mappings.goToType</code> + </a> + </span> +</dt> +<dd> +<p>Go to type</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>lgt"</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/plugins/lsp/module.nix" target="_top"> +<nvf/modules/plugins/lsp/module.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.mappings.hover"></a><a class="term" href="options.html#opt-vim.lsp.mappings.hover"><code class="option">vim.lsp.mappings.hover</code> + </a> + </span> +</dt> +<dd> +<p>Trigger hover</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>lh"</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/plugins/lsp/module.nix" target="_top"> +<nvf/modules/plugins/lsp/module.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.mappings.listDocumentSymbols"></a><a class="term" href="options.html#opt-vim.lsp.mappings.listDocumentSymbols"><code class="option">vim.lsp.mappings.listDocumentSymbols</code> + </a> + </span> +</dt> +<dd> +<p>List document symbols</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>lS"</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/plugins/lsp/module.nix" target="_top"> +<nvf/modules/plugins/lsp/module.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.mappings.listImplementations"></a><a class="term" href="options.html#opt-vim.lsp.mappings.listImplementations"><code class="option">vim.lsp.mappings.listImplementations</code> + </a> + </span> +</dt> +<dd> +<p>List implementations</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>lgi"</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/plugins/lsp/module.nix" target="_top"> +<nvf/modules/plugins/lsp/module.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.mappings.listReferences"></a><a class="term" href="options.html#opt-vim.lsp.mappings.listReferences"><code class="option">vim.lsp.mappings.listReferences</code> + </a> + </span> +</dt> +<dd> +<p>List references</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>lgr"</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/plugins/lsp/module.nix" target="_top"> +<nvf/modules/plugins/lsp/module.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.mappings.listWorkspaceFolders"></a><a class="term" href="options.html#opt-vim.lsp.mappings.listWorkspaceFolders"><code class="option">vim.lsp.mappings.listWorkspaceFolders</code> + </a> + </span> +</dt> +<dd> +<p>List workspace folders</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>lwl"</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/plugins/lsp/module.nix" target="_top"> +<nvf/modules/plugins/lsp/module.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.mappings.listWorkspaceSymbols"></a><a class="term" href="options.html#opt-vim.lsp.mappings.listWorkspaceSymbols"><code class="option">vim.lsp.mappings.listWorkspaceSymbols</code> + </a> + </span> +</dt> +<dd> +<p>List workspace symbols</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>lws"</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/plugins/lsp/module.nix" target="_top"> +<nvf/modules/plugins/lsp/module.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.mappings.nextDiagnostic"></a><a class="term" href="options.html#opt-vim.lsp.mappings.nextDiagnostic"><code class="option">vim.lsp.mappings.nextDiagnostic</code> + </a> + </span> +</dt> +<dd> +<p>Go to next diagnostic</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>lgn"</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/plugins/lsp/module.nix" target="_top"> +<nvf/modules/plugins/lsp/module.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.mappings.openDiagnosticFloat"></a><a class="term" href="options.html#opt-vim.lsp.mappings.openDiagnosticFloat"><code class="option">vim.lsp.mappings.openDiagnosticFloat</code> + </a> + </span> +</dt> +<dd> +<p>Open diagnostic float</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>le"</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/plugins/lsp/module.nix" target="_top"> +<nvf/modules/plugins/lsp/module.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.mappings.previousDiagnostic"></a><a class="term" href="options.html#opt-vim.lsp.mappings.previousDiagnostic"><code class="option">vim.lsp.mappings.previousDiagnostic</code> + </a> + </span> +</dt> +<dd> +<p>Go to previous diagnostic</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>lgp"</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/plugins/lsp/module.nix" target="_top"> +<nvf/modules/plugins/lsp/module.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.mappings.removeWorkspaceFolder"></a><a class="term" href="options.html#opt-vim.lsp.mappings.removeWorkspaceFolder"><code class="option">vim.lsp.mappings.removeWorkspaceFolder</code> + </a> + </span> +</dt> +<dd> +<p>Remove workspace folder</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>lwr"</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/plugins/lsp/module.nix" target="_top"> +<nvf/modules/plugins/lsp/module.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.mappings.renameSymbol"></a><a class="term" href="options.html#opt-vim.lsp.mappings.renameSymbol"><code class="option">vim.lsp.mappings.renameSymbol</code> + </a> + </span> +</dt> +<dd> +<p>Rename symbol</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>ln"</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/plugins/lsp/module.nix" target="_top"> +<nvf/modules/plugins/lsp/module.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.mappings.signatureHelp"></a><a class="term" href="options.html#opt-vim.lsp.mappings.signatureHelp"><code class="option">vim.lsp.mappings.signatureHelp</code> + </a> + </span> +</dt> +<dd> +<p>Signature help</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>ls"</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/plugins/lsp/module.nix" target="_top"> +<nvf/modules/plugins/lsp/module.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.mappings.toggleFormatOnSave"></a><a class="term" href="options.html#opt-vim.lsp.mappings.toggleFormatOnSave"><code class="option">vim.lsp.mappings.toggleFormatOnSave</code> + </a> + </span> +</dt> +<dd> +<p>Toggle format on save</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>ltf"</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/plugins/lsp/module.nix" target="_top"> +<nvf/modules/plugins/lsp/module.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.null-ls.enable"></a><a class="term" href="options.html#opt-vim.lsp.null-ls.enable"><code class="option">vim.lsp.null-ls.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable null-ls, also enabled automatically.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/lsp/null-ls/null-ls.nix" target="_top"> +<nvf/modules/plugins/lsp/null-ls/null-ls.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.null-ls.debounce"></a><a class="term" href="options.html#opt-vim.lsp.null-ls.debounce"><code class="option">vim.lsp.null-ls.debounce</code> + </a> + </span> +</dt> +<dd> +<p>Default debounce</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">250</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/plugins/lsp/null-ls/null-ls.nix" target="_top"> +<nvf/modules/plugins/lsp/null-ls/null-ls.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.null-ls.debug"></a><a class="term" href="options.html#opt-vim.lsp.null-ls.debug"><code class="option">vim.lsp.null-ls.debug</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable debugging information for `null-ls.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/lsp/null-ls/null-ls.nix" target="_top"> +<nvf/modules/plugins/lsp/null-ls/null-ls.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.null-ls.default_timeout"></a><a class="term" href="options.html#opt-vim.lsp.null-ls.default_timeout"><code class="option">vim.lsp.null-ls.default_timeout</code> + </a> + </span> +</dt> +<dd> +<p>Default timeout value, in milliseconds</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">5000</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/plugins/lsp/null-ls/null-ls.nix" target="_top"> +<nvf/modules/plugins/lsp/null-ls/null-ls.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.null-ls.diagnostics_format"></a><a class="term" href="options.html#opt-vim.lsp.null-ls.diagnostics_format"><code class="option">vim.lsp.null-ls.diagnostics_format</code> + </a> + </span> +</dt> +<dd> +<p>Diagnostic output format for null-ls</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"[#{m}] #{s} (#{c})"</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/plugins/lsp/null-ls/null-ls.nix" target="_top"> +<nvf/modules/plugins/lsp/null-ls/null-ls.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.null-ls.sources"></a><a class="term" href="options.html#opt-vim.lsp.null-ls.sources"><code class="option">vim.lsp.null-ls.sources</code> + </a> + </span> +</dt> +<dd> +<p>null-ls sources</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/lsp/null-ls/null-ls.nix" target="_top"> +<nvf/modules/plugins/lsp/null-ls/null-ls.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.nvim-docs-view.enable"></a><a class="term" href="options.html#opt-vim.lsp.nvim-docs-view.enable"><code class="option">vim.lsp.nvim-docs-view.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable nvim-docs-view, for displaying lsp hover documentation in a side panel…</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/lsp/nvim-docs-view/nvim-docs-view.nix" target="_top"> +<nvf/modules/plugins/lsp/nvim-docs-view/nvim-docs-view.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.nvim-docs-view.mappings.viewToggle"></a><a class="term" href="options.html#opt-vim.lsp.nvim-docs-view.mappings.viewToggle"><code class="option">vim.lsp.nvim-docs-view.mappings.viewToggle</code> + </a> + </span> +</dt> +<dd> +<p>Open or close the docs view panel</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"lvt"</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/plugins/lsp/nvim-docs-view/nvim-docs-view.nix" target="_top"> +<nvf/modules/plugins/lsp/nvim-docs-view/nvim-docs-view.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.nvim-docs-view.mappings.viewUpdate"></a><a class="term" href="options.html#opt-vim.lsp.nvim-docs-view.mappings.viewUpdate"><code class="option">vim.lsp.nvim-docs-view.mappings.viewUpdate</code> + </a> + </span> +</dt> +<dd> +<p>Manually update the docs view panel</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"lvu"</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/plugins/lsp/nvim-docs-view/nvim-docs-view.nix" target="_top"> +<nvf/modules/plugins/lsp/nvim-docs-view/nvim-docs-view.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.nvim-docs-view.setupOpts"></a><a class="term" href="options.html#opt-vim.lsp.nvim-docs-view.setupOpts"><code class="option">vim.lsp.nvim-docs-view.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of nvim-docs-view</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/lsp/nvim-docs-view/nvim-docs-view.nix" target="_top"> +<nvf/modules/plugins/lsp/nvim-docs-view/nvim-docs-view.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.nvim-docs-view.setupOpts.height"></a><a class="term" href="options.html#opt-vim.lsp.nvim-docs-view.setupOpts.height"><code class="option">vim.lsp.nvim-docs-view.setupOpts.height</code> + </a> + </span> +</dt> +<dd> +<p>Height of the docs view panel if the position is set to either top or bottom</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">10</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/plugins/lsp/nvim-docs-view/nvim-docs-view.nix" target="_top"> +<nvf/modules/plugins/lsp/nvim-docs-view/nvim-docs-view.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.nvim-docs-view.setupOpts.position"></a><a class="term" href="options.html#opt-vim.lsp.nvim-docs-view.setupOpts.position"><code class="option">vim.lsp.nvim-docs-view.setupOpts.position</code> + </a> + </span> +</dt> +<dd> +<p>Where to open the docs view panel</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “left”, “right”, “top”, “bottom”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"right"</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/plugins/lsp/nvim-docs-view/nvim-docs-view.nix" target="_top"> +<nvf/modules/plugins/lsp/nvim-docs-view/nvim-docs-view.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.nvim-docs-view.setupOpts.update_mode"></a><a class="term" href="options.html#opt-vim.lsp.nvim-docs-view.setupOpts.update_mode"><code class="option">vim.lsp.nvim-docs-view.setupOpts.update_mode</code> + </a> + </span> +</dt> +<dd> +<p>Determines the mechanism used to update the docs view panel content.</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>If auto, the content will update upon cursor move.</p></li><li class="listitem"><p>If manual, the content will only update once :DocsViewUpdate is called</p></li></ul></div> + +<p><span class="emphasis"><em>Type:</em></span> +one of “auto”, “manual”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"auto"</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/plugins/lsp/nvim-docs-view/nvim-docs-view.nix" target="_top"> +<nvf/modules/plugins/lsp/nvim-docs-view/nvim-docs-view.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.nvim-docs-view.setupOpts.width"></a><a class="term" href="options.html#opt-vim.lsp.nvim-docs-view.setupOpts.width"><code class="option">vim.lsp.nvim-docs-view.setupOpts.width</code> + </a> + </span> +</dt> +<dd> +<p>Width of the docs view panel if the position is set to either left or right</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">60</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/plugins/lsp/nvim-docs-view/nvim-docs-view.nix" target="_top"> +<nvf/modules/plugins/lsp/nvim-docs-view/nvim-docs-view.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.otter-nvim.enable"></a><a class="term" href="options.html#opt-vim.lsp.otter-nvim.enable"><code class="option">vim.lsp.otter-nvim.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable lsp features and a code completion source for code embedded in other documents [otter-nvim] +.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/lsp/otter/otter.nix" target="_top"> +<nvf/modules/plugins/lsp/otter/otter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.otter-nvim.mappings.toggle"></a><a class="term" href="options.html#opt-vim.lsp.otter-nvim.mappings.toggle"><code class="option">vim.lsp.otter-nvim.mappings.toggle</code> + </a> + </span> +</dt> +<dd> +<p>Activate LSP on Cursor Position [otter-nvim]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>lo"</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/plugins/lsp/otter/otter.nix" target="_top"> +<nvf/modules/plugins/lsp/otter/otter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.otter-nvim.setupOpts"></a><a class="term" href="options.html#opt-vim.lsp.otter-nvim.setupOpts"><code class="option">vim.lsp.otter-nvim.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of otter.nvim</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/lsp/otter/otter.nix" target="_top"> +<nvf/modules/plugins/lsp/otter/otter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.otter-nvim.setupOpts.buffers.set_filetype"></a><a class="term" href="options.html#opt-vim.lsp.otter-nvim.setupOpts.buffers.set_filetype"><code class="option">vim.lsp.otter-nvim.setupOpts.buffers.set_filetype</code> + </a> + </span> +</dt> +<dd> +<p>if set to true, the filetype of the otterbuffers will be set. Other wide only +the autocommand of lspconfig that attaches the language server will be +executed without setting the filetype</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/lsp/otter/otter.nix" target="_top"> +<nvf/modules/plugins/lsp/otter/otter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.otter-nvim.setupOpts.buffers.write_to_disk"></a><a class="term" href="options.html#opt-vim.lsp.otter-nvim.setupOpts.buffers.write_to_disk"><code class="option">vim.lsp.otter-nvim.setupOpts.buffers.write_to_disk</code> + </a> + </span> +</dt> +<dd> +<p>write <path>.otter.<embedded language extension> files to disk on save of main buffer. +Useful for some linters that require actual files. +Otter files are deleted on quit or main buffer close</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/lsp/otter/otter.nix" target="_top"> +<nvf/modules/plugins/lsp/otter/otter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.otter-nvim.setupOpts.handle_leading_whitespace"></a><a class="term" href="options.html#opt-vim.lsp.otter-nvim.setupOpts.handle_leading_whitespace"><code class="option">vim.lsp.otter-nvim.setupOpts.handle_leading_whitespace</code> + </a> + </span> +</dt> +<dd> +<p>otter may not work the way you expect when entire code blocks are indented +(eg. in Org files) When true, otter handles these cases fully.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/lsp/otter/otter.nix" target="_top"> +<nvf/modules/plugins/lsp/otter/otter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.otter-nvim.setupOpts.lsp.diagnostic_update_event"></a><a class="term" href="options.html#opt-vim.lsp.otter-nvim.setupOpts.lsp.diagnostic_update_event"><code class="option">vim.lsp.otter-nvim.setupOpts.lsp.diagnostic_update_event</code> + </a> + </span> +</dt> +<dd> +<p><code class="literal">:h events</code> that cause the diagnostic to update. +Set to: {“BufWritePost”, “InsertLeave”, “TextChanged” } +for less performant but more instant diagnostic updates</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "BufWritePost" +] +</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/plugins/lsp/otter/otter.nix" target="_top"> +<nvf/modules/plugins/lsp/otter/otter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.otter-nvim.setupOpts.strip_wrapping_quote_characters"></a><a class="term" href="options.html#opt-vim.lsp.otter-nvim.setupOpts.strip_wrapping_quote_characters"><code class="option">vim.lsp.otter-nvim.setupOpts.strip_wrapping_quote_characters</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "'" + "\"" + "`" +] +</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/plugins/lsp/otter/otter.nix" target="_top"> +<nvf/modules/plugins/lsp/otter/otter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.trouble.enable"></a><a class="term" href="options.html#opt-vim.lsp.trouble.enable"><code class="option">vim.lsp.trouble.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable trouble diagnostics viewer.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/lsp/trouble/trouble.nix" target="_top"> +<nvf/modules/plugins/lsp/trouble/trouble.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.trouble.mappings.documentDiagnostics"></a><a class="term" href="options.html#opt-vim.lsp.trouble.mappings.documentDiagnostics"><code class="option">vim.lsp.trouble.mappings.documentDiagnostics</code> + </a> + </span> +</dt> +<dd> +<p>Document diagnostics [trouble]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>ld"</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/plugins/lsp/trouble/trouble.nix" target="_top"> +<nvf/modules/plugins/lsp/trouble/trouble.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.trouble.mappings.locList"></a><a class="term" href="options.html#opt-vim.lsp.trouble.mappings.locList"><code class="option">vim.lsp.trouble.mappings.locList</code> + </a> + </span> +</dt> +<dd> +<p>LOCList [trouble]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>xl"</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/plugins/lsp/trouble/trouble.nix" target="_top"> +<nvf/modules/plugins/lsp/trouble/trouble.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.trouble.mappings.lspReferences"></a><a class="term" href="options.html#opt-vim.lsp.trouble.mappings.lspReferences"><code class="option">vim.lsp.trouble.mappings.lspReferences</code> + </a> + </span> +</dt> +<dd> +<p>LSP References [trouble]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>lr"</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/plugins/lsp/trouble/trouble.nix" target="_top"> +<nvf/modules/plugins/lsp/trouble/trouble.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.trouble.mappings.quickfix"></a><a class="term" href="options.html#opt-vim.lsp.trouble.mappings.quickfix"><code class="option">vim.lsp.trouble.mappings.quickfix</code> + </a> + </span> +</dt> +<dd> +<p>QuickFix [trouble]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>xq"</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/plugins/lsp/trouble/trouble.nix" target="_top"> +<nvf/modules/plugins/lsp/trouble/trouble.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.trouble.mappings.symbols"></a><a class="term" href="options.html#opt-vim.lsp.trouble.mappings.symbols"><code class="option">vim.lsp.trouble.mappings.symbols</code> + </a> + </span> +</dt> +<dd> +<p>Symbols [trouble]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>xs"</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/plugins/lsp/trouble/trouble.nix" target="_top"> +<nvf/modules/plugins/lsp/trouble/trouble.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.trouble.mappings.workspaceDiagnostics"></a><a class="term" href="options.html#opt-vim.lsp.trouble.mappings.workspaceDiagnostics"><code class="option">vim.lsp.trouble.mappings.workspaceDiagnostics</code> + </a> + </span> +</dt> +<dd> +<p>Workspace diagnostics [trouble]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>lwd"</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/plugins/lsp/trouble/trouble.nix" target="_top"> +<nvf/modules/plugins/lsp/trouble/trouble.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.lsp.trouble.setupOpts"></a><a class="term" href="options.html#opt-vim.lsp.trouble.setupOpts"><code class="option">vim.lsp.trouble.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of Trouble</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/lsp/trouble/trouble.nix" target="_top"> +<nvf/modules/plugins/lsp/trouble/trouble.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.luaConfigPost"></a><a class="term" href="options.html#opt-vim.luaConfigPost"><code class="option">vim.luaConfigPost</code> + </a> + </span> +</dt> +<dd> +<p>Verbatim lua code that will be inserted <span class="strong"><strong>after</strong></span> +the result of the <code class="literal">luaConfigRc</code> DAG has been resolved</p><p>This option <span class="strong"><strong>does not</strong></span> take a DAG set, but a string +instead. Useful when you’d like to insert contents +of lua configs after the DAG result.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">""</code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">${builtins.readFile ./my-lua-config-post.lua}</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"> +<nvf/modules/wrapper/rc/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.luaConfigPre"></a><a class="term" href="options.html#opt-vim.luaConfigPre"><code class="option">vim.luaConfigPre</code> + </a> + </span> +</dt> +<dd> +<p>Verbatim lua code that will be inserted <span class="strong"><strong>before</strong></span> +the result of <code class="literal">luaConfigRc</code> DAG has been resolved.</p><p>This option <span class="strong"><strong>does not</strong></span> take a DAG set, but a string +instead. Useful when you’d like to insert contents +of lua configs after the DAG result.</p><div class="warning"><h3 class="title">Warning</h3><p>You do not want to override this option with mkForce +It is used internally to set certain options as early +as possible and should be avoided unless you know what +you’re doing. Passing a string to this option will +merge it with the default contents.</p></div> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +By default, this option will <span class="strong"><strong>append</strong></span> paths in +<a class="xref" href="options.html#opt-vim.additionalRuntimePaths" ><code class="option">vim.additionalRuntimePaths</code></a> +to the <code class="literal">runtimepath</code> and enable the experimental Lua module loader +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> +<code class="literal">${builtins.readFile ./my-lua-config-pre.lua}</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"> +<nvf/modules/wrapper/rc/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.luaConfigRC"></a><a class="term" href="options.html#opt-vim.luaConfigRC"><code class="option">vim.luaConfigRC</code> + </a> + </span> +</dt> +<dd> +<p>Lua configuration, either as a string or a DAG.</p><p>If this option is passed as a DAG, it will be resolved +according to the DAG resolution rules (e.g. entryBefore +or entryAfter) as per the <span class="strong"><strong>nvf</strong></span> extended library.</p> + +<p><span class="emphasis"><em>Type:</em></span> +(DAG of strings concatenated with “\n”) or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</code></p> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting lua">-- Set the tab size to 4 spaces +vim.opt.tabstop = 4 +vim.opt.shiftwidth = 4 +vim.opt.expandtab = true +</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"> +<nvf/modules/wrapper/rc/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.luaPackages"></a><a class="term" href="options.html#opt-vim.luaPackages"><code class="option">vim.luaPackages</code> + </a> + </span> +</dt> +<dd> +<p>List of lua packages to install</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"[\"magick\" \"serpent\"]"</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/environment/options.nix" target="_top"> +<nvf/modules/wrapper/environment/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.command"></a><a class="term" href="options.html#opt-vim.maps.command"><code class="option">vim.maps.command</code> + </a> + </span> +</dt> +<dd> +<p>Mappings for command-line mode</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of (submodule)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.command._name_.action"></a><a class="term" href="options.html#opt-vim.maps.command._name_.action"><code class="option">vim.maps.command.<name>.action</code> + </a> + </span> +</dt> +<dd> +<p>The command to execute.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.command._name_.desc"></a><a class="term" href="options.html#opt-vim.maps.command._name_.desc"><code class="option">vim.maps.command.<name>.desc</code> + </a> + </span> +</dt> +<dd> +<p>A description of this keybind, to be shown in which-key, if you have it enabled.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.command._name_.expr"></a><a class="term" href="options.html#opt-vim.maps.command._name_.expr"><code class="option">vim.maps.command.<name>.expr</code> + </a> + </span> +</dt> +<dd> +<p>Means that the action is actually an expression. Equivalent to adding <expr> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.command._name_.lua"></a><a class="term" href="options.html#opt-vim.maps.command._name_.lua"><code class="option">vim.maps.command.<name>.lua</code> + </a> + </span> +</dt> +<dd> +<p>If true, <code class="literal">action</code> is considered to be lua code. +Thus, it will not be wrapped in <code class="literal">""</code>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.command._name_.noremap"></a><a class="term" href="options.html#opt-vim.maps.command._name_.noremap"><code class="option">vim.maps.command.<name>.noremap</code> + </a> + </span> +</dt> +<dd> +<p>Whether to use the ‘noremap’ variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.command._name_.nowait"></a><a class="term" href="options.html#opt-vim.maps.command._name_.nowait"><code class="option">vim.maps.command.<name>.nowait</code> + </a> + </span> +</dt> +<dd> +<p>Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.command._name_.script"></a><a class="term" href="options.html#opt-vim.maps.command._name_.script"><code class="option">vim.maps.command.<name>.script</code> + </a> + </span> +</dt> +<dd> +<p>Equivalent to adding <script> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.command._name_.silent"></a><a class="term" href="options.html#opt-vim.maps.command._name_.silent"><code class="option">vim.maps.command.<name>.silent</code> + </a> + </span> +</dt> +<dd> +<p>Whether this mapping should be silent. Equivalent to adding <silent> to a map.</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.command._name_.unique"></a><a class="term" href="options.html#opt-vim.maps.command._name_.unique"><code class="option">vim.maps.command.<name>.unique</code> + </a> + </span> +</dt> +<dd> +<p>Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.insert"></a><a class="term" href="options.html#opt-vim.maps.insert"><code class="option">vim.maps.insert</code> + </a> + </span> +</dt> +<dd> +<p>Mappings for insert mode</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of (submodule)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.insert._name_.action"></a><a class="term" href="options.html#opt-vim.maps.insert._name_.action"><code class="option">vim.maps.insert.<name>.action</code> + </a> + </span> +</dt> +<dd> +<p>The command to execute.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.insert._name_.desc"></a><a class="term" href="options.html#opt-vim.maps.insert._name_.desc"><code class="option">vim.maps.insert.<name>.desc</code> + </a> + </span> +</dt> +<dd> +<p>A description of this keybind, to be shown in which-key, if you have it enabled.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.insert._name_.expr"></a><a class="term" href="options.html#opt-vim.maps.insert._name_.expr"><code class="option">vim.maps.insert.<name>.expr</code> + </a> + </span> +</dt> +<dd> +<p>Means that the action is actually an expression. Equivalent to adding <expr> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.insert._name_.lua"></a><a class="term" href="options.html#opt-vim.maps.insert._name_.lua"><code class="option">vim.maps.insert.<name>.lua</code> + </a> + </span> +</dt> +<dd> +<p>If true, <code class="literal">action</code> is considered to be lua code. +Thus, it will not be wrapped in <code class="literal">""</code>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.insert._name_.noremap"></a><a class="term" href="options.html#opt-vim.maps.insert._name_.noremap"><code class="option">vim.maps.insert.<name>.noremap</code> + </a> + </span> +</dt> +<dd> +<p>Whether to use the ‘noremap’ variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.insert._name_.nowait"></a><a class="term" href="options.html#opt-vim.maps.insert._name_.nowait"><code class="option">vim.maps.insert.<name>.nowait</code> + </a> + </span> +</dt> +<dd> +<p>Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.insert._name_.script"></a><a class="term" href="options.html#opt-vim.maps.insert._name_.script"><code class="option">vim.maps.insert.<name>.script</code> + </a> + </span> +</dt> +<dd> +<p>Equivalent to adding <script> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.insert._name_.silent"></a><a class="term" href="options.html#opt-vim.maps.insert._name_.silent"><code class="option">vim.maps.insert.<name>.silent</code> + </a> + </span> +</dt> +<dd> +<p>Whether this mapping should be silent. Equivalent to adding <silent> to a map.</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.insert._name_.unique"></a><a class="term" href="options.html#opt-vim.maps.insert._name_.unique"><code class="option">vim.maps.insert.<name>.unique</code> + </a> + </span> +</dt> +<dd> +<p>Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.insertCommand"></a><a class="term" href="options.html#opt-vim.maps.insertCommand"><code class="option">vim.maps.insertCommand</code> + </a> + </span> +</dt> +<dd> +<p>Mappings for insert and command-line mode</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of (submodule)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.insertCommand._name_.action"></a><a class="term" href="options.html#opt-vim.maps.insertCommand._name_.action"><code class="option">vim.maps.insertCommand.<name>.action</code> + </a> + </span> +</dt> +<dd> +<p>The command to execute.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.insertCommand._name_.desc"></a><a class="term" href="options.html#opt-vim.maps.insertCommand._name_.desc"><code class="option">vim.maps.insertCommand.<name>.desc</code> + </a> + </span> +</dt> +<dd> +<p>A description of this keybind, to be shown in which-key, if you have it enabled.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.insertCommand._name_.expr"></a><a class="term" href="options.html#opt-vim.maps.insertCommand._name_.expr"><code class="option">vim.maps.insertCommand.<name>.expr</code> + </a> + </span> +</dt> +<dd> +<p>Means that the action is actually an expression. Equivalent to adding <expr> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.insertCommand._name_.lua"></a><a class="term" href="options.html#opt-vim.maps.insertCommand._name_.lua"><code class="option">vim.maps.insertCommand.<name>.lua</code> + </a> + </span> +</dt> +<dd> +<p>If true, <code class="literal">action</code> is considered to be lua code. +Thus, it will not be wrapped in <code class="literal">""</code>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.insertCommand._name_.noremap"></a><a class="term" href="options.html#opt-vim.maps.insertCommand._name_.noremap"><code class="option">vim.maps.insertCommand.<name>.noremap</code> + </a> + </span> +</dt> +<dd> +<p>Whether to use the ‘noremap’ variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.insertCommand._name_.nowait"></a><a class="term" href="options.html#opt-vim.maps.insertCommand._name_.nowait"><code class="option">vim.maps.insertCommand.<name>.nowait</code> + </a> + </span> +</dt> +<dd> +<p>Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.insertCommand._name_.script"></a><a class="term" href="options.html#opt-vim.maps.insertCommand._name_.script"><code class="option">vim.maps.insertCommand.<name>.script</code> + </a> + </span> +</dt> +<dd> +<p>Equivalent to adding <script> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.insertCommand._name_.silent"></a><a class="term" href="options.html#opt-vim.maps.insertCommand._name_.silent"><code class="option">vim.maps.insertCommand.<name>.silent</code> + </a> + </span> +</dt> +<dd> +<p>Whether this mapping should be silent. Equivalent to adding <silent> to a map.</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.insertCommand._name_.unique"></a><a class="term" href="options.html#opt-vim.maps.insertCommand._name_.unique"><code class="option">vim.maps.insertCommand.<name>.unique</code> + </a> + </span> +</dt> +<dd> +<p>Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.lang"></a><a class="term" href="options.html#opt-vim.maps.lang"><code class="option">vim.maps.lang</code> + </a> + </span> +</dt> +<dd> +<p>Mappings for insert, command-line and lang-arg mode</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of (submodule)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.lang._name_.action"></a><a class="term" href="options.html#opt-vim.maps.lang._name_.action"><code class="option">vim.maps.lang.<name>.action</code> + </a> + </span> +</dt> +<dd> +<p>The command to execute.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.lang._name_.desc"></a><a class="term" href="options.html#opt-vim.maps.lang._name_.desc"><code class="option">vim.maps.lang.<name>.desc</code> + </a> + </span> +</dt> +<dd> +<p>A description of this keybind, to be shown in which-key, if you have it enabled.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.lang._name_.expr"></a><a class="term" href="options.html#opt-vim.maps.lang._name_.expr"><code class="option">vim.maps.lang.<name>.expr</code> + </a> + </span> +</dt> +<dd> +<p>Means that the action is actually an expression. Equivalent to adding <expr> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.lang._name_.lua"></a><a class="term" href="options.html#opt-vim.maps.lang._name_.lua"><code class="option">vim.maps.lang.<name>.lua</code> + </a> + </span> +</dt> +<dd> +<p>If true, <code class="literal">action</code> is considered to be lua code. +Thus, it will not be wrapped in <code class="literal">""</code>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.lang._name_.noremap"></a><a class="term" href="options.html#opt-vim.maps.lang._name_.noremap"><code class="option">vim.maps.lang.<name>.noremap</code> + </a> + </span> +</dt> +<dd> +<p>Whether to use the ‘noremap’ variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.lang._name_.nowait"></a><a class="term" href="options.html#opt-vim.maps.lang._name_.nowait"><code class="option">vim.maps.lang.<name>.nowait</code> + </a> + </span> +</dt> +<dd> +<p>Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.lang._name_.script"></a><a class="term" href="options.html#opt-vim.maps.lang._name_.script"><code class="option">vim.maps.lang.<name>.script</code> + </a> + </span> +</dt> +<dd> +<p>Equivalent to adding <script> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.lang._name_.silent"></a><a class="term" href="options.html#opt-vim.maps.lang._name_.silent"><code class="option">vim.maps.lang.<name>.silent</code> + </a> + </span> +</dt> +<dd> +<p>Whether this mapping should be silent. Equivalent to adding <silent> to a map.</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.lang._name_.unique"></a><a class="term" href="options.html#opt-vim.maps.lang._name_.unique"><code class="option">vim.maps.lang.<name>.unique</code> + </a> + </span> +</dt> +<dd> +<p>Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.normal"></a><a class="term" href="options.html#opt-vim.maps.normal"><code class="option">vim.maps.normal</code> + </a> + </span> +</dt> +<dd> +<p>Mappings for normal mode</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of (submodule)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.normal._name_.action"></a><a class="term" href="options.html#opt-vim.maps.normal._name_.action"><code class="option">vim.maps.normal.<name>.action</code> + </a> + </span> +</dt> +<dd> +<p>The command to execute.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.normal._name_.desc"></a><a class="term" href="options.html#opt-vim.maps.normal._name_.desc"><code class="option">vim.maps.normal.<name>.desc</code> + </a> + </span> +</dt> +<dd> +<p>A description of this keybind, to be shown in which-key, if you have it enabled.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.normal._name_.expr"></a><a class="term" href="options.html#opt-vim.maps.normal._name_.expr"><code class="option">vim.maps.normal.<name>.expr</code> + </a> + </span> +</dt> +<dd> +<p>Means that the action is actually an expression. Equivalent to adding <expr> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.normal._name_.lua"></a><a class="term" href="options.html#opt-vim.maps.normal._name_.lua"><code class="option">vim.maps.normal.<name>.lua</code> + </a> + </span> +</dt> +<dd> +<p>If true, <code class="literal">action</code> is considered to be lua code. +Thus, it will not be wrapped in <code class="literal">""</code>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.normal._name_.noremap"></a><a class="term" href="options.html#opt-vim.maps.normal._name_.noremap"><code class="option">vim.maps.normal.<name>.noremap</code> + </a> + </span> +</dt> +<dd> +<p>Whether to use the ‘noremap’ variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.normal._name_.nowait"></a><a class="term" href="options.html#opt-vim.maps.normal._name_.nowait"><code class="option">vim.maps.normal.<name>.nowait</code> + </a> + </span> +</dt> +<dd> +<p>Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.normal._name_.script"></a><a class="term" href="options.html#opt-vim.maps.normal._name_.script"><code class="option">vim.maps.normal.<name>.script</code> + </a> + </span> +</dt> +<dd> +<p>Equivalent to adding <script> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.normal._name_.silent"></a><a class="term" href="options.html#opt-vim.maps.normal._name_.silent"><code class="option">vim.maps.normal.<name>.silent</code> + </a> + </span> +</dt> +<dd> +<p>Whether this mapping should be silent. Equivalent to adding <silent> to a map.</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.normal._name_.unique"></a><a class="term" href="options.html#opt-vim.maps.normal._name_.unique"><code class="option">vim.maps.normal.<name>.unique</code> + </a> + </span> +</dt> +<dd> +<p>Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.normalVisualOp"></a><a class="term" href="options.html#opt-vim.maps.normalVisualOp"><code class="option">vim.maps.normalVisualOp</code> + </a> + </span> +</dt> +<dd> +<p>Mappings for normal, visual, select and operator-pending (same as plain ‘map’) mode</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of (submodule)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.normalVisualOp._name_.action"></a><a class="term" href="options.html#opt-vim.maps.normalVisualOp._name_.action"><code class="option">vim.maps.normalVisualOp.<name>.action</code> + </a> + </span> +</dt> +<dd> +<p>The command to execute.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.normalVisualOp._name_.desc"></a><a class="term" href="options.html#opt-vim.maps.normalVisualOp._name_.desc"><code class="option">vim.maps.normalVisualOp.<name>.desc</code> + </a> + </span> +</dt> +<dd> +<p>A description of this keybind, to be shown in which-key, if you have it enabled.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.normalVisualOp._name_.expr"></a><a class="term" href="options.html#opt-vim.maps.normalVisualOp._name_.expr"><code class="option">vim.maps.normalVisualOp.<name>.expr</code> + </a> + </span> +</dt> +<dd> +<p>Means that the action is actually an expression. Equivalent to adding <expr> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.normalVisualOp._name_.lua"></a><a class="term" href="options.html#opt-vim.maps.normalVisualOp._name_.lua"><code class="option">vim.maps.normalVisualOp.<name>.lua</code> + </a> + </span> +</dt> +<dd> +<p>If true, <code class="literal">action</code> is considered to be lua code. +Thus, it will not be wrapped in <code class="literal">""</code>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.normalVisualOp._name_.noremap"></a><a class="term" href="options.html#opt-vim.maps.normalVisualOp._name_.noremap"><code class="option">vim.maps.normalVisualOp.<name>.noremap</code> + </a> + </span> +</dt> +<dd> +<p>Whether to use the ‘noremap’ variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.normalVisualOp._name_.nowait"></a><a class="term" href="options.html#opt-vim.maps.normalVisualOp._name_.nowait"><code class="option">vim.maps.normalVisualOp.<name>.nowait</code> + </a> + </span> +</dt> +<dd> +<p>Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.normalVisualOp._name_.script"></a><a class="term" href="options.html#opt-vim.maps.normalVisualOp._name_.script"><code class="option">vim.maps.normalVisualOp.<name>.script</code> + </a> + </span> +</dt> +<dd> +<p>Equivalent to adding <script> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.normalVisualOp._name_.silent"></a><a class="term" href="options.html#opt-vim.maps.normalVisualOp._name_.silent"><code class="option">vim.maps.normalVisualOp.<name>.silent</code> + </a> + </span> +</dt> +<dd> +<p>Whether this mapping should be silent. Equivalent to adding <silent> to a map.</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.normalVisualOp._name_.unique"></a><a class="term" href="options.html#opt-vim.maps.normalVisualOp._name_.unique"><code class="option">vim.maps.normalVisualOp.<name>.unique</code> + </a> + </span> +</dt> +<dd> +<p>Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.operator"></a><a class="term" href="options.html#opt-vim.maps.operator"><code class="option">vim.maps.operator</code> + </a> + </span> +</dt> +<dd> +<p>Mappings for operator-pending mode</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of (submodule)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.operator._name_.action"></a><a class="term" href="options.html#opt-vim.maps.operator._name_.action"><code class="option">vim.maps.operator.<name>.action</code> + </a> + </span> +</dt> +<dd> +<p>The command to execute.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.operator._name_.desc"></a><a class="term" href="options.html#opt-vim.maps.operator._name_.desc"><code class="option">vim.maps.operator.<name>.desc</code> + </a> + </span> +</dt> +<dd> +<p>A description of this keybind, to be shown in which-key, if you have it enabled.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.operator._name_.expr"></a><a class="term" href="options.html#opt-vim.maps.operator._name_.expr"><code class="option">vim.maps.operator.<name>.expr</code> + </a> + </span> +</dt> +<dd> +<p>Means that the action is actually an expression. Equivalent to adding <expr> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.operator._name_.lua"></a><a class="term" href="options.html#opt-vim.maps.operator._name_.lua"><code class="option">vim.maps.operator.<name>.lua</code> + </a> + </span> +</dt> +<dd> +<p>If true, <code class="literal">action</code> is considered to be lua code. +Thus, it will not be wrapped in <code class="literal">""</code>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.operator._name_.noremap"></a><a class="term" href="options.html#opt-vim.maps.operator._name_.noremap"><code class="option">vim.maps.operator.<name>.noremap</code> + </a> + </span> +</dt> +<dd> +<p>Whether to use the ‘noremap’ variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.operator._name_.nowait"></a><a class="term" href="options.html#opt-vim.maps.operator._name_.nowait"><code class="option">vim.maps.operator.<name>.nowait</code> + </a> + </span> +</dt> +<dd> +<p>Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.operator._name_.script"></a><a class="term" href="options.html#opt-vim.maps.operator._name_.script"><code class="option">vim.maps.operator.<name>.script</code> + </a> + </span> +</dt> +<dd> +<p>Equivalent to adding <script> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.operator._name_.silent"></a><a class="term" href="options.html#opt-vim.maps.operator._name_.silent"><code class="option">vim.maps.operator.<name>.silent</code> + </a> + </span> +</dt> +<dd> +<p>Whether this mapping should be silent. Equivalent to adding <silent> to a map.</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.operator._name_.unique"></a><a class="term" href="options.html#opt-vim.maps.operator._name_.unique"><code class="option">vim.maps.operator.<name>.unique</code> + </a> + </span> +</dt> +<dd> +<p>Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.select"></a><a class="term" href="options.html#opt-vim.maps.select"><code class="option">vim.maps.select</code> + </a> + </span> +</dt> +<dd> +<p>Mappings for select mode</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of (submodule)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.select._name_.action"></a><a class="term" href="options.html#opt-vim.maps.select._name_.action"><code class="option">vim.maps.select.<name>.action</code> + </a> + </span> +</dt> +<dd> +<p>The command to execute.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.select._name_.desc"></a><a class="term" href="options.html#opt-vim.maps.select._name_.desc"><code class="option">vim.maps.select.<name>.desc</code> + </a> + </span> +</dt> +<dd> +<p>A description of this keybind, to be shown in which-key, if you have it enabled.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.select._name_.expr"></a><a class="term" href="options.html#opt-vim.maps.select._name_.expr"><code class="option">vim.maps.select.<name>.expr</code> + </a> + </span> +</dt> +<dd> +<p>Means that the action is actually an expression. Equivalent to adding <expr> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.select._name_.lua"></a><a class="term" href="options.html#opt-vim.maps.select._name_.lua"><code class="option">vim.maps.select.<name>.lua</code> + </a> + </span> +</dt> +<dd> +<p>If true, <code class="literal">action</code> is considered to be lua code. +Thus, it will not be wrapped in <code class="literal">""</code>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.select._name_.noremap"></a><a class="term" href="options.html#opt-vim.maps.select._name_.noremap"><code class="option">vim.maps.select.<name>.noremap</code> + </a> + </span> +</dt> +<dd> +<p>Whether to use the ‘noremap’ variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.select._name_.nowait"></a><a class="term" href="options.html#opt-vim.maps.select._name_.nowait"><code class="option">vim.maps.select.<name>.nowait</code> + </a> + </span> +</dt> +<dd> +<p>Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.select._name_.script"></a><a class="term" href="options.html#opt-vim.maps.select._name_.script"><code class="option">vim.maps.select.<name>.script</code> + </a> + </span> +</dt> +<dd> +<p>Equivalent to adding <script> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.select._name_.silent"></a><a class="term" href="options.html#opt-vim.maps.select._name_.silent"><code class="option">vim.maps.select.<name>.silent</code> + </a> + </span> +</dt> +<dd> +<p>Whether this mapping should be silent. Equivalent to adding <silent> to a map.</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.select._name_.unique"></a><a class="term" href="options.html#opt-vim.maps.select._name_.unique"><code class="option">vim.maps.select.<name>.unique</code> + </a> + </span> +</dt> +<dd> +<p>Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.terminal"></a><a class="term" href="options.html#opt-vim.maps.terminal"><code class="option">vim.maps.terminal</code> + </a> + </span> +</dt> +<dd> +<p>Mappings for terminal mode</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of (submodule)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.terminal._name_.action"></a><a class="term" href="options.html#opt-vim.maps.terminal._name_.action"><code class="option">vim.maps.terminal.<name>.action</code> + </a> + </span> +</dt> +<dd> +<p>The command to execute.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.terminal._name_.desc"></a><a class="term" href="options.html#opt-vim.maps.terminal._name_.desc"><code class="option">vim.maps.terminal.<name>.desc</code> + </a> + </span> +</dt> +<dd> +<p>A description of this keybind, to be shown in which-key, if you have it enabled.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.terminal._name_.expr"></a><a class="term" href="options.html#opt-vim.maps.terminal._name_.expr"><code class="option">vim.maps.terminal.<name>.expr</code> + </a> + </span> +</dt> +<dd> +<p>Means that the action is actually an expression. Equivalent to adding <expr> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.terminal._name_.lua"></a><a class="term" href="options.html#opt-vim.maps.terminal._name_.lua"><code class="option">vim.maps.terminal.<name>.lua</code> + </a> + </span> +</dt> +<dd> +<p>If true, <code class="literal">action</code> is considered to be lua code. +Thus, it will not be wrapped in <code class="literal">""</code>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.terminal._name_.noremap"></a><a class="term" href="options.html#opt-vim.maps.terminal._name_.noremap"><code class="option">vim.maps.terminal.<name>.noremap</code> + </a> + </span> +</dt> +<dd> +<p>Whether to use the ‘noremap’ variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.terminal._name_.nowait"></a><a class="term" href="options.html#opt-vim.maps.terminal._name_.nowait"><code class="option">vim.maps.terminal.<name>.nowait</code> + </a> + </span> +</dt> +<dd> +<p>Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.terminal._name_.script"></a><a class="term" href="options.html#opt-vim.maps.terminal._name_.script"><code class="option">vim.maps.terminal.<name>.script</code> + </a> + </span> +</dt> +<dd> +<p>Equivalent to adding <script> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.terminal._name_.silent"></a><a class="term" href="options.html#opt-vim.maps.terminal._name_.silent"><code class="option">vim.maps.terminal.<name>.silent</code> + </a> + </span> +</dt> +<dd> +<p>Whether this mapping should be silent. Equivalent to adding <silent> to a map.</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.terminal._name_.unique"></a><a class="term" href="options.html#opt-vim.maps.terminal._name_.unique"><code class="option">vim.maps.terminal.<name>.unique</code> + </a> + </span> +</dt> +<dd> +<p>Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.visual"></a><a class="term" href="options.html#opt-vim.maps.visual"><code class="option">vim.maps.visual</code> + </a> + </span> +</dt> +<dd> +<p>Mappings for visual and select mode</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of (submodule)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.visual._name_.action"></a><a class="term" href="options.html#opt-vim.maps.visual._name_.action"><code class="option">vim.maps.visual.<name>.action</code> + </a> + </span> +</dt> +<dd> +<p>The command to execute.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.visual._name_.desc"></a><a class="term" href="options.html#opt-vim.maps.visual._name_.desc"><code class="option">vim.maps.visual.<name>.desc</code> + </a> + </span> +</dt> +<dd> +<p>A description of this keybind, to be shown in which-key, if you have it enabled.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.visual._name_.expr"></a><a class="term" href="options.html#opt-vim.maps.visual._name_.expr"><code class="option">vim.maps.visual.<name>.expr</code> + </a> + </span> +</dt> +<dd> +<p>Means that the action is actually an expression. Equivalent to adding <expr> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.visual._name_.lua"></a><a class="term" href="options.html#opt-vim.maps.visual._name_.lua"><code class="option">vim.maps.visual.<name>.lua</code> + </a> + </span> +</dt> +<dd> +<p>If true, <code class="literal">action</code> is considered to be lua code. +Thus, it will not be wrapped in <code class="literal">""</code>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.visual._name_.noremap"></a><a class="term" href="options.html#opt-vim.maps.visual._name_.noremap"><code class="option">vim.maps.visual.<name>.noremap</code> + </a> + </span> +</dt> +<dd> +<p>Whether to use the ‘noremap’ variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.visual._name_.nowait"></a><a class="term" href="options.html#opt-vim.maps.visual._name_.nowait"><code class="option">vim.maps.visual.<name>.nowait</code> + </a> + </span> +</dt> +<dd> +<p>Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.visual._name_.script"></a><a class="term" href="options.html#opt-vim.maps.visual._name_.script"><code class="option">vim.maps.visual.<name>.script</code> + </a> + </span> +</dt> +<dd> +<p>Equivalent to adding <script> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.visual._name_.silent"></a><a class="term" href="options.html#opt-vim.maps.visual._name_.silent"><code class="option">vim.maps.visual.<name>.silent</code> + </a> + </span> +</dt> +<dd> +<p>Whether this mapping should be silent. Equivalent to adding <silent> to a map.</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.visual._name_.unique"></a><a class="term" href="options.html#opt-vim.maps.visual._name_.unique"><code class="option">vim.maps.visual.<name>.unique</code> + </a> + </span> +</dt> +<dd> +<p>Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.visualOnly"></a><a class="term" href="options.html#opt-vim.maps.visualOnly"><code class="option">vim.maps.visualOnly</code> + </a> + </span> +</dt> +<dd> +<p>Mappings for visual only mode</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of (submodule)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.visualOnly._name_.action"></a><a class="term" href="options.html#opt-vim.maps.visualOnly._name_.action"><code class="option">vim.maps.visualOnly.<name>.action</code> + </a> + </span> +</dt> +<dd> +<p>The command to execute.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.visualOnly._name_.desc"></a><a class="term" href="options.html#opt-vim.maps.visualOnly._name_.desc"><code class="option">vim.maps.visualOnly.<name>.desc</code> + </a> + </span> +</dt> +<dd> +<p>A description of this keybind, to be shown in which-key, if you have it enabled.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.visualOnly._name_.expr"></a><a class="term" href="options.html#opt-vim.maps.visualOnly._name_.expr"><code class="option">vim.maps.visualOnly.<name>.expr</code> + </a> + </span> +</dt> +<dd> +<p>Means that the action is actually an expression. Equivalent to adding <expr> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.visualOnly._name_.lua"></a><a class="term" href="options.html#opt-vim.maps.visualOnly._name_.lua"><code class="option">vim.maps.visualOnly.<name>.lua</code> + </a> + </span> +</dt> +<dd> +<p>If true, <code class="literal">action</code> is considered to be lua code. +Thus, it will not be wrapped in <code class="literal">""</code>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.visualOnly._name_.noremap"></a><a class="term" href="options.html#opt-vim.maps.visualOnly._name_.noremap"><code class="option">vim.maps.visualOnly.<name>.noremap</code> + </a> + </span> +</dt> +<dd> +<p>Whether to use the ‘noremap’ variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.visualOnly._name_.nowait"></a><a class="term" href="options.html#opt-vim.maps.visualOnly._name_.nowait"><code class="option">vim.maps.visualOnly.<name>.nowait</code> + </a> + </span> +</dt> +<dd> +<p>Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.visualOnly._name_.script"></a><a class="term" href="options.html#opt-vim.maps.visualOnly._name_.script"><code class="option">vim.maps.visualOnly.<name>.script</code> + </a> + </span> +</dt> +<dd> +<p>Equivalent to adding <script> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.visualOnly._name_.silent"></a><a class="term" href="options.html#opt-vim.maps.visualOnly._name_.silent"><code class="option">vim.maps.visualOnly.<name>.silent</code> + </a> + </span> +</dt> +<dd> +<p>Whether this mapping should be silent. Equivalent to adding <silent> to a map.</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.maps.visualOnly._name_.unique"></a><a class="term" href="options.html#opt-vim.maps.visualOnly._name_.unique"><code class="option">vim.maps.visualOnly.<name>.unique</code> + </a> + </span> +</dt> +<dd> +<p>Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/mappings/options.nix" target="_top"> +<nvf/modules/neovim/mappings/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.ai.enable"></a><a class="term" href="options.html#opt-vim.mini.ai.enable"><code class="option">vim.mini.ai.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.ai.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/ai/ai.nix" target="_top"> +<nvf/modules/plugins/mini/ai/ai.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.ai.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.ai.setupOpts"><code class="option">vim.mini.ai.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.ai</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/ai/ai.nix" target="_top"> +<nvf/modules/plugins/mini/ai/ai.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.align.enable"></a><a class="term" href="options.html#opt-vim.mini.align.enable"><code class="option">vim.mini.align.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.align.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/align/align.nix" target="_top"> +<nvf/modules/plugins/mini/align/align.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.align.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.align.setupOpts"><code class="option">vim.mini.align.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.align</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/align/align.nix" target="_top"> +<nvf/modules/plugins/mini/align/align.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.animate.enable"></a><a class="term" href="options.html#opt-vim.mini.animate.enable"><code class="option">vim.mini.animate.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.animate.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/animate/animate.nix" target="_top"> +<nvf/modules/plugins/mini/animate/animate.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.animate.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.animate.setupOpts"><code class="option">vim.mini.animate.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.animate</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/animate/animate.nix" target="_top"> +<nvf/modules/plugins/mini/animate/animate.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.basics.enable"></a><a class="term" href="options.html#opt-vim.mini.basics.enable"><code class="option">vim.mini.basics.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.basics.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/basics/basics.nix" target="_top"> +<nvf/modules/plugins/mini/basics/basics.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.basics.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.basics.setupOpts"><code class="option">vim.mini.basics.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.basics</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/basics/basics.nix" target="_top"> +<nvf/modules/plugins/mini/basics/basics.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.bracketed.enable"></a><a class="term" href="options.html#opt-vim.mini.bracketed.enable"><code class="option">vim.mini.bracketed.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.bracketed.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/bracketed/bracketed.nix" target="_top"> +<nvf/modules/plugins/mini/bracketed/bracketed.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.bracketed.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.bracketed.setupOpts"><code class="option">vim.mini.bracketed.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.bracketed</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/bracketed/bracketed.nix" target="_top"> +<nvf/modules/plugins/mini/bracketed/bracketed.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.bufremove.enable"></a><a class="term" href="options.html#opt-vim.mini.bufremove.enable"><code class="option">vim.mini.bufremove.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.bufremove.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/bufremove/bufremove.nix" target="_top"> +<nvf/modules/plugins/mini/bufremove/bufremove.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.bufremove.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.bufremove.setupOpts"><code class="option">vim.mini.bufremove.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.bufremove</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/bufremove/bufremove.nix" target="_top"> +<nvf/modules/plugins/mini/bufremove/bufremove.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.clue.enable"></a><a class="term" href="options.html#opt-vim.mini.clue.enable"><code class="option">vim.mini.clue.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.clue.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/clue/clue.nix" target="_top"> +<nvf/modules/plugins/mini/clue/clue.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.clue.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.clue.setupOpts"><code class="option">vim.mini.clue.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.clue</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/clue/clue.nix" target="_top"> +<nvf/modules/plugins/mini/clue/clue.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.colors.enable"></a><a class="term" href="options.html#opt-vim.mini.colors.enable"><code class="option">vim.mini.colors.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.colors.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/colors/colors.nix" target="_top"> +<nvf/modules/plugins/mini/colors/colors.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.comment.enable"></a><a class="term" href="options.html#opt-vim.mini.comment.enable"><code class="option">vim.mini.comment.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.comment.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/comment/comment.nix" target="_top"> +<nvf/modules/plugins/mini/comment/comment.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.comment.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.comment.setupOpts"><code class="option">vim.mini.comment.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.comment</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/comment/comment.nix" target="_top"> +<nvf/modules/plugins/mini/comment/comment.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.completion.enable"></a><a class="term" href="options.html#opt-vim.mini.completion.enable"><code class="option">vim.mini.completion.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.completion.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/completion/completion.nix" target="_top"> +<nvf/modules/plugins/mini/completion/completion.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.completion.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.completion.setupOpts"><code class="option">vim.mini.completion.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.completion</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/completion/completion.nix" target="_top"> +<nvf/modules/plugins/mini/completion/completion.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.diff.enable"></a><a class="term" href="options.html#opt-vim.mini.diff.enable"><code class="option">vim.mini.diff.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.diff.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/diff/diff.nix" target="_top"> +<nvf/modules/plugins/mini/diff/diff.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.diff.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.diff.setupOpts"><code class="option">vim.mini.diff.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.diff</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/diff/diff.nix" target="_top"> +<nvf/modules/plugins/mini/diff/diff.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.doc.enable"></a><a class="term" href="options.html#opt-vim.mini.doc.enable"><code class="option">vim.mini.doc.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.doc.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/doc/doc.nix" target="_top"> +<nvf/modules/plugins/mini/doc/doc.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.doc.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.doc.setupOpts"><code class="option">vim.mini.doc.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.doc</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/doc/doc.nix" target="_top"> +<nvf/modules/plugins/mini/doc/doc.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.extra.enable"></a><a class="term" href="options.html#opt-vim.mini.extra.enable"><code class="option">vim.mini.extra.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.extra.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/extra/extra.nix" target="_top"> +<nvf/modules/plugins/mini/extra/extra.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.files.enable"></a><a class="term" href="options.html#opt-vim.mini.files.enable"><code class="option">vim.mini.files.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.files.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/files/files.nix" target="_top"> +<nvf/modules/plugins/mini/files/files.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.files.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.files.setupOpts"><code class="option">vim.mini.files.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.files</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/files/files.nix" target="_top"> +<nvf/modules/plugins/mini/files/files.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.fuzzy.enable"></a><a class="term" href="options.html#opt-vim.mini.fuzzy.enable"><code class="option">vim.mini.fuzzy.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.fuzzy.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/fuzzy/fuzzy.nix" target="_top"> +<nvf/modules/plugins/mini/fuzzy/fuzzy.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.fuzzy.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.fuzzy.setupOpts"><code class="option">vim.mini.fuzzy.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.fuzzy</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/fuzzy/fuzzy.nix" target="_top"> +<nvf/modules/plugins/mini/fuzzy/fuzzy.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.git.enable"></a><a class="term" href="options.html#opt-vim.mini.git.enable"><code class="option">vim.mini.git.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.git.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/git/git.nix" target="_top"> +<nvf/modules/plugins/mini/git/git.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.git.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.git.setupOpts"><code class="option">vim.mini.git.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.git</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/git/git.nix" target="_top"> +<nvf/modules/plugins/mini/git/git.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.hipatterns.enable"></a><a class="term" href="options.html#opt-vim.mini.hipatterns.enable"><code class="option">vim.mini.hipatterns.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.hipatterns.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/hipatterns/hipatterns.nix" target="_top"> +<nvf/modules/plugins/mini/hipatterns/hipatterns.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.hipatterns.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.hipatterns.setupOpts"><code class="option">vim.mini.hipatterns.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.hipatterns</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/hipatterns/hipatterns.nix" target="_top"> +<nvf/modules/plugins/mini/hipatterns/hipatterns.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.hues.enable"></a><a class="term" href="options.html#opt-vim.mini.hues.enable"><code class="option">vim.mini.hues.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.hues.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/hues/hues.nix" target="_top"> +<nvf/modules/plugins/mini/hues/hues.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.hues.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.hues.setupOpts"><code class="option">vim.mini.hues.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.hues</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/hues/hues.nix" target="_top"> +<nvf/modules/plugins/mini/hues/hues.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.hues.setupOpts.background"></a><a class="term" href="options.html#opt-vim.mini.hues.setupOpts.background"><code class="option">vim.mini.hues.setupOpts.background</code> + </a> + </span> +</dt> +<dd> +<p>The hex color for the background color of the color scheme, prefixed with #</p> + +<p><span class="emphasis"><em>Type:</em></span> +RGB color in hex format</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/plugins/mini/hues/hues.nix" target="_top"> +<nvf/modules/plugins/mini/hues/hues.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.hues.setupOpts.foreground"></a><a class="term" href="options.html#opt-vim.mini.hues.setupOpts.foreground"><code class="option">vim.mini.hues.setupOpts.foreground</code> + </a> + </span> +</dt> +<dd> +<p>The hex color for the foreground color of the color scheme, prefixed with #</p> + +<p><span class="emphasis"><em>Type:</em></span> +RGB color in hex format</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/plugins/mini/hues/hues.nix" target="_top"> +<nvf/modules/plugins/mini/hues/hues.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.icons.enable"></a><a class="term" href="options.html#opt-vim.mini.icons.enable"><code class="option">vim.mini.icons.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.icons.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/icons/icons.nix" target="_top"> +<nvf/modules/plugins/mini/icons/icons.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.icons.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.icons.setupOpts"><code class="option">vim.mini.icons.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.icons</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/icons/icons.nix" target="_top"> +<nvf/modules/plugins/mini/icons/icons.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.indentscope.enable"></a><a class="term" href="options.html#opt-vim.mini.indentscope.enable"><code class="option">vim.mini.indentscope.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.indentscope.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/indentscope/indentscope.nix" target="_top"> +<nvf/modules/plugins/mini/indentscope/indentscope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.indentscope.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.indentscope.setupOpts"><code class="option">vim.mini.indentscope.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.indentscope</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/indentscope/indentscope.nix" target="_top"> +<nvf/modules/plugins/mini/indentscope/indentscope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.jump.enable"></a><a class="term" href="options.html#opt-vim.mini.jump.enable"><code class="option">vim.mini.jump.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.jump.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/jump/jump.nix" target="_top"> +<nvf/modules/plugins/mini/jump/jump.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.jump.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.jump.setupOpts"><code class="option">vim.mini.jump.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.jump</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/jump/jump.nix" target="_top"> +<nvf/modules/plugins/mini/jump/jump.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.jump2d.enable"></a><a class="term" href="options.html#opt-vim.mini.jump2d.enable"><code class="option">vim.mini.jump2d.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.jump2d.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/jump2d/jump2d.nix" target="_top"> +<nvf/modules/plugins/mini/jump2d/jump2d.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.jump2d.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.jump2d.setupOpts"><code class="option">vim.mini.jump2d.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.jump2d</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/jump2d/jump2d.nix" target="_top"> +<nvf/modules/plugins/mini/jump2d/jump2d.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.map.enable"></a><a class="term" href="options.html#opt-vim.mini.map.enable"><code class="option">vim.mini.map.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.map.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/map/map.nix" target="_top"> +<nvf/modules/plugins/mini/map/map.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.map.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.map.setupOpts"><code class="option">vim.mini.map.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.map</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/map/map.nix" target="_top"> +<nvf/modules/plugins/mini/map/map.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.misc.enable"></a><a class="term" href="options.html#opt-vim.mini.misc.enable"><code class="option">vim.mini.misc.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.misc.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/misc/misc.nix" target="_top"> +<nvf/modules/plugins/mini/misc/misc.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.misc.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.misc.setupOpts"><code class="option">vim.mini.misc.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.misc</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/misc/misc.nix" target="_top"> +<nvf/modules/plugins/mini/misc/misc.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.move.enable"></a><a class="term" href="options.html#opt-vim.mini.move.enable"><code class="option">vim.mini.move.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.move.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/move/move.nix" target="_top"> +<nvf/modules/plugins/mini/move/move.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.move.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.move.setupOpts"><code class="option">vim.mini.move.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.move</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/move/move.nix" target="_top"> +<nvf/modules/plugins/mini/move/move.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.notify.enable"></a><a class="term" href="options.html#opt-vim.mini.notify.enable"><code class="option">vim.mini.notify.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.notify.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/notify/notify.nix" target="_top"> +<nvf/modules/plugins/mini/notify/notify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.notify.notifyOpts"></a><a class="term" href="options.html#opt-vim.mini.notify.notifyOpts"><code class="option">vim.mini.notify.notifyOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.notify notifications</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/notify/notify.nix" target="_top"> +<nvf/modules/plugins/mini/notify/notify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.notify.notifyOpts.DEBUG.duration"></a><a class="term" href="options.html#opt-vim.mini.notify.notifyOpts.DEBUG.duration"><code class="option">vim.mini.notify.notifyOpts.DEBUG.duration</code> + </a> + </span> +</dt> +<dd> +<p>The duration of the debug notification</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">0</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/plugins/mini/notify/notify.nix" target="_top"> +<nvf/modules/plugins/mini/notify/notify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.notify.notifyOpts.DEBUG.hl_group"></a><a class="term" href="options.html#opt-vim.mini.notify.notifyOpts.DEBUG.hl_group"><code class="option">vim.mini.notify.notifyOpts.DEBUG.hl_group</code> + </a> + </span> +</dt> +<dd> +<p>The highlight group of the debug notification</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"DiagnosticHint"</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/plugins/mini/notify/notify.nix" target="_top"> +<nvf/modules/plugins/mini/notify/notify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.notify.notifyOpts.ERROR.duration"></a><a class="term" href="options.html#opt-vim.mini.notify.notifyOpts.ERROR.duration"><code class="option">vim.mini.notify.notifyOpts.ERROR.duration</code> + </a> + </span> +</dt> +<dd> +<p>The duration of the error notification</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">5000</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/plugins/mini/notify/notify.nix" target="_top"> +<nvf/modules/plugins/mini/notify/notify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.notify.notifyOpts.ERROR.hl_group"></a><a class="term" href="options.html#opt-vim.mini.notify.notifyOpts.ERROR.hl_group"><code class="option">vim.mini.notify.notifyOpts.ERROR.hl_group</code> + </a> + </span> +</dt> +<dd> +<p>The highlight group of the error notification</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"DiagnosticError"</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/plugins/mini/notify/notify.nix" target="_top"> +<nvf/modules/plugins/mini/notify/notify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.notify.notifyOpts.INFO.duration"></a><a class="term" href="options.html#opt-vim.mini.notify.notifyOpts.INFO.duration"><code class="option">vim.mini.notify.notifyOpts.INFO.duration</code> + </a> + </span> +</dt> +<dd> +<p>The duration of the info notification</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">5000</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/plugins/mini/notify/notify.nix" target="_top"> +<nvf/modules/plugins/mini/notify/notify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.notify.notifyOpts.INFO.hl_group"></a><a class="term" href="options.html#opt-vim.mini.notify.notifyOpts.INFO.hl_group"><code class="option">vim.mini.notify.notifyOpts.INFO.hl_group</code> + </a> + </span> +</dt> +<dd> +<p>The highlight group of the info notification</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"DiagnosticInfo"</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/plugins/mini/notify/notify.nix" target="_top"> +<nvf/modules/plugins/mini/notify/notify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.notify.notifyOpts.OFF.duration"></a><a class="term" href="options.html#opt-vim.mini.notify.notifyOpts.OFF.duration"><code class="option">vim.mini.notify.notifyOpts.OFF.duration</code> + </a> + </span> +</dt> +<dd> +<p>The duration of the off notification</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">0</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/plugins/mini/notify/notify.nix" target="_top"> +<nvf/modules/plugins/mini/notify/notify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.notify.notifyOpts.OFF.hl_group"></a><a class="term" href="options.html#opt-vim.mini.notify.notifyOpts.OFF.hl_group"><code class="option">vim.mini.notify.notifyOpts.OFF.hl_group</code> + </a> + </span> +</dt> +<dd> +<p>The highlight group of the off notification</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"MiniNotifyNormal"</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/plugins/mini/notify/notify.nix" target="_top"> +<nvf/modules/plugins/mini/notify/notify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.notify.notifyOpts.TRACE.duration"></a><a class="term" href="options.html#opt-vim.mini.notify.notifyOpts.TRACE.duration"><code class="option">vim.mini.notify.notifyOpts.TRACE.duration</code> + </a> + </span> +</dt> +<dd> +<p>The duration of the trace notification</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">0</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/plugins/mini/notify/notify.nix" target="_top"> +<nvf/modules/plugins/mini/notify/notify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.notify.notifyOpts.TRACE.hl_group"></a><a class="term" href="options.html#opt-vim.mini.notify.notifyOpts.TRACE.hl_group"><code class="option">vim.mini.notify.notifyOpts.TRACE.hl_group</code> + </a> + </span> +</dt> +<dd> +<p>The highlight group of the trace notification</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"DiagnosticOk"</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/plugins/mini/notify/notify.nix" target="_top"> +<nvf/modules/plugins/mini/notify/notify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.notify.notifyOpts.WARN.duration"></a><a class="term" href="options.html#opt-vim.mini.notify.notifyOpts.WARN.duration"><code class="option">vim.mini.notify.notifyOpts.WARN.duration</code> + </a> + </span> +</dt> +<dd> +<p>The duration of the warn notification</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">5000</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/plugins/mini/notify/notify.nix" target="_top"> +<nvf/modules/plugins/mini/notify/notify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.notify.notifyOpts.WARN.hl_group"></a><a class="term" href="options.html#opt-vim.mini.notify.notifyOpts.WARN.hl_group"><code class="option">vim.mini.notify.notifyOpts.WARN.hl_group</code> + </a> + </span> +</dt> +<dd> +<p>The highlight group of the warn notification</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"DiagnosticWarn"</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/plugins/mini/notify/notify.nix" target="_top"> +<nvf/modules/plugins/mini/notify/notify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.notify.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.notify.setupOpts"><code class="option">vim.mini.notify.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.notify</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/notify/notify.nix" target="_top"> +<nvf/modules/plugins/mini/notify/notify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.notify.setupOpts.window.config.border"></a><a class="term" href="options.html#opt-vim.mini.notify.setupOpts.window.config.border"><code class="option">vim.mini.notify.setupOpts.window.config.border</code> + </a> + </span> +</dt> +<dd> +<p>The border type for the mini.notify-notifications</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “none”, “single”, “double”, “rounded”, “solid”, “shadow” or list of (string or list of string)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"rounded"</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/plugins/mini/notify/notify.nix" target="_top"> +<nvf/modules/plugins/mini/notify/notify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.operators.enable"></a><a class="term" href="options.html#opt-vim.mini.operators.enable"><code class="option">vim.mini.operators.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.operators.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/operators/operators.nix" target="_top"> +<nvf/modules/plugins/mini/operators/operators.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.operators.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.operators.setupOpts"><code class="option">vim.mini.operators.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.operators</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/operators/operators.nix" target="_top"> +<nvf/modules/plugins/mini/operators/operators.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.pairs.enable"></a><a class="term" href="options.html#opt-vim.mini.pairs.enable"><code class="option">vim.mini.pairs.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.pairs.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/pairs/pairs.nix" target="_top"> +<nvf/modules/plugins/mini/pairs/pairs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.pairs.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.pairs.setupOpts"><code class="option">vim.mini.pairs.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.pairs</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/pairs/pairs.nix" target="_top"> +<nvf/modules/plugins/mini/pairs/pairs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.pick.enable"></a><a class="term" href="options.html#opt-vim.mini.pick.enable"><code class="option">vim.mini.pick.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.pick.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/pick/pick.nix" target="_top"> +<nvf/modules/plugins/mini/pick/pick.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.pick.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.pick.setupOpts"><code class="option">vim.mini.pick.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.pick</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/pick/pick.nix" target="_top"> +<nvf/modules/plugins/mini/pick/pick.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.sessions.enable"></a><a class="term" href="options.html#opt-vim.mini.sessions.enable"><code class="option">vim.mini.sessions.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.sessions.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/sessions/sessions.nix" target="_top"> +<nvf/modules/plugins/mini/sessions/sessions.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.sessions.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.sessions.setupOpts"><code class="option">vim.mini.sessions.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.sessions</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/sessions/sessions.nix" target="_top"> +<nvf/modules/plugins/mini/sessions/sessions.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.snippets.enable"></a><a class="term" href="options.html#opt-vim.mini.snippets.enable"><code class="option">vim.mini.snippets.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.snippets.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/snippets/snippets.nix" target="_top"> +<nvf/modules/plugins/mini/snippets/snippets.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.snippets.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.snippets.setupOpts"><code class="option">vim.mini.snippets.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.snippets</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/snippets/snippets.nix" target="_top"> +<nvf/modules/plugins/mini/snippets/snippets.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.splitjoin.enable"></a><a class="term" href="options.html#opt-vim.mini.splitjoin.enable"><code class="option">vim.mini.splitjoin.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.splitjoin.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/splitjoin/splitjoin.nix" target="_top"> +<nvf/modules/plugins/mini/splitjoin/splitjoin.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.splitjoin.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.splitjoin.setupOpts"><code class="option">vim.mini.splitjoin.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.splitjoin</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/splitjoin/splitjoin.nix" target="_top"> +<nvf/modules/plugins/mini/splitjoin/splitjoin.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.starter.enable"></a><a class="term" href="options.html#opt-vim.mini.starter.enable"><code class="option">vim.mini.starter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.starter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/starter/starter.nix" target="_top"> +<nvf/modules/plugins/mini/starter/starter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.starter.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.starter.setupOpts"><code class="option">vim.mini.starter.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.starter</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/starter/starter.nix" target="_top"> +<nvf/modules/plugins/mini/starter/starter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.statusline.enable"></a><a class="term" href="options.html#opt-vim.mini.statusline.enable"><code class="option">vim.mini.statusline.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.statusline.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/statusline/statusline.nix" target="_top"> +<nvf/modules/plugins/mini/statusline/statusline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.statusline.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.statusline.setupOpts"><code class="option">vim.mini.statusline.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.statusline</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/statusline/statusline.nix" target="_top"> +<nvf/modules/plugins/mini/statusline/statusline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.surround.enable"></a><a class="term" href="options.html#opt-vim.mini.surround.enable"><code class="option">vim.mini.surround.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.surround.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/surround/surround.nix" target="_top"> +<nvf/modules/plugins/mini/surround/surround.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.surround.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.surround.setupOpts"><code class="option">vim.mini.surround.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.surround</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/surround/surround.nix" target="_top"> +<nvf/modules/plugins/mini/surround/surround.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.tabline.enable"></a><a class="term" href="options.html#opt-vim.mini.tabline.enable"><code class="option">vim.mini.tabline.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.tabline.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/tabline/tabline.nix" target="_top"> +<nvf/modules/plugins/mini/tabline/tabline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.tabline.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.tabline.setupOpts"><code class="option">vim.mini.tabline.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.tabline</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/tabline/tabline.nix" target="_top"> +<nvf/modules/plugins/mini/tabline/tabline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.test.enable"></a><a class="term" href="options.html#opt-vim.mini.test.enable"><code class="option">vim.mini.test.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.test.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/test/test.nix" target="_top"> +<nvf/modules/plugins/mini/test/test.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.test.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.test.setupOpts"><code class="option">vim.mini.test.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.test</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/test/test.nix" target="_top"> +<nvf/modules/plugins/mini/test/test.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.trailspace.enable"></a><a class="term" href="options.html#opt-vim.mini.trailspace.enable"><code class="option">vim.mini.trailspace.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.trailspace.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/trailspace/trailspace.nix" target="_top"> +<nvf/modules/plugins/mini/trailspace/trailspace.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.trailspace.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.trailspace.setupOpts"><code class="option">vim.mini.trailspace.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.trailspace</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/trailspace/trailspace.nix" target="_top"> +<nvf/modules/plugins/mini/trailspace/trailspace.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.visits.enable"></a><a class="term" href="options.html#opt-vim.mini.visits.enable"><code class="option">vim.mini.visits.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable mini.visits.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/mini/visits/visits.nix" target="_top"> +<nvf/modules/plugins/mini/visits/visits.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.mini.visits.setupOpts"></a><a class="term" href="options.html#opt-vim.mini.visits.setupOpts"><code class="option">vim.mini.visits.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of mini.visits</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/mini/visits/visits.nix" target="_top"> +<nvf/modules/plugins/mini/visits/visits.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.minimap.codewindow.enable"></a><a class="term" href="options.html#opt-vim.minimap.codewindow.enable"><code class="option">vim.minimap.codewindow.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable codewindow plugin for minimap view.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/minimap/codewindow/codewindow.nix" target="_top"> +<nvf/modules/plugins/minimap/codewindow/codewindow.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.minimap.codewindow.mappings.close"></a><a class="term" href="options.html#opt-vim.minimap.codewindow.mappings.close"><code class="option">vim.minimap.codewindow.mappings.close</code> + </a> + </span> +</dt> +<dd> +<p>Close minimap [codewindow]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>mc"</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/plugins/minimap/codewindow/codewindow.nix" target="_top"> +<nvf/modules/plugins/minimap/codewindow/codewindow.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.minimap.codewindow.mappings.open"></a><a class="term" href="options.html#opt-vim.minimap.codewindow.mappings.open"><code class="option">vim.minimap.codewindow.mappings.open</code> + </a> + </span> +</dt> +<dd> +<p>Open minimap [codewindow]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>mo"</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/plugins/minimap/codewindow/codewindow.nix" target="_top"> +<nvf/modules/plugins/minimap/codewindow/codewindow.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.minimap.codewindow.mappings.toggle"></a><a class="term" href="options.html#opt-vim.minimap.codewindow.mappings.toggle"><code class="option">vim.minimap.codewindow.mappings.toggle</code> + </a> + </span> +</dt> +<dd> +<p>Toggle minimap [codewindow]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>mm"</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/plugins/minimap/codewindow/codewindow.nix" target="_top"> +<nvf/modules/plugins/minimap/codewindow/codewindow.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.minimap.codewindow.mappings.toggleFocus"></a><a class="term" href="options.html#opt-vim.minimap.codewindow.mappings.toggleFocus"><code class="option">vim.minimap.codewindow.mappings.toggleFocus</code> + </a> + </span> +</dt> +<dd> +<p>Toggle minimap focus [codewindow]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>mf"</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/plugins/minimap/codewindow/codewindow.nix" target="_top"> +<nvf/modules/plugins/minimap/codewindow/codewindow.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.minimap.minimap-vim.enable"></a><a class="term" href="options.html#opt-vim.minimap.minimap-vim.enable"><code class="option">vim.minimap.minimap-vim.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable minimap view [minimap-vim].</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/minimap/minimap-vim/minimap-vim.nix" target="_top"> +<nvf/modules/plugins/minimap/minimap-vim/minimap-vim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.mind-nvim.enable"></a><a class="term" href="options.html#opt-vim.notes.mind-nvim.enable"><code class="option">vim.notes.mind-nvim.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable note organizer tool for Neovim [mind-nvim].</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/notes/mind-nvim/mind-nvim.nix" target="_top"> +<nvf/modules/plugins/notes/mind-nvim/mind-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.neorg.enable"></a><a class="term" href="options.html#opt-vim.notes.neorg.enable"><code class="option">vim.notes.neorg.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Neorg: An intuitive note-taking and organization tool with a structured nested syntax. +.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/notes/neorg/neorg.nix" target="_top"> +<nvf/modules/plugins/notes/neorg/neorg.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.neorg.setupOpts"></a><a class="term" href="options.html#opt-vim.notes.neorg.setupOpts"><code class="option">vim.notes.neorg.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of Neorg</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/notes/neorg/neorg.nix" target="_top"> +<nvf/modules/plugins/notes/neorg/neorg.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.neorg.setupOpts.load._core.defaults_"></a><a class="term" href="options.html#opt-vim.notes.neorg.setupOpts.load._core.defaults_"><code class="option">vim.notes.neorg.setupOpts.load."core.defaults"</code> + </a> + </span> +</dt> +<dd> +<p>all of the most important modules that any user would want to have a “just works” experience</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/notes/neorg/neorg.nix" target="_top"> +<nvf/modules/plugins/notes/neorg/neorg.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.neorg.setupOpts.load._core.defaults_.enable"></a><a class="term" href="options.html#opt-vim.notes.neorg.setupOpts.load._core.defaults_.enable"><code class="option">vim.notes.neorg.setupOpts.load."core.defaults".enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable all of the most important modules that any user would want to have a “just works” experience +.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/notes/neorg/neorg.nix" target="_top"> +<nvf/modules/plugins/notes/neorg/neorg.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.neorg.setupOpts.load._core.defaults_.config.disable"></a><a class="term" href="options.html#opt-vim.notes.neorg.setupOpts.load._core.defaults_.config.disable"><code class="option">vim.notes.neorg.setupOpts.load."core.defaults".config.disable</code> + </a> + </span> +</dt> +<dd> +<p>list of modules from to be disabled from core.defaults</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</code></p> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">[ + "core.autocommands" + "core.itero" +] +</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/plugins/notes/neorg/neorg.nix" target="_top"> +<nvf/modules/plugins/notes/neorg/neorg.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.neorg.treesitter.enable"></a><a class="term" href="options.html#opt-vim.notes.neorg.treesitter.enable"><code class="option">vim.notes.neorg.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Neorg treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/notes/neorg/neorg.nix" target="_top"> +<nvf/modules/plugins/notes/neorg/neorg.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.neorg.treesitter.norgPackage"></a><a class="term" href="options.html#opt-vim.notes.neorg.treesitter.norgPackage"><code class="option">vim.notes.neorg.treesitter.norgPackage</code> + </a> + </span> +</dt> +<dd> +<p>The norg treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.norg</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/plugins/notes/neorg/neorg.nix" target="_top"> +<nvf/modules/plugins/notes/neorg/neorg.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.obsidian.enable"></a><a class="term" href="options.html#opt-vim.notes.obsidian.enable"><code class="option">vim.notes.obsidian.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable complementary neovim plugins for Obsidian editor.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/notes/obsidian/obsidian.nix" target="_top"> +<nvf/modules/plugins/notes/obsidian/obsidian.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.obsidian.setupOpts"></a><a class="term" href="options.html#opt-vim.notes.obsidian.setupOpts"><code class="option">vim.notes.obsidian.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of Obsidian.nvim</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/notes/obsidian/obsidian.nix" target="_top"> +<nvf/modules/plugins/notes/obsidian/obsidian.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.obsidian.setupOpts.completion.nvim_cmp"></a><a class="term" href="options.html#opt-vim.notes.obsidian.setupOpts.completion.nvim_cmp"><code class="option">vim.notes.obsidian.setupOpts.completion.nvim_cmp</code> + </a> + </span> +</dt> +<dd> +<p>If using nvim-cmp, otherwise set to false</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/notes/obsidian/obsidian.nix" target="_top"> +<nvf/modules/plugins/notes/obsidian/obsidian.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.obsidian.setupOpts.daily_notes.date_format"></a><a class="term" href="options.html#opt-vim.notes.obsidian.setupOpts.daily_notes.date_format"><code class="option">vim.notes.obsidian.setupOpts.daily_notes.date_format</code> + </a> + </span> +</dt> +<dd> +<p>Date format used for creating daily notes</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/notes/obsidian/obsidian.nix" target="_top"> +<nvf/modules/plugins/notes/obsidian/obsidian.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.obsidian.setupOpts.daily_notes.folder"></a><a class="term" href="options.html#opt-vim.notes.obsidian.setupOpts.daily_notes.folder"><code class="option">vim.notes.obsidian.setupOpts.daily_notes.folder</code> + </a> + </span> +</dt> +<dd> +<p>Directory in which daily notes should be created</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/notes/obsidian/obsidian.nix" target="_top"> +<nvf/modules/plugins/notes/obsidian/obsidian.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.orgmode.enable"></a><a class="term" href="options.html#opt-vim.notes.orgmode.enable"><code class="option">vim.notes.orgmode.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable nvim-orgmode: Neovim plugin for Emacs Orgmode. Get the best of both worlds.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/notes/orgmode/orgmode.nix" target="_top"> +<nvf/modules/plugins/notes/orgmode/orgmode.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.orgmode.setupOpts"></a><a class="term" href="options.html#opt-vim.notes.orgmode.setupOpts"><code class="option">vim.notes.orgmode.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of Orgmode</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/notes/orgmode/orgmode.nix" target="_top"> +<nvf/modules/plugins/notes/orgmode/orgmode.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.orgmode.setupOpts.org_agenda_files"></a><a class="term" href="options.html#opt-vim.notes.orgmode.setupOpts.org_agenda_files"><code class="option">vim.notes.orgmode.setupOpts.org_agenda_files</code> + </a> + </span> +</dt> +<dd> +<p>List of org files to be used as agenda files.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "~/Documents/org/*" + "~/my-orgs/**/*" +] +</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/plugins/notes/orgmode/orgmode.nix" target="_top"> +<nvf/modules/plugins/notes/orgmode/orgmode.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.orgmode.setupOpts.org_default_notes_file"></a><a class="term" href="options.html#opt-vim.notes.orgmode.setupOpts.org_default_notes_file"><code class="option">vim.notes.orgmode.setupOpts.org_default_notes_file</code> + </a> + </span> +</dt> +<dd> +<p>Default org file to be used for notes.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"~/Documents/org/refile.org"</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/plugins/notes/orgmode/orgmode.nix" target="_top"> +<nvf/modules/plugins/notes/orgmode/orgmode.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.orgmode.treesitter.enable"></a><a class="term" href="options.html#opt-vim.notes.orgmode.treesitter.enable"><code class="option">vim.notes.orgmode.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Orgmode treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/notes/orgmode/orgmode.nix" target="_top"> +<nvf/modules/plugins/notes/orgmode/orgmode.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.orgmode.treesitter.orgPackage"></a><a class="term" href="options.html#opt-vim.notes.orgmode.treesitter.orgPackage"><code class="option">vim.notes.orgmode.treesitter.orgPackage</code> + </a> + </span> +</dt> +<dd> +<p>The org treesitter package to use.</p> + +<p><span class="emphasis"><em>Type:</em></span> +package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars.org</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/plugins/notes/orgmode/orgmode.nix" target="_top"> +<nvf/modules/plugins/notes/orgmode/orgmode.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.todo-comments.enable"></a><a class="term" href="options.html#opt-vim.notes.todo-comments.enable"><code class="option">vim.notes.todo-comments.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable todo-comments: highlight and search for todo comments like TODO, HACK, BUG in your code base.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/notes/todo-comments/todo-comments.nix" target="_top"> +<nvf/modules/plugins/notes/todo-comments/todo-comments.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.todo-comments.mappings.quickFix"></a><a class="term" href="options.html#opt-vim.notes.todo-comments.mappings.quickFix"><code class="option">vim.notes.todo-comments.mappings.quickFix</code> + </a> + </span> +</dt> +<dd> +<p>Open Todo-s in a quickfix list</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>tdq"</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/plugins/notes/todo-comments/todo-comments.nix" target="_top"> +<nvf/modules/plugins/notes/todo-comments/todo-comments.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.todo-comments.mappings.telescope"></a><a class="term" href="options.html#opt-vim.notes.todo-comments.mappings.telescope"><code class="option">vim.notes.todo-comments.mappings.telescope</code> + </a> + </span> +</dt> +<dd> +<p>Open Todo-s in telescope</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>tds"</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/plugins/notes/todo-comments/todo-comments.nix" target="_top"> +<nvf/modules/plugins/notes/todo-comments/todo-comments.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.todo-comments.mappings.trouble"></a><a class="term" href="options.html#opt-vim.notes.todo-comments.mappings.trouble"><code class="option">vim.notes.todo-comments.mappings.trouble</code> + </a> + </span> +</dt> +<dd> +<p>Open Todo-s in Trouble</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>tdt"</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/plugins/notes/todo-comments/todo-comments.nix" target="_top"> +<nvf/modules/plugins/notes/todo-comments/todo-comments.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.todo-comments.setupOpts"></a><a class="term" href="options.html#opt-vim.notes.todo-comments.setupOpts"><code class="option">vim.notes.todo-comments.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of todo-comments.nvim</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/notes/todo-comments/todo-comments.nix" target="_top"> +<nvf/modules/plugins/notes/todo-comments/todo-comments.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.todo-comments.setupOpts.highlight.pattern"></a><a class="term" href="options.html#opt-vim.notes.todo-comments.setupOpts.highlight.pattern"><code class="option">vim.notes.todo-comments.setupOpts.highlight.pattern</code> + </a> + </span> +</dt> +<dd> +<p>vim regex pattern used for highlighting comments</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">".*<(KEYWORDS)(\\([^\\)]*\\))?:"</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/plugins/notes/todo-comments/todo-comments.nix" target="_top"> +<nvf/modules/plugins/notes/todo-comments/todo-comments.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.todo-comments.setupOpts.search.args"></a><a class="term" href="options.html#opt-vim.notes.todo-comments.setupOpts.search.args"><code class="option">vim.notes.todo-comments.setupOpts.search.args</code> + </a> + </span> +</dt> +<dd> +<p>arguments to pass to the search command</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "--color=never" + "--no-heading" + "--with-filename" + "--line-number" + "--column" +] +</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/plugins/notes/todo-comments/todo-comments.nix" target="_top"> +<nvf/modules/plugins/notes/todo-comments/todo-comments.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.todo-comments.setupOpts.search.command"></a><a class="term" href="options.html#opt-vim.notes.todo-comments.setupOpts.search.command"><code class="option">vim.notes.todo-comments.setupOpts.search.command</code> + </a> + </span> +</dt> +<dd> +<p>search command</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"\${pkgs.ripgrep}/bin/rg"</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/plugins/notes/todo-comments/todo-comments.nix" target="_top"> +<nvf/modules/plugins/notes/todo-comments/todo-comments.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notes.todo-comments.setupOpts.search.pattern"></a><a class="term" href="options.html#opt-vim.notes.todo-comments.setupOpts.search.pattern"><code class="option">vim.notes.todo-comments.setupOpts.search.pattern</code> + </a> + </span> +</dt> +<dd> +<p>ripgrep regex pattern used for searching comments</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"\\b(KEYWORDS)(\\([^\\)]*\\))?:"</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/plugins/notes/todo-comments/todo-comments.nix" target="_top"> +<nvf/modules/plugins/notes/todo-comments/todo-comments.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notify.nvim-notify.enable"></a><a class="term" href="options.html#opt-vim.notify.nvim-notify.enable"><code class="option">vim.notify.nvim-notify.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable nvim-notify notifications.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/ui/notifications/nvim-notify/nvim-notify.nix" target="_top"> +<nvf/modules/plugins/ui/notifications/nvim-notify/nvim-notify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notify.nvim-notify.setupOpts"></a><a class="term" href="options.html#opt-vim.notify.nvim-notify.setupOpts"><code class="option">vim.notify.nvim-notify.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of nvim-notify</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/ui/notifications/nvim-notify/nvim-notify.nix" target="_top"> +<nvf/modules/plugins/ui/notifications/nvim-notify/nvim-notify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notify.nvim-notify.setupOpts.background_colour"></a><a class="term" href="options.html#opt-vim.notify.nvim-notify.setupOpts.background_colour"><code class="option">vim.notify.nvim-notify.setupOpts.background_colour</code> + </a> + </span> +</dt> +<dd> +<p>The background colour of the notification</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"NotifyBackground"</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/plugins/ui/notifications/nvim-notify/nvim-notify.nix" target="_top"> +<nvf/modules/plugins/ui/notifications/nvim-notify/nvim-notify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notify.nvim-notify.setupOpts.icons"></a><a class="term" href="options.html#opt-vim.notify.nvim-notify.setupOpts.icons"><code class="option">vim.notify.nvim-notify.setupOpts.icons</code> + </a> + </span> +</dt> +<dd> +<p>The icons of the notification</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + DEBUG = ""; + ERROR = ""; + INFO = ""; + TRACE = ""; + WARN = ""; +} +</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/plugins/ui/notifications/nvim-notify/nvim-notify.nix" target="_top"> +<nvf/modules/plugins/ui/notifications/nvim-notify/nvim-notify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notify.nvim-notify.setupOpts.position"></a><a class="term" href="options.html#opt-vim.notify.nvim-notify.setupOpts.position"><code class="option">vim.notify.nvim-notify.setupOpts.position</code> + </a> + </span> +</dt> +<dd> +<p>The position of the notification</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “top_left”, “top_right”, “bottom_left”, “bottom_right”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"top_right"</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/plugins/ui/notifications/nvim-notify/nvim-notify.nix" target="_top"> +<nvf/modules/plugins/ui/notifications/nvim-notify/nvim-notify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notify.nvim-notify.setupOpts.render"></a><a class="term" href="options.html#opt-vim.notify.nvim-notify.setupOpts.render"><code class="option">vim.notify.nvim-notify.setupOpts.render</code> + </a> + </span> +</dt> +<dd> +<p>Custom rendering method to be used for displaying notifications</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “default”, “minimal”, “simple”, “compact”, “wrapped-compact” or (luaInline)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"compact"</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/plugins/ui/notifications/nvim-notify/nvim-notify.nix" target="_top"> +<nvf/modules/plugins/ui/notifications/nvim-notify/nvim-notify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notify.nvim-notify.setupOpts.stages"></a><a class="term" href="options.html#opt-vim.notify.nvim-notify.setupOpts.stages"><code class="option">vim.notify.nvim-notify.setupOpts.stages</code> + </a> + </span> +</dt> +<dd> +<p>The stages of the notification</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “fade_in_slide_out”, “fade”, “slide”, “static”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"fade_in_slide_out"</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/plugins/ui/notifications/nvim-notify/nvim-notify.nix" target="_top"> +<nvf/modules/plugins/ui/notifications/nvim-notify/nvim-notify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.notify.nvim-notify.setupOpts.timeout"></a><a class="term" href="options.html#opt-vim.notify.nvim-notify.setupOpts.timeout"><code class="option">vim.notify.nvim-notify.setupOpts.timeout</code> + </a> + </span> +</dt> +<dd> +<p>The timeout of the notification</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">1000</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/plugins/ui/notifications/nvim-notify/nvim-notify.nix" target="_top"> +<nvf/modules/plugins/ui/notifications/nvim-notify/nvim-notify.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.optPlugins"></a><a class="term" href="options.html#opt-vim.optPlugins"><code class="option">vim.optPlugins</code> + </a> + </span> +</dt> +<dd> +<p>List of plugins to optionally load on startup.</p><p>This option has the same type definition as <code class="option">vim.startPlugins</code> +and plugins in this list are appended to <code class="option">vim.startPlugins</code> by +the wrapper during the build process.</p><p>To avoid overriding packages and dependencies provided by startPlugins, you +are recommended to use this option or <code class="option">vim.extraPlugins</code> option.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of (null or package or one of “aerial-nvim”, “alpha-nvim”, “base16”, “bufdelete-nvim”, “catppuccin”, “ccc”, “cellular-automaton”, “chatgpt”, “cheatsheet-nvim”, “cinnamon-nvim”, “cmp-buffer”, “cmp-luasnip”, “cmp-nvim-lsp”, “cmp-path”, “cmp-treesitter”, “codewindow-nvim”, “comment-nvim”, “copilot-cmp”, “copilot-lua”, “crates-nvim”, “csharpls-extended”, “dashboard-nvim”, “diffview-nvim”, “dracula”, “dressing-nvim”, “elixir-tools”, “fastaction-nvim”, “fidget-nvim”, “flutter-tools”, “friendly-snippets”, “fzf-lua”, “gesture-nvim”, “gitsigns-nvim”, “glow-nvim”, “gruvbox”, “haskell-tools-nvim”, “highlight-undo”, “hop-nvim”, “icon-picker-nvim”, “image-nvim”, “indent-blankline”, “leap-nvim”, “lsp-lines”, “lsp-signature”, “lspkind”, “lspsaga”, “lua-utils-nvim”, “lualine”, “luasnip”, “lz-n”, “lzn-auto-require”, “mind-nvim”, “mini-ai”, “mini-align”, “mini-animate”, “mini-base16”, “mini-basics”, “mini-bracketed”, “mini-bufremove”, “mini-clue”, “mini-colors”, “mini-comment”, “mini-completion”, “mini-diff”, “mini-doc”, “mini-extra”, “mini-files”, “mini-fuzzy”, “mini-git”, “mini-hipatterns”, “mini-hues”, “mini-icons”, “mini-indentscope”, “mini-jump”, “mini-jump2d”, “mini-map”, “mini-misc”, “mini-move”, “mini-notify”, “mini-operators”, “mini-pairs”, “mini-pick”, “mini-sessions”, “mini-snippets”, “mini-splitjoin”, “mini-starter”, “mini-statusline”, “mini-surround”, “mini-tabline”, “mini-test”, “mini-trailspace”, “mini-visits”, “minimap-vim”, “modes-nvim”, “neo-tree-nvim”, “neocord”, “neodev-nvim”, “neorg”, “neorg-telescope”, “new-file-template-nvim”, “noice-nvim”, “none-ls”, “nord”, “nui-nvim”, “nvim-autopairs”, “nvim-bufferline-lua”, “nvim-cmp”, “nvim-colorizer-lua”, “nvim-cursorline”, “nvim-dap”, “nvim-dap-go”, “nvim-dap-ui”, “nvim-docs-view”, “nvim-lightbulb”, “nvim-lspconfig”, “nvim-metals”, “nvim-navbuddy”, “nvim-navic”, “nvim-neoclip”, “nvim-nio”, “nvim-notify”, “nvim-scrollbar”, “nvim-session-manager”, “nvim-surround”, “nvim-tree-lua”, “nvim-treesitter-context”, “nvim-ts-autotag”, “nvim-ufo”, “nvim-web-devicons”, “obsidian-nvim”, “omnisharp-extended”, “onedark”, “orgmode-nvim”, “otter-nvim”, “oxocarbon”, “pathlib-nvim”, “plenary-nvim”, “precognition-nvim”, “project-nvim”, “promise-async”, “registers”, “render-markdown-nvim”, “rose-pine”, “rtp-nvim”, “run-nvim”, “rustaceanvim”, “smartcolumn”, “sqls-nvim”, “tabular”, “telescope”, “tiny-devicons-auto-colors”, “todo-comments”, “toggleterm-nvim”, “tokyonight”, “trouble”, “ts-error-translator”, “typst-preview-nvim”, “vim-dirtytalk”, “vim-fugitive”, “vim-illuminate”, “vim-markdown”, “vim-repeat”, “vim-startify”, “which-key”, “nvim-treesitter”, “flutter-tools-patched”, “vim-repeat”)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</code></p> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">'' + [pkgs.vimPlugins.vim-ghost] +'' +</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/environment/options.nix" target="_top"> +<nvf/modules/wrapper/environment/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.options"></a><a class="term" href="options.html#opt-vim.options"><code class="option">vim.options</code> + </a> + </span> +</dt> +<dd> +<p>A freeform attribute set containing vim options to be set as early as possible. +If populated, this option will set vim options in the built <code class="option">luaConfigRC</code> +after <code class="literal">basic</code> and before <code class="literal">pluginConfigs</code> DAG entries.</p><div class="note"><h3 class="title">Note</h3><p><code class="literal">{foo = "bar";}</code> will set <code class="literal">vim.o.foo</code> to “bar”, where the type of <code class="literal">bar</code> in the +resulting Lua value will be inferred from the type of the value in the +<code class="literal">{name = value;}</code> pair passed to the option.</p></div> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</code></p> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">{ + visualbell = true; +} +</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"> +<nvf/modules/wrapper/rc/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.options.autoindent"></a><a class="term" href="options.html#opt-vim.options.autoindent"><code class="option">vim.options.autoindent</code> + </a> + </span> +</dt> +<dd> +<p>Enable auto indent</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/wrapper/rc/options.nix" target="_top"> +<nvf/modules/wrapper/rc/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.options.cmdheight"></a><a class="term" href="options.html#opt-vim.options.cmdheight"><code class="option">vim.options.cmdheight</code> + </a> + </span> +</dt> +<dd> +<p>Height of the command pane</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">1</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"> +<nvf/modules/wrapper/rc/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.options.cursorlineopt"></a><a class="term" href="options.html#opt-vim.options.cursorlineopt"><code class="option">vim.options.cursorlineopt</code> + </a> + </span> +</dt> +<dd> +<p>Highlight the text line of the cursor with CursorLine hl-CursorLine</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “line”, “screenline”, “number”, “both”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"line"</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"> +<nvf/modules/wrapper/rc/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.options.mouse"></a><a class="term" href="options.html#opt-vim.options.mouse"><code class="option">vim.options.mouse</code> + </a> + </span> +</dt> +<dd> +<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#'mouse'%22" target="_top">neovim documentation</a>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"nvi"</code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"a"</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"> +<nvf/modules/wrapper/rc/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.options.shiftwidth"></a><a class="term" href="options.html#opt-vim.options.shiftwidth"><code class="option">vim.options.shiftwidth</code> + </a> + </span> +</dt> +<dd> +<p>Number of spaces to use for each step of (auto)indent. Used for +<code class="option">cindent</code>, <code class="literal">>></code>, <code class="literal"><<</code>, etc.</p><p>When zero the <code class="option">tabstop</code> value will be used.</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<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"> +<nvf/modules/wrapper/rc/options.nix> +</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>Whether to show the sign column</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"yes"</code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"no"</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"> +<nvf/modules/wrapper/rc/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.options.splitbelow"></a><a class="term" href="options.html#opt-vim.options.splitbelow"><code class="option">vim.options.splitbelow</code> + </a> + </span> +</dt> +<dd> +<p>New splits will open below instead of on top</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/wrapper/rc/options.nix" target="_top"> +<nvf/modules/wrapper/rc/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.options.splitright"></a><a class="term" href="options.html#opt-vim.options.splitright"><code class="option">vim.options.splitright</code> + </a> + </span> +</dt> +<dd> +<p>New splits will open to the right</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/wrapper/rc/options.nix" target="_top"> +<nvf/modules/wrapper/rc/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.options.tabstop"></a><a class="term" href="options.html#opt-vim.options.tabstop"><code class="option">vim.options.tabstop</code> + </a> + </span> +</dt> +<dd> +<p>Number of spaces that a <code class="literal"><Tab></code> in the file counts for. Also see +the <span class="command"><strong>:retab</strong></span> command, and the <code class="option">softtabstop</code> option.</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<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"> +<nvf/modules/wrapper/rc/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.options.termguicolors"></a><a class="term" href="options.html#opt-vim.options.termguicolors"><code class="option">vim.options.termguicolors</code> + </a> + </span> +</dt> +<dd> +<p>Set terminal up for 256 colours</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/wrapper/rc/options.nix" target="_top"> +<nvf/modules/wrapper/rc/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.options.tm"></a><a class="term" href="options.html#opt-vim.options.tm"><code class="option">vim.options.tm</code> + </a> + </span> +</dt> +<dd> +<p>Timeout in ms that Neovim will wait for mapped action to complete</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">500</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"> +<nvf/modules/wrapper/rc/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.options.updatetime"></a><a class="term" href="options.html#opt-vim.options.updatetime"><code class="option">vim.options.updatetime</code> + </a> + </span> +</dt> +<dd> +<p>The number of milliseconds till Cursor Hold event is fired</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">300</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"> +<nvf/modules/wrapper/rc/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.options.wrap"></a><a class="term" href="options.html#opt-vim.options.wrap"><code class="option">vim.options.wrap</code> + </a> + </span> +</dt> +<dd> +<p>Enable word wrapping.</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/wrapper/rc/options.nix" target="_top"> +<nvf/modules/wrapper/rc/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.pluginRC"></a><a class="term" href="options.html#opt-vim.pluginRC"><code class="option">vim.pluginRC</code> + </a> + </span> +</dt> +<dd> +<p>The DAG used to configure plugins. If a string is passed, entryAnywhere is automatically applied.</p> + +<p><span class="emphasis"><em>Type:</em></span> +(DAG of strings concatenated with “\n”) or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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"> +<nvf/modules/wrapper/rc/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.presence.neocord.enable"></a><a class="term" href="options.html#opt-vim.presence.neocord.enable"><code class="option">vim.presence.neocord.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable neocord plugin for discord rich presence.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/rich-presence/neocord/neocord.nix" target="_top"> +<nvf/modules/plugins/rich-presence/neocord/neocord.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.presence.neocord.setupOpts"></a><a class="term" href="options.html#opt-vim.presence.neocord.setupOpts"><code class="option">vim.presence.neocord.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of neocord</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/rich-presence/neocord/neocord.nix" target="_top"> +<nvf/modules/plugins/rich-presence/neocord/neocord.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.presence.neocord.setupOpts.enable_line_number"></a><a class="term" href="options.html#opt-vim.presence.neocord.setupOpts.enable_line_number"><code class="option">vim.presence.neocord.setupOpts.enable_line_number</code> + </a> + </span> +</dt> +<dd> +<p>Show line number on the RPC item</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/rich-presence/neocord/neocord.nix" target="_top"> +<nvf/modules/plugins/rich-presence/neocord/neocord.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.presence.neocord.setupOpts.auto_update"></a><a class="term" href="options.html#opt-vim.presence.neocord.setupOpts.auto_update"><code class="option">vim.presence.neocord.setupOpts.auto_update</code> + </a> + </span> +</dt> +<dd> +<p>Automatically update the presence</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/plugins/rich-presence/neocord/neocord.nix" target="_top"> +<nvf/modules/plugins/rich-presence/neocord/neocord.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.presence.neocord.setupOpts.blacklist"></a><a class="term" href="options.html#opt-vim.presence.neocord.setupOpts.blacklist"><code class="option">vim.presence.neocord.setupOpts.blacklist</code> + </a> + </span> +</dt> +<dd> +<p>List of filetypes to ignore</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">["Alpha"]</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/plugins/rich-presence/neocord/neocord.nix" target="_top"> +<nvf/modules/plugins/rich-presence/neocord/neocord.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.presence.neocord.setupOpts.client_id"></a><a class="term" href="options.html#opt-vim.presence.neocord.setupOpts.client_id"><code class="option">vim.presence.neocord.setupOpts.client_id</code> + </a> + </span> +</dt> +<dd> +<p>Client ID of the application</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"1157438221865717891"</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/plugins/rich-presence/neocord/neocord.nix" target="_top"> +<nvf/modules/plugins/rich-presence/neocord/neocord.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.presence.neocord.setupOpts.debounce_timeout"></a><a class="term" href="options.html#opt-vim.presence.neocord.setupOpts.debounce_timeout"><code class="option">vim.presence.neocord.setupOpts.debounce_timeout</code> + </a> + </span> +</dt> +<dd> +<p>Number of seconds to debounce events</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">10</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/plugins/rich-presence/neocord/neocord.nix" target="_top"> +<nvf/modules/plugins/rich-presence/neocord/neocord.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.presence.neocord.setupOpts.editing_text"></a><a class="term" href="options.html#opt-vim.presence.neocord.setupOpts.editing_text"><code class="option">vim.presence.neocord.setupOpts.editing_text</code> + </a> + </span> +</dt> +<dd> +<p>Text displayed when editing a file</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"Editing %s"</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/plugins/rich-presence/neocord/neocord.nix" target="_top"> +<nvf/modules/plugins/rich-presence/neocord/neocord.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.presence.neocord.setupOpts.file_explorer_text"></a><a class="term" href="options.html#opt-vim.presence.neocord.setupOpts.file_explorer_text"><code class="option">vim.presence.neocord.setupOpts.file_explorer_text</code> + </a> + </span> +</dt> +<dd> +<p>Text displayed when browsing files</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"Browsing %s"</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/plugins/rich-presence/neocord/neocord.nix" target="_top"> +<nvf/modules/plugins/rich-presence/neocord/neocord.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.presence.neocord.setupOpts.git_commit_text"></a><a class="term" href="options.html#opt-vim.presence.neocord.setupOpts.git_commit_text"><code class="option">vim.presence.neocord.setupOpts.git_commit_text</code> + </a> + </span> +</dt> +<dd> +<p>Text displayed when committing changes</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"Committing changes"</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/plugins/rich-presence/neocord/neocord.nix" target="_top"> +<nvf/modules/plugins/rich-presence/neocord/neocord.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.presence.neocord.setupOpts.line_number_text"></a><a class="term" href="options.html#opt-vim.presence.neocord.setupOpts.line_number_text"><code class="option">vim.presence.neocord.setupOpts.line_number_text</code> + </a> + </span> +</dt> +<dd> +<p>Text displayed when showing line number</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"Line %s out of %s"</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/plugins/rich-presence/neocord/neocord.nix" target="_top"> +<nvf/modules/plugins/rich-presence/neocord/neocord.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.presence.neocord.setupOpts.log_level"></a><a class="term" href="options.html#opt-vim.presence.neocord.setupOpts.log_level"><code class="option">vim.presence.neocord.setupOpts.log_level</code> + </a> + </span> +</dt> +<dd> +<p>Log level to be used by the plugin</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or one of “debug”, “info”, “warn”, “error”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/rich-presence/neocord/neocord.nix" target="_top"> +<nvf/modules/plugins/rich-presence/neocord/neocord.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.presence.neocord.setupOpts.logo"></a><a class="term" href="options.html#opt-vim.presence.neocord.setupOpts.logo"><code class="option">vim.presence.neocord.setupOpts.logo</code> + </a> + </span> +</dt> +<dd> +<p>Logo to be displayed on the RPC item</p><p>This must be either “auto” or an URL to your image of choice</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"auto"</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/plugins/rich-presence/neocord/neocord.nix" target="_top"> +<nvf/modules/plugins/rich-presence/neocord/neocord.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.presence.neocord.setupOpts.logo_tooltip"></a><a class="term" href="options.html#opt-vim.presence.neocord.setupOpts.logo_tooltip"><code class="option">vim.presence.neocord.setupOpts.logo_tooltip</code> + </a> + </span> +</dt> +<dd> +<p>Text displayed when hovering over the Neovim image</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"The One True Text Editor"</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/plugins/rich-presence/neocord/neocord.nix" target="_top"> +<nvf/modules/plugins/rich-presence/neocord/neocord.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.presence.neocord.setupOpts.main_image"></a><a class="term" href="options.html#opt-vim.presence.neocord.setupOpts.main_image"><code class="option">vim.presence.neocord.setupOpts.main_image</code> + </a> + </span> +</dt> +<dd> +<p>Main image to be displayed</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “language”, “logo”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"language"</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/plugins/rich-presence/neocord/neocord.nix" target="_top"> +<nvf/modules/plugins/rich-presence/neocord/neocord.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.presence.neocord.setupOpts.plugin_manager_text"></a><a class="term" href="options.html#opt-vim.presence.neocord.setupOpts.plugin_manager_text"><code class="option">vim.presence.neocord.setupOpts.plugin_manager_text</code> + </a> + </span> +</dt> +<dd> +<p>Text displayed when managing plugins</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"Managing plugins"</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/plugins/rich-presence/neocord/neocord.nix" target="_top"> +<nvf/modules/plugins/rich-presence/neocord/neocord.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.presence.neocord.setupOpts.reading_text"></a><a class="term" href="options.html#opt-vim.presence.neocord.setupOpts.reading_text"><code class="option">vim.presence.neocord.setupOpts.reading_text</code> + </a> + </span> +</dt> +<dd> +<p>Text displayed when reading a file</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"Reading %s"</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/plugins/rich-presence/neocord/neocord.nix" target="_top"> +<nvf/modules/plugins/rich-presence/neocord/neocord.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.presence.neocord.setupOpts.show_time"></a><a class="term" href="options.html#opt-vim.presence.neocord.setupOpts.show_time"><code class="option">vim.presence.neocord.setupOpts.show_time</code> + </a> + </span> +</dt> +<dd> +<p>Show time on the RPC item</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/plugins/rich-presence/neocord/neocord.nix" target="_top"> +<nvf/modules/plugins/rich-presence/neocord/neocord.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.presence.neocord.setupOpts.terminal_text"></a><a class="term" href="options.html#opt-vim.presence.neocord.setupOpts.terminal_text"><code class="option">vim.presence.neocord.setupOpts.terminal_text</code> + </a> + </span> +</dt> +<dd> +<p>Text displayed when working on the terminal</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"Working on the terminal"</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/plugins/rich-presence/neocord/neocord.nix" target="_top"> +<nvf/modules/plugins/rich-presence/neocord/neocord.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.presence.neocord.setupOpts.workspace_text"></a><a class="term" href="options.html#opt-vim.presence.neocord.setupOpts.workspace_text"><code class="option">vim.presence.neocord.setupOpts.workspace_text</code> + </a> + </span> +</dt> +<dd> +<p>Text displayed when working on a project</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"Working on %s"</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/plugins/rich-presence/neocord/neocord.nix" target="_top"> +<nvf/modules/plugins/rich-presence/neocord/neocord.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.preventJunkFiles"></a><a class="term" href="options.html#opt-vim.preventJunkFiles"><code class="option">vim.preventJunkFiles</code> + </a> + </span> +</dt> +<dd> +<p>Prevent swapfile and backupfile from being created.</p><p><code class="literal">false</code> is the default Neovim behaviour. If you wish to create +backup and swapfiles, set this option to <code class="literal">false</code>.</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>Example:</em></span> +<code class="literal">false</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"> +<nvf/modules/neovim/init/basic.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.projects.project-nvim.enable"></a><a class="term" href="options.html#opt-vim.projects.project-nvim.enable"><code class="option">vim.projects.project-nvim.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable project-nvim for project management.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/projects/project-nvim/project-nvim.nix" target="_top"> +<nvf/modules/plugins/projects/project-nvim/project-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.projects.project-nvim.setupOpts"></a><a class="term" href="options.html#opt-vim.projects.project-nvim.setupOpts"><code class="option">vim.projects.project-nvim.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of Project.nvim</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/projects/project-nvim/project-nvim.nix" target="_top"> +<nvf/modules/plugins/projects/project-nvim/project-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.projects.project-nvim.setupOpts.detection_methods"></a><a class="term" href="options.html#opt-vim.projects.project-nvim.setupOpts.detection_methods"><code class="option">vim.projects.project-nvim.setupOpts.detection_methods</code> + </a> + </span> +</dt> +<dd> +<p>Detection methods to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "lsp" + "pattern" +] +</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/plugins/projects/project-nvim/project-nvim.nix" target="_top"> +<nvf/modules/plugins/projects/project-nvim/project-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.projects.project-nvim.setupOpts.exclude_dirs"></a><a class="term" href="options.html#opt-vim.projects.project-nvim.setupOpts.exclude_dirs"><code class="option">vim.projects.project-nvim.setupOpts.exclude_dirs</code> + </a> + </span> +</dt> +<dd> +<p>Directories to exclude from project root search</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/projects/project-nvim/project-nvim.nix" target="_top"> +<nvf/modules/plugins/projects/project-nvim/project-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.projects.project-nvim.setupOpts.lsp_ignored"></a><a class="term" href="options.html#opt-vim.projects.project-nvim.setupOpts.lsp_ignored"><code class="option">vim.projects.project-nvim.setupOpts.lsp_ignored</code> + </a> + </span> +</dt> +<dd> +<p>LSP servers no ignore by name</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/projects/project-nvim/project-nvim.nix" target="_top"> +<nvf/modules/plugins/projects/project-nvim/project-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.projects.project-nvim.setupOpts.manual_mode"></a><a class="term" href="options.html#opt-vim.projects.project-nvim.setupOpts.manual_mode"><code class="option">vim.projects.project-nvim.setupOpts.manual_mode</code> + </a> + </span> +</dt> +<dd> +<p>don’t automatically change the root directory so the user has the option to manually do so using <code class="literal">:ProjectRoot</code> command</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/plugins/projects/project-nvim/project-nvim.nix" target="_top"> +<nvf/modules/plugins/projects/project-nvim/project-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.projects.project-nvim.setupOpts.patterns"></a><a class="term" href="options.html#opt-vim.projects.project-nvim.setupOpts.patterns"><code class="option">vim.projects.project-nvim.setupOpts.patterns</code> + </a> + </span> +</dt> +<dd> +<p>Patterns to use for pattern detection method</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + ".git" + "_darcs" + ".hg" + ".bzr" + ".svn" + "Makefile" + "package.json" + "flake.nix" + "cargo.toml" +] +</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/plugins/projects/project-nvim/project-nvim.nix" target="_top"> +<nvf/modules/plugins/projects/project-nvim/project-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.projects.project-nvim.setupOpts.scope_chdir"></a><a class="term" href="options.html#opt-vim.projects.project-nvim.setupOpts.scope_chdir"><code class="option">vim.projects.project-nvim.setupOpts.scope_chdir</code> + </a> + </span> +</dt> +<dd> +<p>What scope to change the directory</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “global”, “tab”, “win”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"global"</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/plugins/projects/project-nvim/project-nvim.nix" target="_top"> +<nvf/modules/plugins/projects/project-nvim/project-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.projects.project-nvim.setupOpts.show_hidden"></a><a class="term" href="options.html#opt-vim.projects.project-nvim.setupOpts.show_hidden"><code class="option">vim.projects.project-nvim.setupOpts.show_hidden</code> + </a> + </span> +</dt> +<dd> +<p>Show hidden files in telescope picker</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/projects/project-nvim/project-nvim.nix" target="_top"> +<nvf/modules/plugins/projects/project-nvim/project-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.projects.project-nvim.setupOpts.silent_chdir"></a><a class="term" href="options.html#opt-vim.projects.project-nvim.setupOpts.silent_chdir"><code class="option">vim.projects.project-nvim.setupOpts.silent_chdir</code> + </a> + </span> +</dt> +<dd> +<p>Silently change directory when changing project</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/plugins/projects/project-nvim/project-nvim.nix" target="_top"> +<nvf/modules/plugins/projects/project-nvim/project-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.python3Packages"></a><a class="term" href="options.html#opt-vim.python3Packages"><code class="option">vim.python3Packages</code> + </a> + </span> +</dt> +<dd> +<p>List of python packages to install</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"[\"pynvim\"]"</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/environment/options.nix" target="_top"> +<nvf/modules/wrapper/environment/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.runner.run-nvim.enable"></a><a class="term" href="options.html#opt-vim.runner.run-nvim.enable"><code class="option">vim.runner.run-nvim.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable run.nvim.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/runner/run-nvim/run-nvim.nix" target="_top"> +<nvf/modules/plugins/runner/run-nvim/run-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.runner.run-nvim.mappings.run"></a><a class="term" href="options.html#opt-vim.runner.run-nvim.mappings.run"><code class="option">vim.runner.run-nvim.mappings.run</code> + </a> + </span> +</dt> +<dd> +<p>Run cached</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>ri"</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/plugins/runner/run-nvim/run-nvim.nix" target="_top"> +<nvf/modules/plugins/runner/run-nvim/run-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.runner.run-nvim.mappings.runCommand"></a><a class="term" href="options.html#opt-vim.runner.run-nvim.mappings.runCommand"><code class="option">vim.runner.run-nvim.mappings.runCommand</code> + </a> + </span> +</dt> +<dd> +<p>Run prompt</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>rc"</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/plugins/runner/run-nvim/run-nvim.nix" target="_top"> +<nvf/modules/plugins/runner/run-nvim/run-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.runner.run-nvim.mappings.runOverride"></a><a class="term" href="options.html#opt-vim.runner.run-nvim.mappings.runOverride"><code class="option">vim.runner.run-nvim.mappings.runOverride</code> + </a> + </span> +</dt> +<dd> +<p>Run and override</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>ro"</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/plugins/runner/run-nvim/run-nvim.nix" target="_top"> +<nvf/modules/plugins/runner/run-nvim/run-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.runner.run-nvim.setupOpts"></a><a class="term" href="options.html#opt-vim.runner.run-nvim.setupOpts"><code class="option">vim.runner.run-nvim.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of run.nvim</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/runner/run-nvim/run-nvim.nix" target="_top"> +<nvf/modules/plugins/runner/run-nvim/run-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.scrollOffset"></a><a class="term" href="options.html#opt-vim.scrollOffset"><code class="option">vim.scrollOffset</code> + </a> + </span> +</dt> +<dd> +<p>Start scrolling this number of lines from the top or bottom of the page.</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<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/neovim/init/basic.nix" target="_top"> +<nvf/modules/neovim/init/basic.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.searchCase"></a><a class="term" href="options.html#opt-vim.searchCase"><code class="option">vim.searchCase</code> + </a> + </span> +</dt> +<dd> +<p>Set the case sensitivity of search</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “ignore”, “smart”, “sensitive”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"sensitive"</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"> +<nvf/modules/neovim/init/basic.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.session.nvim-session-manager.enable"></a><a class="term" href="options.html#opt-vim.session.nvim-session-manager.enable"><code class="option">vim.session.nvim-session-manager.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable nvim-session-manager: manage sessions like folders in VSCode.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/session/nvim-session-manager/nvim-session-manager.nix" target="_top"> +<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.session.nvim-session-manager.mappings.deleteSession"></a><a class="term" href="options.html#opt-vim.session.nvim-session-manager.mappings.deleteSession"><code class="option">vim.session.nvim-session-manager.mappings.deleteSession</code> + </a> + </span> +</dt> +<dd> +<p>Delete session</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>sd"</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/plugins/session/nvim-session-manager/nvim-session-manager.nix" target="_top"> +<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.session.nvim-session-manager.mappings.loadLastSession"></a><a class="term" href="options.html#opt-vim.session.nvim-session-manager.mappings.loadLastSession"><code class="option">vim.session.nvim-session-manager.mappings.loadLastSession</code> + </a> + </span> +</dt> +<dd> +<p>Load last session</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>slt"</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/plugins/session/nvim-session-manager/nvim-session-manager.nix" target="_top"> +<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.session.nvim-session-manager.mappings.loadSession"></a><a class="term" href="options.html#opt-vim.session.nvim-session-manager.mappings.loadSession"><code class="option">vim.session.nvim-session-manager.mappings.loadSession</code> + </a> + </span> +</dt> +<dd> +<p>Load session</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>sl"</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/plugins/session/nvim-session-manager/nvim-session-manager.nix" target="_top"> +<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.session.nvim-session-manager.mappings.saveCurrentSession"></a><a class="term" href="options.html#opt-vim.session.nvim-session-manager.mappings.saveCurrentSession"><code class="option">vim.session.nvim-session-manager.mappings.saveCurrentSession</code> + </a> + </span> +</dt> +<dd> +<p>Save current session</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>sc"</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/plugins/session/nvim-session-manager/nvim-session-manager.nix" target="_top"> +<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.session.nvim-session-manager.setupOpts.autoload_mode"></a><a class="term" href="options.html#opt-vim.session.nvim-session-manager.setupOpts.autoload_mode"><code class="option">vim.session.nvim-session-manager.setupOpts.autoload_mode</code> + </a> + </span> +</dt> +<dd> +<p>Define what to do when Neovim is started without arguments. Possible values: Disabled, CurrentDir, LastSession</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “Disabled”, “CurrentDir”, “LastSession”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"LastSession"</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/plugins/session/nvim-session-manager/nvim-session-manager.nix" target="_top"> +<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.session.nvim-session-manager.setupOpts.autosave_ignore_buftypes"></a><a class="term" href="options.html#opt-vim.session.nvim-session-manager.setupOpts.autosave_ignore_buftypes"><code class="option">vim.session.nvim-session-manager.setupOpts.autosave_ignore_buftypes</code> + </a> + </span> +</dt> +<dd> +<p>All buffers of these buffer types will be closed before the session is saved</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/session/nvim-session-manager/nvim-session-manager.nix" target="_top"> +<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.session.nvim-session-manager.setupOpts.autosave_ignore_dirs"></a><a class="term" href="options.html#opt-vim.session.nvim-session-manager.setupOpts.autosave_ignore_dirs"><code class="option">vim.session.nvim-session-manager.setupOpts.autosave_ignore_dirs</code> + </a> + </span> +</dt> +<dd> +<p>A list of directories where the session will not be autosaved</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/session/nvim-session-manager/nvim-session-manager.nix" target="_top"> +<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.session.nvim-session-manager.setupOpts.autosave_ignore_filetypes"></a><a class="term" href="options.html#opt-vim.session.nvim-session-manager.setupOpts.autosave_ignore_filetypes"><code class="option">vim.session.nvim-session-manager.setupOpts.autosave_ignore_filetypes</code> + </a> + </span> +</dt> +<dd> +<p>All buffers of these file types will be closed before the session is saved</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "gitcommit" +] +</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/plugins/session/nvim-session-manager/nvim-session-manager.nix" target="_top"> +<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.session.nvim-session-manager.setupOpts.autosave_ignore_not_normal"></a><a class="term" href="options.html#opt-vim.session.nvim-session-manager.setupOpts.autosave_ignore_not_normal"><code class="option">vim.session.nvim-session-manager.setupOpts.autosave_ignore_not_normal</code> + </a> + </span> +</dt> +<dd> +<p>Plugin will not save a session when no buffers are opened, or all of them aren’t writable or listed</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/plugins/session/nvim-session-manager/nvim-session-manager.nix" target="_top"> +<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.session.nvim-session-manager.setupOpts.autosave_last_session"></a><a class="term" href="options.html#opt-vim.session.nvim-session-manager.setupOpts.autosave_last_session"><code class="option">vim.session.nvim-session-manager.setupOpts.autosave_last_session</code> + </a> + </span> +</dt> +<dd> +<p>Automatically save last session on exit and on session switch</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/plugins/session/nvim-session-manager/nvim-session-manager.nix" target="_top"> +<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.session.nvim-session-manager.setupOpts.autosave_only_in_session"></a><a class="term" href="options.html#opt-vim.session.nvim-session-manager.setupOpts.autosave_only_in_session"><code class="option">vim.session.nvim-session-manager.setupOpts.autosave_only_in_session</code> + </a> + </span> +</dt> +<dd> +<p>Always autosaves session. If true, only autosaves after a session is active</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/session/nvim-session-manager/nvim-session-manager.nix" target="_top"> +<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.session.nvim-session-manager.setupOpts.colon_replacer"></a><a class="term" href="options.html#opt-vim.session.nvim-session-manager.setupOpts.colon_replacer"><code class="option">vim.session.nvim-session-manager.setupOpts.colon_replacer</code> + </a> + </span> +</dt> +<dd> +<p>The character to which the colon symbol will be replaced for session files</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"++"</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/plugins/session/nvim-session-manager/nvim-session-manager.nix" target="_top"> +<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.session.nvim-session-manager.setupOpts.max_path_length"></a><a class="term" href="options.html#opt-vim.session.nvim-session-manager.setupOpts.max_path_length"><code class="option">vim.session.nvim-session-manager.setupOpts.max_path_length</code> + </a> + </span> +</dt> +<dd> +<p>Shorten the display path if length exceeds this threshold. Use 0 if don’t want to shorten the path at all</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">80</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/plugins/session/nvim-session-manager/nvim-session-manager.nix" target="_top"> +<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.session.nvim-session-manager.setupOpts.path_replacer"></a><a class="term" href="options.html#opt-vim.session.nvim-session-manager.setupOpts.path_replacer"><code class="option">vim.session.nvim-session-manager.setupOpts.path_replacer</code> + </a> + </span> +</dt> +<dd> +<p>The character to which the path separator will be replaced for session files</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"__"</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/plugins/session/nvim-session-manager/nvim-session-manager.nix" target="_top"> +<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.session.nvim-session-manager.usePicker"></a><a class="term" href="options.html#opt-vim.session.nvim-session-manager.usePicker"><code class="option">vim.session.nvim-session-manager.usePicker</code> + </a> + </span> +</dt> +<dd> +<p>Whether or not we should use dressing.nvim to build a session picker UI</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/plugins/session/nvim-session-manager/nvim-session-manager.nix" target="_top"> +<nvf/modules/plugins/session/nvim-session-manager/nvim-session-manager.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <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> + </span> +</dt> +<dd> +<p>Whether to enable luasnip.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/snippets/luasnip/luasnip.nix" target="_top"> +<nvf/modules/plugins/snippets/luasnip/luasnip.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.snippets.luasnip.loaders"></a><a class="term" href="options.html#opt-vim.snippets.luasnip.loaders"><code class="option">vim.snippets.luasnip.loaders</code> + </a> + </span> +</dt> +<dd> +<p>Lua code used to load snippet providers.</p> + +<p><span class="emphasis"><em>Type:</em></span> +strings concatenated with “\n”</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting lua">require('luasnip.loaders.from_vscode').lazy_load() +</code></pre> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting lua">require("luasnip.loaders.from_snipmate").lazy_load() +</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/plugins/snippets/luasnip/luasnip.nix" target="_top"> +<nvf/modules/plugins/snippets/luasnip/luasnip.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.snippets.luasnip.providers"></a><a class="term" href="options.html#opt-vim.snippets.luasnip.providers"><code class="option">vim.snippets.luasnip.providers</code> + </a> + </span> +</dt> +<dd> +<p>The snippet provider packages.</p><div class="note"><h3 class="title">Note</h3><p>These are simply appended to {option} <code class="literal">vim.startPlugins</code>.</p></div> + +<p><span class="emphasis"><em>Type:</em></span> +list of (null or package or one of “aerial-nvim”, “alpha-nvim”, “base16”, “bufdelete-nvim”, “catppuccin”, “ccc”, “cellular-automaton”, “chatgpt”, “cheatsheet-nvim”, “cinnamon-nvim”, “cmp-buffer”, “cmp-luasnip”, “cmp-nvim-lsp”, “cmp-path”, “cmp-treesitter”, “codewindow-nvim”, “comment-nvim”, “copilot-cmp”, “copilot-lua”, “crates-nvim”, “csharpls-extended”, “dashboard-nvim”, “diffview-nvim”, “dracula”, “dressing-nvim”, “elixir-tools”, “fastaction-nvim”, “fidget-nvim”, “flutter-tools”, “friendly-snippets”, “fzf-lua”, “gesture-nvim”, “gitsigns-nvim”, “glow-nvim”, “gruvbox”, “haskell-tools-nvim”, “highlight-undo”, “hop-nvim”, “icon-picker-nvim”, “image-nvim”, “indent-blankline”, “leap-nvim”, “lsp-lines”, “lsp-signature”, “lspkind”, “lspsaga”, “lua-utils-nvim”, “lualine”, “luasnip”, “lz-n”, “lzn-auto-require”, “mind-nvim”, “mini-ai”, “mini-align”, “mini-animate”, “mini-base16”, “mini-basics”, “mini-bracketed”, “mini-bufremove”, “mini-clue”, “mini-colors”, “mini-comment”, “mini-completion”, “mini-diff”, “mini-doc”, “mini-extra”, “mini-files”, “mini-fuzzy”, “mini-git”, “mini-hipatterns”, “mini-hues”, “mini-icons”, “mini-indentscope”, “mini-jump”, “mini-jump2d”, “mini-map”, “mini-misc”, “mini-move”, “mini-notify”, “mini-operators”, “mini-pairs”, “mini-pick”, “mini-sessions”, “mini-snippets”, “mini-splitjoin”, “mini-starter”, “mini-statusline”, “mini-surround”, “mini-tabline”, “mini-test”, “mini-trailspace”, “mini-visits”, “minimap-vim”, “modes-nvim”, “neo-tree-nvim”, “neocord”, “neodev-nvim”, “neorg”, “neorg-telescope”, “new-file-template-nvim”, “noice-nvim”, “none-ls”, “nord”, “nui-nvim”, “nvim-autopairs”, “nvim-bufferline-lua”, “nvim-cmp”, “nvim-colorizer-lua”, “nvim-cursorline”, “nvim-dap”, “nvim-dap-go”, “nvim-dap-ui”, “nvim-docs-view”, “nvim-lightbulb”, “nvim-lspconfig”, “nvim-metals”, “nvim-navbuddy”, “nvim-navic”, “nvim-neoclip”, “nvim-nio”, “nvim-notify”, “nvim-scrollbar”, “nvim-session-manager”, “nvim-surround”, “nvim-tree-lua”, “nvim-treesitter-context”, “nvim-ts-autotag”, “nvim-ufo”, “nvim-web-devicons”, “obsidian-nvim”, “omnisharp-extended”, “onedark”, “orgmode-nvim”, “otter-nvim”, “oxocarbon”, “pathlib-nvim”, “plenary-nvim”, “precognition-nvim”, “project-nvim”, “promise-async”, “registers”, “render-markdown-nvim”, “rose-pine”, “rtp-nvim”, “run-nvim”, “rustaceanvim”, “smartcolumn”, “sqls-nvim”, “tabular”, “telescope”, “tiny-devicons-auto-colors”, “todo-comments”, “toggleterm-nvim”, “tokyonight”, “trouble”, “ts-error-translator”, “typst-preview-nvim”, “vim-dirtytalk”, “vim-fugitive”, “vim-illuminate”, “vim-markdown”, “vim-repeat”, “vim-startify”, “which-key”, “nvim-treesitter”, “flutter-tools-patched”, “vim-repeat”)</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "friendly-snippets" +] +</code></pre> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">["vimPlugins.vim-snippets"]</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/plugins/snippets/luasnip/luasnip.nix" target="_top"> +<nvf/modules/plugins/snippets/luasnip/luasnip.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.snippets.luasnip.setupOpts"></a><a class="term" href="options.html#opt-vim.snippets.luasnip.setupOpts"><code class="option">vim.snippets.luasnip.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of LuaSnip</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/snippets/luasnip/luasnip.nix" target="_top"> +<nvf/modules/plugins/snippets/luasnip/luasnip.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.snippets.luasnip.setupOpts.enable_autosnippets"></a><a class="term" href="options.html#opt-vim.snippets.luasnip.setupOpts.enable_autosnippets"><code class="option">vim.snippets.luasnip.setupOpts.enable_autosnippets</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable autosnippets.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/snippets/luasnip/luasnip.nix" target="_top"> +<nvf/modules/plugins/snippets/luasnip/luasnip.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.spellcheck.enable"></a><a class="term" href="options.html#opt-vim.spellcheck.enable"><code class="option">vim.spellcheck.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Neovim’s built-in spellchecking.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/spellcheck.nix" target="_top"> +<nvf/modules/neovim/init/spellcheck.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.spellcheck.extraSpellWords"></a><a class="term" href="options.html#opt-vim.spellcheck.extraSpellWords"><code class="option">vim.spellcheck.extraSpellWords</code> + </a> + </span> +</dt> +<dd> +<p>Additional words to be used for spellchecking. The names of each key will be +used as the language code for the spell file. For example</p><pre><code class="programlisting nix">"en.utf-8" = [ ... ]; +</code></pre><p>will result in <code class="literal">en.utf-8.add.spl</code> being added to Neovim’s runtime in the +<code class="filename">spell</code> directory.</p><div class="warning"><h3 class="title">Warning</h3><p>The attribute keys must be in <code class="literal">"<name>.<encoding>"</code> format for Neovim to +compile your spellfiles without mangling the resulting file names. Please +make sure that you enter the correct value, as nvf does not do any kind of +internal checking. Please see <span class="command"><strong>:help mkspell</strong></span> for more details.</p><p>Example:</p><pre><code class="programlisting nix"># "en" is the name, and "utf-8" is the encoding. For most use cases, utf-8 +# will be enough, however, you may change it to any encoding format Neovim +# accepts, e.g., utf-16. +"en.utf-8" = ["nvf" "word_you_want_to_add"]; +=> $out/spell/en-utf-8.add.spl +</code></pre></div><p>Note that while adding a new language, you will still need to add the name of +the language (e.g. “en”) to the <code class="option">vim.spellcheck.languages</code> list by name +in order to enable spellchecking for the language. By default only <code class="literal">"en"</code> is in +the list.</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">{"en.utf-8" = ["nvf" "word_you_want_to_add"];}</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/spellcheck.nix" target="_top"> +<nvf/modules/neovim/init/spellcheck.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.spellcheck.ignoredFiletypes"></a><a class="term" href="options.html#opt-vim.spellcheck.ignoredFiletypes"><code class="option">vim.spellcheck.ignoredFiletypes</code> + </a> + </span> +</dt> +<dd> +<p>A list of filetypes for which spellchecking will be disabled.</p><div class="tip"><h3 class="title">Tip</h3><p>You may use <span class="command"><strong>:echo &filetype</strong></span> in Neovim to find out the +filetype for a specific buffer.</p></div> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "toggleterm" +] +</code></pre> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">["markdown" "gitcommit"]</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/spellcheck.nix" target="_top"> +<nvf/modules/neovim/init/spellcheck.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.spellcheck.languages"></a><a class="term" href="options.html#opt-vim.spellcheck.languages"><code class="option">vim.spellcheck.languages</code> + </a> + </span> +</dt> +<dd> +<p>A list of languages that should be used for spellchecking.</p><p>To add your own language files, you may place your <code class="literal">spell</code> directory in either +<code class="filename">$XDG_CONFIG_HOME/nvf</code> or in a path that is included in the +<a class="link" href="options.html#opt-vim.additionalRuntimePaths" >additionalRuntimePaths</a> list provided by nvf.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "en" +] +</code></pre> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">["en" "de"]</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/spellcheck.nix" target="_top"> +<nvf/modules/neovim/init/spellcheck.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.spellcheck.programmingWordlist.enable"></a><a class="term" href="options.html#opt-vim.spellcheck.programmingWordlist.enable"><code class="option">vim.spellcheck.programmingWordlist.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable vim-dirtytalk, a wordlist for programmers containing +common programming terms.</p><div class="note"><h3 class="title">Note</h3><p>Enabling this option will unconditionally set +<code class="option">vim.spellcheck.enable</code> to true as vim-dirtytalk +depends on spellchecking having been set up.</p></div><p>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/spellcheck.nix" target="_top"> +<nvf/modules/neovim/init/spellcheck.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.startPlugins"></a><a class="term" href="options.html#opt-vim.startPlugins"><code class="option">vim.startPlugins</code> + </a> + </span> +</dt> +<dd> +<p>List of plugins to load on startup. This is used +internally to add plugins to Neovim’s runtime.</p><p>To add additional plugins to your configuration, consider +using the <a class="link" href="options.html#opt-vim.extraPlugins" ><code class="option">vim.extraPlugins</code></a> +option.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of (null or package or one of “aerial-nvim”, “alpha-nvim”, “base16”, “bufdelete-nvim”, “catppuccin”, “ccc”, “cellular-automaton”, “chatgpt”, “cheatsheet-nvim”, “cinnamon-nvim”, “cmp-buffer”, “cmp-luasnip”, “cmp-nvim-lsp”, “cmp-path”, “cmp-treesitter”, “codewindow-nvim”, “comment-nvim”, “copilot-cmp”, “copilot-lua”, “crates-nvim”, “csharpls-extended”, “dashboard-nvim”, “diffview-nvim”, “dracula”, “dressing-nvim”, “elixir-tools”, “fastaction-nvim”, “fidget-nvim”, “flutter-tools”, “friendly-snippets”, “fzf-lua”, “gesture-nvim”, “gitsigns-nvim”, “glow-nvim”, “gruvbox”, “haskell-tools-nvim”, “highlight-undo”, “hop-nvim”, “icon-picker-nvim”, “image-nvim”, “indent-blankline”, “leap-nvim”, “lsp-lines”, “lsp-signature”, “lspkind”, “lspsaga”, “lua-utils-nvim”, “lualine”, “luasnip”, “lz-n”, “lzn-auto-require”, “mind-nvim”, “mini-ai”, “mini-align”, “mini-animate”, “mini-base16”, “mini-basics”, “mini-bracketed”, “mini-bufremove”, “mini-clue”, “mini-colors”, “mini-comment”, “mini-completion”, “mini-diff”, “mini-doc”, “mini-extra”, “mini-files”, “mini-fuzzy”, “mini-git”, “mini-hipatterns”, “mini-hues”, “mini-icons”, “mini-indentscope”, “mini-jump”, “mini-jump2d”, “mini-map”, “mini-misc”, “mini-move”, “mini-notify”, “mini-operators”, “mini-pairs”, “mini-pick”, “mini-sessions”, “mini-snippets”, “mini-splitjoin”, “mini-starter”, “mini-statusline”, “mini-surround”, “mini-tabline”, “mini-test”, “mini-trailspace”, “mini-visits”, “minimap-vim”, “modes-nvim”, “neo-tree-nvim”, “neocord”, “neodev-nvim”, “neorg”, “neorg-telescope”, “new-file-template-nvim”, “noice-nvim”, “none-ls”, “nord”, “nui-nvim”, “nvim-autopairs”, “nvim-bufferline-lua”, “nvim-cmp”, “nvim-colorizer-lua”, “nvim-cursorline”, “nvim-dap”, “nvim-dap-go”, “nvim-dap-ui”, “nvim-docs-view”, “nvim-lightbulb”, “nvim-lspconfig”, “nvim-metals”, “nvim-navbuddy”, “nvim-navic”, “nvim-neoclip”, “nvim-nio”, “nvim-notify”, “nvim-scrollbar”, “nvim-session-manager”, “nvim-surround”, “nvim-tree-lua”, “nvim-treesitter-context”, “nvim-ts-autotag”, “nvim-ufo”, “nvim-web-devicons”, “obsidian-nvim”, “omnisharp-extended”, “onedark”, “orgmode-nvim”, “otter-nvim”, “oxocarbon”, “pathlib-nvim”, “plenary-nvim”, “precognition-nvim”, “project-nvim”, “promise-async”, “registers”, “render-markdown-nvim”, “rose-pine”, “rtp-nvim”, “run-nvim”, “rustaceanvim”, “smartcolumn”, “sqls-nvim”, “tabular”, “telescope”, “tiny-devicons-auto-colors”, “todo-comments”, “toggleterm-nvim”, “tokyonight”, “trouble”, “ts-error-translator”, “typst-preview-nvim”, “vim-dirtytalk”, “vim-fugitive”, “vim-illuminate”, “vim-markdown”, “vim-repeat”, “vim-startify”, “which-key”, “nvim-treesitter”, “flutter-tools-patched”, “vim-repeat”)</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "plenary-nvim" +] +</code></pre> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">'' + [pkgs.vimPlugins.telescope-nvim] +'' +</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/environment/options.nix" target="_top"> +<nvf/modules/wrapper/environment/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.enable"></a><a class="term" href="options.html#opt-vim.statusline.lualine.enable"><code class="option">vim.statusline.lualine.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable lualine statusline plugin.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.activeSection.a"></a><a class="term" href="options.html#opt-vim.statusline.lualine.activeSection.a"><code class="option">vim.statusline.lualine.activeSection.a</code> + </a> + </span> +</dt> +<dd> +<p>active config for: | (A) | B | C X | Y | Z |</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + '' + { + "mode", + icons_enabled = true, + separator = { + left = '▎', + right = '' + }, + } + '' + '' + { + "", + draw_empty = true, + separator = { left = '', right = '' } + } + '' +] +</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.activeSection.b"></a><a class="term" href="options.html#opt-vim.statusline.lualine.activeSection.b"><code class="option">vim.statusline.lualine.activeSection.b</code> + </a> + </span> +</dt> +<dd> +<p>active config for: | A | (B) | C X | Y | Z |</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + '' + { + "filetype", + colored = true, + icon_only = true, + icon = { align = 'left' } + } + '' + '' + { + "filename", + symbols = {modified = ' ', readonly = ' '}, + separator = {right = ''} + } + '' + '' + { + "", + draw_empty = true, + separator = { left = '', right = '' } + } + '' +] +</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.activeSection.c"></a><a class="term" href="options.html#opt-vim.statusline.lualine.activeSection.c"><code class="option">vim.statusline.lualine.activeSection.c</code> + </a> + </span> +</dt> +<dd> +<p>active config for: | A | B | © X | Y | Z |</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + '' + { + "diff", + colored = false, + diff_color = { + -- Same color values as the general color option can be used here. + added = 'DiffAdd', -- Changes the diff's added color + modified = 'DiffChange', -- Changes the diff's modified color + removed = 'DiffDelete', -- Changes the diff's removed color you + }, + symbols = {added = '+', modified = '~', removed = '-'}, -- Changes the diff symbols + separator = {right = ''} + } + '' +] +</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.activeSection.x"></a><a class="term" href="options.html#opt-vim.statusline.lualine.activeSection.x"><code class="option">vim.statusline.lualine.activeSection.x</code> + </a> + </span> +</dt> +<dd> +<p>active config for: | A | B | C (X) | Y | Z |</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + '' + { + -- Lsp server name + function() + local buf_ft = vim.api.nvim_get_option_value('filetype', {}) + + -- List of buffer types to exclude + local excluded_buf_ft = {"toggleterm", "NvimTree", "neo-tree", "TelescopePrompt"} + + -- Check if the current buffer type is in the excluded list + for _, excluded_type in ipairs(excluded_buf_ft) do + if buf_ft == excluded_type then + return "" + end + end + + -- Get the name of the LSP server active in the current buffer + local clients = vim.lsp.get_active_clients() + local msg = 'No Active Lsp' + + -- if no lsp client is attached then return the msg + if next(clients) == nil then + return msg + end + + for _, client in ipairs(clients) do + local filetypes = client.config.filetypes + if filetypes and vim.fn.index(filetypes, buf_ft) ~= -1 then + return client.name + end + end + + return msg + end, + icon = ' ', + separator = {left = ''}, + } + '' + '' + { + "diagnostics", + sources = {'nvim_lsp', 'nvim_diagnostic', 'nvim_diagnostic', 'vim_lsp', 'coc'}, + symbols = {error = ' ', warn = ' ', info = ' ', hint = ' '}, + colored = true, + update_in_insert = false, + always_visible = false, + diagnostics_color = { + color_error = { fg = 'red' }, + color_warn = { fg = 'yellow' }, + color_info = { fg = 'cyan' }, + }, + } + '' +] +</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.activeSection.y"></a><a class="term" href="options.html#opt-vim.statusline.lualine.activeSection.y"><code class="option">vim.statusline.lualine.activeSection.y</code> + </a> + </span> +</dt> +<dd> +<p>active config for: | A | B | C X | (Y) | Z |</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + '' + { + "", + draw_empty = true, + separator = { left = '', right = '' } + } + '' + '' + { + 'searchcount', + maxcount = 999, + timeout = 120, + separator = {left = ''} + } + '' + '' + { + "branch", + icon = ' •', + separator = {left = ''} + } + '' +] +</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.activeSection.z"></a><a class="term" href="options.html#opt-vim.statusline.lualine.activeSection.z"><code class="option">vim.statusline.lualine.activeSection.z</code> + </a> + </span> +</dt> +<dd> +<p>active config for: | A | B | C X | Y | (Z) |</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + '' + { + "", + draw_empty = true, + separator = { left = '', right = '' } + } + '' + '' + { + "progress", + separator = {left = ''} + } + '' + '' + {"location"} + '' + '' + { + "fileformat", + color = {fg='black'}, + symbols = { + unix = '', -- e712 + dos = '', -- e70f + mac = '', -- e711 + } + } + '' +] +</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.alwaysDivideMiddle"></a><a class="term" href="options.html#opt-vim.statusline.lualine.alwaysDivideMiddle"><code class="option">vim.statusline.lualine.alwaysDivideMiddle</code> + </a> + </span> +</dt> +<dd> +<p>Always divide middle section</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.componentSeparator.left"></a><a class="term" href="options.html#opt-vim.statusline.lualine.componentSeparator.left"><code class="option">vim.statusline.lualine.componentSeparator.left</code> + </a> + </span> +</dt> +<dd> +<p>Component separator for left side</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">""</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.componentSeparator.right"></a><a class="term" href="options.html#opt-vim.statusline.lualine.componentSeparator.right"><code class="option">vim.statusline.lualine.componentSeparator.right</code> + </a> + </span> +</dt> +<dd> +<p>Component separator for right side</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">""</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.disabledFiletypes"></a><a class="term" href="options.html#opt-vim.statusline.lualine.disabledFiletypes"><code class="option">vim.statusline.lualine.disabledFiletypes</code> + </a> + </span> +</dt> +<dd> +<p>Filetypes to disable lualine on</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "alpha" +] +</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.extraActiveSection.a"></a><a class="term" href="options.html#opt-vim.statusline.lualine.extraActiveSection.a"><code class="option">vim.statusline.lualine.extraActiveSection.a</code> + </a> + </span> +</dt> +<dd> +<p>Extra entries for activeSection.a</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.extraActiveSection.b"></a><a class="term" href="options.html#opt-vim.statusline.lualine.extraActiveSection.b"><code class="option">vim.statusline.lualine.extraActiveSection.b</code> + </a> + </span> +</dt> +<dd> +<p>Extra entries for activeSection.b</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.extraActiveSection.c"></a><a class="term" href="options.html#opt-vim.statusline.lualine.extraActiveSection.c"><code class="option">vim.statusline.lualine.extraActiveSection.c</code> + </a> + </span> +</dt> +<dd> +<p>Extra entries for activeSection.c</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.extraActiveSection.x"></a><a class="term" href="options.html#opt-vim.statusline.lualine.extraActiveSection.x"><code class="option">vim.statusline.lualine.extraActiveSection.x</code> + </a> + </span> +</dt> +<dd> +<p>Extra entries for activeSection.x</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.extraActiveSection.y"></a><a class="term" href="options.html#opt-vim.statusline.lualine.extraActiveSection.y"><code class="option">vim.statusline.lualine.extraActiveSection.y</code> + </a> + </span> +</dt> +<dd> +<p>Extra entries for activeSection.y</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.extraActiveSection.z"></a><a class="term" href="options.html#opt-vim.statusline.lualine.extraActiveSection.z"><code class="option">vim.statusline.lualine.extraActiveSection.z</code> + </a> + </span> +</dt> +<dd> +<p>Extra entries for activeSection.z</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.extraInactiveSection.a"></a><a class="term" href="options.html#opt-vim.statusline.lualine.extraInactiveSection.a"><code class="option">vim.statusline.lualine.extraInactiveSection.a</code> + </a> + </span> +</dt> +<dd> +<p>Extra entries for inactiveSection.a</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.extraInactiveSection.b"></a><a class="term" href="options.html#opt-vim.statusline.lualine.extraInactiveSection.b"><code class="option">vim.statusline.lualine.extraInactiveSection.b</code> + </a> + </span> +</dt> +<dd> +<p>Extra entries for inactiveSection.b</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.extraInactiveSection.c"></a><a class="term" href="options.html#opt-vim.statusline.lualine.extraInactiveSection.c"><code class="option">vim.statusline.lualine.extraInactiveSection.c</code> + </a> + </span> +</dt> +<dd> +<p>Extra entries for inactiveSection.c</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.extraInactiveSection.x"></a><a class="term" href="options.html#opt-vim.statusline.lualine.extraInactiveSection.x"><code class="option">vim.statusline.lualine.extraInactiveSection.x</code> + </a> + </span> +</dt> +<dd> +<p>Extra entries for inactiveSection.x</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.extraInactiveSection.y"></a><a class="term" href="options.html#opt-vim.statusline.lualine.extraInactiveSection.y"><code class="option">vim.statusline.lualine.extraInactiveSection.y</code> + </a> + </span> +</dt> +<dd> +<p>Extra entries for inactiveSection.y</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.extraInactiveSection.z"></a><a class="term" href="options.html#opt-vim.statusline.lualine.extraInactiveSection.z"><code class="option">vim.statusline.lualine.extraInactiveSection.z</code> + </a> + </span> +</dt> +<dd> +<p>Extra entries for inactiveSection.z</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.globalStatus"></a><a class="term" href="options.html#opt-vim.statusline.lualine.globalStatus"><code class="option">vim.statusline.lualine.globalStatus</code> + </a> + </span> +</dt> +<dd> +<p>Enable global status for lualine</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.icons.enable"></a><a class="term" href="options.html#opt-vim.statusline.lualine.icons.enable"><code class="option">vim.statusline.lualine.icons.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable icons for lualine.</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>Example:</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.ignoreFocus"></a><a class="term" href="options.html#opt-vim.statusline.lualine.ignoreFocus"><code class="option">vim.statusline.lualine.ignoreFocus</code> + </a> + </span> +</dt> +<dd> +<p>If current filetype is in this list it’ll always be drawn as inactive statusline +and the last window will be drawn as active statusline.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "NvimTree" +] +</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.inactiveSection.a"></a><a class="term" href="options.html#opt-vim.statusline.lualine.inactiveSection.a"><code class="option">vim.statusline.lualine.inactiveSection.a</code> + </a> + </span> +</dt> +<dd> +<p>inactive config for: | (A) | B | C X | Y | Z |</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.inactiveSection.b"></a><a class="term" href="options.html#opt-vim.statusline.lualine.inactiveSection.b"><code class="option">vim.statusline.lualine.inactiveSection.b</code> + </a> + </span> +</dt> +<dd> +<p>inactive config for: | A | (B) | C X | Y | Z |</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.inactiveSection.c"></a><a class="term" href="options.html#opt-vim.statusline.lualine.inactiveSection.c"><code class="option">vim.statusline.lualine.inactiveSection.c</code> + </a> + </span> +</dt> +<dd> +<p>inactive config for: | A | B | © X | Y | Z |</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "'filename'" +] +</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.inactiveSection.x"></a><a class="term" href="options.html#opt-vim.statusline.lualine.inactiveSection.x"><code class="option">vim.statusline.lualine.inactiveSection.x</code> + </a> + </span> +</dt> +<dd> +<p>inactive config for: | A | B | C (X) | Y | Z |</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "'location'" +] +</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.inactiveSection.y"></a><a class="term" href="options.html#opt-vim.statusline.lualine.inactiveSection.y"><code class="option">vim.statusline.lualine.inactiveSection.y</code> + </a> + </span> +</dt> +<dd> +<p>inactive config for: | A | B | C X | (Y) | Z |</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.inactiveSection.z"></a><a class="term" href="options.html#opt-vim.statusline.lualine.inactiveSection.z"><code class="option">vim.statusline.lualine.inactiveSection.z</code> + </a> + </span> +</dt> +<dd> +<p>inactive config for: | A | B | C X | Y | (Z) |</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.refresh.statusline"></a><a class="term" href="options.html#opt-vim.statusline.lualine.refresh.statusline"><code class="option">vim.statusline.lualine.refresh.statusline</code> + </a> + </span> +</dt> +<dd> +<p>Refresh rate for lualine</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">1000</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.refresh.tabline"></a><a class="term" href="options.html#opt-vim.statusline.lualine.refresh.tabline"><code class="option">vim.statusline.lualine.refresh.tabline</code> + </a> + </span> +</dt> +<dd> +<p>Refresh rate for tabline</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">1000</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.refresh.winbar"></a><a class="term" href="options.html#opt-vim.statusline.lualine.refresh.winbar"><code class="option">vim.statusline.lualine.refresh.winbar</code> + </a> + </span> +</dt> +<dd> +<p>Refresh rate for winbar</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">1000</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.sectionSeparator.left"></a><a class="term" href="options.html#opt-vim.statusline.lualine.sectionSeparator.left"><code class="option">vim.statusline.lualine.sectionSeparator.left</code> + </a> + </span> +</dt> +<dd> +<p>Section separator for left side</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">""</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.sectionSeparator.right"></a><a class="term" href="options.html#opt-vim.statusline.lualine.sectionSeparator.right"><code class="option">vim.statusline.lualine.sectionSeparator.right</code> + </a> + </span> +</dt> +<dd> +<p>Section separator for right side</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">""</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.setupOpts"></a><a class="term" href="options.html#opt-vim.statusline.lualine.setupOpts"><code class="option">vim.statusline.lualine.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of Lualine</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.statusline.lualine.theme"></a><a class="term" href="options.html#opt-vim.statusline.lualine.theme"><code class="option">vim.statusline.lualine.theme</code> + </a> + </span> +</dt> +<dd> +<p>Theme for lualine</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “auto”, “16color”, “ayu_dark”, “ayu_light”, “ayu_mirage”, “ayu”, “base16”, “codedark”, “dracula”, “everforest”, “gruvbox”, “gruvbox_dark”, “gruvbox_light”, “gruvbox-material”, “horizon”, “iceberg_dark”, “iceberg_light”, “iceberg”, “jellybeans”, “material”, “modus-vivendi”, “molokai”, “moonfly”, “nightfly”, “nord”, “OceanicNext”, “onedark”, “onelight”, “palenight”, “papercolor_dark”, “papercolor_light”, “PaperColor”, “powerline_dark”, “powerline”, “pywal”, “seoul256”, “solarized_dark”, “solarized_light”, “Tomorrow”, “wombat”, “onedark”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"`config.vim.theme.name` if theme supports lualine else \"auto\""</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/plugins/statusline/lualine/lualine.nix" target="_top"> +<nvf/modules/plugins/statusline/lualine/lualine.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.syntaxHighlighting"></a><a class="term" href="options.html#opt-vim.syntaxHighlighting"><code class="option">vim.syntaxHighlighting</code> + </a> + </span> +</dt> +<dd> +<p>Enable syntax highlighting</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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"> +<nvf/modules/neovim/init/basic.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.enable"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.enable"><code class="option">vim.tabline.nvimBufferline.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable neovim bufferline.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.mappings.closeCurrent"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.mappings.closeCurrent"><code class="option">vim.tabline.nvimBufferline.mappings.closeCurrent</code> + </a> + </span> +</dt> +<dd> +<p>Close buffer</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.mappings.cycleNext"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.mappings.cycleNext"><code class="option">vim.tabline.nvimBufferline.mappings.cycleNext</code> + </a> + </span> +</dt> +<dd> +<p>Next buffer</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>bn"</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.mappings.cyclePrevious"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.mappings.cyclePrevious"><code class="option">vim.tabline.nvimBufferline.mappings.cyclePrevious</code> + </a> + </span> +</dt> +<dd> +<p>Previous buffer</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>bp"</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.mappings.moveNext"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.mappings.moveNext"><code class="option">vim.tabline.nvimBufferline.mappings.moveNext</code> + </a> + </span> +</dt> +<dd> +<p>Move next buffer</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>bmn"</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.mappings.movePrevious"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.mappings.movePrevious"><code class="option">vim.tabline.nvimBufferline.mappings.movePrevious</code> + </a> + </span> +</dt> +<dd> +<p>Move previous buffer</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>bmp"</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.mappings.pick"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.mappings.pick"><code class="option">vim.tabline.nvimBufferline.mappings.pick</code> + </a> + </span> +</dt> +<dd> +<p>Pick buffer</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>bc"</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.mappings.sortByDirectory"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.mappings.sortByDirectory"><code class="option">vim.tabline.nvimBufferline.mappings.sortByDirectory</code> + </a> + </span> +</dt> +<dd> +<p>Sort buffers by directory</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>bsd"</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.mappings.sortByExtension"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.mappings.sortByExtension"><code class="option">vim.tabline.nvimBufferline.mappings.sortByExtension</code> + </a> + </span> +</dt> +<dd> +<p>Sort buffers by extension</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>bse"</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.mappings.sortById"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.mappings.sortById"><code class="option">vim.tabline.nvimBufferline.mappings.sortById</code> + </a> + </span> +</dt> +<dd> +<p>Sort buffers by ID</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>bsi"</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts"><code class="option">vim.tabline.nvimBufferline.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of Bufferline-nvim</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.highlights"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.highlights"><code class="option">vim.tabline.nvimBufferline.setupOpts.highlights</code> + </a> + </span> +</dt> +<dd> +<p>Overrides the highlight groups of bufferline.</p><p>See <code class="literal">:help bufferline-highlights</code>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +(attribute set) or (luaInline)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.always_show_bufferline"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.always_show_bufferline"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.always_show_bufferline</code> + </a> + </span> +</dt> +<dd> +<p>Whether to always show bufferline</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.auto_toggle_bufferline"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.auto_toggle_bufferline"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.auto_toggle_bufferline</code> + </a> + </span> +</dt> +<dd> +<p>Whether to auto toggle bufferline</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.buffer_close_icon"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.buffer_close_icon"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.buffer_close_icon</code> + </a> + </span> +</dt> +<dd> +<p>Icon for close button</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.close_command"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.close_command"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.close_command</code> + </a> + </span> +</dt> +<dd> +<p>Command to run when closing a buffer</p> + +<p><span class="emphasis"><em>Type:</em></span> +string or (luaInline)</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + _type = "lua-inline"; + expr = '' + function(bufnum) + require("bufdelete").bufdelete(bufnum, false) + end + ''; +} +</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.close_icon"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.close_icon"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.close_icon</code> + </a> + </span> +</dt> +<dd> +<p>Icon for close button</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.color_icons"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.color_icons"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.color_icons</code> + </a> + </span> +</dt> +<dd> +<p>Whether or not to add filetype icon highlights</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.custom_filter"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.custom_filter"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.custom_filter</code> + </a> + </span> +</dt> +<dd> +<p>Custom filter function for filtering out buffers.</p><div class="note"><h3 class="title">Note</h3><p>This will be called a lot, so you are encouraged to keep it as +short and lightweight as possible unless you are fully aware +of the performance implications.</p></div> + +<p><span class="emphasis"><em>Type:</em></span> +null or (luaInline)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</code></p> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">custom_filter = function(buf_number, buf_numbers) + -- filter out filetypes you don't want to see + if vim.bo[buf_number].filetype ~= "<i-dont-want-to-see-this>" then + return true + end + -- filter out by buffer name + if vim.fn.bufname(buf_number) ~= "<buffer-name-I-dont-want>" then + return true + end + -- filter out based on arbitrary rules + -- e.g. filter out vim wiki buffer from tabline in your work repo + if vim.fn.getcwd() == "<work-repo>" and vim.bo[buf_number].filetype ~= "wiki" then + return true + end + -- filter out by it's index number in list (don't show first buffer) + if buf_numbers[1] ~= buf_number then + return true + end +end + +</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.diagnostics"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.diagnostics"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.diagnostics</code> + </a> + </span> +</dt> +<dd> +<p>Diagnostics provider to be used in buffer LSP indicators</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of false, “nvim_lsp”, “coc”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"nvim_lsp"</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.diagnostics_indicator"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.diagnostics_indicator"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.diagnostics_indicator</code> + </a> + </span> +</dt> +<dd> +<p>Function to get the diagnostics indicator. +The function should return a string to be used as the indicator.</p><p>Can be set to nil to keep the buffer name highlight, but delete the +highlighting.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or (luaInline)</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + _type = "lua-inline"; + expr = '' + function(count, level, diagnostics_dict, context) + local s = " " + for e, n in pairs(diagnostics_dict) do + local sym = e == "error" and " " + or (e == "warning" and " " or " " ) + s = s .. n .. sym + end + return s + end + ''; +} +</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.diagnostics_update_in_insert"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.diagnostics_update_in_insert"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.diagnostics_update_in_insert</code> + </a> + </span> +</dt> +<dd> +<p>Whether to update diagnostics while in insert mode.</p><p>Setting this to true has performance implications, but they may be +negligible depending on your setup. Set it to true if you know what +you are doing.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.duplicates_across_groups"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.duplicates_across_groups"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.duplicates_across_groups</code> + </a> + </span> +</dt> +<dd> +<p>Whether to consider duplicate paths in different groups as duplicates</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.enforce_regular_tabs"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.enforce_regular_tabs"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.enforce_regular_tabs</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enforce regular tabs</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.get_element_icon"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.get_element_icon"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.get_element_icon</code> + </a> + </span> +</dt> +<dd> +<p>The function bufferline uses to get the icon. Recommended to leave as default.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or (luaInline)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</code></p> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">function(element) + local custom_map = {my_thing_ft: {icon = "my_thing_icon", hl = "DevIconDefault"}} + return custom_map[element.filetype] +end + +</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.hover.enabled"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.hover.enabled"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.hover.enabled</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable hover.</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>Example:</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.hover.delay"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.hover.delay"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.hover.delay</code> + </a> + </span> +</dt> +<dd> +<p>Delay for hover, in ms</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">200</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.hover.reveal"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.hover.reveal"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.hover.reveal</code> + </a> + </span> +</dt> +<dd> +<p>Reveal hover window</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "close" +] +</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.indicator.icon"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.indicator.icon"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.indicator.icon</code> + </a> + </span> +</dt> +<dd> +<p>The indicatotor icon to use for the current buffer.</p><div class="warning"><h3 class="title">Warning</h3><p>This <span class="strong"><strong>must</strong></span> be omitted while style is not <code class="literal">icon</code></p></div> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.indicator.style"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.indicator.style"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.indicator.style</code> + </a> + </span> +</dt> +<dd> +<p>Style for indicator</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “icon”, “underline”, “none”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"underline"</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.left_mouse_command"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.left_mouse_command"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.left_mouse_command</code> + </a> + </span> +</dt> +<dd> +<p>Command to run when left clicking a buffer</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string or (luaInline)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"buffer %d"</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.left_trunc_marker"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.left_trunc_marker"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.left_trunc_marker</code> + </a> + </span> +</dt> +<dd> +<p>Icon for left truncation</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">""</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.max_name_length"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.max_name_length"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.max_name_length</code> + </a> + </span> +</dt> +<dd> +<p>Max name length</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">18</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.max_prefix_length"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.max_prefix_length"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.max_prefix_length</code> + </a> + </span> +</dt> +<dd> +<p>Length of the prefix used when a buffer is de-duplicated</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">15</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.middle_mouse_command"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.middle_mouse_command"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.middle_mouse_command</code> + </a> + </span> +</dt> +<dd> +<p>Command to run when middle clicking a buffer</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string or (luaInline)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.mode"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.mode"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.mode</code> + </a> + </span> +</dt> +<dd> +<p>Mode to use for bufferline</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “tabs”, “buffers”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"buffers"</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.modified_icon"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.modified_icon"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.modified_icon</code> + </a> + </span> +</dt> +<dd> +<p>Icon for modified buffer</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"● "</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.move_wraps_at_ends"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.move_wraps_at_ends"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.move_wraps_at_ends</code> + </a> + </span> +</dt> +<dd> +<p>Whether or not the move command “wraps” at the first or last position</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.name_formatter"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.name_formatter"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.name_formatter</code> + </a> + </span> +</dt> +<dd> +<p><code class="literal">name_formatter</code> can be used to change the buffer’s label in the +bufferline.</p><div class="note"><h3 class="title">Note</h3><p>Some names can/will break the bufferline so use this at your +discretion knowing that it has some limitations that will +<span class="strong"><strong>NOT</strong></span> be fixed.</p></div> + +<p><span class="emphasis"><em>Type:</em></span> +null or (luaInline)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.numbers"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.numbers"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.numbers</code> + </a> + </span> +</dt> +<dd> +<p>Whether or not to show buffer numbers</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “none”, “ordinal”, “buffer_id”, “both” or (luaInline)</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + _type = "lua-inline"; + expr = '' + function(opts) + return string.format('%s·%s', opts.raise(opts.id), opts.lower(opts.ordinal)) + end + ''; +} +</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.offsets"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.offsets"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.offsets</code> + </a> + </span> +</dt> +<dd> +<p>The windows to offset bufferline above, see <code class="literal">:help bufferline-offset</code></p> + +<p><span class="emphasis"><em>Type:</em></span> +list of (attribute set)</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + { + filetype = "NvimTree"; + highlight = "Directory"; + separator = true; + text = "File Explorer"; + } +] +</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.persist_buffer_sort"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.persist_buffer_sort"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.persist_buffer_sort</code> + </a> + </span> +</dt> +<dd> +<p>Whether or not custom sorted buffers should persist</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.right_mouse_command"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.right_mouse_command"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.right_mouse_command</code> + </a> + </span> +</dt> +<dd> +<p>Command to run when right clicking a buffer</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string or (luaInline)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"vertical sbuffer %d"</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.right_trunc_marker"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.right_trunc_marker"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.right_trunc_marker</code> + </a> + </span> +</dt> +<dd> +<p>Icon for right truncation</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">""</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.separator_style"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.separator_style"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.separator_style</code> + </a> + </span> +</dt> +<dd> +<p>The type of separator used to separate buffers and tabs.</p><p>Either one of the listed types, or a list of 2 characters for either side.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or one of “slant”, “padded_slant”, “slope”, “padded_slope”, “thick”, “thin” or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"thin"</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.show_buffer_close_icons"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.show_buffer_close_icons"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.show_buffer_close_icons</code> + </a> + </span> +</dt> +<dd> +<p>Whether or not to show buffer close icons</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.show_buffer_icons"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.show_buffer_icons"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.show_buffer_icons</code> + </a> + </span> +</dt> +<dd> +<p>Whether or not to show buffer icons</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.show_close_icon"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.show_close_icon"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.show_close_icon</code> + </a> + </span> +</dt> +<dd> +<p>Whether or not to show the close icon</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.show_duplicate_prefix"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.show_duplicate_prefix"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.show_duplicate_prefix</code> + </a> + </span> +</dt> +<dd> +<p>Whether or not to show duplicate buffer prefixes</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.show_tab_indicators"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.show_tab_indicators"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.show_tab_indicators</code> + </a> + </span> +</dt> +<dd> +<p>Whether or not to show tab indicators</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.sort_by"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.sort_by"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.sort_by</code> + </a> + </span> +</dt> +<dd> +<p>Method to sort buffers by. Must be one of the supported values, or an inline Lua value.</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “insert_after_current”, “insert_at_end”, “id”, “extension”, “relative_directory”, “directory”, “tabs” or (luaInline)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"extension"</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.style_preset"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.style_preset"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.style_preset</code> + </a> + </span> +</dt> +<dd> +<p>The base style of bufferline</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “default”, “minimal”, “no_bold”, “no_italic”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"default"</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.tab_size"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.tab_size"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.tab_size</code> + </a> + </span> +</dt> +<dd> +<p>The size of the tabs in bufferline</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">18</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.themable"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.themable"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.themable</code> + </a> + </span> +</dt> +<dd> +<p>Whether or not to allow highlight groups to be overridden.</p><p>While false, bufferline.nvim sets highlights as default.</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.tabline.nvimBufferline.setupOpts.options.truncate_names"></a><a class="term" href="options.html#opt-vim.tabline.nvimBufferline.setupOpts.options.truncate_names"><code class="option">vim.tabline.nvimBufferline.setupOpts.options.truncate_names</code> + </a> + </span> +</dt> +<dd> +<p>Truncate names</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/plugins/tabline/nvim-bufferline/nvim-bufferline.nix" target="_top"> +<nvf/modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.enable"></a><a class="term" href="options.html#opt-vim.telescope.enable"><code class="option">vim.telescope.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable telescope.nvim: multi-purpose search and picker utility.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.mappings.buffers"></a><a class="term" href="options.html#opt-vim.telescope.mappings.buffers"><code class="option">vim.telescope.mappings.buffers</code> + </a> + </span> +</dt> +<dd> +<p>Buffers [Telescope]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>fb"</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.mappings.diagnostics"></a><a class="term" href="options.html#opt-vim.telescope.mappings.diagnostics"><code class="option">vim.telescope.mappings.diagnostics</code> + </a> + </span> +</dt> +<dd> +<p>Diagnostics [Telescope]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>fld"</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.mappings.findFiles"></a><a class="term" href="options.html#opt-vim.telescope.mappings.findFiles"><code class="option">vim.telescope.mappings.findFiles</code> + </a> + </span> +</dt> +<dd> +<p>Find files [Telescope]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>ff"</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.mappings.findProjects"></a><a class="term" href="options.html#opt-vim.telescope.mappings.findProjects"><code class="option">vim.telescope.mappings.findProjects</code> + </a> + </span> +</dt> +<dd> +<p>Find projects [Telescope]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>fp"</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.mappings.gitBranches"></a><a class="term" href="options.html#opt-vim.telescope.mappings.gitBranches"><code class="option">vim.telescope.mappings.gitBranches</code> + </a> + </span> +</dt> +<dd> +<p>Git branches [Telescope]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>fvb"</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.mappings.gitBufferCommits"></a><a class="term" href="options.html#opt-vim.telescope.mappings.gitBufferCommits"><code class="option">vim.telescope.mappings.gitBufferCommits</code> + </a> + </span> +</dt> +<dd> +<p>Git buffer commits [Telescope]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>fvcb"</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.mappings.gitCommits"></a><a class="term" href="options.html#opt-vim.telescope.mappings.gitCommits"><code class="option">vim.telescope.mappings.gitCommits</code> + </a> + </span> +</dt> +<dd> +<p>Git commits [Telescope]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>fvcw"</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.mappings.gitStash"></a><a class="term" href="options.html#opt-vim.telescope.mappings.gitStash"><code class="option">vim.telescope.mappings.gitStash</code> + </a> + </span> +</dt> +<dd> +<p>Git stash [Telescope]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>fvx"</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.mappings.gitStatus"></a><a class="term" href="options.html#opt-vim.telescope.mappings.gitStatus"><code class="option">vim.telescope.mappings.gitStatus</code> + </a> + </span> +</dt> +<dd> +<p>Git status [Telescope]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>fvs"</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.mappings.helpTags"></a><a class="term" href="options.html#opt-vim.telescope.mappings.helpTags"><code class="option">vim.telescope.mappings.helpTags</code> + </a> + </span> +</dt> +<dd> +<p>Help tags [Telescope]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>fh"</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.mappings.liveGrep"></a><a class="term" href="options.html#opt-vim.telescope.mappings.liveGrep"><code class="option">vim.telescope.mappings.liveGrep</code> + </a> + </span> +</dt> +<dd> +<p>Live grep [Telescope]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>fg"</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.mappings.lspDefinitions"></a><a class="term" href="options.html#opt-vim.telescope.mappings.lspDefinitions"><code class="option">vim.telescope.mappings.lspDefinitions</code> + </a> + </span> +</dt> +<dd> +<p>LSP Definitions [Telescope]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>flD"</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.mappings.lspDocumentSymbols"></a><a class="term" href="options.html#opt-vim.telescope.mappings.lspDocumentSymbols"><code class="option">vim.telescope.mappings.lspDocumentSymbols</code> + </a> + </span> +</dt> +<dd> +<p>LSP Document Symbols [Telescope]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>flsb"</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.mappings.lspImplementations"></a><a class="term" href="options.html#opt-vim.telescope.mappings.lspImplementations"><code class="option">vim.telescope.mappings.lspImplementations</code> + </a> + </span> +</dt> +<dd> +<p>LSP Implementations [Telescope]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>fli"</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.mappings.lspReferences"></a><a class="term" href="options.html#opt-vim.telescope.mappings.lspReferences"><code class="option">vim.telescope.mappings.lspReferences</code> + </a> + </span> +</dt> +<dd> +<p>LSP References [Telescope]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>flr"</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.mappings.lspTypeDefinitions"></a><a class="term" href="options.html#opt-vim.telescope.mappings.lspTypeDefinitions"><code class="option">vim.telescope.mappings.lspTypeDefinitions</code> + </a> + </span> +</dt> +<dd> +<p>LSP Type Definitions [Telescope]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>flt"</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.mappings.lspWorkspaceSymbols"></a><a class="term" href="options.html#opt-vim.telescope.mappings.lspWorkspaceSymbols"><code class="option">vim.telescope.mappings.lspWorkspaceSymbols</code> + </a> + </span> +</dt> +<dd> +<p>LSP Workspace Symbols [Telescope]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>flsw"</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.mappings.open"></a><a class="term" href="options.html#opt-vim.telescope.mappings.open"><code class="option">vim.telescope.mappings.open</code> + </a> + </span> +</dt> +<dd> +<p>Open [Telescope]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>ft"</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.mappings.resume"></a><a class="term" href="options.html#opt-vim.telescope.mappings.resume"><code class="option">vim.telescope.mappings.resume</code> + </a> + </span> +</dt> +<dd> +<p>Resume (previous search) [Telescope]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>fr"</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.mappings.treesitter"></a><a class="term" href="options.html#opt-vim.telescope.mappings.treesitter"><code class="option">vim.telescope.mappings.treesitter</code> + </a> + </span> +</dt> +<dd> +<p>Treesitter [Telescope]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>fs"</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.setupOpts"></a><a class="term" href="options.html#opt-vim.telescope.setupOpts"><code class="option">vim.telescope.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of Telescope</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.setupOpts.defaults.color_devicons"></a><a class="term" href="options.html#opt-vim.telescope.setupOpts.defaults.color_devicons"><code class="option">vim.telescope.setupOpts.defaults.color_devicons</code> + </a> + </span> +</dt> +<dd> +<p>Boolean if devicons should be enabled or not.</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.setupOpts.defaults.entry_prefix"></a><a class="term" href="options.html#opt-vim.telescope.setupOpts.defaults.entry_prefix"><code class="option">vim.telescope.setupOpts.defaults.entry_prefix</code> + </a> + </span> +</dt> +<dd> +<p>Prefix in front of each result entry. Current selection not included.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.setupOpts.defaults.file_ignore_patterns"></a><a class="term" href="options.html#opt-vim.telescope.setupOpts.defaults.file_ignore_patterns"><code class="option">vim.telescope.setupOpts.defaults.file_ignore_patterns</code> + </a> + </span> +</dt> +<dd> +<p>A table of lua regex that define the files that should be ignored.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "node_modules" + ".git/" + "dist/" + "build/" + "target/" + "result/" +] +</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.setupOpts.defaults.initial_mode"></a><a class="term" href="options.html#opt-vim.telescope.setupOpts.defaults.initial_mode"><code class="option">vim.telescope.setupOpts.defaults.initial_mode</code> + </a> + </span> +</dt> +<dd> +<p>Determines in which mode telescope starts.</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “insert”, “normal”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"insert"</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.setupOpts.defaults.layout_config"></a><a class="term" href="options.html#opt-vim.telescope.setupOpts.defaults.layout_config"><code class="option">vim.telescope.setupOpts.defaults.layout_config</code> + </a> + </span> +</dt> +<dd> +<p>Determines the default configuration values for layout strategies. +See telescope.layout for details of the configurations options for +each strategy.</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.setupOpts.defaults.layout_config.height"></a><a class="term" href="options.html#opt-vim.telescope.setupOpts.defaults.layout_config.height"><code class="option">vim.telescope.setupOpts.defaults.layout_config.height</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +floating point number</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">0.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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.setupOpts.defaults.layout_config.horizontal.preview_width"></a><a class="term" href="options.html#opt-vim.telescope.setupOpts.defaults.layout_config.horizontal.preview_width"><code class="option">vim.telescope.setupOpts.defaults.layout_config.horizontal.preview_width</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +floating point number</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">0.55</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.setupOpts.defaults.layout_config.horizontal.prompt_position"></a><a class="term" href="options.html#opt-vim.telescope.setupOpts.defaults.layout_config.horizontal.prompt_position"><code class="option">vim.telescope.setupOpts.defaults.layout_config.horizontal.prompt_position</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"top"</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.setupOpts.defaults.layout_config.horizontal.results_width"></a><a class="term" href="options.html#opt-vim.telescope.setupOpts.defaults.layout_config.horizontal.results_width"><code class="option">vim.telescope.setupOpts.defaults.layout_config.horizontal.results_width</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +floating point number</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">0.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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.setupOpts.defaults.layout_config.preview_cutoff"></a><a class="term" href="options.html#opt-vim.telescope.setupOpts.defaults.layout_config.preview_cutoff"><code class="option">vim.telescope.setupOpts.defaults.layout_config.preview_cutoff</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">120</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.setupOpts.defaults.layout_config.vertical.mirror"></a><a class="term" href="options.html#opt-vim.telescope.setupOpts.defaults.layout_config.vertical.mirror"><code class="option">vim.telescope.setupOpts.defaults.layout_config.vertical.mirror</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.setupOpts.defaults.layout_config.width"></a><a class="term" href="options.html#opt-vim.telescope.setupOpts.defaults.layout_config.width"><code class="option">vim.telescope.setupOpts.defaults.layout_config.width</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +floating point number</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">0.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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.setupOpts.defaults.layout_strategy"></a><a class="term" href="options.html#opt-vim.telescope.setupOpts.defaults.layout_strategy"><code class="option">vim.telescope.setupOpts.defaults.layout_strategy</code> + </a> + </span> +</dt> +<dd> +<p>Determines the default layout of Telescope pickers. See <code class="literal">:help telescope.layout</code>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"horizontal"</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.setupOpts.defaults.path_display"></a><a class="term" href="options.html#opt-vim.telescope.setupOpts.defaults.path_display"><code class="option">vim.telescope.setupOpts.defaults.path_display</code> + </a> + </span> +</dt> +<dd> +<p>Determines how file paths are displayed.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of (one of “hidden”, “tail”, “absolute”, “smart”, “shorten”, “truncate”)</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "absolute" +] +</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.setupOpts.defaults.pickers.find_command"></a><a class="term" href="options.html#opt-vim.telescope.setupOpts.defaults.pickers.find_command"><code class="option">vim.telescope.setupOpts.defaults.pickers.find_command</code> + </a> + </span> +</dt> +<dd> +<p>cmd to use for finding files</p> + +<p><span class="emphasis"><em>Type:</em></span> +(list of string) or (luaInline)</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "\${pkgs.fd}/bin/fd" +] +</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.setupOpts.defaults.prompt_prefix"></a><a class="term" href="options.html#opt-vim.telescope.setupOpts.defaults.prompt_prefix"><code class="option">vim.telescope.setupOpts.defaults.prompt_prefix</code> + </a> + </span> +</dt> +<dd> +<p>Shown in front of Telescope’s prompt</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.setupOpts.defaults.selection_caret"></a><a class="term" href="options.html#opt-vim.telescope.setupOpts.defaults.selection_caret"><code class="option">vim.telescope.setupOpts.defaults.selection_caret</code> + </a> + </span> +</dt> +<dd> +<p>Character(s) to show in front of the current selection</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.setupOpts.defaults.selection_strategy"></a><a class="term" href="options.html#opt-vim.telescope.setupOpts.defaults.selection_strategy"><code class="option">vim.telescope.setupOpts.defaults.selection_strategy</code> + </a> + </span> +</dt> +<dd> +<p>Determines how the cursor acts after each sort iteration.</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “reset”, “follow”, “row”, “closest”, “none”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"reset"</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.setupOpts.defaults.set_env"></a><a class="term" href="options.html#opt-vim.telescope.setupOpts.defaults.set_env"><code class="option">vim.telescope.setupOpts.defaults.set_env</code> + </a> + </span> +</dt> +<dd> +<p>Set an environment for term_previewer</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + COLORTERM = "truecolor"; +} +</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.setupOpts.defaults.sorting_strategy"></a><a class="term" href="options.html#opt-vim.telescope.setupOpts.defaults.sorting_strategy"><code class="option">vim.telescope.setupOpts.defaults.sorting_strategy</code> + </a> + </span> +</dt> +<dd> +<p>Determines the direction “better” results are sorted towards.</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “descending”, “ascending”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"ascending"</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.setupOpts.defaults.vimgrep_arguments"></a><a class="term" href="options.html#opt-vim.telescope.setupOpts.defaults.vimgrep_arguments"><code class="option">vim.telescope.setupOpts.defaults.vimgrep_arguments</code> + </a> + </span> +</dt> +<dd> +<p>Defines the command that will be used for <code class="literal">live_grep</code> and <code class="literal">grep_string</code> pickers. +Make sure that color is set to <code class="literal">never</code> because telescope does not yet interpret color codes.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "\${pkgs.ripgrep}/bin/rg" + "--color=never" + "--no-heading" + "--with-filename" + "--line-number" + "--column" + "--smart-case" + "--hidden" + "--no-ignore" +] +</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.telescope.setupOpts.defaults.winblend"></a><a class="term" href="options.html#opt-vim.telescope.setupOpts.defaults.winblend"><code class="option">vim.telescope.setupOpts.defaults.winblend</code> + </a> + </span> +</dt> +<dd> +<p>pseudo-transparency of keymap hints floating window</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">0</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/plugins/utility/telescope/telescope.nix" target="_top"> +<nvf/modules/plugins/utility/telescope/telescope.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.terminal.toggleterm.enable"></a><a class="term" href="options.html#opt-vim.terminal.toggleterm.enable"><code class="option">vim.terminal.toggleterm.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable toggleterm as a replacement to built-in terminal command.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/terminal/toggleterm/toggleterm.nix" target="_top"> +<nvf/modules/plugins/terminal/toggleterm/toggleterm.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.terminal.toggleterm.lazygit.enable"></a><a class="term" href="options.html#opt-vim.terminal.toggleterm.lazygit.enable"><code class="option">vim.terminal.toggleterm.lazygit.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable LazyGit integration.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/terminal/toggleterm/toggleterm.nix" target="_top"> +<nvf/modules/plugins/terminal/toggleterm/toggleterm.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.terminal.toggleterm.lazygit.package"></a><a class="term" href="options.html#opt-vim.terminal.toggleterm.lazygit.package"><code class="option">vim.terminal.toggleterm.lazygit.package</code> + </a> + </span> +</dt> +<dd> +<p>The package that should be used for lazygit. Setting it to null will attempt to use lazygit from your PATH</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation lazygit-0.44.1></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/plugins/terminal/toggleterm/toggleterm.nix" target="_top"> +<nvf/modules/plugins/terminal/toggleterm/toggleterm.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.terminal.toggleterm.lazygit.direction"></a><a class="term" href="options.html#opt-vim.terminal.toggleterm.lazygit.direction"><code class="option">vim.terminal.toggleterm.lazygit.direction</code> + </a> + </span> +</dt> +<dd> +<p>Direction of the lazygit window</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “horizontal”, “vertical”, “tab”, “float”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"float"</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/plugins/terminal/toggleterm/toggleterm.nix" target="_top"> +<nvf/modules/plugins/terminal/toggleterm/toggleterm.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.terminal.toggleterm.lazygit.mappings.open"></a><a class="term" href="options.html#opt-vim.terminal.toggleterm.lazygit.mappings.open"><code class="option">vim.terminal.toggleterm.lazygit.mappings.open</code> + </a> + </span> +</dt> +<dd> +<p>Open lazygit [toggleterm]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>gg"</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/plugins/terminal/toggleterm/toggleterm.nix" target="_top"> +<nvf/modules/plugins/terminal/toggleterm/toggleterm.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.terminal.toggleterm.mappings.open"></a><a class="term" href="options.html#opt-vim.terminal.toggleterm.mappings.open"><code class="option">vim.terminal.toggleterm.mappings.open</code> + </a> + </span> +</dt> +<dd> +<p>The keymapping to open toggleterm</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<c-t>"</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/plugins/terminal/toggleterm/toggleterm.nix" target="_top"> +<nvf/modules/plugins/terminal/toggleterm/toggleterm.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.terminal.toggleterm.setupOpts"></a><a class="term" href="options.html#opt-vim.terminal.toggleterm.setupOpts"><code class="option">vim.terminal.toggleterm.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of ToggleTerm</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/terminal/toggleterm/toggleterm.nix" target="_top"> +<nvf/modules/plugins/terminal/toggleterm/toggleterm.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.terminal.toggleterm.setupOpts.enable_winbar"></a><a class="term" href="options.html#opt-vim.terminal.toggleterm.setupOpts.enable_winbar"><code class="option">vim.terminal.toggleterm.setupOpts.enable_winbar</code> + </a> + </span> +</dt> +<dd> +<p>Enable winbar</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/terminal/toggleterm/toggleterm.nix" target="_top"> +<nvf/modules/plugins/terminal/toggleterm/toggleterm.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.terminal.toggleterm.setupOpts.direction"></a><a class="term" href="options.html#opt-vim.terminal.toggleterm.setupOpts.direction"><code class="option">vim.terminal.toggleterm.setupOpts.direction</code> + </a> + </span> +</dt> +<dd> +<p>Direction of the terminal</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “horizontal”, “vertical”, “tab”, “float”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"horizontal"</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/plugins/terminal/toggleterm/toggleterm.nix" target="_top"> +<nvf/modules/plugins/terminal/toggleterm/toggleterm.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.terminal.toggleterm.setupOpts.size"></a><a class="term" href="options.html#opt-vim.terminal.toggleterm.setupOpts.size"><code class="option">vim.terminal.toggleterm.setupOpts.size</code> + </a> + </span> +</dt> +<dd> +<p>Number or lua function which is passed to the current terminal</p> + +<p><span class="emphasis"><em>Type:</em></span> +(luaInline) or signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + _type = "lua-inline"; + expr = '' + function(term) + if term.direction == "horizontal" then + return 15 + elseif term.direction == "vertical" then + return vim.o.columns * 0.4 + end + end + ''; +} +</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/plugins/terminal/toggleterm/toggleterm.nix" target="_top"> +<nvf/modules/plugins/terminal/toggleterm/toggleterm.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.terminal.toggleterm.setupOpts.winbar.enabled"></a><a class="term" href="options.html#opt-vim.terminal.toggleterm.setupOpts.winbar.enabled"><code class="option">vim.terminal.toggleterm.setupOpts.winbar.enabled</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable winbar in terminal.</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>Example:</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/plugins/terminal/toggleterm/toggleterm.nix" target="_top"> +<nvf/modules/plugins/terminal/toggleterm/toggleterm.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.terminal.toggleterm.setupOpts.winbar.name_formatter"></a><a class="term" href="options.html#opt-vim.terminal.toggleterm.setupOpts.winbar.name_formatter"><code class="option">vim.terminal.toggleterm.setupOpts.winbar.name_formatter</code> + </a> + </span> +</dt> +<dd> +<p>Winbar formatter function.</p> + +<p><span class="emphasis"><em>Type:</em></span> +luaInline</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + _type = "lua-inline"; + expr = '' + function(term) + return term.name + end + ''; +} +</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/plugins/terminal/toggleterm/toggleterm.nix" target="_top"> +<nvf/modules/plugins/terminal/toggleterm/toggleterm.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.theme.enable"></a><a class="term" href="options.html#opt-vim.theme.enable"><code class="option">vim.theme.enable</code> + </a> + </span> +</dt> +<dd> +<p>Enable theming</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</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/plugins/theme/theme.nix" target="_top"> +<nvf/modules/plugins/theme/theme.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.theme.base16-colors.base00"></a><a class="term" href="options.html#opt-vim.theme.base16-colors.base00"><code class="option">vim.theme.base16-colors.base00</code> + </a> + </span> +</dt> +<dd> +<p>The base00 color to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +RGB color in hex format</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/plugins/theme/theme.nix" target="_top"> +<nvf/modules/plugins/theme/theme.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.theme.base16-colors.base01"></a><a class="term" href="options.html#opt-vim.theme.base16-colors.base01"><code class="option">vim.theme.base16-colors.base01</code> + </a> + </span> +</dt> +<dd> +<p>The base01 color to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +RGB color in hex format</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/plugins/theme/theme.nix" target="_top"> +<nvf/modules/plugins/theme/theme.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.theme.base16-colors.base02"></a><a class="term" href="options.html#opt-vim.theme.base16-colors.base02"><code class="option">vim.theme.base16-colors.base02</code> + </a> + </span> +</dt> +<dd> +<p>The base02 color to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +RGB color in hex format</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/plugins/theme/theme.nix" target="_top"> +<nvf/modules/plugins/theme/theme.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.theme.base16-colors.base03"></a><a class="term" href="options.html#opt-vim.theme.base16-colors.base03"><code class="option">vim.theme.base16-colors.base03</code> + </a> + </span> +</dt> +<dd> +<p>The base03 color to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +RGB color in hex format</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/plugins/theme/theme.nix" target="_top"> +<nvf/modules/plugins/theme/theme.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.theme.base16-colors.base04"></a><a class="term" href="options.html#opt-vim.theme.base16-colors.base04"><code class="option">vim.theme.base16-colors.base04</code> + </a> + </span> +</dt> +<dd> +<p>The base04 color to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +RGB color in hex format</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/plugins/theme/theme.nix" target="_top"> +<nvf/modules/plugins/theme/theme.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.theme.base16-colors.base05"></a><a class="term" href="options.html#opt-vim.theme.base16-colors.base05"><code class="option">vim.theme.base16-colors.base05</code> + </a> + </span> +</dt> +<dd> +<p>The base05 color to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +RGB color in hex format</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/plugins/theme/theme.nix" target="_top"> +<nvf/modules/plugins/theme/theme.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.theme.base16-colors.base06"></a><a class="term" href="options.html#opt-vim.theme.base16-colors.base06"><code class="option">vim.theme.base16-colors.base06</code> + </a> + </span> +</dt> +<dd> +<p>The base06 color to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +RGB color in hex format</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/plugins/theme/theme.nix" target="_top"> +<nvf/modules/plugins/theme/theme.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.theme.base16-colors.base07"></a><a class="term" href="options.html#opt-vim.theme.base16-colors.base07"><code class="option">vim.theme.base16-colors.base07</code> + </a> + </span> +</dt> +<dd> +<p>The base07 color to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +RGB color in hex format</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/plugins/theme/theme.nix" target="_top"> +<nvf/modules/plugins/theme/theme.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.theme.base16-colors.base08"></a><a class="term" href="options.html#opt-vim.theme.base16-colors.base08"><code class="option">vim.theme.base16-colors.base08</code> + </a> + </span> +</dt> +<dd> +<p>The base08 color to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +RGB color in hex format</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/plugins/theme/theme.nix" target="_top"> +<nvf/modules/plugins/theme/theme.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.theme.base16-colors.base09"></a><a class="term" href="options.html#opt-vim.theme.base16-colors.base09"><code class="option">vim.theme.base16-colors.base09</code> + </a> + </span> +</dt> +<dd> +<p>The base09 color to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +RGB color in hex format</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/plugins/theme/theme.nix" target="_top"> +<nvf/modules/plugins/theme/theme.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.theme.base16-colors.base0A"></a><a class="term" href="options.html#opt-vim.theme.base16-colors.base0A"><code class="option">vim.theme.base16-colors.base0A</code> + </a> + </span> +</dt> +<dd> +<p>The base0A color to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +RGB color in hex format</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/plugins/theme/theme.nix" target="_top"> +<nvf/modules/plugins/theme/theme.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.theme.base16-colors.base0B"></a><a class="term" href="options.html#opt-vim.theme.base16-colors.base0B"><code class="option">vim.theme.base16-colors.base0B</code> + </a> + </span> +</dt> +<dd> +<p>The base0B color to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +RGB color in hex format</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/plugins/theme/theme.nix" target="_top"> +<nvf/modules/plugins/theme/theme.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.theme.base16-colors.base0C"></a><a class="term" href="options.html#opt-vim.theme.base16-colors.base0C"><code class="option">vim.theme.base16-colors.base0C</code> + </a> + </span> +</dt> +<dd> +<p>The base0C color to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +RGB color in hex format</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/plugins/theme/theme.nix" target="_top"> +<nvf/modules/plugins/theme/theme.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.theme.base16-colors.base0D"></a><a class="term" href="options.html#opt-vim.theme.base16-colors.base0D"><code class="option">vim.theme.base16-colors.base0D</code> + </a> + </span> +</dt> +<dd> +<p>The base0D color to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +RGB color in hex format</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/plugins/theme/theme.nix" target="_top"> +<nvf/modules/plugins/theme/theme.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.theme.base16-colors.base0E"></a><a class="term" href="options.html#opt-vim.theme.base16-colors.base0E"><code class="option">vim.theme.base16-colors.base0E</code> + </a> + </span> +</dt> +<dd> +<p>The base0E color to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +RGB color in hex format</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/plugins/theme/theme.nix" target="_top"> +<nvf/modules/plugins/theme/theme.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.theme.base16-colors.base0F"></a><a class="term" href="options.html#opt-vim.theme.base16-colors.base0F"><code class="option">vim.theme.base16-colors.base0F</code> + </a> + </span> +</dt> +<dd> +<p>The base0F color to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +RGB color in hex format</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/plugins/theme/theme.nix" target="_top"> +<nvf/modules/plugins/theme/theme.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.theme.extraConfig"></a><a class="term" href="options.html#opt-vim.theme.extraConfig"><code class="option">vim.theme.extraConfig</code> + </a> + </span> +</dt> +<dd> +<p>Additional lua configuration to add before setup</p> + +<p><span class="emphasis"><em>Type:</em></span> +strings concatenated with “\n”</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/plugins/theme/theme.nix" target="_top"> +<nvf/modules/plugins/theme/theme.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.theme.name"></a><a class="term" href="options.html#opt-vim.theme.name"><code class="option">vim.theme.name</code> + </a> + </span> +</dt> +<dd> +<p>Supported themes can be found in <code class="filename">supportedThemes.nix</code>. +Setting the theme to “base16” enables base16 theming and +requires all of the colors in <code class="option">vim.theme.base16-colors</code> to be set.</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “base16”, “catppuccin”, “dracula”, “gruvbox”, “mini-base16”, “nord”, “onedark”, “oxocarbon”, “rose-pine”, “tokyonight”</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/plugins/theme/theme.nix" target="_top"> +<nvf/modules/plugins/theme/theme.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.theme.style"></a><a class="term" href="options.html#opt-vim.theme.style"><code class="option">vim.theme.style</code> + </a> + </span> +</dt> +<dd> +<p>Specific style for theme if it supports it</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “dark”, “darker”, “cool”, “deep”, “warm”, “warmer”</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/plugins/theme/theme.nix" target="_top"> +<nvf/modules/plugins/theme/theme.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.theme.transparent"></a><a class="term" href="options.html#opt-vim.theme.transparent"><code class="option">vim.theme.transparent</code> + </a> + </span> +</dt> +<dd> +<p>Whether or not transparency should be enabled. Has no effect for themes that do not support transparency</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/theme/theme.nix" target="_top"> +<nvf/modules/plugins/theme/theme.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.enable"></a><a class="term" href="options.html#opt-vim.treesitter.enable"><code class="option">vim.treesitter.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable treesitter, also enabled automatically through language options.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/treesitter/treesitter.nix" target="_top"> +<nvf/modules/plugins/treesitter/treesitter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.addDefaultGrammars"></a><a class="term" href="options.html#opt-vim.treesitter.addDefaultGrammars"><code class="option">vim.treesitter.addDefaultGrammars</code> + </a> + </span> +</dt> +<dd> +<p>Whether to add the default grammars to the list of grammars +to install.</p><p>This option is only relevant if treesitter has been enabled.</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/plugins/treesitter/treesitter.nix" target="_top"> +<nvf/modules/plugins/treesitter/treesitter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.autotagHtml"></a><a class="term" href="options.html#opt-vim.treesitter.autotagHtml"><code class="option">vim.treesitter.autotagHtml</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable autoclose and rename html tag.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/treesitter/treesitter.nix" target="_top"> +<nvf/modules/plugins/treesitter/treesitter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.context.enable"></a><a class="term" href="options.html#opt-vim.treesitter.context.enable"><code class="option">vim.treesitter.context.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable context of current buffer contents [nvim-treesitter-context] .</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/treesitter/ts-context/context.nix" target="_top"> +<nvf/modules/plugins/treesitter/ts-context/context.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.context.setupOpts"></a><a class="term" href="options.html#opt-vim.treesitter.context.setupOpts"><code class="option">vim.treesitter.context.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of treesitter-context</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/treesitter/ts-context/context.nix" target="_top"> +<nvf/modules/plugins/treesitter/ts-context/context.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.context.setupOpts.line_numbers"></a><a class="term" href="options.html#opt-vim.treesitter.context.setupOpts.line_numbers"><code class="option">vim.treesitter.context.setupOpts.line_numbers</code> + </a> + </span> +</dt> +<dd> +<p>Whether to display line numbers in current context</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/plugins/treesitter/ts-context/context.nix" target="_top"> +<nvf/modules/plugins/treesitter/ts-context/context.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.context.setupOpts.max_lines"></a><a class="term" href="options.html#opt-vim.treesitter.context.setupOpts.max_lines"><code class="option">vim.treesitter.context.setupOpts.max_lines</code> + </a> + </span> +</dt> +<dd> +<p>How many lines the window should span.</p><p>Values >= 0 mean there will be no limit.</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">0</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/plugins/treesitter/ts-context/context.nix" target="_top"> +<nvf/modules/plugins/treesitter/ts-context/context.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.context.setupOpts.min_window_height"></a><a class="term" href="options.html#opt-vim.treesitter.context.setupOpts.min_window_height"><code class="option">vim.treesitter.context.setupOpts.min_window_height</code> + </a> + </span> +</dt> +<dd> +<p>Minimum editor window height to enable context.</p><p>Values >= 0 mean there will be no limit.</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">0</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/plugins/treesitter/ts-context/context.nix" target="_top"> +<nvf/modules/plugins/treesitter/ts-context/context.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.context.setupOpts.mode"></a><a class="term" href="options.html#opt-vim.treesitter.context.setupOpts.mode"><code class="option">vim.treesitter.context.setupOpts.mode</code> + </a> + </span> +</dt> +<dd> +<p>Line used to calculate context.</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “cursor”, “topline”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"cursor"</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/plugins/treesitter/ts-context/context.nix" target="_top"> +<nvf/modules/plugins/treesitter/ts-context/context.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.context.setupOpts.multiline_threshold"></a><a class="term" href="options.html#opt-vim.treesitter.context.setupOpts.multiline_threshold"><code class="option">vim.treesitter.context.setupOpts.multiline_threshold</code> + </a> + </span> +</dt> +<dd> +<p>Maximum number of lines to collapse for a single context line.</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">20</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/plugins/treesitter/ts-context/context.nix" target="_top"> +<nvf/modules/plugins/treesitter/ts-context/context.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.context.setupOpts.separator"></a><a class="term" href="options.html#opt-vim.treesitter.context.setupOpts.separator"><code class="option">vim.treesitter.context.setupOpts.separator</code> + </a> + </span> +</dt> +<dd> +<p>Separator between context and content. This option should +be a single character string, like ‘-’.</p><p>When separator is set, the context will only show up when +there are at least 2 lines above cursorline.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"-"</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/plugins/treesitter/ts-context/context.nix" target="_top"> +<nvf/modules/plugins/treesitter/ts-context/context.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.context.setupOpts.trim_scope"></a><a class="term" href="options.html#opt-vim.treesitter.context.setupOpts.trim_scope"><code class="option">vim.treesitter.context.setupOpts.trim_scope</code> + </a> + </span> +</dt> +<dd> +<p>Which context lines to discard if +<a class="xref" href="options.html#opt-vim.treesitter.context.setupOpts.max_lines" ><code class="option">vim.treesitter.context.setupOpts.max_lines</code></a> is exceeded.</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “inner”, “outer”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"outer"</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/plugins/treesitter/ts-context/context.nix" target="_top"> +<nvf/modules/plugins/treesitter/ts-context/context.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.context.setupOpts.zindex"></a><a class="term" href="options.html#opt-vim.treesitter.context.setupOpts.zindex"><code class="option">vim.treesitter.context.setupOpts.zindex</code> + </a> + </span> +</dt> +<dd> +<p>The Z-index of the context window.</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">20</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/plugins/treesitter/ts-context/context.nix" target="_top"> +<nvf/modules/plugins/treesitter/ts-context/context.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.fold"></a><a class="term" href="options.html#opt-vim.treesitter.fold"><code class="option">vim.treesitter.fold</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable fold with treesitter.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/treesitter/treesitter.nix" target="_top"> +<nvf/modules/plugins/treesitter/treesitter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.grammars"></a><a class="term" href="options.html#opt-vim.treesitter.grammars"><code class="option">vim.treesitter.grammars</code> + </a> + </span> +</dt> +<dd> +<p>List of treesitter grammars to install.</p><p>For languages already supported by nvf, you may +use the <code class="option">vim.language.<lang>.treesitter</code> options, which +will automatically add the required grammars to this.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/treesitter/treesitter.nix" target="_top"> +<nvf/modules/plugins/treesitter/treesitter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.highlight.enable"></a><a class="term" href="options.html#opt-vim.treesitter.highlight.enable"><code class="option">vim.treesitter.highlight.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable highlighting with treesitter.</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>Example:</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/plugins/treesitter/treesitter.nix" target="_top"> +<nvf/modules/plugins/treesitter/treesitter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.highlight.additionalVimRegexHighlighting"></a><a class="term" href="options.html#opt-vim.treesitter.highlight.additionalVimRegexHighlighting"><code class="option">vim.treesitter.highlight.additionalVimRegexHighlighting</code> + </a> + </span> +</dt> +<dd> +<p>Takes either a boolean or a list of languages.</p><p>Setting this to true will run <code class="literal">:h syntax</code> and tree-sitter at the same time. +You may this to <code class="literal">true</code> if you depend on ‘syntax’ being enabled (like for +indentation).</p><div class="note"><h3 class="title">Note</h3><p>Using this option may slow down your editor, and you may see some duplicate +highlights.</p></div> + +<p><span class="emphasis"><em>Type:</em></span> +boolean or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/treesitter/treesitter.nix" target="_top"> +<nvf/modules/plugins/treesitter/treesitter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.highlight.disable"></a><a class="term" href="options.html#opt-vim.treesitter.highlight.disable"><code class="option">vim.treesitter.highlight.disable</code> + </a> + </span> +</dt> +<dd> +<p>List of treesitter grammars to disable highlighting for.</p><p>This option can be either a list, in which case it will be +converted to a Lua table containing grammars to disable +highlighting for, or a string containing a <span class="strong"><strong>lua function</strong></span> +that will be read as is.</p><div class="warning"><h3 class="title">Warning</h3><p>A comma will be added at the end of your function, so you +do not need to add it yourself. Doing so will cause in +syntax errors within your Neovim configuration.</p></div> + +<p><span class="emphasis"><em>Type:</em></span> +(list of string) or (luaInline)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</code></p> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting lua">-- Disable slow treesitter highlight for large files +function(lang, buf) + local max_filesize = 1000 * 1024 -- 1MB + local ok, stats = pcall(vim.loop.fs_stat, vim.api.nvim_buf_get_name(buf)) + if ok and stats and stats.size > max_filesize then + return true + end +end +</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/plugins/treesitter/treesitter.nix" target="_top"> +<nvf/modules/plugins/treesitter/treesitter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.incrementalSelection.enable"></a><a class="term" href="options.html#opt-vim.treesitter.incrementalSelection.enable"><code class="option">vim.treesitter.incrementalSelection.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable incremental selection with treesitter.</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>Example:</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/plugins/treesitter/treesitter.nix" target="_top"> +<nvf/modules/plugins/treesitter/treesitter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.incrementalSelection.disable"></a><a class="term" href="options.html#opt-vim.treesitter.incrementalSelection.disable"><code class="option">vim.treesitter.incrementalSelection.disable</code> + </a> + </span> +</dt> +<dd> +<p>List of treesitter grammars to disable incremental selection +for.</p><p>This option can be either a list, in which case it will be +converted to a Lua table containing grammars to disable +indentation for, or a string containing a <span class="strong"><strong>lua function</strong></span> +that will be read as is.</p><div class="warning"><h3 class="title">Warning</h3><p>A comma will be added at the end of your function, so you +do not need to add it yourself. Doing so will cause in +syntax errors within your Neovim configuration.</p></div> + +<p><span class="emphasis"><em>Type:</em></span> +(list of string) or (luaInline)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">["c" "rust" ]</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/plugins/treesitter/treesitter.nix" target="_top"> +<nvf/modules/plugins/treesitter/treesitter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.indent.enable"></a><a class="term" href="options.html#opt-vim.treesitter.indent.enable"><code class="option">vim.treesitter.indent.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable indentation with treesitter.</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>Example:</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/plugins/treesitter/treesitter.nix" target="_top"> +<nvf/modules/plugins/treesitter/treesitter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.indent.disable"></a><a class="term" href="options.html#opt-vim.treesitter.indent.disable"><code class="option">vim.treesitter.indent.disable</code> + </a> + </span> +</dt> +<dd> +<p>List of treesitter grammars to disable indentation for.</p><p>This option can be either a list, in which case it will be +converted to a Lua table containing grammars to disable +indentation for, or a string containing a <span class="strong"><strong>lua function</strong></span> +that will be read as is.</p><div class="warning"><h3 class="title">Warning</h3><p>A comma will be added at the end of your function, so you +do not need to add it yourself. Doing so will cause in +syntax errors within your Neovim configuration.</p></div> + +<p><span class="emphasis"><em>Type:</em></span> +(list of string) or (luaInline)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">["c" "rust"]</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/plugins/treesitter/treesitter.nix" target="_top"> +<nvf/modules/plugins/treesitter/treesitter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.mappings.incrementalSelection.decrementByNode"></a><a class="term" href="options.html#opt-vim.treesitter.mappings.incrementalSelection.decrementByNode"><code class="option">vim.treesitter.mappings.incrementalSelection.decrementByNode</code> + </a> + </span> +</dt> +<dd> +<p>Decrement selection by node [treesitter]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"grm"</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/plugins/treesitter/treesitter.nix" target="_top"> +<nvf/modules/plugins/treesitter/treesitter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.mappings.incrementalSelection.incrementByNode"></a><a class="term" href="options.html#opt-vim.treesitter.mappings.incrementalSelection.incrementByNode"><code class="option">vim.treesitter.mappings.incrementalSelection.incrementByNode</code> + </a> + </span> +</dt> +<dd> +<p>Increment selection by node [treesitter]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"grn"</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/plugins/treesitter/treesitter.nix" target="_top"> +<nvf/modules/plugins/treesitter/treesitter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.mappings.incrementalSelection.incrementByScope"></a><a class="term" href="options.html#opt-vim.treesitter.mappings.incrementalSelection.incrementByScope"><code class="option">vim.treesitter.mappings.incrementalSelection.incrementByScope</code> + </a> + </span> +</dt> +<dd> +<p>Increment selection by scope [treesitter]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"grc"</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/plugins/treesitter/treesitter.nix" target="_top"> +<nvf/modules/plugins/treesitter/treesitter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.treesitter.mappings.incrementalSelection.init"></a><a class="term" href="options.html#opt-vim.treesitter.mappings.incrementalSelection.init"><code class="option">vim.treesitter.mappings.incrementalSelection.init</code> + </a> + </span> +</dt> +<dd> +<p>Init selection [treesitter]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"gnn"</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/plugins/treesitter/treesitter.nix" target="_top"> +<nvf/modules/plugins/treesitter/treesitter.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.borders.enable"></a><a class="term" href="options.html#opt-vim.ui.borders.enable"><code class="option">vim.ui.borders.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable visible borders for most windows.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/ui/borders/borders.nix" target="_top"> +<nvf/modules/plugins/ui/borders/borders.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.borders.globalStyle"></a><a class="term" href="options.html#opt-vim.ui.borders.globalStyle"><code class="option">vim.ui.borders.globalStyle</code> + </a> + </span> +</dt> +<dd> +<p>The global border style to use.</p><p>If a list is given, it should have a length of eight or any divisor of +eight. The array will specify the eight chars building up the border in +a clockwise fashion starting with the top-left corner. You can specify +a different highlight group for each character by passing a +[char, “YourHighlightGroup”] instead</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “none”, “single”, “double”, “rounded”, “solid”, “shadow” or list of (string or list of string)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"rounded"</code></p> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">[ + "╔" + "═" + "╗" + "║" + "╝" + "═" + "╚" + "║" +] +</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/plugins/ui/borders/borders.nix" target="_top"> +<nvf/modules/plugins/ui/borders/borders.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.borders.plugins.fastaction.enable"></a><a class="term" href="options.html#opt-vim.ui.borders.plugins.fastaction.enable"><code class="option">vim.ui.borders.plugins.fastaction.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable borders for the fastaction plugin.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/ui/borders/borders.nix" target="_top"> +<nvf/modules/plugins/ui/borders/borders.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.borders.plugins.fastaction.style"></a><a class="term" href="options.html#opt-vim.ui.borders.plugins.fastaction.style"><code class="option">vim.ui.borders.plugins.fastaction.style</code> + </a> + </span> +</dt> +<dd> +<p>The border style to use for the fastaction plugin</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “none”, “single”, “double”, “rounded”, “solid”, “shadow” or list of (string or list of string)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"rounded"</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/plugins/ui/borders/borders.nix" target="_top"> +<nvf/modules/plugins/ui/borders/borders.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.borders.plugins.lsp-signature.enable"></a><a class="term" href="options.html#opt-vim.ui.borders.plugins.lsp-signature.enable"><code class="option">vim.ui.borders.plugins.lsp-signature.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable borders for the lsp-signature plugin.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/ui/borders/borders.nix" target="_top"> +<nvf/modules/plugins/ui/borders/borders.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.borders.plugins.lsp-signature.style"></a><a class="term" href="options.html#opt-vim.ui.borders.plugins.lsp-signature.style"><code class="option">vim.ui.borders.plugins.lsp-signature.style</code> + </a> + </span> +</dt> +<dd> +<p>The border style to use for the lsp-signature plugin</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “none”, “single”, “double”, “rounded”, “solid”, “shadow” or list of (string or list of string)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"rounded"</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/plugins/ui/borders/borders.nix" target="_top"> +<nvf/modules/plugins/ui/borders/borders.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.borders.plugins.lspsaga.enable"></a><a class="term" href="options.html#opt-vim.ui.borders.plugins.lspsaga.enable"><code class="option">vim.ui.borders.plugins.lspsaga.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable borders for the lspsaga plugin.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/ui/borders/borders.nix" target="_top"> +<nvf/modules/plugins/ui/borders/borders.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.borders.plugins.lspsaga.style"></a><a class="term" href="options.html#opt-vim.ui.borders.plugins.lspsaga.style"><code class="option">vim.ui.borders.plugins.lspsaga.style</code> + </a> + </span> +</dt> +<dd> +<p>The border style to use for the lspsaga plugin</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “none”, “single”, “double”, “rounded”, “solid”, “shadow” or list of (string or list of string)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"rounded"</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/plugins/ui/borders/borders.nix" target="_top"> +<nvf/modules/plugins/ui/borders/borders.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.borders.plugins.nvim-cmp.enable"></a><a class="term" href="options.html#opt-vim.ui.borders.plugins.nvim-cmp.enable"><code class="option">vim.ui.borders.plugins.nvim-cmp.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable borders for the nvim-cmp plugin.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/ui/borders/borders.nix" target="_top"> +<nvf/modules/plugins/ui/borders/borders.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.borders.plugins.nvim-cmp.style"></a><a class="term" href="options.html#opt-vim.ui.borders.plugins.nvim-cmp.style"><code class="option">vim.ui.borders.plugins.nvim-cmp.style</code> + </a> + </span> +</dt> +<dd> +<p>The border style to use for the nvim-cmp plugin</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “none”, “single”, “double”, “rounded”, “solid”, “shadow” or list of (string or list of string)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"rounded"</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/plugins/ui/borders/borders.nix" target="_top"> +<nvf/modules/plugins/ui/borders/borders.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.borders.plugins.which-key.enable"></a><a class="term" href="options.html#opt-vim.ui.borders.plugins.which-key.enable"><code class="option">vim.ui.borders.plugins.which-key.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable borders for the which-key plugin.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/ui/borders/borders.nix" target="_top"> +<nvf/modules/plugins/ui/borders/borders.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.borders.plugins.which-key.style"></a><a class="term" href="options.html#opt-vim.ui.borders.plugins.which-key.style"><code class="option">vim.ui.borders.plugins.which-key.style</code> + </a> + </span> +</dt> +<dd> +<p>The border style to use for the which-key plugin</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “none”, “single”, “double”, “rounded”, “solid”, “shadow” or list of (string or list of string)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"rounded"</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/plugins/ui/borders/borders.nix" target="_top"> +<nvf/modules/plugins/ui/borders/borders.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.enable"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.enable"><code class="option">vim.ui.breadcrumbs.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable breadcrumbs.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.lualine.winbar.enable"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.lualine.winbar.enable"><code class="option">vim.ui.breadcrumbs.lualine.winbar.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to automatically configure a winbar component for +Lualine on the Winbar section.</p><div class="note"><h3 class="title">Note</h3><p>This is <span class="strong"><strong>set to <code class="literal">true</code> by default</strong></span>, which means nvim-navic +will occupy <code class="literal">winbar.lualine_c</code> for the breadcrumbs feature +unless this option is set to <code class="literal">false</code>.</p></div> + +<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>Example:</em></span> +<code class="literal">false</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.lualine.winbar.alwaysRender"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.lualine.winbar.alwaysRender"><code class="option">vim.ui.breadcrumbs.lualine.winbar.alwaysRender</code> + </a> + </span> +</dt> +<dd> +<p>Whether to always display the breadcrumbs component +on winbar.</p><div class="note"><h3 class="title">Note</h3><p>This will pass <code class="literal">draw_empty</code> to the <code class="literal">nvim_navic</code> winbar +component, which causes the component to be drawn even +if it’s empty</p></div> + +<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>Example:</em></span> +<code class="literal">false</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.enable"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.enable"><code class="option">vim.ui.breadcrumbs.navbuddy.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable navbuddy LSP helper UI. Enabling this option automatically loads and enables nvim-navic.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.mappings.appendName"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.mappings.appendName"><code class="option">vim.ui.breadcrumbs.navbuddy.mappings.appendName</code> + </a> + </span> +</dt> +<dd> +<p>insert at end of name</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"a"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.mappings.appendScope"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.mappings.appendScope"><code class="option">vim.ui.breadcrumbs.navbuddy.mappings.appendScope</code> + </a> + </span> +</dt> +<dd> +<p>insert at end of scope</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"A"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.mappings.children"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.mappings.children"><code class="option">vim.ui.breadcrumbs.navbuddy.mappings.children</code> + </a> + </span> +</dt> +<dd> +<p>keybinding to navigate to the child node</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"l"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.mappings.close"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.mappings.close"><code class="option">vim.ui.breadcrumbs.navbuddy.mappings.close</code> + </a> + </span> +</dt> +<dd> +<p>keybinding to close Navbuddy UI</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<esc>"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.mappings.comment"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.mappings.comment"><code class="option">vim.ui.breadcrumbs.navbuddy.mappings.comment</code> + </a> + </span> +</dt> +<dd> +<p>comment the node</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"c"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.mappings.delete"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.mappings.delete"><code class="option">vim.ui.breadcrumbs.navbuddy.mappings.delete</code> + </a> + </span> +</dt> +<dd> +<p>delete the node</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"d"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.mappings.foldCreate"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.mappings.foldCreate"><code class="option">vim.ui.breadcrumbs.navbuddy.mappings.foldCreate</code> + </a> + </span> +</dt> +<dd> +<p>create a new fold</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"f"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.mappings.foldDelete"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.mappings.foldDelete"><code class="option">vim.ui.breadcrumbs.navbuddy.mappings.foldDelete</code> + </a> + </span> +</dt> +<dd> +<p>delete the current fold</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"F"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.mappings.help"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.mappings.help"><code class="option">vim.ui.breadcrumbs.navbuddy.mappings.help</code> + </a> + </span> +</dt> +<dd> +<p>open mapping help window</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"g?"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.mappings.insertName"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.mappings.insertName"><code class="option">vim.ui.breadcrumbs.navbuddy.mappings.insertName</code> + </a> + </span> +</dt> +<dd> +<p>insert at start of name</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"i"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.mappings.insertScope"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.mappings.insertScope"><code class="option">vim.ui.breadcrumbs.navbuddy.mappings.insertScope</code> + </a> + </span> +</dt> +<dd> +<p>insert at start of scope</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"I"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.mappings.moveDown"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.mappings.moveDown"><code class="option">vim.ui.breadcrumbs.navbuddy.mappings.moveDown</code> + </a> + </span> +</dt> +<dd> +<p>move focused node down</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"J"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.mappings.moveUp"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.mappings.moveUp"><code class="option">vim.ui.breadcrumbs.navbuddy.mappings.moveUp</code> + </a> + </span> +</dt> +<dd> +<p>move focused node up</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"K"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.mappings.nextSibling"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.mappings.nextSibling"><code class="option">vim.ui.breadcrumbs.navbuddy.mappings.nextSibling</code> + </a> + </span> +</dt> +<dd> +<p>keybinding to navigate to the next sibling node</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"j"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.mappings.parent"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.mappings.parent"><code class="option">vim.ui.breadcrumbs.navbuddy.mappings.parent</code> + </a> + </span> +</dt> +<dd> +<p>keybinding to navigate to the parent node</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"h"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.mappings.previousSibling"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.mappings.previousSibling"><code class="option">vim.ui.breadcrumbs.navbuddy.mappings.previousSibling</code> + </a> + </span> +</dt> +<dd> +<p>keybinding to navigate to the previous sibling node</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"k"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.mappings.rename"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.mappings.rename"><code class="option">vim.ui.breadcrumbs.navbuddy.mappings.rename</code> + </a> + </span> +</dt> +<dd> +<p>rename the node</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"r"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.mappings.root"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.mappings.root"><code class="option">vim.ui.breadcrumbs.navbuddy.mappings.root</code> + </a> + </span> +</dt> +<dd> +<p>keybinding to navigate to the root node</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"0"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.mappings.select"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.mappings.select"><code class="option">vim.ui.breadcrumbs.navbuddy.mappings.select</code> + </a> + </span> +</dt> +<dd> +<p>goto selected symbol</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<enter>"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.mappings.telescope"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.mappings.telescope"><code class="option">vim.ui.breadcrumbs.navbuddy.mappings.telescope</code> + </a> + </span> +</dt> +<dd> +<p>fuzzy finder at current level</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"t"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.mappings.visualName"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.mappings.visualName"><code class="option">vim.ui.breadcrumbs.navbuddy.mappings.visualName</code> + </a> + </span> +</dt> +<dd> +<p>visual selection of name</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"v"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.mappings.visualScope"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.mappings.visualScope"><code class="option">vim.ui.breadcrumbs.navbuddy.mappings.visualScope</code> + </a> + </span> +</dt> +<dd> +<p>visual selection of scope</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"V"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.mappings.yankName"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.mappings.yankName"><code class="option">vim.ui.breadcrumbs.navbuddy.mappings.yankName</code> + </a> + </span> +</dt> +<dd> +<p>yank the name to system clipboard</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"y"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.mappings.yankScope"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.mappings.yankScope"><code class="option">vim.ui.breadcrumbs.navbuddy.mappings.yankScope</code> + </a> + </span> +</dt> +<dd> +<p>yank the scope to system clipboard</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"Y"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of navbuddy</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Array"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Array"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Array</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Boolean"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Boolean"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Boolean</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"◩ "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Class"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Class"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Class</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Constant"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Constant"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Constant</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Constructor"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Constructor"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Constructor</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Enum"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Enum"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Enum</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">""</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.EnumMember"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.EnumMember"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.EnumMember</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Event"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Event"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Event</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Field"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Field"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Field</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.File"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.File"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.File</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Function"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Function"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Function</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Interface"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Interface"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Interface</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">""</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Key"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Key"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Key</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Method"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Method"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Method</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Module"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Module"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Module</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Namespace"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Namespace"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Namespace</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Null"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Null"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Null</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Number"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Number"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Number</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Object"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Object"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Object</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Operator"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Operator"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Operator</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Package"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Package"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Package</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Property"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Property"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Property</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.String"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.String"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.String</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Struct"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Struct"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Struct</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.TypeParameter"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.TypeParameter"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.TypeParameter</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Variable"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Variable"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.icons.Variable</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.lsp.auto_attach"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.lsp.auto_attach"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.lsp.auto_attach</code> + </a> + </span> +</dt> +<dd> +<p>Whether to attach to LSP server manually</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.lsp.preference"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.lsp.preference"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.lsp.preference</code> + </a> + </span> +</dt> +<dd> +<p>list of lsp server names in order of preference</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or (list of string)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.node_markers.enable"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.node_markers.enable"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.node_markers.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable node markers.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.node_markers.icons.branch"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.node_markers.icons.branch"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.node_markers.icons.branch</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.node_markers.icons.leaf"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.node_markers.icons.leaf"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.node_markers.icons.leaf</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.node_markers.icons.leaf_selected"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.node_markers.icons.leaf_selected"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.node_markers.icons.leaf_selected</code> + </a> + </span> +</dt> +<dd> +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" → "</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.source_buffer.followNode"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.source_buffer.followNode"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.source_buffer.followNode</code> + </a> + </span> +</dt> +<dd> +<p>keep the current node in focus on the source buffer</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.source_buffer.highlight"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.source_buffer.highlight"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.source_buffer.highlight</code> + </a> + </span> +</dt> +<dd> +<p>highlight the currently focused node</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.source_buffer.reorient"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.source_buffer.reorient"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.source_buffer.reorient</code> + </a> + </span> +</dt> +<dd> +<p>reorient buffer after changing nodes</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “smart”, “top”, “mid”, “none”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"smart"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.source_buffer.scrolloff"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.source_buffer.scrolloff"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.source_buffer.scrolloff</code> + </a> + </span> +</dt> +<dd> +<p>scrolloff value when navbuddy is open</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.useDefaultMappings"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.useDefaultMappings"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.useDefaultMappings</code> + </a> + </span> +</dt> +<dd> +<p>use default Navbuddy keybindings (disables user-specified keybinds)</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.window.border"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.window.border"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.window.border</code> + </a> + </span> +</dt> +<dd> +<p>border style to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “none”, “single”, “double”, “rounded”, “solid”, “shadow” or list of (string or list of string)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"rounded"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.window.scrolloff"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.window.scrolloff"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.window.scrolloff</code> + </a> + </span> +</dt> +<dd> +<p>Scrolloff value within navbuddy window</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.window.sections.left.border"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.window.sections.left.border"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.window.sections.left.border</code> + </a> + </span> +</dt> +<dd> +<p>border style to use for the left section of Navbuddy UI</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “none”, “single”, “double”, “rounded”, “solid”, “shadow” or list of (string or list of string)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"rounded"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.window.sections.mid.border"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.window.sections.mid.border"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.window.sections.mid.border</code> + </a> + </span> +</dt> +<dd> +<p>border style to use for the middle section of Navbuddy UI</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “none”, “single”, “double”, “rounded”, “solid”, “shadow” or list of (string or list of string)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"rounded"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.window.sections.right.border"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.window.sections.right.border"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.window.sections.right.border</code> + </a> + </span> +</dt> +<dd> +<p>border style to use for the right section of Navbuddy UI</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “none”, “single”, “double”, “rounded”, “solid”, “shadow” or list of (string or list of string)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"rounded"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.navbuddy.setupOpts.window.sections.right.preview"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.navbuddy.setupOpts.window.sections.right.preview"><code class="option">vim.ui.breadcrumbs.navbuddy.setupOpts.window.sections.right.preview</code> + </a> + </span> +</dt> +<dd> +<p>display mode of the preview on the right section</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “leaf”, “always”, “never”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"leaf"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.breadcrumbs.source"></a><a class="term" href="options.html#opt-vim.ui.breadcrumbs.source"><code class="option">vim.ui.breadcrumbs.source</code> + </a> + </span> +</dt> +<dd> +<p>The source to be used for breadcrumbs component. Null means no breadcrumbs.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or value “nvim-navic” (singular enum)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"nvim-navic"</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/plugins/ui/breadcrumbs/breadcrumbs.nix" target="_top"> +<nvf/modules/plugins/ui/breadcrumbs/breadcrumbs.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.enable"></a><a class="term" href="options.html#opt-vim.ui.colorizer.enable"><code class="option">vim.ui.colorizer.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable color highlighting [nvim-colorizer.lua].</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts"><code class="option">vim.ui.colorizer.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of colorizer</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.filetypes"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.filetypes"><code class="option">vim.ui.colorizer.setupOpts.filetypes</code> + </a> + </span> +</dt> +<dd> +<p>Filetypes to enable on and their option overrides.</p><p>“*” means enable on all filetypes. Filetypes prefixed with “!” are disabled.</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of (submodule)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</code></p> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">{ + "!vim" = { }; + "*" = { }; + javascript = { + AARRGGBB = false; + }; +} +</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.filetypes._name_.AARRGGBB"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.filetypes._name_.AARRGGBB"><code class="option">vim.ui.colorizer.setupOpts.filetypes.<name>.AARRGGBB</code> + </a> + </span> +</dt> +<dd> +<p>Colorize 0xAARRGGBB hex codes</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.filetypes._name_.RGB"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.filetypes._name_.RGB"><code class="option">vim.ui.colorizer.setupOpts.filetypes.<name>.RGB</code> + </a> + </span> +</dt> +<dd> +<p>Colorize #RGB hex codes</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.filetypes._name_.RRGGBB"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.filetypes._name_.RRGGBB"><code class="option">vim.ui.colorizer.setupOpts.filetypes.<name>.RRGGBB</code> + </a> + </span> +</dt> +<dd> +<p>Colorize #RRGGBB hex codes</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.filetypes._name_.RRGGBBAA"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.filetypes._name_.RRGGBBAA"><code class="option">vim.ui.colorizer.setupOpts.filetypes.<name>.RRGGBBAA</code> + </a> + </span> +</dt> +<dd> +<p>Colorize #RRGGBBAA hex codes</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.filetypes._name_.always_update"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.filetypes._name_.always_update"><code class="option">vim.ui.colorizer.setupOpts.filetypes.<name>.always_update</code> + </a> + </span> +</dt> +<dd> +<p>Update color values even if buffer is not focused. Example use: cmp_menu, cmp_docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.filetypes._name_.css"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.filetypes._name_.css"><code class="option">vim.ui.colorizer.setupOpts.filetypes.<name>.css</code> + </a> + </span> +</dt> +<dd> +<p>Enable all CSS features: rgb_fn, hsl_fn, names, RGB, RRGGBB</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.filetypes._name_.css_fn"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.filetypes._name_.css_fn"><code class="option">vim.ui.colorizer.setupOpts.filetypes.<name>.css_fn</code> + </a> + </span> +</dt> +<dd> +<p>Enable all CSS <span class="emphasis"><em>functions</em></span>: rgb_fn, hsl_fn</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.filetypes._name_.hsl_fn"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.filetypes._name_.hsl_fn"><code class="option">vim.ui.colorizer.setupOpts.filetypes.<name>.hsl_fn</code> + </a> + </span> +</dt> +<dd> +<p>Colorize CSS hsl() and hsla() functions</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.filetypes._name_.mode"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.filetypes._name_.mode"><code class="option">vim.ui.colorizer.setupOpts.filetypes.<name>.mode</code> + </a> + </span> +</dt> +<dd> +<p>Set the display mode</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or one of “foreground”, “background”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.filetypes._name_.names"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.filetypes._name_.names"><code class="option">vim.ui.colorizer.setupOpts.filetypes.<name>.names</code> + </a> + </span> +</dt> +<dd> +<p>Colorize “Name” codes like Blue</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.filetypes._name_.rgb_fn"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.filetypes._name_.rgb_fn"><code class="option">vim.ui.colorizer.setupOpts.filetypes.<name>.rgb_fn</code> + </a> + </span> +</dt> +<dd> +<p>Colorize CSS rgb() and rgba() functions</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.filetypes._name_.sass"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.filetypes._name_.sass"><code class="option">vim.ui.colorizer.setupOpts.filetypes.<name>.sass</code> + </a> + </span> +</dt> +<dd> +<p>Enable sass colors</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.filetypes._name_.tailwind"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.filetypes._name_.tailwind"><code class="option">vim.ui.colorizer.setupOpts.filetypes.<name>.tailwind</code> + </a> + </span> +</dt> +<dd> +<p>Enable tailwind colors</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.filetypes._name_.virtualtext"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.filetypes._name_.virtualtext"><code class="option">vim.ui.colorizer.setupOpts.filetypes.<name>.virtualtext</code> + </a> + </span> +</dt> +<dd> +<p>String to display as virtualtext</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.user_default_options"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.user_default_options"><code class="option">vim.ui.colorizer.setupOpts.user_default_options</code> + </a> + </span> +</dt> +<dd> +<p>Default options</p> + +<p><span class="emphasis"><em>Type:</em></span> +submodule</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.user_default_options.AARRGGBB"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.user_default_options.AARRGGBB"><code class="option">vim.ui.colorizer.setupOpts.user_default_options.AARRGGBB</code> + </a> + </span> +</dt> +<dd> +<p>Colorize 0xAARRGGBB hex codes</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.user_default_options.RGB"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.user_default_options.RGB"><code class="option">vim.ui.colorizer.setupOpts.user_default_options.RGB</code> + </a> + </span> +</dt> +<dd> +<p>Colorize #RGB hex codes</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.user_default_options.RRGGBB"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.user_default_options.RRGGBB"><code class="option">vim.ui.colorizer.setupOpts.user_default_options.RRGGBB</code> + </a> + </span> +</dt> +<dd> +<p>Colorize #RRGGBB hex codes</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.user_default_options.RRGGBBAA"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.user_default_options.RRGGBBAA"><code class="option">vim.ui.colorizer.setupOpts.user_default_options.RRGGBBAA</code> + </a> + </span> +</dt> +<dd> +<p>Colorize #RRGGBBAA hex codes</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.user_default_options.always_update"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.user_default_options.always_update"><code class="option">vim.ui.colorizer.setupOpts.user_default_options.always_update</code> + </a> + </span> +</dt> +<dd> +<p>Update color values even if buffer is not focused. Example use: cmp_menu, cmp_docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.user_default_options.css"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.user_default_options.css"><code class="option">vim.ui.colorizer.setupOpts.user_default_options.css</code> + </a> + </span> +</dt> +<dd> +<p>Enable all CSS features: rgb_fn, hsl_fn, names, RGB, RRGGBB</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.user_default_options.css_fn"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.user_default_options.css_fn"><code class="option">vim.ui.colorizer.setupOpts.user_default_options.css_fn</code> + </a> + </span> +</dt> +<dd> +<p>Enable all CSS <span class="emphasis"><em>functions</em></span>: rgb_fn, hsl_fn</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.user_default_options.hsl_fn"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.user_default_options.hsl_fn"><code class="option">vim.ui.colorizer.setupOpts.user_default_options.hsl_fn</code> + </a> + </span> +</dt> +<dd> +<p>Colorize CSS hsl() and hsla() functions</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.user_default_options.mode"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.user_default_options.mode"><code class="option">vim.ui.colorizer.setupOpts.user_default_options.mode</code> + </a> + </span> +</dt> +<dd> +<p>Set the display mode</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or one of “foreground”, “background”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.user_default_options.names"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.user_default_options.names"><code class="option">vim.ui.colorizer.setupOpts.user_default_options.names</code> + </a> + </span> +</dt> +<dd> +<p>Colorize “Name” codes like Blue</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.user_default_options.rgb_fn"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.user_default_options.rgb_fn"><code class="option">vim.ui.colorizer.setupOpts.user_default_options.rgb_fn</code> + </a> + </span> +</dt> +<dd> +<p>Colorize CSS rgb() and rgba() functions</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.user_default_options.sass"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.user_default_options.sass"><code class="option">vim.ui.colorizer.setupOpts.user_default_options.sass</code> + </a> + </span> +</dt> +<dd> +<p>Enable sass colors</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.user_default_options.tailwind"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.user_default_options.tailwind"><code class="option">vim.ui.colorizer.setupOpts.user_default_options.tailwind</code> + </a> + </span> +</dt> +<dd> +<p>Enable tailwind colors</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.colorizer.setupOpts.user_default_options.virtualtext"></a><a class="term" href="options.html#opt-vim.ui.colorizer.setupOpts.user_default_options.virtualtext"><code class="option">vim.ui.colorizer.setupOpts.user_default_options.virtualtext</code> + </a> + </span> +</dt> +<dd> +<p>String to display as virtualtext</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/colorizer/colorizer.nix" target="_top"> +<nvf/modules/plugins/ui/colorizer/colorizer.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.fastaction.enable"></a><a class="term" href="options.html#opt-vim.ui.fastaction.enable"><code class="option">vim.ui.fastaction.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable overriding vim.ui.select with fastaction.nvim.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/ui/fastaction/fastaction-nvim.nix" target="_top"> +<nvf/modules/plugins/ui/fastaction/fastaction-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.fastaction.setupOpts"></a><a class="term" href="options.html#opt-vim.ui.fastaction.setupOpts"><code class="option">vim.ui.fastaction.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of fastaction</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/ui/fastaction/fastaction-nvim.nix" target="_top"> +<nvf/modules/plugins/ui/fastaction/fastaction-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.illuminate.enable"></a><a class="term" href="options.html#opt-vim.ui.illuminate.enable"><code class="option">vim.ui.illuminate.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable automatically highlight other uses of the word under the cursor [vim-illuminate].</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/ui/illuminate/illuminate.nix" target="_top"> +<nvf/modules/plugins/ui/illuminate/illuminate.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.modes-nvim.enable"></a><a class="term" href="options.html#opt-vim.ui.modes-nvim.enable"><code class="option">vim.ui.modes-nvim.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable modes.nvim’s prismatic line decorations.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/ui/modes/modes.nix" target="_top"> +<nvf/modules/plugins/ui/modes/modes.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.modes-nvim.setupOpts.colors"></a><a class="term" href="options.html#opt-vim.ui.modes-nvim.setupOpts.colors"><code class="option">vim.ui.modes-nvim.setupOpts.colors</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of modes.nvim</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/ui/modes/modes.nix" target="_top"> +<nvf/modules/plugins/ui/modes/modes.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.modes-nvim.setupOpts.colors.copy"></a><a class="term" href="options.html#opt-vim.ui.modes-nvim.setupOpts.colors.copy"><code class="option">vim.ui.modes-nvim.setupOpts.colors.copy</code> + </a> + </span> +</dt> +<dd> +<p>The #RRGGBB color code for the visual mode highlights</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"#f5c359"</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/plugins/ui/modes/modes.nix" target="_top"> +<nvf/modules/plugins/ui/modes/modes.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.modes-nvim.setupOpts.colors.delete"></a><a class="term" href="options.html#opt-vim.ui.modes-nvim.setupOpts.colors.delete"><code class="option">vim.ui.modes-nvim.setupOpts.colors.delete</code> + </a> + </span> +</dt> +<dd> +<p>The #RRGGBB color code for the visual mode highlights</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"#c75c6a"</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/plugins/ui/modes/modes.nix" target="_top"> +<nvf/modules/plugins/ui/modes/modes.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.modes-nvim.setupOpts.colors.insert"></a><a class="term" href="options.html#opt-vim.ui.modes-nvim.setupOpts.colors.insert"><code class="option">vim.ui.modes-nvim.setupOpts.colors.insert</code> + </a> + </span> +</dt> +<dd> +<p>The #RRGGBB color code for the visual mode highlights</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"#78ccc5"</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/plugins/ui/modes/modes.nix" target="_top"> +<nvf/modules/plugins/ui/modes/modes.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.modes-nvim.setupOpts.colors.visual"></a><a class="term" href="options.html#opt-vim.ui.modes-nvim.setupOpts.colors.visual"><code class="option">vim.ui.modes-nvim.setupOpts.colors.visual</code> + </a> + </span> +</dt> +<dd> +<p>The #RRGGBB color code for the visual mode highlights</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"#9745be"</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/plugins/ui/modes/modes.nix" target="_top"> +<nvf/modules/plugins/ui/modes/modes.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.modes-nvim.setupOpts.line_opacity.visual"></a><a class="term" href="options.html#opt-vim.ui.modes-nvim.setupOpts.line_opacity.visual"><code class="option">vim.ui.modes-nvim.setupOpts.line_opacity.visual</code> + </a> + </span> +</dt> +<dd> +<p>Set opacity for cursorline and number background</p> + +<p><span class="emphasis"><em>Type:</em></span> +floating point number</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">0.0</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/plugins/ui/modes/modes.nix" target="_top"> +<nvf/modules/plugins/ui/modes/modes.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.modes-nvim.setupOpts.setCursorline"></a><a class="term" href="options.html#opt-vim.ui.modes-nvim.setupOpts.setCursorline"><code class="option">vim.ui.modes-nvim.setupOpts.setCursorline</code> + </a> + </span> +</dt> +<dd> +<p>Set a colored cursorline on current line</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/ui/modes/modes.nix" target="_top"> +<nvf/modules/plugins/ui/modes/modes.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.noice.enable"></a><a class="term" href="options.html#opt-vim.ui.noice.enable"><code class="option">vim.ui.noice.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable noice.nvim UI modification library.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/ui/noice/noice.nix" target="_top"> +<nvf/modules/plugins/ui/noice/noice.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.noice.setupOpts"></a><a class="term" href="options.html#opt-vim.ui.noice.setupOpts"><code class="option">vim.ui.noice.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of noice.nvim</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/ui/noice/noice.nix" target="_top"> +<nvf/modules/plugins/ui/noice/noice.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.noice.setupOpts.format.cmdline"></a><a class="term" href="options.html#opt-vim.ui.noice.setupOpts.format.cmdline"><code class="option">vim.ui.noice.setupOpts.format.cmdline</code> + </a> + </span> +</dt> +<dd> +<p>formatting options for the cmdline</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or anything</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + icon = ""; + lang = "vim"; + pattern = "^:"; +} +</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/plugins/ui/noice/noice.nix" target="_top"> +<nvf/modules/plugins/ui/noice/noice.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.noice.setupOpts.format.filter"></a><a class="term" href="options.html#opt-vim.ui.noice.setupOpts.format.filter"><code class="option">vim.ui.noice.setupOpts.format.filter</code> + </a> + </span> +</dt> +<dd> +<p>formatting options for filter</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or anything</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + icon = ""; + lang = "bash"; + pattern = "^:%s*!"; +} +</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/plugins/ui/noice/noice.nix" target="_top"> +<nvf/modules/plugins/ui/noice/noice.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.noice.setupOpts.format.help"></a><a class="term" href="options.html#opt-vim.ui.noice.setupOpts.format.help"><code class="option">vim.ui.noice.setupOpts.format.help</code> + </a> + </span> +</dt> +<dd> +<p>formatting options for help</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or anything</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + icon = ""; + pattern = "^:%s*he?l?p?%s+"; +} +</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/plugins/ui/noice/noice.nix" target="_top"> +<nvf/modules/plugins/ui/noice/noice.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.noice.setupOpts.format.lua"></a><a class="term" href="options.html#opt-vim.ui.noice.setupOpts.format.lua"><code class="option">vim.ui.noice.setupOpts.format.lua</code> + </a> + </span> +</dt> +<dd> +<p>formatting options for lua</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or anything</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + icon = ""; + lang = "lua"; + pattern = "^:%s*lua%s+"; +} +</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/plugins/ui/noice/noice.nix" target="_top"> +<nvf/modules/plugins/ui/noice/noice.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.noice.setupOpts.format.search_down"></a><a class="term" href="options.html#opt-vim.ui.noice.setupOpts.format.search_down"><code class="option">vim.ui.noice.setupOpts.format.search_down</code> + </a> + </span> +</dt> +<dd> +<p>formatting options for search_down</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or anything</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + icon = " "; + kind = "search"; + lang = "regex"; + pattern = "^/"; +} +</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/plugins/ui/noice/noice.nix" target="_top"> +<nvf/modules/plugins/ui/noice/noice.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.noice.setupOpts.format.search_up"></a><a class="term" href="options.html#opt-vim.ui.noice.setupOpts.format.search_up"><code class="option">vim.ui.noice.setupOpts.format.search_up</code> + </a> + </span> +</dt> +<dd> +<p>formatting options for search_up</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or anything</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + icon = " "; + kind = "search"; + lang = "regex"; + pattern = "^%?"; +} +</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/plugins/ui/noice/noice.nix" target="_top"> +<nvf/modules/plugins/ui/noice/noice.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.noice.setupOpts.lsp.override._cmp.entry.get_documentation_"></a><a class="term" href="options.html#opt-vim.ui.noice.setupOpts.lsp.override._cmp.entry.get_documentation_"><code class="option">vim.ui.noice.setupOpts.lsp.override."cmp.entry.get_documentation"</code> + </a> + </span> +</dt> +<dd> +<p>override cmp documentation with Noice</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/ui/noice/noice.nix" target="_top"> +<nvf/modules/plugins/ui/noice/noice.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.noice.setupOpts.lsp.override._vim.lsp.util.convert_input_to_markdown_lines_"></a><a class="term" href="options.html#opt-vim.ui.noice.setupOpts.lsp.override._vim.lsp.util.convert_input_to_markdown_lines_"><code class="option">vim.ui.noice.setupOpts.lsp.override."vim.lsp.util.convert_input_to_markdown_lines"</code> + </a> + </span> +</dt> +<dd> +<p>override the default lsp markdown formatter with Noice</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/plugins/ui/noice/noice.nix" target="_top"> +<nvf/modules/plugins/ui/noice/noice.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.noice.setupOpts.lsp.override._vim.lsp.util.stylize_markdown_"></a><a class="term" href="options.html#opt-vim.ui.noice.setupOpts.lsp.override._vim.lsp.util.stylize_markdown_"><code class="option">vim.ui.noice.setupOpts.lsp.override."vim.lsp.util.stylize_markdown"</code> + </a> + </span> +</dt> +<dd> +<p>override the lsp markdown formatter with Noice</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/plugins/ui/noice/noice.nix" target="_top"> +<nvf/modules/plugins/ui/noice/noice.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.noice.setupOpts.lsp.signature.enabled"></a><a class="term" href="options.html#opt-vim.ui.noice.setupOpts.lsp.signature.enabled"><code class="option">vim.ui.noice.setupOpts.lsp.signature.enabled</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable signature help.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/ui/noice/noice.nix" target="_top"> +<nvf/modules/plugins/ui/noice/noice.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.noice.setupOpts.presets.bottom_search"></a><a class="term" href="options.html#opt-vim.ui.noice.setupOpts.presets.bottom_search"><code class="option">vim.ui.noice.setupOpts.presets.bottom_search</code> + </a> + </span> +</dt> +<dd> +<p>use a classic bottom cmdline for search</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/plugins/ui/noice/noice.nix" target="_top"> +<nvf/modules/plugins/ui/noice/noice.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.noice.setupOpts.presets.command_palette"></a><a class="term" href="options.html#opt-vim.ui.noice.setupOpts.presets.command_palette"><code class="option">vim.ui.noice.setupOpts.presets.command_palette</code> + </a> + </span> +</dt> +<dd> +<p>position the cmdline and popupmenu together</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/plugins/ui/noice/noice.nix" target="_top"> +<nvf/modules/plugins/ui/noice/noice.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.noice.setupOpts.presets.inc_rename"></a><a class="term" href="options.html#opt-vim.ui.noice.setupOpts.presets.inc_rename"><code class="option">vim.ui.noice.setupOpts.presets.inc_rename</code> + </a> + </span> +</dt> +<dd> +<p>enables an input dialog for inc-rename.nvim</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/ui/noice/noice.nix" target="_top"> +<nvf/modules/plugins/ui/noice/noice.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.noice.setupOpts.presets.long_message_to_split"></a><a class="term" href="options.html#opt-vim.ui.noice.setupOpts.presets.long_message_to_split"><code class="option">vim.ui.noice.setupOpts.presets.long_message_to_split</code> + </a> + </span> +</dt> +<dd> +<p>long messages will be sent to a split</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/plugins/ui/noice/noice.nix" target="_top"> +<nvf/modules/plugins/ui/noice/noice.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.noice.setupOpts.presets.lsp_doc_border"></a><a class="term" href="options.html#opt-vim.ui.noice.setupOpts.presets.lsp_doc_border"><code class="option">vim.ui.noice.setupOpts.presets.lsp_doc_border</code> + </a> + </span> +</dt> +<dd> +<p>add a border to hover docs and signature help</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/ui/noice/noice.nix" target="_top"> +<nvf/modules/plugins/ui/noice/noice.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.noice.setupOpts.routes"></a><a class="term" href="options.html#opt-vim.ui.noice.setupOpts.routes"><code class="option">vim.ui.noice.setupOpts.routes</code> + </a> + </span> +</dt> +<dd> +<p>How to route messages</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of (submodule)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"Hide written messages"</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/plugins/ui/noice/noice.nix" target="_top"> +<nvf/modules/plugins/ui/noice/noice.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.noice.setupOpts.routes._.filter"></a><a class="term" href="options.html#opt-vim.ui.noice.setupOpts.routes._.filter"><code class="option">vim.ui.noice.setupOpts.routes.*.filter</code> + </a> + </span> +</dt> +<dd> +<p>a filter for messages matching this route</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</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/plugins/ui/noice/noice.nix" target="_top"> +<nvf/modules/plugins/ui/noice/noice.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.noice.setupOpts.routes._.opts"></a><a class="term" href="options.html#opt-vim.ui.noice.setupOpts.routes._.opts"><code class="option">vim.ui.noice.setupOpts.routes.*.opts</code> + </a> + </span> +</dt> +<dd> +<p>options for the view and the route</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/noice/noice.nix" target="_top"> +<nvf/modules/plugins/ui/noice/noice.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.noice.setupOpts.routes._.view"></a><a class="term" href="options.html#opt-vim.ui.noice.setupOpts.routes._.view"><code class="option">vim.ui.noice.setupOpts.routes.*.view</code> + </a> + </span> +</dt> +<dd> +<p>how this route is viewed</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/ui/noice/noice.nix" target="_top"> +<nvf/modules/plugins/ui/noice/noice.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.nvim-ufo.enable"></a><a class="term" href="options.html#opt-vim.ui.nvim-ufo.enable"><code class="option">vim.ui.nvim-ufo.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable nvim-ufo.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/ui/nvim-ufo/nvim-ufo.nix" target="_top"> +<nvf/modules/plugins/ui/nvim-ufo/nvim-ufo.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.nvim-ufo.setupOpts"></a><a class="term" href="options.html#opt-vim.ui.nvim-ufo.setupOpts"><code class="option">vim.ui.nvim-ufo.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of nvim-ufo</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/ui/nvim-ufo/nvim-ufo.nix" target="_top"> +<nvf/modules/plugins/ui/nvim-ufo/nvim-ufo.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.smartcolumn.enable"></a><a class="term" href="options.html#opt-vim.ui.smartcolumn.enable"><code class="option">vim.ui.smartcolumn.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable line length indicator.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/ui/smartcolumn/smartcolumn.nix" target="_top"> +<nvf/modules/plugins/ui/smartcolumn/smartcolumn.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.smartcolumn.setupOpts"></a><a class="term" href="options.html#opt-vim.ui.smartcolumn.setupOpts"><code class="option">vim.ui.smartcolumn.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of smartcolumn.nvim</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/ui/smartcolumn/smartcolumn.nix" target="_top"> +<nvf/modules/plugins/ui/smartcolumn/smartcolumn.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.smartcolumn.setupOpts.colorcolumn"></a><a class="term" href="options.html#opt-vim.ui.smartcolumn.setupOpts.colorcolumn"><code class="option">vim.ui.smartcolumn.setupOpts.colorcolumn</code> + </a> + </span> +</dt> +<dd> +<p>The position at which the column will be displayed. Set to null to disable</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"120"</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/plugins/ui/smartcolumn/smartcolumn.nix" target="_top"> +<nvf/modules/plugins/ui/smartcolumn/smartcolumn.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.smartcolumn.setupOpts.custom_colorcolumn"></a><a class="term" href="options.html#opt-vim.ui.smartcolumn.setupOpts.custom_colorcolumn"><code class="option">vim.ui.smartcolumn.setupOpts.custom_colorcolumn</code> + </a> + </span> +</dt> +<dd> +<p>The position at which smart column should be displayed for each individual buffer type</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of (string or list of string)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</code></p> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">vim.ui.smartcolumn.setupOpts.custom_colorcolumn = { + nix = "110"; + ruby = "120"; + java = "130"; + go = ["90" "130"]; +}; + +</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/plugins/ui/smartcolumn/smartcolumn.nix" target="_top"> +<nvf/modules/plugins/ui/smartcolumn/smartcolumn.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.ui.smartcolumn.setupOpts.disabled_filetypes"></a><a class="term" href="options.html#opt-vim.ui.smartcolumn.setupOpts.disabled_filetypes"><code class="option">vim.ui.smartcolumn.setupOpts.disabled_filetypes</code> + </a> + </span> +</dt> +<dd> +<p>The filetypes smartcolumn will be disabled for.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "help" + "text" + "markdown" + "NvimTree" + "alpha" +] +</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/plugins/ui/smartcolumn/smartcolumn.nix" target="_top"> +<nvf/modules/plugins/ui/smartcolumn/smartcolumn.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.undoFile.enable"></a><a class="term" href="options.html#opt-vim.undoFile.enable"><code class="option">vim.undoFile.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable undofile for persistent undo behaviour.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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"> +<nvf/modules/neovim/init/basic.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.undoFile.path"></a><a class="term" href="options.html#opt-vim.undoFile.path"><code class="option">vim.undoFile.path</code> + </a> + </span> +</dt> +<dd> +<p>Path to the directory in which undo history will be stored</p> + +<p><span class="emphasis"><em>Type:</em></span> +string or (luaInline)</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting nix">mkLuaInline "vim.fn.stdpath('state') .. '/undo'" +</code></pre> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting nix">mkLuaInline "os.getenv('XDG_DATA_HOME') .. '/nvf/undo'" +</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/neovim/init/basic.nix" target="_top"> +<nvf/modules/neovim/init/basic.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.useSystemClipboard"></a><a class="term" href="options.html#opt-vim.useSystemClipboard"><code class="option">vim.useSystemClipboard</code> + </a> + </span> +</dt> +<dd> +<p>Make use of the clipboard for default yank and paste operations. Don’t use * and +</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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"> +<nvf/modules/neovim/init/basic.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.ccc.enable"></a><a class="term" href="options.html#opt-vim.utility.ccc.enable"><code class="option">vim.utility.ccc.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable ccc color picker for neovim.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/utility/ccc/ccc.nix" target="_top"> +<nvf/modules/plugins/utility/ccc/ccc.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.ccc.mappings.decrease10"></a><a class="term" href="options.html#opt-vim.utility.ccc.mappings.decrease10"><code class="option">vim.utility.ccc.mappings.decrease10</code> + </a> + </span> +</dt> +<dd> +<p>Decrease the value times delta of the slider</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<H>"</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/plugins/utility/ccc/ccc.nix" target="_top"> +<nvf/modules/plugins/utility/ccc/ccc.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.ccc.mappings.increase10"></a><a class="term" href="options.html#opt-vim.utility.ccc.mappings.increase10"><code class="option">vim.utility.ccc.mappings.increase10</code> + </a> + </span> +</dt> +<dd> +<p>Increase the value times delta of the slider</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<L>"</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/plugins/utility/ccc/ccc.nix" target="_top"> +<nvf/modules/plugins/utility/ccc/ccc.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.ccc.mappings.quit"></a><a class="term" href="options.html#opt-vim.utility.ccc.mappings.quit"><code class="option">vim.utility.ccc.mappings.quit</code> + </a> + </span> +</dt> +<dd> +<p>Cancel and close the UI without replace or insert</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<Esc>"</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/plugins/utility/ccc/ccc.nix" target="_top"> +<nvf/modules/plugins/utility/ccc/ccc.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.diffview-nvim.enable"></a><a class="term" href="options.html#opt-vim.utility.diffview-nvim.enable"><code class="option">vim.utility.diffview-nvim.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable diffview-nvim: cycle through diffs for all modified files for any git rev.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/utility/diffview/diffview.nix" target="_top"> +<nvf/modules/plugins/utility/diffview/diffview.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.diffview-nvim.setupOpts"></a><a class="term" href="options.html#opt-vim.utility.diffview-nvim.setupOpts"><code class="option">vim.utility.diffview-nvim.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of Fidget</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/utility/diffview/diffview.nix" target="_top"> +<nvf/modules/plugins/utility/diffview/diffview.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.icon-picker.enable"></a><a class="term" href="options.html#opt-vim.utility.icon-picker.enable"><code class="option">vim.utility.icon-picker.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable nerdfonts icon picker for nvim.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/utility/icon-picker/icon-picker.nix" target="_top"> +<nvf/modules/plugins/utility/icon-picker/icon-picker.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.images.image-nvim.enable"></a><a class="term" href="options.html#opt-vim.utility.images.image-nvim.enable"><code class="option">vim.utility.images.image-nvim.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable image support in Neovim [image.nvim].</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/utility/images/image-nvim/image-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.images.image-nvim.setupOpts"></a><a class="term" href="options.html#opt-vim.utility.images.image-nvim.setupOpts"><code class="option">vim.utility.images.image-nvim.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of image.nvim</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/utility/images/image-nvim/image-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.images.image-nvim.setupOpts.backend"></a><a class="term" href="options.html#opt-vim.utility.images.image-nvim.setupOpts.backend"><code class="option">vim.utility.images.image-nvim.setupOpts.backend</code> + </a> + </span> +</dt> +<dd> +<p>The backend to use for rendering images.</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>kitty - best in class, works great and is very snappy</p></li><li class="listitem"><p>ueberzug - backed by ueberzugpp, supports any terminal, +but has lower performance</p></li></ul></div> + +<p><span class="emphasis"><em>Type:</em></span> +one of “kitty”, “ueberzug”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"ueberzug"</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/plugins/utility/images/image-nvim/image-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.images.image-nvim.setupOpts.editorOnlyRenderWhenFocused"></a><a class="term" href="options.html#opt-vim.utility.images.image-nvim.setupOpts.editorOnlyRenderWhenFocused"><code class="option">vim.utility.images.image-nvim.setupOpts.editorOnlyRenderWhenFocused</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable only rendering images when the editor is focused.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/utility/images/image-nvim/image-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.images.image-nvim.setupOpts.hijackFilePatterns"></a><a class="term" href="options.html#opt-vim.utility.images.image-nvim.setupOpts.hijackFilePatterns"><code class="option">vim.utility.images.image-nvim.setupOpts.hijackFilePatterns</code> + </a> + </span> +</dt> +<dd> +<p>File patterns to hijack for image.nvim. This is useful for +filetypes that don’t have a dedicated integration.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "*.png" + "*.jpg" + "*.jpeg" + "*.gif" + "*.webp" +] +</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/plugins/utility/images/image-nvim/image-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.images.image-nvim.setupOpts.integrations.markdown.enable"></a><a class="term" href="options.html#opt-vim.utility.images.image-nvim.setupOpts.integrations.markdown.enable"><code class="option">vim.utility.images.image-nvim.setupOpts.integrations.markdown.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable image.nvim in markdown files.</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>Example:</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/plugins/utility/images/image-nvim/image-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.images.image-nvim.setupOpts.integrations.markdown.clearInInsertMode"></a><a class="term" href="options.html#opt-vim.utility.images.image-nvim.setupOpts.integrations.markdown.clearInInsertMode"><code class="option">vim.utility.images.image-nvim.setupOpts.integrations.markdown.clearInInsertMode</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable clearing of images when entering insert mode.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/utility/images/image-nvim/image-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.images.image-nvim.setupOpts.integrations.markdown.downloadRemoteImages"></a><a class="term" href="options.html#opt-vim.utility.images.image-nvim.setupOpts.integrations.markdown.downloadRemoteImages"><code class="option">vim.utility.images.image-nvim.setupOpts.integrations.markdown.downloadRemoteImages</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable downloading remote images.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/utility/images/image-nvim/image-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.images.image-nvim.setupOpts.integrations.markdown.filetypes"></a><a class="term" href="options.html#opt-vim.utility.images.image-nvim.setupOpts.integrations.markdown.filetypes"><code class="option">vim.utility.images.image-nvim.setupOpts.integrations.markdown.filetypes</code> + </a> + </span> +</dt> +<dd> +<p>Filetypes to enable image.nvim in. Markdown extensions +(i.e. quarto) can go here</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "markdown" + "vimwiki" +] +</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/plugins/utility/images/image-nvim/image-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.images.image-nvim.setupOpts.integrations.markdown.onlyRenderAtCursor"></a><a class="term" href="options.html#opt-vim.utility.images.image-nvim.setupOpts.integrations.markdown.onlyRenderAtCursor"><code class="option">vim.utility.images.image-nvim.setupOpts.integrations.markdown.onlyRenderAtCursor</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable only rendering images at cursor.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/utility/images/image-nvim/image-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.images.image-nvim.setupOpts.integrations.maxWidth"></a><a class="term" href="options.html#opt-vim.utility.images.image-nvim.setupOpts.integrations.maxWidth"><code class="option">vim.utility.images.image-nvim.setupOpts.integrations.maxWidth</code> + </a> + </span> +</dt> +<dd> +<p>The maximum width of images to render. Images larger than +this will be scaled down to fit within this width.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/utility/images/image-nvim/image-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.images.image-nvim.setupOpts.integrations.neorg.enable"></a><a class="term" href="options.html#opt-vim.utility.images.image-nvim.setupOpts.integrations.neorg.enable"><code class="option">vim.utility.images.image-nvim.setupOpts.integrations.neorg.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable image.nvim in Neorg files.</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>Example:</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/plugins/utility/images/image-nvim/image-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.images.image-nvim.setupOpts.integrations.neorg.clearInInsertMode"></a><a class="term" href="options.html#opt-vim.utility.images.image-nvim.setupOpts.integrations.neorg.clearInInsertMode"><code class="option">vim.utility.images.image-nvim.setupOpts.integrations.neorg.clearInInsertMode</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable clearing of images when entering insert mode.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/utility/images/image-nvim/image-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.images.image-nvim.setupOpts.integrations.neorg.downloadRemoteImages"></a><a class="term" href="options.html#opt-vim.utility.images.image-nvim.setupOpts.integrations.neorg.downloadRemoteImages"><code class="option">vim.utility.images.image-nvim.setupOpts.integrations.neorg.downloadRemoteImages</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable downloading remote images.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/utility/images/image-nvim/image-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.images.image-nvim.setupOpts.integrations.neorg.filetypes"></a><a class="term" href="options.html#opt-vim.utility.images.image-nvim.setupOpts.integrations.neorg.filetypes"><code class="option">vim.utility.images.image-nvim.setupOpts.integrations.neorg.filetypes</code> + </a> + </span> +</dt> +<dd> +<p>Filetypes to enable image.nvim in.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "neorg" +] +</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/plugins/utility/images/image-nvim/image-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.images.image-nvim.setupOpts.integrations.neorg.onlyRenderAtCursor"></a><a class="term" href="options.html#opt-vim.utility.images.image-nvim.setupOpts.integrations.neorg.onlyRenderAtCursor"><code class="option">vim.utility.images.image-nvim.setupOpts.integrations.neorg.onlyRenderAtCursor</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable only rendering images at cursor.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/utility/images/image-nvim/image-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.images.image-nvim.setupOpts.maxHeight"></a><a class="term" href="options.html#opt-vim.utility.images.image-nvim.setupOpts.maxHeight"><code class="option">vim.utility.images.image-nvim.setupOpts.maxHeight</code> + </a> + </span> +</dt> +<dd> +<p>The maximum height of images to render. Images larger than +this will be scaled down to fit within this height.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/utility/images/image-nvim/image-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.images.image-nvim.setupOpts.maxHeightWindowPercentage"></a><a class="term" href="options.html#opt-vim.utility.images.image-nvim.setupOpts.maxHeightWindowPercentage"><code class="option">vim.utility.images.image-nvim.setupOpts.maxHeightWindowPercentage</code> + </a> + </span> +</dt> +<dd> +<p>The maximum height of images to render as a percentage of the +window height. Images larger than this will be scaled down to +fit within this height.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">50</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/plugins/utility/images/image-nvim/image-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.images.image-nvim.setupOpts.maxWidthWindowPercentage"></a><a class="term" href="options.html#opt-vim.utility.images.image-nvim.setupOpts.maxWidthWindowPercentage"><code class="option">vim.utility.images.image-nvim.setupOpts.maxWidthWindowPercentage</code> + </a> + </span> +</dt> +<dd> +<p>The maximum width of images to render as a percentage of the +window width. Images larger than this will be scaled down to +fit within this width.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/utility/images/image-nvim/image-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.images.image-nvim.setupOpts.windowOverlapClear.enable"></a><a class="term" href="options.html#opt-vim.utility.images.image-nvim.setupOpts.windowOverlapClear.enable"><code class="option">vim.utility.images.image-nvim.setupOpts.windowOverlapClear.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable clearing of images when they overlap with the window.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/utility/images/image-nvim/image-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.images.image-nvim.setupOpts.windowOverlapClear.ftIgnore"></a><a class="term" href="options.html#opt-vim.utility.images.image-nvim.setupOpts.windowOverlapClear.ftIgnore"><code class="option">vim.utility.images.image-nvim.setupOpts.windowOverlapClear.ftIgnore</code> + </a> + </span> +</dt> +<dd> +<p>Filetypes to ignore window overlap clearing in.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "cmp_menu" + "cmp_docs" + "" +] +</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/plugins/utility/images/image-nvim/image-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/images/image-nvim/image-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.motion.hop.enable"></a><a class="term" href="options.html#opt-vim.utility.motion.hop.enable"><code class="option">vim.utility.motion.hop.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Hop.nvim plugin (easy motion).</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/utility/motion/hop/hop.nix" target="_top"> +<nvf/modules/plugins/utility/motion/hop/hop.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.motion.hop.mappings.hop"></a><a class="term" href="options.html#opt-vim.utility.motion.hop.mappings.hop"><code class="option">vim.utility.motion.hop.mappings.hop</code> + </a> + </span> +</dt> +<dd> +<p>Jump to occurrences [hop.nvim]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>h"</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/plugins/utility/motion/hop/hop.nix" target="_top"> +<nvf/modules/plugins/utility/motion/hop/hop.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.motion.leap.enable"></a><a class="term" href="options.html#opt-vim.utility.motion.leap.enable"><code class="option">vim.utility.motion.leap.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable leap.nvim plugin (easy motion).</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/utility/motion/leap/leap.nix" target="_top"> +<nvf/modules/plugins/utility/motion/leap/leap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.motion.leap.mappings.leapBackwardTill"></a><a class="term" href="options.html#opt-vim.utility.motion.leap.mappings.leapBackwardTill"><code class="option">vim.utility.motion.leap.mappings.leapBackwardTill</code> + </a> + </span> +</dt> +<dd> +<p>Leap backward till</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>sX"</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/plugins/utility/motion/leap/leap.nix" target="_top"> +<nvf/modules/plugins/utility/motion/leap/leap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.motion.leap.mappings.leapBackwardTo"></a><a class="term" href="options.html#opt-vim.utility.motion.leap.mappings.leapBackwardTo"><code class="option">vim.utility.motion.leap.mappings.leapBackwardTo</code> + </a> + </span> +</dt> +<dd> +<p>Leap backward to</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>sS"</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/plugins/utility/motion/leap/leap.nix" target="_top"> +<nvf/modules/plugins/utility/motion/leap/leap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.motion.leap.mappings.leapForwardTill"></a><a class="term" href="options.html#opt-vim.utility.motion.leap.mappings.leapForwardTill"><code class="option">vim.utility.motion.leap.mappings.leapForwardTill</code> + </a> + </span> +</dt> +<dd> +<p>Leap forward till</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>sx"</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/plugins/utility/motion/leap/leap.nix" target="_top"> +<nvf/modules/plugins/utility/motion/leap/leap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.motion.leap.mappings.leapForwardTo"></a><a class="term" href="options.html#opt-vim.utility.motion.leap.mappings.leapForwardTo"><code class="option">vim.utility.motion.leap.mappings.leapForwardTo</code> + </a> + </span> +</dt> +<dd> +<p>Leap forward to</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>ss"</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/plugins/utility/motion/leap/leap.nix" target="_top"> +<nvf/modules/plugins/utility/motion/leap/leap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.motion.leap.mappings.leapFromWindow"></a><a class="term" href="options.html#opt-vim.utility.motion.leap.mappings.leapFromWindow"><code class="option">vim.utility.motion.leap.mappings.leapFromWindow</code> + </a> + </span> +</dt> +<dd> +<p>Leap from window</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"gs"</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/plugins/utility/motion/leap/leap.nix" target="_top"> +<nvf/modules/plugins/utility/motion/leap/leap.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.motion.precognition.enable"></a><a class="term" href="options.html#opt-vim.utility.motion.precognition.enable"><code class="option">vim.utility.motion.precognition.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable assisted motion discovery[precognition.nvim].</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/utility/motion/precognition/precognition.nix" target="_top"> +<nvf/modules/plugins/utility/motion/precognition/precognition.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.motion.precognition.setupOpts"></a><a class="term" href="options.html#opt-vim.utility.motion.precognition.setupOpts"><code class="option">vim.utility.motion.precognition.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of precognition.nvim</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/utility/motion/precognition/precognition.nix" target="_top"> +<nvf/modules/plugins/utility/motion/precognition/precognition.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.motion.precognition.setupOpts.disabled_fts"></a><a class="term" href="options.html#opt-vim.utility.motion.precognition.setupOpts.disabled_fts"><code class="option">vim.utility.motion.precognition.setupOpts.disabled_fts</code> + </a> + </span> +</dt> +<dd> +<p>Filetypes that automatically disable ‘precognition’</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "startify" +] +</code></pre> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">["startify"]</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/plugins/utility/motion/precognition/precognition.nix" target="_top"> +<nvf/modules/plugins/utility/motion/precognition/precognition.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.motion.precognition.setupOpts.gutterHints"></a><a class="term" href="options.html#opt-vim.utility.motion.precognition.setupOpts.gutterHints"><code class="option">vim.utility.motion.precognition.setupOpts.gutterHints</code> + </a> + </span> +</dt> +<dd> +<p>What motions display and at what priority. Only appears in gutters</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of (submodule)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/utility/motion/precognition/precognition.nix" target="_top"> +<nvf/modules/plugins/utility/motion/precognition/precognition.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.motion.precognition.setupOpts.gutterHints._name_.prio"></a><a class="term" href="options.html#opt-vim.utility.motion.precognition.setupOpts.gutterHints._name_.prio"><code class="option">vim.utility.motion.precognition.setupOpts.gutterHints.<name>.prio</code> + </a> + </span> +</dt> +<dd> +<p>The priority of the hint</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">1</code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">10</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/plugins/utility/motion/precognition/precognition.nix" target="_top"> +<nvf/modules/plugins/utility/motion/precognition/precognition.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.motion.precognition.setupOpts.gutterHints._name_.text"></a><a class="term" href="options.html#opt-vim.utility.motion.precognition.setupOpts.gutterHints._name_.text"><code class="option">vim.utility.motion.precognition.setupOpts.gutterHints.<name>.text</code> + </a> + </span> +</dt> +<dd> +<p>The easier-to-read depiction of the motion</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</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/plugins/utility/motion/precognition/precognition.nix" target="_top"> +<nvf/modules/plugins/utility/motion/precognition/precognition.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.motion.precognition.setupOpts.highlightColor"></a><a class="term" href="options.html#opt-vim.utility.motion.precognition.setupOpts.highlightColor"><code class="option">vim.utility.motion.precognition.setupOpts.highlightColor</code> + </a> + </span> +</dt> +<dd> +<p>The highlight for the virtual text</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + link = "Comment"; +} +</code></pre> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">{ link = "Comment"; } +# or +{ foreground = "#0000FF"; background = "#000000"; }; + +</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/plugins/utility/motion/precognition/precognition.nix" target="_top"> +<nvf/modules/plugins/utility/motion/precognition/precognition.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.motion.precognition.setupOpts.hints"></a><a class="term" href="options.html#opt-vim.utility.motion.precognition.setupOpts.hints"><code class="option">vim.utility.motion.precognition.setupOpts.hints</code> + </a> + </span> +</dt> +<dd> +<p>What motions display, and at what priority</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of (submodule)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/utility/motion/precognition/precognition.nix" target="_top"> +<nvf/modules/plugins/utility/motion/precognition/precognition.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.motion.precognition.setupOpts.hints._name_.prio"></a><a class="term" href="options.html#opt-vim.utility.motion.precognition.setupOpts.hints._name_.prio"><code class="option">vim.utility.motion.precognition.setupOpts.hints.<name>.prio</code> + </a> + </span> +</dt> +<dd> +<p>The priority of the hint</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">1</code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">10</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/plugins/utility/motion/precognition/precognition.nix" target="_top"> +<nvf/modules/plugins/utility/motion/precognition/precognition.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.motion.precognition.setupOpts.hints._name_.text"></a><a class="term" href="options.html#opt-vim.utility.motion.precognition.setupOpts.hints._name_.text"><code class="option">vim.utility.motion.precognition.setupOpts.hints.<name>.text</code> + </a> + </span> +</dt> +<dd> +<p>The easier-to-read depiction of the motion</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</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/plugins/utility/motion/precognition/precognition.nix" target="_top"> +<nvf/modules/plugins/utility/motion/precognition/precognition.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.motion.precognition.setupOpts.showBlankVirtLine"></a><a class="term" href="options.html#opt-vim.utility.motion.precognition.setupOpts.showBlankVirtLine"><code class="option">vim.utility.motion.precognition.setupOpts.showBlankVirtLine</code> + </a> + </span> +</dt> +<dd> +<p>Whether to show a blank virtual line when no movements are shown</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/plugins/utility/motion/precognition/precognition.nix" target="_top"> +<nvf/modules/plugins/utility/motion/precognition/precognition.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.motion.precognition.setupOpts.startVisible"></a><a class="term" href="options.html#opt-vim.utility.motion.precognition.setupOpts.startVisible"><code class="option">vim.utility.motion.precognition.setupOpts.startVisible</code> + </a> + </span> +</dt> +<dd> +<p>Whether to start ‘precognition’ automatically</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/plugins/utility/motion/precognition/precognition.nix" target="_top"> +<nvf/modules/plugins/utility/motion/precognition/precognition.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.new-file-template.enable"></a><a class="term" href="options.html#opt-vim.utility.new-file-template.enable"><code class="option">vim.utility.new-file-template.enable</code> + </a> + </span> +</dt> +<dd> +<p>new-file-template.nvim: Automatically insert a template on new files in neovim.</p><div class="note"><h3 class="title">Note</h3><p>For custom templates add a directory containing <code class="literal">lua/templates/*.lua</code> +to <code class="literal">vim.additionalRuntimePaths</code>.</p></div><p>More documentation on the templates available at <a class="link" href="https://github.com/otavioschwanck/new-file-template.nvim?tab=readme-ov-file#creating-new-templates" target="_top">custom-template-docs</a></p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/utility/new-file-template/new-file-template.nix" target="_top"> +<nvf/modules/plugins/utility/new-file-template/new-file-template.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.new-file-template.setupOpts"></a><a class="term" href="options.html#opt-vim.utility.new-file-template.setupOpts"><code class="option">vim.utility.new-file-template.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of nvim-file-template.nvim</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/utility/new-file-template/new-file-template.nix" target="_top"> +<nvf/modules/plugins/utility/new-file-template/new-file-template.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.new-file-template.setupOpts.disableAutocmd"></a><a class="term" href="options.html#opt-vim.utility.new-file-template.setupOpts.disableAutocmd"><code class="option">vim.utility.new-file-template.setupOpts.disableAutocmd</code> + </a> + </span> +</dt> +<dd> +<p>Disable the autocmd that creates the template</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/utility/new-file-template/new-file-template.nix" target="_top"> +<nvf/modules/plugins/utility/new-file-template/new-file-template.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.new-file-template.setupOpts.disableFiletype"></a><a class="term" href="options.html#opt-vim.utility.new-file-template.setupOpts.disableFiletype"><code class="option">vim.utility.new-file-template.setupOpts.disableFiletype</code> + </a> + </span> +</dt> +<dd> +<p>Disable default templates for specific filetypes</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/utility/new-file-template/new-file-template.nix" target="_top"> +<nvf/modules/plugins/utility/new-file-template/new-file-template.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.new-file-template.setupOpts.disableInsert"></a><a class="term" href="options.html#opt-vim.utility.new-file-template.setupOpts.disableInsert"><code class="option">vim.utility.new-file-template.setupOpts.disableInsert</code> + </a> + </span> +</dt> +<dd> +<p>Enter insert mode after inserting the template</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/utility/new-file-template/new-file-template.nix" target="_top"> +<nvf/modules/plugins/utility/new-file-template/new-file-template.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.new-file-template.setupOpts.disableSpecific"></a><a class="term" href="options.html#opt-vim.utility.new-file-template.setupOpts.disableSpecific"><code class="option">vim.utility.new-file-template.setupOpts.disableSpecific</code> + </a> + </span> +</dt> +<dd> +<p>Disable specific regexp for the default templates.</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">"{ ruby = [\".*\"]; }"</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/plugins/utility/new-file-template/new-file-template.nix" target="_top"> +<nvf/modules/plugins/utility/new-file-template/new-file-template.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.new-file-template.setupOpts.suffixAsFiletype"></a><a class="term" href="options.html#opt-vim.utility.new-file-template.setupOpts.suffixAsFiletype"><code class="option">vim.utility.new-file-template.setupOpts.suffixAsFiletype</code> + </a> + </span> +</dt> +<dd> +<p>Use suffix of filename rather than <code class="literal">vim.bo.filetype</code> as filetype</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/utility/new-file-template/new-file-template.nix" target="_top"> +<nvf/modules/plugins/utility/new-file-template/new-file-template.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.outline.aerial-nvim.enable"></a><a class="term" href="options.html#opt-vim.utility.outline.aerial-nvim.enable"><code class="option">vim.utility.outline.aerial-nvim.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Aerial.nvim.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/utility/outline/aerial-nvim/aerial-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/outline/aerial-nvim/aerial-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.outline.aerial-nvim.mappings.toggle"></a><a class="term" href="options.html#opt-vim.utility.outline.aerial-nvim.mappings.toggle"><code class="option">vim.utility.outline.aerial-nvim.mappings.toggle</code> + </a> + </span> +</dt> +<dd> +<p>Toggle aerial window</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"gO"</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/plugins/utility/outline/aerial-nvim/aerial-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/outline/aerial-nvim/aerial-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.outline.aerial-nvim.setupOpts"></a><a class="term" href="options.html#opt-vim.utility.outline.aerial-nvim.setupOpts"><code class="option">vim.utility.outline.aerial-nvim.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of aerial.nvim</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/utility/outline/aerial-nvim/aerial-nvim.nix" target="_top"> +<nvf/modules/plugins/utility/outline/aerial-nvim/aerial-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.preview.glow.enable"></a><a class="term" href="options.html#opt-vim.utility.preview.glow.enable"><code class="option">vim.utility.preview.glow.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable markdown preview in neovim with glow.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/utility/preview/glow/glow.nix" target="_top"> +<nvf/modules/plugins/utility/preview/glow/glow.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.preview.glow.mappings.openPreview"></a><a class="term" href="options.html#opt-vim.utility.preview.glow.mappings.openPreview"><code class="option">vim.utility.preview.glow.mappings.openPreview</code> + </a> + </span> +</dt> +<dd> +<p>Open preview</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>p"</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/plugins/utility/preview/glow/glow.nix" target="_top"> +<nvf/modules/plugins/utility/preview/glow/glow.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.preview.markdownPreview.enable"></a><a class="term" href="options.html#opt-vim.utility.preview.markdownPreview.enable"><code class="option">vim.utility.preview.markdownPreview.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Markdown preview in neovim with markdown-preview.nvim.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/utility/preview/markdown-preview/markdown-preview.nix" target="_top"> +<nvf/modules/plugins/utility/preview/markdown-preview/markdown-preview.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.preview.markdownPreview.alwaysAllowPreview"></a><a class="term" href="options.html#opt-vim.utility.preview.markdownPreview.alwaysAllowPreview"><code class="option">vim.utility.preview.markdownPreview.alwaysAllowPreview</code> + </a> + </span> +</dt> +<dd> +<p>Allow preview on all filetypes</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/utility/preview/markdown-preview/markdown-preview.nix" target="_top"> +<nvf/modules/plugins/utility/preview/markdown-preview/markdown-preview.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.preview.markdownPreview.autoClose"></a><a class="term" href="options.html#opt-vim.utility.preview.markdownPreview.autoClose"><code class="option">vim.utility.preview.markdownPreview.autoClose</code> + </a> + </span> +</dt> +<dd> +<p>Automatically close the preview window after leaving a Markdown buffer</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/plugins/utility/preview/markdown-preview/markdown-preview.nix" target="_top"> +<nvf/modules/plugins/utility/preview/markdown-preview/markdown-preview.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.preview.markdownPreview.autoStart"></a><a class="term" href="options.html#opt-vim.utility.preview.markdownPreview.autoStart"><code class="option">vim.utility.preview.markdownPreview.autoStart</code> + </a> + </span> +</dt> +<dd> +<p>Automatically open the preview window after entering a Markdown buffer</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/utility/preview/markdown-preview/markdown-preview.nix" target="_top"> +<nvf/modules/plugins/utility/preview/markdown-preview/markdown-preview.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.preview.markdownPreview.broadcastServer"></a><a class="term" href="options.html#opt-vim.utility.preview.markdownPreview.broadcastServer"><code class="option">vim.utility.preview.markdownPreview.broadcastServer</code> + </a> + </span> +</dt> +<dd> +<p>Allow for outside and network wide connections</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/utility/preview/markdown-preview/markdown-preview.nix" target="_top"> +<nvf/modules/plugins/utility/preview/markdown-preview/markdown-preview.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.preview.markdownPreview.customIP"></a><a class="term" href="options.html#opt-vim.utility.preview.markdownPreview.customIP"><code class="option">vim.utility.preview.markdownPreview.customIP</code> + </a> + </span> +</dt> +<dd> +<p>IP-address to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">""</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/plugins/utility/preview/markdown-preview/markdown-preview.nix" target="_top"> +<nvf/modules/plugins/utility/preview/markdown-preview/markdown-preview.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.preview.markdownPreview.customPort"></a><a class="term" href="options.html#opt-vim.utility.preview.markdownPreview.customPort"><code class="option">vim.utility.preview.markdownPreview.customPort</code> + </a> + </span> +</dt> +<dd> +<p>Port to use</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">""</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/plugins/utility/preview/markdown-preview/markdown-preview.nix" target="_top"> +<nvf/modules/plugins/utility/preview/markdown-preview/markdown-preview.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.preview.markdownPreview.filetypes"></a><a class="term" href="options.html#opt-vim.utility.preview.markdownPreview.filetypes"><code class="option">vim.utility.preview.markdownPreview.filetypes</code> + </a> + </span> +</dt> +<dd> +<p>Allowed filetypes</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "markdown" +] +</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/plugins/utility/preview/markdown-preview/markdown-preview.nix" target="_top"> +<nvf/modules/plugins/utility/preview/markdown-preview/markdown-preview.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.preview.markdownPreview.lazyRefresh"></a><a class="term" href="options.html#opt-vim.utility.preview.markdownPreview.lazyRefresh"><code class="option">vim.utility.preview.markdownPreview.lazyRefresh</code> + </a> + </span> +</dt> +<dd> +<p>Only update preview when saving or leaving insert mode</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/utility/preview/markdown-preview/markdown-preview.nix" target="_top"> +<nvf/modules/plugins/utility/preview/markdown-preview/markdown-preview.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.surround.enable"></a><a class="term" href="options.html#opt-vim.utility.surround.enable"><code class="option">vim.utility.surround.enable</code> + </a> + </span> +</dt> +<dd> +<p>nvim-surround: add/change/delete surrounding delimiter pairs with ease. +Note that the default mappings deviate from upstreeam to avoid conflicts +with nvim-leap.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/utility/surround/surround.nix" target="_top"> +<nvf/modules/plugins/utility/surround/surround.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.surround.setupOpts"></a><a class="term" href="options.html#opt-vim.utility.surround.setupOpts"><code class="option">vim.utility.surround.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of nvim-surround</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/utility/surround/surround.nix" target="_top"> +<nvf/modules/plugins/utility/surround/surround.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.surround.setupOpts.keymaps.change"></a><a class="term" href="options.html#opt-vim.utility.surround.setupOpts.keymaps.change"><code class="option">vim.utility.surround.setupOpts.keymaps.change</code> + </a> + </span> +</dt> +<dd> +<p>keymap for change</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"gzr"</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/plugins/utility/surround/surround.nix" target="_top"> +<nvf/modules/plugins/utility/surround/surround.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.surround.setupOpts.keymaps.change_line"></a><a class="term" href="options.html#opt-vim.utility.surround.setupOpts.keymaps.change_line"><code class="option">vim.utility.surround.setupOpts.keymaps.change_line</code> + </a> + </span> +</dt> +<dd> +<p>keymap for change_line</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"gZR"</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/plugins/utility/surround/surround.nix" target="_top"> +<nvf/modules/plugins/utility/surround/surround.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.surround.setupOpts.keymaps.delete"></a><a class="term" href="options.html#opt-vim.utility.surround.setupOpts.keymaps.delete"><code class="option">vim.utility.surround.setupOpts.keymaps.delete</code> + </a> + </span> +</dt> +<dd> +<p>keymap for delete</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"gzd"</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/plugins/utility/surround/surround.nix" target="_top"> +<nvf/modules/plugins/utility/surround/surround.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.surround.setupOpts.keymaps.insert"></a><a class="term" href="options.html#opt-vim.utility.surround.setupOpts.keymaps.insert"><code class="option">vim.utility.surround.setupOpts.keymaps.insert</code> + </a> + </span> +</dt> +<dd> +<p>keymap for insert</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<C-g>z"</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/plugins/utility/surround/surround.nix" target="_top"> +<nvf/modules/plugins/utility/surround/surround.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.surround.setupOpts.keymaps.insert_line"></a><a class="term" href="options.html#opt-vim.utility.surround.setupOpts.keymaps.insert_line"><code class="option">vim.utility.surround.setupOpts.keymaps.insert_line</code> + </a> + </span> +</dt> +<dd> +<p>keymap for insert_line</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<C-g>Z"</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/plugins/utility/surround/surround.nix" target="_top"> +<nvf/modules/plugins/utility/surround/surround.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.surround.setupOpts.keymaps.normal"></a><a class="term" href="options.html#opt-vim.utility.surround.setupOpts.keymaps.normal"><code class="option">vim.utility.surround.setupOpts.keymaps.normal</code> + </a> + </span> +</dt> +<dd> +<p>keymap for normal</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"gz"</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/plugins/utility/surround/surround.nix" target="_top"> +<nvf/modules/plugins/utility/surround/surround.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.surround.setupOpts.keymaps.normal_cur"></a><a class="term" href="options.html#opt-vim.utility.surround.setupOpts.keymaps.normal_cur"><code class="option">vim.utility.surround.setupOpts.keymaps.normal_cur</code> + </a> + </span> +</dt> +<dd> +<p>keymap for normal_cur</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"gZ"</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/plugins/utility/surround/surround.nix" target="_top"> +<nvf/modules/plugins/utility/surround/surround.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.surround.setupOpts.keymaps.normal_cur_line"></a><a class="term" href="options.html#opt-vim.utility.surround.setupOpts.keymaps.normal_cur_line"><code class="option">vim.utility.surround.setupOpts.keymaps.normal_cur_line</code> + </a> + </span> +</dt> +<dd> +<p>keymap for normal_cur_line</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"gZZ"</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/plugins/utility/surround/surround.nix" target="_top"> +<nvf/modules/plugins/utility/surround/surround.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.surround.setupOpts.keymaps.normal_line"></a><a class="term" href="options.html#opt-vim.utility.surround.setupOpts.keymaps.normal_line"><code class="option">vim.utility.surround.setupOpts.keymaps.normal_line</code> + </a> + </span> +</dt> +<dd> +<p>keymap for normal_line</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"gzz"</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/plugins/utility/surround/surround.nix" target="_top"> +<nvf/modules/plugins/utility/surround/surround.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.surround.setupOpts.keymaps.visual"></a><a class="term" href="options.html#opt-vim.utility.surround.setupOpts.keymaps.visual"><code class="option">vim.utility.surround.setupOpts.keymaps.visual</code> + </a> + </span> +</dt> +<dd> +<p>keymap for visual</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"gz"</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/plugins/utility/surround/surround.nix" target="_top"> +<nvf/modules/plugins/utility/surround/surround.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.surround.setupOpts.keymaps.visual_line"></a><a class="term" href="options.html#opt-vim.utility.surround.setupOpts.keymaps.visual_line"><code class="option">vim.utility.surround.setupOpts.keymaps.visual_line</code> + </a> + </span> +</dt> +<dd> +<p>keymap for visual_line</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"gZ"</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/plugins/utility/surround/surround.nix" target="_top"> +<nvf/modules/plugins/utility/surround/surround.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.surround.useVendoredKeybindings"></a><a class="term" href="options.html#opt-vim.utility.surround.useVendoredKeybindings"><code class="option">vim.utility.surround.useVendoredKeybindings</code> + </a> + </span> +</dt> +<dd> +<p>Use alternative set of keybindings that avoids conflicts with other popular plugins, e.g. nvim-leap</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/plugins/utility/surround/surround.nix" target="_top"> +<nvf/modules/plugins/utility/surround/surround.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.vim-wakatime.enable"></a><a class="term" href="options.html#opt-vim.utility.vim-wakatime.enable"><code class="option">vim.utility.vim-wakatime.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable automatic time tracking and metrics generated from your programming activity [vim-wakatime] +.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/utility/wakatime/vim-wakatime.nix" target="_top"> +<nvf/modules/plugins/utility/wakatime/vim-wakatime.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.utility.vim-wakatime.cli-package"></a><a class="term" href="options.html#opt-vim.utility.vim-wakatime.cli-package"><code class="option">vim.utility.vim-wakatime.cli-package</code> + </a> + </span> +</dt> +<dd> +<p>The package that should be used for wakatime-cli. +Set as null to use the default path in <code class="envar">$XDG_DATA_HOME</code></p> + +<p><span class="emphasis"><em>Type:</em></span> +null or package</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal"><derivation wakatime-cli-1.102.3></code></p> + +<p><span class="emphasis"><em>Example:</em></span> +<code class="literal">null</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/plugins/utility/wakatime/vim-wakatime.nix" target="_top"> +<nvf/modules/plugins/utility/wakatime/vim-wakatime.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.viAlias"></a><a class="term" href="options.html#opt-vim.viAlias"><code class="option">vim.viAlias</code> + </a> + </span> +</dt> +<dd> +<p>Enable the <code class="literal">vi</code> alias for <code class="literal">nvim</code></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/wrapper/environment/options.nix" target="_top"> +<nvf/modules/wrapper/environment/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.vimAlias"></a><a class="term" href="options.html#opt-vim.vimAlias"><code class="option">vim.vimAlias</code> + </a> + </span> +</dt> +<dd> +<p>Enable the <code class="literal">vim</code> alias for <code class="literal">nvim</code></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/wrapper/environment/options.nix" target="_top"> +<nvf/modules/wrapper/environment/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.cellular-automaton.enable"></a><a class="term" href="options.html#opt-vim.visuals.cellular-automaton.enable"><code class="option">vim.visuals.cellular-automaton.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable cellular-automaton to help you cope with stubborn code [cellular-automaton].</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/visuals/cellular-automaton/cellular-automaton.nix" target="_top"> +<nvf/modules/plugins/visuals/cellular-automaton/cellular-automaton.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.cellular-automaton.animation.register"></a><a class="term" href="options.html#opt-vim.visuals.cellular-automaton.animation.register"><code class="option">vim.visuals.cellular-automaton.animation.register</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable registering configured animation(s) automatically.</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>Example:</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/plugins/visuals/cellular-automaton/cellular-automaton.nix" target="_top"> +<nvf/modules/plugins/visuals/cellular-automaton/cellular-automaton.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.cellular-automaton.animation.setup"></a><a class="term" href="options.html#opt-vim.visuals.cellular-automaton.animation.setup"><code class="option">vim.visuals.cellular-automaton.animation.setup</code> + </a> + </span> +</dt> +<dd> +<p>Configuration used to generate an animation to be registered.</p><p>The final value for <code class="literal">ca_config</code> will be used to register a new +animation using <code class="literal">require("cellular-automaton").register_animation(ca_config)</code></p><div class="warning"><h3 class="title">Warning</h3><p><code class="literal">ca_config</code> <span class="strong"><strong>must</strong></span> eval to a valid Lua table. nvf does not and cannot +perform any kind of validation on your Lua code, so bogus values will +result in errors when the animation is registered.</p></div> + +<p><span class="emphasis"><em>Type:</em></span> +luaInline</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + _type = "lua-inline"; + expr = '' + local ca_config = { + fps = 50, + name = 'slide', + } + + -- init function is invoked only once at the start + -- config.init = function (grid) + -- + -- end + + -- update function + ca_config.update = function (grid) + for i = 1, #grid do + local prev = grid[i][#(grid[i])] + for j = 1, #(grid[i]) do + grid[i][j], prev = prev, grid[i][j] + end + end + return true + end + ''; +} +</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/plugins/visuals/cellular-automaton/cellular-automaton.nix" target="_top"> +<nvf/modules/plugins/visuals/cellular-automaton/cellular-automaton.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.cellular-automaton.mappings.makeItRain"></a><a class="term" href="options.html#opt-vim.visuals.cellular-automaton.mappings.makeItRain"><code class="option">vim.visuals.cellular-automaton.mappings.makeItRain</code> + </a> + </span> +</dt> +<dd> +<p>Make it rain [cellular-automaton]</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"<leader>fml"</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/plugins/visuals/cellular-automaton/cellular-automaton.nix" target="_top"> +<nvf/modules/plugins/visuals/cellular-automaton/cellular-automaton.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.cinnamon-nvim.enable"></a><a class="term" href="options.html#opt-vim.visuals.cinnamon-nvim.enable"><code class="option">vim.visuals.cinnamon-nvim.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable smooth scrolling for ANY command [cinnamon-nvim].</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/visuals/cinnamon-nvim/cinnamon-nvim.nix" target="_top"> +<nvf/modules/plugins/visuals/cinnamon-nvim/cinnamon-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.cinnamon-nvim.setupOpts"></a><a class="term" href="options.html#opt-vim.visuals.cinnamon-nvim.setupOpts"><code class="option">vim.visuals.cinnamon-nvim.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of cinnamon.nvim</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/visuals/cinnamon-nvim/cinnamon-nvim.nix" target="_top"> +<nvf/modules/plugins/visuals/cinnamon-nvim/cinnamon-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.cinnamon-nvim.setupOpts.keymaps.basic"></a><a class="term" href="options.html#opt-vim.visuals.cinnamon-nvim.setupOpts.keymaps.basic"><code class="option">vim.visuals.cinnamon-nvim.setupOpts.keymaps.basic</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable basic animation keymaps.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/visuals/cinnamon-nvim/cinnamon-nvim.nix" target="_top"> +<nvf/modules/plugins/visuals/cinnamon-nvim/cinnamon-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.cinnamon-nvim.setupOpts.keymaps.extra"></a><a class="term" href="options.html#opt-vim.visuals.cinnamon-nvim.setupOpts.keymaps.extra"><code class="option">vim.visuals.cinnamon-nvim.setupOpts.keymaps.extra</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable extra animation keymaps.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/visuals/cinnamon-nvim/cinnamon-nvim.nix" target="_top"> +<nvf/modules/plugins/visuals/cinnamon-nvim/cinnamon-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.cinnamon-nvim.setupOpts.options"></a><a class="term" href="options.html#opt-vim.visuals.cinnamon-nvim.setupOpts.options"><code class="option">vim.visuals.cinnamon-nvim.setupOpts.options</code> + </a> + </span> +</dt> +<dd> +<p>Scroll options</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + count_only = false; + mode = "cursor"; +} +</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/plugins/visuals/cinnamon-nvim/cinnamon-nvim.nix" target="_top"> +<nvf/modules/plugins/visuals/cinnamon-nvim/cinnamon-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.enable"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.enable"><code class="option">vim.visuals.fidget-nvim.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable nvim LSP UI element [fidget-nvim].</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts"><code class="option">vim.visuals.fidget-nvim.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of Fidget</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.integration.nvim-tree.enable"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.integration.nvim-tree.enable"><code class="option">vim.visuals.fidget-nvim.setupOpts.integration.nvim-tree.enable</code> + </a> + </span> +</dt> +<dd> +<p>Integrate with nvim-tree/nvim-tree.lua (if enabled)</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.integration.xcodebuild-nvim.enable"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.integration.xcodebuild-nvim.enable"><code class="option">vim.visuals.fidget-nvim.setupOpts.integration.xcodebuild-nvim.enable</code> + </a> + </span> +</dt> +<dd> +<p>Integrate with wojciech-kulik/xcodebuild.nvim (if enabled)</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.logger.float_precision"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.logger.float_precision"><code class="option">vim.visuals.fidget-nvim.setupOpts.logger.float_precision</code> + </a> + </span> +</dt> +<dd> +<p>Limit the number of decimals displayed for floats</p> + +<p><span class="emphasis"><em>Type:</em></span> +floating point number</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">0.01</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.logger.level"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.logger.level"><code class="option">vim.visuals.fidget-nvim.setupOpts.logger.level</code> + </a> + </span> +</dt> +<dd> +<p>Minimum logging level</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “debug”, “error”, “info”, “trace”, “warn”, “off”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"warn"</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.logger.max_size"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.logger.max_size"><code class="option">vim.visuals.fidget-nvim.setupOpts.logger.max_size</code> + </a> + </span> +</dt> +<dd> +<p>Maximum log file size, in KB</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">10000</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.logger.path"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.logger.path"><code class="option">vim.visuals.fidget-nvim.setupOpts.logger.path</code> + </a> + </span> +</dt> +<dd> +<p>Where Fidget writes its logs to</p> + +<p><span class="emphasis"><em>Type:</em></span> +luaInline</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + _type = "lua-inline"; + expr = '' + string.format("%s/fidget.nvim.log", vim.fn.stdpath("cache")) + ''; +} +</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.notification.configs"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.notification.configs"><code class="option">vim.visuals.fidget-nvim.setupOpts.notification.configs</code> + </a> + </span> +</dt> +<dd> +<p>How to configure notification groups when instantiated</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of (luaInline)</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + default = { + _type = "lua-inline"; + expr = "require('fidget.notification').default_config"; + }; +} +</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.notification.filter"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.notification.filter"><code class="option">vim.visuals.fidget-nvim.setupOpts.notification.filter</code> + </a> + </span> +</dt> +<dd> +<p>Minimum notifications level</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “debug”, “info”, “warn”, “error”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"info"</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.notification.history_size"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.notification.history_size"><code class="option">vim.visuals.fidget-nvim.setupOpts.notification.history_size</code> + </a> + </span> +</dt> +<dd> +<p>Number of removed messages to retain in history</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">128</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.notification.override_vim_notify"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.notification.override_vim_notify"><code class="option">vim.visuals.fidget-nvim.setupOpts.notification.override_vim_notify</code> + </a> + </span> +</dt> +<dd> +<p>Automatically override vim.notify() with Fidget</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.notification.poll_rate"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.notification.poll_rate"><code class="option">vim.visuals.fidget-nvim.setupOpts.notification.poll_rate</code> + </a> + </span> +</dt> +<dd> +<p>How frequently to update and render notifications</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">10</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.notification.redirect"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.notification.redirect"><code class="option">vim.visuals.fidget-nvim.setupOpts.notification.redirect</code> + </a> + </span> +</dt> +<dd> +<p>Conditionally redirect notifications to another backend</p> + +<p><span class="emphasis"><em>Type:</em></span> +luaInline</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + _type = "lua-inline"; + expr = '' + function(msg, level, opts) + if opts and opts.on_open then + return require("fidget.integration.nvim-notify").delegate(msg, level, opts) + end + end + ''; +} +</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.notification.view.group_separator"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.notification.view.group_separator"><code class="option">vim.visuals.fidget-nvim.setupOpts.notification.view.group_separator</code> + </a> + </span> +</dt> +<dd> +<p>Separator between notification groups</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"---"</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.notification.view.group_separator_hl"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.notification.view.group_separator_hl"><code class="option">vim.visuals.fidget-nvim.setupOpts.notification.view.group_separator_hl</code> + </a> + </span> +</dt> +<dd> +<p>Highlight group used for group separator</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"Comment"</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.notification.view.icon_separator"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.notification.view.icon_separator"><code class="option">vim.visuals.fidget-nvim.setupOpts.notification.view.icon_separator</code> + </a> + </span> +</dt> +<dd> +<p>Separator between group name and icon</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.notification.view.render_message"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.notification.view.render_message"><code class="option">vim.visuals.fidget-nvim.setupOpts.notification.view.render_message</code> + </a> + </span> +</dt> +<dd> +<p>How to render notification messages</p> + +<p><span class="emphasis"><em>Type:</em></span> +luaInline</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + _type = "lua-inline"; + expr = '' + function(msg, cnt) + return cnt == 1 and msg or string.format("(%dx) %s", cnt, msg) + end + ''; +} +</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.notification.view.stack_upwards"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.notification.view.stack_upwards"><code class="option">vim.visuals.fidget-nvim.setupOpts.notification.view.stack_upwards</code> + </a> + </span> +</dt> +<dd> +<p>Display notification items from bottom to top</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.notification.window.align"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.notification.window.align"><code class="option">vim.visuals.fidget-nvim.setupOpts.notification.window.align</code> + </a> + </span> +</dt> +<dd> +<p>How to align the notification window</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “top”, “bottom”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"bottom"</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.notification.window.border"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.notification.window.border"><code class="option">vim.visuals.fidget-nvim.setupOpts.notification.window.border</code> + </a> + </span> +</dt> +<dd> +<p>Border style of the notification window</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “none”, “single”, “double”, “rounded”, “solid”, “shadow” or list of (string or list of string)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"none"</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.notification.window.max_height"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.notification.window.max_height"><code class="option">vim.visuals.fidget-nvim.setupOpts.notification.window.max_height</code> + </a> + </span> +</dt> +<dd> +<p>Maximum height of the notification window</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">0</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.notification.window.max_width"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.notification.window.max_width"><code class="option">vim.visuals.fidget-nvim.setupOpts.notification.window.max_width</code> + </a> + </span> +</dt> +<dd> +<p>Maximum width of the notification window</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">0</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.notification.window.normal_hl"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.notification.window.normal_hl"><code class="option">vim.visuals.fidget-nvim.setupOpts.notification.window.normal_hl</code> + </a> + </span> +</dt> +<dd> +<p>Base highlight group in the notification window</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"Comment"</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.notification.window.relative"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.notification.window.relative"><code class="option">vim.visuals.fidget-nvim.setupOpts.notification.window.relative</code> + </a> + </span> +</dt> +<dd> +<p>What the notification window position is relative to</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “editor”, “win”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"editor"</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.notification.window.winblend"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.notification.window.winblend"><code class="option">vim.visuals.fidget-nvim.setupOpts.notification.window.winblend</code> + </a> + </span> +</dt> +<dd> +<p>Background color opacity in the notification window</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">100</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.notification.window.x_padding"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.notification.window.x_padding"><code class="option">vim.visuals.fidget-nvim.setupOpts.notification.window.x_padding</code> + </a> + </span> +</dt> +<dd> +<p>Padding from right edge of window boundary</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">1</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.notification.window.y_padding"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.notification.window.y_padding"><code class="option">vim.visuals.fidget-nvim.setupOpts.notification.window.y_padding</code> + </a> + </span> +</dt> +<dd> +<p>Padding from bottom edge of window boundary</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">0</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.notification.window.zindex"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.notification.window.zindex"><code class="option">vim.visuals.fidget-nvim.setupOpts.notification.window.zindex</code> + </a> + </span> +</dt> +<dd> +<p>Stacking priority of the notification window</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">45</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.done_icon"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.done_icon"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.done_icon</code> + </a> + </span> +</dt> +<dd> +<p>Icon shown when LSP progress tasks are completed</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"✓"</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.done_style"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.done_style"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.done_style</code> + </a> + </span> +</dt> +<dd> +<p>Highlight group for completed LSP tasks</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"Constant"</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.done_ttl"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.done_ttl"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.done_ttl</code> + </a> + </span> +</dt> +<dd> +<p>How long a message should persist when complete</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">3</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.format_annote"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.format_annote"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.format_annote</code> + </a> + </span> +</dt> +<dd> +<p>How to format a progress annotation</p> + +<p><span class="emphasis"><em>Type:</em></span> +luaInline</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + _type = "lua-inline"; + expr = '' + function(msg) return msg.title end + ''; +} +</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.format_group_name"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.format_group_name"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.format_group_name</code> + </a> + </span> +</dt> +<dd> +<p>How to format a progress notification group’s name</p> + +<p><span class="emphasis"><em>Type:</em></span> +luaInline</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + _type = "lua-inline"; + expr = '' + function(group) return tostring(group) end + ''; +} +</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.format_message"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.format_message"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.format_message</code> + </a> + </span> +</dt> +<dd> +<p>How to format a progress message</p> + +<p><span class="emphasis"><em>Type:</em></span> +luaInline</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + _type = "lua-inline"; + expr = '' + require("fidget.progress.display").default_format_message + ''; +} +</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.group_style"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.group_style"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.group_style</code> + </a> + </span> +</dt> +<dd> +<p>Highlight group for group name (LSP server name)</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"Title"</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.icon_style"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.icon_style"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.icon_style</code> + </a> + </span> +</dt> +<dd> +<p>Highlight group for group icons</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"Question"</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.overrides</code> + </a> + </span> +</dt> +<dd> +<p>Overrides the default configuration for a notification group defined +in <a class="xref" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.notification.configs" ><code class="option">vim.visuals.fidget-nvim.setupOpts.notification.configs</code></a>.</p><p>If any of the fields are null, the value from the default +configuration is used.</p><p>If default configuration is not defined, the following defaults are used:</p><pre><code class="programlisting lua"> { + name = "Notifications", + icon = "❰❰", + ttl = 5, + group_style = "Title", + icon_style = "Special", + annote_style = "Question", + debug_style = "Comment", + info_style = "Question", + warn_style = "WarningMsg", + error_style = "ErrorMsg", + debug_annote = "DEBUG", + info_annote = "INFO", + warn_annote = "WARN", + error_annote = "ERROR", + update_hook = function(item) + notification.set_content_key(item) + end, + } +</code></pre> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of (submodule)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</code></p> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">{ + rust_analyzer = { + name = "Rust Analyzer"; + }; +} + +</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.annote_separator"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.annote_separator"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.annote_separator</code> + </a> + </span> +</dt> +<dd> +<p>Separator between message from annote</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">" "</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.annote_style"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.annote_style"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.annote_style</code> + </a> + </span> +</dt> +<dd> +<p>Default style used to highlight item annotes</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"Question"</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.debug_annote"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.debug_annote"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.debug_annote</code> + </a> + </span> +</dt> +<dd> +<p>Default annotation for debug items</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.debug_style"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.debug_style"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.debug_style</code> + </a> + </span> +</dt> +<dd> +<p>Style used to highlight debug item annotes</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.error_annote"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.error_annote"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.error_annote</code> + </a> + </span> +</dt> +<dd> +<p>Default annotation for error items</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.error_style"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.error_style"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.error_style</code> + </a> + </span> +</dt> +<dd> +<p>Style used to highlight error item annotes</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.group_style"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.group_style"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.group_style</code> + </a> + </span> +</dt> +<dd> +<p>Style used to highlight group name</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"Title"</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.icon"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.icon"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.icon</code> + </a> + </span> +</dt> +<dd> +<p>Icon of the group, displayed in the notification window. +Can be a string or a function that returns a string.</p><p>If a function, it is invoked every render cycle with the items +list, useful for rendering animations and other dynamic content.</p><div class="note"><h3 class="title">Note</h3><p>If you’re looking for detailed information into the function +signature, you can refer to the fidget API documentation available +<a class="link" href="https://github.com/j-hui/fidget.nvim/blob/1ba38e4cbb24683973e00c2e36f53ae64da38ef5/doc/fidget-api.txt#L70-L77" target="_top">here</a></p></div> + +<p><span class="emphasis"><em>Type:</em></span> +null or string or (luaInline)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.icon_on_left"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.icon_on_left"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.icon_on_left</code> + </a> + </span> +</dt> +<dd> +<p>If true, icon is rendered on the left instead of right</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.icon_style"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.icon_style"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.icon_style</code> + </a> + </span> +</dt> +<dd> +<p>Style used to highlight icon, if null, use group_style</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.info_annote"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.info_annote"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.info_annote</code> + </a> + </span> +</dt> +<dd> +<p>Default annotation for info items</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.info_style"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.info_style"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.info_style</code> + </a> + </span> +</dt> +<dd> +<p>Style used to highlight info item annotes</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.name"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.name"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.name</code> + </a> + </span> +</dt> +<dd> +<p>Name of the group, displayed in the notification window. +Can be a string or a function that returns a string.</p><p>If a function, it is invoked every render cycle with the items +list, useful for rendering animations and other dynamic content.</p><div class="note"><h3 class="title">Note</h3><p>If you’re looking for detailed information into the function +signature, you can refer to the fidget API documentation available +<a class="link" href="https://github.com/j-hui/fidget.nvim/blob/1ba38e4cbb24683973e00c2e36f53ae64da38ef5/doc/fidget-api.txt#L70-L77" target="_top">here</a></p></div> + +<p><span class="emphasis"><em>Type:</em></span> +null or string or (luaInline)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.priority"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.priority"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.priority</code> + </a> + </span> +</dt> +<dd> +<p>Order in which group should be displayed</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">50</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.render_limit"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.render_limit"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.render_limit</code> + </a> + </span> +</dt> +<dd> +<p>How many notification items to show at once</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.skip_history"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.skip_history"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.skip_history</code> + </a> + </span> +</dt> +<dd> +<p>Whether messages should be preserved in history</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.ttl"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.ttl"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.ttl</code> + </a> + </span> +</dt> +<dd> +<p>How long a notification item should exist</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">5</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.update_hook"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.update_hook"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.update_hook</code> + </a> + </span> +</dt> +<dd> +<p>Called when an item is updated.</p><p>If false, no action is taken. +If a function, it is invoked with the item being updated.</p><div class="note"><h3 class="title">Note</h3><p>If you’re looking for detailed information into the function +signature, you can refer to the fidget API documentation available +<a class="link" href="https://github.com/j-hui/fidget.nvim/blob/1ba38e4cbb24683973e00c2e36f53ae64da38ef5/doc/fidget-api.txt#L114" target="_top">here</a></p></div> + +<p><span class="emphasis"><em>Type:</em></span> +null or boolean or (luaInline)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.warn_annote"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.warn_annote"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.warn_annote</code> + </a> + </span> +</dt> +<dd> +<p>Default annotation for warn items</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.warn_style"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides._name_.warn_style"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.overrides.<name>.warn_style</code> + </a> + </span> +</dt> +<dd> +<p>Style used to highlight warn item annotes</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.priority"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.priority"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.priority</code> + </a> + </span> +</dt> +<dd> +<p>Priority of the progress notification</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">30</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.progress_icon.pattern"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.progress_icon.pattern"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.progress_icon.pattern</code> + </a> + </span> +</dt> +<dd> +<p>Pattern shown when LSP progress tasks are in progress</p> + +<p><span class="emphasis"><em>Type:</em></span> +one of “dots”, “dots_negative”, “dots_snake”, “dots_footsteps”, “dots_hop”, “line”, “pipe”, “dots_ellipsis”, “dots_scrolling”, “star”, “flip”, “hamburger”, “grow_vertical”, “grow_horizontal”, “noise”, “dots_bounce”, “triangle”, “arc”, “circle”, “square_corners”, “circle_quarters”, “circle_halves”, “dots_toggle”, “box_toggle”, “arrow”, “zip”, “bouncing_bar”, “bouncing_ball”, “clock”, “earth”, “moon”, “dots_pulse”, “meter”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"dots"</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.progress_icon.period"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.progress_icon.period"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.progress_icon.period</code> + </a> + </span> +</dt> +<dd> +<p>Period of the pattern</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">1</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.progress_style"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.progress_style"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.progress_style</code> + </a> + </span> +</dt> +<dd> +<p>Highlight group for in-progress LSP tasks</p> + +<p><span class="emphasis"><em>Type:</em></span> +string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"WarningMsg"</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.progress_ttl"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.progress_ttl"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.progress_ttl</code> + </a> + </span> +</dt> +<dd> +<p>How long a message should persist when in progress</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">99999</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.render_limit"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.render_limit"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.render_limit</code> + </a> + </span> +</dt> +<dd> +<p>Maximum number of messages to render</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">16</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.display.skip_history"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.skip_history"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.skip_history</code> + </a> + </span> +</dt> +<dd> +<p>Skip adding messages to history</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.ignore"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.ignore"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.ignore</code> + </a> + </span> +</dt> +<dd> +<p>Ignore LSP servers by name</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.ignore_done_already"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.ignore_done_already"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.ignore_done_already</code> + </a> + </span> +</dt> +<dd> +<p>Ignore new tasks that are already done</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.ignore_empty_message"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.ignore_empty_message"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.ignore_empty_message</code> + </a> + </span> +</dt> +<dd> +<p>Ignore new tasks with empty messages</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.lsp.log_handler"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.lsp.log_handler"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.lsp.log_handler</code> + </a> + </span> +</dt> +<dd> +<p>Log <code class="literal">$/progress</code> handler invocations</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.lsp.progress_ringbuf_size"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.lsp.progress_ringbuf_size"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.lsp.progress_ringbuf_size</code> + </a> + </span> +</dt> +<dd> +<p>Nvim’s LSP client ring buffer size</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">100</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.notification_group"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.notification_group"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.notification_group</code> + </a> + </span> +</dt> +<dd> +<p>How to get a progress message’s notification group key</p> + +<p><span class="emphasis"><em>Type:</em></span> +luaInline</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + _type = "lua-inline"; + expr = '' + function(msg) + return msg.lsp_client.name + end + ''; +} +</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.poll_rate"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.poll_rate"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.poll_rate</code> + </a> + </span> +</dt> +<dd> +<p>How frequently to poll for LSP progress messages</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">0</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.fidget-nvim.setupOpts.progress.suppress_on_insert"></a><a class="term" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.suppress_on_insert"><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.suppress_on_insert</code> + </a> + </span> +</dt> +<dd> +<p>Suppress new messages when in insert mode</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/visuals/fidget-nvim/fidget.nix" target="_top"> +<nvf/modules/plugins/visuals/fidget-nvim/fidget.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.highlight-undo.enable"></a><a class="term" href="options.html#opt-vim.visuals.highlight-undo.enable"><code class="option">vim.visuals.highlight-undo.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable highlight undo [highlight-undo].</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/visuals/highlight-undo/highlight-undo.nix" target="_top"> +<nvf/modules/plugins/visuals/highlight-undo/highlight-undo.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.highlight-undo.setupOpts"></a><a class="term" href="options.html#opt-vim.visuals.highlight-undo.setupOpts"><code class="option">vim.visuals.highlight-undo.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of highlight-undo</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/visuals/highlight-undo/highlight-undo.nix" target="_top"> +<nvf/modules/plugins/visuals/highlight-undo/highlight-undo.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.highlight-undo.setupOpts.duration"></a><a class="term" href="options.html#opt-vim.visuals.highlight-undo.setupOpts.duration"><code class="option">vim.visuals.highlight-undo.setupOpts.duration</code> + </a> + </span> +</dt> +<dd> +<p>Duration of the highlight</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">500</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/plugins/visuals/highlight-undo/highlight-undo.nix" target="_top"> +<nvf/modules/plugins/visuals/highlight-undo/highlight-undo.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.indent-blankline.enable"></a><a class="term" href="options.html#opt-vim.visuals.indent-blankline.enable"><code class="option">vim.visuals.indent-blankline.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable indentation guides [indent-blankline].</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/visuals/indent-blankline/indent-blankline.nix" target="_top"> +<nvf/modules/plugins/visuals/indent-blankline/indent-blankline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.indent-blankline.setupOpts"></a><a class="term" href="options.html#opt-vim.visuals.indent-blankline.setupOpts"><code class="option">vim.visuals.indent-blankline.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of indent-blankline</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/visuals/indent-blankline/indent-blankline.nix" target="_top"> +<nvf/modules/plugins/visuals/indent-blankline/indent-blankline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.indent-blankline.setupOpts.debounce"></a><a class="term" href="options.html#opt-vim.visuals.indent-blankline.setupOpts.debounce"><code class="option">vim.visuals.indent-blankline.setupOpts.debounce</code> + </a> + </span> +</dt> +<dd> +<p>Debounce time in milliseconds</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">200</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/plugins/visuals/indent-blankline/indent-blankline.nix" target="_top"> +<nvf/modules/plugins/visuals/indent-blankline/indent-blankline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.indent-blankline.setupOpts.indent.char"></a><a class="term" href="options.html#opt-vim.visuals.indent-blankline.setupOpts.indent.char"><code class="option">vim.visuals.indent-blankline.setupOpts.indent.char</code> + </a> + </span> +</dt> +<dd> +<p>Character(s) for indentation guide</p> + +<p><span class="emphasis"><em>Type:</em></span> +string or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">"│"</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/plugins/visuals/indent-blankline/indent-blankline.nix" target="_top"> +<nvf/modules/plugins/visuals/indent-blankline/indent-blankline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.indent-blankline.setupOpts.indent.highlight"></a><a class="term" href="options.html#opt-vim.visuals.indent-blankline.setupOpts.indent.highlight"><code class="option">vim.visuals.indent-blankline.setupOpts.indent.highlight</code> + </a> + </span> +</dt> +<dd> +<p>The highlight group(s) applied to the indentation guide.</p><p>See <code class="literal">:help ibl.config.indent.highlight</code>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/visuals/indent-blankline/indent-blankline.nix" target="_top"> +<nvf/modules/plugins/visuals/indent-blankline/indent-blankline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.indent-blankline.setupOpts.indent.priority"></a><a class="term" href="options.html#opt-vim.visuals.indent-blankline.setupOpts.indent.priority"><code class="option">vim.visuals.indent-blankline.setupOpts.indent.priority</code> + </a> + </span> +</dt> +<dd> +<p>Virtual text priority for the indentation guide</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">1</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/plugins/visuals/indent-blankline/indent-blankline.nix" target="_top"> +<nvf/modules/plugins/visuals/indent-blankline/indent-blankline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.indent-blankline.setupOpts.indent.repeat_linebreak"></a><a class="term" href="options.html#opt-vim.visuals.indent-blankline.setupOpts.indent.repeat_linebreak"><code class="option">vim.visuals.indent-blankline.setupOpts.indent.repeat_linebreak</code> + </a> + </span> +</dt> +<dd> +<p>Repeat indentation guides on wrapped lines</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/plugins/visuals/indent-blankline/indent-blankline.nix" target="_top"> +<nvf/modules/plugins/visuals/indent-blankline/indent-blankline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.indent-blankline.setupOpts.indent.smart_indent_cap"></a><a class="term" href="options.html#opt-vim.visuals.indent-blankline.setupOpts.indent.smart_indent_cap"><code class="option">vim.visuals.indent-blankline.setupOpts.indent.smart_indent_cap</code> + </a> + </span> +</dt> +<dd> +<p>Caps the number of indentation levels based on surrounding code</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/plugins/visuals/indent-blankline/indent-blankline.nix" target="_top"> +<nvf/modules/plugins/visuals/indent-blankline/indent-blankline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.indent-blankline.setupOpts.indent.tab_char"></a><a class="term" href="options.html#opt-vim.visuals.indent-blankline.setupOpts.indent.tab_char"><code class="option">vim.visuals.indent-blankline.setupOpts.indent.tab_char</code> + </a> + </span> +</dt> +<dd> +<p>Character(s) for tab indentation guide.</p><p>See <code class="literal">:help ibl.config.indent.tab_char</code>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/visuals/indent-blankline/indent-blankline.nix" target="_top"> +<nvf/modules/plugins/visuals/indent-blankline/indent-blankline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.indent-blankline.setupOpts.scope.enabled"></a><a class="term" href="options.html#opt-vim.visuals.indent-blankline.setupOpts.scope.enabled"><code class="option">vim.visuals.indent-blankline.setupOpts.scope.enabled</code> + </a> + </span> +</dt> +<dd> +<p>Highlight current scope from treesitter</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">config.vim.treesitter.enable</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/plugins/visuals/indent-blankline/indent-blankline.nix" target="_top"> +<nvf/modules/plugins/visuals/indent-blankline/indent-blankline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.indent-blankline.setupOpts.scope.char"></a><a class="term" href="options.html#opt-vim.visuals.indent-blankline.setupOpts.scope.char"><code class="option">vim.visuals.indent-blankline.setupOpts.scope.char</code> + </a> + </span> +</dt> +<dd> +<p>The character(s) for the scope indentation guide</p> + +<p><span class="emphasis"><em>Type:</em></span> +string or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">config.vim.visuals.indent-blankline.setupOpts.indent.char</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/plugins/visuals/indent-blankline/indent-blankline.nix" target="_top"> +<nvf/modules/plugins/visuals/indent-blankline/indent-blankline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.indent-blankline.setupOpts.scope.exclude.language"></a><a class="term" href="options.html#opt-vim.visuals.indent-blankline.setupOpts.scope.exclude.language"><code class="option">vim.visuals.indent-blankline.setupOpts.scope.exclude.language</code> + </a> + </span> +</dt> +<dd> +<p>The list of treesitter languages to disable scope for.</p><p><code class="literal">*</code> can be used as a wildcard for every language/node type.</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">[ ]</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/plugins/visuals/indent-blankline/indent-blankline.nix" target="_top"> +<nvf/modules/plugins/visuals/indent-blankline/indent-blankline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.indent-blankline.setupOpts.scope.exclude.node_type"></a><a class="term" href="options.html#opt-vim.visuals.indent-blankline.setupOpts.scope.exclude.node_type"><code class="option">vim.visuals.indent-blankline.setupOpts.scope.exclude.node_type</code> + </a> + </span> +</dt> +<dd> +<p>Nodes to ignore in scope checking, per language.</p><p><code class="literal">*</code> can be used as a wildcard for every language.</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + "*" = [ + "source_file" + "program" + ]; + lua = [ + "chunk" + ]; + python = [ + "module" + ]; +} +</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/plugins/visuals/indent-blankline/indent-blankline.nix" target="_top"> +<nvf/modules/plugins/visuals/indent-blankline/indent-blankline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.indent-blankline.setupOpts.scope.highlight"></a><a class="term" href="options.html#opt-vim.visuals.indent-blankline.setupOpts.scope.highlight"><code class="option">vim.visuals.indent-blankline.setupOpts.scope.highlight</code> + </a> + </span> +</dt> +<dd> +<p>The highlight group(s) applied to the scope.</p><p>See <code class="literal">:help </code>ibl.config.scope.highlight`.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/visuals/indent-blankline/indent-blankline.nix" target="_top"> +<nvf/modules/plugins/visuals/indent-blankline/indent-blankline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.indent-blankline.setupOpts.scope.include.node_type"></a><a class="term" href="options.html#opt-vim.visuals.indent-blankline.setupOpts.scope.include.node_type"><code class="option">vim.visuals.indent-blankline.setupOpts.scope.include.node_type</code> + </a> + </span> +</dt> +<dd> +<p>Additional nodes to be used for scope checking, per language</p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/visuals/indent-blankline/indent-blankline.nix" target="_top"> +<nvf/modules/plugins/visuals/indent-blankline/indent-blankline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.indent-blankline.setupOpts.scope.injected_languages"></a><a class="term" href="options.html#opt-vim.visuals.indent-blankline.setupOpts.scope.injected_languages"><code class="option">vim.visuals.indent-blankline.setupOpts.scope.injected_languages</code> + </a> + </span> +</dt> +<dd> +<p>Check for injected languages (treesitter)</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">config.vim.treesitter.enable</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/plugins/visuals/indent-blankline/indent-blankline.nix" target="_top"> +<nvf/modules/plugins/visuals/indent-blankline/indent-blankline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.indent-blankline.setupOpts.scope.priority"></a><a class="term" href="options.html#opt-vim.visuals.indent-blankline.setupOpts.scope.priority"><code class="option">vim.visuals.indent-blankline.setupOpts.scope.priority</code> + </a> + </span> +</dt> +<dd> +<p>Virtual text priority for the scope</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">1024</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/plugins/visuals/indent-blankline/indent-blankline.nix" target="_top"> +<nvf/modules/plugins/visuals/indent-blankline/indent-blankline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.indent-blankline.setupOpts.scope.show_end"></a><a class="term" href="options.html#opt-vim.visuals.indent-blankline.setupOpts.scope.show_end"><code class="option">vim.visuals.indent-blankline.setupOpts.scope.show_end</code> + </a> + </span> +</dt> +<dd> +<p>Show an underline on the last line of the scope</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/visuals/indent-blankline/indent-blankline.nix" target="_top"> +<nvf/modules/plugins/visuals/indent-blankline/indent-blankline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.indent-blankline.setupOpts.scope.show_exact_scope"></a><a class="term" href="options.html#opt-vim.visuals.indent-blankline.setupOpts.scope.show_exact_scope"><code class="option">vim.visuals.indent-blankline.setupOpts.scope.show_exact_scope</code> + </a> + </span> +</dt> +<dd> +<p>Show the scope underline at the exact start of the scope, even if that’s to the right of the indentation guide</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/visuals/indent-blankline/indent-blankline.nix" target="_top"> +<nvf/modules/plugins/visuals/indent-blankline/indent-blankline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.indent-blankline.setupOpts.scope.show_start"></a><a class="term" href="options.html#opt-vim.visuals.indent-blankline.setupOpts.scope.show_start"><code class="option">vim.visuals.indent-blankline.setupOpts.scope.show_start</code> + </a> + </span> +</dt> +<dd> +<p>Show an underline on the first line of the scope</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/visuals/indent-blankline/indent-blankline.nix" target="_top"> +<nvf/modules/plugins/visuals/indent-blankline/indent-blankline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.indent-blankline.setupOpts.viewport_buffer.max"></a><a class="term" href="options.html#opt-vim.visuals.indent-blankline.setupOpts.viewport_buffer.max"><code class="option">vim.visuals.indent-blankline.setupOpts.viewport_buffer.max</code> + </a> + </span> +</dt> +<dd> +<p>Number of lines above and below of what is currently +visible in the window</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">500</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/plugins/visuals/indent-blankline/indent-blankline.nix" target="_top"> +<nvf/modules/plugins/visuals/indent-blankline/indent-blankline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.indent-blankline.setupOpts.viewport_buffer.min"></a><a class="term" href="options.html#opt-vim.visuals.indent-blankline.setupOpts.viewport_buffer.min"><code class="option">vim.visuals.indent-blankline.setupOpts.viewport_buffer.min</code> + </a> + </span> +</dt> +<dd> +<p>Number of lines above and below of what is currently +visible in the window</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">30</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/plugins/visuals/indent-blankline/indent-blankline.nix" target="_top"> +<nvf/modules/plugins/visuals/indent-blankline/indent-blankline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.indent-blankline.setupOpts.whitespace.highlight"></a><a class="term" href="options.html#opt-vim.visuals.indent-blankline.setupOpts.whitespace.highlight"><code class="option">vim.visuals.indent-blankline.setupOpts.whitespace.highlight</code> + </a> + </span> +</dt> +<dd> +<p>The highlight group(s) applied to whitespace.</p><p>See <code class="literal">:help ibl.config.whitespace.highlight</code>.</p> + +<p><span class="emphasis"><em>Type:</em></span> +null or string or list of string</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/visuals/indent-blankline/indent-blankline.nix" target="_top"> +<nvf/modules/plugins/visuals/indent-blankline/indent-blankline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.indent-blankline.setupOpts.whitespace.remove_blankline_trail"></a><a class="term" href="options.html#opt-vim.visuals.indent-blankline.setupOpts.whitespace.remove_blankline_trail"><code class="option">vim.visuals.indent-blankline.setupOpts.whitespace.remove_blankline_trail</code> + </a> + </span> +</dt> +<dd> +<p>Remove trailing whitespace on blanklines</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/plugins/visuals/indent-blankline/indent-blankline.nix" target="_top"> +<nvf/modules/plugins/visuals/indent-blankline/indent-blankline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.nvim-cursorline.enable"></a><a class="term" href="options.html#opt-vim.visuals.nvim-cursorline.enable"><code class="option">vim.visuals.nvim-cursorline.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable cursor word and line highlighting [nvim-cursorline].</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/visuals/nvim-cursorline/nvim-cursorline.nix" target="_top"> +<nvf/modules/plugins/visuals/nvim-cursorline/nvim-cursorline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.nvim-cursorline.setupOpts"></a><a class="term" href="options.html#opt-vim.visuals.nvim-cursorline.setupOpts"><code class="option">vim.visuals.nvim-cursorline.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of nvim-cursorline</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/visuals/nvim-cursorline/nvim-cursorline.nix" target="_top"> +<nvf/modules/plugins/visuals/nvim-cursorline/nvim-cursorline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.nvim-cursorline.setupOpts.cursorline.enable"></a><a class="term" href="options.html#opt-vim.visuals.nvim-cursorline.setupOpts.cursorline.enable"><code class="option">vim.visuals.nvim-cursorline.setupOpts.cursorline.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable cursor line highlighting.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/visuals/nvim-cursorline/nvim-cursorline.nix" target="_top"> +<nvf/modules/plugins/visuals/nvim-cursorline/nvim-cursorline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.nvim-cursorline.setupOpts.cursorline.number"></a><a class="term" href="options.html#opt-vim.visuals.nvim-cursorline.setupOpts.cursorline.number"><code class="option">vim.visuals.nvim-cursorline.setupOpts.cursorline.number</code> + </a> + </span> +</dt> +<dd> +<p>If true, <code class="literal">vim.wo.cursorlineopt</code> will be set to “number” +when the trigger conditions are met.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</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/plugins/visuals/nvim-cursorline/nvim-cursorline.nix" target="_top"> +<nvf/modules/plugins/visuals/nvim-cursorline/nvim-cursorline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.nvim-cursorline.setupOpts.cursorline.timeout"></a><a class="term" href="options.html#opt-vim.visuals.nvim-cursorline.setupOpts.cursorline.timeout"><code class="option">vim.visuals.nvim-cursorline.setupOpts.cursorline.timeout</code> + </a> + </span> +</dt> +<dd> +<p>Cursorline timeout</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">1000</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/plugins/visuals/nvim-cursorline/nvim-cursorline.nix" target="_top"> +<nvf/modules/plugins/visuals/nvim-cursorline/nvim-cursorline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.nvim-cursorline.setupOpts.cursorword.enable"></a><a class="term" href="options.html#opt-vim.visuals.nvim-cursorline.setupOpts.cursorword.enable"><code class="option">vim.visuals.nvim-cursorline.setupOpts.cursorword.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable cursor word highlighting.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/visuals/nvim-cursorline/nvim-cursorline.nix" target="_top"> +<nvf/modules/plugins/visuals/nvim-cursorline/nvim-cursorline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.nvim-cursorline.setupOpts.cursorword.hl.underline"></a><a class="term" href="options.html#opt-vim.visuals.nvim-cursorline.setupOpts.cursorword.hl.underline"><code class="option">vim.visuals.nvim-cursorline.setupOpts.cursorword.hl.underline</code> + </a> + </span> +</dt> +<dd> +<p>Whether to underline matching cursorword</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/plugins/visuals/nvim-cursorline/nvim-cursorline.nix" target="_top"> +<nvf/modules/plugins/visuals/nvim-cursorline/nvim-cursorline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.nvim-cursorline.setupOpts.cursorword.min_length"></a><a class="term" href="options.html#opt-vim.visuals.nvim-cursorline.setupOpts.cursorword.min_length"><code class="option">vim.visuals.nvim-cursorline.setupOpts.cursorword.min_length</code> + </a> + </span> +</dt> +<dd> +<p>The min_length option defines the minimum number of characters +a word must have to be highlighted as a “cursor word.” Any word +shorter than this value will be ignored and not highlighted.</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">3</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/plugins/visuals/nvim-cursorline/nvim-cursorline.nix" target="_top"> +<nvf/modules/plugins/visuals/nvim-cursorline/nvim-cursorline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.nvim-cursorline.setupOpts.cursorword.timeout"></a><a class="term" href="options.html#opt-vim.visuals.nvim-cursorline.setupOpts.cursorword.timeout"><code class="option">vim.visuals.nvim-cursorline.setupOpts.cursorword.timeout</code> + </a> + </span> +</dt> +<dd> +<p>Cursorword timeout</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">1000</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/plugins/visuals/nvim-cursorline/nvim-cursorline.nix" target="_top"> +<nvf/modules/plugins/visuals/nvim-cursorline/nvim-cursorline.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.nvim-scrollbar.enable"></a><a class="term" href="options.html#opt-vim.visuals.nvim-scrollbar.enable"><code class="option">vim.visuals.nvim-scrollbar.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable extensible Neovim Scrollbar [nvim-scrollbar].</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/visuals/nvim-scrollbar/scrollbar-nvim.nix" target="_top"> +<nvf/modules/plugins/visuals/nvim-scrollbar/scrollbar-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.nvim-scrollbar.setupOpts"></a><a class="term" href="options.html#opt-vim.visuals.nvim-scrollbar.setupOpts"><code class="option">vim.visuals.nvim-scrollbar.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of scrollbar-nvim</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/visuals/nvim-scrollbar/scrollbar-nvim.nix" target="_top"> +<nvf/modules/plugins/visuals/nvim-scrollbar/scrollbar-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.nvim-scrollbar.setupOpts.excluded_filetypes"></a><a class="term" href="options.html#opt-vim.visuals.nvim-scrollbar.setupOpts.excluded_filetypes"><code class="option">vim.visuals.nvim-scrollbar.setupOpts.excluded_filetypes</code> + </a> + </span> +</dt> +<dd> +<p>Filetypes to hide the scrollbar on</p> + +<p><span class="emphasis"><em>Type:</em></span> +list of string</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">[ + "prompt" + "TelescopePrompt" + "noice" + "noice" + "NvimTree" + "neo-tree" + "alpha" + "notify" + "Navbuddy" +] +</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/plugins/visuals/nvim-scrollbar/scrollbar-nvim.nix" target="_top"> +<nvf/modules/plugins/visuals/nvim-scrollbar/scrollbar-nvim.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.nvim-web-devicons.enable"></a><a class="term" href="options.html#opt-vim.visuals.nvim-web-devicons.enable"><code class="option">vim.visuals.nvim-web-devicons.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Neovim dev icons [nvim-web-devicons].</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/visuals/nvim-web-devicons/nvim-web-devicons.nix" target="_top"> +<nvf/modules/plugins/visuals/nvim-web-devicons/nvim-web-devicons.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.nvim-web-devicons.setupOpts"></a><a class="term" href="options.html#opt-vim.visuals.nvim-web-devicons.setupOpts"><code class="option">vim.visuals.nvim-web-devicons.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of nvim-web-devicons</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/visuals/nvim-web-devicons/nvim-web-devicons.nix" target="_top"> +<nvf/modules/plugins/visuals/nvim-web-devicons/nvim-web-devicons.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.nvim-web-devicons.setupOpts.color_icons"></a><a class="term" href="options.html#opt-vim.visuals.nvim-web-devicons.setupOpts.color_icons"><code class="option">vim.visuals.nvim-web-devicons.setupOpts.color_icons</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable different highlight colors per icon.</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>Example:</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/plugins/visuals/nvim-web-devicons/nvim-web-devicons.nix" target="_top"> +<nvf/modules/plugins/visuals/nvim-web-devicons/nvim-web-devicons.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.nvim-web-devicons.setupOpts.override"></a><a class="term" href="options.html#opt-vim.visuals.nvim-web-devicons.setupOpts.override"><code class="option">vim.visuals.nvim-web-devicons.setupOpts.override</code> + </a> + </span> +</dt> +<dd> +<p>Your personal icon overrides.</p><p>You can specify color or cterm_color instead of specifying +both of them. DevIcon will be appended to <code class="literal">name</code></p> + +<p><span class="emphasis"><em>Type:</em></span> +attribute set of (attribute set)</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</code></p> + +<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">{ + zsh = { + name = "Zsh"; + icon = ""; + color = "#428850"; + cterm_color = "65"; + }; +} + +</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/plugins/visuals/nvim-web-devicons/nvim-web-devicons.nix" target="_top"> +<nvf/modules/plugins/visuals/nvim-web-devicons/nvim-web-devicons.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.nvim-web-devicons.setupOpts.variant"></a><a class="term" href="options.html#opt-vim.visuals.nvim-web-devicons.setupOpts.variant"><code class="option">vim.visuals.nvim-web-devicons.setupOpts.variant</code> + </a> + </span> +</dt> +<dd> +<p>Set the light or dark variant manually, instead of relying on <code class="literal">background</code></p> + +<p><span class="emphasis"><em>Type:</em></span> +null or one of “light”, “dark”</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">null</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/plugins/visuals/nvim-web-devicons/nvim-web-devicons.nix" target="_top"> +<nvf/modules/plugins/visuals/nvim-web-devicons/nvim-web-devicons.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.tiny-devicons-auto-colors.enable"></a><a class="term" href="options.html#opt-vim.visuals.tiny-devicons-auto-colors.enable"><code class="option">vim.visuals.tiny-devicons-auto-colors.enable</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable alternative nvim-web-devicons icon colors [tiny-devicons-auto-colors].</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/plugins/visuals/tiny-devicons-auto-colors/tiny-devicons-auto-colors.nix" target="_top"> +<nvf/modules/plugins/visuals/tiny-devicons-auto-colors/tiny-devicons-auto-colors.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.tiny-devicons-auto-colors.setupOpts"></a><a class="term" href="options.html#opt-vim.visuals.tiny-devicons-auto-colors.setupOpts"><code class="option">vim.visuals.tiny-devicons-auto-colors.setupOpts</code> + </a> + </span> +</dt> +<dd> +<p>Option table to pass into the setup function of tiny-devicons-auto-colors</p><p>You can pass in any additional options even if they’re +not listed in the docs</p> + +<p><span class="emphasis"><em>Type:</em></span> +anything</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">{ }</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/plugins/visuals/tiny-devicons-auto-colors/tiny-devicons-auto-colors.nix" target="_top"> +<nvf/modules/plugins/visuals/tiny-devicons-auto-colors/tiny-devicons-auto-colors.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.tiny-devicons-auto-colors.setupOpts.factors.cache.enabled"></a><a class="term" href="options.html#opt-vim.visuals.tiny-devicons-auto-colors.setupOpts.factors.cache.enabled"><code class="option">vim.visuals.tiny-devicons-auto-colors.setupOpts.factors.cache.enabled</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable caching of icon colors. This will greatly improve performance.</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>Example:</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/plugins/visuals/tiny-devicons-auto-colors/tiny-devicons-auto-colors.nix" target="_top"> +<nvf/modules/plugins/visuals/tiny-devicons-auto-colors/tiny-devicons-auto-colors.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.tiny-devicons-auto-colors.setupOpts.factors.cache.path"></a><a class="term" href="options.html#opt-vim.visuals.tiny-devicons-auto-colors.setupOpts.factors.cache.path"><code class="option">vim.visuals.tiny-devicons-auto-colors.setupOpts.factors.cache.path</code> + </a> + </span> +</dt> +<dd> +<p>Path to the cache file</p> + +<p><span class="emphasis"><em>Type:</em></span> +luaInline</p> + +<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting">{ + _type = "lua-inline"; + expr = "vim.fn.stdpath(\"cache\") .. \"/tiny-devicons-auto-colors-cache.json\""; +} +</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/plugins/visuals/tiny-devicons-auto-colors/tiny-devicons-auto-colors.nix" target="_top"> +<nvf/modules/plugins/visuals/tiny-devicons-auto-colors/tiny-devicons-auto-colors.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.tiny-devicons-auto-colors.setupOpts.factors.chroma"></a><a class="term" href="options.html#opt-vim.visuals.tiny-devicons-auto-colors.setupOpts.factors.chroma"><code class="option">vim.visuals.tiny-devicons-auto-colors.setupOpts.factors.chroma</code> + </a> + </span> +</dt> +<dd> +<p>Chroma factor of icons</p> + +<p><span class="emphasis"><em>Type:</em></span> +signed integer</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">1</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/plugins/visuals/tiny-devicons-auto-colors/tiny-devicons-auto-colors.nix" target="_top"> +<nvf/modules/plugins/visuals/tiny-devicons-auto-colors/tiny-devicons-auto-colors.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.tiny-devicons-auto-colors.setupOpts.factors.hue"></a><a class="term" href="options.html#opt-vim.visuals.tiny-devicons-auto-colors.setupOpts.factors.hue"><code class="option">vim.visuals.tiny-devicons-auto-colors.setupOpts.factors.hue</code> + </a> + </span> +</dt> +<dd> +<p>Hue factor of icons</p> + +<p><span class="emphasis"><em>Type:</em></span> +floating point number</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">1.25</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/plugins/visuals/tiny-devicons-auto-colors/tiny-devicons-auto-colors.nix" target="_top"> +<nvf/modules/plugins/visuals/tiny-devicons-auto-colors/tiny-devicons-auto-colors.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.visuals.tiny-devicons-auto-colors.setupOpts.factors.lightness"></a><a class="term" href="options.html#opt-vim.visuals.tiny-devicons-auto-colors.setupOpts.factors.lightness"><code class="option">vim.visuals.tiny-devicons-auto-colors.setupOpts.factors.lightness</code> + </a> + </span> +</dt> +<dd> +<p>Lightness factor of icons</p> + +<p><span class="emphasis"><em>Type:</em></span> +floating point number</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">1.76</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/plugins/visuals/tiny-devicons-auto-colors/tiny-devicons-auto-colors.nix" target="_top"> +<nvf/modules/plugins/visuals/tiny-devicons-auto-colors/tiny-devicons-auto-colors.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.withNodeJs"></a><a class="term" href="options.html#opt-vim.withNodeJs"><code class="option">vim.withNodeJs</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable NodeJs support in the Neovim wrapper +.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/wrapper/environment/options.nix" target="_top"> +<nvf/modules/wrapper/environment/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.withPython3"></a><a class="term" href="options.html#opt-vim.withPython3"><code class="option">vim.withPython3</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Python3 support in the Neovim wrapper +.</p> + +<p><span class="emphasis"><em>Type:</em></span> +boolean</p> + +<p><span class="emphasis"><em>Default:</em></span> +<code class="literal">false</code></p> + +<p><span class="emphasis"><em>Example:</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/wrapper/environment/options.nix" target="_top"> +<nvf/modules/wrapper/environment/options.nix> +</a></code> +</td></tr> +</table> +</dd> +<dt> + <span class="term"> + <a id="opt-vim.withRuby"></a><a class="term" href="options.html#opt-vim.withRuby"><code class="option">vim.withRuby</code> + </a> + </span> +</dt> +<dd> +<p>Whether to enable Ruby support in the Neovim wrapper. +.</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>Example:</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/wrapper/environment/options.nix" target="_top"> +<nvf/modules/wrapper/environment/options.nix> +</a></code> +</td></tr> +</table> +</dd> + </dl> +</div> +</div> <div class="navfooter"> + <hr /> + <table width="100%" summary="Navigation footer"> + <tr> + <td width="40%" align="left"><a accesskey="p" href="quirks.html">Prev</a> </td> + <td width="20%" align="center"> </td> + <td width="40%" align="right"> <a accesskey="n" href="release-notes.html">Next</a></td> + </tr> + <tr> + <td width="40%" align="left" valign="top">Appendix A. Known Issues and Quirks </td> + <td width="20%" align="center"><a accesskey="h" href="index.xhtml">Home</a></td> + <td width="40%" align="right" valign="top"> Appendix C. Release Notes</td> + </tr> + </table> + </div> + </body> +</html> \ No newline at end of file diff --git a/docs-preview-569/quirks.html b/docs-preview-569/quirks.html new file mode 100644 index 000000000..4ff1fa95f --- /dev/null +++ b/docs-preview-569/quirks.html @@ -0,0 +1,56 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + <title>Appendix A. Known Issues and Quirks</title> +<link rel="stylesheet" type="text/css" href="style.css" /> +<script src="highlightjs/highlight.pack.js" type="text/javascript"></script><script src="highlightjs/loader.js" type="text/javascript"></script><script src="script/anchor-use.js" type="text/javascript"></script><script src="script/anchor-min.js" type="text/javascript"></script><script src="script/search.js" type="text/javascript"></script> + <meta name="generator" content="nixos-render-docs" /> + <link rel="home" href="index.xhtml" title="nvf manual" /> + <link rel="up" href="index.xhtml" title="nvf manual" /><link rel="prev" href="index.xhtml" title="nvf manual" /><link rel="next" href="options.html" title="Appendix B. Neovim Flake Configuration Options" /> + </head> + <body> + <div class="navheader"> + <table width="100%" summary="Navigation header"> + <tr> + <th colspan="3" align="center">Appendix A. Known Issues and Quirks</th> + </tr> + <tr> + <td width="20%" align="left"><a accesskey="p" href="index.xhtml">Prev</a> </td> + <th width="60%" align="center"> </th> + <td width="20%" align="right"> <a accesskey="n" href="options.html">Next</a></td> + </tr> + </table> + <hr /> + </div><div class="appendix"> <div class="titlepage"> <div> <div> <h1 id="ch-known-issues-quirks" class="title" >Appendix A. Known Issues and Quirks </h1> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="chapter"> <a href="quirks.html#ch-quirks-nodejs">NodeJS</a> </span></dt> </dl></div><p>At times, certain plugins and modules may refuse to play nicely with your setup, +be it a result of generating Lua from Nix, or the state of packaging. This page, +in turn, will list any known modules or plugins that are known to misbehave, and +possible workarounds that you may apply.</p><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="ch-quirks-nodejs" class="title" >NodeJS </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="quirks.html#sec-eslint-plugin-prettier">eslint-plugin-prettier</a> </span></dt> </dl></div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-eslint-plugin-prettier" class="title" style="clear: both">eslint-plugin-prettier </h2> </div> </div></div><p>When working with NodeJS, everything works as expected, but some projects have +settings that can fool nvf.</p><p>If <a class="link" href="https://github.com/prettier/eslint-plugin-prettier" target="_top">this plugin</a> or similar +is included, you might get a situation where your eslint configuration diagnoses +your formatting according to its own config (usually <code class="literal">.eslintrc.js</code>).</p><p>The issue there is your formatting is made via prettierd.</p><p>This results in auto-formatting relying on your prettier config, while your +eslint config diagnoses formatting +<a class="link" href="https://prettier.io/docs/en/comparison.html" target="_top">which it’s not supposed to</a>)</p><p>In the end, you get discrepancies between what your editor does and what it +wants.</p><p>Solutions are:</p><div class="orderedlist"><ol class="orderedlist compact" type="1"><li class="listitem"><p>Don’t add a formatting config to eslint, and separate prettier and eslint.</p></li><li class="listitem"><p>PR this repo to add an ESLint formatter and configure nvf to use it.</p></li></ol></div> +</div> + +</div> +</div> <div class="navfooter"> + <hr /> + <table width="100%" summary="Navigation footer"> + <tr> + <td width="40%" align="left"><a accesskey="p" href="index.xhtml">Prev</a> </td> + <td width="20%" align="center"> </td> + <td width="40%" align="right"> <a accesskey="n" href="options.html">Next</a></td> + </tr> + <tr> + <td width="40%" align="left" valign="top">nvf manual </td> + <td width="20%" align="center"><a accesskey="h" href="index.xhtml">Home</a></td> + <td width="40%" align="right" valign="top"> Appendix B. Neovim Flake Configuration Options</td> + </tr> + </table> + </div> + </body> +</html> \ No newline at end of file diff --git a/docs-preview-569/release-notes.html b/docs-preview-569/release-notes.html new file mode 100644 index 000000000..4cf04722f --- /dev/null +++ b/docs-preview-569/release-notes.html @@ -0,0 +1,383 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + <title>Appendix C. Release Notes</title> +<link rel="stylesheet" type="text/css" href="style.css" /> +<script src="highlightjs/highlight.pack.js" type="text/javascript"></script><script src="highlightjs/loader.js" type="text/javascript"></script><script src="script/anchor-use.js" type="text/javascript"></script><script src="script/anchor-min.js" type="text/javascript"></script><script src="script/search.js" type="text/javascript"></script> + <meta name="generator" content="nixos-render-docs" /> + <link rel="home" href="index.xhtml" title="nvf manual" /> + <link rel="up" href="index.xhtml" title="nvf manual" /><link rel="prev" href="options.html" title="Appendix B. Neovim Flake Configuration Options" /> + </head> + <body> + <div class="navheader"> + <table width="100%" summary="Navigation header"> + <tr> + <th colspan="3" align="center">Appendix C. Release Notes</th> + </tr> + <tr> + <td width="20%" align="left"><a accesskey="p" href="options.html">Prev</a> </td> + <th width="60%" align="center"> </th> + <td width="20%" align="right"> </td> + </tr> + </table> + <hr /> + </div><div class="appendix"> <div class="titlepage"> <div> <div> <h1 id="ch-release-notes" class="title" >Appendix C. Release Notes </h1> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="chapter"> <a href="release-notes.html#sec-release-0.1">Release 0.1</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.html#sec-release-0.2">Release 0.2</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.html#sec-release-0.3">Release 0.3</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.html#sec-release-0.4">Release 0.4</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.html#sec-release-0.5">Release 0.5</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.html#sec-release-0.6">Release 0.6</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.html#sec-release-0.7">Release 0.7</a> </span></dt> </dl></div><p>This section lists the release notes for tagged version of <span class="strong"><strong>nvf</strong></span> and the +current main current main branch</p><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="sec-release-0.1" class="title" >Release 0.1 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.html#sec-release-0.1-changelog">Changelog</a> </span></dt> </dl></div><p>This is the current master branch and information here is not final. These are +changes from the v0.1 tag.</p><p>Special thanks to <a class="link" href="https://github.com/nix-community/home-manager/" target="_top">home-manager</a> +for this release. Docs/manual generation, the new module evaluation system, and +DAG implementation are from them.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-0.1-changelog" class="title" style="clear: both">Changelog </h2> </div> </div></div><p><a class="link" href="https://github.com/jordanisaacs" target="_top">jordanisaacs</a>:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Removed hare language support (lsp/tree-sitter/etc). <code class="literal">vim.lsp.hare</code> is no +longer defined. If you use hare and would like it added back, please file an +issue.</p></li><li class="listitem"><p><a class="xref" href="options.html#opt-vim.startPlugins" ><code class="option">vim.startPlugins</code></a> & <a class="xref" href="options.html#opt-vim.optPlugins" ><code class="option">vim.optPlugins</code></a> are now an enum of +<code class="literal">string</code> for options sourced from the flake inputs. Users can still provide +vim plugin packages.</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: circle;"><li class="listitem"><p>If you are contributing and adding a new plugin, add the plugin name to +<code class="literal">availablePlugins</code> in [types-plugin.nix].</p></li></ul></div></li><li class="listitem"><p><code class="literal">neovimBuilder</code> has been removed for configuration. Using an overlay is no +longer required. See the manual for the new way to configuration.</p></li></ul></div><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Treesitter grammars are now configurable with +<a class="xref" href="options.html#opt-vim.treesitter.grammars" ><code class="option">vim.treesitter.grammars</code></a>. Utilizes the nixpkgs <code class="literal">nvim-treesitter</code> +plugin rather than a custom input in order to take advantage of build support +of pinned versions. See the <a class="link" href="https://discourse.nixos.org/t/psa-if-you-are-on-unstable-try-out-nvim-treesitter-withallgrammars/23321?u=snowytrees" target="_top">relevant discourse post</a> for more information. +Packages can be found under the <code class="literal">vimPlugins.nvim-treesitter.builtGrammars</code> +namespace.</p></li><li class="listitem"><p><code class="literal">vim.configRC</code> and <a class="xref" href="options.html#opt-vim.luaConfigRC" ><code class="option">vim.luaConfigRC</code></a> are now of type DAG lines. This +allows for ordering of the config. Usage is the same is in home-manager’s +<code class="literal">home.activation</code> option.</p></li></ul></div><pre><code class="programlisting nix">vim.luaConfigRC = lib.nvim.dag.entryAnywhere "config here" +</code></pre><p><a class="link" href="https://github.com/MoritzBoehme" target="_top">MoritzBoehme</a>:</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p><code class="literal">catppuccin</code> theme is now available as a neovim theme <a class="xref" href="options.html#opt-vim.theme.style" ><code class="option">vim.theme.style</code></a> +and Lualine theme <a class="xref" href="options.html#opt-vim.statusline.lualine.theme" ><code class="option">vim.statusline.lualine.theme</code></a>.</p></li></ul></div> +</div> + +</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="sec-release-0.2" class="title" >Release 0.2 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.html#sec-release-0.2-changelog">Changelog</a> </span></dt> </dl></div><p>Release notes for release 0.2</p><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-0.2-changelog" class="title" style="clear: both">Changelog </h2> </div> </div></div><p><a class="link" href="https://github.com/notashelf" target="_top">notashelf</a>:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Added two minimap plugins under <code class="literal">vim.minimap</code>. <code class="literal">codewindow.nvim</code> is enabled by +default, while <code class="literal">minimap.vim</code> is available with its code-minimap dependency.</p></li><li class="listitem"><p>A complementary plugin, <code class="literal">obsidian.nvim</code> and the Neovim alternative for Emacs’ +orgmode with <code class="literal">orgmode.nvim</code> have been added. Both will be disabled by default.</p></li><li class="listitem"><p>Smooth scrolling for ANY movement command is now available with +<code class="literal">cinnamon.nvim</code></p></li><li class="listitem"><p>You will now notice a dashboard on startup. This is provided by the +<code class="literal">alpha.nvim</code> plugin. You can use any of the three available dashboard plugins, +or disable them entirely.</p></li><li class="listitem"><p>There is now a scrollbar on active buffers, which can highlight errors by +hooking to your LSPs. This is on by default, but can be toggled off under +<code class="literal">vim.visuals</code> if seen necessary.</p></li><li class="listitem"><p>Discord Rich Presence has been added through <code class="literal">presence.nvim</code> for those who +want to flex that they are using the <span class="emphasis"><em>superior</em></span> text editor.</p></li><li class="listitem"><p>An icon picker is now available with telescope integration. You can use +<code class="literal">:IconPickerInsert</code> or <code class="literal">:IconPickerYank</code> to add icons to your code.</p></li><li class="listitem"><p>A general-purpose cheatsheet has been added through <code class="literal">cheatsheet.nvim</code>. Forget +no longer!</p></li><li class="listitem"><p><code class="literal">ccc.nvim</code> has been added to the default plugins to allow picking colors with +ease.</p></li><li class="listitem"><p>Most UI components of Neovim have been replaced through the help of +<code class="literal">noice.nvim</code>. There are also notifications and custom UI elements available +for Neovim messages and prompts.</p></li><li class="listitem"><p>A (floating by default) terminal has been added through <code class="literal">toggleterm.nvim</code>.</p></li><li class="listitem"><p>Harness the power of ethical (<code class="literal">tabnine.nvim</code>) and not-so-ethical +(<code class="literal">copilot.lua</code>) AI by those new assistant plugins. Both are off by default, +TabNine needs to be wrapped before it’s working.</p></li><li class="listitem"><p>Experimental mouse gestures have been added through <code class="literal">gesture.nvim</code>. See plugin +page and the relevant module for more details on how to use.</p></li><li class="listitem"><p>Re-open last visited buffers via <code class="literal">nvim-session-manager</code>. Disabled by default +as deleting buffers seems to be problematic at the moment.</p></li><li class="listitem"><p>Most of NvimTree’s configuration options have been changed with some options +being toggled to off by default.</p></li><li class="listitem"><p>Lualine had its configuration simplified and style toned down. Less color, +more info.</p></li><li class="listitem"><p>Modules where multiple plugin configurations were in the same directory have +been simplified. Each plugin inside a single module gets its directory to be +imported.</p></li><li class="listitem"><p>Separate config options with the same parent attribute have been merged into +one for simplicity.</p></li></ul></div> +</div> + +</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="sec-release-0.3" class="title" >Release 0.3 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.html#sec-release-0.3-changelog">Changelog</a> </span></dt> </dl></div><p>Release 0.3 had to come out before I wanted it to due to Neovim 0.9 dropping +into nixpkgs-unstable. The Treesitter changes have prompted a Treesitter rework, +which was followed by reworking the languages system. Most of the changes to +those are downstreamed from the original repository. The feature requests that +was originally planned for 0.3 have been moved to 0.4, which should come out +soon.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-0.3-changelog" class="title" style="clear: both">Changelog </h2> </div> </div></div><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>We have transitioned to flake-parts, from flake-utils to extend the +flexibility of this flake. This means the flake structure is different than +usual, but the functionality remains the same.</p></li><li class="listitem"><p>We now provide a home-manager module. Do note that it is still far from +perfect, but it works.</p></li><li class="listitem"><p><code class="literal">nodejs_16</code> is now bundled with <code class="literal">Copilot.lua</code> if the user has enabled Copilot +assistant.</p></li><li class="listitem"><p>which-key section titles have been fixed. This is to be changed once again in +a possible keybind rewrite, but now it should display the correct titles +instead of <code class="literal">+prefix</code></p></li><li class="listitem"><p>Most of <code class="literal">presence.nvim</code>’s options have been made fully configurable through +your configuration file.</p></li><li class="listitem"><p>Most of the modules have been refactored to separate <code class="literal">config</code> and <code class="literal">options</code> +attributes.</p></li><li class="listitem"><p>Darwin has been deprecated as the Zig package is marked as broken. We will +attempt to use the Zig overlay to return Darwin support.</p></li><li class="listitem"><p><code class="literal">Fidget.nvim</code> has been added as a neat visual addition for LSP installations.</p></li><li class="listitem"><p><code class="literal">diffview.nvim</code> has been added to provide a convenient diff utility.</p></li><li class="listitem"><p>Treesitter grammars are now configurable with +<a class="xref" href="options.html#opt-vim.treesitter.grammars" ><code class="option">vim.treesitter.grammars</code></a>. Utilizes the nixpkgs <code class="literal">nvim-treesitter</code> +plugin rather than a custom input in order to take advantage of build support +of pinned versions. See <a class="link" href="https://discourse.nixos.org/t/psa-if-you-are-on-unstable-try-out-nvim-treesitter-withallgrammars/23321?u=snowytrees" target="_top">discourse</a> for more information. Packages can be +found under the <code class="literal">pkgs.vimPlugins.nvim-treesitter.builtGrammars</code> attribute. +Treesitter grammars for supported languages should be enabled within the +module. By default no grammars are installed, thus the following grammars +which do not have a language section are not included anymore: <span class="strong"><strong>comment</strong></span>, +<span class="strong"><strong>toml</strong></span>, <span class="strong"><strong>make</strong></span>, <span class="strong"><strong>html</strong></span>, <span class="strong"><strong>css</strong></span>, <span class="strong"><strong>graphql</strong></span>, <span class="strong"><strong>json</strong></span>.</p></li><li class="listitem"><p>A new section has been added for language support: <code class="literal">vim.languages.<language></code>.</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: circle;"><li class="listitem"><p>The options <a class="xref" href="options.html#opt-vim.languages.enableLSP" ><code class="option">vim.languages.enableLSP</code></a>, +<a class="xref" href="options.html#opt-vim.languages.enableTreesitter" ><code class="option">vim.languages.enableTreesitter</code></a>, etc. will enable the respective +section for all languages that have been enabled.</p></li><li class="listitem"><p>All LSP languages have been moved here</p></li><li class="listitem"><p><code class="literal">plantuml</code> and <code class="literal">markdown</code> have been moved here</p></li><li class="listitem"><p>A new section has been added for <code class="literal">html</code>. The old +<code class="literal">vim.treesitter.autotagHtml</code> can be found at +<a class="xref" href="options.html#opt-vim.languages.html.treesitter.autotagHtml" ><code class="option">vim.languages.html.treesitter.autotagHtml</code></a>.</p></li></ul></div></li><li class="listitem"><p><code class="literal">vim.git.gitsigns.codeActions</code> has been added, allowing you to turn on +Gitsigns’ code actions.</p></li><li class="listitem"><p>Removed the plugins document in the docs. Was too unwieldy to keep updated.</p></li><li class="listitem"><p><code class="literal">vim.visual.lspkind</code> has been moved to <a class="xref" href="options.html#opt-vim.lsp.lspkind.enable" ><code class="option">vim.lsp.lspkind.enable</code></a></p></li><li class="listitem"><p>Improved handling of completion formatting. When setting +<code class="literal">vim.autocomplete.sources</code>, can also include optional menu mapping. And can +provide your own function with <code class="literal">vim.autocomplete.formatting.format</code>.</p></li><li class="listitem"><p>For <code class="literal">vim.visuals.indentBlankline.fillChar</code> and +<code class="literal">vim.visuals.indentBlankline.eolChar</code> options, turning them off should be done +by using <code class="literal">null</code> rather than <code class="literal">""</code> now.</p></li><li class="listitem"><p>Transparency has been made optional and has been disabled by default. +<a class="xref" href="options.html#opt-vim.theme.transparent" ><code class="option">vim.theme.transparent</code></a> option can be used to enable or disable +transparency for your configuration.</p></li><li class="listitem"><p>Fixed deprecated configuration method for Tokyonight, and added new style +“moon”</p></li><li class="listitem"><p>Dart language support as well as extended flutter support has been added. +Thanks to @FlafyDev for his contributions towards Dart language support.</p></li><li class="listitem"><p>Elixir language support has been added through <code class="literal">elixir-tools.nvim</code>.</p></li><li class="listitem"><p><code class="literal">hop.nvim</code> and <code class="literal">leap.nvim</code> have been added for fast navigation.</p></li><li class="listitem"><p><code class="literal">modes.nvim</code> has been added to the UI plugins as a minor error highlighter.</p></li><li class="listitem"><p><code class="literal">smartcollumn.nvim</code> has been added to dynamically display a colorcolumn when +the limit has been exceeded, providing per-buftype column position and more.</p></li><li class="listitem"><p><code class="literal">project.nvim</code> has been added for better project management inside Neovim.</p></li><li class="listitem"><p>More configuration options have been added to <code class="literal">nvim-session-manager</code>.</p></li><li class="listitem"><p>Editorconfig support has been added to the core functionality, with an enable +option.</p></li><li class="listitem"><p><code class="literal">venn-nvim</code> has been dropped due to broken keybinds.</p></li></ul></div> +</div> + +</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="sec-release-0.4" class="title" >Release 0.4 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.html#sec-release-0.4-changelog">Changelog</a> </span></dt> </dl></div><p>Following the release of v0.3, I have decided to release v0.4 with a massive new +change: customizable keybinds. As of the 0.4 release, keybinds will no longer be +hardcoded and instead provided by each module’s own keybinds section. The old +keybind system (<code class="literal">vim.keybinds = {}</code>) is now considered deprecated and the new +lib functions are recommended to be used for adding keybinds for new plugins, or +adding keybinds to existing plugins.</p><p>Alongside customizable keybinds, there are a few quality of life updates, such +as <code class="literal">lazygit</code> integration and the new experimental Lua loader of Neovim 0.9 +thanks to our awesome contributors who made this update possible during my +absence.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-0.4-changelog" class="title" style="clear: both">Changelog </h2> </div> </div></div><p><a class="link" href="https://github.com/n3oney" target="_top">n3oney</a>:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Streamlined keybind adding process towards new functions in extended stdlib.</p></li><li class="listitem"><p>Moved default keybinds into keybinds section of each module</p></li><li class="listitem"><p>Simplified luaConfigRC and configRC setting - they can now just take strings</p></li><li class="listitem"><p>Refactored the resolveDag function - you can just provide a string now, which +will default to dag.entryAnywhere</p></li><li class="listitem"><p>Fixed formatting sometimes removing parts of files</p></li><li class="listitem"><p>Made formatting synchronous</p></li><li class="listitem"><p>Gave null-ls priority over other formatters</p></li></ul></div><p><a class="link" href="https://github.com/horriblename" target="_top">horriblename</a>:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Added <code class="literal">clangd</code> as alternative lsp for C/++.</p></li><li class="listitem"><p>Added <code class="literal">toggleterm</code> integration for <code class="literal">lazygit</code>.</p></li><li class="listitem"><p>Added new option <code class="literal">enableluaLoader</code> to enable neovim’s experimental module +loader for faster startup time.</p></li><li class="listitem"><p>Fixed bug where flutter-tools can’t find <code class="literal">dart</code> LSP</p></li><li class="listitem"><p>Added Debug Adapter (DAP) support for clang, rust, go, python and dart.</p></li></ul></div><p><a class="link" href="https://github.com/notashelf" target="_top">notashelf</a>:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Made Copilot’s Node package configurable. It is recommended to keep as +default, but providing a different NodeJS version is now possible.</p></li><li class="listitem"><p>Added <code class="literal">vim.cursorlineOpt</code> for configuring Neovim’s <code class="literal">vim.o.cursorlineopt</code>.</p></li><li class="listitem"><p>Added <code class="literal">filetree.nvimTreeLua.view.cursorline</code>, default false, to enable +cursorline in nvimtre.</p></li><li class="listitem"><p>Added Fidget.nvim support for the Catppuccin theme.</p></li><li class="listitem"><p>Updated bundled NodeJS version used by <code class="literal">Copilot.lua</code>. v16 is now marked as +insecure on Nixpkgs, and we updated to v18</p></li><li class="listitem"><p>Enabled Catppuccin modules for plugins available by default.</p></li><li class="listitem"><p>Added experimental Svelte support under <code class="literal">vim.languages</code>.</p></li><li class="listitem"><p>Removed unnecessary scrollbar element from notifications and codeaction +warning UI.</p></li><li class="listitem"><p><code class="literal">vim.utility.colorizer</code> has been renamed to <code class="literal">vim.utility.ccc</code> after the plugin +it uses</p></li><li class="listitem"><p>Color preview via <code class="literal">nvim-colorizer.lua</code></p></li><li class="listitem"><p>Updated Lualine statusline UI</p></li><li class="listitem"><p>Added vim-illuminate for smart highlighting</p></li><li class="listitem"><p>Added a module for enabling Neovim’s spellchecker</p></li><li class="listitem"><p>Added prettierd as an alternative formatter to prettier - currently defaults +to prettier</p></li><li class="listitem"><p>Fixed presence.nvim inheriting the wrong client id</p></li><li class="listitem"><p>Cleaned up documentation</p></li></ul></div> +</div> + +</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="sec-release-0.5" class="title" >Release 0.5 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.html#sec-release-0.5-changelog">Changelog</a> </span></dt> </dl></div><p>Release notes for release 0.5</p><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-0.5-changelog" class="title" style="clear: both">Changelog </h2> </div> </div></div><p><a class="link" href="https://github.com/vagahbond" target="_top">vagahbond</a>:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Added phan language server for PHP</p></li><li class="listitem"><p>Added phpactor language server for PHP</p></li></ul></div><p><a class="link" href="https://github.com/horriblename" target="_top">horriblename</a>:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Added transparency support for tokyonight theme</p></li><li class="listitem"><p>Fixed a bug where cmp’s close and scrollDocs mappings wasn’t working</p></li><li class="listitem"><p>Streamlined and simplified extra plugin API with the addition of +<a class="xref" href="options.html#opt-vim.extraPlugins" ><code class="option">vim.extraPlugins</code></a></p></li><li class="listitem"><p>Allow using command names in place of LSP packages to avoid automatic +installation</p></li><li class="listitem"><p>Add lua LSP and Treesitter support, and neodev.nvim plugin support</p></li><li class="listitem"><p>Add <a class="xref" href="options.html#opt-vim.lsp.mappings.toggleFormatOnSave" ><code class="option">vim.lsp.mappings.toggleFormatOnSave</code></a> keybind</p></li></ul></div><p><a class="link" href="https://github.com/amanse" target="_top">amanse</a>:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Added daily notes options for obsidian plugin</p></li><li class="listitem"><p>Added <code class="literal">jdt-language-server</code> for Java</p></li></ul></div><p><a class="link" href="https://github.com/yavko" target="_top">yavko</a>:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Added Deno Language Server for Javascript/Typescript</p></li><li class="listitem"><p>Added support for multiple languages under <code class="literal">vim.spellChecking.languages</code>, and +added vim-dirtytalk through <code class="literal">vim.spellChecking.enableProgrammingWordList</code></p></li></ul></div><p><a class="link" href="https://github.com/FrothyMarrow" target="_top">frothymarrow</a>:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Renamed <code class="literal">vim.visuals.cursorWordline</code> to <code class="literal">vim.visuals.cursorline.enable</code></p></li><li class="listitem"><p>Added <code class="literal">vim.visuals.cursorline.lineNumbersOnly</code> to display cursorline only in +the presence of line numbers</p></li><li class="listitem"><p>Added Oxocarbon to the list of available themes.</p></li></ul></div><p><a class="link" href="https://github.com/notashelf" target="_top">notashelf</a>:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Added GitHub Copilot to nvim-cmp completion sources.</p></li><li class="listitem"><p>Added <a class="xref" href="options.html#opt-vim.ui.borders.enable" ><code class="option">vim.ui.borders.enable</code></a> for global and individual plugin border +configuration.</p></li><li class="listitem"><p>LSP integrated breadcrumbs with <a class="xref" href="options.html#opt-vim.ui.breadcrumbs.enable" ><code class="option">vim.ui.breadcrumbs.enable</code></a> through +nvim-navic</p></li><li class="listitem"><p>LSP navigation helper with nvim-navbuddy, depends on nvim-navic (automatically +enabled if navic is enabled)</p></li><li class="listitem"><p>Added nvim-navic integration for Catppuccin theme</p></li><li class="listitem"><p>Fixed mismatching Zig language description</p></li><li class="listitem"><p>Added support for <code class="literal">statix</code> and <code class="literal">deadnix</code> through +<a class="xref" href="options.html#opt-vim.languages.nix.extraDiagnostics.types" ><code class="option">vim.languages.nix.extraDiagnostics.types</code></a></p></li><li class="listitem"><p>Added <code class="literal">lsp_lines</code> plugin for showing diagnostic messages</p></li><li class="listitem"><p>Added a configuration option for choosing the leader key</p></li><li class="listitem"><p>The package used for neovim is now customizable by the user, using +<a class="xref" href="options.html#opt-vim.package" ><code class="option">vim.package</code></a>. For best results, always use an unwrapped package</p></li><li class="listitem"><p>Added highlight-undo plugin for highlighting undo/redo targets</p></li><li class="listitem"><p>Added bash LSP and formatter support</p></li><li class="listitem"><p>Disabled Lualine LSP status indicator for Toggleterm buffer</p></li><li class="listitem"><p>Added <code class="literal">nvim-docs-view</code>, a plugin to display LSP hover documentation in a side +panel</p></li><li class="listitem"><p>Switched to <code class="literal">nixosOptionsDoc</code> in option documentation. To quote home-manager +commit: “Output is mostly unchanged aside from some minor typographical and +formatting changes, along with better source links.”</p></li><li class="listitem"><p>Updated indent-blankine.nvim to v3 - this comes with a few option changes, +which will be migrated with <code class="literal">renamedOptionModule</code></p></li></ul></div><p><a class="link" href="https://jacekpoz.pl" target="_top">jacekpoz</a>:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Fixed scrollOffset not being used</p></li><li class="listitem"><p>Updated clangd to 16</p></li><li class="listitem"><p>Disabled <code class="literal">useSystemClipboard</code> by default</p></li></ul></div><p><a class="link" href="https://github.com/ksonj" target="_top">ksonj</a>:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Add support to change mappings to utility/surround</p></li><li class="listitem"><p>Add black-and-isort python formatter</p></li><li class="listitem"><p>Removed redundant “Enable …” in <code class="literal">mkEnableOption</code> descriptions</p></li><li class="listitem"><p>Add options to modify LSP key bindings and add proper which-key descriptions</p></li><li class="listitem"><p>Changed type of <code class="literal">statusline.lualine.activeSection</code> and +<code class="literal">statusline.lualine.inactiveSection</code> from <code class="literal">attrsOf str</code> to +<code class="literal">attrsOf (listOf str)</code></p></li><li class="listitem"><p>Added <code class="literal">statusline.lualine.extraActiveSection</code> and +<code class="literal">statusline.lualine.extraInactiveSection</code></p></li></ul></div> +</div> + +</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="sec-release-0.6" class="title" >Release 0.6 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.html#sec-breaking-changes-and-migration-guide">Breaking Changes and Migration Guide</a> </span></dt><dt> <span class="section"> <a href="release-notes.html#sec-release-0.6-changelog">Changelog</a> </span></dt> </dl></div><p>Release notes for release 0.6</p><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-breaking-changes-and-migration-guide" class="title" style="clear: both">Breaking Changes and Migration Guide </h2> </div> </div></div><p>In v0.6 we are introducing <code class="literal">setupOpts</code>: many plugin related options are moved +into their respective <code class="literal">setupOpts</code> submodule, e.g. <code class="literal">nvimTree.disableNetrw</code> is +renamed to <code class="literal">nvimTree.setupOpts.disable_netrw</code>.</p><p><span class="emphasis"><em>Why?</em></span> in short, you can now pass in anything to setupOpts and it will be passed +to your <code class="literal">require'plugin'.setup{...}</code>. No need to wait for us to support every +single plugin option.</p><p>The warnings when you rebuild your config should be enough to guide you through +what you need to do, if there’s an option that was renamed but wasn’t listed in +the warning, please file a bug report!</p><p>To make your migration process less annoying, here’s a keybind that will help +you with renaming stuff from camelCase to snake_case (you’ll be doing that a +lot):</p><pre><code class="programlisting lua">-- paste this in a temp.lua file and load it in vim with :source /path/to/temp.lua +function camelToSnake() + -- Get the current word under the cursor + local word = vim.fn.expand("<cword>") + -- Replace each capital letter with an underscore followed by its lowercase equivalent + local snakeCase = string.gsub(word, "%u", function(match) + return "_" .. string.lower(match) + end) + -- Remove the leading underscore if present + if string.sub(snakeCase, 1, 1) == "_" then + snakeCase = string.sub(snakeCase, 2) + end + vim.fn.setreg(vim.v.register, snakeCase) + -- Select the word under the cursor and paste + vim.cmd("normal! viwP") +end + +vim.api.nvim_set_keymap('n', '<leader>a', ':lua camelToSnake()<CR>', { noremap = true, silent = true }) +</code></pre> +</div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-0.6-changelog" class="title" style="clear: both">Changelog </h2> </div> </div></div><p><a class="link" href="https://github.com/ksonj" target="_top">ksonj</a>:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Added Terraform language support.</p></li><li class="listitem"><p>Added <code class="literal">ChatGPT.nvim</code>, which can be enabled with +<a class="xref" href="options.html#opt-vim.assistant.chatgpt.enable" ><code class="option">vim.assistant.chatgpt.enable</code></a>. Do keep in mind that this option +requires <code class="literal">OPENAI_API_KEY</code> environment variable to be set.</p></li></ul></div><p><a class="link" href="https://github.com/donnerinoern" target="_top">donnerinoern</a>:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Added Gruvbox theme.</p></li><li class="listitem"><p>Added marksman LSP for Markdown.</p></li><li class="listitem"><p>Fixed markdown preview with Glow not working and added an option for changing +the preview keybind.</p></li><li class="listitem"><p>colorizer.nvim: switched to a maintained fork.</p></li><li class="listitem"><p>Added <code class="literal">markdown-preview.nvim</code>, moved <code class="literal">glow.nvim</code> to a brand new +<code class="literal">vim.utility.preview</code> category.</p></li></ul></div><p><a class="link" href="https://github.com/elijahimmer" target="_top">elijahimmer</a></p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p>Added rose-pine theme.</p></li></ul></div><p><a class="link" href="https://jacekpoz.pl" target="_top">jacekpoz</a>:</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p>Added <code class="literal">vim.autocomplete.alwaysComplete</code>. Allows users to have the autocomplete +window popup only when manually activated.</p></li></ul></div><p><a class="link" href="https://github.com/horriblename" target="_top">horriblename</a>:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Fixed empty winbar when breadcrumbs are disabled.</p></li><li class="listitem"><p>Added custom <code class="literal">setupOpts</code> for various plugins.</p></li><li class="listitem"><p>Removed support for deprecated plugin “nvim-compe”.</p></li><li class="listitem"><p>Moved most plugins to <code class="literal">setupOpts</code> method.</p></li></ul></div><p><a class="link" href="https://github.com/frothymarrow" target="_top">frothymarrow</a>:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Added option <code class="literal">vim.luaPackages</code> to wrap neovim with extra Lua packages.</p></li><li class="listitem"><p>Rewrote the entire <code class="literal">fidget.nvim</code> module to include extensive configuration +options. Option <code class="literal">vim.fidget-nvim.align.bottom</code> has been removed in favor of +<code class="literal">vim.fidget-nvim.notification.window.align</code>, which now supports <code class="literal">top</code> and +<code class="literal">bottom</code> values. <code class="literal">vim.fidget-nvim.align.right</code> has no longer any equivalent +and also has been removed.</p></li><li class="listitem"><p><code class="literal">which-key.nvim</code> categories can now be customized through +<a class="link" href="options.html#opt-vim.binds.whichKey.register" >vim.binds.whichKey.register</a></p></li><li class="listitem"><p>Added <code class="literal">magick</code> to <code class="literal">vim.luaPackages</code> for <code class="literal">image.nvim</code>.</p></li><li class="listitem"><p>Added <code class="literal">alejandra</code> to the default devShell.</p></li><li class="listitem"><p>Migrated neovim-flake to <code class="literal">makeNeovimUnstable</code> wrapper.</p></li></ul></div><p><a class="link" href="https://github.com/notashelf" target="_top">notashelf</a>:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Finished moving to <code class="literal">nixosOptionsDoc</code> in the documentation and changelog. All +documentation options and files are fully free of Asciidoc, and will now use +Nixpkgs flavored markdown.</p></li><li class="listitem"><p>Bumped plugin inputs to their latest versions.</p></li><li class="listitem"><p>Deprecated <code class="literal">presence.nvim</code> in favor of <code class="literal">neocord</code>. This means +<code class="literal">vim.rich-presence.presence-nvim</code> is removed and will throw a warning if used. +You are recommended to rewrite your neocord configuration from scratch based +on the. <a class="link" href="https://github.com/IogaMaster/neocord" target="_top">official documentation</a></p></li><li class="listitem"><p>Removed Tabnine plugin due to the usage of imperative tarball downloads. If +you’d like to see it back, please create an issue.</p></li><li class="listitem"><p>Added support for css and tailwindcss through +vscode-language-servers-extracted & tailwind-language-server. Those can be +enabled through <code class="literal">vim.languages.css</code> and <code class="literal">vim.languages.tailwind</code>.</p></li><li class="listitem"><p>Lualine module now allows customizing <code class="literal">always_divide_middle</code>, <code class="literal">ignore_focus</code> +and <code class="literal">disabled_filetypes</code> through the new options: +<a class="link" href="options.html#opt-vim.statusline.lualine.alwaysDivideMiddle" >vim.statusline.lualine.alwaysDivideMiddle</a>, +<a class="link" href="options.html#opt-vim.statusline.lualine.ignoreFocus" >vim.statusline.lualine.ignoreFocus</a> +and +<a class="link" href="options.html#opt-vim.statusline.lualine.disabledFiletypes" >vim.statusline.lualine.disabledFiletypes</a>.</p></li><li class="listitem"><p>Updated all plugin inputs to their latest versions (<span class="strong"><strong>21.04.2024</strong></span>) - this +brought minor color changes to the Catppuccin theme.</p></li><li class="listitem"><p>Moved home-manager module entrypoint to <code class="literal">flake/modules</code> and added an +experimental Nixos module. This requires further testing before it can be +considered ready for use.</p></li><li class="listitem"><p>Made lib calls explicit. E.g. <code class="literal">lib.strings.optionalString</code> instead of +<code class="literal">lib.optionalString</code>. This is a pattern expected to be followed by all +contributors in the future.</p></li><li class="listitem"><p>Added <code class="literal">image.nvim</code> for image previews.</p></li><li class="listitem"><p>The final neovim package is now exposed. This means you can build the neovim +package that will be added to your package list without rebuilding your system +to test if your configuration yields a broken package.</p></li><li class="listitem"><p>Changed the tree structure to distinguish between core options and plugin +options.</p></li><li class="listitem"><p>Added plugin auto-discovery from plugin inputs. This is mostly from +<a class="link" href="https://github.com/jordanisaacs/neovim-flake" target="_top">JordanIsaac’s neovim-flake</a>. +Allows contributors to add plugin inputs with the <code class="literal">plugin-</code> prefix to have +them automatically discovered for the <code class="literal">plugin</code> type in <code class="literal">lib/types</code>.</p></li><li class="listitem"><p>Moved internal <code class="literal">wrapLuaConfig</code> to the extended library, structured its +arguments to take <code class="literal">luaBefore</code>, <code class="literal">luaConfig</code> and <code class="literal">luaAfter</code> as strings, which +are then concatted inside a lua block.</p></li><li class="listitem"><p>Added <a class="xref" href="options.html#opt-vim.luaConfigPre" ><code class="option">vim.luaConfigPre</code></a> and <a class="xref" href="options.html#opt-vim.luaConfigPost" ><code class="option">vim.luaConfigPost</code></a> for inserting +verbatim Lua configuration before and after the resolved Lua DAG respectively. +Both of those options take strings as the type, so you may read the contents +of a Lua file from a given path.</p></li><li class="listitem"><p>Added <code class="literal">vim.spellchecking.ignoredFiletypes</code> and +<code class="literal">vim.spellChecking.programmingWordlist.enable</code> for ignoring certain filetypes +in spellchecking and enabling <code class="literal">vim-dirtytalk</code> respectively. The previously +used <code class="literal">vim.spellcheck.vim-dirtytalk</code> aliases to the latter option.</p></li><li class="listitem"><p>Exposed <code class="literal">withRuby</code>, <code class="literal">withNodeJs</code>, <code class="literal">withPython3</code>, and <code class="literal">python3Packages</code> from +the <code class="literal">makeNeovimConfig</code> function under their respective options.</p></li><li class="listitem"><p>Added <a class="xref" href="options.html#opt-vim.extraPackages" ><code class="option">vim.extraPackages</code></a> for appending additional packages to the +wrapper PATH, making said packages available while inside the Neovim session.</p></li><li class="listitem"><p>Made Treesitter options configurable, and moved treesitter-context to +<code class="literal">setupOpts</code> while it is enabled.</p></li><li class="listitem"><p>Added <a class="xref" href="options.html#opt-vim.notify.nvim-notify.setupOpts.render" ><code class="option">vim.notify.nvim-notify.setupOpts.render</code></a> which takes either a +string of enum, or a Lua function. The default is “compact”, but you may +change it according to nvim-notify documentation.</p></li></ul></div> +</div> + +</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="sec-release-0.7" class="title" >Release 0.7 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.html#sec-breaking-changes-and-migration-guide-0-7">Breaking Changes and Migration Guide</a> </span></dt><dd><dl><dt> <span class="section"> <a href="release-notes.html#sec-vim-configrc-removed"><code class="literal">vim.configRC</code> removed</a> </span></dt><dt> <span class="section"> <a href="release-notes.html#sec-vim-maps-rewrite"><code class="literal">vim.maps</code> rewrite</a> </span></dt><dt> <span class="section"> <a href="release-notes.html#sec-nvim-code-action-menu-deprecation"><code class="literal">vim.lsp.nvimCodeActionMenu</code> removed in favor of <code class="literal">vim.ui.fastaction</code></a> </span></dt><dt> <span class="section"> <a href="release-notes.html#sec-type-based-modules-removed"><code class="literal">type</code> based modules removed</a> </span></dt><dt> <span class="section"> <a href="release-notes.html#sec-nixpkgs-fmt-deprecation"><code class="literal">nixpkgs-fmt</code> removed in favor of <code class="literal">nixfmt</code></a> </span></dt><dt> <span class="section"> <a href="release-notes.html#sec-leader-changes">leader changes</a> </span></dt><dt> <span class="section"> <a href="release-notes.html#sec-vim-opt-changes"><code class="literal">vim.*</code> changes</a> </span></dt></dl></dd><dt> <span class="section"> <a href="release-notes.html#sec-release-0.7-changelog">Changelog</a> </span></dt> </dl></div><p>Release notes for release 0.7</p><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-breaking-changes-and-migration-guide-0-7" class="title" style="clear: both">Breaking Changes and Migration Guide </h2> </div> </div></div><div class="toc"> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.html#sec-vim-configrc-removed"><code class="literal">vim.configRC</code> removed</a> </span></dt><dt> <span class="section"> <a href="release-notes.html#sec-vim-maps-rewrite"><code class="literal">vim.maps</code> rewrite</a> </span></dt><dt> <span class="section"> <a href="release-notes.html#sec-nvim-code-action-menu-deprecation"><code class="literal">vim.lsp.nvimCodeActionMenu</code> removed in favor of <code class="literal">vim.ui.fastaction</code></a> </span></dt><dt> <span class="section"> <a href="release-notes.html#sec-type-based-modules-removed"><code class="literal">type</code> based modules removed</a> </span></dt><dt> <span class="section"> <a href="release-notes.html#sec-nixpkgs-fmt-deprecation"><code class="literal">nixpkgs-fmt</code> removed in favor of <code class="literal">nixfmt</code></a> </span></dt><dt> <span class="section"> <a href="release-notes.html#sec-leader-changes">leader changes</a> </span></dt><dt> <span class="section"> <a href="release-notes.html#sec-vim-opt-changes"><code class="literal">vim.*</code> changes</a> </span></dt> </dl></div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-vim-configrc-removed" class="title" ><code class="literal">vim.configRC</code> removed </h3> </div> </div></div><p>In v0.7 we are removing <code class="literal">vim.configRC</code> in favor of making <code class="literal">vim.luaConfigRC</code> the +top-level DAG, and thereby making the entire configuration Lua based. This +change introduces a few breaking changes:</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p><code class="literal">vim.configRC</code> has been removed, which means that you have to convert all of +your custom vimscript-based configuration to Lua. As for how to do that, you +will have to consult the Neovim documentation and your search engine.</p></li><li class="listitem"><p>After migrating your Vimscript-based configuration to Lua, you might not be +able to use the same entry names in <code class="literal">vim.luaConfigRC</code>, because those have also +slightly changed. See the new <a class="link" href="/index.xhtml#ch-dag-entries" target="_top">DAG entries in nvf manual</a> for more details.</p></li></ul></div><p><span class="strong"><strong>Why?</strong></span></p><p>Neovim being an aggressive refactor of Vim, is designed to be mainly Lua based; +making good use of its extensive Lua API. Additionally, Vimscript is slow and +brings unnecessary performance overhead while working with different +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 (e.g., <code class="literal">vim.maps.normal</code>), a +new <code class="literal">vim.keymaps</code> submodule with support for a <code class="literal">mode</code> option has been +introduced. It can be either a string, or a list of strings, where a string +represents the short-name of the map mode(s), that the mapping should be set +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."<leader>m" = { ... }; +</code></pre><p>has to be replaced by</p><pre><code class="programlisting nix">vim.keymaps = [ + { + key = "<leader>m"; + mode = "n"; + } + ... +]; +</code></pre> +</div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-nvim-code-action-menu-deprecation" class="title" ><code class="literal">vim.lsp.nvimCodeActionMenu</code> removed in favor of <code class="literal">vim.ui.fastaction</code> </h3> </div> </div></div><p>The nvim-code-action-menu plugin has been archived and broken for a long time, +so it’s being replaced with a young, but better alternative called +fastaction.nvim. Simply remove everything set under +<code class="literal">vim.lsp.nvimCodeActionMenu</code>, and set <code class="literal">vim.ui.fastaction.enable</code> to <code class="literal">true</code>.</p><p>Note that we are looking to add more alternatives in the future like +dressing.nvim and actions-preview.nvim, in case fastaction doesn’t work for +everyone.</p> +</div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-type-based-modules-removed" class="title" ><code class="literal">type</code> based modules removed </h3> </div> </div></div><p>As part of the autocompletion rewrite, modules that used to use a <code class="literal">type</code> option +have been replaced by per-plugin modules instead. Since both modules only had +one type, you can simply change</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p><code class="literal">vim.autocomplete.*</code> -> <code class="literal">vim.autocomplete.nvim-cmp.*</code></p></li><li class="listitem"><p><code class="literal">vim.autopairs.enable</code> -> <code class="literal">vim.autopairs.nvim-autopairs.enable</code></p></li></ul></div> +</div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-nixpkgs-fmt-deprecation" class="title" ><code class="literal">nixpkgs-fmt</code> removed in favor of <code class="literal">nixfmt</code> </h3> </div> </div></div><p><code class="literal">nixpkgs-fmt</code> has been archived for a while, and it’s finally being removed in +favor of nixfmt (more information can be found +<a class="link" href="https://github.com/nix-community/nixpkgs-fmt?tab=readme-ov-file#nixpkgs-fmt---nix-code-formatter-for-nixpkgs" target="_top">here</a>.</p><p>To migrate to <code class="literal">nixfmt</code>, simply change <code class="literal">vim.languages.nix.format.type</code> to +<code class="literal">nixfmt</code>.</p> +</div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-leader-changes" class="title" >leader changes </h3> </div> </div></div><p>This has been deprecated in favor of using the more generic <code class="literal">vim.globals</code> (you +can use <code class="literal">vim.globals.mapleader</code> to change this instead).</p><p>Rust specific keymaps now use <code class="literal">maplocalleader</code> instead of <code class="literal">localleader</code> by +default. This is to avoid conflicts with other modules. You can change +<code class="literal">maplocalleader</code> with <code class="literal">vim.globals.maplocalleader</code>, but it’s recommended to set +it to something other than <code class="literal">mapleader</code> to avoid conflicts.</p> +</div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-vim-opt-changes" class="title" ><code class="literal">vim.*</code> changes </h3> </div> </div></div><p>Inline with the <a class="link" href="release-notes.html#sec-leader-changes" title="leader changes" >leader changes</a>, we have removed some +options that were under <code class="literal">vim</code> as convenient shorthands for <code class="literal">vim.o.*</code> options.</p><div class="warning"><h3 class="title">Warning</h3><p>As v0.7 features the addition of <a class="xref" href="options.html#opt-vim.options" ><code class="option">vim.options</code></a>, those options are now +considered as deprecated. You should migrate to the appropriate options in the +<code class="literal">vim.options</code> submodule.</p></div><p>The changes are, in no particular order:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p><code class="literal">colourTerm</code>, <code class="literal">mouseSupport</code>, <code class="literal">cmdHeight</code>, <code class="literal">updateTime</code>, <code class="literal">mapTime</code>, +<code class="literal">cursorlineOpt</code>, <code class="literal">splitBelow</code>, <code class="literal">splitRight</code>, <code class="literal">autoIndent</code> and <code class="literal">wordWrap</code> have +been mapped to their <a class="xref" href="options.html#opt-vim.options" ><code class="option">vim.options</code></a> equivalents. Please see the module +definition for the updated options.</p></li><li class="listitem"><p><code class="literal">tabWidth</code> has been <span class="strong"><strong>removed</strong></span> as it lead to confusing behaviour. You can +replicate the same functionality by setting <code class="literal">shiftwidth</code>, <code class="literal">tabstop</code> and +<code class="literal">softtabstop</code> under <code class="literal">vim.options</code> as you see fit.</p></li></ul></div> +</div> + +</div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-0.7-changelog" class="title" style="clear: both">Changelog </h2> </div> </div></div><p><a class="link" href="https://github.com/ItsSorae" target="_top">ItsSorae</a>:</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p>Add support for <a class="link" href="https://typst.app/" target="_top">typst</a> under <code class="literal">vim.languages.typst</code> This +will enable the <code class="literal">typst-lsp</code> language server, and the <code class="literal">typstfmt</code> formatter</p></li></ul></div><p><a class="link" href="https://github.com/frothymarrow" target="_top">frothymarrow</a>:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Modified type for +<a class="xref" href="options.html#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides" ><code class="option">vim.visuals.fidget-nvim.setupOpts.progress.display.overrides</code></a> from +<code class="literal">anything</code> to a <code class="literal">submodule</code> for better type checking.</p></li><li class="listitem"><p>Fix null <code class="literal">vim.lsp.mappings</code> generating an error and not being filtered out.</p></li><li class="listitem"><p>Add basic transparency support for <code class="literal">oxocarbon</code> theme by setting the highlight +group for <code class="literal">Normal</code>, <code class="literal">NormalFloat</code>, <code class="literal">LineNr</code>, <code class="literal">SignColumn</code> and optionally +<code class="literal">NvimTreeNormal</code> to <code class="literal">none</code>.</p></li><li class="listitem"><p>Fix <a class="xref" href="options.html#opt-vim.ui.smartcolumn.setupOpts.custom_colorcolumn" ><code class="option">vim.ui.smartcolumn.setupOpts.custom_colorcolumn</code></a> using the wrong +type <code class="literal">int</code> instead of the expected type <code class="literal">string</code>.</p></li></ul></div><p><a class="link" href="https://github.com/horriblename" target="_top">horriblename</a>:</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p>Fix broken treesitter-context keybinds in visual mode</p></li><li class="listitem"><p>Deprecate use of <code class="literal">__empty</code> to define empty tables in Lua. Empty attrset are no +longer filtered and thus should be used instead.</p></li><li class="listitem"><p>Add dap-go for better dap configurations</p></li><li class="listitem"><p>Make noice.nvim customizable</p></li><li class="listitem"><p>Standardize border style options and add custom borders</p></li><li class="listitem"><p>Remove <code class="literal">vim.disableDefaultRuntimePaths</code> in wrapper options.</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: circle;"><li class="listitem"><p>As nvf uses <code class="literal">$NVIM_APP_NAME</code> as of recent changes, we can safely assume any +configuration in <code class="literal">$XDG_CONFIG_HOME/nvf</code> is intentional.</p></li></ul></div></li></ul></div><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p>Switch from <a class="link" href="https://github.com/simrat39/rust-tools.nvim" target="_top">rust-tools.nvim</a> to the more feature-packed <a class="link" href="https://github.com/mrcjkb/rustaceanvim" target="_top">rustaceanvim</a>. This +switch entails a whole bunch of new features and options, so you are +recommended to go through rustacean.nvim’s README to take a closer look at its +features and usage</p></li></ul></div><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p>Add <a class="link" href="https://github.com/mrcjkb/lz.n" target="_top">lz.n</a> support and lazy-load some builtin plugins.</p></li><li class="listitem"><p>Add simpler helper functions for making keymaps</p></li></ul></div><p><a class="link" href="https://jacekpoz.pl" target="_top">jacekpoz</a>:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Add <a class="link" href="https://github.com/ocaml/ocaml-lsp" target="_top">ocaml-lsp</a> support</p></li><li class="listitem"><p>Fix “Emac” typo</p></li><li class="listitem"><p>Add <a class="link" href="https://github.com/otavioschwanck/new-file-template.nvim" target="_top">new-file-template.nvim</a> to automatically fill new file contents using +templates</p></li><li class="listitem"><p>Make <a class="link" href="https://github.com/nvim-neo-tree/neo-tree.nvim" target="_top">neo-tree.nvim</a> display file icons properly by enabling +<code class="literal">visuals.nvimWebDevicons</code></p></li></ul></div><p><a class="link" href="https://github.com/diniamo" target="_top">diniamo</a>:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Move the <code class="literal">theme</code> dag entry to before <code class="literal">luaScript</code>.</p></li><li class="listitem"><p>Add rustfmt as the default formatter for Rust.</p></li><li class="listitem"><p>Enabled the terminal integration of catppuccin for theming Neovim’s built-in +terminal (this also affects toggleterm).</p></li><li class="listitem"><p>Migrate bufferline to setupOpts for more customizability</p></li><li class="listitem"><p>Use <code class="literal">clangd</code> as the default language server for C languages</p></li><li class="listitem"><p>Expose <code class="literal">lib.nvim.types.pluginType</code>, which for example allows the user to +create abstractions for adding plugins</p></li><li class="listitem"><p>Migrate indent-blankline to setupOpts for more customizability. While the +plugin’s options can now be found under <code class="literal">indentBlankline.setupOpts</code>, the +previous iteration of the module also included out of place/broken options, +which have been removed for the time being. These are:</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: circle;"><li class="listitem"><p><code class="literal">listChar</code> - this was already unused</p></li><li class="listitem"><p><code class="literal">fillChar</code> - this had nothing to do with the plugin, please configure it +yourself by adding <code class="literal">vim.opt.listchars:append({ space = '<char>' })</code> to your +lua configuration</p></li><li class="listitem"><p><code class="literal">eolChar</code> - this also had nothing to do with the plugin, please configure it +yourself by adding <code class="literal">vim.opt.listchars:append({ eol = '<char>' })</code> to your +lua configuration</p></li></ul></div></li><li class="listitem"><p>Replace <code class="literal">vim.lsp.nvimCodeActionMenu</code> with <code class="literal">vim.ui.fastaction</code>, see the +breaking changes section above for more details</p></li><li class="listitem"><p>Add a <code class="literal">setupOpts</code> option to nvim-surround, which allows modifying options that +aren’t defined in nvf. Move the alternate nvim-surround keybinds to use +<code class="literal">setupOpts</code>.</p></li><li class="listitem"><p>Remove <code class="literal">autopairs.type</code>, and rename <code class="literal">autopairs.enable</code> to +<code class="literal">autopairs.nvim-autopairs.enable</code>. The new +<a class="xref" href="options.html#opt-vim.autopairs.nvim-autopairs.enable" ><code class="option">vim.autopairs.nvim-autopairs.enable</code></a> supports <code class="literal">setupOpts</code> format by +default.</p></li><li class="listitem"><p>Refactor of <code class="literal">nvim-cmp</code> and completion related modules</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: circle;"><li class="listitem"><p>Remove <code class="literal">autocomplete.type</code> in favor of per-plugin enable options such as +<a class="xref" href="options.html#opt-vim.autocomplete.nvim-cmp.enable" ><code class="option">vim.autocomplete.nvim-cmp.enable</code></a>.</p></li><li class="listitem"><p>Deprecate legacy Vimsnip in favor of Luasnip, and integrate +friendly-snippets for bundled snippets. <a class="xref" href="options.html#opt-vim.snippets.luasnip.enable" ><code class="option">vim.snippets.luasnip.enable</code></a> +can be used to toggle Luasnip.</p></li><li class="listitem"><p>Add sorting function options for completion sources under +<a class="xref" href="options.html#opt-vim.autocomplete.nvim-cmp.setupOpts.sorting.comparators" ><code class="option">vim.autocomplete.nvim-cmp.setupOpts.sorting.comparators</code></a></p></li></ul></div></li><li class="listitem"><p>Add C# support under <code class="literal">vim.languages.csharp</code>, with support for both +omnisharp-roslyn and csharp-language-server.</p></li><li class="listitem"><p>Add Julia support under <code class="literal">vim.languages.julia</code>. Note that the entirety of Julia +is bundled with nvf, if you enable the module, since there is no way to +provide only the LSP server.</p></li><li class="listitem"><p>Add <a class="link" href="https://github.com/diniamo/run.nvim" target="_top"><code class="literal">run.nvim</code></a> support for running code +using cached commands.</p></li></ul></div><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Make Neovim’s configuration file entirely Lua based. This comes with a few +breaking changes:</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: circle;"><li class="listitem"><p><code class="literal">vim.configRC</code> has been removed. You will need to migrate your entries to +Neovim-compliant Lua code, and add them to <code class="literal">vim.luaConfigRC</code> instead. +Existing vimscript configurations may be preserved in <code class="literal">vim.cmd</code> functions. +Please see <a class="link" href="https://neovim.io/doc/user/lua.html#vim.cmd()" target="_top">Neovim documentation on <code class="literal">vim.cmd</code></a></p></li><li class="listitem"><p><code class="literal">vim.luaScriptRC</code> is now the top-level DAG, and the internal <code class="literal">vim.pluginRC</code> +has been introduced for setting up internal plugins. See the “DAG entries in +nvf” manual page for more information.</p></li></ul></div></li><li class="listitem"><p>Rewrite <code class="literal">vim.maps</code>, see the breaking changes section above.</p></li></ul></div><p><a class="link" href="https://github.com/notashelf" target="_top">NotAShelf</a>:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Add <code class="literal">deno fmt</code> as the default Markdown formatter. This will be enabled +automatically if you have autoformatting enabled, but can be disabled manually +if you choose to.</p></li><li class="listitem"><p>Add <code class="literal">vim.extraLuaFiles</code> for optionally sourcing additional lua files in your +configuration.</p></li><li class="listitem"><p>Refactor <code class="literal">programs.languages.elixir</code> to use lspconfig and none-ls for LSP and +formatter setups respectively. Diagnostics support is considered, and may be +added once the <a class="link" href="https://github.com/rrrene/credo" target="_top">credo</a> linter has been added to nixpkgs. A pull request is +currently open.</p></li><li class="listitem"><p>Remove vim-tidal and friends.</p></li><li class="listitem"><p>Clean up Lualine module to reduce theme dependency on Catppuccin, and fixed +blending issues in component separators.</p></li><li class="listitem"><p>Add [ts-ereror-translator.nvim] extension of the TS language module, under +<code class="literal">vim.languages.ts.extensions.ts-error-translator</code> to aid with Typescript +development.</p></li><li class="listitem"><p>Add <a class="link" href="https://github.com/nvim-neo-tree/neo-tree.nvim" target="_top">neo-tree.nvim</a> as an alternative file-tree plugin. It will be available +under <code class="literal">vim.filetree.neo-tree</code>, similar to nvimtree.</p></li><li class="listitem"><p>Add <code class="literal">nvf-print-config</code> & <code class="literal">nvf-print-config-path</code> helper scripts to Neovim +closure. Both of those scripts have been automatically added to your PATH upon +using neovimConfig or <code class="literal">programs.nvf.enable</code>.</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: circle;"><li class="listitem"><p><code class="literal">nvf-print-config</code> will display your <code class="literal">init.lua</code>, in full.</p></li><li class="listitem"><p><code class="literal">nvf-print-config-path</code> will display the path to <span class="emphasis"><em>a clone</em></span> of your +<code class="literal">init.lua</code>. This is not the path used by the Neovim wrapper, but an +identical clone.</p></li></ul></div></li><li class="listitem"><p>Add <code class="literal">vim.ui.breadcrumbs.lualine</code> to allow fine-tuning breadcrumbs behaviour on +Lualine. Only <code class="literal">vim.ui.breadcrumbs.lualine.winbar</code> is supported for the time +being.</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: circle;"><li class="listitem"><p><a class="xref" href="options.html#opt-vim.ui.breadcrumbs.lualine.winbar.enable" ><code class="option">vim.ui.breadcrumbs.lualine.winbar.enable</code></a> has been added to allow +controlling the default behaviour of the <code class="literal">nvim-navic</code> component on Lualine, +which used to occupy <code class="literal">winbar.lualine_c</code> as long as breadcrumbs are enabled.</p></li><li class="listitem"><p><code class="literal">vim.ui.breadcrumbs.alwaysRender</code> has been renamed to +<a class="xref" href="options.html#opt-vim.ui.breadcrumbs.lualine.winbar.alwaysRender" ><code class="option">vim.ui.breadcrumbs.lualine.winbar.alwaysRender</code></a> to be conform to the +new format.</p></li></ul></div></li><li class="listitem"><p>Add <a class="link" href="https://github.com/detachhead/basedpyright" target="_top">basedpyright</a> as a Python LSP +server and make it default.</p></li><li class="listitem"><p>Add <a class="link" href="https://github.com/python-lsp/python-lsp-server" target="_top">python-lsp-server</a> as an +additional Python LSP server.</p></li><li class="listitem"><p>Add <a class="xref" href="options.html#opt-vim.options" ><code class="option">vim.options</code></a> to set <code class="literal">vim.o</code> values in in your nvf configuration +without using additional Lua. See option documentation for more details.</p></li><li class="listitem"><p>Add <a class="xref" href="options.html#opt-vim.dashboard.dashboard-nvim.setupOpts" ><code class="option">vim.dashboard.dashboard-nvim.setupOpts</code></a> to allow user +configuration for <a class="link" href="https://github.com/nvimdev/dashboard-nvim" target="_top">dashboard.nvim</a></p></li><li class="listitem"><p>Update <code class="literal">lualine.nvim</code> input and add missing themes:</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: circle;"><li class="listitem"><p>Adds <code class="literal">ayu</code>, <code class="literal">gruvbox_dark</code>, <code class="literal">iceberg</code>, <code class="literal">moonfly</code>, <code class="literal">onedark</code>, +<code class="literal">powerline_dark</code> and <code class="literal">solarized_light</code> themes.</p></li></ul></div></li><li class="listitem"><p>Add <a class="xref" href="options.html#opt-vim.spellcheck.extraSpellWords" ><code class="option">vim.spellcheck.extraSpellWords</code></a> to allow adding arbitrary +spellfiles to Neovim’s runtime with ease.</p></li><li class="listitem"><p>Add combined nvf configuration (<code class="literal">config.vim</code>) into the final package’s +<code class="literal">passthru</code> as <code class="literal">passthru.neovimConfiguration</code> for easier debugging.</p></li><li class="listitem"><p>Add support for <a class="link" href="https://github.com/rachartier/tiny-devicons-auto-colors.nvim" target="_top">tiny-devicons-auto-colors</a> under +<code class="literal">vim.visuals.tiny-devicons-auto-colors</code></p></li><li class="listitem"><p>Move options that used to set <code class="literal">vim.o</code> values (e.g. <code class="literal">vim.wordWrap</code>) into +<code class="literal">vim.options</code> as default values. Some are left as they don’t have a direct +equivalent, but expect a switch eventually.</p></li></ul></div><p><a class="link" href="https://github.com/ppenguin" target="_top">ppenguin</a>:</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p>Telescope:</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: circle;"><li class="listitem"><p>Fixed <code class="literal">project-nvim</code> command and keybinding</p></li><li class="listitem"><p>Added default ikeybind/command for <code class="literal">Telescope resume</code> (<code class="literal"><leader>fr</code>)</p></li></ul></div></li><li class="listitem"><p>Add <code class="literal">hcl</code> lsp/formatter (not the same as <code class="literal">terraform</code>, which is not useful for +e.g. <code class="literal">nomad</code> config files).</p></li></ul></div><p><a class="link" href="https://github.com/Soliprem" target="_top">Soliprem</a>:</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p>Add LSP and Treesitter support for R under <code class="literal">vim.languages.R</code>.</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: circle;"><li class="listitem"><p>Add formatter support for R, with styler and formatR as options</p></li></ul></div></li><li class="listitem"><p>Add Otter support under <code class="literal">vim.lsp.otter</code> and an assert to prevent conflict with +ccc</p></li><li class="listitem"><p>Fixed typo in Otter’s setupOpts</p></li><li class="listitem"><p>Add Neorg support under <code class="literal">vim.notes.neorg</code></p></li><li class="listitem"><p>Add LSP, diagnostics, formatter and Treesitter support for Kotlin under +<code class="literal">vim.languages.kotlin</code></p></li><li class="listitem"><p>changed default keybinds for leap.nvim to avoid altering expected behavior</p></li><li class="listitem"><p>Add LSP, formatter and Treesitter support for Vala under <code class="literal">vim.languages.vala</code></p></li><li class="listitem"><p>Add [Tinymist](https://github.com/Myriad-Dreamin/tinymist] as a formatter for +the Typst language module.</p></li><li class="listitem"><p>Add LSP and Treesitter support for Assembly under <code class="literal">vim.languages.assembly</code></p></li><li class="listitem"><p>Move <a class="link" href="https://github.com/folke/which-key.nvim" target="_top">which-key</a> to the new spec</p></li><li class="listitem"><p>Add LSP and Treesitter support for Nushell under <code class="literal">vim.languages.nu</code></p></li><li class="listitem"><p>Add LSP and Treesitter support for Gleam under <code class="literal">vim.languages.gleam</code></p></li></ul></div><p><a class="link" href="https://github.com/Bloxx12" target="_top">Bloxx12</a></p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p>Add support for <a class="link" href="https://github.com/RRethy/base16-nvim" target="_top">base16 theming</a> under +<code class="literal">vim.theme</code></p></li><li class="listitem"><p>Fix internal breakage in <code class="literal">elixir-tools</code> setup.</p></li></ul></div><p><a class="link" href="https://github.com/ksonj" target="_top">ksonj</a>:</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p>Add LSP support for Scala via +<a class="link" href="https://github.com/scalameta/nvim-metals" target="_top">nvim-metals</a></p></li></ul></div><p><a class="link" href="https://github.com/nezia1" target="_top">nezia1</a>:</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p>Add <a class="link" href="https://github.com/biomejs/biome" target="_top">biome</a> support for Typescript, CSS and +Svelte. Enable them via <a class="xref" href="options.html#opt-vim.languages.ts.format.type" ><code class="option">vim.languages.ts.format.type</code></a>, +<a class="xref" href="options.html#opt-vim.languages.css.format.type" ><code class="option">vim.languages.css.format.type</code></a> and +<a class="xref" href="options.html#opt-vim.languages.svelte.format.type" ><code class="option">vim.languages.svelte.format.type</code></a> respectively.</p></li><li class="listitem"><p>Replace <a class="link" href="https://github.com/nix-community/nixpkgs-fmt" target="_top">nixpkgs-fmt</a> with +<a class="link" href="https://github.com/NixOS/nixfmt" target="_top">nixfmt</a> (nixfmt-rfc-style).</p></li></ul></div><p><a class="link" href="https://github.com/Nowaaru" target="_top">Nowaaru</a>:</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p>Add <code class="literal">precognition-nvim</code>.</p></li></ul></div><p><a class="link" href="https://github.com/DamitusThyYeetus123" target="_top">DamitusThyYeeticus123</a>:</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p>Add support for <a class="link" href="https://astro.build/" target="_top">Astro</a> language server.</p></li></ul></div> +</div> + +</div> +</div> <div class="navfooter"> + <hr /> + <table width="100%" summary="Navigation footer"> + <tr> + <td width="40%" align="left"><a accesskey="p" href="options.html">Prev</a> </td> + <td width="20%" align="center"> </td> + <td width="40%" align="right"> </td> + </tr> + <tr> + <td width="40%" align="left" valign="top">Appendix B. Neovim Flake Configuration Options </td> + <td width="20%" align="center"><a accesskey="h" href="index.xhtml">Home</a></td> + <td width="40%" align="right" valign="top"> </td> + </tr> + </table> + </div> + </body> +</html> \ No newline at end of file diff --git a/docs-preview-569/script/anchor-min.js b/docs-preview-569/script/anchor-min.js new file mode 100644 index 000000000..70565172d --- /dev/null +++ b/docs-preview-569/script/anchor-min.js @@ -0,0 +1,10 @@ +// @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt Expat +// +// AnchorJS - v5.0.0 - 2023-01-18 +// https://www.bryanbraun.com/anchorjs/ +// Copyright (c) 2023 Bryan Braun; Licensed MIT +// +// @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt Expat +!function(A,e){"use strict";"function"==typeof define&&define.amd?define([],e):"object"==typeof module&&module.exports?module.exports=e():(A.AnchorJS=e(),A.anchors=new A.AnchorJS)}(globalThis,function(){"use strict";return function(A){function u(A){A.icon=Object.prototype.hasOwnProperty.call(A,"icon")?A.icon:"",A.visible=Object.prototype.hasOwnProperty.call(A,"visible")?A.visible:"hover",A.placement=Object.prototype.hasOwnProperty.call(A,"placement")?A.placement:"right",A.ariaLabel=Object.prototype.hasOwnProperty.call(A,"ariaLabel")?A.ariaLabel:"Anchor",A.class=Object.prototype.hasOwnProperty.call(A,"class")?A.class:"",A.base=Object.prototype.hasOwnProperty.call(A,"base")?A.base:"",A.truncate=Object.prototype.hasOwnProperty.call(A,"truncate")?Math.floor(A.truncate):64,A.titleText=Object.prototype.hasOwnProperty.call(A,"titleText")?A.titleText:""}function d(A){var e;if("string"==typeof A||A instanceof String)e=[].slice.call(document.querySelectorAll(A));else{if(!(Array.isArray(A)||A instanceof NodeList))throw new TypeError("The selector provided to AnchorJS was invalid.");e=[].slice.call(A)}return e}this.options=A||{},this.elements=[],u(this.options),this.add=function(A){var e,t,o,i,n,s,a,r,l,c,h,p=[];if(u(this.options),0!==(e=d(A=A||"h2, h3, h4, h5, h6")).length){for(null===document.head.querySelector("style.anchorjs")&&((A=document.createElement("style")).className="anchorjs",A.appendChild(document.createTextNode("")),void 0===(h=document.head.querySelector('[rel="stylesheet"],style'))?document.head.appendChild(A):document.head.insertBefore(A,h),A.sheet.insertRule(".anchorjs-link{opacity:0;text-decoration:none;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}",A.sheet.cssRules.length),A.sheet.insertRule(":hover>.anchorjs-link,.anchorjs-link:focus{opacity:1}",A.sheet.cssRules.length),A.sheet.insertRule("[data-anchorjs-icon]::after{content:attr(data-anchorjs-icon)}",A.sheet.cssRules.length),A.sheet.insertRule('@font-face{font-family:anchorjs-icons;src:url(data:n/a;base64,AAEAAAALAIAAAwAwT1MvMg8yG2cAAAE4AAAAYGNtYXDp3gC3AAABpAAAAExnYXNwAAAAEAAAA9wAAAAIZ2x5ZlQCcfwAAAH4AAABCGhlYWQHFvHyAAAAvAAAADZoaGVhBnACFwAAAPQAAAAkaG10eASAADEAAAGYAAAADGxvY2EACACEAAAB8AAAAAhtYXhwAAYAVwAAARgAAAAgbmFtZQGOH9cAAAMAAAAAunBvc3QAAwAAAAADvAAAACAAAQAAAAEAAHzE2p9fDzz1AAkEAAAAAADRecUWAAAAANQA6R8AAAAAAoACwAAAAAgAAgAAAAAAAAABAAADwP/AAAACgAAA/9MCrQABAAAAAAAAAAAAAAAAAAAAAwABAAAAAwBVAAIAAAAAAAIAAAAAAAAAAAAAAAAAAAAAAAMCQAGQAAUAAAKZAswAAACPApkCzAAAAesAMwEJAAAAAAAAAAAAAAAAAAAAARAAAAAAAAAAAAAAAAAAAAAAQAAg//0DwP/AAEADwABAAAAAAQAAAAAAAAAAAAAAIAAAAAAAAAIAAAACgAAxAAAAAwAAAAMAAAAcAAEAAwAAABwAAwABAAAAHAAEADAAAAAIAAgAAgAAACDpy//9//8AAAAg6cv//f///+EWNwADAAEAAAAAAAAAAAAAAAAACACEAAEAAAAAAAAAAAAAAAAxAAACAAQARAKAAsAAKwBUAAABIiYnJjQ3NzY2MzIWFxYUBwcGIicmNDc3NjQnJiYjIgYHBwYUFxYUBwYGIwciJicmNDc3NjIXFhQHBwYUFxYWMzI2Nzc2NCcmNDc2MhcWFAcHBgYjARQGDAUtLXoWOR8fORYtLTgKGwoKCjgaGg0gEhIgDXoaGgkJBQwHdR85Fi0tOAobCgoKOBoaDSASEiANehoaCQkKGwotLXoWOR8BMwUFLYEuehYXFxYugC44CQkKGwo4GkoaDQ0NDXoaShoKGwoFBe8XFi6ALjgJCQobCjgaShoNDQ0NehpKGgobCgoKLYEuehYXAAAADACWAAEAAAAAAAEACAAAAAEAAAAAAAIAAwAIAAEAAAAAAAMACAAAAAEAAAAAAAQACAAAAAEAAAAAAAUAAQALAAEAAAAAAAYACAAAAAMAAQQJAAEAEAAMAAMAAQQJAAIABgAcAAMAAQQJAAMAEAAMAAMAAQQJAAQAEAAMAAMAAQQJAAUAAgAiAAMAAQQJAAYAEAAMYW5jaG9yanM0MDBAAGEAbgBjAGgAbwByAGoAcwA0ADAAMABAAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAAH//wAP) format("truetype")}',A.sheet.cssRules.length)),h=document.querySelectorAll("[id]"),t=[].map.call(h,function(A){return A.id}),i=0;i<e.length;i++)if(this.hasAnchorJSLink(e[i]))p.push(i);else{if(e[i].hasAttribute("id"))o=e[i].getAttribute("id");else if(e[i].hasAttribute("data-anchor-id"))o=e[i].getAttribute("data-anchor-id");else{for(r=a=this.urlify(e[i].textContent),s=0;n=t.indexOf(r=void 0!==n?a+"-"+s:r),s+=1,-1!==n;);n=void 0,t.push(r),e[i].setAttribute("id",r),o=r}(l=document.createElement("a")).className="anchorjs-link "+this.options.class,l.setAttribute("aria-label",this.options.ariaLabel),l.setAttribute("data-anchorjs-icon",this.options.icon),this.options.titleText&&(l.title=this.options.titleText),c=document.querySelector("base")?window.location.pathname+window.location.search:"",c=this.options.base||c,l.href=c+"#"+o,"always"===this.options.visible&&(l.style.opacity="1"),""===this.options.icon&&(l.style.font="1em/1 anchorjs-icons","left"===this.options.placement)&&(l.style.lineHeight="inherit"),"left"===this.options.placement?(l.style.position="absolute",l.style.marginLeft="-1.25em",l.style.paddingRight=".25em",l.style.paddingLeft=".25em",e[i].insertBefore(l,e[i].firstChild)):(l.style.marginLeft=".1875em",l.style.paddingRight=".1875em",l.style.paddingLeft=".1875em",e[i].appendChild(l))}for(i=0;i<p.length;i++)e.splice(p[i]-i,1);this.elements=this.elements.concat(e)}return this},this.remove=function(A){for(var e,t,o=d(A),i=0;i<o.length;i++)(t=o[i].querySelector(".anchorjs-link"))&&(-1!==(e=this.elements.indexOf(o[i]))&&this.elements.splice(e,1),o[i].removeChild(t));return this},this.removeAll=function(){this.remove(this.elements)},this.urlify=function(A){var e=document.createElement("textarea");return e.innerHTML=A,A=e.value,this.options.truncate||u(this.options),A.trim().replace(/'/gi,"").replace(/[& +$,:;=?@"#{}|^~[`%!'<>\]./()*\\\n\t\b\v\u00A0]/g,"-").replace(/-{2,}/g,"-").substring(0,this.options.truncate).replace(/^-+|-+$/gm,"").toLowerCase()},this.hasAnchorJSLink=function(A){var e=A.firstChild&&-1<(" "+A.firstChild.className+" ").indexOf(" anchorjs-link "),A=A.lastChild&&-1<(" "+A.lastChild.className+" ").indexOf(" anchorjs-link ");return e||A||!1}}}); +// @license-end + diff --git a/docs-preview-569/script/anchor-use.js b/docs-preview-569/script/anchor-use.js new file mode 100644 index 000000000..d2f2fe6c6 --- /dev/null +++ b/docs-preview-569/script/anchor-use.js @@ -0,0 +1,4 @@ +document.addEventListener('DOMContentLoaded', function(event) { + anchors.add('h1[id]:not(div.note h1, div.warning h1, div.tip h1, div.caution h1, div.important h1), h2[id]:not(div.note h2, div.warning h2, div.tip h2, div.caution h2, div.important h2), h3[id]:not(div.note h3, div.warning h3, div.tip h3, div.caution h3, div.important h3), h4[id]:not(div.note h4, div.warning h4, div.tip h4, div.caution h4, div.important h4), h5[id]:not(div.note h5, div.warning h5, div.tip h5, div.caution h5, div.important h5), h6[id]:not(div.note h6, div.warning h6, div.tip h6, div.caution h6, div.important h6)'); +}); + diff --git a/docs-preview-569/script/search.js b/docs-preview-569/script/search.js new file mode 100644 index 000000000..e20c2314f --- /dev/null +++ b/docs-preview-569/script/search.js @@ -0,0 +1,58 @@ +document.addEventListener("DOMContentLoaded", () => { + if (!window.location.pathname.endsWith("options.html")) return; + + const searchDiv = document.createElement("div"); + searchDiv.id = "search-bar"; + searchDiv.innerHTML = ` + <input type="text" id="search-input" placeholder="Search options by ID..." /> + <div id="search-results"></div> + `; + document.body.prepend(searchDiv); + + const dtElements = Array.from(document.querySelectorAll("dt")); + const ddElements = Array.from(document.querySelectorAll("dd")); + const dtOptionIds = dtElements.map( + (dt) => dt.querySelector("a")?.id.toLowerCase() || "", + ); + + if (dtElements.length === 0 || ddElements.length === 0) { + console.warn("Something went wrong, page may be loaded incorrectly."); + return; + } + + const dtElementsData = dtElements.map((dt, index) => ({ + element: dt, + id: dtOptionIds[index], + ddElement: ddElements[index], + })); + + const hiddenClass = "hidden"; + const hiddenStyle = document.createElement("style"); + hiddenStyle.innerHTML = `.${hiddenClass} { display: none; }`; + document.head.appendChild(hiddenStyle); + + let debounceTimeout; + document.getElementById("search-input").addEventListener("input", (event) => { + clearTimeout(debounceTimeout); + debounceTimeout = setTimeout(() => { + const query = event.target.value.toLowerCase(); + + const matches = []; + const nonMatches = []; + + dtElementsData.forEach(({ element, id, ddElement }) => { + const isMatch = id.includes(query); + if (isMatch) { + matches.push(element, ddElement); + } else { + nonMatches.push(element, ddElement); + } + }); + + requestAnimationFrame(() => { + matches.forEach((el) => el?.classList.remove(hiddenClass)); + nonMatches.forEach((el) => el?.classList.add(hiddenClass)); + }); + }, 200); + }); +}); diff --git a/docs-preview-569/style.css b/docs-preview-569/style.css new file mode 100644 index 000000000..2ec4c76b5 --- /dev/null +++ b/docs-preview-569/style.css @@ -0,0 +1,622 @@ +@import "tomorrow.min.css"; +html { + -webkit-text-size-adjust: 100%; +} + +html:focus-within { + scroll-behavior: smooth; +} + +body { + -webkit-text-size-adjust: 100%; + -moz-text-size-adjust: 100%; + text-size-adjust: 100%; + -moz-osx-font-smoothing: grayscale; + -webkit-font-smoothing: antialiased; + min-height: 100vh; + position: relative; + text-rendering: optimizeSpeed; + width: 100%; +} + +*, :after, :before { + box-sizing: border-box; +} + +a:not([class]) { + -webkit-text-decoration-skip: ink; + text-decoration-skip-ink: auto; +} + +a, abbr, acronym, address, applet, article, aside, audio, b, big, blockquote, body, canvas, caption, center, cite, code, dd, del, details, dfn, div, dl, dt, em, embed, fieldset, figcaption, figure, footer, form, h1, h2, h3, h4, h5, h6, header, hgroup, html, i, iframe, img, ins, kbd, label, legend, li, mark, menu, nav, object, ol, output, p, pre, q, ruby, s, samp, section, small, span, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, time, tr, tt, u, ul, var, video { + border: 0; + font-size: 100%; + font: inherit; + margin: 0; + padding: 0; + vertical-align: baseline; +} + +:focus { + outline: 0; +} + +article, aside, details, figcaption, figure, footer, header, hgroup, main, menu, nav, section { + display: block; +} + +ol, ul { + list-style: none; +} + +blockquote, q { + quotes: none; +} + +blockquote:after, blockquote:before, q:after, q:before { + content: ""; + content: none; +} + +input, input:required { + box-shadow: none; +} + +input:-webkit-autofill, input:-webkit-autofill:active, input:-webkit-autofill:focus, input:-webkit-autofill:hover { + -webkit-box-shadow: inset 0 0 0 30px #fff; +} + +input[type=search]::-webkit-search-cancel-button, input[type=search]::-webkit-search-decoration, input[type=search]::-webkit-search-results-button, input[type=search]::-webkit-search-results-decoration { + -webkit-appearance: none; + -moz-appearance: none; +} + +input[type=search] { + -webkit-appearance: none; + -moz-appearance: none; +} + +input:focus { + outline: 0; +} + +audio, canvas, video { + display: inline-block; + max-width: 100%; +} + +audio:not([controls]) { + display: none; + height: 0; +} + +[hidden] { + display: none; +} + +a:active, a:hover { + outline: 0; +} + +img { + height: auto; + max-width: 100%; + vertical-align: middle; +} + +img, picture { + display: inline-block; +} + +button, input { + line-height: normal; +} + +button, html input[type=button], input[type=reset], input[type=submit] { + -webkit-appearance: button; + background: 0 0; + border: 0; + cursor: pointer; +} + +button[disabled], html input[disabled] { + cursor: default; +} + +[disabled] { + pointer-events: none; +} + +input[type=checkbox], input[type=radio] { + padding: 0; +} + +input[type=search] { + -webkit-appearance: textfield; + box-sizing: content-box; +} + +input[type=search]::-webkit-search-cancel-button, input[type=search]::-webkit-search-decoration { + -webkit-appearance: none; +} + +button::-moz-focus-inner, input::-moz-focus-inner { + border: 0; + padding: 0; +} + +button { + background: 0 0; + border: 0; +} + +textarea { + overflow: auto; + resize: vertical; + vertical-align: top; +} + +table { + border-collapse: collapse; + border-spacing: 0; + text-indent: 0; +} + +hr { + background: #000; + border: 0; + box-sizing: content-box; + height: 1px; + line-height: 0; + margin: 0; + overflow: visible; + padding: 0; + page-break-after: always; + width: 100%; +} + +pre { + font-family: monospace, monospace; + font-size: 100%; +} + +a { + background-color: transparent; +} + +abbr[title] { + border-bottom: none; + text-decoration: none; +} + +code, kbd, pre, samp { + font-family: monospace, monospace; +} + +small, sub, sup { + font-size: 75%; +} + +sub, sup { + line-height: 0; + position: relative; + vertical-align: baseline; +} + +sub { + bottom: -5px; +} + +sup { + top: -5px; +} + +button, input, optgroup, select, textarea { + font-family: inherit; + font-size: 100%; + line-height: 1; + margin: 0; + padding: 0; +} + +button, input { + overflow: visible; +} + +button, select { + text-transform: none; +} + +[type=button], [type=reset], [type=submit], button { + -webkit-appearance: button; +} + +[type=button]::-moz-focus-inner, [type=reset]::-moz-focus-inner, [type=submit]::-moz-focus-inner, button::-moz-focus-inner { + border-style: none; + outline: 0; + padding: 0; +} + +legend { + border: 0; + color: inherit; + display: block; + max-width: 100%; + white-space: normal; + width: 100%; +} + +fieldset { + min-width: 0; +} + +body:not(:-moz-handler-blocked) fieldset { + display: block; +} + +progress { + vertical-align: baseline; +} + +[type=number]::-webkit-inner-spin-button, [type=number]::-webkit-outer-spin-button { + height: auto; +} + +[type=search] { + -webkit-appearance: textfield; + outline-offset: -2px; +} + +[type=search]::-webkit-search-decoration { + -webkit-appearance: none; +} + +::-webkit-file-upload-button { + -webkit-appearance: button; + font: inherit; +} + +summary { + display: list-item; +} + +template { + display: none; +} + +:root { + --nmd-color0: #0a3e68; + --nmd-color1: #268598; + --nmd-color2: #b8d09e; + --nmd-color3: #f6cf5e; + --nmd-color4: #ec733b; + --nmd-color-info: #167cb9; + --nmd-color-warn: #ff6700; +} + +body { + background: white; + color: #111827; + max-width: min(100ch, 1024px); + margin: 0 auto; + padding: 10px; + font-family: "Lucida Sans", Arial, sans-serif; + font-size: 16px; + line-height: 1.4em; +} +@media (prefers-color-scheme: dark) { + body { + background: #111827; + color: #f9fafb; + } +} + +h1, +h2, +h3 { + color: var(--nmd-color0); + font-family: "Lato", sans-serif; + font-weight: 300; + line-height: 1.125; +} +@media (prefers-color-scheme: dark) { + h1, + h2, + h3 { + color: var(--nmd-color4); + } +} + +h1 { + font-size: 48px; + font-weight: 300; + margin: 4rem 0 1.5rem; +} + +h2 { + font-size: 32px; + font-weight: 300; + margin: 2rem 0 1rem; +} + +h3 { + font-size: 20px; + font-weight: 400; + margin: 0.5rem 0.25rem; +} + +p { + margin: 0.9rem 0; +} +p:first-child { + margin-top: 0; +} +p:last-child { + margin-bottom: 0; +} + +a { + color: var(--nmd-color0); + text-decoration: underline; + text-underline-offset: 3px; +} +a:visited { + color: var(--nmd-color1); +} +a:hover { + color: var(--nmd-color1); +} +@media (prefers-color-scheme: dark) { + a { + color: var(--nmd-color3); + } + a:visited { + color: var(--nmd-color2); + } + a:hover { + color: var(--nmd-color4); + } +} + +code { + font-size: 90%; +} + +span.command { + font-size: 90%; + font-family: monospace; +} + +em { + font-style: italic; +} + +strong { + font-weight: bold; +} + +pre { + background: #f9fafb; + margin: 2rem 16px; + padding: 10px; + border: 1px solid #e5e7eb; + border-radius: 4px; + box-shadow: 4px 4px 8px #e5e7eb; + font-size: 90%; + margin-bottom: 1.5rem; + padding: 6px; + overflow: auto; +} +@media (prefers-color-scheme: dark) { + pre { + background: #1f2937; + border-color: black; + box-shadow: 4px 4px 8px black; + } +} +pre span img { + user-select: none; +} + +pre:has(code) { + padding: 0; +} + +td, +th { + padding: 2px 5px; +} +td:first-child, +th:first-child { + padding-left: 0; +} +td:last-child, +th:last-child { + padding-right: 0; +} + +dt { + margin: 1.2rem 0 0.8rem; + content-visibility: auto; + contain-intrinsic-size: auto 42px; +} + +dd { + margin-left: 2rem; + content-visibility: auto; + contain-intrinsic-size: auto 500px; +} + +ul { + margin: 0.9rem 0; + padding-left: 30px; + list-style: disc; +} +ul:first-child { + margin-top: 0; +} +ul:last-child { + margin-bottom: 0; +} + +ol { + margin: 0.9rem 0; + padding-left: 30px; + list-style: decimal; +} +ol:first-child { + margin-top: 0; +} +ol:last-child { + margin-bottom: 0; +} + +li { + margin: 0.9rem 0; + padding-left: 5px; +} +li:first-child { + margin-top: 0; +} +li:last-child { + margin-bottom: 0; +} + +.navheader hr, +.navfooter hr { + margin: 1rem 0; + background: #e5e7eb; +} +@media (prefers-color-scheme: dark) { + .navheader hr, + .navfooter hr { + background: #4b5563; + } +} +.navheader a, +.navfooter a { + text-decoration: none; +} + +#search-bar { + position: sticky; + top: 0; + background: white; + padding: 10px; + border-bottom: 1px solid #e5e7eb; + z-index: 1000; +} +@media (prefers-color-scheme: dark) { + #search-bar { + background: #111827; + color: #f9fafb; + border-bottom: 1px solid black; + } +} + +#search-input { + width: 100%; + padding: 8px; + border: 1px solid #ccc; + border-radius: 4px; + background: inherit; + color: inherit; +} + +.hidden { + display: none; +} + +div.titlepage { + margin: 40px 0; +} +div.titlepage hr { + display: none; +} + +div.toc { + background: #f9fafb; + margin: 2rem 16px; + padding: 10px; + border: 1px solid #e5e7eb; + border-radius: 4px; + box-shadow: 4px 4px 8px #e5e7eb; +} +@media (prefers-color-scheme: dark) { + div.toc { + background: #1f2937; + border-color: black; + box-shadow: 4px 4px 8px black; + } +} +div.toc a { + text-decoration: none; +} + +div.note, +div.warning { + background: #f9fafb; + margin: 2rem 16px; + padding: 10px; + border: 1px solid #e5e7eb; + border-radius: 4px; + box-shadow: 4px 4px 8px #e5e7eb; + font-style: italic; +} +@media (prefers-color-scheme: dark) { + div.note, + div.warning { + background: #1f2937; + border-color: black; + box-shadow: 4px 4px 8px black; + } +} +div.note h3, +div.warning h3 { + float: right; + margin: 0 0 1rem 1rem; + width: 42px; + height: 42px; + content: url(); +} +div.note h3 + p, +div.warning h3 + p { + margin-top: 0; +} + +div.note h3 { + background-color: var(--nmd-color-info); + mask-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='42' height='42' viewBox='0 0 24 24' stroke-width='2' stroke='black' fill='none' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath stroke='none' d='M0 0h24v24H0z' fill='none'%3E%3C/path%3E%3Cpath d='M12 8h.01'%3E%3C/path%3E%3Cpath d='M11 12h1v4h1'%3E%3C/path%3E%3Cpath d='M12 3c7.2 0 9 1.8 9 9s-1.8 9 -9 9s-9 -1.8 -9 -9s1.8 -9 9 -9z'%3E%3C/path%3E%3C/svg%3E"); + -webkit-mask-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='42' height='42' viewBox='0 0 24 24' stroke-width='2' stroke='black' fill='none' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath stroke='none' d='M0 0h24v24H0z' fill='none'%3E%3C/path%3E%3Cpath d='M12 8h.01'%3E%3C/path%3E%3Cpath d='M11 12h1v4h1'%3E%3C/path%3E%3Cpath d='M12 3c7.2 0 9 1.8 9 9s-1.8 9 -9 9s-9 -1.8 -9 -9s1.8 -9 9 -9z'%3E%3C/path%3E%3C/svg%3E"); +} + +div.warning h3 { + background-color: var(--nmd-color-warn); + mask-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='42' height='42' viewBox='0 0 24 24' stroke-width='2' stroke='black' fill='none' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath stroke='none' d='M0 0h24v24H0z' fill='none'%3E%3C/path%3E%3Cpath d='M12 9v2m0 4v.01'%3E%3C/path%3E%3Cpath d='M5 19h14a2 2 0 0 0 1.84 -2.75l-7.1 -12.25a2 2 0 0 0 -3.5 0l-7.1 12.25a2 2 0 0 0 1.75 2.75'%3E%3C/path%3E%3C/svg%3E"); + -webkit-mask-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='42' height='42' viewBox='0 0 24 24' stroke-width='2' stroke='black' fill='none' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath stroke='none' d='M0 0h24v24H0z' fill='none'%3E%3C/path%3E%3Cpath d='M12 9v2m0 4v.01'%3E%3C/path%3E%3Cpath d='M5 19h14a2 2 0 0 0 1.84 -2.75l-7.1 -12.25a2 2 0 0 0 -3.5 0l-7.1 12.25a2 2 0 0 0 1.75 2.75'%3E%3C/path%3E%3C/svg%3E"); +} + +.term { + font-weight: 300; +} + +.docbook .xref img[src^="images/callouts/"], +.screen img, +.programlisting img { + width: 1em; +} + +.calloutlist img { + width: 1.3em; +} + +/** The console prompt, e.g., `$` and `#` should not be selectable. */ +.programlisting.language-shell .hljs-meta.prompt_ { + user-select: none; +} + +@media (prefers-color-scheme: dark) { + @import "tomorrow-night.min.css"; +} + +/*# sourceMappingURL=style.css.map */