devkits-docker-compose-parser

@devkits/docker-compose-parser

Parse and generate docker-compose.yml files. Build compose configurations programmatically. Zero-dependency Docker Compose utility.

Installation

npm install @devkits/docker-compose-parser

Usage

const { parse, generate, getServices, validate, createService, TEMPLATES } = require('@devkits/docker-compose-parser');

// Parse docker-compose.yml
const yaml = `
version: "3.8"
services:
  web:
    image: nginx
    ports:
      - "80:80"
    volumes:
      - ./html:/usr/share/nginx/html
  db:
    image: postgres:16
    environment:
      - POSTGRES_PASSWORD=secret
`;

const config = parse(yaml);
// { version: '3.8', services: { web: {...}, db: {...} } }

// Get service names
getServices(config);
// ['web', 'db']

// Validate configuration
validate(config);
// { valid: true, errors: [] }

// Generate docker-compose.yml from object
const newConfig = {
  version: '3.8',
  services: {
    app: createService({
      image: 'node:20-alpine',
      build: '.',
      ports: ['3000:3000'],
      environment: ['NODE_ENV=production'],
      volumes: ['.:/app']
    })
  }
};

const yamlOut = generate(newConfig);
// version: "3.8"
// services:
//   app:
//     image: node:20-alpine
//     build: .
//     ...

// Use built-in templates
const template = TEMPLATES['node-mongo'];
const templateYaml = generate(template);

API

parse(yaml)

Parses a docker-compose YAML string into a JavaScript object.

generate(config)

Generates docker-compose.yml string from a config object.

getServices(config)

Returns array of service names from a parsed config.

validate(config)

Validates a docker-compose config, returns {valid, errors}.

createService(options)

Helper to create a service configuration object.

TEMPLATES

Built-in templates for common stacks (node-mongo, python-postgres, etc.).

Supported Properties

Property	Description
image	Docker image to use
build	Build context path
ports	Port mappings (host:container)
environment	Environment variables
volumes	Volume mounts
depends_on	Service dependencies
restart	Restart policy

See Also

Free Online Version: DevKits - Docker Compose Generator

Other DevKits npm Packages

Package	Description
@devkits/base64-tool	Base64 encoding/decoding
@devkits/env-editor	.env file utilities
@devkits/json-formatter	Format and validate JSON
@devkits/chmod-calculator	Unix file permissions

Browse all 82 tools at DevKits

License

MIT