Skip to content

docs(dev-tools): clarify vfox metadata depends for install hooks#9573

Merged
jdx merged 7 commits intojdx:mainfrom
risu729:docs/clarify-tool-depends-vs-metadata
May 3, 2026
Merged

docs(dev-tools): clarify vfox metadata depends for install hooks#9573
jdx merged 7 commits intojdx:mainfrom
risu729:docs/clarify-tool-depends-vs-metadata

Conversation

@risu729
Copy link
Copy Markdown
Contributor

@risu729 risu729 commented May 3, 2026

Summary

  • Clarify that [tools] depends is an install graph ordering constraint for configured tools.
  • Document vfox PLUGIN.depends in metadata.lua as the hook-time dependency metadata for tool plugins.
  • Keep the docs scoped to vfox plugin metadata and hook PATH behavior.

Implementation Notes

Verified against mise's install scheduler and vfox hook environment code paths. [tools] depends is consumed by ToolDeps to add edges between tools in the current install set. vfox metadata.lua depends is parsed as an array of tool names; when matching tools are configured, mise uses those entries to order current install jobs and build the install-hook environment.

Verification

  • git diff --check

Document that [tools] depends controls install order only, while
registry and vfox metadata.lua depends feed dependency_env for hooks.
Add metadata.lua examples and vfox backend subsection.
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 3, 2026

Greptile Summary

This is a docs-only PR that distinguishes between [tools] depends (install-order constraint for configured tools) and vfox PLUGIN.depends in metadata.lua (plugin metadata that controls hook-time PATH and install ordering). It adds a new ### vfox plugin hook dependencies subsection in dev-tools/index.md and documents the depends field in the tool-plugin-development.md example.

Confidence Score: 5/5

Documentation-only changes; safe to merge with minor suggestions

No code changes; all findings are P2 style/completeness suggestions. The anchor precision and removed automatic-dependency context are cosmetic issues that don't affect correctness.

docs/dev-tools/index.md (dropped automatic backend dependency context); docs/configuration.md (anchor specificity)

Important Files Changed

Filename Overview
docs/configuration.md Clarifies depends description; link anchor points to parent section rather than the new vfox subsection directly
docs/dev-tools/index.md Adds ### vfox plugin hook dependencies subsection and rewrites depends prose; drops the automatic backend dependency context that was previously documented
docs/dev-tools/backends/vfox.md Minor wording improvement to the Dependencies section; no issues
docs/tool-plugin-development.md Adds depends field to the PLUGIN example and explanatory prose; the depends = { "node" } example in a plugin named "nodejs" is self-referential (noted in a previous review thread)

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["[tools] depends\n(mise.toml)"] -->|"install-graph ordering only\nbetween configured tools"| B[Install Scheduler]
    C["PLUGIN.depends\n(metadata.lua)"] -->|"plugin metadata\n(ordering + hook PATH)"| B
    B --> D[Install Jobs run in order]
    D --> E["Install hooks executed\nwith correct PATH"]
Loading

Reviews (5): Last reviewed commit: "docs(dev-tools): explain config depends ..." | Re-trigger Greptile

Comment thread docs/dev-tools/index.md Outdated
@risu729 risu729 changed the title docs(dev-tools): clarify config depends vs metadata.lua for install PATH docs(dev-tools): clarify vfox metadata depends for install hooks May 3, 2026
Comment thread docs/tool-plugin-development.md
@risu729 risu729 marked this pull request as ready for review May 3, 2026 18:51
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

@jdx jdx merged commit acdfc78 into jdx:main May 3, 2026
36 checks passed
mise-en-dev added a commit that referenced this pull request May 5, 2026
### 🚀 Features

- **(backend)** support top-level aqua cosign verification by @risu729
in [#9111](#9111)

### 🐛 Bug Fixes

- **(schema)** validate all schema files with draft2020 and strict mode
by @risu729 in [#9594](#9594)
- **(shim)** skip network resolution for installed tool dirs by @jdx in
[#9599](#9599)

### 📚 Documentation

- **(dev-tools)** clarify vfox metadata depends for install hooks by
@risu729 in [#9573](#9573)
- **(plugins)** remove registry submission guidance by @risu729 in
[#9577](#9577)

### 📦️ Dependency Updates

- lock file maintenance by @renovate[bot] in
[#9586](#9586)

### 📦 Registry

- remove bashly asdf fallback by @risu729 in
[#9578](#9578)
- use github backend for rebar by @risu729 in
[#9576](#9576)
- add wasm-tools
([aqua:bytecodealliance/wasm-tools](https://github.com/bytecodealliance/wasm-tools))
by @2xdevv in [#9596](#9596)
- enable symlink_bins for elixir-ls by @AlternateRT in
[#9592](#9592)

### Chore

- **(release)** always append sponsor block to release notes by @jdx in
[#9580](#9580)
- warn on vendored vfox embedded plugins by @risu729 in
[#9588](#9588)
- prefer registry shorthands over cargo/npm backends in mise.toml by
@risu729 in [#9595](#9595)

## 📦 Aqua Registry Updates

### New Packages (2)

-
[`salesforce/reactive-grpc/protoc-gen-reactor-grpc`](https://github.com/salesforce/reactive-grpc)
- [`spinframework/spin`](https://github.com/spinframework/spin)

### Updated Packages (1)

- [`pnpm/pnpm`](https://github.com/pnpm/pnpm)
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.

2 participants