feat: add typed compose object support#325
Merged
AlexZeitler merged 2 commits intomasterfrom Mar 31, 2026
Merged
Conversation
Add a `compose` option to `IDockerComposeOptions` that accepts a typed `ComposeSpecification` object. The object is serialized to YAML internally and piped via stdin using the existing `configAsString` path. TypeScript types are generated from the official Compose Specification JSON Schema (Apache 2.0) using json-schema-to-typescript.
0a979f3 to
83884bf
Compare
The .d.ts file has no runtime module, so use `export type` instead of a value re-export to avoid ERR_MODULE_NOT_FOUND at runtime.
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
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
Closes #295
composeoption toIDockerComposeOptionsthat accepts a typedComposeSpecificationobjectjson-schema-to-typescriptconfigAsStringpath - no temporary files neededUsage