diff --git a/highlight.load.js b/highlight.load.js deleted file mode 100644 index d83e168..0000000 --- a/highlight.load.js +++ /dev/null @@ -1,35 +0,0 @@ -/* This file is NOT part of highlight.js */ - -class PreserveCallouts { - - constructor(options) { - self.callouts = []; - /* Using OBJECT REPLACEMENT CHARACTER as a marker of where the callout - should be inserted. We hope that this won't cause conflicts. */ - self.marker = '\u{FFFC}'; - } - - 'before:highlightElement'({el, language}) { - const re = /<\/a>\d+<\/span>/g; - const array = [...el.innerHTML.matchAll(re)]; - if (array.length > 0) { - self.callouts = array; - el.innerHTML = el.innerHTML.replaceAll(re, self.marker); - } - } - - 'after:highlightElement'({ el, result, text }) { - if (self.callouts.length > 0) { - el.innerHTML = el.innerHTML.replaceAll( - self.marker, (str) => self.callouts.shift()); - } - } -} - -document.addEventListener('DOMContentLoaded', (event) => { - hljs.addPlugin(new PreserveCallouts()); - - document.querySelectorAll('pre.programlisting, pre.screen').forEach((el) => { - hljs.highlightElement(el); - }); -}); diff --git a/highlight.min.js b/highlight.min.js deleted file mode 100644 index bcd6556..0000000 --- a/highlight.min.js +++ /dev/null @@ -1,340 +0,0 @@ -/*! - Highlight.js v11.7.0 (git: 82688fad18) - (c) 2006-2022 undefined and other contributors - License: BSD-3-Clause - */ -var hljs=function(){"use strict";var e={exports:{}};function t(e){ -return e instanceof Map?e.clear=e.delete=e.set=()=>{ -throw Error("map is read-only")}:e instanceof Set&&(e.add=e.clear=e.delete=()=>{ -throw Error("set is read-only") -}),Object.freeze(e),Object.getOwnPropertyNames(e).forEach((n=>{var i=e[n] -;"object"!=typeof i||Object.isFrozen(i)||t(i)})),e} -e.exports=t,e.exports.default=t;class n{constructor(e){ -void 0===e.data&&(e.data={}),this.data=e.data,this.isMatchIgnored=!1} -ignoreMatch(){this.isMatchIgnored=!0}}function i(e){ -return e.replace(/&/g,"&").replace(//g,">").replace(/"/g,""").replace(/'/g,"'") -}function r(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||e.sublanguage&&e.language;class o{constructor(e,t){ -this.buffer="",this.classPrefix=t.classPrefix,e.walk(this)}addText(e){ -this.buffer+=i(e)}openNode(e){if(!s(e))return;let t="" -;t=e.sublanguage?"language-"+e.language:((e,{prefix:t})=>{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+="")}value(){return this.buffer}span(e){ -this.buffer+=``}}const a=(e={})=>{const t={children:[]} -;return Object.assign(t,e),t};class c{constructor(){ -this.rootNode=a(),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=a({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=>{ -c._collapse(e)})))}}class l extends c{constructor(e){super(),this.options=e} -addKeyword(e,t){""!==e&&(this.openNode(t),this.addText(e),this.closeNode())} -addText(e){""!==e&&this.add(e)}addSublanguage(e,t){const n=e.root -;n.sublanguage=!0,n.language=t,this.add(n)}toHTML(){ -return new o(this,this.options).value()}finalize(){return!0}}function g(e){ -return e?"string"==typeof e?e:e.source:null}function d(e){return p("(?=",e,")")} -function u(e){return p("(?:",e,")*")}function h(e){return p("(?:",e,")?")} -function p(...e){return e.map((e=>g(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=>g(e))).join("|")+")"} -function b(e){return RegExp(e.toString()+"|").exec("").length-1} -const m=/\[(?:[^\\\]]|\\.)*\]|\(\??|\\([1-9][0-9]*)|\\./ -;function E(e,{joinWith:t}){let n=0;return e.map((e=>{n+=1;const t=n -;let i=g(e),r="";for(;i.length>0;){const e=m.exec(i);if(!e){r+=i;break} -r+=i.substring(0,e.index), -i=i.substring(e.index+e[0].length),"\\"===e[0][0]&&e[1]?r+="\\"+(Number(e[1])+t):(r+=e[0], -"("===e[0]&&n++)}return r})).map((e=>`(${e})`)).join(t)} -const x="[a-zA-Z]\\w*",w="[a-zA-Z_]\\w*",y="\\b\\d+(\\.\\d+)?",_="(-?)(\\b0[xX][a-fA-F0-9]+|(\\b\\d+(\\.\\d*)?|\\.\\d+)([eE][-+]?\\d+)?)",O="\\b(0b[01]+)",v={ -begin:"\\\\[\\s\\S]",relevance:0},N={scope:"string",begin:"'",end:"'", -illegal:"\\n",contains:[v]},k={scope:"string",begin:'"',end:'"',illegal:"\\n", -contains:[v]},M=(e,t,n={})=>{const i=r({scope:"comment",begin:e,end:t, -contains:[]},n);i.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 s=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 i.contains.push({begin:p(/[ ]+/,"(",s,/[.]?[:]?([.][ ]|[ ])/,"){3}")}),i -},S=M("//","$"),R=M("/\\*","\\*/"),j=M("#","$");var A=Object.freeze({ -__proto__:null,MATCH_NOTHING_RE:/\b\B/,IDENT_RE:x,UNDERSCORE_IDENT_RE:w, -NUMBER_RE:y,C_NUMBER_RE:_,BINARY_NUMBER_RE:O, -RE_STARTERS_RE:"!|!=|!==|%|%=|&|&&|&=|\\*|\\*=|\\+|\\+=|,|-|-=|/=|/|:|;|<<|<<=|<=|<|===|==|=|>>>=|>>=|>=|>>>|>>|>|\\?|\\[|\\{|\\(|\\^|\\^=|\\||\\|=|\\|\\||~", -SHEBANG:(e={})=>{const t=/^#![ ]*\// -;return e.binary&&(e.begin=p(t,/.*\b/,e.binary,/\b.*/)),r({scope:"meta",begin:t, -end:/$/,relevance:0,"on:begin":(e,t)=>{0!==e.index&&t.ignoreMatch()}},e)}, -BACKSLASH_ESCAPE:v,APOS_STRING_MODE:N,QUOTE_STRING_MODE:k,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/ -},COMMENT:M,C_LINE_COMMENT_MODE:S,C_BLOCK_COMMENT_MODE:R,HASH_COMMENT_MODE:j, -NUMBER_MODE:{scope:"number",begin:y,relevance:0},C_NUMBER_MODE:{scope:"number", -begin:_,relevance:0},BINARY_NUMBER_MODE:{scope:"number",begin:O,relevance:0}, -REGEXP_MODE:{begin:/(?=\/[^/\n]*\/)/,contains:[{scope:"regexp",begin:/\//, -end:/\/[gimuy]*/,illegal:/\n/,contains:[v,{begin:/\[/,end:/\]/,relevance:0, -contains:[v]}]}]},TITLE_MODE:{scope:"title",begin:x,relevance:0}, -UNDERSCORE_TITLE_MODE:{scope:"title",begin:w,relevance:0},METHOD_GUARD:{ -begin:"\\.\\s*[a-zA-Z_]\\w*",relevance:0},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()}})});function I(e,t){ -"."===e.input[e.index-1]&&t.ignoreMatch()}function T(e,t){ -void 0!==e.className&&(e.scope=e.className,delete e.className)}function L(e,t){ -t&&e.beginKeywords&&(e.begin="\\b("+e.beginKeywords.split(" ").join("|")+")(?!\\.)(?=\\b|\\s)", -e.__beforeBegin=I,e.keywords=e.keywords||e.beginKeywords,delete e.beginKeywords, -void 0===e.relevance&&(e.relevance=0))}function B(e,t){ -Array.isArray(e.illegal)&&(e.illegal=f(...e.illegal))}function D(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 H(e,t){ -void 0===e.relevance&&(e.relevance=1)}const P=(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=p(n.beforeMatch,d(n.begin)),e.starts={ -relevance:0,contains:[Object.assign(n,{endsParent:!0})] -},e.relevance=0,delete n.beforeMatch -},C=["of","and","for","in","not","or","if","then","parent","list","value"] -;function $(e,t,n="keyword"){const i=Object.create(null) -;return"string"==typeof e?r(n,e.split(" ")):Array.isArray(e)?r(n,e):Object.keys(e).forEach((n=>{ -Object.assign(i,$(e[n],t,n))})),i;function r(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=>C.includes(e.toLowerCase()))(e)?0:1}const z={},K=e=>{ -console.error(e)},W=(e,...t)=>{console.log("WARN: "+e,...t)},X=(e,t)=>{ -z[`${e}/${t}`]||(console.log(`Deprecated as of ${e}. ${t}`),z[`${e}/${t}`]=!0) -},G=Error();function Z(e,t,{key:n}){let i=0;const r=e[n],s={},o={} -;for(let e=1;e<=t.length;e++)o[e+i]=r[e],s[e+i]=!0,i+=b(t[e-1]) -;e[n]=o,e[n]._emit=s,e[n]._multi=!0}function F(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 K("skip, excludeBegin, returnBegin not compatible with beginScope: {}"), -G -;if("object"!=typeof e.beginScope||null===e.beginScope)throw K("beginScope must be object"), -G;Z(e,e.begin,{key:"beginScope"}),e.begin=E(e.begin,{joinWith:""})}})(e),(e=>{ -if(Array.isArray(e.end)){ -if(e.skip||e.excludeEnd||e.returnEnd)throw K("skip, excludeEnd, returnEnd not compatible with endScope: {}"), -G -;if("object"!=typeof e.endScope||null===e.endScope)throw K("endScope must be object"), -G;Z(e,e.end,{key:"endScope"}),e.end=E(e.end,{joinWith:""})}})(e)}function V(e){ -function t(t,n){ -return RegExp(g(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+=b(e)+1}compile(){0===this.regexes.length&&(this.exec=()=>null) -;const e=this.regexes.map((e=>e[1]));this.matcherRe=t(E(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 i{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=r(e.classNameAliases||{}),function n(s,o){const a=s -;if(s.isCompiled)return a -;[T,D,F,P].forEach((e=>e(s,o))),e.compilerExtensions.forEach((e=>e(s,o))), -s.__beforeBegin=null,[L,B,H].forEach((e=>e(s,o))),s.isCompiled=!0;let c=null -;return"object"==typeof s.keywords&&s.keywords.$pattern&&(s.keywords=Object.assign({},s.keywords), -c=s.keywords.$pattern, -delete s.keywords.$pattern),c=c||/\w+/,s.keywords&&(s.keywords=$(s.keywords,e.case_insensitive)), -a.keywordPatternRe=t(c,!0), -o&&(s.begin||(s.begin=/\B|\b/),a.beginRe=t(a.begin),s.end||s.endsWithParent||(s.end=/\B|\b/), -s.end&&(a.endRe=t(a.end)), -a.terminatorEnd=g(a.end)||"",s.endsWithParent&&o.terminatorEnd&&(a.terminatorEnd+=(s.end?"|":"")+o.terminatorEnd)), -s.illegal&&(a.illegalRe=t(s.illegal)), -s.contains||(s.contains=[]),s.contains=[].concat(...s.contains.map((e=>(e=>(e.variants&&!e.cachedVariants&&(e.cachedVariants=e.variants.map((t=>r(e,{ -variants:null},t)))),e.cachedVariants?e.cachedVariants:q(e)?r(e,{ -starts:e.starts?r(e.starts):null -}):Object.isFrozen(e)?r(e):e))("self"===e?s:e)))),s.contains.forEach((e=>{n(e,a) -})),s.starts&&n(s.starts,o),a.matcher=(e=>{const t=new i -;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=i,Q=r,ee=Symbol("nomatch");var te=(t=>{ -const i=Object.create(null),r=Object.create(null),s=[];let o=!0 -;const a="Could not find the language '{}', did you forget to load/include a language module?",c={ -disableAutodetect:!0,name:"Plain text",contains:[]};let g={ -ignoreUnescapedHTML:!1,throwUnescapedHTML:!1,noHighlightRe:/^(no-?highlight)$/i, -languageDetectRe:/\blang(?:uage)?-([\w-]+)\b/i,classPrefix:"hljs-", -cssSelector:"pre code",languages:null,__emitter:l};function b(e){ -return g.noHighlightRe.test(e)}function m(e,t,n){let i="",r="" -;"object"==typeof t?(i=e, -n=t.ignoreIllegals,r=t.language):(X("10.7.0","highlight(lang, code, ...args) has been deprecated."), -X("10.7.0","Please use highlight(code, options) instead.\nhttps://github.com/highlightjs/highlight.js/issues/2277"), -r=e,i=t),void 0===n&&(n=!0);const s={code:i,language:r};k("before:highlight",s) -;const o=s.result?s.result:E(s.language,s.code,n) -;return o.code=s.code,k("after:highlight",o),o}function E(e,t,r,s){ -const c=Object.create(null);function l(){if(!N.keywords)return void M.addText(S) -;let e=0;N.keywordPatternRe.lastIndex=0;let t=N.keywordPatternRe.exec(S),n="" -;for(;t;){n+=S.substring(e,t.index) -;const r=y.case_insensitive?t[0].toLowerCase():t[0],s=(i=r,N.keywords[i]);if(s){ -const[e,i]=s -;if(M.addText(n),n="",c[r]=(c[r]||0)+1,c[r]<=7&&(R+=i),e.startsWith("_"))n+=t[0];else{ -const n=y.classNameAliases[e]||e;M.addKeyword(t[0],n)}}else n+=t[0] -;e=N.keywordPatternRe.lastIndex,t=N.keywordPatternRe.exec(S)}var i -;n+=S.substring(e),M.addText(n)}function d(){null!=N.subLanguage?(()=>{ -if(""===S)return;let e=null;if("string"==typeof N.subLanguage){ -if(!i[N.subLanguage])return void M.addText(S) -;e=E(N.subLanguage,S,!0,k[N.subLanguage]),k[N.subLanguage]=e._top -}else e=x(S,N.subLanguage.length?N.subLanguage:null) -;N.relevance>0&&(R+=e.relevance),M.addSublanguage(e._emitter,e.language) -})():l(),S=""}function u(e,t){let n=1;const i=t.length-1;for(;n<=i;){ -if(!e._emit[n]){n++;continue}const i=y.classNameAliases[e[n]]||e[n],r=t[n] -;i?M.addKeyword(r,i):(S=r,l(),S=""),n++}}function h(e,t){ -return e.scope&&"string"==typeof e.scope&&M.openNode(y.classNameAliases[e.scope]||e.scope), -e.beginScope&&(e.beginScope._wrap?(M.addKeyword(S,y.classNameAliases[e.beginScope._wrap]||e.beginScope._wrap), -S=""):e.beginScope._multi&&(u(e.beginScope,t),S="")),N=Object.create(e,{parent:{ -value:N}}),N}function p(e,t,i){let r=((e,t)=>{const n=e&&e.exec(t) -;return n&&0===n.index})(e.endRe,i);if(r){if(e["on:end"]){const i=new n(e) -;e["on:end"](t,i),i.isMatchIgnored&&(r=!1)}if(r){ -for(;e.endsParent&&e.parent;)e=e.parent;return e}} -if(e.endsWithParent)return p(e.parent,t,i)}function f(e){ -return 0===N.matcher.regexIndex?(S+=e[0],1):(I=!0,0)}function b(e){ -const n=e[0],i=t.substring(e.index),r=p(N,e,i);if(!r)return ee;const s=N -;N.endScope&&N.endScope._wrap?(d(), -M.addKeyword(n,N.endScope._wrap)):N.endScope&&N.endScope._multi?(d(), -u(N.endScope,e)):s.skip?S+=n:(s.returnEnd||s.excludeEnd||(S+=n), -d(),s.excludeEnd&&(S=n));do{ -N.scope&&M.closeNode(),N.skip||N.subLanguage||(R+=N.relevance),N=N.parent -}while(N!==r.parent);return r.starts&&h(r.starts,e),s.returnEnd?0:n.length} -let m={};function w(i,s){const a=s&&s[0];if(S+=i,null==a)return d(),0 -;if("begin"===m.type&&"end"===s.type&&m.index===s.index&&""===a){ -if(S+=t.slice(s.index,s.index+1),!o){const t=Error(`0 width match regex (${e})`) -;throw t.languageName=e,t.badRule=m.rule,t}return 1} -if(m=s,"begin"===s.type)return(e=>{ -const t=e[0],i=e.rule,r=new n(i),s=[i.__beforeBegin,i["on:begin"]] -;for(const n of s)if(n&&(n(e,r),r.isMatchIgnored))return f(t) -;return i.skip?S+=t:(i.excludeBegin&&(S+=t), -d(),i.returnBegin||i.excludeBegin||(S=t)),h(i,e),i.returnBegin?0:t.length})(s) -;if("illegal"===s.type&&!r){ -const e=Error('Illegal lexeme "'+a+'" for mode "'+(N.scope||"")+'"') -;throw e.mode=N,e}if("end"===s.type){const e=b(s);if(e!==ee)return e} -if("illegal"===s.type&&""===a)return 1 -;if(A>1e5&&A>3*s.index)throw Error("potential infinite loop, way more iterations than matches") -;return S+=a,a.length}const y=O(e) -;if(!y)throw K(a.replace("{}",e)),Error('Unknown language: "'+e+'"') -;const _=V(y);let v="",N=s||_;const k={},M=new g.__emitter(g);(()=>{const e=[] -;for(let t=N;t!==y;t=t.parent)t.scope&&e.unshift(t.scope) -;e.forEach((e=>M.openNode(e)))})();let S="",R=0,j=0,A=0,I=!1;try{ -for(N.matcher.considerAll();;){ -A++,I?I=!1:N.matcher.considerAll(),N.matcher.lastIndex=j -;const e=N.matcher.exec(t);if(!e)break;const n=w(t.substring(j,e.index),e) -;j=e.index+n} -return w(t.substring(j)),M.closeAllNodes(),M.finalize(),v=M.toHTML(),{ -language:e,value:v,relevance:R,illegal:!1,_emitter:M,_top:N}}catch(n){ -if(n.message&&n.message.includes("Illegal"))return{language:e,value:Y(t), -illegal:!0,relevance:0,_illegalBy:{message:n.message,index:j, -context:t.slice(j-100,j+100),mode:n.mode,resultSoFar:v},_emitter:M};if(o)return{ -language:e,value:Y(t),illegal:!1,relevance:0,errorRaised:n,_emitter:M,_top:N} -;throw n}}function x(e,t){t=t||g.languages||Object.keys(i);const n=(e=>{ -const t={value:Y(e),illegal:!1,relevance:0,_top:c,_emitter:new g.__emitter(g)} -;return t._emitter.addText(e),t})(e),r=t.filter(O).filter(N).map((t=>E(t,e,!1))) -;r.unshift(n);const s=r.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})),[o,a]=s,l=o -;return l.secondBest=a,l}function w(e){let t=null;const n=(e=>{ -let t=e.className+" ";t+=e.parentNode?e.parentNode.className:"" -;const n=g.languageDetectRe.exec(t);if(n){const t=O(n[1]) -;return t||(W(a.replace("{}",n[1])), -W("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(k("before:highlightElement",{el:e,language:n -}),e.children.length>0&&(g.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)),g.throwUnescapedHTML))throw new J("One of your code blocks includes unescaped HTML.",e.innerHTML) -;t=e;const i=t.textContent,s=n?m(i,{language:n,ignoreIllegals:!0}):x(i) -;e.innerHTML=s.value,((e,t,n)=>{const i=t&&r[t]||n -;e.classList.add("hljs"),e.classList.add("language-"+i) -})(e,n,s.language),e.result={language:s.language,re:s.relevance, -relevance:s.relevance},s.secondBest&&(e.secondBest={ -language:s.secondBest.language,relevance:s.secondBest.relevance -}),k("after:highlightElement",{el:e,result:s,text:i})}let y=!1;function _(){ -"loading"!==document.readyState?document.querySelectorAll(g.cssSelector).forEach(w):y=!0 -}function O(e){return e=(e||"").toLowerCase(),i[e]||i[r[e]]} -function v(e,{languageName:t}){"string"==typeof e&&(e=[e]),e.forEach((e=>{ -r[e.toLowerCase()]=t}))}function N(e){const t=O(e) -;return t&&!t.disableAutodetect}function k(e,t){const n=e;s.forEach((e=>{ -e[n]&&e[n](t)}))} -"undefined"!=typeof window&&window.addEventListener&&window.addEventListener("DOMContentLoaded",(()=>{ -y&&_()}),!1),Object.assign(t,{highlight:m,highlightAuto:x,highlightAll:_, -highlightElement:w, -highlightBlock:e=>(X("10.7.0","highlightBlock will be removed entirely in v12.0"), -X("10.7.0","Please use highlightElement now."),w(e)),configure:e=>{g=Q(g,e)}, -initHighlighting:()=>{ -_(),X("10.6.0","initHighlighting() deprecated. Use highlightAll() now.")}, -initHighlightingOnLoad:()=>{ -_(),X("10.6.0","initHighlightingOnLoad() deprecated. Use highlightAll() now.") -},registerLanguage:(e,n)=>{let r=null;try{r=n(t)}catch(t){ -if(K("Language definition for '{}' could not be registered.".replace("{}",e)), -!o)throw t;K(t),r=c} -r.name||(r.name=e),i[e]=r,r.rawDefinition=n.bind(null,t),r.aliases&&v(r.aliases,{ -languageName:e})},unregisterLanguage:e=>{delete i[e] -;for(const t of Object.keys(r))r[t]===e&&delete r[t]}, -listLanguages:()=>Object.keys(i),getLanguage:O,registerAliases:v, -autoDetection:N,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),s.push(e)} -}),t.debugMode=()=>{o=!1},t.safeMode=()=>{o=!0 -},t.versionString="11.7.0",t.regex={concat:p,lookahead:d,either:f,optional:h, -anyNumberOfTimes:u};for(const t in A)"object"==typeof A[t]&&e.exports(A[t]) -;return Object.assign(t,A),t})({});return te}() -;"object"==typeof exports&&"undefined"!=typeof module&&(module.exports=hljs);/*! `bash` grammar compiled for Highlight.js 11.7.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={ -begin:/<<-?\s*(?=\w+)/,starts:{contains:[e.END_SAME_AS_BEGIN({begin:/(\w+)/, -end:/(\w+)/,className:"string"})]}},c={className:"string",begin:/"/,end:/"/, -contains:[e.BACKSLASH_ESCAPE,t,a]};a.contains.push(c);const o={begin:/\$?\(\(/, -end:/\)\)/,contains:[{begin:/\d+#[0-9a-f]+/,className:"number"},e.NUMBER_MODE,t] -},r=e.SHEBANG({binary:"(fish|bash|zsh|sh|csh|ksh|tcsh|dash|scsh)",relevance:10 -}),l={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","in","do","done","case","esac","function"], -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:[r,e.SHEBANG(),l,o,e.HASH_COMMENT_MODE,i,{match:/(\/[a-z._-]+)+/},c,{ -className:"",begin:/\\"/},{className:"string",begin:/'/,end:/'/},t]}}})() -;hljs.registerLanguage("bash",e)})();/*! `shell` grammar compiled for Highlight.js 11.7.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)})();/*! `nix` grammar compiled for Highlight.js 11.7.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) -})(); \ No newline at end of file diff --git a/highlightjs/LICENSE b/highlightjs/LICENSE new file mode 100644 index 0000000..2250cc7 --- /dev/null +++ b/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/highlightjs/highlight-style.css b/highlightjs/highlight-style.css new file mode 100644 index 0000000..d5fbcef --- /dev/null +++ b/highlightjs/highlight-style.css @@ -0,0 +1,8 @@ +pre { + padding: 0; +} + +pre code.hljs { + border: none; + margin: 0; +} diff --git a/highlightjs/highlight.pack.js b/highlightjs/highlight.pack.js new file mode 100644 index 0000000..b8008d3 --- /dev/null +++ b/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,"'") +}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+="")}value(){return this.buffer}span(e){ +this.buffer+=``}}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||"")+'"') +;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/highlightjs/loader.js b/highlightjs/loader.js new file mode 100644 index 0000000..cf0fdac --- /dev/null +++ b/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/highlightjs/mono-blue.css b/highlightjs/mono-blue.css new file mode 100644 index 0000000..bc9bcea --- /dev/null +++ b/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/tomorrow-night.min.css b/highlightjs/tomorrow-night.min.css similarity index 100% rename from tomorrow-night.min.css rename to highlightjs/tomorrow-night.min.css diff --git a/images/callouts/1.svg b/images/callouts/1.svg deleted file mode 100644 index e2e87dc..0000000 --- a/images/callouts/1.svg +++ /dev/null @@ -1,15 +0,0 @@ - - - - -]> - - - - - - - - diff --git a/images/callouts/10.svg b/images/callouts/10.svg deleted file mode 100644 index 4740f58..0000000 --- a/images/callouts/10.svg +++ /dev/null @@ -1,18 +0,0 @@ - - - - -]> - - - - - - - - - diff --git a/images/callouts/11.svg b/images/callouts/11.svg deleted file mode 100644 index 09a0b2c..0000000 --- a/images/callouts/11.svg +++ /dev/null @@ -1,16 +0,0 @@ - - - - -]> - - - - - - - - - diff --git a/images/callouts/12.svg b/images/callouts/12.svg deleted file mode 100644 index 9794044..0000000 --- a/images/callouts/12.svg +++ /dev/null @@ -1,18 +0,0 @@ - - - - -]> - - - - - - - - - diff --git a/images/callouts/13.svg b/images/callouts/13.svg deleted file mode 100644 index 64268bb..0000000 --- a/images/callouts/13.svg +++ /dev/null @@ -1,20 +0,0 @@ - - - - -]> - - - - - - - - - diff --git a/images/callouts/14.svg b/images/callouts/14.svg deleted file mode 100644 index 469aa97..0000000 --- a/images/callouts/14.svg +++ /dev/null @@ -1,17 +0,0 @@ - - - - -]> - - - - - - - - - diff --git a/images/callouts/15.svg b/images/callouts/15.svg deleted file mode 100644 index 8202233..0000000 --- a/images/callouts/15.svg +++ /dev/null @@ -1,19 +0,0 @@ - - - - -]> - - - - - - - - - diff --git a/images/callouts/16.svg b/images/callouts/16.svg deleted file mode 100644 index 01d6bf8..0000000 --- a/images/callouts/16.svg +++ /dev/null @@ -1,20 +0,0 @@ - - - - -]> - - - - - - - - - diff --git a/images/callouts/17.svg b/images/callouts/17.svg deleted file mode 100644 index 0a04c55..0000000 --- a/images/callouts/17.svg +++ /dev/null @@ -1,17 +0,0 @@ - - - - -]> - - - - - - - - - diff --git a/images/callouts/18.svg b/images/callouts/18.svg deleted file mode 100644 index 1cb891b..0000000 --- a/images/callouts/18.svg +++ /dev/null @@ -1,21 +0,0 @@ - - - - -]> - - - - - - - - - diff --git a/images/callouts/19.svg b/images/callouts/19.svg deleted file mode 100644 index e6fbb17..0000000 --- a/images/callouts/19.svg +++ /dev/null @@ -1,20 +0,0 @@ - - - - -]> - - - - - - - - - diff --git a/images/callouts/2.svg b/images/callouts/2.svg deleted file mode 100644 index 07d0339..0000000 --- a/images/callouts/2.svg +++ /dev/null @@ -1,17 +0,0 @@ - - - - -]> - - - - - - - - diff --git a/images/callouts/20.svg b/images/callouts/20.svg deleted file mode 100644 index ccbfd40..0000000 --- a/images/callouts/20.svg +++ /dev/null @@ -1,20 +0,0 @@ - - - - -]> - - - - - - - - - diff --git a/images/callouts/21.svg b/images/callouts/21.svg deleted file mode 100644 index 93ec53f..0000000 --- a/images/callouts/21.svg +++ /dev/null @@ -1,18 +0,0 @@ - - - - -]> - - - - - - - - - diff --git a/images/callouts/22.svg b/images/callouts/22.svg deleted file mode 100644 index f48c5f3..0000000 --- a/images/callouts/22.svg +++ /dev/null @@ -1,20 +0,0 @@ - - - - -]> - - - - - - - - - diff --git a/images/callouts/23.svg b/images/callouts/23.svg deleted file mode 100644 index 6624212..0000000 --- a/images/callouts/23.svg +++ /dev/null @@ -1,22 +0,0 @@ - - - - -]> - - - - - - - - - diff --git a/images/callouts/24.svg b/images/callouts/24.svg deleted file mode 100644 index a3d5525..0000000 --- a/images/callouts/24.svg +++ /dev/null @@ -1,19 +0,0 @@ - - - - -]> - - - - - - - - - diff --git a/images/callouts/25.svg b/images/callouts/25.svg deleted file mode 100644 index 56614a9..0000000 --- a/images/callouts/25.svg +++ /dev/null @@ -1,21 +0,0 @@ - - - - -]> - - - - - - - - - diff --git a/images/callouts/26.svg b/images/callouts/26.svg deleted file mode 100644 index 56faeac..0000000 --- a/images/callouts/26.svg +++ /dev/null @@ -1,22 +0,0 @@ - - - - -]> - - - - - - - - - diff --git a/images/callouts/27.svg b/images/callouts/27.svg deleted file mode 100644 index a75c812..0000000 --- a/images/callouts/27.svg +++ /dev/null @@ -1,19 +0,0 @@ - - - - -]> - - - - - - - - - diff --git a/images/callouts/28.svg b/images/callouts/28.svg deleted file mode 100644 index 7f8cf1a..0000000 --- a/images/callouts/28.svg +++ /dev/null @@ -1,23 +0,0 @@ - - - - -]> - - - - - - - - - diff --git a/images/callouts/29.svg b/images/callouts/29.svg deleted file mode 100644 index cb63adf..0000000 --- a/images/callouts/29.svg +++ /dev/null @@ -1,22 +0,0 @@ - - - - -]> - - - - - - - - - diff --git a/images/callouts/3.svg b/images/callouts/3.svg deleted file mode 100644 index 918be80..0000000 --- a/images/callouts/3.svg +++ /dev/null @@ -1,19 +0,0 @@ - - - - -]> - - - - - - - - diff --git a/images/callouts/30.svg b/images/callouts/30.svg deleted file mode 100644 index dc43ba1..0000000 --- a/images/callouts/30.svg +++ /dev/null @@ -1,22 +0,0 @@ - - - - -]> - - - - - - - - - diff --git a/images/callouts/4.svg b/images/callouts/4.svg deleted file mode 100644 index 8eb6a53..0000000 --- a/images/callouts/4.svg +++ /dev/null @@ -1,16 +0,0 @@ - - - - -]> - - - - - - - - diff --git a/images/callouts/5.svg b/images/callouts/5.svg deleted file mode 100644 index ca7a9f2..0000000 --- a/images/callouts/5.svg +++ /dev/null @@ -1,18 +0,0 @@ - - - - -]> - - - - - - - - diff --git a/images/callouts/6.svg b/images/callouts/6.svg deleted file mode 100644 index 783a0b9..0000000 --- a/images/callouts/6.svg +++ /dev/null @@ -1,19 +0,0 @@ - - - - -]> - - - - - - - - diff --git a/images/callouts/7.svg b/images/callouts/7.svg deleted file mode 100644 index 59b3714..0000000 --- a/images/callouts/7.svg +++ /dev/null @@ -1,16 +0,0 @@ - - - - -]> - - - - - - - - diff --git a/images/callouts/8.svg b/images/callouts/8.svg deleted file mode 100644 index c1803a3..0000000 --- a/images/callouts/8.svg +++ /dev/null @@ -1,20 +0,0 @@ - - - - -]> - - - - - - - - diff --git a/images/callouts/9.svg b/images/callouts/9.svg deleted file mode 100644 index bc149d3..0000000 --- a/images/callouts/9.svg +++ /dev/null @@ -1,19 +0,0 @@ - - - - -]> - - - - - - - - diff --git a/index.html b/index.html deleted file mode 100644 index a4e74fd..0000000 --- a/index.html +++ /dev/null @@ -1,423 +0,0 @@ - -neovim-flake Manual
neovim-flake Manual
   Next

neovim-flake Manual

Preface
1. Try it out
1.1. Using Prebuilt Configs
1.2. Available Configs
1.2.1. Nix
1.2.2. Tidal
1.2.3. Maximal
2. Default Configs
2.1. Tidal Cycles
2.2. Nix
2.3. Maximal
3. Custom Configuration
4. Custom Neovim Package
5. Custom Plugins
5.1. New Method
5.2. Old Method
6. Home Manager
7. Language Support
7.1. LSP Custom Packages/Command
8. Hacking neovim-flake
8.1. Getting started
8.2. Guidelines
8.2.1. Add adequate documentation
8.2.2. Format your code
8.2.3. Format your commit messages
8.2.4. Commits
8.2.5. Code Style
8.3. Testing Your Changes
8.4. Keybinds
8.4.1. Custom Key Mappings Support for a Plugin
8.5. Adding Plugins
A. Configuration Options
B. Release Notes
B.1. Release 0.1
B.1.1. Changelog
B.2. Release 0.2
B.2.1. Changelog
B.3. Release 0.3
B.3.1. Changelog
B.4. Release 0.4
B.4.1. Changelog
B.5. Release 0.5
B.5.1. Changelog
B.6. Release 0.6
B.6.1. Changelog

Preface

- If you believe your problem is caused by a bug in neovim-flake then please consider reporting it over - the neovim-flake issue tracker. - Bugfixes, feature additions and upstream changes are welcome over - the neovim-flake pull requests tab. -

Chapter 1. Try it out

Thanks to the portability of Nix, you can try out neovim-flake 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, three -configurations are provided:

  • -Nix -
  • -Tidal -
  • -Maximal -

You may try out any of the provided configurations using the nix run command on a system where Nix is installed.

$ cachix use neovim-flake # Optional: it'll save you CPU resources and time
-$ nix run github:notashelf/neovim-flake#nix # will run the default minimal configuration

Do keep in mind that this is susceptible to garbage collection meaning it will be removed from your Nix store -once you garbage collect. If you wish to install neovim-flake, please take a look at -custom-configuration or home-manager sections for installation -instructions.

1.1. Using Prebuilt Configs

$ nix run github:notashelf/neovim-flake#nix
-$ nix run github:notashelf/neovim-flake#tidal
-$ nix run github:notashelf/neovim-flake#maximal

1.2. Available Configs

1.2.1. Nix

Nix configuration by default provides LSP/diagnostic support for Nix alongisde a set of visual and functional plugins. -By running nix run ., which is the default package, you will build Neovim with this config.

1.2.2. Tidal

Tidal is an alternative config that adds vim-tidal on top of the plugins from the Nix configuration.

1.2.3. Maximal

Maximal 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.

You are strongly recommended to use the binary cache if you would like to try the Maximal configuration.

Chapter 2. Default Configs

While you can configure neovim-flake yourself using the builder, here are a few default configurations you can use.

2.1. Tidal Cycles

$ nix run github:notashelf/neovim-flake#tidal file.tidal

Utilizing vim-tidal and mitchmindtree’s fantastic tidalcycles.nix start playing with tidal cycles in a single command.

In your tidal file, type a cycle e.g. d1 $ s "drum" and then press ctrl+enter. Super collider with superdirt, and a modified GHCI with tidal will start up and begin playing. Note, you need jack enabled on your system. If you are using pipewire, its as easy as setting services.pipewire.jack.enable = true.

2.2. Nix

$ nix run github:notashelf/neovim-flake#nix test.nix

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.

2.3. Maximal

$ nix shell github:notashelf/neovim-flake#maximal test.nix

It is the same fully configured neovim as with the Nix config, but with every supported language enabled.

Note

Running the maximal config will download a lot of packages as it is downloading language servers, formatters, and more.

Chapter 3. Custom Configuration

Custom configuration is done with the neovimConfiguration while using the flake as a standalone package. -It takes in the configuration as a module. The output of the configuration function is an attrset.

{
-  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";
-}

The following is an example of a barebones vim configuration with the default theme enabled.

{
-  inputs.neovim-flake = {
-    url = "github:notashelf/neovim-flake";
-    inputs.nixpkgs.follows = "nixpkgs";
-  };
-
-  outputs = {nixpkgs, neovim-flake, ...}: let
-    system = "x86_64-linux";
-    pkgs = nixpkgs.legacyPackages.${system};
-    configModule = {
-      # Add any custom options (and feel free to upstream them!)
-      # options = ...
-
-      config.vim = {
-        theme.enable = true;
-      };
-    };
-
-    customNeovim = neovim-flake.lib.neovimConfiguration {
-      modules = [configModule];
-      inherit pkgs;
-    };
-  in {
-    # this will make the package available as a flake input
-    packages.${system}.neovim = customNeovim.neovim;
-
-    # this is an example nixosConfiguration using the built neovim package
-    nixosConfigurations = {
-      yourHostName = nixpkgs.lib.nixosSystem {
-        # ...
-        modules = [
-          ./configuration.nix # or whatever your configuration is
-
-          # this will make wrapped neovim available in your system packages
-          {environment.systemPackages = [customNeovim.neovim];}
-        ];
-        # ...
-      };
-    };
-  };
-}

Your built neovim configuration can be exposed as a flake output, or be added to your system packages to make -it available across your system. You may also consider passing the flake output to home-manager to make it available -to a specific user without using the home-manager module.

Chapter 4. Custom Neovim Package

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

{inputs, pkgs, ...}: {
-  # using the neovim-nightly overlay
-  config.vim.package = inputs.neovim-overlay.packages.${pkgs.system}.neovim;
-}

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 neovim-unwrapped in nixpkgs.

Chapter 5. Custom Plugins

You can use custom plugins, before they are implemented in the flake. -To add a plugin, you need to add it to your config’s config.vim.startPlugins array.

5.1. New Method

As of version 0.5, we have a more extensive API for configuring plugins, under vim.extraPlugins.

Instead of using DAGs exposed by the library, you may use the extra plugin module as follows:

{
-  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"];
-    };
-  };
-}

5.2. Old Method

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.

{
-  # fetch plugin source from GitHub and add it to startPlugins
-  config.vim.startPlugins = [
-    (pkgs.fetchFromGitHub {
-      owner = "FrenzyExists";
-      repo = "aquarium-vim";
-      rev = "d09b1feda1148797aa5ff0dbca8d8e3256d028d5";
-      sha256 = "CtyEhCcGxxok6xFQ09feWpdEBIYHH+GIFVOaNZx10Bs=";
-    })
-  ];
-}

However, just making the plugin available might not be enough. In that case, you can write custom vimscript -or lua config, using config.vim.configRC or config.vim.luaConfigRC respectively. -These options are attribute sets, and you need to give the configuration you’re adding some name, like this:

{
-  # this will create an "aquarium" section in your init.vim with the contents of your custom config
-  # which will be *appended* to the rest of your configuration, inside your init.vim
-  config.vim.configRC.aquarium = "colorscheme aquiarum";
-}

Note: If your configuration needs to be put in a specific place in the config, you can use functions from -inputs.neovim-flake.lib.nvim.dag to order it. -Refer to https://github.com/nix-community/home-manager/blob/master/modules/lib/dag.nix to find out more about -the DAG system.

Also, if you successfully made your plugin work, please make a PR to add it to the flake, or open an issue -with your findings so that we can make it available for everyone easily.

Chapter 6. Home Manager

The Home Manager module allows us to customize the different vim options from inside the home-manager configuration -and it is the preferred way of configuring neovim-flake, both on NixOS and non-NixOS systems.

To use it, we first add the input flake.

{
-  neovim-flake = {
-    url = github:notashelf/neovim-flake;
-    # you can override input nixpkgs
-    inputs.nixpkgs.follows = "nixpkgs";
-    # you can also override individual plugins
-    # i.e inputs.obsidian-nvim.follows = "obsidian-nvim"; # <- obsidian nvim needs to be in your inputs
-  };
-}

Followed by importing the home-manager module somewhere in your configuration.

{
-  # assuming neovim-flake is in your inputs and inputs is in the argset
-  imports = [ inputs.neovim-flake.homeManagerModules.default ];
-}

An example installation for standalone home-manager would look like this:

{
-  inputs = {
-    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
-    home-manager.url = "github:nix-community/home-manager";
-    stylix.url = "github:notashelf/neovim-flake";
-  };
-
-  outputs = { nixpkgs, home-manager, neovim-flake ... }: let
-  system = "x86_64-linux"; in {
-    # ↓ this is the home-manager output in the flake schema
-    homeConfigurations."yourUsername»" = home-manager.lib.homeManagerConfiguration {
-      pkgs = nixpkgs.legacyPackages.x86_64-linux;
-      modules = [
-        neovim-flake.homeManagerModules.default # <- this imports the home-manager module that provides the options
-        ./home.nix # your home-manager configuration, probably where you will want to add programs.neovim-flake options
-      ];
-    };
-  };
-}

Once the module is imported, we will be able to define the following options (and much more) from inside the -home-manager configuration.

{
-  programs.neovim-flake = {
-
-    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;
-      };
-    };
-  };
-}

Note

You may find all avaliable options in the appendix

Chapter 7. Language Support

Language specific support means there is a combination of language specific plugins, treesitter support, nvim-lspconfig language servers, and null-ls integration. This gets you capabilities ranging from autocompletion to formatting to diagnostics. The following languages have sections under the vim.languages attribute. See the configuration docs for details.

Adding support for more languages, and improving support for existing ones are great places -where you can contribute with a PR.

7.1. LSP Custom Packages/Command

In any of the opt.languages.<language>.lsp.package 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 $PATH during runtime, for example:

vim.languages.java = {
-  lsp = {
-    enable = true;
-        package = ["jdt-language-server" "-data" "~/.cache/jdtls/workspace"];
-  };
-}

Chapter 8. Hacking neovim-flake

neovim-flake is designed for developers as much as it is for the end user. I would like any potential contributor -to be able to propagate their desired changes into the repository without the extra effort. As such, below are guides -(and guidelines) to streamline the contribution process and ensure that your valuable input seamlessly integrates -into neovim-flake’s development without leaving question marks in your head.

This section is mainly directed towards those who wish to contribute code into neovim-flake. If you wish to instead -report a bug or discuss a potential feature implementation, first look among the already open issues and -if no matching issue exists you may open a new issue and describe your problem/request. 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.

8.1. Getting started

You naturally would like to start by forking the repository. If you are new to git, have a look at GitHub’s -Fork a repo guide for instructions on how you can do this. Once you have a fork of neovim-flake -you should create a branch starting at the most recent main branch. -Give your branch a reasonably descriptive name, suffixed by its type - i.e feature/debugger or fix/pesky-bug.

Implement your changes and commit them to the newly created branch and when you are happy with the result and positive -that it fulfills Section 8.2, “Guidelines”. Once you are confident everything is in order, push the branch to GitHub and

8.2. Guidelines

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.

If you are uncertain how these rules affect the change you would like to make then feel free to start a -discussion in the discussions tab ideally (but not necessarily) before you start developing.

8.2.1. Add adequate documentation

Most, if not all, changes warrant changes to the documentation. Module options should be documented with -Nixpkgs-flavoured Markdown, albeit with exceptions. -neovim-flake is itself documented using a combination of DocBook and AsciiDoc conventions.

The HTML version of this manual containing both the module option descriptions and the documentation of neovim-flake -(such as this page) can be generated and opened by typing the following in a shell within a clone of the -neovim-flake Git repository:

$ nix build .#docs-html
-$ xdg-open ./result/share/doc/neovim-flake/index.html

8.2.2. Format your code

Make sure your code is formatted as described in Section 8.2.5, “Code Style”. To maintain consistency throughout the project -you are encouraged to browse through existing code and adopt its style also in new code.

8.2.3. Format your commit messages

Similar to Section 8.2.2, “Format your code” we encourage a consistent commit message format as described -in Section 8.2.4, “Commits”.

8.2.4. Commits

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.

The commit messages should follow the seven rules, 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

{component}: {description}
-
-{long description}

where {component} refers to the code component (or module) your change affects, {description} is a very brief -description of your change, and {long description} is an optional clarifying description. As a rare exception, if -there is no clear component, or your change affects many components, then the {component} part is optional. -See Example 8.1, “Compliant commit message” for a commit message that fulfills these requirements.

Example 8.1. Compliant commit message

The commit 69f8e47e9e74c8d3d060ca22e18246b7f7d988ef contains the commit message

starship: allow running in Emacs if vterm is used
-
-The vterm buffer is backed by libvterm and can handle Starship prompts
-without issues.

Long description can be ommitted 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 for your changes.

Finally, when adding a new module, say modules/foo.nix, we use the fixed commit format foo: add module. -You can, of course, still include a long description if you wish.

In case of nested modules, i.e modules/languages/java.nix you are recommended to contain the parent as well - for -example languages/java: some major change.

8.2.5. Code Style

Treewide -Keep lines at a reasonable width, ideally 80 characters or less. This also applies to string literals and module -descriptions and documentation.

Nix -neovim-flake is formatted by the alejandra tool and the formatting is checked in the pull -request and push workflows. Run the nix fmt command inside the project repository before submitting your -pull request.

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.

Please use one line code for attribute sets that contain only one subset. -For example:

# 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
-        someOtherValue = mkOption {
-            type = lib.types.bool;
-            description = "Some other description"
-            default = true;
-        };
-    };
-}

If you move a line down after the merge operator, Alejandra will automatically unfold the whole merged attrset -for you, which we do not want.

module = {
-    key = mkEnableOption "some description" // {
-        default = true; # we want this to be inline
-    };
-    # ...
-}

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.

# 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
-singleItemList = [item1];

8.3. Testing Your Changes

Once you have made your changes, you will need to test them throughly. If it is a module, add your module option to -configuration.nix (located in the root of this project) inside neovimConfiguration. Enable it, and then run the -maximal configuration with nix run .#maximal -Lv to check for build errors. If neovim opens in the current directory -without any error messages (you can check the output of :messages 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 posssible.

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 configuration.nix, and then run it with nix run .#maximal -Lv. Same procedure as -adding a new module will apply here.

8.4. Keybinds

As of 0.4, there exists an API for writing your own keybinds and a couple of useful utility functions are available in -the extended standard library. The following section contains -a general overview to how you may utilize said functions.

8.4.1. Custom Key Mappings Support for a Plugin

To set a mapping, you should define it in vim.maps.<<mode>>. -The available modes are:

  • -normal -
  • -insert -
  • -select -
  • -visual -
  • -terminal -
  • -normalVisualOp -
  • -visualOnly -
  • -operator -
  • -insertCommand -
  • -lang -
  • -command -

An example, simple keybinding, can look like this:

{
-  vim.maps.normal = {
-    "<leader>wq" = {
-      action = ":wq<CR>";
-      silent = true;
-      desc = "Save file and quit";
-    };
-  };
-}

There are many settings available in the options. Please refer to the documentation to see a list of them.

neovim-flake provides a list of helper commands, so that you don’t have to write the mapping attribute sets every -time:

  • -mkBinding = key: action: desc: - makes a basic binding, with silent set to true. -
  • -mkExprBinding = key: action: desc: - makes an expression binding, with lua, silent, and expr set to true. -
  • -mkLuaBinding = key: action: desc: - makes an expression binding, with lua, and silent set to true. -

Note that the Lua in these bindings is actual Lua, not pasted into a :lua command. -Therefore, you either pass in a function like require('someplugin').some_function, without actually calling it, -or you define your own function, like function() require('someplugin').some_function() end.

Additionally, to not have to repeat the descriptions, there’s another utility function with its own set of functions:

# Utility function that takes two attrsets:
-# { someKey = "some_value" } and
-# { someKey = { description = "Some Description"; }; }
-# and merges them into
-# { someKey = { value = "some_value"; description = "Some Description"; }; }
-
-addDescriptionsToMappings = actualMappings: mappingDefinitions:

This function can be used in combination with the same mkBinding functions as above, except they only take two -arguments - binding and action, and have different names:

  • -mkSetBinding = binding: action: - makes a basic binding, with silent set to true. -
  • -mkSetExprBinding = binding: action: - makes an expression binding, with lua, silent, and expr set to true. -
  • -mkSetLuaBinding = binding: action: - makes an expression binding, with lua, and silent set to true. -

You can read the source code of some modules to see them in action, but their usage should look something like this:

# plugindefinition.nix
-{lib, ...}:
-with lib; {
-  options.vim.plugin = {
-    enable = mkEnableOption "Enable plugin";
-
-    # Mappings should always be inside an attrset called mappings
-    mappings = {
-      # mkMappingOption is a helper function from lib,
-      # that takes a description (which will also appear in which-key),
-      # and a default mapping (which can be null)
-      toggleCurrentLine = mkMappingOption "Toggle current line comment" "gcc";
-      toggleCurrentBlock = mkMappingOption "Toggle current block comment" "gbc";
-
-      toggleOpLeaderLine = mkMappingOption "Toggle line comment" "gc";
-      toggleOpLeaderBlock = mkMappingOption "Toggle block comment" "gb";
-
-      toggleSelectedLine = mkMappingOption "Toggle selected comment" "gc";
-      toggleSelectedBlock = mkMappingOption "Toggle selected block" "gb";
-    };
-  };
-}
# config.nix
-{
-  pkgs,
-  config,
-  lib,
-  ...
-}:
-with lib;
-with builtins; let
-  cfg = config.vim.plugin;
-  self = import ./plugindefinition.nix {inherit lib;};
-  mappingDefinitions = self.options.vim.plugin;
-
-  # addDescriptionsToMappings is a helper function from lib,
-  # that merges mapping values and their descriptions
-  # into one nice attribute set
-  mappings = addDescriptionsToMappings cfg.mappings mappingDefinitions;
-in {
-  config = mkIf (cfg.enable) {
-    # ...
-
-    vim.maps.normal = mkMerge [
-      # mkSetBinding is another helper function from lib,
-      # that actually adds the mapping with a description.
-      (mkSetBinding mappings.findFiles "<cmd> Telescope find_files<CR>")
-      (mkSetBinding mappings.liveGrep "<cmd> Telescope live_grep<CR>")
-      (mkSetBinding mappings.buffers "<cmd> Telescope buffers<CR>")
-      (mkSetBinding mappings.helpTags "<cmd> Telescope help_tags<CR>")
-      (mkSetBinding mappings.open "<cmd> Telescope<CR>")
-
-      (mkSetBinding mappings.gitCommits "<cmd> Telescope git_commits<CR>")
-      (mkSetBinding mappings.gitBufferCommits "<cmd> Telescope git_bcommits<CR>")
-      (mkSetBinding mappings.gitBranches "<cmd> Telescope git_branches<CR>")
-      (mkSetBinding mappings.gitStatus "<cmd> Telescope git_status<CR>")
-      (mkSetBinding mappings.gitStash "<cmd> Telescope git_stash<CR>")
-
-      (mkIf config.vim.lsp.enable (mkMerge [
-        (mkSetBinding mappings.lspDocumentSymbols "<cmd> Telescope lsp_document_symbols<CR>")
-        (mkSetBinding mappings.lspWorkspaceSymbols "<cmd> Telescope lsp_workspace_symbols<CR>")
-
-        (mkSetBinding mappings.lspReferences "<cmd> Telescope lsp_references<CR>")
-        (mkSetBinding mappings.lspImplementations "<cmd> Telescope lsp_implementations<CR>")
-        (mkSetBinding mappings.lspDefinitions "<cmd> Telescope lsp_definitions<CR>")
-        (mkSetBinding mappings.lspTypeDefinitions "<cmd> Telescope lsp_type_definitions<CR>")
-        (mkSetBinding mappings.diagnostics "<cmd> Telescope diagnostics<CR>")
-      ]))
-
-      (
-        mkIf config.vim.treesitter.enable
-        (mkSetBinding mappings.treesitter "<cmd> Telescope treesitter<CR>")
-      )
-    ];
-
-    # ...
-  };
-}

Note

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.

8.5. Adding Plugins

To add a new neovim plugin, first add the source url in the inputs section of flake.nix

{
-    inputs = {
-        # ...
-        neodev-nvim = {
-            url = "github:folke/neodev.nvim";
-            flake = false;
-        };
-    };
-}

Then add the name of the plugin into the availablePlugins variable in lib/types/plugins.nix:

# ...
-availablePlugins = [
-    # ...
-    "neodev-nvim"
-];

You can now reference this plugin using its string name:

config.vim.startPlugins = ["neodev-nvim"];
   Next
   Appendix A. Configuration Options
\ No newline at end of file diff --git a/index.xhtml b/index.xhtml new file mode 100644 index 0000000..a112be4 --- /dev/null +++ b/index.xhtml @@ -0,0 +1,486 @@ + + + + + + neovim-flake-manual + + + + + + + +
+ + + + + + + + + +
neovim-flake-manual
   Next
+
+
+
+
+
+

neovim-flake-manual

+

Version release-v0.6

+
+
+
+

Table of Contents

Preface
Try it out
Custom Configuration
Custom Neovim Package
Custom Plugins
New Method
Old Method
Configuring
Default Configs
Maximal
Nix
Tidal Cycles
Home Manager
Language Support
LSP Custom Packages/Command
Hacking neovim-flake
Getting Started
Guidelines
Testing Changes
Keybinds
Adding Plugins
A. Neovim Flake Configuration Options
+

Preface

If you noticed a bug caused by neovim-flake then please consider reporting it over +the neovim-flake issue tracker. +Bugfixes, feature additions and upstreamed changes are welcome over +the neovim-flake pull requests tab.

+

Try it out

Table of Contents

Using Prebuilt Configs

Thanks to the portability of Nix, you can try out neovim-flake 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, three +configurations are provided:

  • Nix

  • Tidal

  • Maximal

You may try out any of the provided configurations using the nix run command on a system where Nix is installed.

$ cachix use neovim-flake # Optional: it'll save you CPU resources and time
+$ nix run github:notashelf/neovim-flake#nix # will run the default minimal configuration
+

Do keep in mind that this is susceptible to garbage collection meaning it will be removed from your Nix store +once you garbage collect. If you wish to install neovim-flake, please take a look at +custom-configuration or home-manager sections for installation +instructions.

Using Prebuilt Configs

Available Configs 
$ nix run github:notashelf/neovim-flake#nix
+$ nix run github:notashelf/neovim-flake#tidal
+$ nix run github:notashelf/neovim-flake#maximal
+

Available Configs

Nix

Nix configuration by default provides LSP/diagnostic support for Nix alongisde a set of visual and functional plugins. +By running nix run ., which is the default package, you will build Neovim with this config.

+

Tidal

Tidal is an alternative config that adds vim-tidal on top of the plugins from the Nix configuration.

+

Maximal

Maximal 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.

You are strongly recommended to use the binary cache if you would like to try the Maximal configuration.

+
+ +
+ +
+ +

Custom Configuration

Custom configuration is done with the neovimConfiguration while using the flake as a standalone package. +It takes in the configuration as a module. The output of the configuration function is an attrset.

{
+  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";
+}
+

The following is an example of a barebones vim configuration with the default theme enabled.

{
+  inputs.neovim-flake = {
+    url = "github:notashelf/neovim-flake";
+    inputs.nixpkgs.follows = "nixpkgs";
+  };
+
+  outputs = {nixpkgs, neovim-flake, ...}: let
+    system = "x86_64-linux";
+    pkgs = nixpkgs.legacyPackages.${system};
+    configModule = {
+      # Add any custom options (and feel free to upstream them!)
+      # options = ...
+
+      config.vim = {
+        theme.enable = true;
+      };
+    };
+
+    customNeovim = neovim-flake.lib.neovimConfiguration {
+      modules = [configModule];
+      inherit pkgs;
+    };
+  in {
+    # this will make the package available as a flake input
+    packages.${system}.neovim = customNeovim.neovim;
+
+    # this is an example nixosConfiguration using the built neovim package
+    nixosConfigurations = {
+      yourHostName = nixpkgs.lib.nixosSystem {
+        # ...
+        modules = [
+          ./configuration.nix # or whatever your configuration is
+
+          # this will make wrapped neovim available in your system packages
+          {environment.systemPackages = [customNeovim.neovim];}
+        ];
+        # ...
+      };
+    };
+  };
+}
+

Your built neovim configuration can be exposed as a flake output, or be added to your system packages to make +it available across your system. You may also consider passing the flake output to home-manager to make it available +to a specific user without using the home-manager module.

+

Custom Neovim Package

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

{inputs, pkgs, ...}: {
+  # using the neovim-nightly overlay
+  config.vim.package = inputs.neovim-overlay.packages.${pkgs.system}.neovim;
+}
+

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 neovim-unwrapped in nixpkgs.

+

Custom Plugins

You can use custom plugins, before they are implemented in the flake. +To add a plugin, you need to add it to your config’s config.vim.startPlugins array.

Table of Contents

New Method
Old Method
Configuring

New Method

As of version 0.5, we have a more extensive API for configuring plugins, under vim.extraPlugins.

Instead of using DAGs exposed by the library, you may use the extra plugin module as follows:

{
+  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"];
+    };
+  };
+}
+
+

Old Method

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.

{
+  # fetch plugin source from GitHub and add it to startPlugins
+  config.vim.startPlugins = [
+    (pkgs.fetchFromGitHub {
+      owner = "FrenzyExists";
+      repo = "aquarium-vim";
+      rev = "d09b1feda1148797aa5ff0dbca8d8e3256d028d5";
+      sha256 = "CtyEhCcGxxok6xFQ09feWpdEBIYHH+GIFVOaNZx10Bs=";
+    })
+  ];
+}
+
+

Configuring

Just making the plugin to your neovim configuration available might not always be enough. +In that case, you can write custom vimscript or lua config, using config.vim.configRC or config.vim.luaConfigRC +respectively. These options are attribute sets, and you need to give the configuration you’re adding some name, like this:

{
+  # this will create an "aquarium" section in your init.vim with the contents of your custom config
+  # which will be *appended* to the rest of your configuration, inside your init.vim
+  config.vim.configRC.aquarium = "colorscheme aquiarum";
+}
+

Note

If your configuration needs to be put in a specific place in the config, you can use functions from +inputs.neovim-flake.lib.nvim.dag to order it. +Refer to https://github.com/nix-community/home-manager/blob/master/modules/lib/dag.nix to find out more about +the DAG system.

Also, if you successfully made your plugin work, please make a PR to add it to the flake, or open an issue +with your findings so that we can make it available for everyone easily.

+
+

Default Configs

While you can configure neovim-flake yourself using the builder, you can also use the pre-built configs that are available. +Here are a few default configurations you can use.

Table of Contents

Maximal
Nix
Tidal Cycles

Maximal 

$ nix shell github:notashelf/neovim-flake#maximal test.nix
+

It is the same fully configured neovim as with the Nix config, but with every supported language enabled.

::: note +Running the maximal config will download a lot of packages as it is downloading language servers, formatters, and more. +:::

+

Nix 

$ nix run github:notashelf/neovim-flake#nix test.nix
+

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.

+

Tidal Cycles 

$ nix run github:notashelf/neovim-flake#tidal file.tidal
+

Utilizing vim-tidal and mitchmindtree’s fantastic +tidalcycles.nix start playing with tidal cycles in a single command.

In your tidal file, type a cycle e.g. d1 $ s "drum" and then press ctrl+enter. Super collider with superdirt, and a +modified GHCI with tidal will start up and begin playing. Note, you need jack enabled on your system. If you are using +pipewire, its as easy as setting services.pipewire.jack.enable = true in your configuration.

+
+

Home Manager

The Home Manager module allows us to customize the different vim options from inside the home-manager configuration +and it is the preferred way of configuring neovim-flake, both on NixOS and non-NixOS systems.

To use it, we first add the input flake.

{
+  neovim-flake = {
+    url = github:notashelf/neovim-flake;
+    # you can override input nixpkgs
+    inputs.nixpkgs.follows = "nixpkgs";
+    # you can also override individual plugins
+    # i.e inputs.obsidian-nvim.follows = "obsidian-nvim"; # <- obsidian nvim needs to be in your inputs
+  };
+}
+

Followed by importing the home-manager module somewhere in your configuration.

{
+  # assuming neovim-flake is in your inputs and inputs is in the argset
+  imports = [ inputs.neovim-flake.homeManagerModules.default ];
+}
+

An example installation for standalone home-manager would look like this:

{
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+    home-manager.url = "github:nix-community/home-manager";
+    stylix.url = "github:notashelf/neovim-flake";
+  };
+
+  outputs = { nixpkgs, home-manager, neovim-flake ... }: let
+  system = "x86_64-linux"; in {
+    # ↓ this is the home-manager output in the flake schema
+    homeConfigurations."yourUsername»" = home-manager.lib.homeManagerConfiguration {
+      pkgs = nixpkgs.legacyPackages.x86_64-linux;
+      modules = [
+        neovim-flake.homeManagerModules.default # <- this imports the home-manager module that provides the options
+        ./home.nix # your home-manager configuration, probably where you will want to add programs.neovim-flake options
+      ];
+    };
+  };
+}
+

Once the module is imported, we will be able to define the following options (and much more) from inside the +home-manager configuration.

  programs.neovim-flake = {
+
+    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;
+      };
+    };
+  };
+}
+

Note

You may find all avaliable options in the appendix

+

Language Support

Language specific support means there is a combination of language specific plugins, treesitter support, nvim-lspconfig language servers, and null-ls integration. This gets you capabilities ranging from autocompletion to formatting to diagnostics. The following languages have sections under the vim.languages attribute. See the configuration docs for details.

Adding support for more languages, and improving support for existing ones are great places +where you can contribute with a PR.

Table of Contents

LSP Custom Packages/Command

LSP Custom Packages/Command

In any of the opt.languages.<language>.lsp.package 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 $PATH during runtime, for example:

vim.languages.java = {
+  lsp = {
+    enable = true;
+    package = ["jdt-language-server" "-data" "~/.cache/jdtls/workspace"];
+  };
+}
+
+
+

Hacking neovim-flake

neovim-flake is designed for developers as much as it is for the end user. I would like any potential contributor +to be able to propagate their desired changes into the repository without the extra effort. As such, below are guides +(and guidelines) to streamline the contribution process and ensure that your valuable input seamlessly integrates +into neovim-flake’s development without leaving question marks in your head.

This section is mainly directed towards those who wish to contribute code into neovim-flake. If you wish to instead +report a bug or discuss a potential feature implementation, first look among the +already open issues and if no matching issue exists you may open +a new issue and describe your problem/request. 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.

Table of Contents

Getting Started
Guidelines
Testing Changes
Keybinds
Adding Plugins

Getting Started

You naturally would like to start by forking the repository. If you are new to git, have a look at GitHub’s +Fork a repo guide for instructions on how you can do this. Once you have a fork of neovim-flake +you should create a branch starting at the most recent main branch. +Give your branch a reasonably descriptive name, suffixed by its type - i.e feature/debugger or fix/pesky-bug.

Implement your changes and commit them to the newly created branch and when you are happy with the result and positive +that it fulfills Guidelines. Once you are confident everything is in order, push the branch to GitHub and +create a pull request, following the template that you will be prompted to fill.

+

Guidelines

Adding Documentation
Formatting Code
Formatting Commits
Commit Style
Example Commit
Code Style

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.

If you are uncertain how these rules affect the change you would like to make then feel free to start a +discussion in the discussions tab ideally (but not necessarily) +before you start developing.

Adding Documentation

Most, if not all, changes warrant changes to the documentation. Module options should be documented with +Nixpkgs-flavoured Markdown, albeit with exceptions.

Note

As of v0.6, neovim-flake is itself documented using full markdown in both module options and the manual.

The HTML version of this manual containing both the module option descriptions and the documentation of neovim-flake +(such as this page) can be generated and opened by typing the following in a shell within a clone of the +neovim-flake Git repository:

$ nix build .#docs-html
+$ xdg-open $PWD/result/share/doc/neovim-flake/index.html
+
+

Formatting Code

Make sure your code is formatted as described in code-style section. To maintain consistency throughout +the project you are encouraged to browse through existing code and adopt its style also in new code.

+

Formatting Commits

Similar to code style guidelines we encourage a consistent commit message format as described +in commit style guidelines.

+

Commit Style

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.

The commit messages should follow the {seven-rules}[seven rules], 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

  {component}: {description}
+
+  {long description}
+

where {component} refers to the code component (or module) your change affects, {description} is a very brief +description of your change, and {long description} is an optional clarifying description. As a rare exception, if +there is no clear component, or your change affects many components, then the {component} part is optional. +See <<ex-commit-message>> for a commit message that fulfills these requirements.

+

Example Commit

The commit {example-commit-message}[69f8e47e9e74c8d3d060ca22e18246b7f7d988ef] contains the commit message


+starship: allow running in Emacs if vterm is used
+
+The vterm buffer is backed by libvterm and can handle Starship prompts
+without issues.
+
+

Long description can be ommitted 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 for your changes.

Finally, when adding a new module, say modules/foo.nix, we use the fixed commit format foo: add module. +You can, of course, still include a long description if you wish.

In case of nested modules, i.e modules/languages/java.nix you are recommended to contain the parent as well - for +example languages/java: some major change.

+

Code Style

Treewide +Keep lines at a reasonable width, ideally 80 characters or less. This also applies to string literals and module +descriptions and documentation.

Nix +neovim-flake is formatted by the alejandra tool and the formatting is checked in the pull +request and push workflows. Run the nix fmt command inside the project repository before submitting your +pull request.

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.

Please use one line code for attribute sets that contain only one subset. +For example:

# 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
+        someOtherValue = mkOption {
+            type = lib.types.bool;
+            description = "Some other description";
+            default = true;
+        };
+    };
+}
+

If you move a line down after the merge operator, Alejandra will automatically unfold the whole merged attrset +for you, which we do not want.

module = {
+  key = mkEnableOption "some description" // {
+    default = true; # we want this to be inline
+  }; # ...
+}
+

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.


+# 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];
+
+# this is not ok
+listToBeAvoided = [
+  item1
+];
+
+
+ +

Testing Changes

Once you have made your changes, you will need to test them throughly. If it is a module, add your module option to +configuration.nix (located in the root of this project) inside neovimConfiguration. Enable it, and then run the +maximal configuration with nix run .#maximal -Lv to check for build errors. If neovim opens in the current directory +without any error messages (you can check the output of :messages 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 posssible.

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 configuration.nix, and then run it with nix run .#maximal -Lv. Same procedure as +adding a new module will apply here.

+

Keybinds

Custom Key Mappings Support for a Plugin

As of 0.4, there exists an API for writing your own keybinds and a couple of useful utility functions are available in +the https://github.com/NotAShelf/neovim-flake/tree/main/lib[extended standard library]. The following section contains +a general overview to how you may utilize said functions.

Custom Key Mappings Support for a Plugin

:maps: https://notashelf.github.io/neovim-flake/options.html#opt-vim.maps.command.name.action

To set a mapping, you should define it in vim.maps.<<mode>>. +The available modes are:

  • normal

  • insert

  • select

  • visual

  • terminal

  • normalVisualOp

  • visualOnly

  • operator

  • insertCommand

  • lang

  • command

An example, simple keybinding, can look like this:

{
+  vim.maps.normal = {
+    "<leader>wq" = {
+      action = ":wq<CR>";
+      silent = true;
+      desc = "Save file and quit";
+    };
+  };
+}
+

There are many settings available in the options. Please refer to the {maps}[documentation] to see a list of them.

neovim-flake provides a list of helper commands, so that you don’t have to write the mapping attribute sets every +time:

  • mkBinding = key: action: desc: - makes a basic binding, with silent set to true.

  • mkExprBinding = key: action: desc: - makes an expression binding, with lua, silent, and expr set to true.

  • mkLuaBinding = key: action: desc: - makes an expression binding, with lua, and silent set to true.

Note that the Lua in these bindings is actual Lua, not pasted into a :lua command. +Therefore, you either pass in a function like require('someplugin').some_function, without actually calling it, +or you define your own function, like function() require('someplugin').some_function() end.

Additionally, to not have to repeat the descriptions, there’s another utility function with its own set of functions:

Utility function that takes two attrsets:

  • { someKey = "some_value" }

  • { someKey = { description = "Some Description"; }; }

and merges them into { someKey = { value = "some_value"; description = "Some Description"; }; }

addDescriptionsToMappings = actualMappings: mappingDefinitions:
+

This function can be used in combination with the same mkBinding functions as above, except they only take two +arguments - binding and action, and have different names:

  • mkSetBinding = binding: action: - makes a basic binding, with silent set to true.

  • mkSetExprBinding = binding: action: - makes an expression binding, with lua, silent, and expr set to true.

  • mkSetLuaBinding = binding: action: - makes an expression binding, with lua, and silent set to true.

You can read the source code of some modules to see them in action, but their usage should look something like this:


+# plugindefinition.nix
+{lib, ...}: with lib; {
+  options.vim.plugin = {
+    enable = mkEnableOption "Enable plugin";
+
+    # Mappings should always be inside an attrset called mappings
+    mappings = {
+      # mkMappingOption is a helper function from lib,
+      # that takes a description (which will also appear in which-key),
+      # and a default mapping (which can be null)
+      toggleCurrentLine = mkMappingOption "Toggle current line comment" "gcc";
+      toggleCurrentBlock = mkMappingOption "Toggle current block comment" "gbc";
+
+      toggleOpLeaderLine = mkMappingOption "Toggle line comment" "gc";
+      toggleOpLeaderBlock = mkMappingOption "Toggle block comment" "gb";
+
+      toggleSelectedLine = mkMappingOption "Toggle selected comment" "gc";
+      toggleSelectedBlock = mkMappingOption "Toggle selected block" "gb";
+    };
+
+  };
+}
+
+

+# config.nix
+{
+  pkgs,
+  config,
+  lib,
+  ...
+}:
+  with lib;
+  with builtins; let
+    cfg = config.vim.plugin;
+    self = import ./plugindefinition.nix {inherit lib;};
+    mappingDefinitions = self.options.vim.plugin;
+
+    # addDescriptionsToMappings is a helper function from lib,
+    # that merges mapping values and their descriptions
+    # into one nice attribute set
+    mappings = addDescriptionsToMappings cfg.mappings mappingDefinitions;
+in {
+  config = mkIf (cfg.enable) {
+    # ...
+    vim.maps.normal = mkMerge [
+      # mkSetBinding is another helper function from lib,
+      # that actually adds the mapping with a description.
+      (mkSetBinding mappings.findFiles "<cmd> Telescope find_files<CR>")
+      (mkSetBinding mappings.liveGrep "<cmd> Telescope live_grep<CR>")
+      (mkSetBinding mappings.buffers "<cmd> Telescope buffers<CR>")
+      (mkSetBinding mappings.helpTags "<cmd> Telescope help_tags<CR>")
+      (mkSetBinding mappings.open "<cmd> Telescope<CR>")
+
+      (mkSetBinding mappings.gitCommits "<cmd> Telescope git_commits<CR>")
+      (mkSetBinding mappings.gitBufferCommits "<cmd> Telescope git_bcommits<CR>")
+      (mkSetBinding mappings.gitBranches "<cmd> Telescope git_branches<CR>")
+      (mkSetBinding mappings.gitStatus "<cmd> Telescope git_status<CR>")
+      (mkSetBinding mappings.gitStash "<cmd> Telescope git_stash<CR>")
+
+      (mkIf config.vim.lsp.enable (mkMerge [
+        (mkSetBinding mappings.lspDocumentSymbols "<cmd> Telescope lsp_document_symbols<CR>")
+        (mkSetBinding mappings.lspWorkspaceSymbols "<cmd> Telescope lsp_workspace_symbols<CR>")
+
+        (mkSetBinding mappings.lspReferences "<cmd> Telescope lsp_references<CR>")
+        (mkSetBinding mappings.lspImplementations "<cmd> Telescope lsp_implementations<CR>")
+        (mkSetBinding mappings.lspDefinitions "<cmd> Telescope lsp_definitions<CR>")
+        (mkSetBinding mappings.lspTypeDefinitions "<cmd> Telescope lsp_type_definitions<CR>")
+        (mkSetBinding mappings.diagnostics "<cmd> Telescope diagnostics<CR>")
+      ]))
+
+      (
+        mkIf config.vim.treesitter.enable
+        (mkSetBinding mappings.treesitter "<cmd> Telescope treesitter<CR>")
+      )
+    ];
+    # ...
+  };
+}
+
+

Note

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.

+
+ +

Adding Plugins

To add a new neovim plugin, first add the source url in the inputs section of flake.nix


+{
+  inputs = {
+    # ...
+    neodev-nvim = {
+      url = "github:folke/neodev.nvim";
+      flake = false;
+    };
+    # ...
+  };
+}
+

Then add the name of the plugin into the availablePlugins variable in lib/types/plugins.nix:

# ...
+availablePlugins = [
+  # ...
+  "neodev-nvim"
+];
+

You can now reference this plugin using its string name:

config.vim.startPlugins = ["neodev-nvim"];
+
+
+
+
+
+
+ + + + + + + + + + + +
   Next
   Appendix A. Neovim Flake Configuration Options
+
+ + \ No newline at end of file diff --git a/options.html b/options.html index 46f5c45..40888a1 100644 --- a/options.html +++ b/options.html @@ -1,5 +1,40 @@ - -Appendix A. Configuration Options
Appendix A. Configuration Options
Prev   Next

Appendix A. Configuration Options

_module.args

Additional arguments passed to each module in addition to ones + + + + + + Appendix A. Neovim Flake Configuration Options + + + + + + + +

+ + + + + + + + + +
Appendix A. Neovim Flake Configuration Options
Prev   
+
+

Appendix A. Neovim Flake Configuration Options

+ +
+
+ + _module.args + + +
+
+

Additional arguments passed to each module in addition to ones like lib, config, and pkgs, modulesPath.

This option is also available to all submodules. Submodules do not inherit args from their parent module, nor do they provide args to @@ -8,3231 +43,17377 @@ this is the argument name 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.

Some arguments are already passed by default, of which the -following cannot be changed with this option:

+
+ + vim.autocomplete.formatting.format + + +
+
+

The function used to customize the appearance of the completion menu.

If vim.lsp.lspkind.enable is true, then the function +will be called before modifications from lspkind.

Default is to call the menu mapping function.

+ +

Type: +string

+ +

Default: +"nvim_cmp_menu_map"

+ +

Example:

function(entry, vim_item)
   return vim_item
 end
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/completion/nvim-cmp/nvim-cmp.nix> -
vim.autocomplete.mappings.close

Close [nvim-cmp]

Type: -null or string

Default: -"<C-e>"

Declared by:

+
+ +
+
+
+ + vim.autocomplete.mappings.close + + +
+
+

Close [nvim-cmp]

+ +

Type: +null or string

+ +

Default: +"<C-e>"

+ +

Declared by:

+ +
+ <neovim-flake/modules/completion/nvim-cmp/nvim-cmp.nix> -
vim.autocomplete.mappings.complete

Complete [nvim-cmp]

Type: -null or string

Default: -"<C-Space>"

Declared by:

+
+ +
+
+
+ + vim.autocomplete.mappings.complete + + +
+
+

Complete [nvim-cmp]

+ +

Type: +null or string

+ +

Default: +"<C-Space>"

+ +

Declared by:

+ +
+ <neovim-flake/modules/completion/nvim-cmp/nvim-cmp.nix> -
vim.autocomplete.mappings.confirm

Confirm [nvim-cmp]

Type: -null or string

Default: -"<CR>"

Declared by:

+
+ +
+
+
+ + vim.autocomplete.mappings.confirm + + +
+
+

Confirm [nvim-cmp]

+ +

Type: +null or string

+ +

Default: +"<CR>"

+ +

Declared by:

+ +
+ <neovim-flake/modules/completion/nvim-cmp/nvim-cmp.nix> -
vim.autocomplete.mappings.next

Next item [nvim-cmp]

Type: -null or string

Default: -"<Tab>"

Declared by:

+
+ +
+
+
+ + vim.autocomplete.mappings.next + + +
+
+

Next item [nvim-cmp]

+ +

Type: +null or string

+ +

Default: +"<Tab>"

+ +

Declared by:

+ +
+ <neovim-flake/modules/completion/nvim-cmp/nvim-cmp.nix> -
vim.autocomplete.mappings.previous

Previous item [nvim-cmp]

Type: -null or string

Default: -"<S-Tab>"

Declared by:

+
+ +
+
+
+ + vim.autocomplete.mappings.previous + + +
+
+

Previous item [nvim-cmp]

+ +

Type: +null or string

+ +

Default: +"<S-Tab>"

+ +

Declared by:

+ +
+ <neovim-flake/modules/completion/nvim-cmp/nvim-cmp.nix> -
vim.autocomplete.mappings.scrollDocsDown

Scroll docs down [nvim-cmp]

Type: -null or string

Default: -"<C-f>"

Declared by:

+
+ +
+
+
+ + vim.autocomplete.mappings.scrollDocsDown + + +
+
+

Scroll docs down [nvim-cmp]

+ +

Type: +null or string

+ +

Default: +"<C-f>"

+ +

Declared by:

+ +
+ <neovim-flake/modules/completion/nvim-cmp/nvim-cmp.nix> -
vim.autocomplete.mappings.scrollDocsUp

Scroll docs up [nvim-cmp]

Type: -null or string

Default: -"<C-d>"

Declared by:

+
+ +
+
+
+ + vim.autocomplete.mappings.scrollDocsUp + + +
+
+

Scroll docs up [nvim-cmp]

+ +

Type: +null or string

+ +

Default: +"<C-d>"

+ +

Declared by:

+ +
+ <neovim-flake/modules/completion/nvim-cmp/nvim-cmp.nix> -
vim.autocomplete.sources

Attribute set of source names for nvim-cmp.

If an attribute set is provided, then the menu value of + +

+
+
+ + vim.autocomplete.sources + + +
+
+

Attribute set of source names for nvim-cmp.

If an attribute set is provided, then the menu value of vim_item in the format will be set to the value (if -utilizing the nvim_cmp_menu_map function).

Note: only use a single attribute name per attribute set

Type: -attribute set of (null or string)

Default: -{ }

Example:

''
-  {nvim-cmp = null; buffer = "[Buffer]";}
-''
-

Declared by:

+
+utilizing the nvim_cmp_menu_map function).

Note: only use a single attribute name per attribute set

+ +

Type: +attribute set of (null or string)

+ +

Default: +{ }

+ +

Example:

''
+  {nvim-cmp = null; buffer = "[Buffer]";}
+''
+
+ +

Declared by:

+ +
+ <neovim-flake/modules/completion/nvim-cmp/nvim-cmp.nix> -
vim.autocomplete.type

Set the autocomplete plugin. Options: [nvim-cmp]

Type: -value “nvim-cmp” (singular enum)

Default: -"nvim-cmp"

Declared by:

+
+ +
+
+
+ + vim.autocomplete.type + + +
+
+

Set the autocomplete plugin. Options: [nvim-cmp]

+ +

Type: +value “nvim-cmp” (singular enum)

+ +

Default: +"nvim-cmp"

+ +

Declared by:

+ +
+ <neovim-flake/modules/completion/nvim-cmp/nvim-cmp.nix> -
vim.autopairs.enable

Whether to enable autopairs.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.autopairs.enable + + +
+
+

Whether to enable autopairs.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/autopairs/nvim-autopairs/nvim-autopairs.nix> -
vim.autopairs.nvim-compe.auto_select

auto select first item

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.autopairs.nvim-compe.auto_select + + +
+
+

auto select first item

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/autopairs/nvim-autopairs/nvim-autopairs.nix> -
vim.autopairs.nvim-compe.map_complete

auto insert ( after select function or method item

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.autopairs.nvim-compe.map_complete + + +
+
+

auto insert ( after select function or method item

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/autopairs/nvim-autopairs/nvim-autopairs.nix> -
vim.autopairs.nvim-compe.map_cr

map <CR> on insert mode

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.autopairs.nvim-compe.map_cr + + +
+
+

map <CR> on insert mode

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/autopairs/nvim-autopairs/nvim-autopairs.nix> -
vim.autopairs.type

Set the autopairs type. Options: nvim-autopairs [nvim-autopairs]

Type: -value “nvim-autopairs” (singular enum)

Default: -"nvim-autopairs"

Declared by:

+
+ +
+
+
+ + vim.autopairs.type + + +
+
+

Set the autopairs type. Options: nvim-autopairs [nvim-autopairs]

+ +

Type: +value “nvim-autopairs” (singular enum)

+ +

Default: +"nvim-autopairs"

+ +

Declared by:

+ +
+ <neovim-flake/modules/autopairs/nvim-autopairs/nvim-autopairs.nix> -
vim.bell

Set how bells are handled. Options: on, visual or none

Type: -one of “none”, “visual”, “on”

Default: -"none"

Declared by:

+
+ +
+
+
+ + vim.bell + + +
+
+

Set how bells are handled. Options: on, visual or none

+ +

Type: +one of “none”, “visual”, “on”

+ +

Default: +"none"

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.binds.cheatsheet.enable

Whether to enable cheatsheet-nvim: searchable cheatsheet for nvim using telescope.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.binds.cheatsheet.enable + + +
+
+

Whether to enable cheatsheet-nvim: searchable cheatsheet for nvim using telescope.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/binds/cheatsheet/cheatsheet.nix> -
vim.binds.whichKey.enable

Whether to enable which-key keybind helper menu.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.binds.whichKey.enable + + +
+
+

Whether to enable which-key keybind helper menu.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/binds/which-key/which-key.nix> -
vim.cmdHeight

Height of the command pane

Type: -signed integer

Default: -1

Declared by:

+
+ +
+
+
+ + vim.cmdHeight + + +
+
+

Height of the command pane

+ +

Type: +signed integer

+ +

Default: +1

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.colourTerm

Set terminal up for 256 colours

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.colourTerm + + +
+
+

Set terminal up for 256 colours

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.comments.comment-nvim.enable

Whether to enable smart and powerful comment plugin for neovim comment-nvim.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.comments.comment-nvim.enable + + +
+
+

Whether to enable smart and powerful comment plugin for neovim comment-nvim.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/comments/comment-nvim/comment-nvim.nix> -
vim.comments.comment-nvim.mappings.toggleCurrentBlock

Toggle current block comment

Type: -null or string

Default: -"gbc"

Declared by:

+
+ +
+
+
+ + vim.comments.comment-nvim.mappings.toggleCurrentBlock + + +
+
+

Toggle current block comment

+ +

Type: +null or string

+ +

Default: +"gbc"

+ +

Declared by:

+ +
+ <neovim-flake/modules/comments/comment-nvim/comment-nvim.nix> -
vim.comments.comment-nvim.mappings.toggleCurrentLine

Toggle current line comment

Type: -null or string

Default: -"gcc"

Declared by:

+
+ +
+
+
+ + vim.comments.comment-nvim.mappings.toggleCurrentLine + + +
+
+

Toggle current line comment

+ +

Type: +null or string

+ +

Default: +"gcc"

+ +

Declared by:

+ +
+ <neovim-flake/modules/comments/comment-nvim/comment-nvim.nix> -
vim.comments.comment-nvim.mappings.toggleOpLeaderBlock

Toggle block comment

Type: -null or string

Default: -"gb"

Declared by:

+
+ +
+
+
+ + vim.comments.comment-nvim.mappings.toggleOpLeaderBlock + + +
+
+

Toggle block comment

+ +

Type: +null or string

+ +

Default: +"gb"

+ +

Declared by:

+ +
+ <neovim-flake/modules/comments/comment-nvim/comment-nvim.nix> -
vim.comments.comment-nvim.mappings.toggleOpLeaderLine

Toggle line comment

Type: -null or string

Default: -"gc"

Declared by:

+
+ +
+
+
+ + vim.comments.comment-nvim.mappings.toggleOpLeaderLine + + +
+
+

Toggle line comment

+ +

Type: +null or string

+ +

Default: +"gc"

+ +

Declared by:

+ +
+ <neovim-flake/modules/comments/comment-nvim/comment-nvim.nix> -
vim.comments.comment-nvim.mappings.toggleSelectedBlock

Toggle selected block

Type: -null or string

Default: -"gb"

Declared by:

+
+ +
+
+
+ + vim.comments.comment-nvim.mappings.toggleSelectedBlock + + +
+
+

Toggle selected block

+ +

Type: +null or string

+ +

Default: +"gb"

+ +

Declared by:

+ +
+ <neovim-flake/modules/comments/comment-nvim/comment-nvim.nix> -
vim.comments.comment-nvim.mappings.toggleSelectedLine

Toggle selected comment

Type: -null or string

Default: -"gc"

Declared by:

+
+ +
+
+
+ + vim.comments.comment-nvim.mappings.toggleSelectedLine + + +
+
+

Toggle selected comment

+ +

Type: +null or string

+ +

Default: +"gc"

+ +

Declared by:

+ +
+ <neovim-flake/modules/comments/comment-nvim/comment-nvim.nix> -
vim.configRC

vimrc contents

Type: -(DAG of strings concatenated with “\n”) or string

Default: -{ }

Declared by:

+
+ +
+
+
+ + vim.configRC + + +
+
+

vimrc contents

+ +

Type: +(DAG of strings concatenated with “\n”) or string

+ +

Default: +{ }

+ +

Declared by:

+ +
+ <neovim-flake/modules/core> -
vim.cursorlineOpt

Highlight the text line of the cursor with CursorLine hl-CursorLine

Type: -one of “line”, “screenline”, “number”, “both”

Default: -"line"

Declared by:

+
+ +
+
+
+ + vim.cursorlineOpt + + +
+
+

Highlight the text line of the cursor with CursorLine hl-CursorLine

+ +

Type: +one of “line”, “screenline”, “number”, “both”

+ +

Default: +"line"

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.dashboard.alpha.enable

Whether to enable dashboard via alpha.nvim.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.dashboard.alpha.enable + + +
+
+

Whether to enable dashboard via alpha.nvim.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/alpha/alpha.nix> -
vim.dashboard.dashboard-nvim.enable

Whether to enable dashboard via dashboard.nvim.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.dashboard.dashboard-nvim.enable + + +
+
+

Whether to enable dashboard via dashboard.nvim.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/dashboard-nvim/dashboard-nvim.nix> -
vim.dashboard.startify.enable

Whether to enable dashboard via vim-startify.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.dashboard.startify.enable + + +
+
+

Whether to enable dashboard via vim-startify.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.bookmarks

List of book marks to disaply on start page

Type: -list of (attribute set)

Default: -[ ]

Example:

{
-  c = "~/.vimrc";
+
+
+
+
+ + vim.dashboard.startify.bookmarks + + +
+
+

List of book marks to disaply on start page

+ +

Type: +list of (attribute set)

+ +

Default: +[ ]

+ +

Example:

{
+  c = "~/.vimrc";
 }
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.changeDirCmd

Command to change the current window with. Can be cd, lcd or tcd

Type: -one of “cd”, “lcd”, “tcd”

Default: -"lcd"

Declared by:

+
+ +
+
+
+ + vim.dashboard.startify.changeDirCmd + + +
+
+

Command to change the current window with. Can be cd, lcd or tcd

+ +

Type: +one of “cd”, “lcd”, “tcd”

+ +

Default: +"lcd"

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.changeToDir

Should vim change to the directory of the file you open

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.dashboard.startify.changeToDir + + +
+
+

Should vim change to the directory of the file you open

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.changeToVCRoot

Should vim change to the version control root when opening a file

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.dashboard.startify.changeToVCRoot + + +
+
+

Should vim change to the version control root when opening a file

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.commands

Commands that are presented to the user on startify page

Type: -list of (string or (attribute set) or list of string)

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.dashboard.startify.commands + + +
+
+

Commands that are presented to the user on startify page

+ +

Type: +list of (string or (attribute set) or list of string)

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.customFooter

Text to place in the footer

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.dashboard.startify.customFooter + + +
+
+

Text to place in the footer

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.customHeader

Text to place in the header

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.dashboard.startify.customHeader + + +
+
+

Text to place in the header

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.customIndices

Specify a list of default charecters to use instead of numbers

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.dashboard.startify.customIndices + + +
+
+

Specify a list of default charecters to use instead of numbers

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.disableOnStartup

Prevent startify from opening on startup but can be called with :Startify

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.dashboard.startify.disableOnStartup + + +
+
+

Prevent startify from opening on startup but can be called with :Startify

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.filesNumber

How many files to list

Type: -signed integer

Default: -10

Declared by:

+
+ +
+
+
+ + vim.dashboard.startify.filesNumber + + +
+
+

How many files to list

+ +

Type: +signed integer

+ +

Default: +10

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.lists

Specify the lists and in what order they are displayed on startify.

Type: -list of (attribute set)

Default:

[
+
+
+
+
+ + vim.dashboard.startify.lists + + +
+
+

Specify the lists and in what order they are displayed on startify.

+ +

Type: +list of (attribute set)

+ +

Default:

[
   {
     header = [
-      "MRU"
+      "MRU"
     ];
-    type = "files";
+    type = "files";
   }
   {
     header = [
-      "MRU Current Directory"
+      "MRU Current Directory"
     ];
-    type = "dir";
+    type = "dir";
   }
   {
     header = [
-      "Sessions"
+      "Sessions"
     ];
-    type = "sessions";
+    type = "sessions";
   }
   {
     header = [
-      "Bookmarks"
+      "Bookmarks"
     ];
-    type = "bookmarks";
+    type = "bookmarks";
   }
   {
     header = [
-      "Commands"
+      "Commands"
     ];
-    type = "commands";
+    type = "commands";
   }
 ]
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.paddingLeft

Number of spaces used for left padding.

Type: -signed integer

Default: -3

Declared by:

+
+ +
+
+
+ + vim.dashboard.startify.paddingLeft + + +
+
+

Number of spaces used for left padding.

+ +

Type: +signed integer

+ +

Default: +3

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.sessionAutoload

Make startify auto load Session.vim files from the current directory

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.dashboard.startify.sessionAutoload + + +
+
+

Make startify auto load Session.vim files from the current directory

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.sessionBeforeSave

Commands to run before saving a session

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.dashboard.startify.sessionBeforeSave + + +
+
+

Commands to run before saving a session

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.sessionDeleteBuffers

Delete all buffers when loading or closing a session

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.dashboard.startify.sessionDeleteBuffers + + +
+
+

Delete all buffers when loading or closing a session

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.sessionDir

Directory to save and load sessions from

Type: -string

Default: -"~/.vim/session"

Declared by:

+
+ +
+
+
+ + vim.dashboard.startify.sessionDir + + +
+
+

Directory to save and load sessions from

+ +

Type: +string

+ +

Default: +"~/.vim/session"

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.sessionPersistence

Persist session before leaving vim or switching session

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.dashboard.startify.sessionPersistence + + +
+
+

Persist session before leaving vim or switching session

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.sessionRemoveLines

Patterns to remove from session files

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.dashboard.startify.sessionRemoveLines + + +
+
+

Patterns to remove from session files

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.sessionSavecmds

List of commands to run when loading a session.

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.dashboard.startify.sessionSavecmds + + +
+
+

List of commands to run when loading a session.

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.sessionSavevars

List of variables to save into a session file.

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.dashboard.startify.sessionSavevars + + +
+
+

List of variables to save into a session file.

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.sessionSort

Set if you want items sorted by date rather than alphabetically

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.dashboard.startify.sessionSort + + +
+
+

Set if you want items sorted by date rather than alphabetically

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.skipList

List of regex patterns to exclude from MRU lists

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.dashboard.startify.skipList + + +
+
+

List of regex patterns to exclude from MRU lists

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.skipListServer

List of vim servers to not load startify for

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.dashboard.startify.skipListServer + + +
+
+

List of vim servers to not load startify for

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.unsafe

Turns on unsafe mode for Startify. Stops resolving links, checking files are readable and filtering bookmark list

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.dashboard.startify.unsafe + + +
+
+

Turns on unsafe mode for Startify. Stops resolving links, checking files are readable and filtering bookmark list

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.updateOldFiles

Set if you want startify to always update and not just when neovim closes

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.dashboard.startify.updateOldFiles + + +
+
+

Set if you want startify to always update and not just when neovim closes

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.dashboard.startify.useEnv

Show environment variables in path if name is shorter than value

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.dashboard.startify.useEnv + + +
+
+

Show environment variables in path if name is shorter than value

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/dashboard/startify/startify.nix> -
vim.debugMode.enable

Whether to enable debug mode.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.debugMode.enable + + +
+
+

Whether to enable debug mode.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.debugMode.level

Set the debug level

Type: -signed integer

Default: -20

Declared by:

+
+ +
+
+
+ + vim.debugMode.level + + +
+
+

Set the debug level

+ +

Type: +signed integer

+ +

Default: +20

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.debugMode.logFile

Set the log file

Type: -path

Default: -"/tmp/nvim.log"

Declared by:

+
+ +
+
+
+ + vim.debugMode.logFile + + +
+
+

Set the log file

+ +

Type: +path

+ +

Default: +"/tmp/nvim.log"

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.debugger.nvim-dap.enable

Whether to enable debugging via nvim-dap.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.debugger.nvim-dap.enable + + +
+
+

Whether to enable debugging via nvim-dap.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/debugger/nvim-dap/nvim-dap.nix> -
vim.debugger.nvim-dap.mappings.continue

Contiue

Type: -null or string

Default: -"<leader>dc"

Declared by:

+
+ +
+
+
+ + vim.debugger.nvim-dap.mappings.continue + + +
+
+

Contiue

+ +

Type: +null or string

+ +

Default: +"<leader>dc"

+ +

Declared by:

+ +
+ <neovim-flake/modules/debugger/nvim-dap/nvim-dap.nix> -
vim.debugger.nvim-dap.mappings.goDown

Go down stacktrace

Type: -null or string

Default: -"<leader>dvi"

Declared by:

+
+ +
+
+
+ + vim.debugger.nvim-dap.mappings.goDown + + +
+
+

Go down stacktrace

+ +

Type: +null or string

+ +

Default: +"<leader>dvi"

+ +

Declared by:

+ +
+ <neovim-flake/modules/debugger/nvim-dap/nvim-dap.nix> -
vim.debugger.nvim-dap.mappings.goUp

Go up stacktrace

Type: -null or string

Default: -"<leader>dvo"

Declared by:

+
+ +
+
+
+ + vim.debugger.nvim-dap.mappings.goUp + + +
+
+

Go up stacktrace

+ +

Type: +null or string

+ +

Default: +"<leader>dvo"

+ +

Declared by:

+ +
+ <neovim-flake/modules/debugger/nvim-dap/nvim-dap.nix> -
vim.debugger.nvim-dap.mappings.hover

Hover

Type: -null or string

Default: -"<leader>dh"

Declared by:

+
+ +
+
+
+ + vim.debugger.nvim-dap.mappings.hover + + +
+
+

Hover

+ +

Type: +null or string

+ +

Default: +"<leader>dh"

+ +

Declared by:

+ +
+ <neovim-flake/modules/debugger/nvim-dap/nvim-dap.nix> -
vim.debugger.nvim-dap.mappings.restart

Restart

Type: -null or string

Default: -"<leader>dR"

Declared by:

+
+ +
+
+
+ + vim.debugger.nvim-dap.mappings.restart + + +
+
+

Restart

+ +

Type: +null or string

+ +

Default: +"<leader>dR"

+ +

Declared by:

+ +
+ <neovim-flake/modules/debugger/nvim-dap/nvim-dap.nix> -
vim.debugger.nvim-dap.mappings.runLast

Re-run Last Debug Session

Type: -null or string

Default: -"<leader>d."

Declared by:

+
+ +
+
+
+ + vim.debugger.nvim-dap.mappings.runLast + + +
+
+

Re-run Last Debug Session

+ +

Type: +null or string

+ +

Default: +"<leader>d."

+ +

Declared by:

+ +
+ <neovim-flake/modules/debugger/nvim-dap/nvim-dap.nix> -
vim.debugger.nvim-dap.mappings.runToCursor

Continue to the current cursor

Type: -null or string

Default: -"<leader>dgc"

Declared by:

+
+ +
+
+
+ + vim.debugger.nvim-dap.mappings.runToCursor + + +
+
+

Continue to the current cursor

+ +

Type: +null or string

+ +

Default: +"<leader>dgc"

+ +

Declared by:

+ +
+ <neovim-flake/modules/debugger/nvim-dap/nvim-dap.nix> -
vim.debugger.nvim-dap.mappings.stepBack

Step back

Type: -null or string

Default: -"<leader>dgk"

Declared by:

+
+ +
+
+
+ + vim.debugger.nvim-dap.mappings.stepBack + + +
+
+

Step back

+ +

Type: +null or string

+ +

Default: +"<leader>dgk"

+ +

Declared by:

+ +
+ <neovim-flake/modules/debugger/nvim-dap/nvim-dap.nix> -
vim.debugger.nvim-dap.mappings.stepInto

Step into function

Type: -null or string

Default: -"<leader>dgi"

Declared by:

+
+ +
+
+
+ + vim.debugger.nvim-dap.mappings.stepInto + + +
+
+

Step into function

+ +

Type: +null or string

+ +

Default: +"<leader>dgi"

+ +

Declared by:

+ +
+ <neovim-flake/modules/debugger/nvim-dap/nvim-dap.nix> -
vim.debugger.nvim-dap.mappings.stepOut

Step out of function

Type: -null or string

Default: -"<leader>dgo"

Declared by:

+
+ +
+
+
+ + vim.debugger.nvim-dap.mappings.stepOut + + +
+
+

Step out of function

+ +

Type: +null or string

+ +

Default: +"<leader>dgo"

+ +

Declared by:

+ +
+ <neovim-flake/modules/debugger/nvim-dap/nvim-dap.nix> -
vim.debugger.nvim-dap.mappings.stepOver

Next step

Type: -null or string

Default: -"<leader>dgj"

Declared by:

+
+ +
+
+
+ + vim.debugger.nvim-dap.mappings.stepOver + + +
+
+

Next step

+ +

Type: +null or string

+ +

Default: +"<leader>dgj"

+ +

Declared by:

+ +
+ <neovim-flake/modules/debugger/nvim-dap/nvim-dap.nix> -
vim.debugger.nvim-dap.mappings.terminate

Terminate

Type: -null or string

Default: -"<leader>dq"

Declared by:

+
+ +
+
+
+ + vim.debugger.nvim-dap.mappings.terminate + + +
+
+

Terminate

+ +

Type: +null or string

+ +

Default: +"<leader>dq"

+ +

Declared by:

+ +
+ <neovim-flake/modules/debugger/nvim-dap/nvim-dap.nix> -
vim.debugger.nvim-dap.mappings.toggleBreakpoint

Toggle breakpoint

Type: -null or string

Default: -"<leader>db"

Declared by:

+
+ +
+
+
+ + vim.debugger.nvim-dap.mappings.toggleBreakpoint + + +
+
+

Toggle breakpoint

+ +

Type: +null or string

+ +

Default: +"<leader>db"

+ +

Declared by:

+ +
+ <neovim-flake/modules/debugger/nvim-dap/nvim-dap.nix> -
vim.debugger.nvim-dap.mappings.toggleDapUI

Toggle DAP-UI

Type: -null or string

Default: -"<leader>du"

Declared by:

+
+ +
+
+
+ + vim.debugger.nvim-dap.mappings.toggleDapUI + + +
+
+

Toggle DAP-UI

+ +

Type: +null or string

+ +

Default: +"<leader>du"

+ +

Declared by:

+ +
+ <neovim-flake/modules/debugger/nvim-dap/nvim-dap.nix> -
vim.debugger.nvim-dap.mappings.toggleRepl

Toggle Repl

Type: -null or string

Default: -"<leader>dr"

Declared by:

+
+ +
+
+
+ + vim.debugger.nvim-dap.mappings.toggleRepl + + +
+
+

Toggle Repl

+ +

Type: +null or string

+ +

Default: +"<leader>dr"

+ +

Declared by:

+ +
+ <neovim-flake/modules/debugger/nvim-dap/nvim-dap.nix> -
vim.debugger.nvim-dap.sources

List of debuggers to install

Type: -attribute set of string

Default: -{ }

Declared by:

+
+ +
+
+
+ + vim.debugger.nvim-dap.sources + + +
+
+

List of debuggers to install

+ +

Type: +attribute set of string

+ +

Default: +{ }

+ +

Declared by:

+ +
+ <neovim-flake/modules/debugger/nvim-dap/nvim-dap.nix> -
vim.debugger.nvim-dap.ui.enable

Whether to enable UI extension for nvim-dap.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.debugger.nvim-dap.ui.enable + + +
+
+

Whether to enable UI extension for nvim-dap.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/debugger/nvim-dap/nvim-dap.nix> -
vim.debugger.nvim-dap.ui.autoStart

Automatically Opens and Closes DAP-UI upon starting/closing a debugging session

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.debugger.nvim-dap.ui.autoStart + + +
+
+

Automatically Opens and Closes DAP-UI upon starting/closing a debugging session

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/debugger/nvim-dap/nvim-dap.nix> -
vim.disableArrows

Set to prevent arrow keys from moving cursor

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.disableArrows + + +
+
+

Set to prevent arrow keys from moving cursor

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.extraPlugins

List of plugins and related config. -Note that these are setup after builtin plugins.

Type: -attribute set of (submodule)

Default: -{ }

Example:

  with pkgs.vimPlugins; {
+
+
+
+
+ + vim.extraPlugins + + +
+
+

List of plugins and related config. +Note that these are setup after builtin plugins.

+ +

Type: +attribute set of (submodule)

+ +

Default: +{ }

+ +

Example:

  with pkgs.vimPlugins; {
   aerial = {
     package = aerial-nvim;
-    setup = "require('aerial').setup {}";
+    setup = "require('aerial').setup {}";
   };
   harpoon = {
     package = harpoon;
-    setup = "require('harpoon').setup {}";
-    after = ["aerial"];
+    setup = "require('harpoon').setup {}";
+    after = ["aerial"];
   };
 }
-

Declared by:

-<neovim-flake/modules/core> -
vim.extraPlugins.<name>.package

Plugin Package.

Type: -null or package or one of “nvim-treesitter-context”, “gitsigns-nvim”, “plenary-nvim”, “nvim-lspconfig”, “nvim-treesitter”, “lspsaga”, “lspkind”, “nvim-lightbulb”, “lsp-signature”, “nvim-tree-lua”, “nvim-bufferline-lua”, “lualine”, “nvim-compe”, “nvim-autopairs”, “nvim-ts-autotag”, “nvim-web-devicons”, “tokyonight”, “bufdelete-nvim”, “nvim-cmp”, “cmp-nvim-lsp”, “cmp-buffer”, “cmp-vsnip”, “cmp-path”, “cmp-treesitter”, “crates-nvim”, “vim-vsnip”, “nvim-code-action-menu”, “trouble”, “none-ls”, “which-key”, “indent-blankline”, “nvim-cursorline”, “sqls-nvim”, “glow-nvim”, “telescope”, “rust-tools”, “onedark”, “catppuccin”, “dracula”, “oxocarbon”, “minimap-vim”, “dashboard-nvim”, “alpha-nvim”, “scrollbar-nvim”, “codewindow-nvim”, “nvim-notify”, “cinnamon-nvim”, “cheatsheet-nvim”, “ccc”, “cellular-automaton”, “presence-nvim”, “icon-picker-nvim”, “dressing-nvim”, “orgmode-nvim”, “obsidian-nvim”, “vim-markdown”, “tabular”, “toggleterm-nvim”, “noice-nvim”, “nui-nvim”, “copilot-lua”, “tabnine-nvim”, “nvim-session-manager”, “gesture-nvim”, “comment-nvim”, “kommentary”, “mind-nvim”, “fidget-nvim”, “diffview-nvim”, “todo-comments”, “flutter-tools”, “flutter-tools-patched”, “hop-nvim”, “leap-nvim”, “modes-nvim”, “vim-repeat”, “smartcolumn”, “project-nvim”, “neodev-nvim”, “elixir-ls”, “elixir-tools”, “nvim-colorizer-lua”, “vim-illuminate”, “nvim-surround”, “nvim-dap”, “nvim-dap-ui”, “nvim-navic”, “nvim-navbuddy”, “copilot-cmp”, “lsp-lines”, “vim-dirtytalk”, “highlight-undo”, “nvim-docs-view”

Declared by:

-<neovim-flake/modules/core> -
vim.extraPlugins.<name>.after

Setup this plugin after the following ones.

Type: -list of string

Default: -[ ]

Declared by:

-<neovim-flake/modules/core> -
vim.extraPlugins.<name>.setup

Lua code to run during setup.

Type: -strings concatenated with “\n”

Default: -""

Example: -"require('aerial').setup {}"

Declared by:

-<neovim-flake/modules/core> -
vim.filetree.nvimTree.enable

Whether to enable filetree via nvim-tree.lua.

Type: -boolean

Default: -false

Example: -true

Declared by:

-<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.actions

Configuration for various actions.

Type: -submodule

Default: -{ }

Declared by:

-<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.actions.changeDir

vim change-directory behaviour

Type: -submodule

Default: -{ }

Declared by:

-<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.actions.changeDir.enable

Change the working directory when changing directories in the tree.

Type: -boolean

Default: -true

Declared by:

-<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.actions.changeDir.global

Use :cd instead of :lcd when changing directories. -Consider that this might cause issues with the nvimTree.syncRootWithCwd option.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.actions.changeDir.restrictAboveCwd

Restrict changing to a directory above the global current working directory.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.actions.expandAll

Configuration for expand_all behaviour.

Type: -submodule

Default: -{ }

Declared by:

-<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.actions.expandAll.exclude

A list of directories that should not be expanded automatically.

Type: -list of string

Default:

[
-  ".git"
-  "target"
-  "build"
-  "result"
-]
-

Declared by:

-<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.actions.expandAll.maxFolderDiscovery

Limit the number of folders being explored when expanding every folders. -Avoids hanging neovim when running this action on very large folders.

Type: -signed integer

Default: -300

Declared by:

-<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.actions.filePopup

Configuration for file_popup behaviour.

Type: -submodule

Default: -{ }

Declared by:

-<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.actions.filePopup.openWinConfig

Floating window config for file_popup. See |nvim_open_win| for more details.

Type: -attribute set

Default:

{
-  border = "rounded";
-  col = 1;
-  relative = "cursor";
-  row = 1;
-  style = "minimal";
-}
-

Declared by:

-<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.actions.openFile

Configuration options for opening a file from nvim-tree.

Type: -submodule

Default: -{ }

Declared by:

-<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.actions.openFile.eject

Prevent new opened file from opening in the same window as the tree.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.actions.openFile.quitOnOpen

Closes the explorer when opening a file.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.actions.openFile.resizeWindow

Resizes the tree when opening a file. Previously view.auto_resize

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.actions.openFile.windowPicker

window_picker

Type: -submodule

Default: -{ }

Declared by:

-<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.actions.openFile.windowPicker.enable

Enable the window picker. If this feature is not enabled, files will open in window from which you last opened the tree.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.actions.openFile.windowPicker.chars

A string of chars used as identifiers by the window picker.

Type: -string

Default: -"ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890"

Declared by:

-<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.actions.openFile.windowPicker.exclude.buftype

A list of buftypes to exclude from the window picker.

Type: -list of string

Default:

[
-  "nofile"
-  "terminal"
-  "help"
-]
-

Declared by:

-<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.actions.openFile.windowPicker.exclude.filetype

A list of filetypes to exclude from the window picker.

Type: -list of string

Default:

[
-  "notify"
-  "packer"
-  "qf"
-  "diff"
-  "fugitive"
-  "fugitiveblame"
-]
-

Declared by:

-<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.actions.openFile.windowPicker.picker

Change the default window picker, can be a string "default" or a function. -The function should return the window id that will open the node, -or nil if an invalid window is picked or user cancelled the action.

The picker may create a new window.

Type: -string

Default: -"default"

Example:

-- with s1n7ax/nvim-window-picker plugin
-require('window-picker').pick_window,
+
-

Declared by:

+
+

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+ +
+ + vim.extraPlugins.<name>.package + + +
+
+

Plugin Package.

+ +

Type: +null or package or one of “nvim-treesitter-context”, “gitsigns-nvim”, “plenary-nvim”, “nvim-lspconfig”, “nvim-treesitter”, “lspsaga”, “lspkind”, “nvim-lightbulb”, “lsp-signature”, “nvim-tree-lua”, “nvim-bufferline-lua”, “lualine”, “nvim-compe”, “nvim-autopairs”, “nvim-ts-autotag”, “nvim-web-devicons”, “tokyonight”, “bufdelete-nvim”, “nvim-cmp”, “cmp-nvim-lsp”, “cmp-buffer”, “cmp-vsnip”, “cmp-path”, “cmp-treesitter”, “crates-nvim”, “vim-vsnip”, “nvim-code-action-menu”, “trouble”, “none-ls”, “which-key”, “indent-blankline”, “nvim-cursorline”, “sqls-nvim”, “glow-nvim”, “telescope”, “rust-tools”, “onedark”, “catppuccin”, “dracula”, “oxocarbon”, “minimap-vim”, “dashboard-nvim”, “alpha-nvim”, “scrollbar-nvim”, “codewindow-nvim”, “nvim-notify”, “cinnamon-nvim”, “cheatsheet-nvim”, “ccc”, “cellular-automaton”, “presence-nvim”, “icon-picker-nvim”, “dressing-nvim”, “orgmode-nvim”, “obsidian-nvim”, “vim-markdown”, “tabular”, “toggleterm-nvim”, “noice-nvim”, “nui-nvim”, “copilot-lua”, “tabnine-nvim”, “nvim-session-manager”, “gesture-nvim”, “comment-nvim”, “kommentary”, “mind-nvim”, “fidget-nvim”, “diffview-nvim”, “todo-comments”, “flutter-tools”, “flutter-tools-patched”, “hop-nvim”, “leap-nvim”, “modes-nvim”, “vim-repeat”, “smartcolumn”, “project-nvim”, “neodev-nvim”, “elixir-ls”, “elixir-tools”, “nvim-colorizer-lua”, “vim-illuminate”, “nvim-surround”, “nvim-dap”, “nvim-dap-ui”, “nvim-navic”, “nvim-navbuddy”, “copilot-cmp”, “lsp-lines”, “vim-dirtytalk”, “highlight-undo”, “nvim-docs-view”

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.extraPlugins.<name>.after + + +
+
+

Setup this plugin after the following ones.

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.extraPlugins.<name>.setup + + +
+
+

Lua code to run during setup.

+ +

Type: +strings concatenated with “\n”

+ +

Default: +""

+ +

Example: +"require('aerial').setup {}"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.filetree.nvimTree.enable + + +
+
+

Whether to enable filetree via nvim-tree.lua.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.actions.removeFile.closeWindow

Close any window displaying a file when removing the file from the tree

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.actions + + +
+
+

Configuration for various actions.

+ +

Type: +submodule

+ +

Default: +{ }

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.actions.useSystemClipboard

A boolean value that toggle the use of system clipboard when copy/paste + +

+
+
+ + vim.filetree.nvimTree.actions.changeDir + + +
+
+

vim change-directory behaviour

+ +

Type: +submodule

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> + +
+
+
+ + vim.filetree.nvimTree.actions.changeDir.enable + + +
+
+

Change the working directory when changing directories in the tree.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> + +
+
+
+ + vim.filetree.nvimTree.actions.changeDir.global + + +
+
+

Use :cd instead of :lcd when changing directories. +Consider that this might cause issues with the nvimTree.syncRootWithCwd option.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> + +
+
+
+ + vim.filetree.nvimTree.actions.changeDir.restrictAboveCwd + + +
+
+

Restrict changing to a directory above the global current working directory.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> + +
+
+
+ + vim.filetree.nvimTree.actions.expandAll + + +
+
+

Configuration for expand_all behaviour.

+ +

Type: +submodule

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> + +
+
+
+ + vim.filetree.nvimTree.actions.expandAll.exclude + + +
+
+

A list of directories that should not be expanded automatically.

+ +

Type: +list of string

+ +

Default:

[
+  ".git"
+  "target"
+  "build"
+  "result"
+]
+
+ +

Declared by:

+ + +
+ +<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> + +
+
+
+ + vim.filetree.nvimTree.actions.expandAll.maxFolderDiscovery + + +
+
+

Limit the number of folders being explored when expanding every folders. +Avoids hanging neovim when running this action on very large folders.

+ +

Type: +signed integer

+ +

Default: +300

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> + +
+
+
+ + vim.filetree.nvimTree.actions.filePopup + + +
+
+

Configuration for file_popup behaviour.

+ +

Type: +submodule

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> + +
+
+
+ + vim.filetree.nvimTree.actions.filePopup.openWinConfig + + +
+
+

Floating window config for file_popup. See |nvim_open_win| for more details.

+ +

Type: +attribute set

+ +

Default:

{
+  border = "rounded";
+  col = 1;
+  relative = "cursor";
+  row = 1;
+  style = "minimal";
+}
+
+ +

Declared by:

+ + +
+ +<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> + +
+
+
+ + vim.filetree.nvimTree.actions.openFile + + +
+
+

Configuration options for opening a file from nvim-tree.

+ +

Type: +submodule

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> + +
+
+
+ + vim.filetree.nvimTree.actions.openFile.eject + + +
+
+

Prevent new opened file from opening in the same window as the tree.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> + +
+
+
+ + vim.filetree.nvimTree.actions.openFile.quitOnOpen + + +
+
+

Closes the explorer when opening a file.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> + +
+
+
+ + vim.filetree.nvimTree.actions.openFile.resizeWindow + + +
+
+

Resizes the tree when opening a file. Previously view.auto_resize

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> + +
+
+
+ + vim.filetree.nvimTree.actions.openFile.windowPicker + + +
+
+

window_picker

+ +

Type: +submodule

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> + +
+
+
+ + vim.filetree.nvimTree.actions.openFile.windowPicker.enable + + +
+
+

Enable the window picker. If this feature is not enabled, files will open in window from which you last opened the tree.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> + +
+
+
+ + vim.filetree.nvimTree.actions.openFile.windowPicker.chars + + +
+
+

A string of chars used as identifiers by the window picker.

+ +

Type: +string

+ +

Default: +"ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> + +
+
+
+ + vim.filetree.nvimTree.actions.openFile.windowPicker.exclude.buftype + + +
+
+

A list of buftypes to exclude from the window picker.

+ +

Type: +list of string

+ +

Default:

[
+  "nofile"
+  "terminal"
+  "help"
+]
+
+ +

Declared by:

+ + +
+ +<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> + +
+
+
+ + vim.filetree.nvimTree.actions.openFile.windowPicker.exclude.filetype + + +
+
+

A list of filetypes to exclude from the window picker.

+ +

Type: +list of string

+ +

Default:

[
+  "notify"
+  "packer"
+  "qf"
+  "diff"
+  "fugitive"
+  "fugitiveblame"
+]
+
+ +

Declared by:

+ + +
+ +<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> + +
+
+
+ + vim.filetree.nvimTree.actions.openFile.windowPicker.picker + + +
+
+

Change the default window picker, can be a string "default" or a function. +The function should return the window id that will open the node, +or nil if an invalid window is picked or user cancelled the action.

The picker may create a new window.

+ +

Type: +string

+ +

Default: +"default"

+ +

Example:

-- with s1n7ax/nvim-window-picker plugin
+require('window-picker').pick_window,
+
+
+ +

Declared by:

+ + +
+ +<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> + +
+
+
+ + vim.filetree.nvimTree.actions.removeFile.closeWindow + + +
+
+

Close any window displaying a file when removing the file from the tree

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/filetree/nvimtree/nvimtree.nix> + +
+
+
+ + vim.filetree.nvimTree.actions.useSystemClipboard + + +
+
+

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 ‘"’.

Type: -boolean

Default: -true

Declared by:

+
+‘+’ (system), otherwise, it will be stored in ‘1’ and ‘"’.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.autoreloadOnWrite

Auto reload tree on write

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.autoreloadOnWrite + + +
+
+

Auto reload tree on write

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.diagnostics

Show LSP and COC diagnostics in the signcolumn -Note that the modified sign will take precedence over the diagnostics signs.

Type: -submodule

Default: -{ }

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.diagnostics + + +
+
+

Show LSP and COC diagnostics in the signcolumn +Note that the modified sign will take precedence over the diagnostics signs.

+ +

Type: +submodule

+ +

Default: +{ }

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.diagnostics.enable

Whether to enable diagnostics view in the signcolumn…

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.diagnostics.enable + + +
+
+

Whether to enable diagnostics view in the signcolumn…

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.diagnostics.debounceDelay

Idle milliseconds between diagnostic event and update.

Type: -signed integer

Default: -50

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.diagnostics.debounceDelay + + +
+
+

Idle milliseconds between diagnostic event and update.

+ +

Type: +signed integer

+ +

Default: +50

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.diagnostics.icons

Icons for diagnostic severity.

Type: -submodule

Default: -{ }

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.diagnostics.icons + + +
+
+

Icons for diagnostic severity.

+ +

Type: +submodule

+ +

Default: +{ }

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.diagnostics.icons.error

Icon used for error diagnostic.

Type: -string

Default: -""

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.diagnostics.icons.error + + +
+
+

Icon used for error diagnostic.

+ +

Type: +string

+ +

Default: +""

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.diagnostics.icons.hint

Icon used for hint diagnostic.

Type: -string

Default: -""

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.diagnostics.icons.hint + + +
+
+

Icon used for hint diagnostic.

+ +

Type: +string

+ +

Default: +""

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.diagnostics.icons.info

Icon used for info diagnostic.

Type: -string

Default: -""

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.diagnostics.icons.info + + +
+
+

Icon used for info diagnostic.

+ +

Type: +string

+ +

Default: +""

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.diagnostics.icons.warning

Icon used for warning diagnostic.

Type: -string

Default: -""

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.diagnostics.icons.warning + + +
+
+

Icon used for warning diagnostic.

+ +

Type: +string

+ +

Default: +""

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.diagnostics.severity

Severity for which the diagnostics will be displayed. See :help diagnostic-severity

Type: -submodule

Default: -{ }

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.diagnostics.severity + + +
+
+

Severity for which the diagnostics will be displayed. See :help diagnostic-severity

+ +

Type: +submodule

+ +

Default: +{ }

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.diagnostics.severity.max

Maximum severity.

Type: -one of “HINT”, “INFO”, “WARNING”, “ERROR”

Default: -"ERROR"

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.diagnostics.severity.max + + +
+
+

Maximum severity.

+ +

Type: +one of “HINT”, “INFO”, “WARNING”, “ERROR”

+ +

Default: +"ERROR"

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.diagnostics.severity.min

Minimum severity.

Type: -one of “HINT”, “INFO”, “WARNING”, “ERROR”

Default: -"HINT"

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.diagnostics.severity.min + + +
+
+

Minimum severity.

+ +

Type: +one of “HINT”, “INFO”, “WARNING”, “ERROR”

+ +

Default: +"HINT"

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.diagnostics.showOnDirs

Show diagnostic icons on parent directories.

Type: -unspecified value

Default: -false

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.diagnostics.showOnDirs + + +
+
+

Show diagnostic icons on parent directories.

+ +

Type: +unspecified value

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.diagnostics.showOnOpenDirs

Show diagnostics icons on directories that are open. -Only relevant when diagnostics.show_on_dirs is true.

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.diagnostics.showOnOpenDirs + + +
+
+

Show diagnostics icons on directories that are open. +Only relevant when diagnostics.show_on_dirs is true.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.disableNetrw

Disables netrw and replaces it with tree

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.disableNetrw + + +
+
+

Disables netrw and replaces it with tree

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.filesystemWatchers

Will use file system watcher (libuv fs_event) to watch the filesystem for changes. + +

+
+
+ + vim.filetree.nvimTree.filesystemWatchers + + +
+
+

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.

Type: -submodule

Default: -{ }

Declared by:

+
+performance.

+ +

Type: +submodule

+ +

Default: +{ }

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.filesystemWatchers.enable

Enable filesystem watchers.

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.filesystemWatchers.enable + + +
+
+

Enable filesystem watchers.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.filesystemWatchers.debounceDelay

Idle milliseconds between filesystem change and action.

Type: -signed integer

Default: -50

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.filesystemWatchers.debounceDelay + + +
+
+

Idle milliseconds between filesystem change and action.

+ +

Type: +signed integer

+ +

Default: +50

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.filesystemWatchers.ignoreDirs

List of vim regex for absolute directory paths that will not be watched. -Backslashes must be escaped e.g. "my-project/\\.build$". -Useful when path is not in .gitignore or git integration is disabled.

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.filesystemWatchers.ignoreDirs + + +
+
+

List of vim regex for absolute directory paths that will not be watched. +Backslashes must be escaped e.g. "my-project/\\.build$". +Useful when path is not in .gitignore or git integration is disabled.

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.filters

Filtering options.

Type: -submodule

Default:

{
+
+
+
+
+ + vim.filetree.nvimTree.filters + + +
+
+

Filtering options.

+ +

Type: +submodule

+ +

Default:

{
   dotfiles = false;
   exclude = [ ];
   gitClean = false;
   gitIgnored = false;
   noBuffer = false;
 }
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.filters.dotfiles

Do not show dotfiles: files starting with a .

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.filters.dotfiles + + +
+
+

Do not show dotfiles: files starting with a .

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.filters.exclude

List of directories or files to exclude from filtering: always show them.

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.filters.exclude + + +
+
+

List of directories or files to exclude from filtering: always show them.

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.filters.gitClean

Do not show files with no git status. This will show ignored files when -nvimTree.filters.gitIgnored is set, as they are effectively dirty.

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.filters.gitClean + + +
+
+

Do not show files with no git status. This will show ignored files when +nvimTree.filters.gitIgnored is set, as they are effectively dirty.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.filters.gitIgnored

Ignore files based on .gitignore. Requires git.enableto betrue`

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.filters.gitIgnored + + +
+
+

Ignore files based on .gitignore. Requires git.enableto betrue`

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.filters.noBuffer

Do not show files that have no buflisted() buffer.

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.filters.noBuffer + + +
+
+

Do not show files that have no buflisted() buffer.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.git.enable

Whether to enable Git integration with icons and colors…

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.git.enable + + +
+
+

Whether to enable Git integration with icons and colors…

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.git.disableForDirs

Disable git integration when git top-level matches these paths. -May be relative, evaluated via ":p"

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.git.disableForDirs + + +
+
+

Disable git integration when git top-level matches these paths. +May be relative, evaluated via ":p"

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.git.showOnDirs

Show git icons on parent directories.

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.git.showOnDirs + + +
+
+

Show git icons on parent directories.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.git.showOnOpenDirs

Show git icons on directories that are open.

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.git.showOnOpenDirs + + +
+
+

Show git icons on directories that are open.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.git.timeout

Kills the git process after some time if it takes too long. -Git integration will be disabled after 10 git jobs exceed this timeout.

Type: -signed integer

Default: -400

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.git.timeout + + +
+
+

Kills the git process after some time if it takes too long. +Git integration will be disabled after 10 git jobs exceed this timeout.

+ +

Type: +signed integer

+ +

Default: +400

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.hijackCursor

Hijack the cursor in the tree to put it at the start of the filename

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.hijackCursor + + +
+
+

Hijack the cursor in the tree to put it at the start of the filename

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.hijackDirectories

hijack new directory buffers when they are opened (:e dir).

Type: -submodule

Default:

{
+
+
+
+
+ + vim.filetree.nvimTree.hijackDirectories + + +
+
+

hijack new directory buffers when they are opened (:e dir).

+ +

Type: +submodule

+ +

Default:

{
   autoOpen = false;
   enable = true;
 }
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.hijackDirectories.enable

Enable the hijack_directories feature. Disable this option if you use vim-dirvish or dirbuf.nvim. -If hijack_netrw and disable_netrw are false, this feature will be disabled.

Type: -boolean

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.hijackDirectories.enable + + +
+
+

Enable the hijack_directories feature. Disable this option if you use vim-dirvish or dirbuf.nvim. +If hijack_netrw and disable_netrw are false, this feature will be disabled.

+ +

Type: +boolean

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.hijackDirectories.autoOpen

Opens the tree if the tree was previously closed.

Type: -boolean

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.hijackDirectories.autoOpen + + +
+
+

Opens the tree if the tree was previously closed.

+ +

Type: +boolean

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.hijackNetrw

Prevents netrw from automatically opening when opening directories

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.hijackNetrw + + +
+
+

Prevents netrw from automatically opening when opening directories

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.hijackUnnamedBufferWhenOpening

Open nvimtree in place of the unnamed buffer if it’s empty.

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.hijackUnnamedBufferWhenOpening + + +
+
+

Open nvimtree in place of the unnamed buffer if it’s empty.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.liveFilter

Configurations for the live_filtering feature. + +

+
+
+ + vim.filetree.nvimTree.liveFilter + + +
+
+

Configurations for the live_filtering feature. The live filter allows you to filter the tree nodes dynamically, based on regex matching (see vim.regex). This feature is bound to the f key by default. -The filter can be cleared with the F key by default.

Type: -submodule

Default: -{ }

Declared by:

+
+The filter can be cleared with the F key by default.

+ +

Type: +submodule

+ +

Default: +{ }

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.liveFilter.alwaysShowFolders

Whether to filter folders or not.

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.liveFilter.alwaysShowFolders + + +
+
+

Whether to filter folders or not.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.liveFilter.prefix

Prefix of the filter displayed in the buffer.

Type: -string

Default: -"[FILTER]: "

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.liveFilter.prefix + + +
+
+

Prefix of the filter displayed in the buffer.

+ +

Type: +string

+ +

Default: +"[FILTER]: "

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.mappings.findFile

Find file in NvimTree

Type: -null or string

Default: -"<leader>tg"

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.mappings.findFile + + +
+
+

Find file in NvimTree

+ +

Type: +null or string

+ +

Default: +"<leader>tg"

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.mappings.focus

Focus NvimTree

Type: -null or string

Default: -"<leader>tf"

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.mappings.focus + + +
+
+

Focus NvimTree

+ +

Type: +null or string

+ +

Default: +"<leader>tf"

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.mappings.refresh

Refresh NvimTree

Type: -null or string

Default: -"<leader>tr"

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.mappings.refresh + + +
+
+

Refresh NvimTree

+ +

Type: +null or string

+ +

Default: +"<leader>tr"

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.mappings.toggle

Toggle NvimTree

Type: -null or string

Default: -"<leader>t"

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.mappings.toggle + + +
+
+

Toggle NvimTree

+ +

Type: +null or string

+ +

Default: +"<leader>t"

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.modified

Indicate which file have unsaved modification.

Type: -submodule

Default: -{ }

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.modified + + +
+
+

Indicate which file have unsaved modification.

+ +

Type: +submodule

+ +

Default: +{ }

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.modified.enable

Whether to enable Modified files with icons and color highlight…

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.modified.enable + + +
+
+

Whether to enable Modified files with icons and color highlight…

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.modified.showOnDirs

Show modified icons on parent directories.

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.modified.showOnDirs + + +
+
+

Show modified icons on parent directories.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.modified.showOnOpenDirs

Show modified icons on directories that are open.

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.modified.showOnOpenDirs + + +
+
+

Show modified icons on directories that are open.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.notify

Configuration for notifications.

Type: -submodule

Default: -{ }

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.notify + + +
+
+

Configuration for notifications.

+ +

Type: +submodule

+ +

Default: +{ }

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.notify.absolutePath

Whether to use absolute paths or item names in fs action notifications.

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.notify.absolutePath + + +
+
+

Whether to use absolute paths or item names in fs action notifications.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.notify.threshold

Specify minimum notification level, uses the values from vim.log.levels

Type: -one of “ERROR”, “WARNING”, “INFO”, “DEBUG”

Default: -"INFO"

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.notify.threshold + + +
+
+

Specify minimum notification level, uses the values from vim.log.levels

+ +

Type: +one of “ERROR”, “WARNING”, “INFO”, “DEBUG”

+ +

Default: +"INFO"

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.openOnSetup

Open when vim is started on a directory

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.openOnSetup + + +
+
+

Open when vim is started on a directory

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.preferStartupRoot

Prefer startup root directory when updating root directory of the tree. -Only relevant when update_focused_file.update_root is true

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.preferStartupRoot + + +
+
+

Prefer startup root directory when updating root directory of the tree. +Only relevant when update_focused_file.update_root is true

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.reloadOnBufEnter

Automatically reloads the tree on BufEnter nvim-tree.

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.reloadOnBufEnter + + +
+
+

Automatically reloads the tree on BufEnter nvim-tree.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.addTrailing

Appends a trailing slash to folder names.

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.renderer.addTrailing + + +
+
+

Appends a trailing slash to folder names.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.fullName

Display node whose name length is wider than the width of nvim-tree window in floating window.

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.renderer.fullName + + +
+
+

Display node whose name length is wider than the width of nvim-tree window in floating window.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.groupEmpty

Compact folders that only contain a single folder into one node in the file tree.

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.renderer.groupEmpty + + +
+
+

Compact folders that only contain a single folder into one node in the file tree.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.highlightGit

Enable file highlight for git attributes using NvimTreeGit highlight groups. + +

+
+
+ + vim.filetree.nvimTree.renderer.highlightGit + + +
+
+

Enable file highlight for git attributes using NvimTreeGit highlight groups. Requires nvimTree.git.enable -This can be used with or without the icons.

Type: -boolean

Default: -false

Declared by:

+
+This can be used with or without the icons.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.highlightModified

Highlight modified files in the tree using NvimTreeNormal highlight group. -Requires nvimTree.view.highlightOpenedFiles

Type: -one of “none”, “icon”, “name”, “all”

Default: -"none"

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.renderer.highlightModified + + +
+
+

Highlight modified files in the tree using NvimTreeNormal highlight group. +Requires nvimTree.view.highlightOpenedFiles

+ +

Type: +one of “none”, “icon”, “name”, “all”

+ +

Default: +"none"

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.highlightOpenedFiles

Highlight icons and/or names for bufloaded() files using the -NvimTreeOpenedFile highlight group.

Type: -one of “none”, “icon”, “name”, “all”

Default: -"none"

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.renderer.highlightOpenedFiles + + +
+
+

Highlight icons and/or names for bufloaded() files using the +NvimTreeOpenedFile highlight group.

+ +

Type: +one of “none”, “icon”, “name”, “all”

+ +

Default: +"none"

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.icons

Configuration options for icons.

Type: -submodule

Default: -{ }

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.renderer.icons + + +
+
+

Configuration options for icons.

+ +

Type: +submodule

+ +

Default: +{ }

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.icons.gitPlacement

Place where the git icons will be rendered. signcolumn requires view.signcolumn to be enabled.

Type: -one of “before”, “after”, “signcolumn”

Default: -"before"

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.renderer.icons.gitPlacement + + +
+
+

Place where the git icons will be rendered. signcolumn requires view.signcolumn to be enabled.

+ +

Type: +one of “before”, “after”, “signcolumn”

+ +

Default: +"before"

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.icons.glyphs

Configuration options for icon glyphs. + +

+
+
+ + vim.filetree.nvimTree.renderer.icons.glyphs + + +
+
+

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.

Type: -submodule

Default: -{ }

Declared by:

+
+to appear in the signcolumn.

+ +

Type: +submodule

+ +

Default: +{ }

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.icons.glyphs.default

Glyph for files. Will be overridden by nvim-web-devicons if available.

Type: -string

Default: -""

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.renderer.icons.glyphs.default + + +
+
+

Glyph for files. Will be overridden by nvim-web-devicons if available.

+ +

Type: +string

+ +

Default: +""

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.icons.glyphs.folder

Glyphs for directories. Recommended to use the defaults unless you know what you are doing.

Type: -attribute set

Default:

{
-  arrowClosed = "";
-  arrowOpen = "";
-  default = "";
-  empty = "";
-  emptyOpen = "";
-  open = "";
-  symlink = "";
-  symlinkOpen = "";
+
+
+
+
+ + vim.filetree.nvimTree.renderer.icons.glyphs.folder + + +
+
+

Glyphs for directories. Recommended to use the defaults unless you know what you are doing.

+ +

Type: +attribute set

+ +

Default:

{
+  arrowClosed = "";
+  arrowOpen = "";
+  default = "";
+  empty = "";
+  emptyOpen = "";
+  open = "";
+  symlink = "";
+  symlinkOpen = "";
 }
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.icons.glyphs.git

Glyphs for git status.

Type: -attribute set

Default:

{
-  deleted = "";
-  ignored = "◌";
-  renamed = "➜";
-  staged = "✓";
-  unmerged = "";
-  unstaged = "✗";
-  untracked = "★";
+
+
+
+
+ + vim.filetree.nvimTree.renderer.icons.glyphs.git + + +
+
+

Glyphs for git status.

+ +

Type: +attribute set

+ +

Default:

{
+  deleted = "";
+  ignored = "◌";
+  renamed = "➜";
+  staged = "✓";
+  unmerged = "";
+  unstaged = "✗";
+  untracked = "★";
 }
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.icons.glyphs.modified

Icon to display for modified files.

Type: -string

Default: -""

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.renderer.icons.glyphs.modified + + +
+
+

Icon to display for modified files.

+ +

Type: +string

+ +

Default: +""

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.icons.glyphs.symlink

Glyph for symlinks.

Type: -string

Default: -""

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.renderer.icons.glyphs.symlink + + +
+
+

Glyph for symlinks.

+ +

Type: +string

+ +

Default: +""

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.icons.modifiedPlacement

Place where the modified icons will be rendered. signcolumn requires view.signcolumn to be enabled.

Type: -one of “before”, “after”, “signcolumn”

Default: -"after"

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.renderer.icons.modifiedPlacement + + +
+
+

Place where the modified icons will be rendered. signcolumn requires view.signcolumn to be enabled.

+ +

Type: +one of “before”, “after”, “signcolumn”

+ +

Default: +"after"

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.icons.padding

Inserted between icon and filename

Type: -string

Default: -" "

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.renderer.icons.padding + + +
+
+

Inserted between icon and filename

+ +

Type: +string

+ +

Default: +" "

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.icons.show.file

Show an icon before the file name. nvim-web-devicons will be used if available.

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.renderer.icons.show.file + + +
+
+

Show an icon before the file name. nvim-web-devicons will be used if available.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.icons.show.folder

Show an icon before the folder name.

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.renderer.icons.show.folder + + +
+
+

Show an icon before the folder name.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.icons.show.folderArrow

Show a small arrow before the folder node. Arrow will be a part of the -node when using renderer.indent_markers.

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.renderer.icons.show.folderArrow + + +
+
+

Show a small arrow before the folder node. Arrow will be a part of the +node when using renderer.indent_markers.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.icons.show.git

Show a git status icon, see renderer.icons.gitPlacement -Requires git.enable to be true.

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.renderer.icons.show.git + + +
+
+

Show a git status icon, see renderer.icons.gitPlacement +Requires git.enable to be true.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.icons.show.modified

Show a modified icon, see renderer.icons.modifiedPlacement -Requires modified.enable to be true.

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.renderer.icons.show.modified + + +
+
+

Show a modified icon, see renderer.icons.modifiedPlacement +Requires modified.enable to be true.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.icons.symlinkArrow

Used as a separator between symlinks’ source and target.

Type: -string

Default: -" ➛ "

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.renderer.icons.symlinkArrow + + +
+
+

Used as a separator between symlinks’ source and target.

+ +

Type: +string

+ +

Default: +" ➛ "

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.icons.webdevColors

Use the webdev icon colors, otherwise NvimTreeFileIcon

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.renderer.icons.webdevColors + + +
+
+

Use the webdev icon colors, otherwise NvimTreeFileIcon

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.indentMarkers

Configuration options for tree indent markers.

Type: -submodule

Default: -{ }

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.renderer.indentMarkers + + +
+
+

Configuration options for tree indent markers.

+ +

Type: +submodule

+ +

Default: +{ }

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.indentMarkers.enable

Whether to enable Display indent markers when folders are open…

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.renderer.indentMarkers.enable + + +
+
+

Whether to enable Display indent markers when folders are open…

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.indentMarkers.icons

Individual elements of the indent markers

Type: -attribute set

Default:

{
-  bottom = "─";
-  corner = "└";
-  edge = "│";
-  item = "│";
-  none = "";
+
+
+
+
+ + vim.filetree.nvimTree.renderer.indentMarkers.icons + + +
+
+

Individual elements of the indent markers

+ +

Type: +attribute set

+ +

Default:

{
+  bottom = "─";
+  corner = "└";
+  edge = "│";
+  item = "│";
+  none = "";
 }
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.indentMarkers.inlineArrows

Display folder arrows in the same column as indent marker when using renderer.icons.show.folder_arrow

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.renderer.indentMarkers.inlineArrows + + +
+
+

Display folder arrows in the same column as indent marker when using renderer.icons.show.folder_arrow

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.indentWidth

Number of spaces for an each tree nesting level. Minimum 1.

Type: -signed integer

Default: -2

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.renderer.indentWidth + + +
+
+

Number of spaces for an each tree nesting level. Minimum 1.

+ +

Type: +signed integer

+ +

Default: +2

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.rootFolderLabel

In what format to show root folder. See :help filename-modifiers for + +

+
+
+ + vim.filetree.nvimTree.renderer.rootFolderLabel + + +
+
+

In what format to show root folder. See :help filename-modifiers for available string options. Set to false to hide the root folder.

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

Type: -string or boolean

Default: -false

Example: -"\"\":~:s?$?/..?\""

Declared by:

+
+end

+ +

Type: +string or boolean

+ +

Default: +false

+ +

Example: +"\"\":~:s?$?/..?\""

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.specialFiles

A list of filenames that gets highlighted with `NvimTreeSpecialFile

Type: -list of string

Default:

[
-  "Cargo.toml"
-  "README.md"
-  "readme.md"
-  "Makefile"
-  "MAKEFILE"
-  "flake.nix"
+
+
+
+
+ + vim.filetree.nvimTree.renderer.specialFiles + + +
+
+

A list of filenames that gets highlighted with `NvimTreeSpecialFile

+ +

Type: +list of string

+ +

Default:

[
+  "Cargo.toml"
+  "README.md"
+  "readme.md"
+  "Makefile"
+  "MAKEFILE"
+  "flake.nix"
 ]
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.renderer.symlinkDestination

Whether to show the destination of the symlink.

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.renderer.symlinkDestination + + +
+
+

Whether to show the destination of the symlink.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.respectBufCwd

Will change cwd of nvim-tree to that of new buffer’s when opening nvim-tree.

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.respectBufCwd + + +
+
+

Will change cwd of nvim-tree to that of new buffer’s when opening nvim-tree.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.rootDirs

Preferred root directories. Only relevant when updateFocusedFile.updateRoot is true

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.rootDirs + + +
+
+

Preferred root directories. Only relevant when updateFocusedFile.updateRoot is true

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.selectPrompts

Whether to enable Use vim.ui.select style prompts. Necessary when using a UI prompt decorator such as dressing.nvim or telescope-ui-select.nvim -.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.selectPrompts + + +
+
+

Whether to enable Use vim.ui.select style prompts. Necessary when using a UI prompt decorator such as dressing.nvim or telescope-ui-select.nvim +.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.sort.foldersFirst

Sort folders before files. Has no effect when sort.sorter is a function.

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.sort.foldersFirst + + +
+
+

Sort folders before files. Has no effect when sort.sorter is a function.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.sort.sorter

How files within the same directory are sorted.

Type: -one of “name”, “extension”, “modification_time”, “case_sensitive”, “suffix”, “filetype”

Default: -"name"

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.sort.sorter + + +
+
+

How files within the same directory are sorted.

+ +

Type: +one of “name”, “extension”, “modification_time”, “case_sensitive”, “suffix”, “filetype”

+ +

Default: +"name"

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.syncRootWithCwd

Changes the tree root directory on DirChanged and refreshes the tree. -Only relevant when updateFocusedFile.updateRoot is true

(previously update_cwd)

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.syncRootWithCwd + + +
+
+

Changes the tree root directory on DirChanged and refreshes the tree. +Only relevant when updateFocusedFile.updateRoot is true

(previously update_cwd)

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.systemOpen.args

Optional argument list.

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.systemOpen.args + + +
+
+

Optional argument list.

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.systemOpen.cmd

The open command itself

Type: -string

Default: -"\${pkgs.xdg-utils}/bin/xdg-open"

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.systemOpen.cmd + + +
+
+

The open command itself

+ +

Type: +string

+ +

Default: +"\${pkgs.xdg-utils}/bin/xdg-open"

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.tab

Configuration for tab behaviour.

Type: -submodule

Default: -{ }

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.tab + + +
+
+

Configuration for tab behaviour.

+ +

Type: +submodule

+ +

Default: +{ }

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.tab.sync

Configuration for syncing nvim-tree across tabs.

Type: -submodule

Default: -{ }

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.tab.sync + + +
+
+

Configuration for syncing nvim-tree across tabs.

+ +

Type: +submodule

+ +

Default: +{ }

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.tab.sync.close

Closes the tree across all tabpages when the tree is closed.

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.tab.sync.close + + +
+
+

Closes the tree across all tabpages when the tree is closed.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.tab.sync.ignore

List of filetypes or buffer names on new tab that will prevent -nvimTree.tab.sync.open and nvimTree.tab.sync.close

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.tab.sync.ignore + + +
+
+

List of filetypes or buffer names on new tab that will prevent +nvimTree.tab.sync.open and nvimTree.tab.sync.close

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.tab.sync.open

Opens the tree automatically when switching tabpage or opening a new -tabpage if the tree was previously open.

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.tab.sync.open + + +
+
+

Opens the tree automatically when switching tabpage or opening a new +tabpage if the tree was previously open.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.trash

Configuration options for trashing.

Type: -submodule

Default:

{
-  cmd = "\${pkgs.glib}/bin/gio trash";
+
+
+
+
+ + vim.filetree.nvimTree.trash + + +
+
+

Configuration options for trashing.

+ +

Type: +submodule

+ +

Default:

{
+  cmd = "\${pkgs.glib}/bin/gio trash";
 }
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.trash.cmd

The command used to trash items

Type: -string

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.trash.cmd + + +
+
+

The command used to trash items

+ +

Type: +string

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.ui

General UI configuration.

Type: -submodule

Default: -{ }

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.ui + + +
+
+

General UI configuration.

+ +

Type: +submodule

+ +

Default: +{ }

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.ui.confirm.remove

Prompt before removing.

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.ui.confirm.remove + + +
+
+

Prompt before removing.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.ui.confirm.trash

Prompt before trash.

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.ui.confirm.trash + + +
+
+

Prompt before trash.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.updateFocusedFile

Update the focused file on BufEnter, un-collapses the folders recursively -until it finds the file.

Type: -submodule

Default: -{ }

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.updateFocusedFile + + +
+
+

Update the focused file on BufEnter, un-collapses the folders recursively +until it finds the file.

+ +

Type: +submodule

+ +

Default: +{ }

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.updateFocusedFile.enable

update focused file

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.updateFocusedFile.enable + + +
+
+

update focused file

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.updateFocusedFile.ignoreList

List of buffer names and filetypes that will not update the root dir + +

+
+
+ + vim.filetree.nvimTree.updateFocusedFile.ignoreList + + +
+
+

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 update_focused_file.update_root and -update_focused_file.enable are true.

Type: -list of string

Default: -[ ]

Declared by:

+
+update_focused_file.enable are true.

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.updateFocusedFile.updateRoot

Update the root directory of the tree if the file is not under current + +

+
+
+ + vim.filetree.nvimTree.updateFocusedFile.updateRoot + + +
+
+

Update the root directory of the tree if the file is not under current root directory. It prefers vim’s cwd and root_dirs. Otherwise it falls back to the folder containing the file. -Only relevant when update_focused_file.enable is true

Type: -boolean

Default: -false

Declared by:

+
+Only relevant when update_focused_file.enable is true

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.view

Window / buffer setup.

Type: -submodule

Default: -{ }

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.view + + +
+
+

Window / buffer setup.

+ +

Type: +submodule

+ +

Default: +{ }

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.view.centralizeSelection

If true, reposition the view so that the current node is initially centralized when entering nvim-tree.

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.view.centralizeSelection + + +
+
+

If true, reposition the view so that the current node is initially centralized when entering nvim-tree.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.view.cursorline

Enable cursorline in nvim-tree window.

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.view.cursorline + + +
+
+

Enable cursorline in nvim-tree window.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.view.debounceDelay

Idle milliseconds before some reload / refresh operations. -Increase if you experience performance issues around screen refresh.

Type: -signed integer

Default: -15

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.view.debounceDelay + + +
+
+

Idle milliseconds before some reload / refresh operations. +Increase if you experience performance issues around screen refresh.

+ +

Type: +signed integer

+ +

Default: +15

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.view.float

Configuration options for floating window.

Type: -submodule

Default: -{ }

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.view.float + + +
+
+

Configuration options for floating window.

+ +

Type: +submodule

+ +

Default: +{ }

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.view.float.enable

If true, tree window will be floating.

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.view.float.enable + + +
+
+

If true, tree window will be floating.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.view.float.openWinConfig

Floating window config. See :h nvim_open_win() for more details.

Type: -attribute set

Default:

{
-  border = "rounded";
+
+
+
+
+ + vim.filetree.nvimTree.view.float.openWinConfig + + +
+
+

Floating window config. See :h nvim_open_win() for more details.

+ +

Type: +attribute set

+ +

Default:

{
+  border = "rounded";
   col = 1;
   height = 30;
-  relative = "editor";
+  relative = "editor";
   row = 1;
   width = 30;
 }
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.view.float.quitOnFocusLoss

Close the floating tree window when it loses focus.

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.view.float.quitOnFocusLoss + + +
+
+

Close the floating tree window when it loses focus.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.view.number

Print the line number in front of each line.

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.view.number + + +
+
+

Print the line number in front of each line.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.view.preserveWindowProportions

Preserves window proportions when opening a file. -If false, the height and width of windows other than nvim-tree will be equalized.

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.view.preserveWindowProportions + + +
+
+

Preserves window proportions when opening a file. +If false, the height and width of windows other than nvim-tree will be equalized.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.view.relativenumber

Show the line number relative to the line with the cursor in front of each line. + +

+
+
+ + vim.filetree.nvimTree.view.relativenumber + + +
+
+

Show the line number relative to the line with the cursor in front of each line. If the option view.number is also true, the number on the cursor line -will be the line number instead of 0.

Type: -boolean

Default: -false

Declared by:

+
+will be the line number instead of 0.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.view.side

Side of the tree.

Type: -one of “left”, “right”

Default: -"left"

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.view.side + + +
+
+

Side of the tree.

+ +

Type: +one of “left”, “right”

+ +

Default: +"left"

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.view.signcolumn

Show diagnostic sign column. Value can be "yes", "auto" or"no".

Type: -one of “yes”, “auto”, “no”

Default: -"yes"

Declared by:

+
+ +
+
+
+ + vim.filetree.nvimTree.view.signcolumn + + +
+
+

Show diagnostic sign column. Value can be "yes", "auto" or"no".

+ +

Type: +one of “yes”, “auto”, “no”

+ +

Default: +"yes"

+ +

Declared by:

+ +
+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> -
vim.filetree.nvimTree.view.width

Width of the window: can be a % string, a number representing columns, a + +

+
+
+ + vim.filetree.nvimTree.view.width + + +
+
+

Width of the window: can be a % string, a number representing columns, a function or a table.

A table (an attribute set in our case, see example) indicates that the view should be dynamically sized based on the -longest line.

Type: -signed integer or (attribute set)

Default: -30

Example:

{
+longest line.

+
+
Type:
+signed integer or (attribute set)

+
+
Default:
+30

+
+
Example:
{
   min = 30;
   max = -1;
   padding = 1;
 }
 
-
Declared by:

+

+
+
+
Declared by:

+
+

+
 <neovim-flake/modules/filetree/nvimtree/nvimtree.nix>
-
vim.gestures.gesture-nvim.enable
Whether to enable gesture-nvim: mouse gestures.
Type:
-boolean
Default:
-false
Example:
-true
Declared by:

+

+
+

+

+

+ 
+ vim.gestures.gesture-nvim.enable
+  
+ 
+

+

+
Whether to enable gesture-nvim: mouse gestures.

+
+
Type:
+boolean

+
+
Default:
+false

+
+
Example:
+true

+
+
Declared by:

+
+

+
 <neovim-flake/modules/utility/gestures/gesture-nvim/gesture-nvim.nix>
-
vim.gestures.gesture-nvim.mappings.draw
Start drawing [gesture.nvim]
Type:
-null or string
Default:
-"<LeftDrag>"
Declared by:

+

+
+

+

+

+ 
+ vim.gestures.gesture-nvim.mappings.draw
+  
+ 
+

+

+
Start drawing [gesture.nvim]

+
+
Type:
+null or string

+
+
Default:
+"<LeftDrag>"

+
+
Declared by:

+
+

+
 <neovim-flake/modules/utility/gestures/gesture-nvim/gesture-nvim.nix>
-
vim.gestures.gesture-nvim.mappings.finish
Finish drawing [gesture.nvim]
Type:
-null or string
Default:
-"<LeftRelease>"
Declared by:

+

+
+

+

+

+ 
+ vim.gestures.gesture-nvim.mappings.finish
+  
+ 
+

+

+
Finish drawing [gesture.nvim]

+
+
Type:
+null or string

+
+
Default:
+"<LeftRelease>"

+
+
Declared by:

+
+

+
 <neovim-flake/modules/utility/gestures/gesture-nvim/gesture-nvim.nix>
-
vim.git.enable
Whether to enable git tools via gitsigns.
Type:
-boolean
Default:
-false
Example:
-true
Declared by:

+

+
+

+

+

+ 
+ vim.git.enable
+  
+ 
+

+

+
Whether to enable git tools via gitsigns.

+
+
Type:
+boolean

+
+
Default:
+false

+
+
Example:
+true

+
+
Declared by:

+
+

+
 <neovim-flake/modules/git/git.nix>
-
vim.git.gitsigns.enable
Whether to enable gitsigns.
Type:
-boolean
Default:
-false
Example:
-true
Declared by:

+

+
+

+

+

+ 
+ vim.git.gitsigns.enable
+  
+ 
+

+

+
Whether to enable gitsigns.

+
+
Type:
+boolean

+
+
Default:
+false

+
+
Example:
+true

+
+
Declared by:

+
+

+
 <neovim-flake/modules/git/git.nix>
-
vim.git.gitsigns.codeActions
Whether to enable gitsigns codeactions through null-ls.
Type:
-boolean
Default:
-false
Example:
-true
Declared by:

+

+
+

+

+

+ 
+ vim.git.gitsigns.codeActions
+  
+ 
+

+

+
Whether to enable gitsigns codeactions through null-ls.

+
+
Type:
+boolean

+
+
Default:
+false

+
+
Example:
+true

+
+
Declared by:

+
+

+
 <neovim-flake/modules/git/git.nix>
-
vim.git.gitsigns.mappings.blameLine
Blame line [Gitsigns]
Type:
-null or string
Default:
-"<leader>hb"
Declared by:

+

+
+

+

+

+ 
+ vim.git.gitsigns.mappings.blameLine
+  
+ 
+

+

+
Blame line [Gitsigns]

+
+
Type:
+null or string

+
+
Default:
+"<leader>hb"

+
+
Declared by:

+
+

+
 <neovim-flake/modules/git/git.nix>
-
vim.git.gitsigns.mappings.diffProject
Diff project [Gitsigns]
Type:
-null or string
Default:
-"<leader>hD"
Declared by:

+

+
+

+

+

+ 
+ vim.git.gitsigns.mappings.diffProject
+  
+ 
+

+

+
Diff project [Gitsigns]

+
+
Type:
+null or string

+
+
Default:
+"<leader>hD"

+
+
Declared by:

+
+

+
 <neovim-flake/modules/git/git.nix>
-
vim.git.gitsigns.mappings.diffThis
Diff this [Gitsigns]
Type:
-null or string
Default:
-"<leader>hd"
Declared by:

+

+
+

+

+

+ 
+ vim.git.gitsigns.mappings.diffThis
+  
+ 
+

+

+
Diff this [Gitsigns]

+
+
Type:
+null or string

+
+
Default:
+"<leader>hd"

+
+
Declared by:

+
+

+
 <neovim-flake/modules/git/git.nix>
-
vim.git.gitsigns.mappings.nextHunk
Next hunk [Gitsigns]
Type:
-null or string
Default:
-"]c"
Declared by:

+

+
+

+

+

+ 
+ vim.git.gitsigns.mappings.nextHunk
+  
+ 
+

+

+
Next hunk [Gitsigns]

+
+
Type:
+null or string

+
+
Default:
+"]c"

+
+
Declared by:

+
+

+
 <neovim-flake/modules/git/git.nix>
-
vim.git.gitsigns.mappings.previewHunk
Preview hunk [Gitsigns]
Type:
-null or string
Default:
-"<leader>hP"
Declared by:

+

+
+

+

+

+ 
+ vim.git.gitsigns.mappings.previewHunk
+  
+ 
+

+

+
Preview hunk [Gitsigns]

+
+
Type:
+null or string

+
+
Default:
+"<leader>hP"

+
+
Declared by:

+
+

+
 <neovim-flake/modules/git/git.nix>
-
vim.git.gitsigns.mappings.previousHunk
Previous hunk [Gitsigns]
Type:
-null or string
Default:
-"[c"
Declared by:

+

+
+

+

+

+ 
+ vim.git.gitsigns.mappings.previousHunk
+  
+ 
+

+

+
Previous hunk [Gitsigns]

+
+
Type:
+null or string

+
+
Default:
+"[c"

+
+
Declared by:

+
+

+
 <neovim-flake/modules/git/git.nix>
-
vim.git.gitsigns.mappings.resetBuffer
Reset buffer [Gitsigns]
Type:
-null or string
Default:
-"<leader>hR"
Declared by:

+

+
+

+

+

+ 
+ vim.git.gitsigns.mappings.resetBuffer
+  
+ 
+

+

+
Reset buffer [Gitsigns]

+
+
Type:
+null or string

+
+
Default:
+"<leader>hR"

+
+
Declared by:

+
+

+
 <neovim-flake/modules/git/git.nix>
-
vim.git.gitsigns.mappings.resetHunk
Reset hunk [Gitsigns]
Type:
-null or string
Default:
-"<leader>hr"
Declared by:

+

+
+

+

+

+ 
+ vim.git.gitsigns.mappings.resetHunk
+  
+ 
+

+

+
Reset hunk [Gitsigns]

+
+
Type:
+null or string

+
+
Default:
+"<leader>hr"

+
+
Declared by:

+
+

+
 <neovim-flake/modules/git/git.nix>
-
vim.git.gitsigns.mappings.stageBuffer
Stage buffer [Gitsigns]
Type:
-null or string
Default:
-"<leader>hS"
Declared by:

+

+
+

+

+

+ 
+ vim.git.gitsigns.mappings.stageBuffer
+  
+ 
+

+

+
Stage buffer [Gitsigns]

+
+
Type:
+null or string

+
+
Default:
+"<leader>hS"

+
+
Declared by:

+
+

+
 <neovim-flake/modules/git/git.nix>
-
vim.git.gitsigns.mappings.stageHunk
Stage hunk [Gitsigns]
Type:
-null or string
Default:
-"<leader>hs"
Declared by:

+

+
+

+

+

+ 
+ vim.git.gitsigns.mappings.stageHunk
+  
+ 
+

+

+
Stage hunk [Gitsigns]

+
+
Type:
+null or string

+
+
Default:
+"<leader>hs"

+
+
Declared by:

+
+

+
 <neovim-flake/modules/git/git.nix>
-
vim.git.gitsigns.mappings.toggleBlame
Toggle blame [Gitsigns]
Type:
-null or string
Default:
-"<leader>tb"
Declared by:

+

+
+

+

+

+ 
+ vim.git.gitsigns.mappings.toggleBlame
+  
+ 
+

+

+
Toggle blame [Gitsigns]

+
+
Type:
+null or string

+
+
Default:
+"<leader>tb"

+
+
Declared by:

+
+

+
 <neovim-flake/modules/git/git.nix>
-
vim.git.gitsigns.mappings.toggleDeleted
Toggle deleted [Gitsigns]
Type:
-null or string
Default:
-"<leader>td"
Declared by:

+

+
+

+

+

+ 
+ vim.git.gitsigns.mappings.toggleDeleted
+  
+ 
+

+

+
Toggle deleted [Gitsigns]

+
+
Type:
+null or string

+
+
Default:
+"<leader>td"

+
+
Declared by:

+
+

+
 <neovim-flake/modules/git/git.nix>
-
vim.git.gitsigns.mappings.undoStageHunk
Undo stage hunk [Gitsigns]
Type:
-null or string
Default:
-"<leader>hu"
Declared by:

+

+
+

+

+

+ 
+ vim.git.gitsigns.mappings.undoStageHunk
+  
+ 
+

+

+
Undo stage hunk [Gitsigns]

+
+
Type:
+null or string

+
+
Default:
+"<leader>hu"

+
+
Declared by:

+
+

+
 <neovim-flake/modules/git/git.nix>
-
vim.globals
Set containing global variable values
Type:
-attribute set
Default:
-{ }
Declared by:

+

+
+

+

+

+ 
+ vim.globals
+  
+ 
+

+

+
Set containing global variable values

+
+
Type:
+attribute set

+
+
Default:
+{ }

+
+
Declared by:

+
+

+
 <neovim-flake/modules/core>
-
vim.hideSearchHighlight
Hide search highlight so it doesn’t stay highlighted
Type:
-boolean
Default:
-false
Declared by:

+

+
+

+

+

+ 
+ vim.hideSearchHighlight
+  
+ 
+

+

+
Hide search highlight so it doesn’t stay highlighted

+
+
Type:
+boolean

+
+
Default:
+false

+
+
Declared by:

+
+

+
 <neovim-flake/modules/basic/module.nix>
-
vim.languages.enableDAP
Turn on Debug Adapter for enabled languages by default
Type:
-boolean
Default:
-false
Declared by:

+

+
+

+

+

+ 
+ vim.languages.enableDAP
+  
+ 
+

+

+
Turn on Debug Adapter for enabled languages by default

+
+
Type:
+boolean

+
+
Default:
+false

+
+
Declared by:

+
+

+
 <neovim-flake/modules/languages>
-
vim.languages.enableExtraDiagnostics
Turn on extra diagnostics for enabled languages by default
Type:
-boolean
Default:
-false
Declared by:

+

+
+

+

+

+ 
+ vim.languages.enableExtraDiagnostics
+  
+ 
+

+

+
Turn on extra diagnostics for enabled languages by default

+
+
Type:
+boolean

+
+
Default:
+false

+
+
Declared by:

+
+

+
 <neovim-flake/modules/languages>
-
vim.languages.enableFormat
Turn on Formatting for enabled languages by default
Type:
-boolean
Default:
-false
Declared by:

+

+
+

+

+

+ 
+ vim.languages.enableFormat
+  
+ 
+

+

+
Turn on Formatting for enabled languages by default

+
+
Type:
+boolean

+
+
Default:
+false

+
+
Declared by:

+
+

+
 <neovim-flake/modules/languages>
-
vim.languages.enableLSP
Turn on LSP for enabled languages by default
Type:
-boolean
Default:
-false
Declared by:

+

+
+

+

+

+ 
+ vim.languages.enableLSP
+  
+ 
+

+

+
Turn on LSP for enabled languages by default

+
+
Type:
+boolean

+
+
Default:
+false

+
+
Declared by:

+
+

+
 <neovim-flake/modules/languages>
-
vim.languages.enableTreesitter
Turn on Treesitter for enabled languages by default
Type:
-boolean
Default:
-false
Declared by:

+

+
+

+

+

+ 
+ vim.languages.enableTreesitter
+  
+ 
+

+

+
Turn on Treesitter for enabled languages by default

+
+
Type:
+boolean

+
+
Default:
+false

+
+
Declared by:

+
+

+
 <neovim-flake/modules/languages>
-
vim.languages.bash.enable
Whether to enable Bash language support.
Type:
-boolean
Default:
-false
Example:
-true
Declared by:

+

+
+

+

+

+ 
+ vim.languages.bash.enable
+  
+ 
+

+

+
Whether to enable Bash language support.

+
+
Type:
+boolean

+
+
Default:
+false

+
+
Example:
+true

+
+
Declared by:

+
+

+
 <neovim-flake/modules/languages/bash/bash.nix>
-
vim.languages.bash.extraDiagnostics.enable
Whether to enable extra Bash diagnostics.
Type:
-boolean
Default:
-false
Example:
-true
Declared by:

+

+
+

+

+

+ 
+ vim.languages.bash.extraDiagnostics.enable
+  
+ 
+

+

+
Whether to enable extra Bash diagnostics.

+
+
Type:
+boolean

+
+
Default:
+false

+
+
Example:
+true

+
+
Declared by:

+
+

+
 <neovim-flake/modules/languages/bash/bash.nix>
-
vim.languages.bash.extraDiagnostics.types
List of Bash diagnostics to enable
Type:
-list of (value “shellcheck” (singular enum) or (submodule))
Default:
[
-  "shellcheck"
+
+

+
+
+ + vim.languages.bash.extraDiagnostics.types + + +
+
+

List of Bash diagnostics to enable

+ +

Type: +list of (value “shellcheck” (singular enum) or (submodule))

+ +

Default:

[
+  "shellcheck"
 ]
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/languages/bash/bash.nix> -
vim.languages.bash.format.enable

Enable Bash formatting

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.languages.bash.format.enable + + +
+
+

Enable Bash formatting

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/bash/bash.nix> -
vim.languages.bash.format.package

Bash formatter package

Type: -package

Default: -<derivation shfmt-3.7.0>

Declared by:

+
+ +
+
+
+ + vim.languages.bash.format.package + + +
+
+

Bash formatter package

+ +

Type: +package

+ +

Default: +<derivation shfmt-3.7.0>

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/bash/bash.nix> -
vim.languages.bash.format.type

Bash formatter to use

Type: -value “shfmt” (singular enum)

Default: -"shfmt"

Declared by:

+
+ +
+
+
+ + vim.languages.bash.format.type + + +
+
+

Bash formatter to use

+ +

Type: +value “shfmt” (singular enum)

+ +

Default: +"shfmt"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/bash/bash.nix> -
vim.languages.bash.lsp.enable

Whether to enable Enable Bash LSP support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.bash.lsp.enable + + +
+
+

Whether to enable Enable Bash LSP support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/bash/bash.nix> -
vim.languages.bash.lsp.package

bash-language-server package, or the command to run as a list of strings

Type: -package or list of string

Default: -<derivation bash-language-server-5.0.0>

Example: -[lib.getExe pkgs.nodePackages.bash-language-server "start"]

Declared by:

+
+ +
+
+
+ + vim.languages.bash.lsp.package + + +
+
+

bash-language-server package, or the command to run as a list of strings

+ +

Type: +package or list of string

+ +

Default: +<derivation bash-language-server-5.0.0>

+ +

Example: +[lib.getExe pkgs.nodePackages.bash-language-server "start"]

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/bash/bash.nix> -
vim.languages.bash.lsp.server

Bash LSP server to use

Type: -value “bash-ls” (singular enum)

Default: -"bash-ls"

Declared by:

+
+ +
+
+
+ + vim.languages.bash.lsp.server + + +
+
+

Bash LSP server to use

+ +

Type: +value “bash-ls” (singular enum)

+ +

Default: +"bash-ls"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/bash/bash.nix> -
vim.languages.bash.treesitter.enable

Whether to enable Bash treesitter.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.bash.treesitter.enable + + +
+
+

Whether to enable Bash treesitter.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/bash/bash.nix> -
vim.languages.bash.treesitter.package

The bash treesitter package to use.

Type: -package

Default: -pkgs.vimPlugins.nvim-treesitter.builtGrammars.bash

Declared by:

+
+ +
+
+
+ + vim.languages.bash.treesitter.package + + +
+
+

The bash treesitter package to use.

+ +

Type: +package

+ +

Default: +pkgs.vimPlugins.nvim-treesitter.builtGrammars.bash

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/bash/bash.nix> -
vim.languages.clang.enable

Whether to enable C/C++ language support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.clang.enable + + +
+
+

Whether to enable C/C++ language support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/clang.nix> -
vim.languages.clang.cHeader

C syntax for headers. Can fix treesitter errors, see: -https://www.reddit.com/r/neovim/comments/orfpcd/question_does_the_c_parser_from_nvimtreesitter/

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.languages.clang.cHeader + + +
+
+

C syntax for headers. Can fix treesitter errors, see: +https://www.reddit.com/r/neovim/comments/orfpcd/question_does_the_c_parser_from_nvimtreesitter/

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/clang.nix> -
vim.languages.clang.dap.enable

Enable clang Debug Adapter

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.languages.clang.dap.enable + + +
+
+

Enable clang Debug Adapter

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/clang.nix> -
vim.languages.clang.dap.package

clang debugger package.

Type: -package

Default: -<derivation lldb-14.0.6>

Declared by:

+
+ +
+
+
+ + vim.languages.clang.dap.package + + +
+
+

clang debugger package.

+ +

Type: +package

+ +

Default: +<derivation lldb-14.0.6>

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/clang.nix> -
vim.languages.clang.dap.debugger

clang debugger to use

Type: -value “lldb-vscode” (singular enum)

Default: -"lldb-vscode"

Declared by:

+
+ +
+
+
+ + vim.languages.clang.dap.debugger + + +
+
+

clang debugger to use

+ +

Type: +value “lldb-vscode” (singular enum)

+ +

Default: +"lldb-vscode"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/clang.nix> -
vim.languages.clang.lsp.enable

Whether to enable clang LSP support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.clang.lsp.enable + + +
+
+

Whether to enable clang LSP support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/clang.nix> -
vim.languages.clang.lsp.package

clang LSP server package, or the command to run as a list of strings

Type: -package or list of string

Default: -<derivation ccls-0.20230717>

Example: -"[lib.getExe pkgs.jdt-language-server \" - data \" \" ~/.cache/jdtls/workspace \"]"

Declared by:

+
+ +
+
+
+ + vim.languages.clang.lsp.package + + +
+
+

clang LSP server package, or the command to run as a list of strings

+ +

Type: +package or list of string

+ +

Default: +<derivation ccls-0.20230717>

+ +

Example: +"[lib.getExe pkgs.jdt-language-server \" - data \" \" ~/.cache/jdtls/workspace \"]"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/clang.nix> -
vim.languages.clang.lsp.opts

Options to pass to clang LSP server

Type: -null or string

Default: -null

Declared by:

+
+ +
+
+
+ + vim.languages.clang.lsp.opts + + +
+
+

Options to pass to clang LSP server

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/clang.nix> -
vim.languages.clang.lsp.server

The clang LSP server to use

Type: -one of “ccls”, “clangd”

Default: -"ccls"

Declared by:

+
+ +
+
+
+ + vim.languages.clang.lsp.server + + +
+
+

The clang LSP server to use

+ +

Type: +one of “ccls”, “clangd”

+ +

Default: +"ccls"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/clang.nix> -
vim.languages.clang.treesitter.enable

Whether to enable C/C++ treesitter.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.clang.treesitter.enable + + +
+
+

Whether to enable C/C++ treesitter.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/clang.nix> -
vim.languages.clang.treesitter.cPackage

The c treesitter package to use.

Type: -package

Default: -pkgs.vimPlugins.nvim-treesitter.builtGrammars.c

Declared by:

+
+ +
+
+
+ + vim.languages.clang.treesitter.cPackage + + +
+
+

The c treesitter package to use.

+ +

Type: +package

+ +

Default: +pkgs.vimPlugins.nvim-treesitter.builtGrammars.c

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/clang.nix> -
vim.languages.clang.treesitter.cppPackage

The cpp treesitter package to use.

Type: -package

Default: -pkgs.vimPlugins.nvim-treesitter.builtGrammars.cpp

Declared by:

+
+ +
+
+
+ + vim.languages.clang.treesitter.cppPackage + + +
+
+

The cpp treesitter package to use.

+ +

Type: +package

+ +

Default: +pkgs.vimPlugins.nvim-treesitter.builtGrammars.cpp

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/clang.nix> -
vim.languages.dart.enable

Whether to enable Dart language support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.dart.enable + + +
+
+

Whether to enable Dart language support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/dart/dart.nix> -
vim.languages.dart.dap.enable

Enable Dart DAP support via flutter-tools

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.languages.dart.dap.enable + + +
+
+

Enable Dart DAP support via flutter-tools

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/dart/dart.nix> -
vim.languages.dart.flutter-tools.enable

Enable flutter-tools for flutter support

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.languages.dart.flutter-tools.enable + + +
+
+

Enable flutter-tools for flutter support

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/dart/dart.nix> -
vim.languages.dart.flutter-tools.enableNoResolvePatch

Patch flutter-tools so that it doesn’t resolve symlinks when detecting flutter path. + +

+
+
+ + vim.languages.dart.flutter-tools.enableNoResolvePatch + + +
+
+

Patch flutter-tools so that it doesn’t resolve symlinks when detecting flutter path. 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 “dart missing from PATH”, disable this option.

Type: -boolean

Default: -true

Declared by:

+
+If you are using a flutter SDK installed from a different source and encounter the error “dart missing from PATH”, disable this option.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/dart/dart.nix> -
vim.languages.dart.flutter-tools.color.enable

Whether to enable Whether or mot to highlight color variables at all.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.dart.flutter-tools.color.enable + + +
+
+

Whether to enable Whether or mot to highlight color variables at all.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/dart/dart.nix> -
vim.languages.dart.flutter-tools.color.highlightBackground

Highlight the background

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.languages.dart.flutter-tools.color.highlightBackground + + +
+
+

Highlight the background

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/dart/dart.nix> -
vim.languages.dart.flutter-tools.color.highlightForeground

Highlight the foreground

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.languages.dart.flutter-tools.color.highlightForeground + + +
+
+

Highlight the foreground

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/dart/dart.nix> -
vim.languages.dart.flutter-tools.color.virtualText.enable

Whether to enable Show the highlight using virtual text.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.dart.flutter-tools.color.virtualText.enable + + +
+
+

Whether to enable Show the highlight using virtual text.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/dart/dart.nix> -
vim.languages.dart.flutter-tools.color.virtualText.character

Virtual text character to highlight

Type: -string

Default: -"■"

Declared by:

+
+ +
+
+
+ + vim.languages.dart.flutter-tools.color.virtualText.character + + +
+
+

Virtual text character to highlight

+ +

Type: +string

+ +

Default: +"■"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/dart/dart.nix> -
vim.languages.dart.lsp.enable

Whether to enable Dart LSP support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.dart.lsp.enable + + +
+
+

Whether to enable Dart LSP support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/dart/dart.nix> -
vim.languages.dart.lsp.package

Dart LSP server package, or the command to run as a list of strings

Type: -package or list of string

Default: -<derivation dart-3.1.3>

Example: -"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

Declared by:

+
+ +
+
+
+ + vim.languages.dart.lsp.package + + +
+
+

Dart LSP server package, or the command to run as a list of strings

+ +

Type: +package or list of string

+ +

Default: +<derivation dart-3.2.0>

+ +

Example: +"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/dart/dart.nix> -
vim.languages.dart.lsp.opts

Options to pass to Dart LSP server

Type: -null or string

Default: -null

Declared by:

+
+ +
+
+
+ + vim.languages.dart.lsp.opts + + +
+
+

Options to pass to Dart LSP server

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/dart/dart.nix> -
vim.languages.dart.lsp.server

The Dart LSP server to use

Type: -value “dart” (singular enum)

Default: -"dart"

Declared by:

+
+ +
+
+
+ + vim.languages.dart.lsp.server + + +
+
+

The Dart LSP server to use

+ +

Type: +value “dart” (singular enum)

+ +

Default: +"dart"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/dart/dart.nix> -
vim.languages.dart.treesitter.enable

Whether to enable Dart treesitter.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.dart.treesitter.enable + + +
+
+

Whether to enable Dart treesitter.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/dart/dart.nix> -
vim.languages.dart.treesitter.package

The dart treesitter package to use.

Type: -package

Default: -pkgs.vimPlugins.nvim-treesitter.builtGrammars.dart

Declared by:

+
+ +
+
+
+ + vim.languages.dart.treesitter.package + + +
+
+

The dart treesitter package to use.

+ +

Type: +package

+ +

Default: +pkgs.vimPlugins.nvim-treesitter.builtGrammars.dart

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/dart/dart.nix> -
vim.languages.elixir.enable

Whether to enable Elixir language support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.elixir.enable + + +
+
+

Whether to enable Elixir language support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/elixir/elixir-tools.nix> -
vim.languages.go.enable

Whether to enable Go language support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.go.enable + + +
+
+

Whether to enable Go language support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/go.nix> -
vim.languages.go.dap.enable

Enable Go Debug Adapter

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.languages.go.dap.enable + + +
+
+

Enable Go Debug Adapter

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/go.nix> -
vim.languages.go.dap.package

Go debugger package.

Type: -package

Default: -<derivation delve-1.21.0>

Declared by:

+
+ +
+
+
+ + vim.languages.go.dap.package + + +
+
+

Go debugger package.

+ +

Type: +package

+ +

Default: +<derivation delve-1.21.2>

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/go.nix> -
vim.languages.go.dap.debugger

Go debugger to use

Type: -value “delve” (singular enum)

Default: -"delve"

Declared by:

+
+ +
+
+
+ + vim.languages.go.dap.debugger + + +
+
+

Go debugger to use

+ +

Type: +value “delve” (singular enum)

+ +

Default: +"delve"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/go.nix> -
vim.languages.go.lsp.enable

Whether to enable Go LSP support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.go.lsp.enable + + +
+
+

Whether to enable Go LSP support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/go.nix> -
vim.languages.go.lsp.package

Go LSP server package, or the command to run as a list of strings

Type: -package or list of string

Default: -<derivation gopls-0.14.2>

Example: -"[lib.getExe pkgs.jdt-language-server \" - data \" \" ~/.cache/jdtls/workspace \"]"

Declared by:

+
+ +
+
+
+ + vim.languages.go.lsp.package + + +
+
+

Go LSP server package, or the command to run as a list of strings

+ +

Type: +package or list of string

+ +

Default: +<derivation gopls-0.14.2>

+ +

Example: +"[lib.getExe pkgs.jdt-language-server \" - data \" \" ~/.cache/jdtls/workspace \"]"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/go.nix> -
vim.languages.go.lsp.server

Go LSP server to use

Type: -value “gopls” (singular enum)

Default: -"gopls"

Declared by:

+
+ +
+
+
+ + vim.languages.go.lsp.server + + +
+
+

Go LSP server to use

+ +

Type: +value “gopls” (singular enum)

+ +

Default: +"gopls"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/go.nix> -
vim.languages.go.treesitter.enable

Whether to enable Go treesitter.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.go.treesitter.enable + + +
+
+

Whether to enable Go treesitter.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/go.nix> -
vim.languages.go.treesitter.package

The go treesitter package to use.

Type: -package

Default: -pkgs.vimPlugins.nvim-treesitter.builtGrammars.go

Declared by:

+
+ +
+
+
+ + vim.languages.go.treesitter.package + + +
+
+

The go treesitter package to use.

+ +

Type: +package

+ +

Default: +pkgs.vimPlugins.nvim-treesitter.builtGrammars.go

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/go.nix> -
vim.languages.html.enable

Whether to enable HTML language support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.html.enable + + +
+
+

Whether to enable HTML language support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/html.nix> -
vim.languages.html.treesitter.enable

Enable HTML treesitter

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.languages.html.treesitter.enable + + +
+
+

Enable HTML treesitter

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/html.nix> -
vim.languages.html.treesitter.package

The html treesitter package to use.

Type: -package

Default: -pkgs.vimPlugins.nvim-treesitter.builtGrammars.html

Declared by:

+
+ +
+
+
+ + vim.languages.html.treesitter.package + + +
+
+

The html treesitter package to use.

+ +

Type: +package

+ +

Default: +pkgs.vimPlugins.nvim-treesitter.builtGrammars.html

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/html.nix> -
vim.languages.html.treesitter.autotagHtml

Enable autoclose/autorename of html tags (nvim-ts-autotag)

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.languages.html.treesitter.autotagHtml + + +
+
+

Enable autoclose/autorename of html tags (nvim-ts-autotag)

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/html.nix> -
vim.languages.java.enable

Whether to enable Java language support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.java.enable + + +
+
+

Whether to enable Java language support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/java.nix> -
vim.languages.java.lsp.enable

Whether to enable Java LSP support (java-language-server).

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.java.lsp.enable + + +
+
+

Whether to enable Java LSP support (java-language-server).

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/java.nix> -
vim.languages.java.lsp.package

java language server package, or the command to run as a list of strings

Type: -package or list of string

Default: -<derivation jdt-language-server-1.26.0>

Example: -"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

Declared by:

+
+ +
+
+
+ + vim.languages.java.lsp.package + + +
+
+

java language server package, or the command to run as a list of strings

+ +

Type: +package or list of string

+ +

Default: +<derivation jdt-language-server-1.26.0>

+ +

Example: +"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/java.nix> -
vim.languages.java.treesitter.enable

Whether to enable Java treesitter.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.java.treesitter.enable + + +
+
+

Whether to enable Java treesitter.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/java.nix> -
vim.languages.java.treesitter.package

The java treesitter package to use.

Type: -package

Default: -pkgs.vimPlugins.nvim-treesitter.builtGrammars.java

Declared by:

+
+ +
+
+
+ + vim.languages.java.treesitter.package + + +
+
+

The java treesitter package to use.

+ +

Type: +package

+ +

Default: +pkgs.vimPlugins.nvim-treesitter.builtGrammars.java

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/java.nix> -
vim.languages.lua.enable

Whether to enable Lua language support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.lua.enable + + +
+
+

Whether to enable Lua language support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/lua.nix> -
vim.languages.lua.lsp.enable

Whether to enable Lua LSP support via LuaLS.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.lua.lsp.enable + + +
+
+

Whether to enable Lua LSP support via LuaLS.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/lua.nix> -
vim.languages.lua.lsp.package

LuaLS package, or the command to run as a list of strings

Type: -package or list of string

Default: -<derivation lua-language-server-3.7.3>

Declared by:

+
+ +
+
+
+ + vim.languages.lua.lsp.package + + +
+
+

LuaLS package, or the command to run as a list of strings

+ +

Type: +package or list of string

+ +

Default: +<derivation lua-language-server-3.7.3>

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/lua.nix> -
vim.languages.lua.lsp.neodev.enable

Whether to enable neodev.nvim integration, useful for neovim plugin developers.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.lua.lsp.neodev.enable + + +
+
+

Whether to enable neodev.nvim integration, useful for neovim plugin developers.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/lua.nix> -
vim.languages.lua.treesitter.enable

Whether to enable Lua Treesitter support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.lua.treesitter.enable + + +
+
+

Whether to enable Lua Treesitter support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/lua.nix> -
vim.languages.lua.treesitter.package

The lua treesitter package to use.

Type: -package

Default: -pkgs.vimPlugins.nvim-treesitter.builtGrammars.lua

Declared by:

+
+ +
+
+
+ + vim.languages.lua.treesitter.package + + +
+
+

The lua treesitter package to use.

+ +

Type: +package

+ +

Default: +pkgs.vimPlugins.nvim-treesitter.builtGrammars.lua

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/lua.nix> -
vim.languages.markdown.enable

Whether to enable Markdown markup language support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.markdown.enable + + +
+
+

Whether to enable Markdown markup language support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/markdown/markdown.nix> -
vim.languages.markdown.glow.enable

Enable markdown preview in neovim with glow

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.languages.markdown.glow.enable + + +
+
+

Enable markdown preview in neovim with glow

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/markdown/markdown.nix> -
vim.languages.markdown.treesitter.enable

Enable Markdown treesitter

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.languages.markdown.treesitter.enable + + +
+
+

Enable Markdown treesitter

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/markdown/markdown.nix> -
vim.languages.markdown.treesitter.mdInlinePackage

The markdown-inline treesitter package to use.

Type: -package

Default: -pkgs.vimPlugins.nvim-treesitter.builtGrammars.markdown-inline

Declared by:

+
+ +
+
+
+ + vim.languages.markdown.treesitter.mdInlinePackage + + +
+
+

The markdown-inline treesitter package to use.

+ +

Type: +package

+ +

Default: +pkgs.vimPlugins.nvim-treesitter.builtGrammars.markdown-inline

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/markdown/markdown.nix> -
vim.languages.markdown.treesitter.mdPackage

The markdown treesitter package to use.

Type: -package

Default: -pkgs.vimPlugins.nvim-treesitter.builtGrammars.markdown

Declared by:

+
+ +
+
+
+ + vim.languages.markdown.treesitter.mdPackage + + +
+
+

The markdown treesitter package to use.

+ +

Type: +package

+ +

Default: +pkgs.vimPlugins.nvim-treesitter.builtGrammars.markdown

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/markdown/markdown.nix> -
vim.languages.nix.enable

Whether to enable Nix language support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.nix.enable + + +
+
+

Whether to enable Nix language support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/nix.nix> -
vim.languages.nix.extraDiagnostics.enable

Enable extra Nix diagnostics

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.languages.nix.extraDiagnostics.enable + + +
+
+

Enable extra Nix diagnostics

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/nix.nix> -
vim.languages.nix.extraDiagnostics.types

List of Nix diagnostics to enable

Type: -list of (one of “deadnix”, “statix” or (submodule))

Default:

[
-  "statix"
-  "deadnix"
+
+
+
+
+ + vim.languages.nix.extraDiagnostics.types + + +
+
+

List of Nix diagnostics to enable

+ +

Type: +list of (one of “deadnix”, “statix” or (submodule))

+ +

Default:

[
+  "statix"
+  "deadnix"
 ]
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/languages/nix.nix> -
vim.languages.nix.format.enable

Whether to enable Nix formatting.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.nix.format.enable + + +
+
+

Whether to enable Nix formatting.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/nix.nix> -
vim.languages.nix.format.package

Nix formatter package

Type: -package

Default: -<derivation alejandra-3.0.0>

Declared by:

+
+ +
+
+
+ + vim.languages.nix.format.package + + +
+
+

Nix formatter package

+ +

Type: +package

+ +

Default: +<derivation alejandra-3.0.0>

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/nix.nix> -
vim.languages.nix.format.type

Nix formatter to use

Type: -one of “alejandra”, “nixpkgs-fmt”

Default: -"alejandra"

Declared by:

+
+ +
+
+
+ + vim.languages.nix.format.type + + +
+
+

Nix formatter to use

+ +

Type: +one of “alejandra”, “nixpkgs-fmt”

+ +

Default: +"alejandra"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/nix.nix> -
vim.languages.nix.lsp.enable

Whether to enable Nix LSP support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.nix.lsp.enable + + +
+
+

Whether to enable Nix LSP support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/nix.nix> -
vim.languages.nix.lsp.package

Nix LSP server package, or the command to run as a list of strings

Type: -package or list of string

Default: -<derivation nil-2023-08-09>

Example: -"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

Declared by:

+
+ +
+
+
+ + vim.languages.nix.lsp.package + + +
+
+

Nix LSP server package, or the command to run as a list of strings

+ +

Type: +package or list of string

+ +

Default: +<derivation nil-2023-08-09>

+ +

Example: +"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/nix.nix> -
vim.languages.nix.lsp.server

Nix LSP server to use

Type: -string

Default: -"nil"

Declared by:

+
+ +
+
+
+ + vim.languages.nix.lsp.server + + +
+
+

Nix LSP server to use

+ +

Type: +string

+ +

Default: +"nil"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/nix.nix> -
vim.languages.nix.treesitter.enable

Enable Nix treesitter

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.languages.nix.treesitter.enable + + +
+
+

Enable Nix treesitter

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/nix.nix> -
vim.languages.nix.treesitter.package

The nix treesitter package to use.

Type: -package

Default: -pkgs.vimPlugins.nvim-treesitter.builtGrammars.nix

Declared by:

+
+ +
+
+
+ + vim.languages.nix.treesitter.package + + +
+
+

The nix treesitter package to use.

+ +

Type: +package

+ +

Default: +pkgs.vimPlugins.nvim-treesitter.builtGrammars.nix

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/nix.nix> -
vim.languages.php.enable

Whether to enable PHP language support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.php.enable + + +
+
+

Whether to enable PHP language support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/php.nix> -
vim.languages.php.lsp.enable

Whether to enable PHP LSP support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.php.lsp.enable + + +
+
+

Whether to enable PHP LSP support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/php.nix> -
vim.languages.php.lsp.package

PHP LSP server package, or the command to run as a list of strings

Type: -package or list of string

Default: -<derivation phpactor-2023.08.06-1>

Example: -"[lib.getExe pkgs.jdt-language-server \" - data \" \" ~/.cache/jdtls/workspace \"]"

Declared by:

+
+ +
+
+
+ + vim.languages.php.lsp.package + + +
+
+

PHP LSP server package, or the command to run as a list of strings

+ +

Type: +package or list of string

+ +

Default: +<derivation phpactor-2023.08.06-1>

+ +

Example: +"[lib.getExe pkgs.jdt-language-server \" - data \" \" ~/.cache/jdtls/workspace \"]"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/php.nix> -
vim.languages.php.lsp.server

PHP LSP server to use

Type: -one of “phan”, “phpactor”

Default: -"phpactor"

Declared by:

+
+ +
+
+
+ + vim.languages.php.lsp.server + + +
+
+

PHP LSP server to use

+ +

Type: +one of “phan”, “phpactor”

+ +

Default: +"phpactor"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/php.nix> -
vim.languages.php.treesitter.enable

Whether to enable PHP treesitter.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.php.treesitter.enable + + +
+
+

Whether to enable PHP treesitter.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/php.nix> -
vim.languages.php.treesitter.package

The php treesitter package to use.

Type: -package

Default: -pkgs.vimPlugins.nvim-treesitter.builtGrammars.php

Declared by:

+
+ +
+
+
+ + vim.languages.php.treesitter.package + + +
+
+

The php treesitter package to use.

+ +

Type: +package

+ +

Default: +pkgs.vimPlugins.nvim-treesitter.builtGrammars.php

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/php.nix> -
vim.languages.python.enable

Whether to enable Python language support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.python.enable + + +
+
+

Whether to enable Python language support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/python.nix> -
vim.languages.python.dap.enable

Enable Python Debug Adapter

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.languages.python.dap.enable + + +
+
+

Enable Python Debug Adapter

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/python.nix> -
vim.languages.python.dap.package

Python debugger package. -This is a python package with debugpy installed, see https://nixos.wiki/wiki/Python#Install_Python_Packages.

Type: -package

Default: -<derivation python3-3.11.6-env>

Example: -with pkgs; python39.withPackages (ps: with ps; [debugpy])

Declared by:

+
+ +
+
+
+ + vim.languages.python.dap.package + + +
+
+

Python debugger package. +This is a python package with debugpy installed, see https://nixos.wiki/wiki/Python#Install_Python_Packages.

+ +

Type: +package

+ +

Default: +<derivation python3-3.11.6-env>

+ +

Example: +with pkgs; python39.withPackages (ps: with ps; [debugpy])

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/python.nix> -
vim.languages.python.dap.debugger

Python debugger to use

Type: -value “debugpy” (singular enum)

Default: -"debugpy"

Declared by:

+
+ +
+
+
+ + vim.languages.python.dap.debugger + + +
+
+

Python debugger to use

+ +

Type: +value “debugpy” (singular enum)

+ +

Default: +"debugpy"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/python.nix> -
vim.languages.python.format.enable

Whether to enable Python formatting.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.python.format.enable + + +
+
+

Whether to enable Python formatting.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/python.nix> -
vim.languages.python.format.package

Python formatter package

Type: -package

Default: -<derivation black-23.9.1>

Declared by:

+
+ +
+
+
+ + vim.languages.python.format.package + + +
+
+

Python formatter package

+ +

Type: +package

+ +

Default: +<derivation black-23.11.0>

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/python.nix> -
vim.languages.python.format.type

Python formatter to use

Type: -one of “black”, “black-and-isort”, “isort”

Default: -"black"

Declared by:

+
+ +
+
+
+ + vim.languages.python.format.type + + +
+
+

Python formatter to use

+ +

Type: +one of “black”, “black-and-isort”, “isort”

+ +

Default: +"black"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/python.nix> -
vim.languages.python.lsp.enable

Whether to enable Python LSP support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.python.lsp.enable + + +
+
+

Whether to enable Python LSP support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/python.nix> -
vim.languages.python.lsp.package

python LSP server package, or the command to run as a list of strings

Type: -package or list of string

Default: -<derivation pyright-1.1.336>

Example: -"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

Declared by:

+
+ +
+
+
+ + vim.languages.python.lsp.package + + +
+
+

python LSP server package, or the command to run as a list of strings

+ +

Type: +package or list of string

+ +

Default: +<derivation pyright-1.1.336>

+ +

Example: +"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/python.nix> -
vim.languages.python.lsp.server

Python LSP server to use

Type: -value “pyright” (singular enum)

Default: -"pyright"

Declared by:

+
+ +
+
+
+ + vim.languages.python.lsp.server + + +
+
+

Python LSP server to use

+ +

Type: +value “pyright” (singular enum)

+ +

Default: +"pyright"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/python.nix> -
vim.languages.python.treesitter.enable

Whether to enable Python treesitter.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.python.treesitter.enable + + +
+
+

Whether to enable Python treesitter.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/python.nix> -
vim.languages.python.treesitter.package

Python treesitter grammar to use

Type: -package

Default: -<derivation python-grammar-0.0.0+rev=4bfdd90>

Declared by:

+
+ +
+
+
+ + vim.languages.python.treesitter.package + + +
+
+

Python treesitter grammar to use

+ +

Type: +package

+ +

Default: +<derivation python-grammar-0.0.0+rev=4bfdd90>

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/python.nix> -
vim.languages.rust.enable

Whether to enable Rust language support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.rust.enable + + +
+
+

Whether to enable Rust language support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/rust.nix> -
vim.languages.rust.crates.enable

Whether to enable crates-nvim, tools for managing dependencies.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.rust.crates.enable + + +
+
+

Whether to enable crates-nvim, tools for managing dependencies.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/rust.nix> -
vim.languages.rust.crates.codeActions

Enable code actions through null-ls

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.languages.rust.crates.codeActions + + +
+
+

Enable code actions through null-ls

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/rust.nix> -
vim.languages.rust.dap.enable

Rust Debug Adapter support

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.languages.rust.dap.enable + + +
+
+

Rust Debug Adapter support

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/rust.nix> -
vim.languages.rust.dap.package

lldb pacakge

Type: -package

Default: -<derivation lldb-14.0.6>

Declared by:

+
+ +
+
+
+ + vim.languages.rust.dap.package + + +
+
+

lldb pacakge

+ +

Type: +package

+ +

Default: +<derivation lldb-14.0.6>

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/rust.nix> -
vim.languages.rust.lsp.enable

Whether to enable Rust LSP support (rust-analyzer with extra tools).

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.rust.lsp.enable + + +
+
+

Whether to enable Rust LSP support (rust-analyzer with extra tools).

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/rust.nix> -
vim.languages.rust.lsp.package

rust-analyzer package, or the command to run as a list of strings

Type: -package or list of string

Default: -<derivation rust-analyzer-2023-11-13>

Example: -"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

Declared by:

+
+ +
+
+
+ + vim.languages.rust.lsp.package + + +
+
+

rust-analyzer package, or the command to run as a list of strings

+ +

Type: +package or list of string

+ +

Default: +<derivation rust-analyzer-2023-11-13>

+ +

Example: +"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/rust.nix> -
vim.languages.rust.lsp.opts

Options to pass to rust analyzer

Type: -string

Default: -""

Declared by:

+
+ +
+
+
+ + vim.languages.rust.lsp.opts + + +
+
+

Options to pass to rust analyzer

+ +

Type: +string

+ +

Default: +""

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/rust.nix> -
vim.languages.rust.treesitter.enable

Whether to enable Rust treesitter.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.rust.treesitter.enable + + +
+
+

Whether to enable Rust treesitter.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/rust.nix> -
vim.languages.rust.treesitter.package

The rust treesitter package to use.

Type: -package

Default: -pkgs.vimPlugins.nvim-treesitter.builtGrammars.rust

Declared by:

+
+ +
+
+
+ + vim.languages.rust.treesitter.package + + +
+
+

The rust treesitter package to use.

+ +

Type: +package

+ +

Default: +pkgs.vimPlugins.nvim-treesitter.builtGrammars.rust

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/rust.nix> -
vim.languages.sql.enable

Whether to enable SQL language support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.sql.enable + + +
+
+

Whether to enable SQL language support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/sql.nix> -
vim.languages.sql.dialect

SQL dialect for sqlfluff (if used)

Type: -string

Default: -"ansi"

Declared by:

+
+ +
+
+
+ + vim.languages.sql.dialect + + +
+
+

SQL dialect for sqlfluff (if used)

+ +

Type: +string

+ +

Default: +"ansi"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/sql.nix> -
vim.languages.sql.extraDiagnostics.enable

Whether to enable extra SQL diagnostics.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.sql.extraDiagnostics.enable + + +
+
+

Whether to enable extra SQL diagnostics.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/sql.nix> -
vim.languages.sql.extraDiagnostics.types

List of SQL diagnostics to enable

Type: -list of (value “sqlfluff” (singular enum) or (submodule))

Default:

[
-  "sqlfluff"
+
+
+
+
+ + vim.languages.sql.extraDiagnostics.types + + +
+
+

List of SQL diagnostics to enable

+ +

Type: +list of (value “sqlfluff” (singular enum) or (submodule))

+ +

Default:

[
+  "sqlfluff"
 ]
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/languages/sql.nix> -
vim.languages.sql.format.enable

Whether to enable SQL formatting.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.sql.format.enable + + +
+
+

Whether to enable SQL formatting.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/sql.nix> -
vim.languages.sql.format.package

SQL formatter package

Type: -package

Default: -<derivation sqlfluff-2.3.5>

Declared by:

+
+ +
+
+
+ + vim.languages.sql.format.package + + +
+
+

SQL formatter package

+ +

Type: +package

+ +

Default: +<derivation sqlfluff-2.3.5>

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/sql.nix> -
vim.languages.sql.format.type

SQL formatter to use

Type: -value “sqlfluff” (singular enum)

Default: -"sqlfluff"

Declared by:

+
+ +
+
+
+ + vim.languages.sql.format.type + + +
+
+

SQL formatter to use

+ +

Type: +value “sqlfluff” (singular enum)

+ +

Default: +"sqlfluff"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/sql.nix> -
vim.languages.sql.lsp.enable

Whether to enable SQL LSP support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.sql.lsp.enable + + +
+
+

Whether to enable SQL LSP support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/sql.nix> -
vim.languages.sql.lsp.package

SQL LSP server package, or the command to run as a list of strings

Type: -package or list of string

Default: -<derivation sqls-0.2.22>

Example: -"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

Declared by:

+
+ +
+
+
+ + vim.languages.sql.lsp.package + + +
+
+

SQL LSP server package, or the command to run as a list of strings

+ +

Type: +package or list of string

+ +

Default: +<derivation sqls-0.2.22>

+ +

Example: +"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/sql.nix> -
vim.languages.sql.lsp.server

SQL LSP server to use

Type: -value “sqls” (singular enum)

Default: -"sqls"

Declared by:

+
+ +
+
+
+ + vim.languages.sql.lsp.server + + +
+
+

SQL LSP server to use

+ +

Type: +value “sqls” (singular enum)

+ +

Default: +"sqls"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/sql.nix> -
vim.languages.sql.treesitter.enable

Whether to enable SQL treesitter.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.sql.treesitter.enable + + +
+
+

Whether to enable SQL treesitter.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/sql.nix> -
vim.languages.sql.treesitter.package

SQL treesitter grammar to use

Type: -package

Default: -<derivation sql-grammar-0.0.0+rev=d8fffdf>

Declared by:

+
+ +
+
+
+ + vim.languages.sql.treesitter.package + + +
+
+

SQL treesitter grammar to use

+ +

Type: +package

+ +

Default: +<derivation sql-grammar-0.0.0+rev=b599f6a>

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/sql.nix> -
vim.languages.svelte.enable

Whether to enable Svelte language support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.svelte.enable + + +
+
+

Whether to enable Svelte language support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/svelte.nix> -
vim.languages.svelte.extraDiagnostics.enable

Whether to enable extra Svelte diagnostics.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.svelte.extraDiagnostics.enable + + +
+
+

Whether to enable extra Svelte diagnostics.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/svelte.nix> -
vim.languages.svelte.extraDiagnostics.types

List of Svelte diagnostics to enable

Type: -list of (value “eslint_d” (singular enum) or (submodule))

Default:

[
-  "eslint_d"
+
+
+
+
+ + vim.languages.svelte.extraDiagnostics.types + + +
+
+

List of Svelte diagnostics to enable

+ +

Type: +list of (value “eslint_d” (singular enum) or (submodule))

+ +

Default:

[
+  "eslint_d"
 ]
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/languages/svelte.nix> -
vim.languages.svelte.format.enable

Whether to enable Svelte formatting.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.svelte.format.enable + + +
+
+

Whether to enable Svelte formatting.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/svelte.nix> -
vim.languages.svelte.format.package

Svelte formatter package

Type: -package

Default: -<derivation prettier-3.1.0>

Declared by:

+
+ +
+
+
+ + vim.languages.svelte.format.package + + +
+
+

Svelte formatter package

+ +

Type: +package

+ +

Default: +<derivation prettier-3.1.0>

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/svelte.nix> -
vim.languages.svelte.format.type

Svelte formatter to use

Type: -value “prettier” (singular enum)

Default: -"prettier"

Declared by:

+
+ +
+
+
+ + vim.languages.svelte.format.type + + +
+
+

Svelte formatter to use

+ +

Type: +value “prettier” (singular enum)

+ +

Default: +"prettier"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/svelte.nix> -
vim.languages.svelte.lsp.enable

Whether to enable Svelte LSP support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.svelte.lsp.enable + + +
+
+

Whether to enable Svelte LSP support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/svelte.nix> -
vim.languages.svelte.lsp.package

Svelte LSP server package, or the command to run as a list of strings

Type: -package or list of string

Default: -<derivation svelte-language-server-0.15.22>

Example: -"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

Declared by:

+
+ +
+
+
+ + vim.languages.svelte.lsp.package + + +
+
+

Svelte LSP server package, or the command to run as a list of strings

+ +

Type: +package or list of string

+ +

Default: +<derivation svelte-language-server-0.15.22>

+ +

Example: +"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/svelte.nix> -
vim.languages.svelte.lsp.server

Svelte LSP server to use

Type: -value “svelte” (singular enum)

Default: -"svelte"

Declared by:

+
+ +
+
+
+ + vim.languages.svelte.lsp.server + + +
+
+

Svelte LSP server to use

+ +

Type: +value “svelte” (singular enum)

+ +

Default: +"svelte"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/svelte.nix> -
vim.languages.svelte.treesitter.enable

Whether to enable Svelte treesitter.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.svelte.treesitter.enable + + +
+
+

Whether to enable Svelte treesitter.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/svelte.nix> -
vim.languages.svelte.treesitter.sveltePackage

The svelte treesitter package to use.

Type: -package

Default: -pkgs.vimPlugins.nvim-treesitter.builtGrammars.svelte

Declared by:

+
+ +
+
+
+ + vim.languages.svelte.treesitter.sveltePackage + + +
+
+

The svelte treesitter package to use.

+ +

Type: +package

+ +

Default: +pkgs.vimPlugins.nvim-treesitter.builtGrammars.svelte

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/svelte.nix> -
vim.languages.terraform.enable

Whether to enable Terraform/HCL support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.terraform.enable + + +
+
+

Whether to enable Terraform/HCL support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/terraform.nix> -
vim.languages.terraform.lsp.enable

Whether to enable Terraform LSP support (terraform-ls).

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.terraform.lsp.enable + + +
+
+

Whether to enable Terraform LSP support (terraform-ls).

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/terraform.nix> -
vim.languages.terraform.lsp.package

terraform-ls package

Type: -package

Default: -<derivation terraform-ls-0.32.3>

Declared by:

+
+ +
+
+
+ + vim.languages.terraform.lsp.package + + +
+
+

terraform-ls package

+ +

Type: +package

+ +

Default: +<derivation terraform-ls-0.32.3>

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/terraform.nix> -
vim.languages.terraform.treesitter.enable

Whether to enable Terraform treesitter.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.terraform.treesitter.enable + + +
+
+

Whether to enable Terraform treesitter.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/terraform.nix> -
vim.languages.terraform.treesitter.package

The terraform treesitter package to use.

Type: -package

Default: -pkgs.vimPlugins.nvim-treesitter.builtGrammars.terraform

Declared by:

+
+ +
+
+
+ + vim.languages.terraform.treesitter.package + + +
+
+

The terraform treesitter package to use.

+ +

Type: +package

+ +

Default: +pkgs.vimPlugins.nvim-treesitter.builtGrammars.terraform

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/terraform.nix> -
vim.languages.ts.enable

Whether to enable Typescript/Javascript language support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.ts.enable + + +
+
+

Whether to enable Typescript/Javascript language support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/ts.nix> -
vim.languages.ts.extraDiagnostics.enable

Whether to enable extra Typescript/Javascript diagnostics.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.ts.extraDiagnostics.enable + + +
+
+

Whether to enable extra Typescript/Javascript diagnostics.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/ts.nix> -
vim.languages.ts.extraDiagnostics.types

List of Typescript/Javascript diagnostics to enable

Type: -list of (value “eslint_d” (singular enum) or (submodule))

Default:

[
-  "eslint_d"
+
+
+
+
+ + vim.languages.ts.extraDiagnostics.types + + +
+
+

List of Typescript/Javascript diagnostics to enable

+ +

Type: +list of (value “eslint_d” (singular enum) or (submodule))

+ +

Default:

[
+  "eslint_d"
 ]
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/languages/ts.nix> -
vim.languages.ts.format.enable

Whether to enable Typescript/Javascript formatting.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.ts.format.enable + + +
+
+

Whether to enable Typescript/Javascript formatting.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/ts.nix> -
vim.languages.ts.format.package

Typescript/Javascript formatter package

Type: -package

Default: -<derivation prettier-3.1.0>

Declared by:

+
+ +
+
+
+ + vim.languages.ts.format.package + + +
+
+

Typescript/Javascript formatter package

+ +

Type: +package

+ +

Default: +<derivation prettier-3.1.0>

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/ts.nix> -
vim.languages.ts.format.type

Typescript/Javascript formatter to use

Type: -one of “prettier”, “prettierd”

Default: -"prettier"

Declared by:

+
+ +
+
+
+ + vim.languages.ts.format.type + + +
+
+

Typescript/Javascript formatter to use

+ +

Type: +one of “prettier”, “prettierd”

+ +

Default: +"prettier"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/ts.nix> -
vim.languages.ts.lsp.enable

Whether to enable Typescript/Javascript LSP support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.ts.lsp.enable + + +
+
+

Whether to enable Typescript/Javascript LSP support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/ts.nix> -
vim.languages.ts.lsp.package

Typescript/Javascript LSP server package, or the command to run as a list of strings

Type: -package or list of string

Default: -<derivation typescript-language-server-4.1.2>

Example: -"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

Declared by:

+
+ +
+
+
+ + vim.languages.ts.lsp.package + + +
+
+

Typescript/Javascript LSP server package, or the command to run as a list of strings

+ +

Type: +package or list of string

+ +

Default: +<derivation typescript-language-server-4.1.2>

+ +

Example: +"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/ts.nix> -
vim.languages.ts.lsp.server

Typescript/Javascript LSP server to use

Type: -one of “denols”, “tsserver”

Default: -"tsserver"

Declared by:

+
+ +
+
+
+ + vim.languages.ts.lsp.server + + +
+
+

Typescript/Javascript LSP server to use

+ +

Type: +one of “denols”, “tsserver”

+ +

Default: +"tsserver"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/ts.nix> -
vim.languages.ts.treesitter.enable

Whether to enable Typescript/Javascript treesitter.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.ts.treesitter.enable + + +
+
+

Whether to enable Typescript/Javascript treesitter.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/ts.nix> -
vim.languages.ts.treesitter.jsPackage

The javascript treesitter package to use.

Type: -package

Default: -pkgs.vimPlugins.nvim-treesitter.builtGrammars.javascript

Declared by:

+
+ +
+
+
+ + vim.languages.ts.treesitter.jsPackage + + +
+
+

The javascript treesitter package to use.

+ +

Type: +package

+ +

Default: +pkgs.vimPlugins.nvim-treesitter.builtGrammars.javascript

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/ts.nix> -
vim.languages.ts.treesitter.tsPackage

The tsx treesitter package to use.

Type: -package

Default: -pkgs.vimPlugins.nvim-treesitter.builtGrammars.tsx

Declared by:

+
+ +
+
+
+ + vim.languages.ts.treesitter.tsPackage + + +
+
+

The tsx treesitter package to use.

+ +

Type: +package

+ +

Default: +pkgs.vimPlugins.nvim-treesitter.builtGrammars.tsx

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/ts.nix> -
vim.languages.zig.enable

Whether to enable Zig language support.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.zig.enable + + +
+
+

Whether to enable Zig language support.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/zig.nix> -
vim.languages.zig.lsp.enable

Whether to enable Zig LSP support (zls).

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.zig.lsp.enable + + +
+
+

Whether to enable Zig LSP support (zls).

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/zig.nix> -
vim.languages.zig.lsp.package

ZLS package, or the command to run as a list of strings

Type: -package or list of string

Default: -<derivation zls-0.11.0>

Example: -"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

Declared by:

+
+ +
+
+
+ + vim.languages.zig.lsp.package + + +
+
+

ZLS package, or the command to run as a list of strings

+ +

Type: +package or list of string

+ +

Default: +<derivation zls-0.11.0>

+ +

Example: +"[lib.getExe pkgs.jdt-language-server \"-data\" \"~/.cache/jdtls/workspace\"]"

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/zig.nix> -
vim.languages.zig.lsp.zigPackage

Zig package used by ZLS

Type: -package

Default: -<derivation zig-0.11.0>

Declared by:

+
+ +
+
+
+ + vim.languages.zig.lsp.zigPackage + + +
+
+

Zig package used by ZLS

+ +

Type: +package

+ +

Default: +<derivation zig-0.11.0>

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/zig.nix> -
vim.languages.zig.treesitter.enable

Whether to enable Zig treesitter.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.languages.zig.treesitter.enable + + +
+
+

Whether to enable Zig treesitter.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/zig.nix> -
vim.languages.zig.treesitter.package

The zig treesitter package to use.

Type: -package

Default: -pkgs.vimPlugins.nvim-treesitter.builtGrammars.zig

Declared by:

+
+ +
+
+
+ + vim.languages.zig.treesitter.package + + +
+
+

The zig treesitter package to use.

+ +

Type: +package

+ +

Default: +pkgs.vimPlugins.nvim-treesitter.builtGrammars.zig

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/zig.nix> -
vim.leaderKey

The leader key to be used internally

Type: -null or string

Default: -null

Declared by:

+
+ +
+
+
+ + vim.leaderKey + + +
+
+

The leader key to be used internally

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.lineNumberMode

How line numbers are displayed. none, relative, number, relNumber

Type: -one of “relative”, “number”, “relNumber”, “none”

Default: -"relNumber"

Declared by:

+
+ +
+
+
+ + vim.lineNumberMode + + +
+
+

How line numbers are displayed. none, relative, number, relNumber

+ +

Type: +one of “relative”, “number”, “relNumber”, “none”

+ +

Default: +"relNumber"

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.lsp.enable

Whether to enable LSP, also enabled automatically through null-ls and lspconfig options.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.lsp.enable + + +
+
+

Whether to enable LSP, also enabled automatically through null-ls and lspconfig options.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/module.nix> -
vim.lsp.formatOnSave

Whether to enable format on save.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.lsp.formatOnSave + + +
+
+

Whether to enable format on save.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/module.nix> -
vim.lsp.lightbulb.enable

Whether to enable Lightbulb for code actions. Requires an emoji font.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.lsp.lightbulb.enable + + +
+
+

Whether to enable Lightbulb for code actions. Requires an emoji font.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/lightbulb/lightbulb.nix> -
vim.lsp.lspSignature.enable

Whether to enable lsp signature viewer.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.lsp.lspSignature.enable + + +
+
+

Whether to enable lsp signature viewer.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/lsp-signature/lsp-signature.nix> -
vim.lsp.lspconfig.enable

Whether to enable nvim-lspconfig, also enabled automatically.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.lsp.lspconfig.enable + + +
+
+

Whether to enable nvim-lspconfig, also enabled automatically.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/lspconfig/lspconfig.nix> -
vim.lsp.lspconfig.sources

nvim-lspconfig sources

Type: -attribute set of string

Default: -{ }

Declared by:

+
+ +
+
+
+ + vim.lsp.lspconfig.sources + + +
+
+

nvim-lspconfig sources

+ +

Type: +attribute set of string

+ +

Default: +{ }

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/lspconfig/lspconfig.nix> -
vim.lsp.lspkind.enable

Whether to enable vscode-like pictograms for lsp [lspkind].

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.lsp.lspkind.enable + + +
+
+

Whether to enable vscode-like pictograms for lsp [lspkind].

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/lspkind/lspkind.nix> -
vim.lsp.lspkind.mode

Defines how annotations are shown

Type: -one of “text”, “text_symbol”, “symbol_text”, “symbol”

Default: -"symbol_text"

Declared by:

+
+ +
+
+
+ + vim.lsp.lspkind.mode + + +
+
+

Defines how annotations are shown

+ +

Type: +one of “text”, “text_symbol”, “symbol_text”, “symbol”

+ +

Default: +"symbol_text"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/lspkind/lspkind.nix> -
vim.lsp.lsplines.enable

Whether to enable diagnostics using virtual lines on top of the real line of code. [lsp_lines].

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.lsp.lsplines.enable + + +
+
+

Whether to enable diagnostics using virtual lines on top of the real line of code. [lsp_lines].

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/lsplines/lsplines.nix> -
vim.lsp.lspsaga.enable

Whether to enable LSP Saga.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.lsp.lspsaga.enable + + +
+
+

Whether to enable LSP Saga.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/lspsaga/lspsaga.nix> -
vim.lsp.lspsaga.mappings.codeAction

Code action [LSPSaga]

Type: -null or string

Default: -"<leader>ca"

Declared by:

+
+ +
+
+
+ + vim.lsp.lspsaga.mappings.codeAction + + +
+
+

Code action [LSPSaga]

+ +

Type: +null or string

+ +

Default: +"<leader>ca"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/lspsaga/lspsaga.nix> -
vim.lsp.lspsaga.mappings.lspFinder

LSP Finder [LSPSaga]

Type: -null or string

Default: -"<leader>lf"

Declared by:

+
+ +
+
+
+ + vim.lsp.lspsaga.mappings.lspFinder + + +
+
+

LSP Finder [LSPSaga]

+ +

Type: +null or string

+ +

Default: +"<leader>lf"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/lspsaga/lspsaga.nix> -
vim.lsp.lspsaga.mappings.nextDiagnostic

Next diagnostic [LSPSaga]

Type: -null or string

Default: -"<leader>ln"

Declared by:

+
+ +
+
+
+ + vim.lsp.lspsaga.mappings.nextDiagnostic + + +
+
+

Next diagnostic [LSPSaga]

+ +

Type: +null or string

+ +

Default: +"<leader>ln"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/lspsaga/lspsaga.nix> -
vim.lsp.lspsaga.mappings.previewDefinition

Preview definition [LSPSaga]

Type: -null or string

Default: -"<leader>ld"

Declared by:

+
+ +
+
+
+ + vim.lsp.lspsaga.mappings.previewDefinition + + +
+
+

Preview definition [LSPSaga]

+ +

Type: +null or string

+ +

Default: +"<leader>ld"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/lspsaga/lspsaga.nix> -
vim.lsp.lspsaga.mappings.previousDiagnostic

Previous diagnostic [LSPSaga]

Type: -null or string

Default: -"<leader>lp"

Declared by:

+
+ +
+
+
+ + vim.lsp.lspsaga.mappings.previousDiagnostic + + +
+
+

Previous diagnostic [LSPSaga]

+ +

Type: +null or string

+ +

Default: +"<leader>lp"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/lspsaga/lspsaga.nix> -
vim.lsp.lspsaga.mappings.rename

Rename [LSPSaga]

Type: -null or string

Default: -"<leader>lr"

Declared by:

+
+ +
+
+
+ + vim.lsp.lspsaga.mappings.rename + + +
+
+

Rename [LSPSaga]

+ +

Type: +null or string

+ +

Default: +"<leader>lr"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/lspsaga/lspsaga.nix> -
vim.lsp.lspsaga.mappings.renderHoveredDoc

Rendered hovered docs [LSPSaga]

Type: -null or string

Default: -"<leader>lh"

Declared by:

+
+ +
+
+
+ + vim.lsp.lspsaga.mappings.renderHoveredDoc + + +
+
+

Rendered hovered docs [LSPSaga]

+ +

Type: +null or string

+ +

Default: +"<leader>lh"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/lspsaga/lspsaga.nix> -
vim.lsp.lspsaga.mappings.showCursorDiagnostics

Show cursor diagnostics [LSPSaga]

Type: -null or string

Default: -"<leader>lc"

Declared by:

+
+ +
+
+
+ + vim.lsp.lspsaga.mappings.showCursorDiagnostics + + +
+
+

Show cursor diagnostics [LSPSaga]

+ +

Type: +null or string

+ +

Default: +"<leader>lc"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/lspsaga/lspsaga.nix> -
vim.lsp.lspsaga.mappings.showLineDiagnostics

Show line diagnostics [LSPSaga]

Type: -null or string

Default: -"<leader>ll"

Declared by:

+
+ +
+
+
+ + vim.lsp.lspsaga.mappings.showLineDiagnostics + + +
+
+

Show line diagnostics [LSPSaga]

+ +

Type: +null or string

+ +

Default: +"<leader>ll"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/lspsaga/lspsaga.nix> -
vim.lsp.lspsaga.mappings.signatureHelp

Signature help [LSPSaga]

Type: -null or string

Default: -"<leader>ls"

Declared by:

+
+ +
+
+
+ + vim.lsp.lspsaga.mappings.signatureHelp + + +
+
+

Signature help [LSPSaga]

+ +

Type: +null or string

+ +

Default: +"<leader>ls"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/lspsaga/lspsaga.nix> -
vim.lsp.lspsaga.mappings.smartScrollDown

Smart scroll up [LSPSaga]

Type: -null or string

Default: -"<C-b>"

Declared by:

+
+ +
+
+
+ + vim.lsp.lspsaga.mappings.smartScrollDown + + +
+
+

Smart scroll up [LSPSaga]

+ +

Type: +null or string

+ +

Default: +"<C-b>"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/lspsaga/lspsaga.nix> -
vim.lsp.lspsaga.mappings.smartScrollUp

Smart scroll up [LSPSaga]

Type: -null or string

Default: -"<C-f>"

Declared by:

+
+ +
+
+
+ + vim.lsp.lspsaga.mappings.smartScrollUp + + +
+
+

Smart scroll up [LSPSaga]

+ +

Type: +null or string

+ +

Default: +"<C-f>"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/lspsaga/lspsaga.nix> -
vim.lsp.mappings.addWorkspaceFolder

Add workspace folder

Type: -null or string

Default: -"<leader>lwa"

Declared by:

+
+ +
+
+
+ + vim.lsp.mappings.addWorkspaceFolder + + +
+
+

Add workspace folder

+ +

Type: +null or string

+ +

Default: +"<leader>lwa"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/module.nix> -
vim.lsp.mappings.codeAction

Code action

Type: -null or string

Default: -"<leader>la"

Declared by:

+
+ +
+
+
+ + vim.lsp.mappings.codeAction + + +
+
+

Code action

+ +

Type: +null or string

+ +

Default: +"<leader>la"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/module.nix> -
vim.lsp.mappings.documentHighlight

Document highlight

Type: -null or string

Default: -"<leader>lH"

Declared by:

+
+ +
+
+
+ + vim.lsp.mappings.documentHighlight + + +
+
+

Document highlight

+ +

Type: +null or string

+ +

Default: +"<leader>lH"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/module.nix> -
vim.lsp.mappings.format

Format

Type: -null or string

Default: -"<leader>lf"

Declared by:

+
+ +
+
+
+ + vim.lsp.mappings.format + + +
+
+

Format

+ +

Type: +null or string

+ +

Default: +"<leader>lf"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/module.nix> -
vim.lsp.mappings.goToDeclaration

Go to declaration

Type: -null or string

Default: -"<leader>lgD"

Declared by:

+
+ +
+
+
+ + vim.lsp.mappings.goToDeclaration + + +
+
+

Go to declaration

+ +

Type: +null or string

+ +

Default: +"<leader>lgD"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/module.nix> -
vim.lsp.mappings.goToDefinition

Go to definition

Type: -null or string

Default: -"<leader>lgd"

Declared by:

+
+ +
+
+
+ + vim.lsp.mappings.goToDefinition + + +
+
+

Go to definition

+ +

Type: +null or string

+ +

Default: +"<leader>lgd"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/module.nix> -
vim.lsp.mappings.goToType

Go to type

Type: -null or string

Default: -"<leader>lgt"

Declared by:

+
+ +
+
+
+ + vim.lsp.mappings.goToType + + +
+
+

Go to type

+ +

Type: +null or string

+ +

Default: +"<leader>lgt"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/module.nix> -
vim.lsp.mappings.hover

Trigger hover

Type: -null or string

Default: -"<leader>lh"

Declared by:

+
+ +
+
+
+ + vim.lsp.mappings.hover + + +
+
+

Trigger hover

+ +

Type: +null or string

+ +

Default: +"<leader>lh"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/module.nix> -
vim.lsp.mappings.listDocumentSymbols

List document symbols

Type: -null or string

Default: -"<leader>lS"

Declared by:

+
+ +
+
+
+ + vim.lsp.mappings.listDocumentSymbols + + +
+
+

List document symbols

+ +

Type: +null or string

+ +

Default: +"<leader>lS"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/module.nix> -
vim.lsp.mappings.listImplementations

List implementations

Type: -null or string

Default: -"<leader>lgi"

Declared by:

+
+ +
+
+
+ + vim.lsp.mappings.listImplementations + + +
+
+

List implementations

+ +

Type: +null or string

+ +

Default: +"<leader>lgi"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/module.nix> -
vim.lsp.mappings.listReferences

List references

Type: -null or string

Default: -"<leader>lgr"

Declared by:

+
+ +
+
+
+ + vim.lsp.mappings.listReferences + + +
+
+

List references

+ +

Type: +null or string

+ +

Default: +"<leader>lgr"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/module.nix> -
vim.lsp.mappings.listWorkspaceFolders

List workspace folders

Type: -null or string

Default: -"<leader>lwl"

Declared by:

+
+ +
+
+
+ + vim.lsp.mappings.listWorkspaceFolders + + +
+
+

List workspace folders

+ +

Type: +null or string

+ +

Default: +"<leader>lwl"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/module.nix> -
vim.lsp.mappings.listWorkspaceSymbols

List workspace symbols

Type: -null or string

Default: -"<leader>lws"

Declared by:

+
+ +
+
+
+ + vim.lsp.mappings.listWorkspaceSymbols + + +
+
+

List workspace symbols

+ +

Type: +null or string

+ +

Default: +"<leader>lws"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/module.nix> -
vim.lsp.mappings.nextDiagnostic

Go to next diagnostic

Type: -null or string

Default: -"<leader>lgn"

Declared by:

+
+ +
+
+
+ + vim.lsp.mappings.nextDiagnostic + + +
+
+

Go to next diagnostic

+ +

Type: +null or string

+ +

Default: +"<leader>lgn"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/module.nix> -
vim.lsp.mappings.openDiagnosticFloat

Open diagnostic float

Type: -null or string

Default: -"<leader>le"

Declared by:

+
+ +
+
+
+ + vim.lsp.mappings.openDiagnosticFloat + + +
+
+

Open diagnostic float

+ +

Type: +null or string

+ +

Default: +"<leader>le"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/module.nix> -
vim.lsp.mappings.previousDiagnostic

Go to previous diagnostic

Type: -null or string

Default: -"<leader>lgp"

Declared by:

+
+ +
+
+
+ + vim.lsp.mappings.previousDiagnostic + + +
+
+

Go to previous diagnostic

+ +

Type: +null or string

+ +

Default: +"<leader>lgp"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/module.nix> -
vim.lsp.mappings.removeWorkspaceFolder

Remove workspace folder

Type: -null or string

Default: -"<leader>lwr"

Declared by:

+
+ +
+
+
+ + vim.lsp.mappings.removeWorkspaceFolder + + +
+
+

Remove workspace folder

+ +

Type: +null or string

+ +

Default: +"<leader>lwr"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/module.nix> -
vim.lsp.mappings.renameSymbol

Rename symbol

Type: -null or string

Default: -"<leader>ln"

Declared by:

+
+ +
+
+
+ + vim.lsp.mappings.renameSymbol + + +
+
+

Rename symbol

+ +

Type: +null or string

+ +

Default: +"<leader>ln"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/module.nix> -
vim.lsp.mappings.signatureHelp

Signature help

Type: -null or string

Default: -"<leader>ls"

Declared by:

+
+ +
+
+
+ + vim.lsp.mappings.signatureHelp + + +
+
+

Signature help

+ +

Type: +null or string

+ +

Default: +"<leader>ls"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/module.nix> -
vim.lsp.mappings.toggleFormatOnSave

Toggle format on save

Type: -null or string

Default: -"<leader>ltf"

Declared by:

+
+ +
+
+
+ + vim.lsp.mappings.toggleFormatOnSave + + +
+
+

Toggle format on save

+ +

Type: +null or string

+ +

Default: +"<leader>ltf"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/module.nix> -
vim.lsp.null-ls.enable

Whether to enable null-ls, also enabled automatically.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.lsp.null-ls.enable + + +
+
+

Whether to enable null-ls, also enabled automatically.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/null-ls/null-ls.nix> -
vim.lsp.null-ls.sources

null-ls sources

Type: -attribute set of string

Default: -{ }

Declared by:

+
+ +
+
+
+ + vim.lsp.null-ls.sources + + +
+
+

null-ls sources

+ +

Type: +attribute set of string

+ +

Default: +{ }

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/null-ls/null-ls.nix> -
vim.lsp.nvim-docs-view.enable

Whether to enable nvim-docs-view, for displaying lsp hover documentation in a side panel…

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.lsp.nvim-docs-view.enable + + +
+
+

Whether to enable nvim-docs-view, for displaying lsp hover documentation in a side panel…

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/nvim-docs-view/nvim-docs-view.nix> -
vim.lsp.nvim-docs-view.height

Height of the docs view panel if the position is set to either top or bottom

Type: -signed integer

Default: -10

Declared by:

+
+ +
+
+
+ + vim.lsp.nvim-docs-view.height + + +
+
+

Height of the docs view panel if the position is set to either top or bottom

+ +

Type: +signed integer

+ +

Default: +10

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/nvim-docs-view/nvim-docs-view.nix> -
vim.lsp.nvim-docs-view.mappings.viewToggle

Open or close the docs view panel

Type: -null or string

Default: -"lvt"

Declared by:

+
+ +
+
+
+ + vim.lsp.nvim-docs-view.mappings.viewToggle + + +
+
+

Open or close the docs view panel

+ +

Type: +null or string

+ +

Default: +"lvt"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/nvim-docs-view/nvim-docs-view.nix> -
vim.lsp.nvim-docs-view.mappings.viewUpdate

Manually update the docs view panel

Type: -null or string

Default: -"lvu"

Declared by:

+
+ +
+
+
+ + vim.lsp.nvim-docs-view.mappings.viewUpdate + + +
+
+

Manually update the docs view panel

+ +

Type: +null or string

+ +

Default: +"lvu"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/nvim-docs-view/nvim-docs-view.nix> -
vim.lsp.nvim-docs-view.position

Where to open the docs view panel

Type: -one of “left”, “right”, “top”, “bottom”

Default: -"right"

Declared by:

+
+ +
+
+
+ + vim.lsp.nvim-docs-view.position + + +
+
+

Where to open the docs view panel

+ +

Type: +one of “left”, “right”, “top”, “bottom”

+ +

Default: +"right"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/nvim-docs-view/nvim-docs-view.nix> -
vim.lsp.nvim-docs-view.updateMode

Determines the mechanism used to update the docs view panel content.

  • If auto, the content will update upon cursor move.

  • If manual, the content will only update once :DocsViewUpdate is called

Type: -one of “auto”, “manual”

Default: -"auto"

Declared by:

+
+ +
+
+
+ + vim.lsp.nvim-docs-view.updateMode + + +
+
+

Determines the mechanism used to update the docs view panel content.

  • If auto, the content will update upon cursor move.

  • If manual, the content will only update once :DocsViewUpdate is called

+ +

Type: +one of “auto”, “manual”

+ +

Default: +"auto"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/nvim-docs-view/nvim-docs-view.nix> -
vim.lsp.nvim-docs-view.width

Width of the docs view panel if the position is set to either left or right

Type: -signed integer

Default: -60

Declared by:

+
+ +
+
+
+ + vim.lsp.nvim-docs-view.width + + +
+
+

Width of the docs view panel if the position is set to either left or right

+ +

Type: +signed integer

+ +

Default: +60

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/nvim-docs-view/nvim-docs-view.nix> -
vim.lsp.nvimCodeActionMenu.enable

Whether to enable nvim code action menu.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.lsp.nvimCodeActionMenu.enable + + +
+
+

Whether to enable nvim code action menu.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/nvim-code-action-menu/nvim-code-action-menu.nix> -
vim.lsp.nvimCodeActionMenu.mappings.open

Open code action menu [nvim-code-action-menu]

Type: -null or string

Default: -"<leader>ca"

Declared by:

+
+ +
+
+
+ + vim.lsp.nvimCodeActionMenu.mappings.open + + +
+
+

Open code action menu [nvim-code-action-menu]

+ +

Type: +null or string

+ +

Default: +"<leader>ca"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/nvim-code-action-menu/nvim-code-action-menu.nix> -
vim.lsp.nvimCodeActionMenu.show.actionKind

Whether to enable Show action kind.

Type: -boolean

Default: -true

Example: -true

Declared by:

+
+ +
+
+
+ + vim.lsp.nvimCodeActionMenu.show.actionKind + + +
+
+

Whether to enable Show action kind.

+ +

Type: +boolean

+ +

Default: +true

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/nvim-code-action-menu/nvim-code-action-menu.nix> -
vim.lsp.nvimCodeActionMenu.show.details

Whether to enable Show details.

Type: -boolean

Default: -true

Example: -true

Declared by:

+
+ +
+
+
+ + vim.lsp.nvimCodeActionMenu.show.details + + +
+
+

Whether to enable Show details.

+ +

Type: +boolean

+ +

Default: +true

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/nvim-code-action-menu/nvim-code-action-menu.nix> -
vim.lsp.nvimCodeActionMenu.show.diff

Whether to enable Show diff.

Type: -boolean

Default: -true

Example: -true

Declared by:

+
+ +
+
+
+ + vim.lsp.nvimCodeActionMenu.show.diff + + +
+
+

Whether to enable Show diff.

+ +

Type: +boolean

+ +

Default: +true

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/nvim-code-action-menu/nvim-code-action-menu.nix> -
vim.lsp.trouble.enable

Whether to enable trouble diagnostics viewer.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.lsp.trouble.enable + + +
+
+

Whether to enable trouble diagnostics viewer.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/trouble/trouble.nix> -
vim.lsp.trouble.mappings.documentDiagnostics

Document diagnostics [trouble]

Type: -null or string

Default: -"<leader>ld"

Declared by:

+
+ +
+
+
+ + vim.lsp.trouble.mappings.documentDiagnostics + + +
+
+

Document diagnostics [trouble]

+ +

Type: +null or string

+ +

Default: +"<leader>ld"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/trouble/trouble.nix> -
vim.lsp.trouble.mappings.locList

LOCList [trouble]

Type: -null or string

Default: -"<leader>xl"

Declared by:

+
+ +
+
+
+ + vim.lsp.trouble.mappings.locList + + +
+
+

LOCList [trouble]

+ +

Type: +null or string

+ +

Default: +"<leader>xl"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/trouble/trouble.nix> -
vim.lsp.trouble.mappings.lspReferences

LSP References [trouble]

Type: -null or string

Default: -"<leader>lr"

Declared by:

+
+ +
+
+
+ + vim.lsp.trouble.mappings.lspReferences + + +
+
+

LSP References [trouble]

+ +

Type: +null or string

+ +

Default: +"<leader>lr"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/trouble/trouble.nix> -
vim.lsp.trouble.mappings.quickfix

QuickFix [trouble]

Type: -null or string

Default: -"<leader>xq"

Declared by:

+
+ +
+
+
+ + vim.lsp.trouble.mappings.quickfix + + +
+
+

QuickFix [trouble]

+ +

Type: +null or string

+ +

Default: +"<leader>xq"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/trouble/trouble.nix> -
vim.lsp.trouble.mappings.toggle

Toggle trouble [trouble]

Type: -null or string

Default: -"<leader>xx"

Declared by:

+
+ +
+
+
+ + vim.lsp.trouble.mappings.toggle + + +
+
+

Toggle trouble [trouble]

+ +

Type: +null or string

+ +

Default: +"<leader>xx"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/trouble/trouble.nix> -
vim.lsp.trouble.mappings.workspaceDiagnostics

Workspace diagnostics [trouble]

Type: -null or string

Default: -"<leader>lwd"

Declared by:

+
+ +
+
+
+ + vim.lsp.trouble.mappings.workspaceDiagnostics + + +
+
+

Workspace diagnostics [trouble]

+ +

Type: +null or string

+ +

Default: +"<leader>lwd"

+ +

Declared by:

+ +
+ <neovim-flake/modules/lsp/trouble/trouble.nix> -
vim.luaConfigRC

vim lua config

Type: -(DAG of strings concatenated with “\n”) or string

Default: -{ }

Declared by:

+
+ +
+
+
+ + vim.luaConfigRC + + +
+
+

vim lua config

+ +

Type: +(DAG of strings concatenated with “\n”) or string

+ +

Default: +{ }

+ +

Declared by:

+ +
+ <neovim-flake/modules/core> -
vim.mapLeaderSpace

Map the space key to leader key

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.mapLeaderSpace + + +
+
+

Map the space key to leader key

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.mapTimeout

Timeout in ms that neovim will wait for mapped action to complete

Type: -signed integer

Default: -500

Declared by:

+
+ +
+
+
+ + vim.mapTimeout + + +
+
+

Timeout in ms that neovim will wait for mapped action to complete

+ +

Type: +signed integer

+ +

Default: +500

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.maps

Custom keybindings for any mode.

For plain maps (e.g. just ‘map’ or ‘remap’) use maps.normalVisualOp.

Type: -submodule

Default: -{ }

Example:

''
+
+
+
+
+ + vim.maps + + +
+
+

Custom keybindings for any mode.

For plain maps (e.g. just ‘map’ or ‘remap’) use maps.normalVisualOp.

+ +

Type: +submodule

+ +

Default: +{ }

+ +

Example:

''
   maps = {
-    normal."<leader>m" = {
+    normal."<leader>m" = {
       silent = true;
-      action = "<cmd>make<CR>";
+      action = "<cmd>make<CR>";
     }; # Same as nnoremap <leader>m <silent> <cmd>make<CR>
   };
-''
-

Declared by:

-<neovim-flake/modules/core> -
vim.maps.command

Mappings for command-line mode

Type: -attribute set of (submodule)

Default: -{ }

Declared by:

-<neovim-flake/modules/core> -
vim.maps.command.<name>.action

The action to execute.

Type: -string

Declared by:

-<neovim-flake/modules/core> -
vim.maps.command.<name>.desc

A description of this keybind, to be shown in which-key, if you have it enabled.

Type: -null or string

Default: -null

Declared by:

-<neovim-flake/modules/core> -
vim.maps.command.<name>.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.command.<name>.lua

If true, action is considered to be lua code. -Thus, it will not be wrapped in "".

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.command.<name>.noremap

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.

Type: -boolean

Default: -true

Declared by:

-<neovim-flake/modules/core> -
vim.maps.command.<name>.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.command.<name>.script

Equivalent to adding <script> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.command.<name>.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.command.<name>.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.insert

Mappings for insert mode

Type: -attribute set of (submodule)

Default: -{ }

Declared by:

-<neovim-flake/modules/core> -
vim.maps.insert.<name>.action

The action to execute.

Type: -string

Declared by:

-<neovim-flake/modules/core> -
vim.maps.insert.<name>.desc

A description of this keybind, to be shown in which-key, if you have it enabled.

Type: -null or string

Default: -null

Declared by:

-<neovim-flake/modules/core> -
vim.maps.insert.<name>.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.insert.<name>.lua

If true, action is considered to be lua code. -Thus, it will not be wrapped in "".

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.insert.<name>.noremap

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.

Type: -boolean

Default: -true

Declared by:

-<neovim-flake/modules/core> -
vim.maps.insert.<name>.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.insert.<name>.script

Equivalent to adding <script> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.insert.<name>.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.insert.<name>.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.insertCommand

Mappings for insert and command-line mode

Type: -attribute set of (submodule)

Default: -{ }

Declared by:

-<neovim-flake/modules/core> -
vim.maps.insertCommand.<name>.action

The action to execute.

Type: -string

Declared by:

-<neovim-flake/modules/core> -
vim.maps.insertCommand.<name>.desc

A description of this keybind, to be shown in which-key, if you have it enabled.

Type: -null or string

Default: -null

Declared by:

-<neovim-flake/modules/core> -
vim.maps.insertCommand.<name>.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.insertCommand.<name>.lua

If true, action is considered to be lua code. -Thus, it will not be wrapped in "".

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.insertCommand.<name>.noremap

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.

Type: -boolean

Default: -true

Declared by:

-<neovim-flake/modules/core> -
vim.maps.insertCommand.<name>.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.insertCommand.<name>.script

Equivalent to adding <script> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.insertCommand.<name>.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.insertCommand.<name>.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.lang

Mappings for insert, command-line and lang-arg mode

Type: -attribute set of (submodule)

Default: -{ }

Declared by:

-<neovim-flake/modules/core> -
vim.maps.lang.<name>.action

The action to execute.

Type: -string

Declared by:

-<neovim-flake/modules/core> -
vim.maps.lang.<name>.desc

A description of this keybind, to be shown in which-key, if you have it enabled.

Type: -null or string

Default: -null

Declared by:

-<neovim-flake/modules/core> -
vim.maps.lang.<name>.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.lang.<name>.lua

If true, action is considered to be lua code. -Thus, it will not be wrapped in "".

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.lang.<name>.noremap

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.

Type: -boolean

Default: -true

Declared by:

-<neovim-flake/modules/core> -
vim.maps.lang.<name>.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.lang.<name>.script

Equivalent to adding <script> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.lang.<name>.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.lang.<name>.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.normal

Mappings for normal mode

Type: -attribute set of (submodule)

Default: -{ }

Declared by:

-<neovim-flake/modules/core> -
vim.maps.normal.<name>.action

The action to execute.

Type: -string

Declared by:

-<neovim-flake/modules/core> -
vim.maps.normal.<name>.desc

A description of this keybind, to be shown in which-key, if you have it enabled.

Type: -null or string

Default: -null

Declared by:

-<neovim-flake/modules/core> -
vim.maps.normal.<name>.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.normal.<name>.lua

If true, action is considered to be lua code. -Thus, it will not be wrapped in "".

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.normal.<name>.noremap

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.

Type: -boolean

Default: -true

Declared by:

-<neovim-flake/modules/core> -
vim.maps.normal.<name>.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.normal.<name>.script

Equivalent to adding <script> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.normal.<name>.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.normal.<name>.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.normalVisualOp

Mappings for normal, visual, select and operator-pending (same as plain ‘map’) mode

Type: -attribute set of (submodule)

Default: -{ }

Declared by:

-<neovim-flake/modules/core> -
vim.maps.normalVisualOp.<name>.action

The action to execute.

Type: -string

Declared by:

-<neovim-flake/modules/core> -
vim.maps.normalVisualOp.<name>.desc

A description of this keybind, to be shown in which-key, if you have it enabled.

Type: -null or string

Default: -null

Declared by:

-<neovim-flake/modules/core> -
vim.maps.normalVisualOp.<name>.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.normalVisualOp.<name>.lua

If true, action is considered to be lua code. -Thus, it will not be wrapped in "".

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.normalVisualOp.<name>.noremap

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.

Type: -boolean

Default: -true

Declared by:

-<neovim-flake/modules/core> -
vim.maps.normalVisualOp.<name>.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.normalVisualOp.<name>.script

Equivalent to adding <script> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.normalVisualOp.<name>.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.normalVisualOp.<name>.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.operator

Mappings for operator-pending mode

Type: -attribute set of (submodule)

Default: -{ }

Declared by:

-<neovim-flake/modules/core> -
vim.maps.operator.<name>.action

The action to execute.

Type: -string

Declared by:

-<neovim-flake/modules/core> -
vim.maps.operator.<name>.desc

A description of this keybind, to be shown in which-key, if you have it enabled.

Type: -null or string

Default: -null

Declared by:

-<neovim-flake/modules/core> -
vim.maps.operator.<name>.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.operator.<name>.lua

If true, action is considered to be lua code. -Thus, it will not be wrapped in "".

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.operator.<name>.noremap

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.

Type: -boolean

Default: -true

Declared by:

-<neovim-flake/modules/core> -
vim.maps.operator.<name>.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.operator.<name>.script

Equivalent to adding <script> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.operator.<name>.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.operator.<name>.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.select

Mappings for select mode

Type: -attribute set of (submodule)

Default: -{ }

Declared by:

-<neovim-flake/modules/core> -
vim.maps.select.<name>.action

The action to execute.

Type: -string

Declared by:

-<neovim-flake/modules/core> -
vim.maps.select.<name>.desc

A description of this keybind, to be shown in which-key, if you have it enabled.

Type: -null or string

Default: -null

Declared by:

-<neovim-flake/modules/core> -
vim.maps.select.<name>.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.select.<name>.lua

If true, action is considered to be lua code. -Thus, it will not be wrapped in "".

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.select.<name>.noremap

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.

Type: -boolean

Default: -true

Declared by:

-<neovim-flake/modules/core> -
vim.maps.select.<name>.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.select.<name>.script

Equivalent to adding <script> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.select.<name>.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.select.<name>.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.terminal

Mappings for terminal mode

Type: -attribute set of (submodule)

Default: -{ }

Declared by:

-<neovim-flake/modules/core> -
vim.maps.terminal.<name>.action

The action to execute.

Type: -string

Declared by:

-<neovim-flake/modules/core> -
vim.maps.terminal.<name>.desc

A description of this keybind, to be shown in which-key, if you have it enabled.

Type: -null or string

Default: -null

Declared by:

-<neovim-flake/modules/core> -
vim.maps.terminal.<name>.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.terminal.<name>.lua

If true, action is considered to be lua code. -Thus, it will not be wrapped in "".

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.terminal.<name>.noremap

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.

Type: -boolean

Default: -true

Declared by:

-<neovim-flake/modules/core> -
vim.maps.terminal.<name>.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.terminal.<name>.script

Equivalent to adding <script> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.terminal.<name>.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.terminal.<name>.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.visual

Mappings for visual and select mode

Type: -attribute set of (submodule)

Default: -{ }

Declared by:

-<neovim-flake/modules/core> -
vim.maps.visual.<name>.action

The action to execute.

Type: -string

Declared by:

-<neovim-flake/modules/core> -
vim.maps.visual.<name>.desc

A description of this keybind, to be shown in which-key, if you have it enabled.

Type: -null or string

Default: -null

Declared by:

-<neovim-flake/modules/core> -
vim.maps.visual.<name>.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.visual.<name>.lua

If true, action is considered to be lua code. -Thus, it will not be wrapped in "".

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.visual.<name>.noremap

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.

Type: -boolean

Default: -true

Declared by:

-<neovim-flake/modules/core> -
vim.maps.visual.<name>.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.visual.<name>.script

Equivalent to adding <script> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.visual.<name>.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.visual.<name>.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.visualOnly

Mappings for visual only mode

Type: -attribute set of (submodule)

Default: -{ }

Declared by:

-<neovim-flake/modules/core> -
vim.maps.visualOnly.<name>.action

The action to execute.

Type: -string

Declared by:

-<neovim-flake/modules/core> -
vim.maps.visualOnly.<name>.desc

A description of this keybind, to be shown in which-key, if you have it enabled.

Type: -null or string

Default: -null

Declared by:

-<neovim-flake/modules/core> -
vim.maps.visualOnly.<name>.expr

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.visualOnly.<name>.lua

If true, action is considered to be lua code. -Thus, it will not be wrapped in "".

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.visualOnly.<name>.noremap

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.

Type: -boolean

Default: -true

Declared by:

-<neovim-flake/modules/core> -
vim.maps.visualOnly.<name>.nowait

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.visualOnly.<name>.script

Equivalent to adding <script> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.visualOnly.<name>.silent

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.maps.visualOnly.<name>.unique

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

Type: -boolean

Default: -false

Declared by:

-<neovim-flake/modules/core> -
vim.minimap.codewindow.enable

Whether to enable codewindow plugin for minimap view.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+'' + + +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+ +
+ + vim.maps.command + + +
+
+

Mappings for command-line mode

+ +

Type: +attribute set of (submodule)

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.command.<name>.action + + +
+
+

The action to execute.

+ +

Type: +string

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.command.<name>.desc + + +
+
+

A description of this keybind, to be shown in which-key, if you have it enabled.

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.command.<name>.expr + + +
+
+

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.command.<name>.lua + + +
+
+

If true, action is considered to be lua code. +Thus, it will not be wrapped in "".

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.command.<name>.noremap + + +
+
+

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.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.command.<name>.nowait + + +
+
+

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.command.<name>.script + + +
+
+

Equivalent to adding <script> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.command.<name>.silent + + +
+
+

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.command.<name>.unique + + +
+
+

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.insert + + +
+
+

Mappings for insert mode

+ +

Type: +attribute set of (submodule)

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.insert.<name>.action + + +
+
+

The action to execute.

+ +

Type: +string

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.insert.<name>.desc + + +
+
+

A description of this keybind, to be shown in which-key, if you have it enabled.

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.insert.<name>.expr + + +
+
+

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.insert.<name>.lua + + +
+
+

If true, action is considered to be lua code. +Thus, it will not be wrapped in "".

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.insert.<name>.noremap + + +
+
+

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.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.insert.<name>.nowait + + +
+
+

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.insert.<name>.script + + +
+
+

Equivalent to adding <script> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.insert.<name>.silent + + +
+
+

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.insert.<name>.unique + + +
+
+

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.insertCommand + + +
+
+

Mappings for insert and command-line mode

+ +

Type: +attribute set of (submodule)

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.insertCommand.<name>.action + + +
+
+

The action to execute.

+ +

Type: +string

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.insertCommand.<name>.desc + + +
+
+

A description of this keybind, to be shown in which-key, if you have it enabled.

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.insertCommand.<name>.expr + + +
+
+

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.insertCommand.<name>.lua + + +
+
+

If true, action is considered to be lua code. +Thus, it will not be wrapped in "".

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.insertCommand.<name>.noremap + + +
+
+

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.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.insertCommand.<name>.nowait + + +
+
+

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.insertCommand.<name>.script + + +
+
+

Equivalent to adding <script> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.insertCommand.<name>.silent + + +
+
+

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.insertCommand.<name>.unique + + +
+
+

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.lang + + +
+
+

Mappings for insert, command-line and lang-arg mode

+ +

Type: +attribute set of (submodule)

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.lang.<name>.action + + +
+
+

The action to execute.

+ +

Type: +string

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.lang.<name>.desc + + +
+
+

A description of this keybind, to be shown in which-key, if you have it enabled.

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.lang.<name>.expr + + +
+
+

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.lang.<name>.lua + + +
+
+

If true, action is considered to be lua code. +Thus, it will not be wrapped in "".

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.lang.<name>.noremap + + +
+
+

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.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.lang.<name>.nowait + + +
+
+

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.lang.<name>.script + + +
+
+

Equivalent to adding <script> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.lang.<name>.silent + + +
+
+

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.lang.<name>.unique + + +
+
+

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.normal + + +
+
+

Mappings for normal mode

+ +

Type: +attribute set of (submodule)

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.normal.<name>.action + + +
+
+

The action to execute.

+ +

Type: +string

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.normal.<name>.desc + + +
+
+

A description of this keybind, to be shown in which-key, if you have it enabled.

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.normal.<name>.expr + + +
+
+

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.normal.<name>.lua + + +
+
+

If true, action is considered to be lua code. +Thus, it will not be wrapped in "".

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.normal.<name>.noremap + + +
+
+

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.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.normal.<name>.nowait + + +
+
+

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.normal.<name>.script + + +
+
+

Equivalent to adding <script> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.normal.<name>.silent + + +
+
+

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.normal.<name>.unique + + +
+
+

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.normalVisualOp + + +
+
+

Mappings for normal, visual, select and operator-pending (same as plain ‘map’) mode

+ +

Type: +attribute set of (submodule)

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.normalVisualOp.<name>.action + + +
+
+

The action to execute.

+ +

Type: +string

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.normalVisualOp.<name>.desc + + +
+
+

A description of this keybind, to be shown in which-key, if you have it enabled.

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.normalVisualOp.<name>.expr + + +
+
+

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.normalVisualOp.<name>.lua + + +
+
+

If true, action is considered to be lua code. +Thus, it will not be wrapped in "".

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.normalVisualOp.<name>.noremap + + +
+
+

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.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.normalVisualOp.<name>.nowait + + +
+
+

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.normalVisualOp.<name>.script + + +
+
+

Equivalent to adding <script> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.normalVisualOp.<name>.silent + + +
+
+

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.normalVisualOp.<name>.unique + + +
+
+

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.operator + + +
+
+

Mappings for operator-pending mode

+ +

Type: +attribute set of (submodule)

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.operator.<name>.action + + +
+
+

The action to execute.

+ +

Type: +string

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.operator.<name>.desc + + +
+
+

A description of this keybind, to be shown in which-key, if you have it enabled.

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.operator.<name>.expr + + +
+
+

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.operator.<name>.lua + + +
+
+

If true, action is considered to be lua code. +Thus, it will not be wrapped in "".

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.operator.<name>.noremap + + +
+
+

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.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.operator.<name>.nowait + + +
+
+

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.operator.<name>.script + + +
+
+

Equivalent to adding <script> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.operator.<name>.silent + + +
+
+

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.operator.<name>.unique + + +
+
+

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.select + + +
+
+

Mappings for select mode

+ +

Type: +attribute set of (submodule)

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.select.<name>.action + + +
+
+

The action to execute.

+ +

Type: +string

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.select.<name>.desc + + +
+
+

A description of this keybind, to be shown in which-key, if you have it enabled.

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.select.<name>.expr + + +
+
+

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.select.<name>.lua + + +
+
+

If true, action is considered to be lua code. +Thus, it will not be wrapped in "".

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.select.<name>.noremap + + +
+
+

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.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.select.<name>.nowait + + +
+
+

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.select.<name>.script + + +
+
+

Equivalent to adding <script> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.select.<name>.silent + + +
+
+

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.select.<name>.unique + + +
+
+

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.terminal + + +
+
+

Mappings for terminal mode

+ +

Type: +attribute set of (submodule)

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.terminal.<name>.action + + +
+
+

The action to execute.

+ +

Type: +string

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.terminal.<name>.desc + + +
+
+

A description of this keybind, to be shown in which-key, if you have it enabled.

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.terminal.<name>.expr + + +
+
+

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.terminal.<name>.lua + + +
+
+

If true, action is considered to be lua code. +Thus, it will not be wrapped in "".

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.terminal.<name>.noremap + + +
+
+

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.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.terminal.<name>.nowait + + +
+
+

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.terminal.<name>.script + + +
+
+

Equivalent to adding <script> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.terminal.<name>.silent + + +
+
+

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.terminal.<name>.unique + + +
+
+

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.visual + + +
+
+

Mappings for visual and select mode

+ +

Type: +attribute set of (submodule)

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.visual.<name>.action + + +
+
+

The action to execute.

+ +

Type: +string

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.visual.<name>.desc + + +
+
+

A description of this keybind, to be shown in which-key, if you have it enabled.

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.visual.<name>.expr + + +
+
+

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.visual.<name>.lua + + +
+
+

If true, action is considered to be lua code. +Thus, it will not be wrapped in "".

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.visual.<name>.noremap + + +
+
+

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.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.visual.<name>.nowait + + +
+
+

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.visual.<name>.script + + +
+
+

Equivalent to adding <script> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.visual.<name>.silent + + +
+
+

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.visual.<name>.unique + + +
+
+

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.visualOnly + + +
+
+

Mappings for visual only mode

+ +

Type: +attribute set of (submodule)

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.visualOnly.<name>.action + + +
+
+

The action to execute.

+ +

Type: +string

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.visualOnly.<name>.desc + + +
+
+

A description of this keybind, to be shown in which-key, if you have it enabled.

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.visualOnly.<name>.expr + + +
+
+

Means that the action is actually an expression. Equivalent to adding <expr> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.visualOnly.<name>.lua + + +
+
+

If true, action is considered to be lua code. +Thus, it will not be wrapped in "".

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.visualOnly.<name>.noremap + + +
+
+

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.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.visualOnly.<name>.nowait + + +
+
+

Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.visualOnly.<name>.script + + +
+
+

Equivalent to adding <script> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.visualOnly.<name>.silent + + +
+
+

Whether this mapping should be silent. Equivalent to adding <silent> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.maps.visualOnly.<name>.unique + + +
+
+

Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/core> + +
+
+
+ + vim.minimap.codewindow.enable + + +
+
+

Whether to enable codewindow plugin for minimap view.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/minimap/codewindow/codewindow.nix> -
vim.minimap.codewindow.mappings.close

Close minimap [codewindow]

Type: -null or string

Default: -"<leader>mc"

Declared by:

+
+ +
+
+
+ + vim.minimap.codewindow.mappings.close + + +
+
+

Close minimap [codewindow]

+ +

Type: +null or string

+ +

Default: +"<leader>mc"

+ +

Declared by:

+ +
+ <neovim-flake/modules/minimap/codewindow/codewindow.nix> -
vim.minimap.codewindow.mappings.open

Open minimap [codewindow]

Type: -null or string

Default: -"<leader>mo"

Declared by:

+
+ +
+
+
+ + vim.minimap.codewindow.mappings.open + + +
+
+

Open minimap [codewindow]

+ +

Type: +null or string

+ +

Default: +"<leader>mo"

+ +

Declared by:

+ +
+ <neovim-flake/modules/minimap/codewindow/codewindow.nix> -
vim.minimap.codewindow.mappings.toggle

Toggle minimap [codewindow]

Type: -null or string

Default: -"<leader>mm"

Declared by:

+
+ +
+
+
+ + vim.minimap.codewindow.mappings.toggle + + +
+
+

Toggle minimap [codewindow]

+ +

Type: +null or string

+ +

Default: +"<leader>mm"

+ +

Declared by:

+ +
+ <neovim-flake/modules/minimap/codewindow/codewindow.nix> -
vim.minimap.codewindow.mappings.toggleFocus

Toggle minimap focus [codewindow]

Type: -null or string

Default: -"<leader>mf"

Declared by:

+
+ +
+
+
+ + vim.minimap.codewindow.mappings.toggleFocus + + +
+
+

Toggle minimap focus [codewindow]

+ +

Type: +null or string

+ +

Default: +"<leader>mf"

+ +

Declared by:

+ +
+ <neovim-flake/modules/minimap/codewindow/codewindow.nix> -
vim.minimap.minimap-vim.enable

Whether to enable minimap-vim plugin for minimap view.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.minimap.minimap-vim.enable + + +
+
+

Whether to enable minimap-vim plugin for minimap view.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/minimap/minimap-vim/minimap-vim.nix> -
vim.mouseSupport

Set modes for mouse support. a - all, n - normal, v - visual, i - insert, c - command

Type: -one of “a”, “n”, “v”, “i”, “c”

Default: -"a"

Declared by:

+
+ +
+
+
+ + vim.mouseSupport + + +
+
+

Set modes for mouse support. a - all, n - normal, v - visual, i - insert, c - command

+ +

Type: +one of “a”, “n”, “v”, “i”, “c”

+ +

Default: +"a"

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.notes.mind-nvim.enable

Whether to enable organizer tool for Neovim…

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.notes.mind-nvim.enable + + +
+
+

Whether to enable organizer tool for Neovim…

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/notes/mind-nvim/mind-nvim.nix> -
vim.notes.obsidian.enable

Whether to enable complementary neovim plugins for Obsidian editor.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.notes.obsidian.enable + + +
+
+

Whether to enable complementary neovim plugins for Obsidian editor.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/notes/obsidian/obsidian.nix> -
vim.notes.obsidian.completion.nvim_cmp

If using nvim-cmp, otherwise set to false

Type: -boolean

Declared by:

+
+ +
+
+
+ + vim.notes.obsidian.completion.nvim_cmp + + +
+
+

If using nvim-cmp, otherwise set to false

+ +

Type: +boolean

+ +

Declared by:

+ +
+ <neovim-flake/modules/notes/obsidian/obsidian.nix> -
vim.notes.obsidian.daily-notes.date-format

Date format used for creating daily notes

Type: -string

Default: -""

Declared by:

+
+ +
+
+
+ + vim.notes.obsidian.daily-notes.date-format + + +
+
+

Date format used for creating daily notes

+ +

Type: +string

+ +

Default: +""

+ +

Declared by:

+ +
+ <neovim-flake/modules/notes/obsidian/obsidian.nix> -
vim.notes.obsidian.daily-notes.folder

Directory in which daily notes should be created

Type: -string

Default: -""

Declared by:

+
+ +
+
+
+ + vim.notes.obsidian.daily-notes.folder + + +
+
+

Directory in which daily notes should be created

+ +

Type: +string

+ +

Default: +""

+ +

Declared by:

+ +
+ <neovim-flake/modules/notes/obsidian/obsidian.nix> -
vim.notes.obsidian.dir

Obsidian vault directory

Type: -string

Default: -"~/my-vault"

Declared by:

+
+ +
+
+
+ + vim.notes.obsidian.dir + + +
+
+

Obsidian vault directory

+ +

Type: +string

+ +

Default: +"~/my-vault"

+ +

Declared by:

+ +
+ <neovim-flake/modules/notes/obsidian/obsidian.nix> -
vim.notes.orgmode.enable

Whether to enable nvim-orgmode: Neovim plugin for Emac Orgmode. Get the best of both worlds.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.notes.orgmode.enable + + +
+
+

Whether to enable nvim-orgmode: Neovim plugin for Emac Orgmode. Get the best of both worlds.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/notes/orgmode/orgmode.nix> -
vim.notes.orgmode.orgAgendaFiles

List of org files to be used as agenda files.

Type: -string

Default: -"{'~/Documents/org/*', '~/my-orgs/**/*'}"

Declared by:

+
+ +
+
+
+ + vim.notes.orgmode.orgAgendaFiles + + +
+
+

List of org files to be used as agenda files.

+ +

Type: +string

+ +

Default: +"{'~/Documents/org/*', '~/my-orgs/**/*'}"

+ +

Declared by:

+ +
+ <neovim-flake/modules/notes/orgmode/orgmode.nix> -
vim.notes.orgmode.orgDefaultNotesFile

Default org file to be used for notes.

Type: -string

Default: -"~/Documents/org/refile.org"

Declared by:

+
+ +
+
+
+ + vim.notes.orgmode.orgDefaultNotesFile + + +
+
+

Default org file to be used for notes.

+ +

Type: +string

+ +

Default: +"~/Documents/org/refile.org"

+ +

Declared by:

+ +
+ <neovim-flake/modules/notes/orgmode/orgmode.nix> -
vim.notes.orgmode.treesitter.enable

Whether to enable Orgmode treesitter.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.notes.orgmode.treesitter.enable + + +
+
+

Whether to enable Orgmode treesitter.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/notes/orgmode/orgmode.nix> -
vim.notes.orgmode.treesitter.orgPackage

The org treesitter package to use.

Type: -package

Default: -pkgs.vimPlugins.nvim-treesitter.builtGrammars.org

Declared by:

+
+ +
+
+
+ + vim.notes.orgmode.treesitter.orgPackage + + +
+
+

The org treesitter package to use.

+ +

Type: +package

+ +

Default: +pkgs.vimPlugins.nvim-treesitter.builtGrammars.org

+ +

Declared by:

+ +
+ <neovim-flake/modules/notes/orgmode/orgmode.nix> -
vim.notes.todo-comments.enable

Whether to enable todo-comments: highlight and search for todo comments like TODO, HACK, BUG in your code base.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.notes.todo-comments.enable + + +
+
+

Whether to enable todo-comments: highlight and search for todo comments like TODO, HACK, BUG in your code base.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/notes/todo-comments/todo-comments.nix> -
vim.notes.todo-comments.mappings.quickFix

Open Todo-s in a quickfix list

Type: -null or string

Default: -"<leader>tdq"

Declared by:

+
+ +
+
+
+ + vim.notes.todo-comments.mappings.quickFix + + +
+
+

Open Todo-s in a quickfix list

+ +

Type: +null or string

+ +

Default: +"<leader>tdq"

+ +

Declared by:

+ +
+ <neovim-flake/modules/notes/todo-comments/todo-comments.nix> -
vim.notes.todo-comments.mappings.telescope

Open Todo-s in telescope

Type: -null or string

Default: -"<leader>tds"

Declared by:

+
+ +
+
+
+ + vim.notes.todo-comments.mappings.telescope + + +
+
+

Open Todo-s in telescope

+ +

Type: +null or string

+ +

Default: +"<leader>tds"

+ +

Declared by:

+ +
+ <neovim-flake/modules/notes/todo-comments/todo-comments.nix> -
vim.notes.todo-comments.mappings.trouble

Open Todo-s in Trouble

Type: -null or string

Default: -"<leader>tdt"

Declared by:

+
+ +
+
+
+ + vim.notes.todo-comments.mappings.trouble + + +
+
+

Open Todo-s in Trouble

+ +

Type: +null or string

+ +

Default: +"<leader>tdt"

+ +

Declared by:

+ +
+ <neovim-flake/modules/notes/todo-comments/todo-comments.nix> -
vim.notes.todo-comments.patterns.highlight

vim regex pattern used for highlighting comments

Type: -string

Default: -"[[.*<(KEYWORDS)(\\([^\\)]*\\))?:]]"

Declared by:

+
+ +
+
+
+ + vim.notes.todo-comments.patterns.highlight + + +
+
+

vim regex pattern used for highlighting comments

+ +

Type: +string

+ +

Default: +"[[.*<(KEYWORDS)(\\([^\\)]*\\))?:]]"

+ +

Declared by:

+ +
+ <neovim-flake/modules/notes/todo-comments/todo-comments.nix> -
vim.notes.todo-comments.patterns.search

ripgrep regex pattern used for searching comments

Type: -string

Default: -"[[\\b(KEYWORDS)(\\([^\\)]*\\))?:]]"

Declared by:

+
+ +
+
+
+ + vim.notes.todo-comments.patterns.search + + +
+
+

ripgrep regex pattern used for searching comments

+ +

Type: +string

+ +

Default: +"[[\\b(KEYWORDS)(\\([^\\)]*\\))?:]]"

+ +

Declared by:

+ +
+ <neovim-flake/modules/notes/todo-comments/todo-comments.nix> -
vim.notify.nvim-notify.enable

Whether to enable nvim-notify notifications.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.notify.nvim-notify.enable + + +
+
+

Whether to enable nvim-notify notifications.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/notifications/nvim-notify/nvim-notify.nix> -
vim.notify.nvim-notify.background_colour

The background colour of the notification

Type: -string

Default: -"#000000"

Declared by:

+
+ +
+
+
+ + vim.notify.nvim-notify.background_colour + + +
+
+

The background colour of the notification

+ +

Type: +string

+ +

Default: +"#000000"

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/notifications/nvim-notify/nvim-notify.nix> -
vim.notify.nvim-notify.icons

The icons of the notification

Type: -attribute set of string

Default:

{
-  DEBUG = "";
-  ERROR = "";
-  INFO = "";
-  TRACE = "";
-  WARN = "";
+
+
+
+
+ + vim.notify.nvim-notify.icons + + +
+
+

The icons of the notification

+ +

Type: +attribute set of string

+ +

Default:

{
+  DEBUG = "";
+  ERROR = "";
+  INFO = "";
+  TRACE = "";
+  WARN = "";
 }
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/ui/notifications/nvim-notify/nvim-notify.nix> -
vim.notify.nvim-notify.position

The position of the notification

Type: -one of “top_left”, “top_right”, “bottom_left”, “bottom_right”

Default: -"top_right"

Declared by:

+
+ +
+
+
+ + vim.notify.nvim-notify.position + + +
+
+

The position of the notification

+ +

Type: +one of “top_left”, “top_right”, “bottom_left”, “bottom_right”

+ +

Default: +"top_right"

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/notifications/nvim-notify/nvim-notify.nix> -
vim.notify.nvim-notify.stages

The stages of the notification

Type: -one of “fade_in_slide_out”, “fade_in”, “slide_out”, “none”

Default: -"fade_in_slide_out"

Declared by:

+
+ +
+
+
+ + vim.notify.nvim-notify.stages + + +
+
+

The stages of the notification

+ +

Type: +one of “fade_in_slide_out”, “fade_in”, “slide_out”, “none”

+ +

Default: +"fade_in_slide_out"

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/notifications/nvim-notify/nvim-notify.nix> -
vim.notify.nvim-notify.timeout

The timeout of the notification

Type: -signed integer

Default: -1000

Declared by:

+
+ +
+
+
+ + vim.notify.nvim-notify.timeout + + +
+
+

The timeout of the notification

+ +

Type: +signed integer

+ +

Default: +1000

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/notifications/nvim-notify/nvim-notify.nix> -
vim.optPlugins

List of plugins to optionally load

Type: -list of (null or package or one of “nvim-treesitter-context”, “gitsigns-nvim”, “plenary-nvim”, “nvim-lspconfig”, “nvim-treesitter”, “lspsaga”, “lspkind”, “nvim-lightbulb”, “lsp-signature”, “nvim-tree-lua”, “nvim-bufferline-lua”, “lualine”, “nvim-compe”, “nvim-autopairs”, “nvim-ts-autotag”, “nvim-web-devicons”, “tokyonight”, “bufdelete-nvim”, “nvim-cmp”, “cmp-nvim-lsp”, “cmp-buffer”, “cmp-vsnip”, “cmp-path”, “cmp-treesitter”, “crates-nvim”, “vim-vsnip”, “nvim-code-action-menu”, “trouble”, “none-ls”, “which-key”, “indent-blankline”, “nvim-cursorline”, “sqls-nvim”, “glow-nvim”, “telescope”, “rust-tools”, “onedark”, “catppuccin”, “dracula”, “oxocarbon”, “minimap-vim”, “dashboard-nvim”, “alpha-nvim”, “scrollbar-nvim”, “codewindow-nvim”, “nvim-notify”, “cinnamon-nvim”, “cheatsheet-nvim”, “ccc”, “cellular-automaton”, “presence-nvim”, “icon-picker-nvim”, “dressing-nvim”, “orgmode-nvim”, “obsidian-nvim”, “vim-markdown”, “tabular”, “toggleterm-nvim”, “noice-nvim”, “nui-nvim”, “copilot-lua”, “tabnine-nvim”, “nvim-session-manager”, “gesture-nvim”, “comment-nvim”, “kommentary”, “mind-nvim”, “fidget-nvim”, “diffview-nvim”, “todo-comments”, “flutter-tools”, “flutter-tools-patched”, “hop-nvim”, “leap-nvim”, “modes-nvim”, “vim-repeat”, “smartcolumn”, “project-nvim”, “neodev-nvim”, “elixir-ls”, “elixir-tools”, “nvim-colorizer-lua”, “vim-illuminate”, “nvim-surround”, “nvim-dap”, “nvim-dap-ui”, “nvim-navic”, “nvim-navbuddy”, “copilot-cmp”, “lsp-lines”, “vim-dirtytalk”, “highlight-undo”, “nvim-docs-view”)

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.optPlugins + + +
+
+

List of plugins to optionally load

+ +

Type: +list of (null or package or one of “nvim-treesitter-context”, “gitsigns-nvim”, “plenary-nvim”, “nvim-lspconfig”, “nvim-treesitter”, “lspsaga”, “lspkind”, “nvim-lightbulb”, “lsp-signature”, “nvim-tree-lua”, “nvim-bufferline-lua”, “lualine”, “nvim-compe”, “nvim-autopairs”, “nvim-ts-autotag”, “nvim-web-devicons”, “tokyonight”, “bufdelete-nvim”, “nvim-cmp”, “cmp-nvim-lsp”, “cmp-buffer”, “cmp-vsnip”, “cmp-path”, “cmp-treesitter”, “crates-nvim”, “vim-vsnip”, “nvim-code-action-menu”, “trouble”, “none-ls”, “which-key”, “indent-blankline”, “nvim-cursorline”, “sqls-nvim”, “glow-nvim”, “telescope”, “rust-tools”, “onedark”, “catppuccin”, “dracula”, “oxocarbon”, “minimap-vim”, “dashboard-nvim”, “alpha-nvim”, “scrollbar-nvim”, “codewindow-nvim”, “nvim-notify”, “cinnamon-nvim”, “cheatsheet-nvim”, “ccc”, “cellular-automaton”, “presence-nvim”, “icon-picker-nvim”, “dressing-nvim”, “orgmode-nvim”, “obsidian-nvim”, “vim-markdown”, “tabular”, “toggleterm-nvim”, “noice-nvim”, “nui-nvim”, “copilot-lua”, “tabnine-nvim”, “nvim-session-manager”, “gesture-nvim”, “comment-nvim”, “kommentary”, “mind-nvim”, “fidget-nvim”, “diffview-nvim”, “todo-comments”, “flutter-tools”, “flutter-tools-patched”, “hop-nvim”, “leap-nvim”, “modes-nvim”, “vim-repeat”, “smartcolumn”, “project-nvim”, “neodev-nvim”, “elixir-ls”, “elixir-tools”, “nvim-colorizer-lua”, “vim-illuminate”, “nvim-surround”, “nvim-dap”, “nvim-dap-ui”, “nvim-navic”, “nvim-navbuddy”, “copilot-cmp”, “lsp-lines”, “vim-dirtytalk”, “highlight-undo”, “nvim-docs-view”)

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/core> -
vim.presence.presence-nvim.enable

Whether to enable presence.nvim plugin for discord rich presence.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.presence.presence-nvim.enable + + +
+
+

Whether to enable presence.nvim plugin for discord rich presence.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/rich-presence/presence-nvim/presence-nvim.nix> -
vim.presence.presence-nvim.enable_line_number

Show line number on the RPC item

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.presence.presence-nvim.enable_line_number + + +
+
+

Show line number on the RPC item

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/rich-presence/presence-nvim/presence-nvim.nix> -
vim.presence.presence-nvim.auto_update

Automatically update the presence

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.presence.presence-nvim.auto_update + + +
+
+

Automatically update the presence

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/rich-presence/presence-nvim/presence-nvim.nix> -
vim.presence.presence-nvim.buttons

Show buttons on the RPC item

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.presence.presence-nvim.buttons + + +
+
+

Show buttons on the RPC item

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/rich-presence/presence-nvim/presence-nvim.nix> -
vim.presence.presence-nvim.client_id

Client ID of the application

Type: -string

Default: -"79327144129396737"

Declared by:

+
+ +
+
+
+ + vim.presence.presence-nvim.client_id + + +
+
+

Client ID of the application

+ +

Type: +string

+ +

Default: +"79327144129396737"

+ +

Declared by:

+ +
+ <neovim-flake/modules/rich-presence/presence-nvim/presence-nvim.nix> -
vim.presence.presence-nvim.image_text

Text displayed when hovering over the Neovim image

Type: -string

Default: -"The One True Text Editor"

Declared by:

+
+ +
+
+
+ + vim.presence.presence-nvim.image_text + + +
+
+

Text displayed when hovering over the Neovim image

+ +

Type: +string

+ +

Default: +"The One True Text Editor"

+ +

Declared by:

+ +
+ <neovim-flake/modules/rich-presence/presence-nvim/presence-nvim.nix> -
vim.presence.presence-nvim.main_image

Main image to be displayed

Type: -string

Default: -"neovim"

Declared by:

+
+ +
+
+
+ + vim.presence.presence-nvim.main_image + + +
+
+

Main image to be displayed

+ +

Type: +string

+ +

Default: +"neovim"

+ +

Declared by:

+ +
+ <neovim-flake/modules/rich-presence/presence-nvim/presence-nvim.nix> -
vim.presence.presence-nvim.rich_presence.editing_text

Text displayed when editing a file

Type: -string

Default: -"Editing %s"

Declared by:

+
+ +
+
+
+ + vim.presence.presence-nvim.rich_presence.editing_text + + +
+
+

Text displayed when editing a file

+ +

Type: +string

+ +

Default: +"Editing %s"

+ +

Declared by:

+ +
+ <neovim-flake/modules/rich-presence/presence-nvim/presence-nvim.nix> -
vim.presence.presence-nvim.rich_presence.file_explorer_text

Text displayed when browsing files

Type: -string

Default: -"Browsing %s"

Declared by:

+
+ +
+
+
+ + vim.presence.presence-nvim.rich_presence.file_explorer_text + + +
+
+

Text displayed when browsing files

+ +

Type: +string

+ +

Default: +"Browsing %s"

+ +

Declared by:

+ +
+ <neovim-flake/modules/rich-presence/presence-nvim/presence-nvim.nix> -
vim.presence.presence-nvim.rich_presence.git_commit_text

Text displayed when committing changes

Type: -string

Default: -"Committing changes"

Declared by:

+
+ +
+
+
+ + vim.presence.presence-nvim.rich_presence.git_commit_text + + +
+
+

Text displayed when committing changes

+ +

Type: +string

+ +

Default: +"Committing changes"

+ +

Declared by:

+ +
+ <neovim-flake/modules/rich-presence/presence-nvim/presence-nvim.nix> -
vim.presence.presence-nvim.rich_presence.line_number_text

Text displayed when showing line number

Type: -string

Default: -"Line %s out of %s"

Declared by:

+
+ +
+
+
+ + vim.presence.presence-nvim.rich_presence.line_number_text + + +
+
+

Text displayed when showing line number

+ +

Type: +string

+ +

Default: +"Line %s out of %s"

+ +

Declared by:

+ +
+ <neovim-flake/modules/rich-presence/presence-nvim/presence-nvim.nix> -
vim.presence.presence-nvim.rich_presence.plugin_manager_text

Text displayed when managing plugins

Type: -string

Default: -"Managing plugins"

Declared by:

+
+ +
+
+
+ + vim.presence.presence-nvim.rich_presence.plugin_manager_text + + +
+
+

Text displayed when managing plugins

+ +

Type: +string

+ +

Default: +"Managing plugins"

+ +

Declared by:

+ +
+ <neovim-flake/modules/rich-presence/presence-nvim/presence-nvim.nix> -
vim.presence.presence-nvim.rich_presence.reading_text

Text displayed when reading a file

Type: -string

Default: -"Reading %s"

Declared by:

+
+ +
+
+
+ + vim.presence.presence-nvim.rich_presence.reading_text + + +
+
+

Text displayed when reading a file

+ +

Type: +string

+ +

Default: +"Reading %s"

+ +

Declared by:

+ +
+ <neovim-flake/modules/rich-presence/presence-nvim/presence-nvim.nix> -
vim.presence.presence-nvim.rich_presence.workspace_text

Text displayed when working on a project

Type: -string

Default: -"Working on %s"

Declared by:

+
+ +
+
+
+ + vim.presence.presence-nvim.rich_presence.workspace_text + + +
+
+

Text displayed when working on a project

+ +

Type: +string

+ +

Default: +"Working on %s"

+ +

Declared by:

+ +
+ <neovim-flake/modules/rich-presence/presence-nvim/presence-nvim.nix> -
vim.presence.presence-nvim.show_time

Show time on the RPC item

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.presence.presence-nvim.show_time + + +
+
+

Show time on the RPC item

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/rich-presence/presence-nvim/presence-nvim.nix> -
vim.preventJunkFiles

Prevent swapfile, backupfile from being created

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.preventJunkFiles + + +
+
+

Prevent swapfile, backupfile from being created

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.projects.project-nvim.enable

Whether to enable project-nvim for project management.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.projects.project-nvim.enable + + +
+
+

Whether to enable project-nvim for project management.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/projects/project-nvim/project-nvim.nix> -
vim.projects.project-nvim.detectionMethods

Detection methods to use

Type: -list of string

Default:

[
-  "lsp"
-  "pattern"
+
+
+
+
+ + vim.projects.project-nvim.detectionMethods + + +
+
+

Detection methods to use

+ +

Type: +list of string

+ +

Default:

[
+  "lsp"
+  "pattern"
 ]
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/projects/project-nvim/project-nvim.nix> -
vim.projects.project-nvim.excludeDirs

Directories to exclude from project root search

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.projects.project-nvim.excludeDirs + + +
+
+

Directories to exclude from project root search

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/projects/project-nvim/project-nvim.nix> -
vim.projects.project-nvim.lspIgnored

LSP servers no ignore by name

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.projects.project-nvim.lspIgnored + + +
+
+

LSP servers no ignore by name

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/projects/project-nvim/project-nvim.nix> -
vim.projects.project-nvim.manualMode

don’t automatically change the root directory so the user has the option to manually do so using :ProjectRoot command

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.projects.project-nvim.manualMode + + +
+
+

don’t automatically change the root directory so the user has the option to manually do so using :ProjectRoot command

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/projects/project-nvim/project-nvim.nix> -
vim.projects.project-nvim.patterns

Patterns to use for pattern detection method

Type: -list of string

Default:

[
-  ".git"
-  "_darcs"
-  ".hg"
-  ".bzr"
-  ".svn"
-  "Makefile"
-  "package.json"
-  "flake.nix"
-  "cargo.toml"
+
+
+
+
+ + vim.projects.project-nvim.patterns + + +
+
+

Patterns to use for pattern detection method

+ +

Type: +list of string

+ +

Default:

[
+  ".git"
+  "_darcs"
+  ".hg"
+  ".bzr"
+  ".svn"
+  "Makefile"
+  "package.json"
+  "flake.nix"
+  "cargo.toml"
 ]
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/projects/project-nvim/project-nvim.nix> -
vim.projects.project-nvim.scopeChdir

What scope to change the directory

Type: -one of “global”, “tab”, “win”

Default: -"global"

Declared by:

+
+ +
+
+
+ + vim.projects.project-nvim.scopeChdir + + +
+
+

What scope to change the directory

+ +

Type: +one of “global”, “tab”, “win”

+ +

Default: +"global"

+ +

Declared by:

+ +
+ <neovim-flake/modules/projects/project-nvim/project-nvim.nix> -
vim.projects.project-nvim.showHidden

Show hidden files in telescope picker

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.projects.project-nvim.showHidden + + +
+
+

Show hidden files in telescope picker

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/projects/project-nvim/project-nvim.nix> -
vim.projects.project-nvim.silentChdir

Silently change directory when changing project

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.projects.project-nvim.silentChdir + + +
+
+

Silently change directory when changing project

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/projects/project-nvim/project-nvim.nix> -
vim.scrollOffset

Start scrolling this number of lines from the top or bottom of the page.

Type: -signed integer

Default: -8

Declared by:

+
+ +
+
+
+ + vim.scrollOffset + + +
+
+

Start scrolling this number of lines from the top or bottom of the page.

+ +

Type: +signed integer

+ +

Default: +8

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.searchCase

Set the case sensitivity of search

Type: -one of “ignore”, “smart”, “sensitive”

Default: -"sensitive"

Declared by:

+
+ +
+
+
+ + vim.searchCase + + +
+
+

Set the case sensitivity of search

+ +

Type: +one of “ignore”, “smart”, “sensitive”

+ +

Default: +"sensitive"

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.session.nvim-session-manager.enable

Whether to enable nvim-session-manager: manage sessions like folders in VSCode.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.session.nvim-session-manager.enable + + +
+
+

Whether to enable nvim-session-manager: manage sessions like folders in VSCode.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/session/nvim-session-manager/nvim-session-manager.nix> -
vim.session.nvim-session-manager.autoSave.ignoreBufTypes

All buffers of these bufer types will be closed before the session is saved

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.session.nvim-session-manager.autoSave.ignoreBufTypes + + +
+
+

All buffers of these bufer types will be closed before the session is saved

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/session/nvim-session-manager/nvim-session-manager.nix> -
vim.session.nvim-session-manager.autoSave.ignoreDirs

A list of directories where the session will not be autosaved

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.session.nvim-session-manager.autoSave.ignoreDirs + + +
+
+

A list of directories where the session will not be autosaved

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/session/nvim-session-manager/nvim-session-manager.nix> -
vim.session.nvim-session-manager.autoSave.ignoreFiletypes

All buffers of these file types will be closed before the session is saved

Type: -list of string

Default:

[
-  "gitcommit"
+
+
+
+
+ + vim.session.nvim-session-manager.autoSave.ignoreFiletypes + + +
+
+

All buffers of these file types will be closed before the session is saved

+ +

Type: +list of string

+ +

Default:

[
+  "gitcommit"
 ]
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/session/nvim-session-manager/nvim-session-manager.nix> -
vim.session.nvim-session-manager.autoSave.ignoreNotNormal

Plugin will not save a session when no buffers are opened, or all of them aren’t writable or listed

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.session.nvim-session-manager.autoSave.ignoreNotNormal + + +
+
+

Plugin will not save a session when no buffers are opened, or all of them aren’t writable or listed

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/session/nvim-session-manager/nvim-session-manager.nix> -
vim.session.nvim-session-manager.autoSave.lastSession

Automatically save last session on exit and on session switch

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.session.nvim-session-manager.autoSave.lastSession + + +
+
+

Automatically save last session on exit and on session switch

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/session/nvim-session-manager/nvim-session-manager.nix> -
vim.session.nvim-session-manager.autoSave.onlyInSession

Always autosaves session. If true, only autosaves after a session is active

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.session.nvim-session-manager.autoSave.onlyInSession + + +
+
+

Always autosaves session. If true, only autosaves after a session is active

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/session/nvim-session-manager/nvim-session-manager.nix> -
vim.session.nvim-session-manager.autoloadMode

Define what to do when Neovim is started without arguments. Possible values: Disabled, CurrentDir, LastSession

Type: -one of “Disabled”, “CurrentDir”, “LastSession”

Default: -"LastSession"

Declared by:

+
+ +
+
+
+ + vim.session.nvim-session-manager.autoloadMode + + +
+
+

Define what to do when Neovim is started without arguments. Possible values: Disabled, CurrentDir, LastSession

+ +

Type: +one of “Disabled”, “CurrentDir”, “LastSession”

+ +

Default: +"LastSession"

+ +

Declared by:

+ +
+ <neovim-flake/modules/session/nvim-session-manager/nvim-session-manager.nix> -
vim.session.nvim-session-manager.colonReplacer

The character to which the colon symbol will be replaced for session files

Type: -string

Default: -"++"

Declared by:

+
+ +
+
+
+ + vim.session.nvim-session-manager.colonReplacer + + +
+
+

The character to which the colon symbol will be replaced for session files

+ +

Type: +string

+ +

Default: +"++"

+ +

Declared by:

+ +
+ <neovim-flake/modules/session/nvim-session-manager/nvim-session-manager.nix> -
vim.session.nvim-session-manager.mappings.deleteSession

Delete session

Type: -null or string

Default: -"<leader>sd"

Declared by:

+
+ +
+
+
+ + vim.session.nvim-session-manager.mappings.deleteSession + + +
+
+

Delete session

+ +

Type: +null or string

+ +

Default: +"<leader>sd"

+ +

Declared by:

+ +
+ <neovim-flake/modules/session/nvim-session-manager/nvim-session-manager.nix> -
vim.session.nvim-session-manager.mappings.loadLastSession

Load last session

Type: -null or string

Default: -"<leader>slt"

Declared by:

+
+ +
+
+
+ + vim.session.nvim-session-manager.mappings.loadLastSession + + +
+
+

Load last session

+ +

Type: +null or string

+ +

Default: +"<leader>slt"

+ +

Declared by:

+ +
+ <neovim-flake/modules/session/nvim-session-manager/nvim-session-manager.nix> -
vim.session.nvim-session-manager.mappings.loadSession

Load session

Type: -null or string

Default: -"<leader>sl"

Declared by:

+
+ +
+
+
+ + vim.session.nvim-session-manager.mappings.loadSession + + +
+
+

Load session

+ +

Type: +null or string

+ +

Default: +"<leader>sl"

+ +

Declared by:

+ +
+ <neovim-flake/modules/session/nvim-session-manager/nvim-session-manager.nix> -
vim.session.nvim-session-manager.mappings.saveCurrentSession

Save current session

Type: -null or string

Default: -"<leader>sc"

Declared by:

+
+ +
+
+
+ + vim.session.nvim-session-manager.mappings.saveCurrentSession + + +
+
+

Save current session

+ +

Type: +null or string

+ +

Default: +"<leader>sc"

+ +

Declared by:

+ +
+ <neovim-flake/modules/session/nvim-session-manager/nvim-session-manager.nix> -
vim.session.nvim-session-manager.maxPathLength

Shorten the display path if length exceeds this threshold. Use 0 if don’t want to shorten the path at all

Type: -null or signed integer

Default: -80

Declared by:

+
+ +
+
+
+ + vim.session.nvim-session-manager.maxPathLength + + +
+
+

Shorten the display path if length exceeds this threshold. Use 0 if don’t want to shorten the path at all

+ +

Type: +null or signed integer

+ +

Default: +80

+ +

Declared by:

+ +
+ <neovim-flake/modules/session/nvim-session-manager/nvim-session-manager.nix> -
vim.session.nvim-session-manager.pathReplacer

The character to which the path separator will be replaced for session files

Type: -string

Default: -"__"

Declared by:

+
+ +
+
+
+ + vim.session.nvim-session-manager.pathReplacer + + +
+
+

The character to which the path separator will be replaced for session files

+ +

Type: +string

+ +

Default: +"__"

+ +

Declared by:

+ +
+ <neovim-flake/modules/session/nvim-session-manager/nvim-session-manager.nix> -
vim.session.nvim-session-manager.usePicker

Whether or not we should use dressing.nvim to build a session picker UI

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.session.nvim-session-manager.usePicker + + +
+
+

Whether or not we should use dressing.nvim to build a session picker UI

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/session/nvim-session-manager/nvim-session-manager.nix> -
vim.showSignColumn

Show the sign column

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.showSignColumn + + +
+
+

Show the sign column

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.snippets.vsnip.enable

Whether to enable vim-vsnip: snippet LSP/VSCode’s format.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.snippets.vsnip.enable + + +
+
+

Whether to enable vim-vsnip: snippet LSP/VSCode’s format.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/snippets/vsnip/vsnip.nix> -
vim.spellChecking.enable

Whether to enable neovim’s built-in spellchecking.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.spellChecking.enable + + +
+
+

Whether to enable neovim’s built-in spellchecking.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.spellChecking.enableProgrammingWordList

Whether to enable vim-dirtytalk, a wordlist for programmers, that includes programming words.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.spellChecking.enableProgrammingWordList + + +
+
+

Whether to enable vim-dirtytalk, a wordlist for programmers, that includes programming words.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.spellChecking.languages

The languages to be used for spellchecking

Type: -list of string

Default:

[
-  "en"
+
+
+
+
+ + vim.spellChecking.languages + + +
+
+

The languages to be used for spellchecking

+ +

Type: +list of string

+ +

Default:

[
+  "en"
 ]
-

Example:

[
-  "en"
-  "de"
+
+ +

Example:

[
+  "en"
+  "de"
 ]
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.splitBelow

New splits will open below instead of on top

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.splitBelow + + +
+
+

New splits will open below instead of on top

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.splitRight

New splits will open to the right

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.splitRight + + +
+
+

New splits will open to the right

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.startPlugins

List of plugins to startup.

Type: -list of (null or package or one of “nvim-treesitter-context”, “gitsigns-nvim”, “plenary-nvim”, “nvim-lspconfig”, “nvim-treesitter”, “lspsaga”, “lspkind”, “nvim-lightbulb”, “lsp-signature”, “nvim-tree-lua”, “nvim-bufferline-lua”, “lualine”, “nvim-compe”, “nvim-autopairs”, “nvim-ts-autotag”, “nvim-web-devicons”, “tokyonight”, “bufdelete-nvim”, “nvim-cmp”, “cmp-nvim-lsp”, “cmp-buffer”, “cmp-vsnip”, “cmp-path”, “cmp-treesitter”, “crates-nvim”, “vim-vsnip”, “nvim-code-action-menu”, “trouble”, “none-ls”, “which-key”, “indent-blankline”, “nvim-cursorline”, “sqls-nvim”, “glow-nvim”, “telescope”, “rust-tools”, “onedark”, “catppuccin”, “dracula”, “oxocarbon”, “minimap-vim”, “dashboard-nvim”, “alpha-nvim”, “scrollbar-nvim”, “codewindow-nvim”, “nvim-notify”, “cinnamon-nvim”, “cheatsheet-nvim”, “ccc”, “cellular-automaton”, “presence-nvim”, “icon-picker-nvim”, “dressing-nvim”, “orgmode-nvim”, “obsidian-nvim”, “vim-markdown”, “tabular”, “toggleterm-nvim”, “noice-nvim”, “nui-nvim”, “copilot-lua”, “tabnine-nvim”, “nvim-session-manager”, “gesture-nvim”, “comment-nvim”, “kommentary”, “mind-nvim”, “fidget-nvim”, “diffview-nvim”, “todo-comments”, “flutter-tools”, “flutter-tools-patched”, “hop-nvim”, “leap-nvim”, “modes-nvim”, “vim-repeat”, “smartcolumn”, “project-nvim”, “neodev-nvim”, “elixir-ls”, “elixir-tools”, “nvim-colorizer-lua”, “vim-illuminate”, “nvim-surround”, “nvim-dap”, “nvim-dap-ui”, “nvim-navic”, “nvim-navbuddy”, “copilot-cmp”, “lsp-lines”, “vim-dirtytalk”, “highlight-undo”, “nvim-docs-view”)

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.startPlugins + + +
+
+

List of plugins to startup.

+ +

Type: +list of (null or package or one of “nvim-treesitter-context”, “gitsigns-nvim”, “plenary-nvim”, “nvim-lspconfig”, “nvim-treesitter”, “lspsaga”, “lspkind”, “nvim-lightbulb”, “lsp-signature”, “nvim-tree-lua”, “nvim-bufferline-lua”, “lualine”, “nvim-compe”, “nvim-autopairs”, “nvim-ts-autotag”, “nvim-web-devicons”, “tokyonight”, “bufdelete-nvim”, “nvim-cmp”, “cmp-nvim-lsp”, “cmp-buffer”, “cmp-vsnip”, “cmp-path”, “cmp-treesitter”, “crates-nvim”, “vim-vsnip”, “nvim-code-action-menu”, “trouble”, “none-ls”, “which-key”, “indent-blankline”, “nvim-cursorline”, “sqls-nvim”, “glow-nvim”, “telescope”, “rust-tools”, “onedark”, “catppuccin”, “dracula”, “oxocarbon”, “minimap-vim”, “dashboard-nvim”, “alpha-nvim”, “scrollbar-nvim”, “codewindow-nvim”, “nvim-notify”, “cinnamon-nvim”, “cheatsheet-nvim”, “ccc”, “cellular-automaton”, “presence-nvim”, “icon-picker-nvim”, “dressing-nvim”, “orgmode-nvim”, “obsidian-nvim”, “vim-markdown”, “tabular”, “toggleterm-nvim”, “noice-nvim”, “nui-nvim”, “copilot-lua”, “tabnine-nvim”, “nvim-session-manager”, “gesture-nvim”, “comment-nvim”, “kommentary”, “mind-nvim”, “fidget-nvim”, “diffview-nvim”, “todo-comments”, “flutter-tools”, “flutter-tools-patched”, “hop-nvim”, “leap-nvim”, “modes-nvim”, “vim-repeat”, “smartcolumn”, “project-nvim”, “neodev-nvim”, “elixir-ls”, “elixir-tools”, “nvim-colorizer-lua”, “vim-illuminate”, “nvim-surround”, “nvim-dap”, “nvim-dap-ui”, “nvim-navic”, “nvim-navbuddy”, “copilot-cmp”, “lsp-lines”, “vim-dirtytalk”, “highlight-undo”, “nvim-docs-view”)

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/core> -
vim.statusline.lualine.enable

Whether to enable lualine statusline plugin.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.enable + + +
+
+

Whether to enable lualine statusline plugin.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.activeSection.a

active config for: | (A) | B | C X | Y | Z |

Type: -list of string

Default:

[
-  ''
+
+
+
+
+ + vim.statusline.lualine.activeSection.a + + +
+
+

active config for: | (A) | B | C X | Y | Z |

+ +

Type: +list of string

+ +

Default:

[
+  ''
     {
-      "mode",
+      "mode",
       icons_enabled = true,
       separator = {
-        left = '▎',
-        right = ''
+        left = '▎',
+        right = ''
       },
     }
-  ''
+  ''
 ]
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.activeSection.b

active config for: | A | (B) | C X | Y | Z |

Type: -list of string

Default:

[
-  ''
+
+
+
+
+ + vim.statusline.lualine.activeSection.b + + +
+
+

active config for: | A | (B) | C X | Y | Z |

+ +

Type: +list of string

+ +

Default:

[
+  ''
     {
-      "filetype",
+      "filetype",
       colored = true,
       icon_only = true,
-      icon = { align = 'left' },
-      color = {bg='none', fg='lavender'},
+      icon = { align = 'left' },
+      color = {bg='none', fg='lavender'},
     }
-  ''
-  ''
+  ''
+  ''
     {
-      "filename",
-      color = {bg='none'},
-      symbols = {modified = '', readonly = ''},
+      "filename",
+      color = {bg='none'},
+      symbols = {modified = '', readonly = ''},
     }
-  ''
+  ''
 ]
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.activeSection.c

active config for: | A | B | © X | Y | Z |

Type: -list of string

Default:

[
-  ''
+
+
+
+
+ + vim.statusline.lualine.activeSection.c + + +
+
+

active config for: | A | B | © X | Y | Z |

+ +

Type: +list of string

+ +

Default:

[
+  ''
     {
-      "diff",
+      "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
+        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
+      symbols = {added = '+', modified = '~', removed = '-'}, -- Changes the diff symbols
       color = {
-        bg='none',
-        fg='lavender'
+        bg='none',
+        fg='lavender'
       },
     }
-  ''
+  ''
 ]
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.activeSection.x

active config for: | A | B | C (X) | Y | Z |

Type: -list of string

Default:

[
-  ''
+
+
+
+
+ + vim.statusline.lualine.activeSection.x + + +
+
+

active config for: | A | B | C (X) | Y | Z |

+ +

Type: +list of string

+ +

Default:

[
+  ''
     {
       -- Lsp server name
       function()
-        local buf_ft = vim.api.nvim_get_option_value('filetype', {})
+        local buf_ft = vim.api.nvim_get_option_value('filetype', {})
     
         -- List of buffer types to exclude
-        local excluded_buf_ft = {"toggleterm", "NvimTree", "TelescopePrompt"}
+        local excluded_buf_ft = {"toggleterm", "NvimTree", "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 ""
+            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'
+        local msg = 'No Active Lsp'
     
         -- if no lsp client is attached then return the msg
         if next(clients) == nil then
@@ -3248,1161 +17429,6398 @@ list of string
Default:
Declared by:

+

+
+
+
Declared by:

+
+

+
 <neovim-flake/modules/statusline/lualine/lualine.nix>
-
vim.statusline.lualine.activeSection.y
active config for: | A | B | C       X | (Y) | Z |
Type:
-list of string
Default:
[
-  ''
+
+

+
+
+ + vim.statusline.lualine.activeSection.y + + +
+
+

active config for: | A | B | C X | (Y) | Z |

+ +

Type: +list of string

+ +

Default:

[
+  ''
     {
-      'searchcount',
+      'searchcount',
       maxcount = 999,
       timeout = 120,
-      color = {bg='none', fg='lavender'}
+      color = {bg='none', fg='lavender'}
     }
-  ''
-  ''
+  ''
+  ''
     {
-      "branch",
-      icon = ' •',
-      color = {bg='none', fg='lavender'},
+      "branch",
+      icon = ' •',
+      color = {bg='none', fg='lavender'},
     }
-  ''
+  ''
 ]
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.activeSection.z

active config for: | A | B | C X | Y | (Z) |

Type: -list of string

Default:

[
-  ''
+
+
+
+
+ + vim.statusline.lualine.activeSection.z + + +
+
+

active config for: | A | B | C X | Y | (Z) |

+ +

Type: +list of string

+ +

Default:

[
+  ''
     {
-      "progress",
+      "progress",
       separator = {
-        left = '',
+        left = '',
       },
     }
-  ''
-  ''
+  ''
+  ''
     {
-      "location",
+      "location",
     }
-  ''
-  ''
+  ''
+  ''
     {
-      "fileformat",
-      color = {fg='black'},
+      "fileformat",
+      color = {fg='black'},
       symbols = {
-        unix = '', -- e712
-        dos = '',  -- e70f
-        mac = '',  -- e711
+        unix = '', -- e712
+        dos = '',  -- e70f
+        mac = '',  -- e711
       },
     }
-  ''
+  ''
 ]
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.componentSeparator.left

Component separator for left side

Type: -string

Default: -""

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.componentSeparator.left + + +
+
+

Component separator for left side

+ +

Type: +string

+ +

Default: +""

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.componentSeparator.right

Component separator for right side

Type: -string

Default: -""

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.componentSeparator.right + + +
+
+

Component separator for right side

+ +

Type: +string

+ +

Default: +""

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.extraActiveSection.a

Extra entries for activeSection.a

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.extraActiveSection.a + + +
+
+

Extra entries for activeSection.a

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.extraActiveSection.b

Extra entries for activeSection.b

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.extraActiveSection.b + + +
+
+

Extra entries for activeSection.b

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.extraActiveSection.c

Extra entries for activeSection.c

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.extraActiveSection.c + + +
+
+

Extra entries for activeSection.c

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.extraActiveSection.x

Extra entries for activeSection.x

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.extraActiveSection.x + + +
+
+

Extra entries for activeSection.x

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.extraActiveSection.y

Extra entries for activeSection.y

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.extraActiveSection.y + + +
+
+

Extra entries for activeSection.y

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.extraActiveSection.z

Extra entries for activeSection.z

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.extraActiveSection.z + + +
+
+

Extra entries for activeSection.z

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.extraInactiveSection.a

Extra entries for inactiveSection.a

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.extraInactiveSection.a + + +
+
+

Extra entries for inactiveSection.a

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.extraInactiveSection.b

Extra entries for inactiveSection.b

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.extraInactiveSection.b + + +
+
+

Extra entries for inactiveSection.b

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.extraInactiveSection.c

Extra entries for inactiveSection.c

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.extraInactiveSection.c + + +
+
+

Extra entries for inactiveSection.c

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.extraInactiveSection.x

Extra entries for inactiveSection.x

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.extraInactiveSection.x + + +
+
+

Extra entries for inactiveSection.x

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.extraInactiveSection.y

Extra entries for inactiveSection.y

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.extraInactiveSection.y + + +
+
+

Extra entries for inactiveSection.y

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.extraInactiveSection.z

Extra entries for inactiveSection.z

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.extraInactiveSection.z + + +
+
+

Extra entries for inactiveSection.z

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.globalStatus

Enable global status for lualine

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.globalStatus + + +
+
+

Enable global status for lualine

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.icons.enable

Whether to enable icons for lualine.

Type: -boolean

Default: -true

Example: -true

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.icons.enable + + +
+
+

Whether to enable icons for lualine.

+ +

Type: +boolean

+ +

Default: +true

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.inactiveSection.a

inactive config for: | (A) | B | C X | Y | Z |

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.inactiveSection.a + + +
+
+

inactive config for: | (A) | B | C X | Y | Z |

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.inactiveSection.b

inactive config for: | A | (B) | C X | Y | Z |

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.inactiveSection.b + + +
+
+

inactive config for: | A | (B) | C X | Y | Z |

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.inactiveSection.c

inactive config for: | A | B | © X | Y | Z |

Type: -list of string

Default:

[
-  "'filename'"
+
+
+
+
+ + vim.statusline.lualine.inactiveSection.c + + +
+
+

inactive config for: | A | B | © X | Y | Z |

+ +

Type: +list of string

+ +

Default:

[
+  "'filename'"
 ]
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.inactiveSection.x

inactive config for: | A | B | C (X) | Y | Z |

Type: -list of string

Default:

[
-  "'location'"
+
+
+
+
+ + vim.statusline.lualine.inactiveSection.x + + +
+
+

inactive config for: | A | B | C (X) | Y | Z |

+ +

Type: +list of string

+ +

Default:

[
+  "'location'"
 ]
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.inactiveSection.y

inactive config for: | A | B | C X | (Y) | Z |

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.inactiveSection.y + + +
+
+

inactive config for: | A | B | C X | (Y) | Z |

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.inactiveSection.z

inactive config for: | A | B | C X | Y | (Z) |

Type: -list of string

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.inactiveSection.z + + +
+
+

inactive config for: | A | B | C X | Y | (Z) |

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.refresh.statusline

Refresh rate for lualine

Type: -signed integer

Default: -1000

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.refresh.statusline + + +
+
+

Refresh rate for lualine

+ +

Type: +signed integer

+ +

Default: +1000

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.refresh.tabline

Refresh rate for tabline

Type: -signed integer

Default: -1000

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.refresh.tabline + + +
+
+

Refresh rate for tabline

+ +

Type: +signed integer

+ +

Default: +1000

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.refresh.winbar

Refresh rate for winbar

Type: -signed integer

Default: -1000

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.refresh.winbar + + +
+
+

Refresh rate for winbar

+ +

Type: +signed integer

+ +

Default: +1000

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.sectionSeparator.left

Section separator for left side

Type: -string

Default: -""

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.sectionSeparator.left + + +
+
+

Section separator for left side

+ +

Type: +string

+ +

Default: +""

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.sectionSeparator.right

Section separator for right side

Type: -string

Default: -""

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.sectionSeparator.right + + +
+
+

Section separator for right side

+ +

Type: +string

+ +

Default: +""

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.statusline.lualine.theme

Theme for lualine

Type: -one of “auto”, “16color”, “gruvbox”, “ayu_dark”, “ayu_light”, “ayu_mirage”, “codedark”, “dracula”, “everforest”, “gruvbox”, “gruvbox_light”, “gruvbox_material”, “horizon”, “iceberg_dark”, “iceberg_light”, “jellybeans”, “material”, “modus_vivendi”, “molokai”, “nightfly”, “nord”, “oceanicnext”, “onelight”, “palenight”, “papercolor_dark”, “papercolor_light”, “powerline”, “seoul256”, “solarized_dark”, “tomorrow”, “wombat”, “onedark”

Default: -"`config.vim.theme.name` if theme supports lualine else \"auto\""

Declared by:

+
+ +
+
+
+ + vim.statusline.lualine.theme + + +
+
+

Theme for lualine

+ +

Type: +one of “auto”, “16color”, “gruvbox”, “ayu_dark”, “ayu_light”, “ayu_mirage”, “codedark”, “dracula”, “everforest”, “gruvbox”, “gruvbox_light”, “gruvbox_material”, “horizon”, “iceberg_dark”, “iceberg_light”, “jellybeans”, “material”, “modus_vivendi”, “molokai”, “nightfly”, “nord”, “oceanicnext”, “onelight”, “palenight”, “papercolor_dark”, “papercolor_light”, “powerline”, “seoul256”, “solarized_dark”, “tomorrow”, “wombat”, “onedark”

+ +

Default: +"`config.vim.theme.name` if theme supports lualine else \"auto\""

+ +

Declared by:

+ +
+ <neovim-flake/modules/statusline/lualine/lualine.nix> -
vim.syntaxHighlighting

Enable syntax highlighting

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.syntaxHighlighting + + +
+
+

Enable syntax highlighting

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.tabWidth

Set the width of tabs

Type: -signed integer

Default: -4

Declared by:

+
+ +
+
+
+ + vim.tabWidth + + +
+
+

Set the width of tabs

+ +

Type: +signed integer

+ +

Default: +4

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.tabline.nvimBufferline.enable

Whether to enable nvim-bufferline-lua as a bufferline.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.tabline.nvimBufferline.enable + + +
+
+

Whether to enable nvim-bufferline-lua as a bufferline.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/tabline/nvim-bufferline/nvim-bufferline.nix> -
vim.tabline.nvimBufferline.mappings.closeCurrent

Close buffer

Type: -null or string

Default: -null

Declared by:

+
+ +
+
+
+ + vim.tabline.nvimBufferline.mappings.closeCurrent + + +
+
+

Close buffer

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ +
+ <neovim-flake/modules/tabline/nvim-bufferline/nvim-bufferline.nix> -
vim.tabline.nvimBufferline.mappings.cycleNext

Next buffer

Type: -null or string

Default: -"<leader>bn"

Declared by:

+
+ +
+
+
+ + vim.tabline.nvimBufferline.mappings.cycleNext + + +
+
+

Next buffer

+ +

Type: +null or string

+ +

Default: +"<leader>bn"

+ +

Declared by:

+ +
+ <neovim-flake/modules/tabline/nvim-bufferline/nvim-bufferline.nix> -
vim.tabline.nvimBufferline.mappings.cyclePrevious

Previous buffer

Type: -null or string

Default: -"<leader>bp"

Declared by:

+
+ +
+
+
+ + vim.tabline.nvimBufferline.mappings.cyclePrevious + + +
+
+

Previous buffer

+ +

Type: +null or string

+ +

Default: +"<leader>bp"

+ +

Declared by:

+ +
+ <neovim-flake/modules/tabline/nvim-bufferline/nvim-bufferline.nix> -
vim.tabline.nvimBufferline.mappings.moveNext

Move next buffer

Type: -null or string

Default: -"<leader>bmn"

Declared by:

+
+ +
+
+
+ + vim.tabline.nvimBufferline.mappings.moveNext + + +
+
+

Move next buffer

+ +

Type: +null or string

+ +

Default: +"<leader>bmn"

+ +

Declared by:

+ +
+ <neovim-flake/modules/tabline/nvim-bufferline/nvim-bufferline.nix> -
vim.tabline.nvimBufferline.mappings.movePrevious

Move previous buffer

Type: -null or string

Default: -"<leader>bmp"

Declared by:

+
+ +
+
+
+ + vim.tabline.nvimBufferline.mappings.movePrevious + + +
+
+

Move previous buffer

+ +

Type: +null or string

+ +

Default: +"<leader>bmp"

+ +

Declared by:

+ +
+ <neovim-flake/modules/tabline/nvim-bufferline/nvim-bufferline.nix> -
vim.tabline.nvimBufferline.mappings.pick

Pick buffer

Type: -null or string

Default: -"<leader>bc"

Declared by:

+
+ +
+
+
+ + vim.tabline.nvimBufferline.mappings.pick + + +
+
+

Pick buffer

+ +

Type: +null or string

+ +

Default: +"<leader>bc"

+ +

Declared by:

+ +
+ <neovim-flake/modules/tabline/nvim-bufferline/nvim-bufferline.nix> -
vim.tabline.nvimBufferline.mappings.sortByDirectory

Sort buffers by directory

Type: -null or string

Default: -"<leader>bsd"

Declared by:

+
+ +
+
+
+ + vim.tabline.nvimBufferline.mappings.sortByDirectory + + +
+
+

Sort buffers by directory

+ +

Type: +null or string

+ +

Default: +"<leader>bsd"

+ +

Declared by:

+ +
+ <neovim-flake/modules/tabline/nvim-bufferline/nvim-bufferline.nix> -
vim.tabline.nvimBufferline.mappings.sortByExtension

Sort buffers by extension

Type: -null or string

Default: -"<leader>bse"

Declared by:

+
+ +
+
+
+ + vim.tabline.nvimBufferline.mappings.sortByExtension + + +
+
+

Sort buffers by extension

+ +

Type: +null or string

+ +

Default: +"<leader>bse"

+ +

Declared by:

+ +
+ <neovim-flake/modules/tabline/nvim-bufferline/nvim-bufferline.nix> -
vim.tabline.nvimBufferline.mappings.sortById

Sort buffers by ID

Type: -null or string

Default: -"<leader>bsi"

Declared by:

+
+ +
+
+
+ + vim.tabline.nvimBufferline.mappings.sortById + + +
+
+

Sort buffers by ID

+ +

Type: +null or string

+ +

Default: +"<leader>bsi"

+ +

Declared by:

+ +
+ <neovim-flake/modules/tabline/nvim-bufferline/nvim-bufferline.nix> -
vim.telescope.enable

Whether to enable telescope.nvim: multi-purpose search and picker utility.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.telescope.enable + + +
+
+

Whether to enable telescope.nvim: multi-purpose search and picker utility.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/telescope/telescope.nix> -
vim.telescope.mappings.buffers

Buffers [Telescope]

Type: -null or string

Default: -"<leader>fb"

Declared by:

+
+ +
+
+
+ + vim.telescope.mappings.buffers + + +
+
+

Buffers [Telescope]

+ +

Type: +null or string

+ +

Default: +"<leader>fb"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/telescope/telescope.nix> -
vim.telescope.mappings.diagnostics

Diagnostics [Telescope]

Type: -null or string

Default: -"<leader>fld"

Declared by:

+
+ +
+
+
+ + vim.telescope.mappings.diagnostics + + +
+
+

Diagnostics [Telescope]

+ +

Type: +null or string

+ +

Default: +"<leader>fld"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/telescope/telescope.nix> -
vim.telescope.mappings.findFiles

Find files [Telescope]

Type: -null or string

Default: -"<leader>ff"

Declared by:

+
+ +
+
+
+ + vim.telescope.mappings.findFiles + + +
+
+

Find files [Telescope]

+ +

Type: +null or string

+ +

Default: +"<leader>ff"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/telescope/telescope.nix> -
vim.telescope.mappings.findProjects

Find files [Telescope]

Type: -null or string

Default: -"<leader>fp"

Declared by:

+
+ +
+
+
+ + vim.telescope.mappings.findProjects + + +
+
+

Find files [Telescope]

+ +

Type: +null or string

+ +

Default: +"<leader>fp"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/telescope/telescope.nix> -
vim.telescope.mappings.gitBranches

Git branches [Telescope]

Type: -null or string

Default: -"<leader>fvb"

Declared by:

+
+ +
+
+
+ + vim.telescope.mappings.gitBranches + + +
+
+

Git branches [Telescope]

+ +

Type: +null or string

+ +

Default: +"<leader>fvb"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/telescope/telescope.nix> -
vim.telescope.mappings.gitBufferCommits

Git buffer commits [Telescope]

Type: -null or string

Default: -"<leader>fvcb"

Declared by:

+
+ +
+
+
+ + vim.telescope.mappings.gitBufferCommits + + +
+
+

Git buffer commits [Telescope]

+ +

Type: +null or string

+ +

Default: +"<leader>fvcb"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/telescope/telescope.nix> -
vim.telescope.mappings.gitCommits

Git commits [Telescope]

Type: -null or string

Default: -"<leader>fvcw"

Declared by:

+
+ +
+
+
+ + vim.telescope.mappings.gitCommits + + +
+
+

Git commits [Telescope]

+ +

Type: +null or string

+ +

Default: +"<leader>fvcw"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/telescope/telescope.nix> -
vim.telescope.mappings.gitStash

Git stash [Telescope]

Type: -null or string

Default: -"<leader>fvx"

Declared by:

+
+ +
+
+
+ + vim.telescope.mappings.gitStash + + +
+
+

Git stash [Telescope]

+ +

Type: +null or string

+ +

Default: +"<leader>fvx"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/telescope/telescope.nix> -
vim.telescope.mappings.gitStatus

Git status [Telescope]

Type: -null or string

Default: -"<leader>fvs"

Declared by:

+
+ +
+
+
+ + vim.telescope.mappings.gitStatus + + +
+
+

Git status [Telescope]

+ +

Type: +null or string

+ +

Default: +"<leader>fvs"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/telescope/telescope.nix> -
vim.telescope.mappings.helpTags

Help tags [Telescope]

Type: -null or string

Default: -"<leader>fh"

Declared by:

+
+ +
+
+
+ + vim.telescope.mappings.helpTags + + +
+
+

Help tags [Telescope]

+ +

Type: +null or string

+ +

Default: +"<leader>fh"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/telescope/telescope.nix> -
vim.telescope.mappings.liveGrep

Live grep [Telescope]

Type: -null or string

Default: -"<leader>fg"

Declared by:

+
+ +
+
+
+ + vim.telescope.mappings.liveGrep + + +
+
+

Live grep [Telescope]

+ +

Type: +null or string

+ +

Default: +"<leader>fg"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/telescope/telescope.nix> -
vim.telescope.mappings.lspDefinitions

LSP Definitions [Telescope]

Type: -null or string

Default: -"<leader>flD"

Declared by:

+
+ +
+
+
+ + vim.telescope.mappings.lspDefinitions + + +
+
+

LSP Definitions [Telescope]

+ +

Type: +null or string

+ +

Default: +"<leader>flD"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/telescope/telescope.nix> -
vim.telescope.mappings.lspDocumentSymbols

LSP Document Symbols [Telescope]

Type: -null or string

Default: -"<leader>flsb"

Declared by:

+
+ +
+
+
+ + vim.telescope.mappings.lspDocumentSymbols + + +
+
+

LSP Document Symbols [Telescope]

+ +

Type: +null or string

+ +

Default: +"<leader>flsb"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/telescope/telescope.nix> -
vim.telescope.mappings.lspImplementations

LSP Implementations [Telescope]

Type: -null or string

Default: -"<leader>fli"

Declared by:

+
+ +
+
+
+ + vim.telescope.mappings.lspImplementations + + +
+
+

LSP Implementations [Telescope]

+ +

Type: +null or string

+ +

Default: +"<leader>fli"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/telescope/telescope.nix> -
vim.telescope.mappings.lspReferences

LSP References [Telescope]

Type: -null or string

Default: -"<leader>flr"

Declared by:

+
+ +
+
+
+ + vim.telescope.mappings.lspReferences + + +
+
+

LSP References [Telescope]

+ +

Type: +null or string

+ +

Default: +"<leader>flr"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/telescope/telescope.nix> -
vim.telescope.mappings.lspTypeDefinitions

LSP Type Definitions [Telescope]

Type: -null or string

Default: -"<leader>flt"

Declared by:

+
+ +
+
+
+ + vim.telescope.mappings.lspTypeDefinitions + + +
+
+

LSP Type Definitions [Telescope]

+ +

Type: +null or string

+ +

Default: +"<leader>flt"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/telescope/telescope.nix> -
vim.telescope.mappings.lspWorkspaceSymbols

LSP Workspace Symbols [Telescope]

Type: -null or string

Default: -"<leader>flsw"

Declared by:

+
+ +
+
+
+ + vim.telescope.mappings.lspWorkspaceSymbols + + +
+
+

LSP Workspace Symbols [Telescope]

+ +

Type: +null or string

+ +

Default: +"<leader>flsw"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/telescope/telescope.nix> -
vim.telescope.mappings.open

Open [Telescope]

Type: -null or string

Default: -"<leader>ft"

Declared by:

+
+ +
+
+
+ + vim.telescope.mappings.open + + +
+
+

Open [Telescope]

+ +

Type: +null or string

+ +

Default: +"<leader>ft"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/telescope/telescope.nix> -
vim.telescope.mappings.treesitter

Treesitter [Telescope]

Type: -null or string

Default: -"<leader>fs"

Declared by:

+
+ +
+
+
+ + vim.telescope.mappings.treesitter + + +
+
+

Treesitter [Telescope]

+ +

Type: +null or string

+ +

Default: +"<leader>fs"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/telescope/telescope.nix> -
vim.terminal.toggleterm.enable

Whether to enable toggleterm as a replacement to built-in terminal command.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.terminal.toggleterm.enable + + +
+
+

Whether to enable toggleterm as a replacement to built-in terminal command.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/terminal/toggleterm/toggleterm.nix> -
vim.terminal.toggleterm.enable_winbar

Enable winbar

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.terminal.toggleterm.enable_winbar + + +
+
+

Enable winbar

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/terminal/toggleterm/toggleterm.nix> -
vim.terminal.toggleterm.direction

Direction of the terminal

Type: -one of “horizontal”, “vertical”, “tab”, “float”

Default: -"horizontal"

Declared by:

+
+ +
+
+
+ + vim.terminal.toggleterm.direction + + +
+
+

Direction of the terminal

+ +

Type: +one of “horizontal”, “vertical”, “tab”, “float”

+ +

Default: +"horizontal"

+ +

Declared by:

+ +
+ <neovim-flake/modules/terminal/toggleterm/toggleterm.nix> -
vim.terminal.toggleterm.lazygit.enable

Whether to enable LazyGit integration.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.terminal.toggleterm.lazygit.enable + + +
+
+

Whether to enable LazyGit integration.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/terminal/toggleterm/toggleterm.nix> -
vim.terminal.toggleterm.lazygit.package

The package that should be used for lazygit. Setting it to null will attempt to use lazygit from your PATH

Type: -null or package

Default: -<derivation lazygit-0.40.2>

Declared by:

+
+ +
+
+
+ + vim.terminal.toggleterm.lazygit.package + + +
+
+

The package that should be used for lazygit. Setting it to null will attempt to use lazygit from your PATH

+ +

Type: +null or package

+ +

Default: +<derivation lazygit-0.40.2>

+ +

Declared by:

+ +
+ <neovim-flake/modules/terminal/toggleterm/toggleterm.nix> -
vim.terminal.toggleterm.lazygit.direction

Direction of the lazygit window

Type: -one of “horizontal”, “vertical”, “tab”, “float”

Default: -"float"

Declared by:

+
+ +
+
+
+ + vim.terminal.toggleterm.lazygit.direction + + +
+
+

Direction of the lazygit window

+ +

Type: +one of “horizontal”, “vertical”, “tab”, “float”

+ +

Default: +"float"

+ +

Declared by:

+ +
+ <neovim-flake/modules/terminal/toggleterm/toggleterm.nix> -
vim.terminal.toggleterm.lazygit.mappings.open

Open lazygit [toggleterm]

Type: -null or string

Default: -"<leader>gg"

Declared by:

+
+ +
+
+
+ + vim.terminal.toggleterm.lazygit.mappings.open + + +
+
+

Open lazygit [toggleterm]

+ +

Type: +null or string

+ +

Default: +"<leader>gg"

+ +

Declared by:

+ +
+ <neovim-flake/modules/terminal/toggleterm/toggleterm.nix> -
vim.terminal.toggleterm.mappings.open

The keymapping to open toggleterm

Type: -null or string

Default: -"<c-t>"

Declared by:

+
+ +
+
+
+ + vim.terminal.toggleterm.mappings.open + + +
+
+

The keymapping to open toggleterm

+ +

Type: +null or string

+ +

Default: +"<c-t>"

+ +

Declared by:

+ +
+ <neovim-flake/modules/terminal/toggleterm/toggleterm.nix> -
vim.theme.enable

Enable theming

Type: -boolean

Declared by:

+
+ +
+
+
+ + vim.theme.enable + + +
+
+

Enable theming

+ +

Type: +boolean

+ +

Declared by:

+ +
+ <neovim-flake/modules/theme/theme.nix> -
vim.theme.extraConfig

Additional lua configuration to add before setup

Type: -strings concatenated with “\n”

Declared by:

+
+ +
+
+
+ + vim.theme.extraConfig + + +
+
+

Additional lua configuration to add before setup

+ +

Type: +strings concatenated with “\n”

+ +

Declared by:

+ +
+ <neovim-flake/modules/theme/theme.nix> -
vim.theme.name

Supported themes can be found in supported_themes.nix

Type: -one of “catppuccin”, “dracula”, “onedark”, “oxocarbon”, “tokyonight”

Declared by:

+
+ +
+
+
+ + vim.theme.name + + +
+
+

Supported themes can be found in supported_themes.nix

+ +

Type: +one of “catppuccin”, “dracula”, “onedark”, “oxocarbon”, “tokyonight”

+ +

Declared by:

+ +
+ <neovim-flake/modules/theme/theme.nix> -
vim.theme.style

Specific style for theme if it supports it

Type: -one of “dark”, “darker”, “cool”, “deep”, “warm”, “warmer”

Declared by:

+
+ +
+
+
+ + vim.theme.style + + +
+
+

Specific style for theme if it supports it

+ +

Type: +one of “dark”, “darker”, “cool”, “deep”, “warm”, “warmer”

+ +

Declared by:

+ +
+ <neovim-flake/modules/theme/theme.nix> -
vim.theme.transparent

Whether or not transparency should be enabled. Has no effect for themes that do not support transparency

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.theme.transparent + + +
+
+

Whether or not transparency should be enabled. Has no effect for themes that do not support transparency

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/theme/theme.nix> -
vim.tidal.enable

Whether to enable tidalcycles tools and plugins.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.tidal.enable + + +
+
+

Whether to enable tidalcycles tools and plugins.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/tidal/tidal.nix> -
vim.tidal.flash

When sending a paragraph or a single line, vim-tidal will “flash” the selection for some milliseconds

Type: -signed integer

Default: -150

Declared by:

+
+ +
+
+
+ + vim.tidal.flash + + +
+
+

When sending a paragraph or a single line, vim-tidal will “flash” the selection for some milliseconds

+ +

Type: +signed integer

+ +

Default: +150

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/tidal/tidal.nix> -
vim.tidal.openSC

Automatically run the supercollider CLI, sclang, alongside the Tidal GHCI terminal.

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.tidal.openSC + + +
+
+

Automatically run the supercollider CLI, sclang, alongside the Tidal GHCI terminal.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/languages/tidal/tidal.nix> -
vim.treesitter.enable

Whether to enable treesitter, also enabled automatically through language options.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.treesitter.enable + + +
+
+

Whether to enable treesitter, also enabled automatically through language options.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/treesitter/treesitter.nix> -
vim.treesitter.autotagHtml

Whether to enable autoclose and rename html tag.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.treesitter.autotagHtml + + +
+
+

Whether to enable autoclose and rename html tag.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/treesitter/treesitter.nix> -
vim.treesitter.context.enable

Whether to enable context of current buffer contents [nvim-treesitter-context] .

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.treesitter.context.enable + + +
+
+

Whether to enable context of current buffer contents [nvim-treesitter-context] .

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/treesitter/context.nix> -
vim.treesitter.context.lineNumbers

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.treesitter.context.lineNumbers + + +
+
+

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/treesitter/context.nix> -
vim.treesitter.context.maxLines

How many lines the window should span. Values <=0 mean no limit.

Type: -signed integer

Default: -0

Declared by:

+
+ +
+
+
+ + vim.treesitter.context.maxLines + + +
+
+

How many lines the window should span. Values <=0 mean no limit.

+ +

Type: +signed integer

+ +

Default: +0

+ +

Declared by:

+ +
+ <neovim-flake/modules/treesitter/context.nix> -
vim.treesitter.context.minWindowHeight

Minimum editor window height to enable context. Values <= 0 mean no limit.

Type: -signed integer

Default: -0

Declared by:

+
+ +
+
+
+ + vim.treesitter.context.minWindowHeight + + +
+
+

Minimum editor window height to enable context. Values <= 0 mean no limit.

+ +

Type: +signed integer

+ +

Default: +0

+ +

Declared by:

+ +
+ <neovim-flake/modules/treesitter/context.nix> -
vim.treesitter.context.mode

Line used to calculate context.

Type: -one of “cursor”, “topline”

Default: -"cursor"

Declared by:

+
+ +
+
+
+ + vim.treesitter.context.mode + + +
+
+

Line used to calculate context.

+ +

Type: +one of “cursor”, “topline”

+ +

Default: +"cursor"

+ +

Declared by:

+ +
+ <neovim-flake/modules/treesitter/context.nix> -
vim.treesitter.context.multilineThreshold

Maximum number of lines to collapse for a single context line.

Type: -signed integer

Default: -20

Declared by:

+
+ +
+
+
+ + vim.treesitter.context.multilineThreshold + + +
+
+

Maximum number of lines to collapse for a single context line.

+ +

Type: +signed integer

+ +

Default: +20

+ +

Declared by:

+ +
+ <neovim-flake/modules/treesitter/context.nix> -
vim.treesitter.context.separator

Separator between context and content. Should be a single character string, like ‘-’.

When separator is set, the context will only show up when there are at least 2 lines above cursorline.

Type: -null or string

Default: -null

Declared by:

+
+ +
+
+
+ + vim.treesitter.context.separator + + +
+
+

Separator between context and content. Should be a single character string, like ‘-’.

When separator is set, the context will only show up when there are at least 2 lines above cursorline.

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ +
+ <neovim-flake/modules/treesitter/context.nix> -
vim.treesitter.context.trimScope

Which context lines to discard if vim.treesitter.context.maxLines is exceeded.

Type: -one of “inner”, “outer”

Default: -"outer"

Declared by:

+
+ +
+
+
+ + vim.treesitter.context.trimScope + + +
+
+

Which context lines to discard if vim.treesitter.context.maxLines is exceeded.

+ +

Type: +one of “inner”, “outer”

+ +

Default: +"outer"

+ +

Declared by:

+ +
+ <neovim-flake/modules/treesitter/context.nix> -
vim.treesitter.context.zindex

The Z-index of the context window.

Type: -signed integer

Default: -20

Declared by:

+
+ +
+
+
+ + vim.treesitter.context.zindex + + +
+
+

The Z-index of the context window.

+ +

Type: +signed integer

+ +

Default: +20

+ +

Declared by:

+ +
+ <neovim-flake/modules/treesitter/context.nix> -
vim.treesitter.fold

Whether to enable fold with treesitter.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.treesitter.fold + + +
+
+

Whether to enable fold with treesitter.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/treesitter/treesitter.nix> -
vim.treesitter.grammars

List of treesitter grammars to install. For supported languages -use the vim.language.<lang>.treesitter option

Type: -list of package

Default: -[ ]

Declared by:

+
+ +
+
+
+ + vim.treesitter.grammars + + +
+
+

List of treesitter grammars to install. For supported languages +use the vim.language.<lang>.treesitter option

+ +

Type: +list of package

+ +

Default: +[ ]

+ +

Declared by:

+ +
+ <neovim-flake/modules/treesitter/treesitter.nix> -
vim.treesitter.mappings.incrementalSelection.decrementByNode

Decrement selection by node [treesitter]

Type: -null or string

Default: -"grm"

Declared by:

+
+ +
+
+
+ + vim.treesitter.mappings.incrementalSelection.decrementByNode + + +
+
+

Decrement selection by node [treesitter]

+ +

Type: +null or string

+ +

Default: +"grm"

+ +

Declared by:

+ +
+ <neovim-flake/modules/treesitter/treesitter.nix> -
vim.treesitter.mappings.incrementalSelection.incrementByNode

Increment selection by node [treesitter]

Type: -null or string

Default: -"grn"

Declared by:

+
+ +
+
+
+ + vim.treesitter.mappings.incrementalSelection.incrementByNode + + +
+
+

Increment selection by node [treesitter]

+ +

Type: +null or string

+ +

Default: +"grn"

+ +

Declared by:

+ +
+ <neovim-flake/modules/treesitter/treesitter.nix> -
vim.treesitter.mappings.incrementalSelection.incrementByScope

Increment selection by scope [treesitter]

Type: -null or string

Default: -"grc"

Declared by:

+
+ +
+
+
+ + vim.treesitter.mappings.incrementalSelection.incrementByScope + + +
+
+

Increment selection by scope [treesitter]

+ +

Type: +null or string

+ +

Default: +"grc"

+ +

Declared by:

+ +
+ <neovim-flake/modules/treesitter/treesitter.nix> -
vim.treesitter.mappings.incrementalSelection.init

Init selection [treesitter]

Type: -null or string

Default: -"gnn"

Declared by:

+
+ +
+
+
+ + vim.treesitter.mappings.incrementalSelection.init + + +
+
+

Init selection [treesitter]

+ +

Type: +null or string

+ +

Default: +"gnn"

+ +

Declared by:

+ +
+ <neovim-flake/modules/treesitter/treesitter.nix> -
vim.ui.borders.enable

Whether to enable visible borders for most windows.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.ui.borders.enable + + +
+
+

Whether to enable visible borders for most windows.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/borders/borders.nix> -
vim.ui.borders.globalStyle

global border style to use

Type: -one of “none”, “single”, “double”, “rounded”

Default: -"rounded"

Declared by:

+
+ +
+
+
+ + vim.ui.borders.globalStyle + + +
+
+

global border style to use

+ +

Type: +one of “none”, “single”, “double”, “rounded”

+ +

Default: +"rounded"

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/borders/borders.nix> -
vim.ui.borders.plugins.code-action-menu.enable

Whether to enable borders for the code-actions-menu plugin.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.ui.borders.plugins.code-action-menu.enable + + +
+
+

Whether to enable borders for the code-actions-menu plugin.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/borders/borders.nix> -
vim.ui.borders.plugins.code-action-menu.style

border style to use for the code-actions-menu plugin

Type: -one of “none”, “single”, “double”, “rounded”, “shadow”

Default: -"rounded"

Declared by:

+
+ +
+
+
+ + vim.ui.borders.plugins.code-action-menu.style + + +
+
+

border style to use for the code-actions-menu plugin

+ +

Type: +one of “none”, “single”, “double”, “rounded”, “shadow”

+ +

Default: +"rounded"

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/borders/borders.nix> -
vim.ui.borders.plugins.lsp-signature.enable

Whether to enable borders for the lsp-signature plugin.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.ui.borders.plugins.lsp-signature.enable + + +
+
+

Whether to enable borders for the lsp-signature plugin.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/borders/borders.nix> -
vim.ui.borders.plugins.lsp-signature.style

border style to use for the lsp-signature plugin

Type: -one of “none”, “single”, “double”, “rounded”, “shadow”

Default: -"rounded"

Declared by:

+
+ +
+
+
+ + vim.ui.borders.plugins.lsp-signature.style + + +
+
+

border style to use for the lsp-signature plugin

+ +

Type: +one of “none”, “single”, “double”, “rounded”, “shadow”

+ +

Default: +"rounded"

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/borders/borders.nix> -
vim.ui.borders.plugins.lspsaga.enable

Whether to enable borders for the lspsaga plugin.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.ui.borders.plugins.lspsaga.enable + + +
+
+

Whether to enable borders for the lspsaga plugin.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/borders/borders.nix> -
vim.ui.borders.plugins.lspsaga.style

border style to use for the lspsaga plugin

Type: -one of “none”, “single”, “double”, “rounded”, “shadow”

Default: -"rounded"

Declared by:

+
+ +
+
+
+ + vim.ui.borders.plugins.lspsaga.style + + +
+
+

border style to use for the lspsaga plugin

+ +

Type: +one of “none”, “single”, “double”, “rounded”, “shadow”

+ +

Default: +"rounded"

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/borders/borders.nix> -
vim.ui.borders.plugins.nvim-cmp.enable

Whether to enable borders for the nvim-cmp plugin.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.ui.borders.plugins.nvim-cmp.enable + + +
+
+

Whether to enable borders for the nvim-cmp plugin.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/borders/borders.nix> -
vim.ui.borders.plugins.nvim-cmp.style

border style to use for the nvim-cmp plugin

Type: -one of “none”, “single”, “double”, “rounded”, “shadow”

Default: -"rounded"

Declared by:

+
+ +
+
+
+ + vim.ui.borders.plugins.nvim-cmp.style + + +
+
+

border style to use for the nvim-cmp plugin

+ +

Type: +one of “none”, “single”, “double”, “rounded”, “shadow”

+ +

Default: +"rounded"

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/borders/borders.nix> -
vim.ui.borders.plugins.which-key.enable

Whether to enable borders for the which-key plugin.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.ui.borders.plugins.which-key.enable + + +
+
+

Whether to enable borders for the which-key plugin.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/borders/borders.nix> -
vim.ui.borders.plugins.which-key.style

border style to use for the which-key plugin

Type: -one of “none”, “single”, “double”, “rounded”

Default: -"rounded"

Declared by:

+
+ +
+
+
+ + vim.ui.borders.plugins.which-key.style + + +
+
+

border style to use for the which-key plugin

+ +

Type: +one of “none”, “single”, “double”, “rounded”

+ +

Default: +"rounded"

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/borders/borders.nix> -
vim.ui.breadcrumbs.enable

Whether to enable breadcrumbs.

Type: -boolean

Default: -false

Example: -true

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.alwaysRender

Whether to always display the breadcrumbs component on winbar (always renders winbar)

Type: -boolean

Default: -true

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.enable

Whether to enable navbuddy LSP helper UI. Enabling this option automatically loads and enables nvim-navic.

Type: -boolean

Default: -false

Example: -true

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.package

Type: -string

Default: -" "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.array

Type: -string

Default: -"󰅪 "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.boolean

Type: -string

Default: -"◩ "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.class

Type: -string

Default: -"󰌗 "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.constant

Type: -string

Default: -"󰏿 "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.constructor

Type: -string

Default: -" "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.enum

Type: -string

Default: -"󰕘"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.enumMember

Type: -string

Default: -"󰕘 "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.event

Type: -string

Default: -" "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.field

Type: -string

Default: -" "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.file

Type: -string

Default: -"󰈙 "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.function

Type: -string

Default: -"󰊕 "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.interface

Type: -string

Default: -"󰕘"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.key

Type: -string

Default: -"󰌋 "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.method

Type: -string

Default: -"󰆧 "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.module

Type: -string

Default: -" "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.namespace

Type: -string

Default: -"󰌗 "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.null

Type: -string

Default: -"󰟢 "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.number

Type: -string

Default: -"󰎠 "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.object

Type: -string

Default: -"󰅩 "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.operator

Type: -string

Default: -"󰆕 "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.property

Type: -string

Default: -" "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.string

Type: -string

Default: -" "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.struct

Type: -string

Default: -"󰌗 "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.typeParameter

Type: -string

Default: -"󰊄 "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.icons.variable

Type: -string

Default: -"󰆧 "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.lsp.autoAttach

Whether to attach to LSP server manually

Type: -boolean

Default: -true

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.lsp.preference

list of lsp server names in order of preference

Type: -null or (list of string)

Default: -null

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.mappings.appendName

insert at end of name

Type: -string

Default: -"a"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.mappings.appendScope

insert at end of scope

Type: -string

Default: -"A"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.mappings.children

keybinding to navigate to the child node

Type: -string

Default: -"h"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.mappings.close

keybinding to close Navbuddy UI

Type: -string

Default: -"<esc>"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.mappings.comment

comment the node

Type: -string

Default: -"c"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.mappings.delete

delete the node

Type: -string

Default: -"d"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.mappings.foldCreate

create a new fold

Type: -string

Default: -"f"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.mappings.foldDelete

delete the current fold

Type: -string

Default: -"F"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.mappings.help

open mapping help window

Type: -string

Default: -"g?"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.mappings.insertName

insert at start of name

Type: -string

Default: -"i"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.mappings.insertScope

insert at start of scope

Type: -string

Default: -"I"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.mappings.moveDown

move focused node down

Type: -string

Default: -"J"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.mappings.moveUp

move focused node up

Type: -string

Default: -"K"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.mappings.nextSibling

keybinding to navigate to the next sibling node

Type: -string

Default: -"j"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.mappings.parent

keybinding to navigate to the parent node

Type: -string

Default: -"h"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.mappings.previousSibling

keybinding to navigate to the previous sibling node

Type: -string

Default: -"k"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.mappings.rename

rename the node

Type: -string

Default: -"r"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.mappings.root

keybinding to navigate to the root node

Type: -string

Default: -"0"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.mappings.select

goto selected symbol

Type: -string

Default: -"<enter>"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.mappings.telescope

fuzzy finder at current level

Type: -string

Default: -"t"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.mappings.visualName

visual selection of name

Type: -string

Default: -"v"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.mappings.visualScope

visual selection of scope

Type: -string

Default: -"V"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.mappings.yankName

yank the name to system clipboard

Type: -string

Default: -"y"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.mappings.yankScope

yank the scope to system clipboard

Type: -string

Default: -"Y"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.nodeMarkers.enable

Whether to enable node markers.

Type: -boolean

Default: -false

Example: -true

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.nodeMarkers.icons.branch

Type: -string

Default: -" "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.nodeMarkers.icons.leaf

Type: -string

Default: -" "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.nodeMarkers.icons.leafSelected

Type: -string

Default: -" → "

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.sourceBuffer.followNode

keep the current node in focus on the source buffer

Type: -boolean

Default: -true

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.sourceBuffer.highlight

highlight the currently focused node

Type: -boolean

Default: -true

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.sourceBuffer.reorient

reorient buffer after changing nodes

Type: -one of “smart”, “top”, “mid”, “none”

Default: -"smart"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.sourceBuffer.scrolloff

scrolloff value when navbuddy is open

Type: -null or signed integer

Default: -null

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.useDefaultMappings

use default Navbuddy keybindings (disables user-specified keybinds)

Type: -boolean

Default: -true

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.window.border

border style to use

Type: -one of “single”, “rounded”, “double”, “solid”, “none”

Default: -"rounded"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.window.scrolloff

Scrolloff value within navbuddy window

Type: -null or signed integer

Default: -null

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.window.sections.left.border

border style to use for the left section of Navbuddy UI

Type: -null or one of “single”, “rounded”, “double”, “solid”, “none”

Default: -"rounded"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.window.sections.mid.border

border style to use for the middle section of Navbuddy UI

Type: -null or one of “single”, “rounded”, “double”, “solid”, “none”

Default: -"rounded"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.window.sections.right.border

border style to use for the right section of Navbuddy UI

Type: -null or one of “single”, “rounded”, “double”, “solid”, “none”

Default: -"rounded"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.navbuddy.window.sections.right.preview

display mode of the preview on the right section

Type: -one of “leaf”, “always”, “never”

Default: -"leaf"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.breadcrumbs.source

The source to be used for breadcrumbs component. Null means no breadcrumbs.

Type: -null or value “nvim-navic” (singular enum)

Default: -"nvim-navic"

Declared by:

-<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> -
vim.ui.colorizer.enable

Whether to enable nvim-colorizer.lua for color highlighting.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.ui.breadcrumbs.enable + + +
+
+

Whether to enable breadcrumbs.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.alwaysRender + + +
+
+

Whether to always display the breadcrumbs component on winbar (always renders winbar)

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.enable + + +
+
+

Whether to enable navbuddy LSP helper UI. Enabling this option automatically loads and enables nvim-navic.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.package + + +
+
+

Type: +string

+ +

Default: +" "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.array + + +
+
+

Type: +string

+ +

Default: +"󰅪 "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.boolean + + +
+
+

Type: +string

+ +

Default: +"◩ "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.class + + +
+
+

Type: +string

+ +

Default: +"󰌗 "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.constant + + +
+
+

Type: +string

+ +

Default: +"󰏿 "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.constructor + + +
+
+

Type: +string

+ +

Default: +" "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.enum + + +
+
+

Type: +string

+ +

Default: +"󰕘"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.enumMember + + +
+
+

Type: +string

+ +

Default: +"󰕘 "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.event + + +
+
+

Type: +string

+ +

Default: +" "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.field + + +
+
+

Type: +string

+ +

Default: +" "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.file + + +
+
+

Type: +string

+ +

Default: +"󰈙 "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.function + + +
+
+

Type: +string

+ +

Default: +"󰊕 "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.interface + + +
+
+

Type: +string

+ +

Default: +"󰕘"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.key + + +
+
+

Type: +string

+ +

Default: +"󰌋 "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.method + + +
+
+

Type: +string

+ +

Default: +"󰆧 "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.module + + +
+
+

Type: +string

+ +

Default: +" "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.namespace + + +
+
+

Type: +string

+ +

Default: +"󰌗 "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.null + + +
+
+

Type: +string

+ +

Default: +"󰟢 "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.number + + +
+
+

Type: +string

+ +

Default: +"󰎠 "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.object + + +
+
+

Type: +string

+ +

Default: +"󰅩 "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.operator + + +
+
+

Type: +string

+ +

Default: +"󰆕 "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.property + + +
+
+

Type: +string

+ +

Default: +" "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.string + + +
+
+

Type: +string

+ +

Default: +" "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.struct + + +
+
+

Type: +string

+ +

Default: +"󰌗 "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.typeParameter + + +
+
+

Type: +string

+ +

Default: +"󰊄 "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.icons.variable + + +
+
+

Type: +string

+ +

Default: +"󰆧 "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.lsp.autoAttach + + +
+
+

Whether to attach to LSP server manually

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.lsp.preference + + +
+
+

list of lsp server names in order of preference

+ +

Type: +null or (list of string)

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.mappings.appendName + + +
+
+

insert at end of name

+ +

Type: +string

+ +

Default: +"a"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.mappings.appendScope + + +
+
+

insert at end of scope

+ +

Type: +string

+ +

Default: +"A"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.mappings.children + + +
+
+

keybinding to navigate to the child node

+ +

Type: +string

+ +

Default: +"h"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.mappings.close + + +
+
+

keybinding to close Navbuddy UI

+ +

Type: +string

+ +

Default: +"<esc>"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.mappings.comment + + +
+
+

comment the node

+ +

Type: +string

+ +

Default: +"c"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.mappings.delete + + +
+
+

delete the node

+ +

Type: +string

+ +

Default: +"d"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.mappings.foldCreate + + +
+
+

create a new fold

+ +

Type: +string

+ +

Default: +"f"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.mappings.foldDelete + + +
+
+

delete the current fold

+ +

Type: +string

+ +

Default: +"F"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.mappings.help + + +
+
+

open mapping help window

+ +

Type: +string

+ +

Default: +"g?"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.mappings.insertName + + +
+
+

insert at start of name

+ +

Type: +string

+ +

Default: +"i"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.mappings.insertScope + + +
+
+

insert at start of scope

+ +

Type: +string

+ +

Default: +"I"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.mappings.moveDown + + +
+
+

move focused node down

+ +

Type: +string

+ +

Default: +"J"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.mappings.moveUp + + +
+
+

move focused node up

+ +

Type: +string

+ +

Default: +"K"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.mappings.nextSibling + + +
+
+

keybinding to navigate to the next sibling node

+ +

Type: +string

+ +

Default: +"j"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.mappings.parent + + +
+
+

keybinding to navigate to the parent node

+ +

Type: +string

+ +

Default: +"h"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.mappings.previousSibling + + +
+
+

keybinding to navigate to the previous sibling node

+ +

Type: +string

+ +

Default: +"k"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.mappings.rename + + +
+
+

rename the node

+ +

Type: +string

+ +

Default: +"r"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.mappings.root + + +
+
+

keybinding to navigate to the root node

+ +

Type: +string

+ +

Default: +"0"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.mappings.select + + +
+
+

goto selected symbol

+ +

Type: +string

+ +

Default: +"<enter>"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.mappings.telescope + + +
+
+

fuzzy finder at current level

+ +

Type: +string

+ +

Default: +"t"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.mappings.visualName + + +
+
+

visual selection of name

+ +

Type: +string

+ +

Default: +"v"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.mappings.visualScope + + +
+
+

visual selection of scope

+ +

Type: +string

+ +

Default: +"V"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.mappings.yankName + + +
+
+

yank the name to system clipboard

+ +

Type: +string

+ +

Default: +"y"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.mappings.yankScope + + +
+
+

yank the scope to system clipboard

+ +

Type: +string

+ +

Default: +"Y"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.nodeMarkers.enable + + +
+
+

Whether to enable node markers.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.nodeMarkers.icons.branch + + +
+
+

Type: +string

+ +

Default: +" "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.nodeMarkers.icons.leaf + + +
+
+

Type: +string

+ +

Default: +" "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.nodeMarkers.icons.leafSelected + + +
+
+

Type: +string

+ +

Default: +" → "

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.sourceBuffer.followNode + + +
+
+

keep the current node in focus on the source buffer

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.sourceBuffer.highlight + + +
+
+

highlight the currently focused node

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.sourceBuffer.reorient + + +
+
+

reorient buffer after changing nodes

+ +

Type: +one of “smart”, “top”, “mid”, “none”

+ +

Default: +"smart"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.sourceBuffer.scrolloff + + +
+
+

scrolloff value when navbuddy is open

+ +

Type: +null or signed integer

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.useDefaultMappings + + +
+
+

use default Navbuddy keybindings (disables user-specified keybinds)

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.window.border + + +
+
+

border style to use

+ +

Type: +one of “single”, “rounded”, “double”, “solid”, “none”

+ +

Default: +"rounded"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.window.scrolloff + + +
+
+

Scrolloff value within navbuddy window

+ +

Type: +null or signed integer

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.window.sections.left.border + + +
+
+

border style to use for the left section of Navbuddy UI

+ +

Type: +null or one of “single”, “rounded”, “double”, “solid”, “none”

+ +

Default: +"rounded"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.window.sections.mid.border + + +
+
+

border style to use for the middle section of Navbuddy UI

+ +

Type: +null or one of “single”, “rounded”, “double”, “solid”, “none”

+ +

Default: +"rounded"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.window.sections.right.border + + +
+
+

border style to use for the right section of Navbuddy UI

+ +

Type: +null or one of “single”, “rounded”, “double”, “solid”, “none”

+ +

Default: +"rounded"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.navbuddy.window.sections.right.preview + + +
+
+

display mode of the preview on the right section

+ +

Type: +one of “leaf”, “always”, “never”

+ +

Default: +"leaf"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.breadcrumbs.source + + +
+
+

The source to be used for breadcrumbs component. Null means no breadcrumbs.

+ +

Type: +null or value “nvim-navic” (singular enum)

+ +

Default: +"nvim-navic"

+ +

Declared by:

+ + +
+ +<neovim-flake/modules/ui/breadcrumbs/breadcrumbs.nix> + +
+
+
+ + vim.ui.colorizer.enable + + +
+
+

Whether to enable nvim-colorizer.lua for color highlighting.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/colorizer/colorizer.nix> -
vim.ui.colorizer.options.css

Enable all CSS features: rgb_fn, hsl_fn, names, RGB, RRGGBB

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.ui.colorizer.options.css + + +
+
+

Enable all CSS features: rgb_fn, hsl_fn, names, RGB, RRGGBB

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/colorizer/colorizer.nix> -
vim.ui.colorizer.options.css_fn

Enable all CSS functions: rgb_fn, hsl_fn

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.ui.colorizer.options.css_fn + + +
+
+

Enable all CSS functions: rgb_fn, hsl_fn

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/colorizer/colorizer.nix> -
vim.ui.colorizer.options.hsl_fn

CSS hsl() and hsla() functions

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.ui.colorizer.options.hsl_fn + + +
+
+

CSS hsl() and hsla() functions

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/colorizer/colorizer.nix> -
vim.ui.colorizer.options.mode

Set the display mode

Type: -one of “foreground”, “background”

Default: -"background"

Declared by:

+
+ +
+
+
+ + vim.ui.colorizer.options.mode + + +
+
+

Set the display mode

+ +

Type: +one of “foreground”, “background”

+ +

Default: +"background"

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/colorizer/colorizer.nix> -
vim.ui.colorizer.options.names

“Name” codes such as “Blue”

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.ui.colorizer.options.names + + +
+
+

“Name” codes such as “Blue”

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/colorizer/colorizer.nix> -
vim.ui.colorizer.options.rgb

#RGB hex codes

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.ui.colorizer.options.rgb + + +
+
+

#RGB hex codes

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/colorizer/colorizer.nix> -
vim.ui.colorizer.options.rgb_fn

CSS rgb() and rgba() functions

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.ui.colorizer.options.rgb_fn + + +
+
+

CSS rgb() and rgba() functions

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/colorizer/colorizer.nix> -
vim.ui.colorizer.options.rrggbb

#RRGGBB hex codes

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.ui.colorizer.options.rrggbb + + +
+
+

#RRGGBB hex codes

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/colorizer/colorizer.nix> -
vim.ui.colorizer.options.rrggbbaa

#RRGGBBAA hex codes

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.ui.colorizer.options.rrggbbaa + + +
+
+

#RRGGBBAA hex codes

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/colorizer/colorizer.nix> -
vim.ui.illuminate.enable

Whether to enable vim-illuminate: automatically highlight other uses of the word under the cursor.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.ui.illuminate.enable + + +
+
+

Whether to enable vim-illuminate: automatically highlight other uses of the word under the cursor.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/illuminate/illuminate.nix> -
vim.ui.modes-nvim.enable

Whether to enable modes.nvim’s prismatic line decorations.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.ui.modes-nvim.enable + + +
+
+

Whether to enable modes.nvim’s prismatic line decorations.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/modes/modes.nix> -
vim.ui.modes-nvim.colors.copy

The #RRGGBB color code for the visual mode highlights

Type: -string

Default: -"#f5c359"

Declared by:

+
+ +
+
+
+ + vim.ui.modes-nvim.colors.copy + + +
+
+

The #RRGGBB color code for the visual mode highlights

+ +

Type: +string

+ +

Default: +"#f5c359"

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/modes/modes.nix> -
vim.ui.modes-nvim.colors.delete

The #RRGGBB color code for the visual mode highlights

Type: -string

Default: -"#c75c6a"

Declared by:

+
+ +
+
+
+ + vim.ui.modes-nvim.colors.delete + + +
+
+

The #RRGGBB color code for the visual mode highlights

+ +

Type: +string

+ +

Default: +"#c75c6a"

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/modes/modes.nix> -
vim.ui.modes-nvim.colors.insert

The #RRGGBB color code for the visual mode highlights

Type: -string

Default: -"#78ccc5"

Declared by:

+
+ +
+
+
+ + vim.ui.modes-nvim.colors.insert + + +
+
+

The #RRGGBB color code for the visual mode highlights

+ +

Type: +string

+ +

Default: +"#78ccc5"

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/modes/modes.nix> -
vim.ui.modes-nvim.colors.visual

The #RRGGBB color code for the visual mode highlights

Type: -string

Default: -"#9745be"

Declared by:

+
+ +
+
+
+ + vim.ui.modes-nvim.colors.visual + + +
+
+

The #RRGGBB color code for the visual mode highlights

+ +

Type: +string

+ +

Default: +"#9745be"

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/modes/modes.nix> -
vim.ui.modes-nvim.setCursorline

Set a colored cursorline on current line

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.ui.modes-nvim.setCursorline + + +
+
+

Set a colored cursorline on current line

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/modes/modes.nix> -
vim.ui.noice.enable

Whether to enable noice-nvim UI modification library.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.ui.noice.enable + + +
+
+

Whether to enable noice-nvim UI modification library.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/noice/noice.nix> -
vim.ui.smartcolumn.enable

Whether to enable line length indicator.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.ui.smartcolumn.enable + + +
+
+

Whether to enable line length indicator.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/smartcolumn/smartcolumn.nix> -
vim.ui.smartcolumn.columnAt.languages

The position at which smart column should be displayed for each individual buffer type

Type: -attribute set of (signed integer or list of signed integer)

Example:

vim.ui.smartcolumn.columnAt.languages = {
+
+
+
+
+ + vim.ui.smartcolumn.columnAt.languages + + +
+
+

The position at which smart column should be displayed for each individual buffer type

+ +

Type: +attribute set of (signed integer or list of signed integer)

+ +

Example:

vim.ui.smartcolumn.columnAt.languages = {
   nix = 110;
   ruby = 120;
   java = 130;
   go = [90 130];
 };
 
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/ui/smartcolumn/smartcolumn.nix> -
vim.ui.smartcolumn.disabledFiletypes

The filetypes smartcolumn will be disabled for.

Type: -list of string

Default:

[
-  "help"
-  "text"
-  "markdown"
-  "NvimTree"
-  "alpha"
+
+
+
+
+ + vim.ui.smartcolumn.disabledFiletypes + + +
+
+

The filetypes smartcolumn will be disabled for.

+ +

Type: +list of string

+ +

Default:

[
+  "help"
+  "text"
+  "markdown"
+  "NvimTree"
+  "alpha"
 ]
-

Declared by:

+
+ + +

Declared by:

+ +
+ <neovim-flake/modules/ui/smartcolumn/smartcolumn.nix> -
vim.ui.smartcolumn.showColumnAt

The position at which the column will be displayed. Set to null to disable

Type: -null or signed integer

Default: -120

Declared by:

+
+ +
+
+
+ + vim.ui.smartcolumn.showColumnAt + + +
+
+

The position at which the column will be displayed. Set to null to disable

+ +

Type: +null or signed integer

+ +

Default: +120

+ +

Declared by:

+ +
+ <neovim-flake/modules/ui/smartcolumn/smartcolumn.nix> -
vim.updateTime

The number of milliseconds till Cursor Hold event is fired

Type: -signed integer

Default: -300

Declared by:

+
+ +
+
+
+ + vim.updateTime + + +
+
+

The number of milliseconds till Cursor Hold event is fired

+ +

Type: +signed integer

+ +

Default: +300

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.useSystemClipboard

Make use of the clipboard for default yank and paste operations. Don’t use * and +

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.useSystemClipboard + + +
+
+

Make use of the clipboard for default yank and paste operations. Don’t use * and +

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
vim.utility.ccc.enable

Whether to enable ccc color picker for neovim.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.utility.ccc.enable + + +
+
+

Whether to enable ccc color picker for neovim.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/ccc/ccc.nix> -
vim.utility.ccc.mappings.decrease10

Decrease the value times delta of the slider

Type: -null or string

Default: -"<H>"

Declared by:

+
+ +
+
+
+ + vim.utility.ccc.mappings.decrease10 + + +
+
+

Decrease the value times delta of the slider

+ +

Type: +null or string

+ +

Default: +"<H>"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/ccc/ccc.nix> -
vim.utility.ccc.mappings.increase10

Increase the value times delta of the slider

Type: -null or string

Default: -"<L>"

Declared by:

+
+ +
+
+
+ + vim.utility.ccc.mappings.increase10 + + +
+
+

Increase the value times delta of the slider

+ +

Type: +null or string

+ +

Default: +"<L>"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/ccc/ccc.nix> -
vim.utility.ccc.mappings.quit

Cancel and close the UI without replace or insert

Type: -null or string

Default: -"<Esc>"

Declared by:

+
+ +
+
+
+ + vim.utility.ccc.mappings.quit + + +
+
+

Cancel and close the UI without replace or insert

+ +

Type: +null or string

+ +

Default: +"<Esc>"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/ccc/ccc.nix> -
vim.utility.diffview-nvim.enable

Whether to enable diffview-nvim: cycle through diffs for all modified files for any git rev.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.utility.diffview-nvim.enable + + +
+
+

Whether to enable diffview-nvim: cycle through diffs for all modified files for any git rev.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/diffview/diffview.nix> -
vim.utility.icon-picker.enable

Whether to enable nerdfonts icon picker for nvim.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.utility.icon-picker.enable + + +
+
+

Whether to enable nerdfonts icon picker for nvim.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/icon-picker/icon-picker.nix> -
vim.utility.motion.hop.enable

Whether to enable Hop.nvim plugin (easy motion).

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.utility.motion.hop.enable + + +
+
+

Whether to enable Hop.nvim plugin (easy motion).

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/motion/hop/hop.nix> -
vim.utility.motion.hop.mappings.hop

Jump to occurences [hop.nvim]

Type: -null or string

Default: -"<leader>h"

Declared by:

+
+ +
+
+
+ + vim.utility.motion.hop.mappings.hop + + +
+
+

Jump to occurences [hop.nvim]

+ +

Type: +null or string

+ +

Default: +"<leader>h"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/motion/hop/hop.nix> -
vim.utility.motion.leap.enable

Whether to enable leap.nvim plugin (easy motion).

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.utility.motion.leap.enable + + +
+
+

Whether to enable leap.nvim plugin (easy motion).

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/motion/leap/leap.nix> -
vim.utility.motion.leap.mappings.leapBackwardTill

Leap backward till

Type: -null or string

Default: -"X"

Declared by:

+
+ +
+
+
+ + vim.utility.motion.leap.mappings.leapBackwardTill + + +
+
+

Leap backward till

+ +

Type: +null or string

+ +

Default: +"X"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/motion/leap/leap.nix> -
vim.utility.motion.leap.mappings.leapBackwardTo

Leap backward to

Type: -null or string

Default: -"S"

Declared by:

+
+ +
+
+
+ + vim.utility.motion.leap.mappings.leapBackwardTo + + +
+
+

Leap backward to

+ +

Type: +null or string

+ +

Default: +"S"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/motion/leap/leap.nix> -
vim.utility.motion.leap.mappings.leapForwardTill

Leap forward till

Type: -null or string

Default: -"x"

Declared by:

+
+ +
+
+
+ + vim.utility.motion.leap.mappings.leapForwardTill + + +
+
+

Leap forward till

+ +

Type: +null or string

+ +

Default: +"x"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/motion/leap/leap.nix> -
vim.utility.motion.leap.mappings.leapForwardTo

Leap forward to

Type: -null or string

Default: -"s"

Declared by:

+
+ +
+
+
+ + vim.utility.motion.leap.mappings.leapForwardTo + + +
+
+

Leap forward to

+ +

Type: +null or string

+ +

Default: +"s"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/motion/leap/leap.nix> -
vim.utility.motion.leap.mappings.leapFromWindow

Leap from window

Type: -null or string

Default: -"gs"

Declared by:

+
+ +
+
+
+ + vim.utility.motion.leap.mappings.leapFromWindow + + +
+
+

Leap from window

+ +

Type: +null or string

+ +

Default: +"gs"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/motion/leap/leap.nix> -
vim.utility.surround.enable

nvim-surround: add/change/delete surrounding delimiter pairs with ease. Note that the default mappings deviate from upstreeam to avoid conflicts with nvim-leap.

Type: -boolean

Default: -false

Declared by:

+
+ +
+
+
+ + vim.utility.surround.enable + + +
+
+

nvim-surround: add/change/delete surrounding delimiter pairs with ease. Note that the default mappings deviate from upstreeam to avoid conflicts with nvim-leap.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/surround/surround.nix> -
vim.utility.surround.mappings.change

Change surrounding character

Type: -null or string

Default: -"gzr"

Declared by:

+
+ +
+
+
+ + vim.utility.surround.mappings.change + + +
+
+

Change surrounding character

+ +

Type: +null or string

+ +

Default: +"gzr"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/surround/surround.nix> -
vim.utility.surround.mappings.delete

Delete surrounding character

Type: -null or string

Default: -"gzd"

Declared by:

+
+ +
+
+
+ + vim.utility.surround.mappings.delete + + +
+
+

Delete surrounding character

+ +

Type: +null or string

+ +

Default: +"gzd"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/surround/surround.nix> -
vim.utility.surround.mappings.insert

Add surround character around the cursor

Type: -null or string

Default: -"<C-g>z"

Declared by:

+
+ +
+
+
+ + vim.utility.surround.mappings.insert + + +
+
+

Add surround character around the cursor

+ +

Type: +null or string

+ +

Default: +"<C-g>z"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/surround/surround.nix> -
vim.utility.surround.mappings.insertLine

Add surround character around the cursor on new lines

Type: -null or string

Default: -"<C-g>Z"

Declared by:

+
+ +
+
+
+ + vim.utility.surround.mappings.insertLine + + +
+
+

Add surround character around the cursor on new lines

+ +

Type: +null or string

+ +

Default: +"<C-g>Z"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/surround/surround.nix> -
vim.utility.surround.mappings.normal

Surround motion with character

Type: -null or string

Default: -"gz"

Declared by:

+
+ +
+
+
+ + vim.utility.surround.mappings.normal + + +
+
+

Surround motion with character

+ +

Type: +null or string

+ +

Default: +"gz"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/surround/surround.nix> -
vim.utility.surround.mappings.normalCur

Surround motion with character on new lines

Type: -null or string

Default: -"gZ"

Declared by:

+
+ +
+
+
+ + vim.utility.surround.mappings.normalCur + + +
+
+

Surround motion with character on new lines

+ +

Type: +null or string

+ +

Default: +"gZ"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/surround/surround.nix> -
vim.utility.surround.mappings.normalCurLine

Surround line with character on new lines

Type: -null or string

Default: -"gZZ"

Declared by:

+
+ +
+
+
+ + vim.utility.surround.mappings.normalCurLine + + +
+
+

Surround line with character on new lines

+ +

Type: +null or string

+ +

Default: +"gZZ"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/surround/surround.nix> -
vim.utility.surround.mappings.normalLine

Surround line with character

Type: -null or string

Default: -"gzz"

Declared by:

+
+ +
+
+
+ + vim.utility.surround.mappings.normalLine + + +
+
+

Surround line with character

+ +

Type: +null or string

+ +

Default: +"gzz"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/surround/surround.nix> -
vim.utility.surround.mappings.visual

Surround selection with character

Type: -null or string

Default: -"gz"

Declared by:

+
+ +
+
+
+ + vim.utility.surround.mappings.visual + + +
+
+

Surround selection with character

+ +

Type: +null or string

+ +

Default: +"gz"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/surround/surround.nix> -
vim.utility.surround.mappings.visualLine

Surround selection with character on new lines

Type: -null or string

Default: -"gZ"

Declared by:

+
+ +
+
+
+ + vim.utility.surround.mappings.visualLine + + +
+
+

Surround selection with character on new lines

+ +

Type: +null or string

+ +

Default: +"gZ"

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/surround/surround.nix> -
vim.utility.surround.useVendoredKeybindings

Use alternative set of keybindings that avoids conflicts with other popular plugins, e.g. nvim-leap

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.utility.surround.useVendoredKeybindings + + +
+
+

Use alternative set of keybindings that avoids conflicts with other popular plugins, e.g. nvim-leap

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/surround/surround.nix> -
vim.utility.vim-wakatime.enable

Whether to enable vim-wakatime: live code statistics.

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.utility.vim-wakatime.enable + + +
+
+

Whether to enable vim-wakatime: live code statistics.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/wakatime/vim-wakatime.nix> -
vim.utility.vim-wakatime.cli-package

The package that should be used for wakatime-cli. Set as null to use the default path in $XDG_DATA_HOME

Type: -null or package

Default: -<derivation wakatime-1.73.0>

Declared by:

+
+ +
+
+
+ + vim.utility.vim-wakatime.cli-package + + +
+
+

The package that should be used for wakatime-cli. Set as null to use the default path in $XDG_DATA_HOME

+ +

Type: +null or package

+ +

Default: +<derivation wakatime-1.73.0>

+ +

Declared by:

+ +
+ <neovim-flake/modules/utility/wakatime/vim-wakatime.nix> -
vim.viAlias

Enable vi alias

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.viAlias + + +
+
+

Enable vi alias

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/core> -
vim.vimAlias

Enable vim alias

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.vimAlias + + +
+
+

Enable vim alias

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/core> -
vim.visuals.enable

Whether to enable Visual enhancements…

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.visuals.enable + + +
+
+

Whether to enable Visual enhancements…

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.cellularAutomaton.enable

Whether to enable cellular automaton [cellular-automaton].

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.visuals.cellularAutomaton.enable + + +
+
+

Whether to enable cellular automaton [cellular-automaton].

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.cellularAutomaton.mappings.makeItRain

Make it rain [cellular-automaton]

Type: -null or string

Default: -"<leader>fml"

Declared by:

+
+ +
+
+
+ + vim.visuals.cellularAutomaton.mappings.makeItRain + + +
+
+

Make it rain [cellular-automaton]

+ +

Type: +null or string

+ +

Default: +"<leader>fml"

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.cursorline.enable

Whether to enable line hightlighting on the cursor [nvim-cursorline].

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.visuals.cursorline.enable + + +
+
+

Whether to enable line hightlighting on the cursor [nvim-cursorline].

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.cursorline.lineNumbersOnly

Hightlight only in the presence of line numbers

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.visuals.cursorline.lineNumbersOnly + + +
+
+

Hightlight only in the presence of line numbers

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.cursorline.lineTimeout

Time in milliseconds for cursorline to appear

Type: -signed integer

Default: -0

Declared by:

+
+ +
+
+
+ + vim.visuals.cursorline.lineTimeout + + +
+
+

Time in milliseconds for cursorline to appear

+ +

Type: +signed integer

+ +

Default: +0

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.fidget-nvim.enable

Whether to enable nvim LSP UI element [fidget-nvim].

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.visuals.fidget-nvim.enable + + +
+
+

Whether to enable nvim LSP UI element [fidget-nvim].

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.fidget-nvim.align.bottom

Align to bottom

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.visuals.fidget-nvim.align.bottom + + +
+
+

Align to bottom

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.fidget-nvim.align.right

Align to right

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.visuals.fidget-nvim.align.right + + +
+
+

Align to right

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.highlight-undo.enable

Whether to enable highlight undo [highlight-undo].

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.visuals.highlight-undo.enable + + +
+
+

Whether to enable highlight undo [highlight-undo].

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.highlight-undo.duration

Duration of highlight

Type: -signed integer

Default: -500

Declared by:

+
+ +
+
+
+ + vim.visuals.highlight-undo.duration + + +
+
+

Duration of highlight

+ +

Type: +signed integer

+ +

Default: +500

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.highlight-undo.highlightForCount

Enable support for highlighting when a <count> is provided before the key -If set to false it will only highlight when the mapping is not prefixed with a <count>

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.visuals.highlight-undo.highlightForCount + + +
+
+

Enable support for highlighting when a <count> is provided before the key +If set to false it will only highlight when the mapping is not prefixed with a <count>

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.highlight-undo.redo.hlGroup

Highlight group for redo

Type: -string

Default: -"HighlightUndo"

Declared by:

+
+ +
+
+
+ + vim.visuals.highlight-undo.redo.hlGroup + + +
+
+

Highlight group for redo

+ +

Type: +string

+ +

Default: +"HighlightUndo"

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.highlight-undo.undo.hlGroup

Highlight group for undo

Type: -string

Default: -"HighlightUndo"

Declared by:

+
+ +
+
+
+ + vim.visuals.highlight-undo.undo.hlGroup + + +
+
+

Highlight group for undo

+ +

Type: +string

+ +

Default: +"HighlightUndo"

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.indentBlankline.enable

Whether to enable indentation guides [indent-blankline].

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.visuals.indentBlankline.enable + + +
+
+

Whether to enable indentation guides [indent-blankline].

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.indentBlankline.debounce

Debounce time in milliseconds

Type: -signed integer

Default: -200

Declared by:

+
+ +
+
+
+ + vim.visuals.indentBlankline.debounce + + +
+
+

Debounce time in milliseconds

+ +

Type: +signed integer

+ +

Default: +200

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.indentBlankline.eolChar

Character at end of line

Type: -null or string

Default: -"↴"

Declared by:

+
+ +
+
+
+ + vim.visuals.indentBlankline.eolChar + + +
+
+

Character at end of line

+ +

Type: +null or string

+ +

Default: +"↴"

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.indentBlankline.fillChar

Character to fill indents

Type: -null or string

Default: -"⋅"

Declared by:

+
+ +
+
+
+ + vim.visuals.indentBlankline.fillChar + + +
+
+

Character to fill indents

+ +

Type: +null or string

+ +

Default: +"⋅"

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.indentBlankline.indent.char

Character for indentation line

Type: -string

Default: -"│"

Declared by:

+
+ +
+
+
+ + vim.visuals.indentBlankline.indent.char + + +
+
+

Character for indentation line

+ +

Type: +string

+ +

Default: +"│"

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.indentBlankline.listChar

Character for indentation line

Type: -string

Default: -"│"

Declared by:

+
+ +
+
+
+ + vim.visuals.indentBlankline.listChar + + +
+
+

Character for indentation line

+ +

Type: +string

+ +

Default: +"│"

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.indentBlankline.scope.enabled

Highlight current scope from treesitter

Type: -boolean

Default: -config.vim.treesitter.enable

Declared by:

+
+ +
+
+
+ + vim.visuals.indentBlankline.scope.enabled + + +
+
+

Highlight current scope from treesitter

+ +

Type: +boolean

+ +

Default: +config.vim.treesitter.enable

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.indentBlankline.scope.showEndOfLine

Displays the end of line character set by vim.visuals.indentBlankline.eolChar instead of the -indent guide on line returns.

Type: -boolean

Default: -config.vim.visuals.indentBlankline.eolChar != null

Declared by:

+
+ +
+
+
+ + vim.visuals.indentBlankline.scope.showEndOfLine + + +
+
+

Displays the end of line character set by vim.visuals.indentBlankline.eolChar instead of the +indent guide on line returns.

+ +

Type: +boolean

+ +

Default: +config.vim.visuals.indentBlankline.eolChar != null

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.indentBlankline.viewportBuffer.max

Number of lines above and below of what is currently -visible in the window

Type: -signed integer

Default: -500

Declared by:

+
+ +
+
+
+ + vim.visuals.indentBlankline.viewportBuffer.max + + +
+
+

Number of lines above and below of what is currently +visible in the window

+ +

Type: +signed integer

+ +

Default: +500

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.indentBlankline.viewportBuffer.min

Number of lines above and below of what is currently -visible in the window

Type: -signed integer

Default: -30

Declared by:

+
+ +
+
+
+ + vim.visuals.indentBlankline.viewportBuffer.min + + +
+
+

Number of lines above and below of what is currently +visible in the window

+ +

Type: +signed integer

+ +

Default: +30

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.nvimWebDevicons.enable

Whether to enable dev icons. Required for certain plugins [nvim-web-devicons]…

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.visuals.nvimWebDevicons.enable + + +
+
+

Whether to enable dev icons. Required for certain plugins [nvim-web-devicons]…

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.scrollBar.enable

Whether to enable scrollbar [scrollbar.nvim].

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.visuals.scrollBar.enable + + +
+
+

Whether to enable scrollbar [scrollbar.nvim].

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.visuals.smoothScroll.enable

Whether to enable smooth scrolling [cinnamon-nvim].

Type: -boolean

Default: -false

Example: -true

Declared by:

+
+ +
+
+
+ + vim.visuals.smoothScroll.enable + + +
+
+

Whether to enable smooth scrolling [cinnamon-nvim].

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/visuals/visuals.nix> -
vim.wordWrap

Enable word wrapping.

Type: -boolean

Default: -true

Declared by:

+
+ +
+
+
+ + vim.wordWrap + + +
+
+

Enable word wrapping.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ +
+ <neovim-flake/modules/basic/module.nix> -
Prev   Next
neovim-flake Manual Home Appendix B. Release Notes
\ No newline at end of file + +
+
+
+
+
+
+ + + + + + + + + + + +
Prev   
neovim-flake-manual Home 
+
+ + \ No newline at end of file diff --git a/release-notes.html b/release-notes.html deleted file mode 100644 index 62f554a..0000000 --- a/release-notes.html +++ /dev/null @@ -1,258 +0,0 @@ - -Appendix B. Release Notes
Appendix B. Release Notes
Prev   

Appendix B. Release Notes

B.1. Release 0.1
B.1.1. Changelog
B.2. Release 0.2
B.2.1. Changelog
B.3. Release 0.3
B.3.1. Changelog
B.4. Release 0.4
B.4.1. Changelog
B.5. Release 0.5
B.5.1. Changelog
B.6. Release 0.6
B.6.1. Changelog

This section lists the release notes for tagged version of neovim-flake and current main.

B.1. Release 0.1

This is the current master branch and information here is not final. These are changes from the v0.01 tag.

Special thanks to home-manager for this release. Docs/manual generation, the new module evaluation system, and DAG implementation are from them.

B.1.1. Changelog

jordanisaacs:

  • -Removed hare language support (lsp/tree-sitter/etc). vim.lsp.hare is no longer defined. If you use hare and would like it added back, please file an issue. -

  • -vim.startPlugins & vim.optPlugins are now an enum of string for options sourced from the flake inputs. Users can still provide vim plugin packages. -

    If you are contributing and adding a new plugin, add the plugin name to availablePlugins in types-plugin.nix.

  • -neovimBuilder has been removed for configuration. Using an overlay is no longer required. See the manual for the new way to configuration. -
  • -Treesitter grammars are now configurable with vim.treesitter.grammars. Utilizes the nixpkgs nvim-treesitter plugin rather than a custom input in order to take advantage of build support of pinned versions. See discourse for more information. Packages can be found under the vimPlugins.nvim-treesitter.builtGrammars namespace. -

  • -vim.configRC and vim.luaConfigRC are now of type DAG lines. This allows for ordering of the config. Usage is the same is in home-manager’s home.activation option. -

    vim.luaConfigRC = lib.nvim.dag.entryAnywhere "config here"

MoritzBoehme:

B.2. Release 0.2

Release notes for release 0.2

B.2.1. Changelog

notashelf:

  • -Added two minimap plugins under vim.minimap. codewindow.nvim is enabled by default, while minimap.vim is available with its code-minimap dependency. -
  • -A complementary plugin, ‘obsidian.nvim` and the Neovim alternative for Emacs’ orgmode with orgmode.nvim have been added. Both will be disabled by default. -
  • -Smooth scrolling for ANY movement command is now available with cinnamon.nvim -
  • -You will now notice a dashboard on startup. This is provided by the alpha.nvim plugin. You can use any of the three available dashboard plugins, or disable them entirely. -
  • -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 vim.visuals if seen necessary. -
  • -Discord Rich Presence has been added through presence.nvim for those who want to flex that they are using the superior text editor. -
  • -An icon picker is now available with telescope integration. You can use :IconPickerInsert or :IconPickerYank to add icons to your code. -
  • -A general purpose cheatsheet has been added through cheatsheet.nvim. Forget no longer! -
  • -ccc.nvim has been added to the default plugins to allow picking colors with ease. -
  • -Most UI components of Neovim have been replaced through the help of noice.nvim. There are also notifications and custom UI elements available for Neovim messages and prompts. -
  • -A (floating by default) terminal has been added through toggleterm.nvim. -
  • -Harness the power of ethical (tabnine.nvim) and not-so-ethical (copilot.lua) AI by those new assistant plugins. Both are off by default, TabNine needs to be wrapped before it’s working. -
  • -Experimental mouse gestures have been addede through gesture.nvim. See plugin page and the relevant module for more details on how to use. -
  • -Re-open last visited buffers via nvim-session-manager. Disabled by default as deleting buffers seems to be problematic at the moment. -
  • -Most of NvimTree’s configuration options have been changed with some options being toggled to off by default. -
  • -Lualine had its configuration simplified and style toned down. Less color, more info. -
  • -Modules where multiple plugin configurations were in the same directory have been simplified. Each plugin inside a single module gets its own directory to be imported. -
  • -Separate config options with the same parent attribute have been merged into one for simplicity. -

B.3. Release 0.3

Release 0.3 had to come out beore 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.

B.3.1. Changelog

  • -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. -
  • -We now provide a home-manager module. Do note that it is still far from perfect, but it works. -
  • -nodejs_16 is now bundled with Copilot.lua if the user has enabled Copilot assistant. -
  • -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 instad of +prefix -
  • -Most of presence.nvim's options have been made fully configurable through your configuration file. -
  • -Most of the modules have been refactored to separate config and options attributes. -
  • -Darwin has been deprecated as the zig package is marked as broken. We will attempt to use the zig overlay to return Darwin -support. -
  • -Fidget.nvim has been added as a neat visual addition for LSP installations. -
  • -diffview.nvim has been added to provide a convenient diff utility. -
  • -Treesitter grammars are now configurable with vim.treesitter.grammars. Utilizes the nixpkgs nvim-treesitter plugin rather than a custom input in order to take advantage of build support of pinned versions. See discourse for more information. Packages can be found under the pkgs.vimPlugins.nvim-treesitter.builtGrammars 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: comment, toml, make, html, css, graphql, json. -

  • -A new section has been added for language support: vim.languages.<language>. The options vim.languages.enableLSP, vim.languages.enableTreesitter, etc. will enable the respective section for all languages that have been enabled. -

    • -All LSP languages have been moved here -
    • -plantuml and markdown have been moved here -
    • -A new section has been added for html. The old vim.treesitter.autotagHtml can be found at vim.languages.html.treesitter.autotagHtml. -
  • -vim.git.gitsigns.codeActions has been added allowing you to turn on gitsigns codeactions. -
  • -Removed the plugins document in the docs. Was too unwieldy to keep updated. -
  • -vim.visual.lspkind has been moved to vim.lsp.lspkind.enable -
  • -Improved handling of completion formatting. When setting vim.autocomplete.sources, can also include optional menu mapping. And can provide your own function with vim.autocomplete.formatting.format. -
  • -For vim.visuals.indentBlankline.fillChar and vim.visuals.indentBlankline.eolChar turning them off should use null rather than "" now. -
  • -Transparency has been made optional and has been disabled by default. vim.theme.transparent option can be used to enable or -disable transparency for your configuration. -
  • -Fixed deprecated configuration method for Tokyonight, and added new style "moon" -
  • -Dart language support as well as extended flutter support has been added. Thanks to @FlafyDev for his contributions towards Dart -language support. -
  • -Elixir language support has been added through elixir-tools.nvim. -
  • -hop.nvim and leap.nvim have been added for fast navigation. -
  • -modes.nvim has been added to the UI plugins as a minor error highlighter. -
  • -smartcollumn.nvim has been added to dynamically display a colorcolumn when the limit has been exceeded, providing -per-buftype column position and more. -
  • -project.nvim has been added for better project management inside Neovim. -
  • -More configuration options have been added to nvim-session-manager. -
  • -Editorconfig support has been added to the core functionality, with an enable option. -
  • -venn-nvim has been dropped due to broken keybinds. -

B.4. Release 0.4

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 (vim.keybinds = {}) 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.

Alongside customizable keybinds, there are a few quality of life updates, such as lazygit integration and the new experimental Lua loader of Neovim 0.9 thanks to our awesome contributors who made this update possible during my absence.

B.4.1. Changelog

n3oney:

  • -Streamlined keybind adding process towards new functions in extended stdlib. -
  • -Moved default keybinds into keybinds section of each module -
  • -Simplified luaConfigRC and configRC setting - they can now just take strings -
  • -Refactored the resolveDag function - you can just provide a string now, which will default to dag.entryAnywhere -
  • -Fixed formatting sometimes removing parts of files -
  • -Made formatting synchronous -
  • -Gave null-ls priority over other formatters -

horriblename:

  • -Added clangd as alternative lsp for C/++. -
  • -Added toggleterm integration for lazygit. -
  • -Added new option enableluaLoader to enable neovim’s experimental module loader for faster startup time. -
  • -Fixed bug where flutter-tools can’t find dart LSP -
  • -Added Debug Adapter (DAP) support for clang, rust, go, python and dart. -

notashelf:

  • -Made Copilot’s Node package configurable. It is recommended to keep as default, but providing a different NodeJS version is now possible. -
  • -Added vim.cursorlineOpt for configuring Neovim’s cursorlineOpt. -
  • -Added filetree.nvimTreeLua.view.cursorline, default false, to enable cursorline in nvimtre. -
  • -Added Fidget.nvim support for the Catppuccin theme. -
  • -Updated bundled NodeJS version used by Copilot.lua. v16 is now marked as insecure on Nixpkgs, and we updated to v18 -
  • -Enabled Catppuccin modules for plugins available by default. -
  • -Added experimental Svelte support under vim.languages. -
  • -Removed unnecessary scrollbar element from notifications and codeaction warning UI. -
  • -vim.utility.colorizer has been renamed to vim.utility.ccc after the plugin it uses -
  • -Color preview via nvim-colorizer.lua -
  • -Updated Lualine statusline UI -
  • -Added vim-illuminate for smart highlighting -
  • -Added a module for enabling Neovim’s spellchecker -
  • -Added prettierd as an alternative formatter to prettier - currently defaults to prettier -
  • -Fixed presence.nvim inheriting the wrong client id -
  • -Cleaned up documentation -

B.5. Release 0.5

B.5.1. Changelog

vagahbond: -* Added phan language server for PHP

  • -Added phpactor language server for PHP -

horriblename:

  • -Added transparency support for tokyonight theme -
  • -Fixed a bug where cmp’s close and scrollDocs mappings wasn’t working -
  • -Streamlined and simplified extra plugin API with the addition of vim.extraPlugins -
  • -Allow using command names in place of LSP packages to avoid automatic installation -
  • -Add lua LSP and treesitter support, and neodev.nvim plugin support -
  • -Add vim.lsp.mappings.toggleFormatOnSave keybind -

amanse:

  • -Added daily notes options for obsidian plugin -
  • -Added jdt-language-server for Java -

yavko:

frothymarrow:

notashelf:

  • -Added GitHub Copilot to nvim-cmp completion sources. -
  • -Added vim.ui.borders.enable for global and individual plugin border configuration. -
  • -LSP integrated breadcrumbs with vim.ui.breadcrumbs.enable through nvim-navic -
  • -LSP navigation helper with nvim-navbuddy, depends on nvim-navic (automatically enabled) -
  • -Addeed nvim-navic integration for catppuccin theme -
  • -Fixed mismatching zig language description -
  • -Added support for statix and deadnix through vim.languages.nix.extraDiagnostics.types -
  • -Added lsp_lines plugin for showing diagnostic messages -
  • -Added a configuration option for choosing the leader key -
  • -The package used for neovim is now customizable by the user, using vim.package. For best results, always use an unwrapped package -
  • -Added highlight-undo plugin for highlighting undo/redo targets -
  • -Added bash LSP and formatter support -
  • -Disabled Lualine LSP status indicator for toggleterm buffer -
  • -Added nvim-docs-view, a plugin to display lsp hover documentation in a side panel -
  • -Switched to nixosOptionsDoc 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." -
  • -Updated indent-blankine.nvim to v3 - this comes with a few option changes, which will be migrated with renamedOptionModule -

jacekpoz:

  • -Fixed scrollOffset not being used -
  • -Updated clangd to 16 -
  • -Disabled useSystemClipboard by default -

ksonj:

  • -Add support to change mappings to utility/surround -
  • -Add black-and-isort python formatter -
  • -Removed redundant "Enable …" in mkEnableOption descriptions -
  • -Add options to modify LSP key bindings and add proper whichkey descriptions -
  • -Changed type of statusline.lualine.activeSection and statusline.lualine.inactiveSection from attrsOf str to attrsOf (listOf str) -
  • -Added statusline.lualine.extraActiveSection and statusline.lualine.extraInactiveSection -

B.6. Release 0.6

Release notes for release 0.6

B.6.1. Changelog

ksonj:

  • -Add Terraform language support -
Prev   
Appendix A. Configuration Options Home 
\ No newline at end of file diff --git a/style.css b/style.css index ab40af2..fbebeff 100644 --- a/style.css +++ b/style.css @@ -1,4 +1,4 @@ -:root{--nmd-color0: #0A3E68;--nmd-color1: #268598;--nmd-color2: #B8D09E;--nmd-color3: #F6CF5E;--nmd-color4: #EC733B;--nmd-color-info: #167cb9;--nmd-color-warn: #ff6700}html{scroll-behavior:smooth}body{text-size-adjust:100%;position:relative;width:100%;min-height:100vh}*,::after,::before{box-sizing:border-box}a:not([class]){text-decoration-skip-ink:auto}html,body,div,span,applet,object,iframe,h1,h2,h3,h4,h5,h6,p,blockquote,pre,a,abbr,acronym,address,big,cite,code,del,dfn,em,img,ins,kbd,q,s,samp,small,strike,strong,sub,sup,tt,var,b,u,i,center,dl,dt,dd,ol,ul,li,fieldset,form,label,legend,table,caption,tbody,tfoot,thead,tr,th,td,article,aside,canvas,details,embed,figure,figcaption,footer,header,hgroup,menu,nav,output,ruby,section,summary,time,mark,audio,video{font-size:100%;font:inherit;margin:0;padding:0;border:0;vertical-align:baseline}:focus{outline:0}main,article,aside,details,figcaption,figure,footer,header,hgroup,menu,nav,section{display:block}ol,ul{list-style:none}blockquote,q{quotes:none}blockquote:before,blockquote:after,q:before,q:after{content:"";content:none}table{border-collapse:collapse;border-spacing:0}td:empty,th:empty{opacity:0}input:required,input{box-shadow:none}input:-webkit-autofill,input:-webkit-autofill:hover,input:-webkit-autofill:focus,input:-webkit-autofill:active{-webkit-box-shadow:0 0 0 30px white inset}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;-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box}textarea{overflow:auto;vertical-align:top;resize:vertical}audio,canvas,video{display:inline-block;max-width:100%}audio:not([controls]){display:none;height:0}[hidden]{display:none}a:active,a:hover{outline:none}img{border:0;max-width:100%;display:inline-block;vertical-align:middle;height:auto}picture{display:inline-block}figure{margin:0}button,input{line-height:normal}button,select{text-transform:none}button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;border:0;background:transparent}button::-moz-focus-inner{border:0}button[disabled],html input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;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{border:0;background:transparent}textarea{overflow:auto;vertical-align:top;resize:vertical}table{border-collapse:collapse;border-spacing:0}hr{box-sizing:content-box;overflow:visible;background:#000;border:0;height:1px;line-height:0;margin:0;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,samp{font-family:monospace,monospace;font-size:100%}small{font-size:75%}sub,sup{font-size:75%;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}button,[type=button],[type=reset],[type=submit]{-webkit-appearance:button}button::-moz-focus-inner,[type=button]::-moz-focus-inner,[type=reset]::-moz-focus-inner,[type=submit]::-moz-focus-inner{border-style:none;padding:0;outline:0}legend{color:inherit;white-space:normal;display:block;border:0;max-width:100%;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}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:.5rem .25rem}p{margin:.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}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 .8rem}dd{margin-left:2rem}ul{margin:.9rem 0;padding-left:30px;list-style:disc}ul:first-child{margin-top:0}ul:last-child{margin-bottom:0}ol{margin:.9rem 0;padding-left:30px;list-style:decimal}ol:first-child{margin-top:0}ol:last-child{margin-bottom:0}li{margin:.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}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}.programlisting.console .hljs-meta{user-select: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}html{scroll-behavior:smooth}body{text-size-adjust:100%;position:relative;width:100%;min-height:100vh}*,::after,::before{box-sizing:border-box}a:not([class]){text-decoration-skip-ink:auto}html,body,div,span,applet,object,iframe,h1,h2,h3,h4,h5,h6,p,blockquote,pre,a,abbr,acronym,address,big,cite,code,del,dfn,em,img,ins,kbd,q,s,samp,small,strike,strong,sub,sup,tt,var,b,u,i,center,dl,dt,dd,ol,ul,li,fieldset,form,label,legend,table,caption,tbody,tfoot,thead,tr,th,td,article,aside,canvas,details,embed,figure,figcaption,footer,header,hgroup,menu,nav,output,ruby,section,summary,time,mark,audio,video{font-size:100%;font:inherit;margin:0;padding:0;border:0;vertical-align:baseline}:focus{outline:0}main,article,aside,details,figcaption,figure,footer,header,hgroup,menu,nav,section{display:block}ol,ul{list-style:none}blockquote,q{quotes:none}blockquote:before,blockquote:after,q:before,q:after{content:"";content:none}table{border-collapse:collapse;border-spacing:0}td:empty,th:empty{opacity:0}input:required,input{box-shadow:none}input:-webkit-autofill,input:-webkit-autofill:hover,input:-webkit-autofill:focus,input:-webkit-autofill:active{-webkit-box-shadow:0 0 0 30px white inset}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;-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box}textarea{overflow:auto;vertical-align:top;resize:vertical}audio,canvas,video{display:inline-block;max-width:100%}audio:not([controls]){display:none;height:0}[hidden]{display:none}a:active,a:hover{outline:none}img{border:0;max-width:100%;display:inline-block;vertical-align:middle;height:auto}picture{display:inline-block}figure{margin:0}button,input{line-height:normal}button,select{text-transform:none}button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;border:0;background:transparent}button::-moz-focus-inner{border:0}button[disabled],html input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;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{border:0;background:transparent}textarea{overflow:auto;vertical-align:top;resize:vertical}table{border-collapse:collapse;border-spacing:0}hr{box-sizing:content-box;overflow:visible;background:#000;border:0;height:1px;line-height:0;margin:0;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,samp{font-family:monospace,monospace;font-size:100%}small{font-size:75%}sub,sup{font-size:75%;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}button,[type=button],[type=reset],[type=submit]{-webkit-appearance:button}button::-moz-focus-inner,[type=button]::-moz-focus-inner,[type=reset]::-moz-focus-inner,[type=submit]::-moz-focus-inner{border-style:none;padding:0;outline:0}legend{color:inherit;white-space:normal;display:block;border:0;max-width:100%;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}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:.5rem .25rem}p{margin:.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}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 .8rem}dd{margin-left:2rem}ul{margin:.9rem 0;padding-left:30px;list-style:disc}ul:first-child{margin-top:0}ul:last-child{margin-bottom:0}ol{margin:.9rem 0;padding-left:30px;list-style:decimal}ol:first-child{margin-top:0}ol:last-child{margin-bottom:0}li{margin:.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}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}.programlisting.language-shell .hljs-meta.prompt_{user-select:none}/*! Theme: Tomorrow Author: Chris Kempson (http://chriskempson.com) License: ~ MIT (or more permissive) [via base16-schemes-source] diff --git a/tomorrow.min.css b/tomorrow.min.css deleted file mode 100644 index 5785f6e..0000000 --- a/tomorrow.min.css +++ /dev/null @@ -1,7 +0,0 @@ -/*! - Theme: Tomorrow - Author: Chris Kempson (http://chriskempson.com) - License: ~ MIT (or more permissive) [via base16-schemes-source] - Maintainer: @highlightjs/core-team - Version: 2021.09.0 -*/pre code.hljs{display:block;overflow-x:auto;padding:1em}code.hljs{padding:3px 5px}.hljs{color:#4d4d4c;background:#fff}.hljs ::selection,.hljs::selection{background-color:#d6d6d6;color:#4d4d4c}.hljs-comment{color:#8e908c}.hljs-tag{color:#969896}.hljs-operator,.hljs-punctuation,.hljs-subst{color:#4d4d4c}.hljs-operator{opacity:.7}.hljs-bullet,.hljs-deletion,.hljs-name,.hljs-selector-tag,.hljs-template-variable,.hljs-variable{color:#c82829}.hljs-attr,.hljs-link,.hljs-literal,.hljs-number,.hljs-symbol,.hljs-variable.constant_{color:#f5871f}.hljs-class .hljs-title,.hljs-title,.hljs-title.class_{color:#eab700}.hljs-strong{font-weight:700;color:#eab700}.hljs-addition,.hljs-code,.hljs-string,.hljs-title.class_.inherited__{color:#718c00}.hljs-built_in,.hljs-doctag,.hljs-keyword.hljs-atrule,.hljs-quote,.hljs-regexp{color:#3e999f}.hljs-attribute,.hljs-function .hljs-title,.hljs-section,.hljs-title.function_,.ruby .hljs-property{color:#4271ae}.diff .hljs-meta,.hljs-keyword,.hljs-template-tag,.hljs-type{color:#8959a8}.hljs-emphasis{color:#8959a8;font-style:italic}.hljs-meta,.hljs-meta .hljs-keyword,.hljs-meta .hljs-string{color:#a3685a}.hljs-meta .hljs-keyword,.hljs-meta-keyword{font-weight:700} \ No newline at end of file