nvim-chezmoi

A NeoVim plugin written in Lua that integrates with chezmoi.

Requirements

• Neovim
• chezmoi
• plenary.nvim
• snacks.nvim

Features

• Interface for chezmoi commands.
• Sets the appropriate filetype for a source file based on the target file name.
• Preview the executed template in a new window.
• Apply all files or specified ones.
• Picker integration (via snacks.nvim) for browsing managed and special chezmoi files.

Installation

First, ensure that chezmoi is in your PATH.

Then, install nvim-chezmoi with your favorite plugin manager. You'll need both plenary and snacks.nvim installed too.

With lazy.nvim

  return {
    "andre-kotake/nvim-chezmoi",
    dependencies = {
      { "nvim-lua/plenary.nvim" },
      { "folke/snacks.nvim" },
    },
    opts = { 
      -- Your custom config 
    },
    config = function(_, opts)
      require("nvim-chezmoi").setup(opts)
    end,
  }

Configuration

Default configuration values for nvim-chezmoi:

  {
    -- Show extra debug messages.
    debug = false,
    -- chezmoi source path. Defaults to the result of `chezmoi source-path`
    -- Change this only if your dotfiles live in a different directory.
    source_path = nil,
    edit = {
      -- Automatically apply file on save. Can be one of: "auto", "confirm" or "never"
      apply_on_save = "never",
    },
    window = {
      -- Changes the layout for executed template window.
      execute_template = {
        relative = "editor",
        width = vim.o.columns,
        height = vim.o.lines,
        row = 0,
        col = 0,
        style = "minimal",
        border = "single",
      },
    },
  }

Usage

User Commands

Global

• :ChezmoiApply [file...]: Applies changes to source files. You may specify optional file args to apply them only.
• :ChezmoiEdit [file...]: Opens the source file from current buffer target file.You may specify optional [file] argument if you want to open that instead. Example: :ChezmoiEdit ~/.bashrc Encrypted files have partial supported. Tested and working fine for gpg encryption as long as you have args: ["--quiet"] in your chezmoi configuration.
• :ChezmoiManaged: List source managed files via Snacks.picker. Shows a diff preview of pending changes for each file.
• :ChezmoiFiles: List special chezmoi files (.chezmoi*) in the source directory via Snacks.picker.

Source files only

• :ChezmoiExecuteTemplate: Preview the executed template in a new buffer. Only applies for files with the ".tmpl" extension.
• :ChezmoiDetectFileType: Detects the correct filetype for the opened source file. Not really much use since it does it by default whenever you open a file.

To do

• Eliminate plenary dependency entirely (tracked in #3)
• Implement async-variants of all command modules
• Merge features in my Neovim config built atop this plugin into the plugin directly:
  • Notifications and progress spinners
  • Exit inhibiting if a job is in progress
  • Auto-detection
  • Live template preview

Acknowledgements

Stuff that helped me or inspired this:

• chezmoi
• plenary
• snacks.nvim
• andre-kotake/nvim-chezmoi (fork of)

For cool alternatives:

• alker0/chezmoi.vim
• xvzc/chezmoi.nvim

Contributing

All contributions and suggestions are welcome; Feel free to open an issue or pull request.

License

MIT