container-interop / definition-interop
Promoting container interoperability through standard definitions
Installs: 1 002
Dependents: 7
Suggesters: 0
Security: 0
Stars: 19
Watchers: 13
Forks: 2
Open Issues: 6
This package is auto-updated.
Last update: 2024-04-19 19:59:15 UTC
README
definition-interop tries to offer a solution for writing cross-framework modules.
Introduction
Modules (aka packages or bundles) are widespread in modern frameworks. Unfortunately each framework has its own convention and tools for writing them. The goal of container-interop and more specifically definition-interop is to help developers write modules that can work in any framework.
Cross-framework modules can take advantage of PSR-7 (HTTP requests and responses abstractions) as well as Puli (resource location in packages), but the last missing piece is letting modules register container entries. That is necessary so that modules can expose services to users.
Scope
While container-interop/container-interop tries to standardize how to fetch entries from containers, container-interop/definition-interop tries to standardize how to define container entries.
The definitions standardized in this package are only meant to be used by modules; they are not meant to cover every use case of every container. Given this restricted scope, the definitions are intentionally simple in order to be easily supported by every container.
With that in mind, users can rest assured that they can use all the features offered by their container of choice, while only module developers have to make use of the standard definitions.
Installation
composer require container-interop/definition-interop@dev
This package adheres to the SemVer specification and will be fully backward compatible between minor versions.
Compatible projects
Projects implementing definition-interop
Projects providing definition classes implementing the definition-interop interfaces.
Loaders
Projects reading configuration files in any kind of format and generating definition-interop compatible definitions.
- YamlDefinitionLoader: Loads definitions from YAML files. Accepts a subset of Symfony YAML file format.
Projects consuming definition-interop
Projects reading definition-interop compatible definitions and turning them into actual container entries.
- Assembly: provides a simple container-interop compatible container
- Yaco: provides a compiler generating container-interop compatible containers
Note: A dedicated test suite is available for projects consuming definition-interop compatible definitions. Those projects can use this test suite to check compliance with definition-interop.