spec: add Composer ecosystem metadata fields and env key registry#91
Open
toderash wants to merge 2 commits into
Open
spec: add Composer ecosystem metadata fields and env key registry#91toderash wants to merge 2 commits into
toderash wants to merge 2 commits into
Conversation
…, and env key registry
Adds three interrelated changes to support Composer ecosystem integration:
- `composer-name` (Metadata Document): optional field declaring the canonical
Composer vendor/package name, providing the FAIR → Composer direction of the
bidirectional identity link.
- `x-composer-requires` (Release Document): optional map of Composer-native
dependencies not registered in FAIR, allowing full dependency graph resolution
for packages whose transitive deps have no FAIR DIDs.
- `x-composer-repositories` (Release Document): optional source hints for
x-composer-requires entries not resolvable through standard public registries.
- Environment keys table (registry.md): registers env:php, env:php-{name},
env:typo3, and env:wp with value format and Composer platform package mappings.
Unregistered env: keys are effectively client blockers per the requires spec.
Signed-off-by: toderash <brent@toderash.net>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: Brent Toderash <brent@toderash.net>
toderash
requested review from
Ipstenu,
afragen,
chuckadams,
costdev,
jazzsequence and
norcross
Member
Author
|
Semi-randomly tagged interested parties for reviews & comments - adding composer support to the protocol so we have something to implement against. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Three interrelated changes supporting Composer ecosystem integration. Grouped in one PR because
x-composer-requireskeys reference thecomposer-nameformat, and the env key registry documents the mappings that both fields depend on.composer-name(Metadata Document) — optional field declaring the canonicalvendor/packageComposer name. Provides the FAIR → Composer direction of the bidirectional identity link; the Composer → FAIR direction isextra.fair.package-didin an extension'scomposer.json(specified in the TYPO3 extension, applicable to any Composer-distributed package).x-composer-requires(Release Document) — optional map of Composer-native dependencies not registered in FAIR. Covers the common case where transitive deps (libraries, framework packages) have no FAIR DID and must be resolved through Packagist or a compatible registry. These are not FAIR-verified; they travel under thex-prefix to signal that they are outside the core FAIR trust model.x-composer-repositories(Release Document) — optional source hints forx-composer-requiresentries not resolvable through standard public registries (e.g. commercial plugins with private Composer endpoints). Clients MUST present additions to the user before writing them and MUST NOT add non-HTTPS repositories without explicit confirmation.Environment keys table (
registry.md) — registersenv:php,env:php-{name},env:typo3, andenv:wpwith value format and Composer platform package mappings. Per therequiresspec, unregisteredenv:keys are client blockers ("SHOULD treat as unfulfilled"); these keys are in active use in TYPO3 and WordPress release records.Test plan
composer-nameABNF is consistent with Composer's own schema documentation (linked)x-composer-requireskey constraint correctly cross-referencescomposer-nameformatx-composer-repositoriesHTTPS requirement is unambiguousext-typo3.mdandext-wp.mdenv:php-{name}pattern note is clear about the*value semantic🤖 Generated with Claude Code