hmts.nvim

This neovim plugin allows (thanks to treesitter) highlighting languages contained in strings in various places of a Home Manager configuration nix file.

What it does

Often in a nix configuration, and in particular with home manager, you find yourself inlining files in arbitrary languages as strings. This, by default, gets highlighted as a plain, boring string. This plugin uses treesitter queries to inject the actual language used within the screen, enabling proper highlighting of the language within.

Note

The default nix queries from the nvim-treesitter first-party plugin do come with a few injections, but only the trivial ones. Properly detecting more complex stuff requires some lua code, which is what is done in hmts.nvim.

Here's an example of the difference it can make:

Default behavior	With hmts.nvim

Requirements

• Neovim 0.9
• Have treesitter enabled

Important

Make sure all the languages you embed are actually installed in treesitter, with :TSInstall. Don't be me, don't spend hours trying to figure out why your injections don't work when the parsers aren't even installed.

Installation

Install calops/hmts.nvim with your favorite package manager.

Example with lazy.nvim:

{
    "calops/hmts.nvim",
    version = "*",
}

Note

It is recommended to follow releases (all numbered with a semver tag, looking like vX.X.X) instead of the raw main branch, as things are expected to break occasionally there. This is done in lazy.nvim with version = * (you can choose a more specific version if you prefer).

Configuration

You're done already.

Usage

Automatic language detection

The following features work out-of-the-box without any user intervention.

From filename

When writing a file's content directly with home.file or xdg.configFile, we can infer the language from the specified filename, if possible:

# Also works with `home.file.*.text`
xdg.configFile."myprogram/myScript.py".text = ''
    print("foo")
'';

From arbitrary program options

Some programs have options asking for code in specific languages. Some of them are implemented in this plugin to automatically setup these arbitrary injections.

Here's the full list of the currently implemented options.

• Bash (bash language)
  • programs.bash.bashrcExtra
  • programs.bash.initExtra
  • programs.bash.logoutExtra
  • programs.bash.profileExtra
• Fish (fish language)
  • programs.fish.functions.*
  • programs.fish.functions.*.body
  • programs.fish.interactiveShellInit
  • programs.fish.loginShellInit
  • programs.fish.shellInit
• Zsh (bash language)
  • programs.bash.completionInit
  • programs.bash.envExtra
  • programs.bash.initExtraBeforeCompInit
  • programs.bash.initExtraFirst
  • programs.bash.initExtra
  • programs.bash.loginExtra
  • programs.bash.logoutExtra
  • programs.bash.profileExtra
• Firefox (css language)
  • programs.firefox.profiles.*.userChrome
• Wezterm (lua language)
  • programs.wezterm.extraConfig

Warning

These implementations are not exhaustive and may eventually be broken if the program's options change. If that happens, please use explicit annotations to set the injection.

Note

Contributions to implement new programs or fix existing ones are welcome.

Explicit annotations

From a shebang expression

For languages that support # comments, if you provide a shebang expression, the language will be inferred whenever possible:

home.activation.neovim = lib.hm.dag.entryAfter ["linkGeneration"] ''
    #! /bin/bash
    echo "Syncing neovim plugins"
    PATH="$PATH:${pkgs.git}/bin" $DRY_RUN_CMD ${lib.getExe my.neovim} --headless "+Lazy! restore" +qa
'';

From a preceding comment

For all the cases not handled by the other features, you can specify the language yourself with a comment right before the string that should be injected:

my_lua_script = /* lua */ ''
    require("foo")
    return {
        bar = foo.bar
    }
'';

my_python_script =
    # python
    ''
    import foo
    print(foo.bar)
    '';

FAQ

Don't I need to...

No. No, you don't need to call a setup() function. But there's still one (that does nothing) if you really feel compelled to. It won't break anything.

Contribute

Very few programs are handled right now, but I welcome any addition. Just look through the injections file and copy what's already there. It should be pretty straightforward for most things. If it isn't, don't hesitate to open an issue.

TODO

• Better description in the readme
• Screenshots in the readme
• Benchmark the performance impact and see if the queries can be optimized
• Find a better way to handle nix nodes among string fragments in shebang scripts
• Check the stuff that's already done on the to-do list