Skip to content

feat: add typed compose object support #325

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AlexZeitler merged 2 commits into from
Mar 31, 2026
+4,580 −3
Merged

feat: add typed compose object support #325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
83884bf
feat: add typed compose object support
AlexZeitler Mar 31, 2026
9729b12
fix: use type-only export for ComposeSpecification
AlexZeitler Mar 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ compose.upAll({
| `executablePath` | `string` | Path to docker-compose executable if not in `$PATH` |
| `config` | `string \| string[]` | Custom yml file(s), relative to `cwd` |
| `configAsString` | `string` | Configuration as string (ignores `config` if set) |
| `compose` | `ComposeSpecification` | Typed compose configuration object (converted to YAML internally) |
| `log` | `boolean` | Enable console logging |
| `composeOptions` | `string[] \| Array<string \| string[]>` | Options for all commands (e.g., `--verbose`) |
| `commandOptions` | `string[] \| Array<string \| string[]>` | Options for specific command |
Expand All @@ -89,3 +90,30 @@ compose.upAll({
commandOptions: ['--build', ['--timeout', '30']]
})
```

### Example with typed compose object

Instead of using a YAML file, you can pass a typed `ComposeSpecification` object directly. This gives you full TypeScript autocompletion and type checking for the Docker Compose configuration.

```typescript
import { upAll, ComposeSpecification } from 'docker-compose'

const compose: ComposeSpecification = {
services: {
web: {
image: 'nginx:latest',
ports: ['8080:80']
},
db: {
image: 'postgres:16',
environment: {
POSTGRES_PASSWORD: 'secret'
}
}
}
}

await upAll({ compose })
```

The `ComposeSpecification` type is generated from the official [Compose Specification JSON Schema](https://github.com/compose-spec/compose-spec), so it covers all valid compose file options.
6 changes: 4 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@
"ci": "yarn install --frozen-lockfile",
"test": "npx vitest --dir test --test-timeout=30000",
"lint": "eslint src/**/*.ts test/**/*.ts",
"build": "tsc",
"prepublishOnly": "tsc",
"generate:types": "json2ts schema/compose-spec.json src/compose-spec.d.ts",
"build": "yarn generate:types && tsc",
"prepublishOnly": "yarn generate:types && tsc",
"release": "yarn build && standard-version"
},
"repository": {
Expand Down Expand Up @@ -94,6 +95,7 @@
"eslint-plugin-prettier": "^3.3.1",
"eslint-watch": "^7.0.0",
"husky": "^6.0.0",
"json-schema-to-typescript": "^15.0.4",
"prettier": "^2.2.1",
"standard-version": "9.5.0",
"typescript": "^5.0.0",
Expand Down
6 changes: 6 additions & 0 deletions schema/NOTICE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
The file compose-spec.json is sourced from the Compose Specification project:
https://github.com/compose-spec/compose-go

Copyright The Compose Specification Authors.
Licensed under the Apache License, Version 2.0.
See https://www.apache.org/licenses/LICENSE-2.0
Loading
Loading