Skip to content

docs: document custom lockfile path via 'packlockfile' - #34

Merged
zuqini merged 1 commit into
mainfrom
docs/lockfile-path
Aug 2, 2026
Merged

docs: document custom lockfile path via 'packlockfile'#34
zuqini merged 1 commit into
mainfrom
docs/lockfile-path

Conversation

@zuqini

@zuqini zuqini commented Aug 2, 2026

Copy link
Copy Markdown
Owner

Follow-up to #6 (custom lockfile path), which was resolved upstream by neovim/neovim#36078.

Neovim 0.13+ exposes the 'packlockfile' option, and zpack delegates every lockfile read/write to vim.pack, so it works with zpack as-is — it just wasn't documented anywhere.

Adds a Lockfile location section to docs/tips.md and a mirrored *zpack-lockfile* subsection to doc/zpack.txt covering:

  • the default path ($XDG_CONFIG_HOME/nvim/nvim-pack-lock.json, i.e. inside your config repo)
  • the snippet to relocate it to stdpath('data')
  • the ordering caveat — must be set before the first vim.pack call, i.e. before the vim.pack.add() that installs zpack itself
  • the existing lockfile is not moved automatically

No code changes.

Note on #7's plenary follow-up ("maybe add it to the migration tips"): already covered on main by the default lazy plugins bullet in docs/tips.md / *zpack-migration-default-lazy*, so no change needed there.

Neovim 0.13+ (neovim/neovim#36078) makes the vim.pack lockfile path
configurable. zpack delegates all lockfile access to vim.pack, so the
option works as-is; note the ordering caveat (must be set before the
vim.pack.add() that installs zpack).

Refs #6
@zuqini zuqini closed this Aug 2, 2026
@zuqini zuqini reopened this Aug 2, 2026
@zuqini
zuqini merged commit dd5caa6 into main Aug 2, 2026
8 checks passed
@zuqini
zuqini deleted the docs/lockfile-path branch August 2, 2026 00:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant