id       = "volt"
name     = "Volt"
homepage = "https://github.com/vim-volt/volt"
description = "A meta-level vim package manager."
executables   = ["volt"]

[dotfiles]

# The project README's VOLTPATH section: "You can change base directory of volt
# by `VOLTPATH` environment variable. This is `$HOME/volt` by default." The same
# README names what lives under that base directory:
#
#   "Config file: `$VOLTPATH/config.toml`"
#   `$VOLTPATH/lock.json` — the repositories list each command reads and writes
#   `$VOLTPATH/rc/<profile>/vimrc.vim` and `gvimrc.vim`, which `volt build`
#     installs to ~/.vim/vimrc and ~/.vim/gvimrc
#   `$VOLTPATH/plugconf` — the per-plugin configuration `volt build` merges
#
# ~/volt is a literal directory in the home directory, not an XDG or %APPDATA%
# base, so it is written as such. A user who set VOLTPATH has moved the whole
# tree somewhere only that machine's environment names.
paths = [
  "~/volt/config.toml",
  "~/volt/lock.json",
  "~/volt/rc/",
  "~/volt/plugconf/",
]

# The README describes `volt get` as "Clone and install the repository to
# `$VOLTPATH/repos/github.com/tyru/caw.vim`" — plugin checkouts, which
# `volt build` recreates from lock.json.
exclude = [
  "~/volt/repos/",
]

# Nothing volt writes under ~/volt is a credential. It clones over https or ssh
# with git's own configuration, which is the `git` entry's business.
secret = []

# A one-shot Go binary: it reads config.toml and lock.json at startup and exits.
side_effect = false

# No machine_lines. config.toml holds the plugin-install strategy and the
# per-command build settings, and lock.json is the plugin list itself — both
# are what a user wants carried, and neither records anything about the
# machine it was written on.