Skip to main content

Module header

Module header 

Source
Expand description

Parses the optional @data_deps = [...] declaration from the first contiguous block of // line comments at the top of a plugin script. See docs/specs/plugin-api.md §@data_deps header syntax for the full contract.

Resolved dep list is always a superset of &[DataDep::Status] — every plugin implicitly has access to the stdin payload — even if the author lists other deps explicitly or declares no header at all.

Enums§

HeaderError
Error surface for header parsing. The registry layer wraps these into PluginError variants with the plugin id attached.

Functions§

parse_data_deps_header
Parse a plugin script’s @data_deps header. Returns the resolved dep list (always including DataDep::Status), HeaderError on malformed syntax or an unknown / reserved dep name.