qutebrowser: add some options
Specificially, this adds options - `aliases`, - `searchEngines`, - `keyMappings`, and - `keyBindings`. PR #1212
This commit is contained in:
ivann
Robert Helgesson
parent
1dd226fde7
commit
03b4f81679
|
|
@ -24,10 +24,52 @@ let
|
|||
else
|
||||
"${o}${n} = ${formatValue v}";
|
||||
|
||||
formatDictLine = o: n: v: ''${o}['${n}'] = "${v}"'';
|
||||
|
||||
formatKeyBindings = m: b:
|
||||
let
|
||||
formatKeyBinding = m: k: c:
|
||||
''config.bind("${k}", "${escape [ ''"'' ] c}", mode="${m}")'';
|
||||
in concatStringsSep "\n" (mapAttrsToList (formatKeyBinding m) b);
|
||||
|
||||
in {
|
||||
options.programs.qutebrowser = {
|
||||
enable = mkEnableOption "qutebrowser";
|
||||
|
||||
aliases = mkOption {
|
||||
type = types.attrsOf types.str;
|
||||
default = { };
|
||||
description = ''
|
||||
Aliases for commands.
|
||||
'';
|
||||
};
|
||||
|
||||
searchEngines = mkOption {
|
||||
type = types.attrsOf types.str;
|
||||
default = { };
|
||||
description = ''
|
||||
Search engines that can be used via the address bar. Maps a search
|
||||
engine name (such as <literal>DEFAULT</literal>, or
|
||||
<literal>ddg</literal>) to a URL with a <literal>{}</literal>
|
||||
placeholder. The placeholder will be replaced by the search term, use
|
||||
<literal>{{</literal> and <literal>}}</literal> for literal
|
||||
<literal>{/}</literal> signs. The search engine named
|
||||
<literal>DEFAULT</literal> is used when
|
||||
<literal>url.auto_search</literal> is turned on and something else than
|
||||
a URL was entered to be opened. Other search engines can be used by
|
||||
prepending the search engine name to the search term, for example
|
||||
<literal>:open google qutebrowser</literal>.
|
||||
'';
|
||||
example = literalExample ''
|
||||
{
|
||||
w = "https://en.wikipedia.org/wiki/Special:Search?search={}&go=Go&ns0=1";
|
||||
aw = "https://wiki.archlinux.org/?search={}";
|
||||
nw = "https://nixos.wiki/index.php?search={}";
|
||||
g = "https://www.google.com/search?hl=en&q={}";
|
||||
}
|
||||
'';
|
||||
};
|
||||
|
||||
settings = mkOption {
|
||||
type = types.attrs;
|
||||
default = { };
|
||||
|
|
@ -50,6 +92,150 @@ in {
|
|||
'';
|
||||
};
|
||||
|
||||
keyMappings = mkOption {
|
||||
type = types.attrsOf types.str;
|
||||
default = { };
|
||||
description = ''
|
||||
This setting can be used to map keys to other keys. When the key used
|
||||
as dictionary-key is pressed, the binding for the key used as
|
||||
dictionary-value is invoked instead. This is useful for global
|
||||
remappings of keys, for example to map Ctrl-[ to Escape. Note that when
|
||||
a key is bound (via <literal>bindings.default</literal> or
|
||||
<literal>bindings.commands</literal>), the mapping is ignored.
|
||||
'';
|
||||
};
|
||||
|
||||
enableDefaultBindings = mkOption {
|
||||
type = types.bool;
|
||||
default = true;
|
||||
description = ''
|
||||
Disable to prevent loading default key bindings.
|
||||
'';
|
||||
};
|
||||
|
||||
keyBindings = mkOption {
|
||||
type = types.attrsOf (types.attrsOf types.str);
|
||||
default = { };
|
||||
description = ''
|
||||
Key bindings mapping keys to commands in different modes. This setting
|
||||
is a dictionary containing mode names and dictionaries mapping keys to
|
||||
commands: <literal>{mode: {key: command}}</literal> If you want to map
|
||||
a key to another key, check the <literal>keyMappings</literal> setting
|
||||
instead. For modifiers, you can use either <literal>-</literal> or
|
||||
<literal>+</literal> as delimiters, and these names:
|
||||
|
||||
<itemizedlist>
|
||||
<listitem><para>
|
||||
Control: <literal>Control</literal>, <literal>Ctrl</literal>
|
||||
</para></listitem>
|
||||
<listitem><para>
|
||||
Meta: <literal>Meta</literal>, <literal>Windows</literal>,
|
||||
<literal>Mod4</literal>
|
||||
</para></listitem>
|
||||
<listitem><para>
|
||||
Alt: <literal>Alt</literal>, <literal>Mod1</literal>
|
||||
</para></listitem>
|
||||
<listitem><para>
|
||||
Shift: <literal>Shift</literal>
|
||||
</para></listitem>
|
||||
</itemizedlist>
|
||||
|
||||
For simple keys (no <literal><></literal>-signs), a capital
|
||||
letter means the key is pressed with Shift. For special keys (with
|
||||
<literal><></literal>-signs), you need to explicitly add
|
||||
<literal>Shift-</literal> to match a key pressed with shift. If you
|
||||
want a binding to do nothing, bind it to the <literal>nop</literal>
|
||||
command. If you want a default binding to be passed through to the
|
||||
website, bind it to null. Note that some commands which are only useful
|
||||
for bindings (but not used interactively) are hidden from the command
|
||||
completion. See <literal>:</literal>help for a full list of available
|
||||
commands. The following modes are available:
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><literal>normal</literal></term>
|
||||
<listitem><para>
|
||||
Default mode, where most commands are invoked.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><literal>insert</literal></term>
|
||||
<listitem><para>
|
||||
Entered when an input field is focused on a website, or by
|
||||
pressing i in normal mode. Passes through almost all keypresses
|
||||
to the website, but has some bindings like
|
||||
<literal><Ctrl-e></literal> to open an external editor.
|
||||
Note that single keys can’t be bound in this mode.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><literal>hint</literal></term>
|
||||
<listitem><para>
|
||||
Entered when f is pressed to select links with the keyboard. Note
|
||||
that single keys can’t be bound in this mode.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><literal>passthrough</literal></term>
|
||||
<listitem><para>
|
||||
Similar to insert mode, but passes through all keypresses except
|
||||
<literal><Escape></literal> to leave the mode. It might be
|
||||
useful to bind <literal><Escape></literal> to some other
|
||||
key in this mode if you want to be able to send an Escape key to
|
||||
the website as well. Note that single keys can’t be bound in this
|
||||
mode.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><literal>command</literal></term>
|
||||
<listitem><para>
|
||||
Entered when pressing the : key in order to enter a command. Note
|
||||
that single keys can’t be bound in this mode.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><literal>prompt</literal></term>
|
||||
<listitem><para>
|
||||
Entered when there’s a prompt to display, like for download
|
||||
locations or when invoked from JavaScript.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><literal>yesno</literal></term>
|
||||
<listitem><para>
|
||||
Entered when there’s a yes/no prompt displayed.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><literal>caret</literal></term>
|
||||
<listitem><para>
|
||||
Entered when pressing the v mode, used to select text using the
|
||||
keyboard.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><literal>register</literal></term>
|
||||
<listitem><para>
|
||||
Entered when qutebrowser is waiting for a register name/key for
|
||||
commands like <literal>:set-mark</literal>.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
'';
|
||||
example = literalExample ''
|
||||
{
|
||||
normal = {
|
||||
"<Ctrl-v>" = "spawn mpv {url}";
|
||||
",p" = "spawn --userscript qute-pass";
|
||||
",l" = '''config-cycle spellcheck.languages ["en-GB"] ["en-US"]''';
|
||||
};
|
||||
prompt = {
|
||||
"<Ctrl-y>" = "prompt-yes";
|
||||
};
|
||||
}
|
||||
'';
|
||||
};
|
||||
|
||||
extraConfig = mkOption {
|
||||
type = types.lines;
|
||||
default = "";
|
||||
|
|
@ -64,6 +250,12 @@ in {
|
|||
|
||||
xdg.configFile."qutebrowser/config.py".text = concatStringsSep "\n" ([ ]
|
||||
++ mapAttrsToList (formatLine "c.") cfg.settings
|
||||
++ mapAttrsToList (formatDictLine "c.aliases") cfg.aliases
|
||||
++ mapAttrsToList (formatDictLine "c.url.searchengines") cfg.searchEngines
|
||||
++ mapAttrsToList (formatDictLine "c.bindings.key_mappings")
|
||||
cfg.keyMappings
|
||||
++ optional (!cfg.enableDefaultBindings) [ "c.bindings.default = {}" ]
|
||||
++ mapAttrsToList formatKeyBindings cfg.keyBindings
|
||||
++ optional (cfg.extraConfig != "") cfg.extraConfig);
|
||||
};
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1 +1,4 @@
|
|||
{ qutebrowser-settings = ./settings.nix; }
|
||||
{
|
||||
qutebrowser-settings = ./settings.nix;
|
||||
qutebrowser-keybindings = ./keybindings.nix;
|
||||
}
|
||||
|
|
|
|||
36
tests/modules/programs/qutebrowser/keybindings.nix
Normal file
36
tests/modules/programs/qutebrowser/keybindings.nix
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
{ config, lib, pkgs, ... }:
|
||||
|
||||
with lib;
|
||||
|
||||
{
|
||||
config = {
|
||||
programs.qutebrowser = {
|
||||
enable = true;
|
||||
|
||||
keyBindings = {
|
||||
normal = {
|
||||
"<Ctrl-v>" = "spawn mpv {url}";
|
||||
",l" = ''config-cycle spellcheck.languages ["en-GB"] ["en-US"]'';
|
||||
};
|
||||
prompt = { "<Ctrl-y>" = "prompt-yes"; };
|
||||
};
|
||||
};
|
||||
|
||||
nixpkgs.overlays = [
|
||||
(self: super: {
|
||||
qutebrowser = pkgs.writeScriptBin "dummy-qutebrowser" "";
|
||||
})
|
||||
];
|
||||
|
||||
nmt.script = ''
|
||||
assertFileContent \
|
||||
home-files/.config/qutebrowser/config.py \
|
||||
${
|
||||
pkgs.writeText "qutebrowser-expected-config.py" ''
|
||||
config.bind(",l", "config-cycle spellcheck.languages [\"en-GB\"] [\"en-US\"]", mode="normal")
|
||||
config.bind("<Ctrl-v>", "spawn mpv {url}", mode="normal")
|
||||
config.bind("<Ctrl-y>", "prompt-yes", mode="prompt")''
|
||||
}
|
||||
'';
|
||||
};
|
||||
}
|
||||
Loading…
Reference in a new issue