home-manager/modules/programs/kakoune.nix

660 lines
19 KiB
Nix
Raw Normal View History

2019-03-21 19:38:55 +01:00
{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.programs.kakoune;
hook = types.submodule {
options = {
name = mkOption {
type = types.enum [
2020-02-02 00:39:17 +01:00
"NormalIdle"
"NormalKey"
"InsertIdle"
"InsertKey"
"InsertChar"
"InsertDelete"
"InsertMove"
"WinCreate"
"WinClose"
"WinResize"
"WinDisplay"
"WinSetOption"
"BufSetOption"
"BufNewFile"
"BufOpenFile"
"BufCreate"
"BufWritePre"
"BufWritePost"
"BufReload"
"BufClose"
"BufOpenFifo"
"BufReadFifo"
"BufCloseFifo"
"RuntimeError"
"ModeChange"
"PromptIdle"
"GlobalSetOption"
"KakBegin"
"KakEnd"
"FocusIn"
"FocusOut"
"RawKey"
"InsertCompletionShow"
"InsertCompletionHide"
"ModuleLoaded"
"ClientCreate"
"ClientClose"
"RegisterModified"
"User"
2019-03-21 19:38:55 +01:00
];
example = "SetOption";
description = ''
The name of the hook. For a description, see
<link xlink:href="https://github.com/mawww/kakoune/blob/master/doc/pages/hooks.asciidoc#default-hooks"/>.
'';
};
once = mkOption {
type = types.bool;
default = false;
description = ''
Remove the hook after running it once.
'';
};
group = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
Add the hook to the named group.
'';
};
option = mkOption {
type = types.nullOr types.str;
default = null;
example = "filetype=latex";
description = ''
Additional option to pass to the hook.
'';
};
commands = mkOption {
type = types.lines;
default = "";
example = "set-option window indentwidth 2";
description = ''
Commands to run when the hook is activated.
'';
};
};
};
keyMapping = types.submodule {
options = {
mode = mkOption {
type = types.str;
2019-03-21 19:38:55 +01:00
example = "user";
description = ''
The mode in which the mapping takes effect.
'';
};
docstring = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
Optional documentation text to display in info boxes.
'';
};
key = mkOption {
type = types.str;
example = "<a-x>";
description = ''
The key to be mapped. See
<link xlink:href="https://github.com/mawww/kakoune/blob/master/doc/pages/mapping.asciidoc#mappable-keys"/>
for possible values.
'';
};
effect = mkOption {
type = types.str;
example = ":wq<ret>";
description = ''
The sequence of keys to be mapped.
'';
};
};
};
configModule = types.submodule {
options = {
colorScheme = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
Set the color scheme. To see available schemes, enter
<command>colorscheme</command> at the kakoune prompt.
'';
};
tabStop = mkOption {
type = types.nullOr types.ints.unsigned;
default = null;
description = ''
The width of a tab in spaces. The kakoune default is
<literal>6</literal>.
'';
};
indentWidth = mkOption {
type = types.nullOr types.ints.unsigned;
default = null;
description = ''
The width of an indentation in spaces.
The kakoune default is <literal>4</literal>.
If <literal>0</literal>, a tab will be used instead.
'';
};
incrementalSearch = mkOption {
type = types.bool;
default = true;
description = ''
Execute a search as it is being typed.
'';
};
alignWithTabs = mkOption {
type = types.bool;
default = false;
description = ''
Use tabs for the align command.
'';
};
autoInfo = mkOption {
2020-02-02 00:39:17 +01:00
type = types.nullOr
(types.listOf (types.enum [ "command" "onkey" "normal" ]));
2019-03-21 19:38:55 +01:00
default = null;
example = [ "command" "normal" ];
description = ''
Contexts in which to display automatic information box.
The kakoune default is <literal>[ "command" "onkey" ]</literal>.
'';
};
autoComplete = mkOption {
2020-02-02 00:39:17 +01:00
type = types.nullOr (types.listOf (types.enum [ "insert" "prompt" ]));
2019-03-21 19:38:55 +01:00
default = null;
description = ''
Modes in which to display possible completions.
The kakoune default is <literal>[ "insert" "prompt" ]</literal>.
'';
};
autoReload = mkOption {
type = types.nullOr (types.enum [ "yes" "no" "ask" ]);
default = null;
description = ''
Reload buffers when an external modification is detected.
The kakoune default is <literal>"ask"</literal>.
'';
};
scrollOff = mkOption {
type = types.nullOr (types.submodule {
options = {
lines = mkOption {
type = types.ints.unsigned;
default = 0;
description = ''
The number of lines to keep visible around the cursor.
'';
};
columns = mkOption {
type = types.ints.unsigned;
default = 0;
description = ''
The number of columns to keep visible around the cursor.
'';
};
};
});
default = null;
description = ''
How many lines and columns to keep visible around the cursor.
'';
};
ui = mkOption {
type = types.nullOr (types.submodule {
options = {
setTitle = mkOption {
type = types.bool;
default = false;
description = ''
Change the title of the terminal emulator.
'';
};
statusLine = mkOption {
type = types.enum [ "top" "bottom" ];
default = "bottom";
description = ''
Where to display the status line.
'';
};
assistant = mkOption {
type = types.enum [ "clippy" "cat" "dilbert" "none" ];
default = "clippy";
description = ''
The assistant displayed in info boxes.
'';
};
enableMouse = mkOption {
type = types.bool;
default = false;
description = ''
Whether to enable mouse support.
'';
};
changeColors = mkOption {
type = types.bool;
default = true;
description = ''
Change color palette.
'';
};
wheelDownButton = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
Button to send for wheel down events.
'';
};
wheelUpButton = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
Button to send for wheel up events.
'';
};
shiftFunctionKeys = mkOption {
type = types.nullOr types.ints.unsigned;
default = null;
description = ''
Amount by which shifted function keys are offset. That
is, if the terminal sends F13 for Shift-F1, this
should be <literal>12</literal>.
'';
};
useBuiltinKeyParser = mkOption {
type = types.bool;
default = false;
description = ''
Bypass ncurses key parser and use an internal one.
'';
};
};
});
default = null;
description = ''
Settings for the ncurses interface.
'';
};
showMatching = mkOption {
type = types.bool;
default = false;
description = ''
Highlight the matching char of the character under the
selections' cursor using the <literal>MatchingChar</literal>
face.
'';
};
wrapLines = mkOption {
type = types.nullOr (types.submodule {
options = {
enable = mkEnableOption "the wrap lines highlighter";
word = mkOption {
type = types.bool;
default = false;
description = ''
Wrap at word boundaries instead of codepoint boundaries.
'';
};
indent = mkOption {
type = types.bool;
default = false;
description = ''
Preserve line indentation when wrapping.
'';
};
maxWidth = mkOption {
type = types.nullOr types.ints.unsigned;
default = null;
description = ''
Wrap text at maxWidth, even if the window is wider.
'';
};
marker = mkOption {
type = types.nullOr types.str;
default = null;
example = "";
description = ''
Prefix wrapped lines with marker text.
If not <literal>null</literal>,
the marker text will be displayed in the indentation if possible.
'';
};
};
});
default = null;
description = ''
Settings for the wrap lines highlighter.
'';
};
numberLines = mkOption {
type = types.nullOr (types.submodule {
options = {
enable = mkEnableOption "the number lines highlighter";
relative = mkOption {
type = types.bool;
default = false;
description = ''
Show line numbers relative to the main cursor line.
'';
};
highlightCursor = mkOption {
type = types.bool;
default = false;
description = ''
Highlight the cursor line with a separate face.
'';
};
separator = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
String that separates the line number column from the
buffer contents. The kakoune default is
<literal>"|"</literal>.
'';
};
};
});
default = null;
description = ''
Settings for the number lines highlighter.
'';
};
showWhitespace = mkOption {
type = types.nullOr (types.submodule {
options = {
enable = mkEnableOption "the show whitespace highlighter";
lineFeed = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
The character to display for line feeds.
The kakoune default is <literal>"¬"</literal>.
'';
};
space = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
The character to display for spaces.
The kakoune default is <literal>"·"</literal>.
'';
};
nonBreakingSpace = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
The character to display for non-breaking spaces.
The kakoune default is <literal>""</literal>.
'';
};
tab = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
The character to display for tabs.
The kakoune default is <literal>""</literal>.
'';
};
tabStop = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
The character to append to tabs to reach the width of a tabstop.
The kakoune default is <literal>" "</literal>.
'';
};
};
});
default = null;
description = ''
Settings for the show whitespaces highlighter.
'';
};
keyMappings = mkOption {
type = types.listOf keyMapping;
2020-02-02 00:39:17 +01:00
default = [ ];
2019-03-21 19:38:55 +01:00
description = ''
User-defined key mappings. For documentation, see
<link xlink:href="https://github.com/mawww/kakoune/blob/master/doc/pages/mapping.asciidoc"/>.
2019-03-21 19:38:55 +01:00
'';
};
hooks = mkOption {
type = types.listOf hook;
2020-02-02 00:39:17 +01:00
default = [ ];
2019-03-21 19:38:55 +01:00
description = ''
Global hooks. For documentation, see
<link xlink:href="https://github.com/mawww/kakoune/blob/master/doc/pages/hooks.asciidoc"/>.
'';
};
};
};
2022-11-27 01:49:15 +01:00
kakouneWithPlugins =
pkgs.wrapKakoune cfg.package { configure = { plugins = cfg.plugins; }; };
2020-02-02 00:39:17 +01:00
configFile = let
wrapOptions = with cfg.config.wrapLines;
concatStrings [
2019-03-21 19:38:55 +01:00
"${optionalString word " -word"}"
"${optionalString indent " -indent"}"
"${optionalString (marker != null) " -marker ${marker}"}"
"${optionalString (maxWidth != null) " -width ${toString maxWidth}"}"
];
2020-02-02 00:39:17 +01:00
numberLinesOptions = with cfg.config.numberLines;
concatStrings [
2019-03-21 19:38:55 +01:00
"${optionalString relative " -relative "}"
"${optionalString highlightCursor " -hlcursor"}"
"${optionalString (separator != null) " -separator ${separator}"}"
];
showWhitespaceOptions = with cfg.config.showWhitespace;
let
quoteSep = sep:
if sep == "'" then
''"'"''
else if lib.strings.stringLength sep == 1 then
"'${sep}'"
else
sep; # backwards compat, in case sep == "' '", etc.
in concatStrings [
(optionalString (tab != null) " -tab ${quoteSep tab}")
(optionalString (tabStop != null) " -tabpad ${quoteSep tabStop}")
(optionalString (space != null) " -spc ${quoteSep space}")
(optionalString (nonBreakingSpace != null)
" -nbsp ${quoteSep nonBreakingSpace}")
(optionalString (lineFeed != null) " -lf ${quoteSep lineFeed}")
];
2020-02-02 00:39:17 +01:00
uiOptions = with cfg.config.ui;
concatStringsSep " " [
"terminal_set_title=${if setTitle then "true" else "false"}"
"terminal_status_on_top=${
2020-02-02 00:39:17 +01:00
if (statusLine == "top") then "true" else "false"
}"
"terminal_assistant=${assistant}"
"terminal_enable_mouse=${if enableMouse then "true" else "false"}"
"terminal_change_colors=${if changeColors then "true" else "false"}"
2019-03-21 19:38:55 +01:00
"${optionalString (wheelDownButton != null)
"terminal_wheel_down_button=${wheelDownButton}"}"
2019-03-21 19:38:55 +01:00
"${optionalString (wheelUpButton != null)
"terminal_wheel_up_button=${wheelUpButton}"}"
2019-03-21 19:38:55 +01:00
"${optionalString (shiftFunctionKeys != null)
"terminal_shift_function_key=${toString shiftFunctionKeys}"}"
"terminal_builtin_key_parser=${
2020-02-02 00:39:17 +01:00
if useBuiltinKeyParser then "true" else "false"
}"
2019-03-21 19:38:55 +01:00
];
userModeString = mode:
optionalString (!builtins.elem mode [
"insert"
"normal"
"prompt"
"menu"
"user"
"goto"
"view"
"object"
]) "try %{declare-user-mode ${mode}}";
userModeStrings = map userModeString
(lists.unique (map (km: km.mode) cfg.config.keyMappings));
2020-02-02 00:39:17 +01:00
keyMappingString = km:
concatStringsSep " " [
2019-03-21 19:38:55 +01:00
"map global"
"${km.mode} ${km.key} '${km.effect}'"
2020-02-02 00:39:17 +01:00
"${optionalString (km.docstring != null)
"-docstring '${km.docstring}'"}"
2019-03-21 19:38:55 +01:00
];
2020-02-02 00:39:17 +01:00
hookString = h:
concatStringsSep " " [
"hook"
"${optionalString (h.group != null) "-group ${h.group}"}"
2020-02-02 00:39:17 +01:00
"${optionalString (h.once) "-once"}"
"global"
"${h.name}"
"${optionalString (h.option != null) h.option}"
2019-03-21 19:38:55 +01:00
"%{ ${h.commands} }"
];
2020-02-02 00:39:17 +01:00
cfgStr = with cfg.config;
concatStringsSep "\n" ([ "# Generated by home-manager" ]
2019-03-21 19:38:55 +01:00
++ optional (colorScheme != null) "colorscheme ${colorScheme}"
2020-02-02 00:39:17 +01:00
++ optional (tabStop != null)
"set-option global tabstop ${toString tabStop}"
++ optional (indentWidth != null)
"set-option global indentwidth ${toString indentWidth}"
2019-03-21 19:38:55 +01:00
++ optional (!incrementalSearch) "set-option global incsearch false"
++ optional (alignWithTabs) "set-option global aligntab true"
2020-02-02 00:39:17 +01:00
++ optional (autoInfo != null)
"set-option global autoinfo ${concatStringsSep "|" autoInfo}"
++ optional (autoComplete != null)
"set-option global autocomplete ${concatStringsSep "|" autoComplete}"
++ optional (autoReload != null)
"set-option global autoreload ${autoReload}"
2020-02-02 00:39:17 +01:00
++ optional (wrapLines != null && wrapLines.enable)
"add-highlighter global/ wrap${wrapOptions}"
2019-03-21 19:38:55 +01:00
++ optional (numberLines != null && numberLines.enable)
2020-02-02 00:39:17 +01:00
"add-highlighter global/ number-lines${numberLinesOptions}"
2019-03-21 19:38:55 +01:00
++ optional showMatching "add-highlighter global/ show-matching"
++ optional (showWhitespace != null && showWhitespace.enable)
"add-highlighter global/ show-whitespaces${showWhitespaceOptions}"
2019-03-21 19:38:55 +01:00
++ optional (scrollOff != null)
2020-02-02 00:39:17 +01:00
"set-option global scrolloff ${toString scrollOff.lines},${
toString scrollOff.columns
}"
2019-03-21 19:38:55 +01:00
++ [ "# UI options" ]
++ optional (ui != null) "set-option global ui_options ${uiOptions}"
++ [ "# User modes" ] ++ userModeStrings ++ [ "# Key mappings" ]
++ map keyMappingString keyMappings
2019-03-21 19:38:55 +01:00
2020-02-02 00:39:17 +01:00
++ [ "# Hooks" ] ++ map hookString hooks);
in pkgs.writeText "kakrc"
(optionalString (cfg.config != null) cfgStr + "\n" + cfg.extraConfig);
2019-03-21 19:38:55 +01:00
2020-02-02 00:39:17 +01:00
in {
2019-03-21 19:38:55 +01:00
options = {
programs.kakoune = {
enable = mkEnableOption "the kakoune text editor";
2022-11-27 01:49:15 +01:00
package = mkPackageOption pkgs "kakoune-unwrapped" { };
2019-03-21 19:38:55 +01:00
config = mkOption {
type = types.nullOr configModule;
2020-02-02 00:39:17 +01:00
default = { };
2019-03-21 19:38:55 +01:00
description = "kakoune configuration options.";
};
extraConfig = mkOption {
type = types.lines;
default = "";
description = ''
Extra configuration lines to add to
<filename>$XDG_CONFIG_HOME/kak/kakrc</filename>.
2019-03-21 19:38:55 +01:00
'';
};
plugins = mkOption {
type = with types; listOf package;
default = [ ];
example = literalExpression "[ pkgs.kakounePlugins.kak-fzf ]";
description = ''
List of kakoune plugins to install. To get a list of
supported plugins run:
<command>nix-env -f '&lt;nixpkgs&gt;' -qaP -A kakounePlugins</command>.
'';
};
2019-03-21 19:38:55 +01:00
};
};
config = mkIf cfg.enable {
home.packages = [ kakouneWithPlugins ];
2019-03-21 19:38:55 +01:00
xdg.configFile."kak/kakrc".source = configFile;
};
}