Update name

Add service
Fix skipping first container in ps command
2026-06-14 12:11:25 +00:00 · 2021-12-12 10:33:03 +01:00 · 2021-11-30 21:05:59 +01:00 · 2021-11-30 21:00:04 +01:00 · 2021-11-29 08:18:31 +01:00 · 2021-11-29 07:57:04 +01:00
28 changed files with 6241 additions and 13204 deletions
--- a/.circleci/config.yml
+++ b/.circleci/config.yml
@ -1,39 +0,0 @@
-# Javascript Node CircleCI 2.0 configuration file
-#
-# Check https://circleci.com/docs/2.0/language-javascript/ for more details
-#
-version: 2
-jobs:
-  build:
-    docker:
-      # specify the version you desire here
-      - image: circleci/node:10
-
-      # Specify service dependencies here if necessary
-      # CircleCI maintains a library of pre-built images
-      # documented at https://circleci.com/docs/2.0/circleci-images/
-      # - image: circleci/mongo:3.4.4
-
-    working_directory: ~/repo
-
-    steps:
-      - setup_remote_docker
-      - checkout
-
-      # Download and cache dependencies
-      - restore_cache:
-          keys:
-          - v1-dependencies-{{ checksum "package.json" }}
-          # fallback to using the latest cache if no exact match is found
-          - v1-dependencies-
-
-      - run: npm install
-
-      - save_cache:
-          paths:
-            - node_modules
-          key: v1-dependencies-{{ checksum "package.json" }}
-
-      # run tests!
-      - run: npm test
-
--- a/.editorconfig
+++ b/.editorconfig
@ -3,11 +3,19 @@ root = true
 [**/**.yml]
 indent_style = space
 indent_size = 2
+insert_final_newline = true

 [**/**.js]
 indent_style = space
 indent_size = 2
+insert_final_newline = true
+
+[**/**.ts]
+indent_style = space
+indent_size = 2
+insert_final_newline = true

 [**/**.json]
 indent_style = space
-indent_size = 2
+indent_size = 2
+insert_final_newline = true
--- a/.eslintrc.js
+++ b/.eslintrc.js
@ -0,0 +1,17 @@
+module.exports = {
+  extends: [
+    'eslint:recommended',
+    'plugin:jest/recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended'
+  ],
+  env: {
+    node: true,
+    mocha: true,
+    es6: true
+  },
+  plugins: ['@typescript-eslint', 'prettier'],
+  parserOptions: {
+    parser: '@typescript-eslint/parser'
+  }
+}
--- a/.eslintrc.json
+++ b/.eslintrc.json
@ -1,31 +0,0 @@
-{
-  "extends": [
-    "es/2015/server",
-    "plugin:jest/recommended",
-    "plugin:@typescript-eslint/eslint-recommended",
-    "plugin:@typescript-eslint/recommended"
-  ],
-  "parserOptions": {
-    "project": "./tsconfig.json"
-  },
-  "rules": {
-    "no-console" :"off",
-    "@typescript-eslint/indent": "off",
-    "@typescript-eslint/interface-name-prefix":  "off",
-    "indent": [
-      "warn",
-      2,
-      {
-        "SwitchCase": 1
-      }
-    ]
-  },
-  "parser": "@typescript-eslint/parser",
-  "plugins": [
-    "jest",
-    "@typescript-eslint"
-  ],
-  "env": {
-    "jest/globals": true
-  }
-}
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@ -0,0 +1,31 @@
+name: Node.js CI
+
+on: 
+  push:
+    branches: 
+      - '*'
+  pull_request:
+    branches:
+      - master
+jobs:
+  lint:
+    runs-on: ubuntu-18.04
+    name: Lint
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-node@v1
+      with:
+        node-version: '12'
+    - run: yarn
+    - run: yarn lint
+  build:
+    runs-on: ubuntu-18.04
+    name: Build + Test
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-node@v1
+      with:
+        node-version: '12'
+    - run: yarn
+    - run: yarn build
+    - run: yarn test
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@ -0,0 +1,56 @@
+name: docs
+
+on:
+  # trigger deployment on every push to main branch
+  push:
+    branches: [master]
+  # trigger deployment manually
+  workflow_dispatch:
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          # fetch all commits to get last updated time or other git log info
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          # choose node.js version to use
+          node-version: '14'
+
+      # cache node_modules
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        id: yarn-cache
+        with:
+          path: |
+            **/node_modules
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+
+      # install dependencies if the cache did not hit
+      - name: Install dependencies
+        if: steps.yarn-cache.outputs.cache-hit != 'true'
+        run: yarn --frozen-lockfile
+
+      # run build script
+      - name: Build VuePress site
+        run: yarn docs:build
+
+      # please check out the docs of the workflow for more details
+      # @see https://github.com/crazy-max/ghaction-github-pages
+      - name: Deploy to GitHub Pages
+        uses: crazy-max/ghaction-github-pages@v2
+        with:
+          # deploy to gh-pages branch
+          target_branch: gh-pages
+          # deploy the default output dir of VuePress
+          build_dir: docs/.vuepress/dist
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
--- a/.gitignore
+++ b/.gitignore
@ -75,3 +75,7 @@ typings/
 # End of https://www.gitignore.io/api/node,jetbrains,visualstudiocode

 /dist
+
+### Vuepress ###
+.cache
+.temp
--- a/.husky/.gitignore
+++ b/.husky/.gitignore
@ -0,0 +1 @@
+_
--- a/.npmignore
+++ b/.npmignore
@ -1,9 +1,17 @@
-# ignore all files in the test/ directory
-test/
+# ignore docs
+docs/
+community-samples/readme.md
+readme.md

-# ignore ESLint and EditorConfig
+# ignore all files in the test/ directory and test settings
+test/
+jest.config.js
+
+# ignore EditorConfig, ESLint, Prettier config
 .editorconfig
 .eslintrc.json
+.eslintrc.js
+.prettierrc.js

 # JetBrains IDE settings
 .idea
@ -11,5 +19,9 @@ test/
 # VS Code settings
 .vscode

-# CircleCI
-.circleci
+# GitHub actions
+.github
+
+# VuePress
+.cache
+.temp
--- a/.prettierrc.js
+++ b/.prettierrc.js
@ -0,0 +1,12 @@
+module.exports = {
+  printWidth: 80,
+  tabWidth: 2,
+  singleQuote: true,
+  quoteProps: 'as-needed',
+  trailingComma: 'none',
+  bracketSpacing: true,
+  semi: false,
+  useTabs: false,
+  jsxBracketSameLine: false,
+  proseWrap: 'never'
+}
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@ -0,0 +1,13 @@
+{
+  "editor.formatOnSave": true,
+  "editor.formatOnPaste": true,
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[json]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  }
+}
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@ -2,6 +2,80 @@

 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

+### [0.23.14](https://github.com/PDMLab/docker-compose/compare/v0.23.13...v0.23.14) (2021-11-29)
+
+
+### Features
+
+* passing callback to report progress ([#191](https://github.com/PDMLab/docker-compose/issues/191)) ([f60e4d5](https://github.com/PDMLab/docker-compose/commit/f60e4d5a186ea3ca0b99e8443e1c4006d75be5a7))
+
+### [0.23.13](https://github.com/PDMLab/docker-compose/compare/v0.23.12...v0.23.13) (2021-07-20)
+
+
+### Features
+
+* single container pause and unpause added ([5921b51](https://github.com/PDMLab/docker-compose/commit/5921b51977cbd51ffcb1def458738ccfccbe1dd9))
+
+
+### Bug Fixes
+
+* now lints correctly ([74b4d6e](https://github.com/PDMLab/docker-compose/commit/74b4d6ea22d7e1b9ebbbbe9874e5314b7adfa31a))
+
+### [0.23.12](https://github.com/PDMLab/docker-compose/compare/v0.23.11...v0.23.12) (2021-06-06)
+
+
+### Features
+
+* **dx:** add default export ([c4b6087](https://github.com/PDMLab/docker-compose/commit/c4b60872aecfdc6610e9b2141a45ea7785820af7))
+
+### [0.23.11](https://github.com/PDMLab/docker-compose/compare/v0.23.10...v0.23.11) (2021-06-04)
+
+### [0.23.10](https://github.com/PDMLab/docker-compose/compare/v0.23.9...v0.23.10) (2021-05-11)
+
+
+### Bug Fixes
+
+* fix mapping ipv6-based port mappings ([53fb971](https://github.com/PDMLab/docker-compose/commit/53fb97196f3cf0ebb229d127e9b630c863eaf8fc))
+* fix mapping ipv6-based port mappings ([6dec0c6](https://github.com/PDMLab/docker-compose/commit/6dec0c6bb6220b06eff188a26220b405d632bed3))
+* fix mapping ipv6-based port mappings ([dbdb900](https://github.com/PDMLab/docker-compose/commit/dbdb9008f25d237254312d79382e342d03f4c5bb))
+* fix mapping ipv6-based port mappings ([8aa8465](https://github.com/PDMLab/docker-compose/commit/8aa846553c2d045f610392bf38569fb3579b9aa6))
+* fix mapping ipv6-based port mappings ([21b63cb](https://github.com/PDMLab/docker-compose/commit/21b63cbc53635ee8532c388e57f4552f1b3ae6e3))
+* fix mapping ipv6-based port mappings ([48c9f08](https://github.com/PDMLab/docker-compose/commit/48c9f0841af2bbcb8ec666a38eee3ab8236304d0))
+* fix mapping ipv6-based port mappings ([e7013df](https://github.com/PDMLab/docker-compose/commit/e7013dfab10e4e369ee076b465c40a5bcb50802b))
+
+### [0.23.9](https://github.com/PDMLab/docker-compose/compare/v0.23.8...v0.23.9) (2021-05-08)
+
+
+### Features
+
+* Add execPath option to set path to docker-compose executable ([58f09f4](https://github.com/PDMLab/docker-compose/commit/58f09f4c7414df5a6ee7af7f77d2af297d84d6c1))
+
+### [0.23.8](https://github.com/PDMLab/docker-compose/compare/v0.23.7...v0.23.8) (2021-04-15)
+
+
+### Bug Fixes
+
+* ignore vuepress cache + temp files on release ([#148](https://github.com/PDMLab/docker-compose/issues/148)) ([e58387d](https://github.com/PDMLab/docker-compose/commit/e58387d82e4586f7a8156446f12c999c9a6f9f42))
+
+### [0.23.7](https://github.com/PDMLab/docker-compose/compare/v0.23.5...v0.23.7) (2021-04-14)
+
+
+### Features
+
+* allow to pass docker compose configuration as string ([e8c14d3](https://github.com/PDMLab/docker-compose/commit/e8c14d318ce440ab02c858b1ca1dbeeb2985dc00))
+* make result for `config --services` command type safe ([6f105ca](https://github.com/PDMLab/docker-compose/commit/6f105ca16098ba8de11f85ec0d092130b65293e4))
+* make result for `config --volumes` command type safe ([51b20b4](https://github.com/PDMLab/docker-compose/commit/51b20b43d6eccac45653553437a546e4ccee51a6))
+* make result for `config` command type safe ([a2f5a4e](https://github.com/PDMLab/docker-compose/commit/a2f5a4ec0eee8fcbd60fa12f969b8eb83a4730fb))
+* make result for `port` command type safe ([70a98f4](https://github.com/PDMLab/docker-compose/commit/70a98f473b7bd46f0aa03c1a4334fa2abf6c3455))
+* make result for `ps` command type safe ([880d252](https://github.com/PDMLab/docker-compose/commit/880d2522b5777db30c48569a41dd09fb7e46a4b3))
+* make result for `version` command type safe ([a7da038](https://github.com/PDMLab/docker-compose/commit/a7da0380a8464bbd2efc2c16b70b67d4fdf77c24))
+
+
+### Bug Fixes
+
+* filter empty entries from `config --services` command ([ed91eba](https://github.com/PDMLab/docker-compose/commit/ed91eba770d3a32d82dda4e927d31ed4b6d01db4))
+* **test:** fix broken tests ([afb2b11](https://github.com/PDMLab/docker-compose/commit/afb2b1116b12c4800563e85adb15ebd39e030516))
+
 ### [0.23.6](https://github.com/PDMLab/docker-compose/compare/v0.23.5...v0.23.6) (2021-01-06)


--- a/2
+++ b/2
@ -1,6 +1,6 @@
 MIT License

-Copyright (c) 2017 - 2019 PDMLab
+Copyright (c) 2017 - 2021 PDMLab

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
--- a/docs/.vuepress/config.js
+++ b/docs/.vuepress/config.js
@ -0,0 +1,12 @@
+module.exports = {
+  base: '/docker-compose/',
+  themeConfig: {
+    navbar: [
+      { text: 'GitHub', link: 'https://github.com/PDMLab/docker-compose' },
+      { text: 'npm', link: 'https://npmjs.com/docker-compose' }
+    ],
+    displayAllHeaders: true,
+    lastUpdated: true,
+    sidebar: []
+  }
+}
--- a/docs/README.md
+++ b/docs/README.md
@ -1,20 +1,11 @@
 ---
-layout: default
-title: README
-nav_order: 99
+title: Manage Docker-Compose via Node.js
+lang: en-US
+home: false
 ---
-
-<img src="https://img.shields.io/circleci/project/github/PDMLab/docker-compose.svg" /> <a href="https://join.slack.com/t/pdmlab-oss/shared_invite/enQtNjEyMjQ0MDY3NTczLTg1ZDc0YjQxMGE3MTcyYTdkODU1YjFmMTBiODE2ZTZiNDFkNjc1MWE4OTE4NWY0Y2YyMWYzYmNhZGY0NDAyYWY"><img src="https://img.shields.io/badge/Slack-join-green.svg?logo=slack" /></a>
-
 # Manage Docker-Compose via Node.js

-`docker-compose` is a small library that allows you to run [docker-compose](https://docs.docker.com/compose/)(which is still required) via Node.js. This is useful to bootstrap test environments. You might also generate your `docker-compose.yml` files using [composefile](https://www.npmjs.com/package/composefile).
-
-## Existing user? We need your help
-First of all: thanks for using the `docker-compose` module.
-As described in [#44][i44], we're planning to provide more guidance for CI/CD when using the `docker-compose` module and it would be great if you could support us here. More details in [#44][i44].
-
-[i44]: https://github.com/PDMLab/docker-compose/issues/44
+`docker-compose` is a small library that allows you to run [docker-compose](https://docs.docker.com/compose/) (which is still required) via Node.js. This is useful to bootstrap test environments.

 ## Installation

@ -26,26 +17,34 @@ npm install --save-dev docker-compose

 `docker-compose` current supports these commands:

-* `upAll(options)` - Builds, (re)creates, starts, and attaches to containers for all services - always uses the `-d` flag due to non interactive mode
-* `upMany(services, options)` - Builds, (re)creates, starts, and attaches to containers for the services specified in `services` - always uses the `-d` flag due to non interactive mode
-* `upOne(service, options)` - Builds, (re)creates, starts, and attaches to containers for a service specified in `service` - always uses the `-d` flag due to non interactive mode
-* `down(options)` - Stops containers and removes containers, networks, volumes, and images created by `up`
-* `kill(options)` - Force stop service containers
-* `stop(options)` - Stop running containers without removing them
-* `rm(options)` - Remove stopped service containers - always uses the `-f` flag due to non interactive mode
-* `exec(container, command, options)` - Exec `command` inside `container`, uses `-T` to properly handle stdin & stdout
-* `logs(container, command, options)` - Show logs of service. Use `options.follow` `true|false` to turn on `--follow` flag.
-* `run(service, command, options)` - Run a one-off `command` on a service, uses `-T` to properly handle stdin & stdout
 * `buildAll(options)` - Build or rebuild services
 * `buildMany(services, options)` - Build or rebuild services
 * `buildOne(service, options)` - Build or rebuild service
-* `restartAll(options)` - Restart all services
-* `restartMany(services, options)` - Restart services
-* `restartOne(service, options)` - Restart service
-* `ps(options)` - Lists containers information
 * `config(options)` - Validates configuration files and returns configuration yaml
 * `configServices(options)` - Returns list of services defined in configuration files
 * `configVolumes(options)` - Returns list of volumes defined in configuration files
+* `down(options)` - Stops containers and removes containers, networks, volumes, and images created by `up`
+* `exec(container, command, options)` - Exec `command` inside `container` - uses `-T` to properly handle stdin & stdout
+* `kill(options)` - Force stop service containers
+* `logs(services, options)` - Show logs of service(s) - use `options.follow` `true|false` to turn on `--follow` flag
+* `pauseOne(service, options)` - Pause the specified service
+* `port(service, containerPort, options)` - Returns the public port of the given service and internal port. 
+* `ps(options)` - Lists containers information
+* `pullAll(options)` - Pull all service images
+* `pullMany(services, options)` - Pull service images specified
+* `pullOne(service, options)` - Pull a service image
+* `restartAll(options)` - Restart all services
+* `restartMany(services, options)` - Restart services
+* `restartOne(service, options)` - Restart service
+* `rm(options, services)` - Remove stopped service containers - always uses the `-f` flag due to non interactive mode - `services` can optionally be used to select the containers to remove
+* `run(service, command, options)` - Run a one-off `command` on a service - uses `-T` to properly handle stdin & stdout
+* `stop(options)` - Stop running containers without removing them
+* `stopOne(service, options)` - Stops one container without removing it
+* `unpauseOne(service, options)` - Resume the specified service
+* `upAll(options)` - Builds, (re)creates, starts, and attaches to containers for all services - always uses the `-d` flag due to non interactive mode
+* `upMany(services, options)` - Builds, (re)creates, starts, and attaches to containers for the services specified in `services` - always uses the `-d` flag due to non interactive mode
+* `upOne(service, options)` - Builds, (re)creates, starts, and attaches to containers for a service specified in `service` - always uses the `-d` flag due to non interactive mode
+* `version(options)` - Show `docker-compose` version strings

 All commands return a `Promise({object})` with stdout and stderr strings and an exit code:
 ```javascript
@ -55,6 +54,7 @@ All commands return a `Promise({object})` with stdout and stderr strings and an
  exitCode: 0, // !== 0 in case of an error
 }
 ```
+Although the return type is a `Promise`, it is still possible to get the process progres before the `Promise` resolves, by passing a callback function to the optional `callback` parameter. 

 ### Example

@ -67,6 +67,19 @@ compose.upAll({ cwd: path.join(__dirname), log: true })
    err => { console.log('something went wrong:', err.message)}
  );
 ```
+To get process progres
+```typescript
+compose.upAll({
+   cwd: path.join(__dirname),
+   callback: (chunk: Buffer) => {
+     console.log('job in progres: ', chunk.ToString())
+      }
+   })
+  .then(
+    () => { console.log('job done')},
+    err => { console.log('something went wrong:', err.message)}
+  );
+```

 To execute command inside a running container
 ```javascript
@ -78,9 +91,12 @@ compose.exec('node', 'npm install', { cwd: path.join(__dirname) })
 `docker-compose` accepts these params:

 * `cwd {string}`: mandatory folder path to the `docker-compose.yml`
+* `executablePath {string}`: optional path to docker-compose executable in case it's not located in $PATH `/path/to/docker-compose`
 * `config {(string|string[])}`: custom and/or multiple yml files can be specified (relative to `cwd`)
+* `configAsString {string}`: configuration can be provided as is, instead of relying on a file. In case `configAsString` is provided `config` will be ignored.
 * `[log] {boolean}`:  optional setting to enable console logging (output of `docker-compose` `stdout`/`stderr` output)
 * `[composeOptions] string[]|Array<string|string[]`: pass optional compose options like `"--verbose"` or `[["--verbose"], ["--log-level", "DEBUG"]]` or `["--verbose", ["--loglevel", "DEBUG"]]` for *all* commands.
+* `[callback] (chunk: Buffer, sourceStream?: 'stdout' | 'stderr') => void`: optional callback function, that provides infromation about the process while it is still runing.  
 * `[commandOptions] string[]|Array<string|string[]`: pass optional command options like `"--build"` or `[["--build"], ["--timeout", "5"]]` or `["--build", ["--timeout", "5"]]` for the `up` command. Viable `commandOptions` depend on the command (`up`, `down` etc.) itself

 ## Running the tests
@ -88,7 +104,7 @@ compose.exec('node', 'npm install', { cwd: path.join(__dirname) })
 While `docker-compose` runs on Node.js 6+, running the tests requires you to use Node.js 8 as they make use of `async/await`.

 ```
-npm test
+yarn test
 ```

 ## Want to help?
@ -101,17 +117,19 @@ If you see a bug, please be so kind as to show how it's failing, and we'll do ou

 Before sending a PR, please [create an issue](https://github.com/PDMLab/docker-compose/issues/new) to introduce your idea and have a reference for your PR.

-Also please add tests and make sure to run `npm run eslint`.
+We're using [conventional commits](https://www.conventionalcommits.org), so please use it for your commits as well.

-### Slack
+Also please add tests and make sure to run `yarn lint`.

-If you want to discuss an `docker-compose` issue or PR in more detail, feel free to [join our Slack workspace](https://join.slack.com/t/pdmlab-oss/shared_invite/enQtNjEyMjQ0MDY3NTczLTg1ZDc0YjQxMGE3MTcyYTdkODU1YjFmMTBiODE2ZTZiNDFkNjc1MWE4OTE4NWY0Y2YyMWYzYmNhZGY0NDAyYWY). 
+### Discussions
+
+If you want to discuss an `docker-compose` issue or PR in more detail, feel free to [start a discussion](https://github.com/PDMLab/docker-compose/discussions).

 ## License

 MIT License

-Copyright (c) 2017 - 2019 PDMLab
+Copyright (c) 2017 - 2021 PDMLab

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
--- a/docs/_config.yml
+++ b/docs/_config.yml
@ -1,23 +0,0 @@
-title: docker-compose
-description: A Jekyll theme for documentation
-baseurl: "/docker-compose/" # the subpath of your site, e.g. /blog
-url: "https://pdmlab.github.io" # the base hostname & protocol for your site, e.g. http://example.com
-
-permalink: pretty
-exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json",  "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"]
-
-# Enable or disable the site search
-search_enabled: true
-
-# Aux links for the upper right navigation
-aux_links:
-  "docker-compose on GitHub":
-    - "//github.com/pdmlab/docker-compose"
-
-# Color scheme currently only supports "dark" or nil (default)
-color_scheme: nil
-
-remote_theme: pmarsceill/just-the-docs
-
-plugins:
-  - jekyll-seo-tag
--- a/docs/_sass/custom/custom.scss
+++ b/docs/_sass/custom/custom.scss
@ -1,120 +0,0 @@
-// //
-// // Typography
-// //
-//
-// $body-font-family: -apple-system, BlinkMacSystemFont, "helvetica neue", helvetica, roboto, noto, "segoe ui", arial, sans-serif;
-// $mono-font-family: "SFMono-Regular", Menlo, Consolas, Monospace;
-// $root-font-size: 16px;         // Base font-size for rems
-// $body-line-height: 1.4;
-// $body-heading-line-height: 1.15;
-//
-// //
-// // Colors
-// //
-//
-// $white: #fff;
-//
-// $grey-dk-000: #959396;
-// $grey-dk-100: #5c5962;
-// $grey-dk-200: #44434d;
-// $grey-dk-250: #302d36 !default;
-// $grey-dk-300: #27262b;
-//
-// $grey-lt-000: #f5f6fa;
-// $grey-lt-100: #eeebee;
-// $grey-lt-200: #ecebed;
-// $grey-lt-300: #e6e1e8;
-//
-// $purple-000: #7253ed;
-// $purple-100: #5e41d0;
-// $purple-200: #4e26af;
-// $purple-300: #381885;
-//
-$blue-000: #2c84fa;
-// $blue-100: #2869e6;
-// $blue-200: #264caf;
-// $blue-300: #183385;
-//
-// $green-000: #41d693;
-// $green-100: #11b584;
-// $green-200: #009c7b;
-// $green-300: #026e57;
-//
-// $body-background-color: $white !default;
-// $sidebar-color: $grey-lt-000 !default;
-// $code-background-color: $grey-lt-000 !default;
-
-// $body-text-color: $grey-dk-100 !default;
-// $body-heading-color: $grey-dk-300 !default;
-// $nav-child-link-color: $grey-dk-100 !default
-$link-color: $blue-000;
-// $btn-primary-color: $purple-100 !default;
-// $base-button-color: #f7f7f7 !default;
-//
-// //
-// // Media queries in pixels
-// //
-//
-// $media-queries: (
-//   xs: 320px,
-//   sm: 500px,
-//   md: 740px,
-//   lg: 1120px,
-//   xl: 1400px
-// );
-//
-// //
-// // Spacing
-// //
-//
-// $spacing-unit: 1rem; // 1rem == 16px
-//
-// $spacers: (
-//   sp-0: 0,
-//   sp-1: $spacing-unit * 0.25,
-//   sp-2: $spacing-unit * 0.5,
-//   sp-3: $spacing-unit * 0.75,
-//   sp-4: $spacing-unit,
-//   sp-5: $spacing-unit * 1.5,
-//   sp-6: $spacing-unit * 2,
-//   sp-7: $spacing-unit * 2.5,
-//   sp-8: $spacing-unit * 3,
-//   sp-9: $spacing-unit * 3.5,
-//   sp-10: $spacing-unit * 4
-// );
-//
-// $sp-1: map-get($spacers, sp-1); // 0.25 rem == 4px
-// $sp-2: map-get($spacers, sp-2); // 0.5  rem == 8px
-// $sp-3: map-get($spacers, sp-3); // 0.75 rem == 12px
-// $sp-4: map-get($spacers, sp-4); // 1    rem == 16px
-// $sp-5: map-get($spacers, sp-5); // 1.5  rem == 24px
-// $sp-6: map-get($spacers, sp-6); // 2    rem == 32px
-// $sp-7: map-get($spacers, sp-7); // 2.5  rem == 40px
-// $sp-8: map-get($spacers, sp-8); // 3    rem == 48px
-// $sp-9: map-get($spacers, sp-9); // 4    rem == 48px
-// $sp-10: map-get($spacers, sp-10); // 4.5  rem == 48px
-//
-// //
-// // Borders
-// //
-//
-// $border: 1px solid;
-// $border-radius: 4px;
-// $border-color: $grey-lt-100;
-//
-// //
-// // Grid system
-// //
-//
-// $gutter-spacing: $sp-6;
-// $gutter-spacing-sm: $sp-4;
-// $nav-width: 232px;
-// $content-width: 800px;
-//
-// $media-queries: (
-//   xs: 320px,
-//   sm: 500px,
-//   md: 740px,
-//   lg: 800px,
-//   xl: 1316px
-// );
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@ -1,15 +1,17 @@
 {
-  "name": "docker-compose",
-  "version": "0.23.6",
+  "name": "@iceprod/docker-compose",
+  "version": "0.24.0",
  "main": "dist/index.js",
  "typings": "dist/index.d.ts",
  "types": "dist/index.d.ts",
  "scripts": {
    "test": "jest test --verbose",
-    "eslint": "eslint src/**/*.ts test/**/*.ts",
+    "lint": "eslint src/**/*.ts test/**/*.ts",
    "build": "tsc",
    "prepublishOnly": "tsc",
-    "release": "yarn build && standard-version"
+    "release": "yarn build && standard-version",
+    "docs:dev": "vuepress dev docs",
+    "docs:build": "vuepress build docs"
  },
  "repository": {
    "url": "git@github.com:PDMLab/docker-compose.git"
@ -22,7 +24,7 @@
    "test",
    "test-tools"
  ],
-  "author": "Alexander Zeitler <alexander.zeitler@pdmlab.com>",
+  "author": "Alexander Zeitler <alexander.zeitler@pdmlab.com>, Daniel Bulan <danbulant@danbulant.eu>",
  "contributors": [
    {
      "name": "Ignatiev Mikhail"
@ -70,28 +72,39 @@
    {
      "name": "Gabriel Fürstenheim",
      "url": "https://github.com/furstenheim"
+    },
+    {
+      "name": "gautaz"
+    },
+    {
+      "name": "Daniel Bulant",
+      "url": "https://github.com/danbulant"
    }
  ],
  "license": "MIT",
  "description": "Manage docker-compose from Node.js",
  "devDependencies": {
-    "@commitlint/cli": "^8.2.0",
-    "@commitlint/config-conventional": "^8.2.0",
+    "@commitlint/cli": "^13.1.0",
+    "@commitlint/config-conventional": "13.1.0",
    "@types/dockerode": "^2.5.27",
-    "@types/jest": "^25.1.4",
-    "@types/node": "^10.17.17",
-    "@typescript-eslint/eslint-plugin": "^2.23.0",
-    "@typescript-eslint/parser": "^2.23.0",
-    "dockerode": "^3.1.0",
-    "eslint": "^6.8.0",
-    "eslint-config-es": "^3.19.44",
-    "eslint-plugin-extended": "^0.2.0",
-    "eslint-plugin-jest": "^23.8.2",
-    "husky": "^4.2.3",
-    "jest": "^25.1.0",
-    "standard-version": "^8.0.1",
-    "ts-jest": "^25.2.1",
-    "typescript": "^3.8.3"
+    "@types/jest": "^26.0.22",
+    "@types/node": "^12.12.6",
+    "@typescript-eslint/eslint-plugin": "^4.21.0",
+    "@typescript-eslint/parser": "^4.21.0",
+    "dockerode": "^3.2.1",
+    "eslint": "^7.24.0",
+    "eslint-config-prettier": "^8.1.0",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-jest": "^24.3.4",
+    "eslint-plugin-prettier": "^3.3.1",
+    "eslint-watch": "^7.0.0",
+    "husky": "^6.0.0",
+    "jest": "^26.6.3",
+    "prettier": "^2.2.1",
+    "standard-version": "9.3.1",
+    "ts-jest": "^26.5.4",
+    "typescript": "^4.2.4",
+    "vuepress": "^2.0.0-beta.7"
  },
  "engines": {
    "node": ">= 6.0.0"
@ -105,5 +118,8 @@
    "extends": [
      "@commitlint/config-conventional"
    ]
+  },
+  "dependencies": {
+    "yaml": "^1.10.2"
  }
 }
--- a/readme.md
+++ b/readme.md
@ -1,87 +1,46 @@
-[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org) [![Join the chat at https://gitter.im/pdmlab/docker-compose](https://badges.gitter.im/pdmlab/docker-compose.svg)](https://gitter.im/pdmlab/docker-compose?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) <img src="https://img.shields.io/circleci/project/github/PDMLab/docker-compose.svg" /> <a href="https://join.slack.com/t/pdmlab-oss/shared_invite/enQtNjEyMjQ0MDY3NTczLTg1ZDc0YjQxMGE3MTcyYTdkODU1YjFmMTBiODE2ZTZiNDFkNjc1MWE4OTE4NWY0Y2YyMWYzYmNhZGY0NDAyYWY"><img src="https://img.shields.io/npm/dm/docker-compose.svg" /> <img src="https://img.shields.io/badge/Slack-join-green.svg?logo=slack" /></a>
+[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org) [![Join the chat at https://gitter.im/pdmlab/docker-compose](https://badges.gitter.im/pdmlab/docker-compose.svg)](https://gitter.im/pdmlab/docker-compose?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) <img src="https://img.shields.io/github/workflow/status/pdmlab/docker-compose/Node.js%20CI/master" /> <img src="https://img.shields.io/npm/dm/docker-compose.svg" />

 # Manage Docker-Compose via Node.js

-`docker-compose` is a small library that allows you to run [docker-compose](https://docs.docker.com/compose/)(which is still required) via Node.js. This is useful to bootstrap test environments. You might also generate your `docker-compose.yml` files using [composefile](https://www.npmjs.com/package/composefile).
+`docker-compose` is a small library that allows you to run [docker-compose](https://docs.docker.com/compose/)(which is still required) via Node.js. This is useful to bootstrap test environments.

 ## Installation

-```
-npm install --save-dev docker-compose
+```bash
+yarn add --dev docker-compose
 ```

-## Usage
+## Documentation

-`docker-compose` current supports these commands:
+The documentation can be found [here](https://pdmlab.github.io/docker-compose/).

-* `upAll(options)` - Builds, (re)creates, starts, and attaches to containers for all services - always uses the `-d` flag due to non interactive mode
-* `upMany(services, options)` - Builds, (re)creates, starts, and attaches to containers for the services specified in `services` - always uses the `-d` flag due to non interactive mode
-* `upOne(service, options)` - Builds, (re)creates, starts, and attaches to containers for a service specified in `service` - always uses the `-d` flag due to non interactive mode
-* `down(options)` - Stops containers and removes containers, networks, volumes, and images created by `up`
-* `kill(options)` - Force stop service containers
-* `stop(options)` - Stop running containers without removing them
-* `stopOne(service, options)` - Stops one container without removing it
-* `rm(options)` - Remove stopped service containers - always uses the `-f` flag due to non interactive mode
-* `exec(container, command, options)` - Exec `command` inside `container`, uses `-T` to properly handle stdin & stdout
-* `logs(services, options)` - Show logs of service(s). Use `options.follow` `true|false` to turn on `--follow` flag.
-* `run(service, command, options)` - Run a one-off `command` on a service, uses `-T` to properly handle stdin & stdout
-* `buildAll(options)` - Build or rebuild services
-* `buildMany(services, options)` - Build or rebuild services
-* `buildOne(service, options)` - Build or rebuild service
-* `pullMany(services, options)` - Pull service images specified
-* `pullOne(service, options)` - Pull a service image
-* `pullAll(options)` - Pull all service images
-* `restartAll(options)` - Restart all services
-* `restartMany(services, options)` - Restart services
-* `restartOne(service, options)` - Restart service
-* `ps(options)` - Lists containers information
-* `config(options)` - Validates configuration files and returns configuration yaml
-* `configServices(options)` - Returns list of services defined in configuration files
-* `configVolumes(options)` - Returns list of volumes defined in configuration files
-
-All commands return a `Promise({object})` with stdout and stderr strings and an exit code:
-```javascript
-{
-  out: 'stdout contents',
-  err: 'stderr contents',
-  exitCode: 0, // !== 0 in case of an error
-}
-```
-
-### Example
+## Example

 To start service containers based on the `docker-compose.yml` file in your current directory, just call `compose.up` like this:

 ```javascript
-compose.upAll({ cwd: path.join(__dirname), log: true })
-  .then(
-    () => { console.log('done')},
-    err => { console.log('something went wrong:', err.message)}
-  );
+compose.upAll({ cwd: path.join(__dirname), log: true }).then(
+  () => {
+    console.log('done')
+  },
+  (err) => {
+    console.log('something went wrong:', err.message)
+  }
+)
 ```

 To execute command inside a running container
+
 ```javascript
 compose.exec('node', 'npm install', { cwd: path.join(__dirname) })
 ```

-### Options
-
-`docker-compose` accepts these params:
-
-* `cwd {string}`: mandatory folder path to the `docker-compose.yml`
-* `config {(string|string[])}`: custom and/or multiple yml files can be specified (relative to `cwd`)
-* `configAsString {string}`: configuration can be provided as is, instead of relying on a file. In case `configAsString` is provided `config` will be ignored.
-* `[log] {boolean}`:  optional setting to enable console logging (output of `docker-compose` `stdout`/`stderr` output)
-* `[composeOptions] string[]|Array<string|string[]`: pass optional compose options like `"--verbose"` or `[["--verbose"], ["--log-level", "DEBUG"]]` or `["--verbose", ["--loglevel", "DEBUG"]]` for *all* commands.
-* `[commandOptions] string[]|Array<string|string[]`: pass optional command options like `"--build"` or `[["--build"], ["--timeout", "5"]]` or `["--build", ["--timeout", "5"]]` for the `up` command. Viable `commandOptions` depend on the command (`up`, `down` etc.) itself
-
 ## Running the tests

-While `docker-compose` runs on Node.js 6+, running the tests requires you to use Node.js 8 as they make use of `async/await`.
+While `docker-compose` runs on Node.js 6+, running the tests requires you to use Node.js 8+ as they make use of `async/await`.

-```
-npm test
+```bash
+yarn test
 ```

 ## Want to help?
@ -96,33 +55,20 @@ Before sending a PR, please [create an issue](https://github.com/PDMLab/docker-c

 We're using [conventional commits](https://www.conventionalcommits.org), so please use it for your commits as well.

-Also please add tests and make sure to run `npm run eslint`.
+Also please add tests and make sure to run `yarn lint`.

-### Slack
+### Discussions

-If you want to discuss an `docker-compose` issue or PR in more detail, feel free to [join our Slack workspace](https://join.slack.com/t/pdmlab-oss/shared_invite/enQtNjEyMjQ0MDY3NTczLTg1ZDc0YjQxMGE3MTcyYTdkODU1YjFmMTBiODE2ZTZiNDFkNjc1MWE4OTE4NWY0Y2YyMWYzYmNhZGY0NDAyYWY).
+If you want to discuss an `docker-compose` issue or PR in more detail, feel free to [start a discussion](https://github.com/PDMLab/docker-compose/discussions).

 ## License

 MIT License

-Copyright (c) 2017 - 2019 PDMLab
+Copyright (c) 2017 - 2021 PDMLab

-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
--- a/src/index.ts
+++ b/src/index.ts
@ -1,31 +1,106 @@
-import childProcess from 'child_process';
-import { Readable } from 'stream'
+import childProcess from 'child_process'
+import yaml from 'yaml'
+import mapPorts from './map-ports'
+
 export interface IDockerComposeOptions {
-  cwd?: string;
-  config?: string | string[];
-  configAsString?: string;
-  log?: boolean;
-  composeOptions?: string[] | (string | string[])[];
-  commandOptions?: string[] | (string | string[])[];
-  env?: NodeJS.ProcessEnv;
+  cwd?: string
+  executablePath?: string
+  config?: string | string[]
+  configAsString?: string
+  log?: boolean
+  composeOptions?: string[] | (string | string[])[]
+  commandOptions?: string[] | (string | string[])[]
+  env?: NodeJS.ProcessEnv
+  callback?: (chunk: Buffer, streamSource?: 'stdout' | 'stderr') => void
+}
+
+export type DockerComposePortResult = {
+  address: string
+  port: number
+}
+
+export type DockerComposeVersionResult = {
+  version: string
+}
+
+export type DockerComposeConfigResult = {
+  config: {
+    version: Record<string, string>
+    services: Record<string, string | Record<string, string>>
+    volumes: Record<string, string>
+  }
+}
+
+export type DockerComposeConfigServicesResult = {
+  services: string[]
+}
+
+export type DockerComposeConfigVolumesResult = {
+  volumes: string[]
 }

 export interface IDockerComposeLogOptions extends IDockerComposeOptions {
-  follow?: boolean;
+  follow?: boolean
 }

 export interface IDockerComposeBuildOptions extends IDockerComposeOptions {
-  parallel?: boolean;
+  parallel?: boolean
 }

 export interface IDockerComposePushOptions extends IDockerComposeOptions {
-  ignorePushFailures?: boolean;
+  ignorePushFailures?: boolean
 }

 export interface IDockerComposeResult {
-  exitCode: number | null;
-  out: string;
-  err: string;
+  exitCode: number | null
+  out: string
+  err: string
+}
+
+export type TypedDockerComposeResult<T> = {
+  exitCode: number | null
+  out: string
+  err: string
+  data: T
+}
+
+const nonEmptyString = (v: string) => v !== ''
+
+export type DockerComposePsResult = {
+  services: Array<{
+    name: string
+    command: string
+    state: string
+    ports: Array<{
+      mapped?: { address: string; port: number }
+      exposed: { port: number; protocol: string }
+    }>
+  }>
+}
+
+export const mapPsOutput = (output: string): DockerComposePsResult => {
+  const services = output
+    .split(`\n`)
+    .filter(nonEmptyString)
+    .filter((_, index) => index > 0)
+    .map((line) => {
+      const [
+        nameFragment,
+        commandFragment,
+        serviceFragment,
+        stateFragment,
+        untypedPortsFragment
+      ] = line.split(/\s{3,}/)
+
+      return {
+        name: nameFragment.trim(),
+        command: commandFragment.trim(),
+        service: serviceFragment.trim(),
+        state: stateFragment.trim(),
+        ports: mapPorts(untypedPortsFragment.trim())
+      }
+    })
+  return { services }
 }

 /**
@ -34,231 +109,434 @@ export interface IDockerComposeResult {
 */
 const configToArgs = (config): string[] => {
  if (typeof config === 'undefined') {
-    return [];
+    return []
  } else if (typeof config === 'string') {
-    return [ '-f', config ];
+    return ['-f', config]
  } else if (config instanceof Array) {
-    return config.reduce((args, item): string[] => args.concat([ '-f', item ]), []);
+    return config.reduce(
+      (args, item): string[] => args.concat(['-f', item]),
+      []
+    )
  }
-  throw new Error(`Invalid argument supplied: ${config}`);
-};
+  throw new Error(`Invalid argument supplied: ${config}`)
+}

 /**
 * Converts docker-compose commandline options to cli arguments
 */
 const composeOptionsToArgs = (composeOptions): string[] => {
-  let composeArgs: string[] = [];
+  let composeArgs: string[] = []

  composeOptions.forEach((option: string[] | string): void => {
    if (option instanceof Array) {
-      composeArgs = composeArgs.concat(option);
+      composeArgs = composeArgs.concat(option)
    }
    if (typeof option === 'string') {
-      composeArgs = composeArgs.concat([ option ]);
+      composeArgs = composeArgs.concat([option])
    }
-  });
+  })

-  return composeArgs;
-};
+  return composeArgs
+}

 /**
 * Executes docker-compose command with common options
 */
-const execCompose = (command, args, options: IDockerComposeOptions = {}): Promise<IDockerComposeResult> => new Promise((resolve, reject): void => {
-  const composeOptions = options.composeOptions || [];
-  const commandOptions = options.commandOptions || [];
-  let composeArgs = composeOptionsToArgs(composeOptions);
-  const isConfigProvidedAsString = !!options.configAsString;
+export const execCompose = (
+  command,
+  args,
+  options: IDockerComposeOptions = {}
+): Promise<IDockerComposeResult> =>
+  new Promise((resolve, reject): void => {
+    const composeOptions = options.composeOptions || []
+    const commandOptions = options.commandOptions || []
+    let composeArgs = composeOptionsToArgs(composeOptions)
+    const isConfigProvidedAsString = !!options.configAsString

-  const configArgs = isConfigProvidedAsString ? [ '-f', '-' ] : configToArgs(options.config);
+    const configArgs = isConfigProvidedAsString
+      ? ['-f', '-']
+      : configToArgs(options.config)

-  composeArgs = composeArgs.concat(configArgs.concat([ command ].concat(composeOptionsToArgs(commandOptions), args)));
+    composeArgs = composeArgs.concat(
+      configArgs.concat(
+        [command].concat(composeOptionsToArgs(commandOptions), args)
+      )
+    )

-  const cwd = options.cwd;
-  const env = options.env || undefined;
+    const cwd = options.cwd
+    const env = options.env || undefined
+    const executablePath = options.executablePath || 'docker-compose'

-  const childProc = childProcess.spawn('docker-compose', composeArgs, { cwd, env });
+    const childProc = childProcess.spawn(executablePath, composeArgs, {
+      cwd,
+      env
+    })

-  childProc.on('error', (err): void => {
-    reject(err);
-  });
+    childProc.on('error', (err): void => {
+      reject(err)
+    })

-  const result: IDockerComposeResult = {
-    exitCode: null,
-    err: '',
-    out: ''
-  };
-
-  childProc.stdout.on('data', (chunk): void => {
-    result.out += chunk.toString();
-  });
-
-  childProc.stderr.on('data', (chunk): void => {
-    result.err += chunk.toString();
-  });
-
-  childProc.on('exit', (exitCode): void => {
-    result.exitCode = exitCode;
-    if (exitCode === 0) {
-      resolve(result);
-    } else {
-      reject(result);
+    const result: IDockerComposeResult = {
+      exitCode: null,
+      err: '',
+      out: ''
    }
-  });

-  if (isConfigProvidedAsString) {
-    childProc.stdin.write(options.configAsString);
-    childProc.stdin.end();
-  }
+    childProc.stdout.on('data', (chunk): void => {
+      result.out += chunk.toString()
+      options.callback?.(chunk, 'stdout')
+    })

-  if (options.log) {
-    childProc.stdout.pipe(process.stdout);
-    childProc.stderr.pipe(process.stderr);
-  }
-});
+    childProc.stderr.on('data', (chunk): void => {
+      result.err += chunk.toString()
+      options.callback?.(chunk, 'stderr')
+    })
+
+    childProc.on('exit', (exitCode): void => {
+      result.exitCode = exitCode
+      if (exitCode === 0) {
+        resolve(result)
+      } else {
+        reject(result)
+      }
+    })
+
+    if (isConfigProvidedAsString) {
+      childProc.stdin.write(options.configAsString)
+      childProc.stdin.end()
+    }
+
+    if (options.log) {
+      childProc.stdout.pipe(process.stdout)
+      childProc.stderr.pipe(process.stderr)
+    }
+  })

 /**
 * Determines whether or not to use the default non-interactive flag -d for up commands
 */
-const shouldUseDefaultNonInteractiveFlag = function(options: IDockerComposeOptions = {}): boolean {
-  const commandOptions = options.commandOptions || [];
-  const containsOtherNonInteractiveFlag = commandOptions.reduce((memo: boolean, item: string | string[]) => {
-    return memo && !item.includes('--abort-on-container-exit') && !item.includes('--no-start');
-  }, true);
-  return containsOtherNonInteractiveFlag;
-};
+const shouldUseDefaultNonInteractiveFlag = function (
+  options: IDockerComposeOptions = {}
+): boolean {
+  const commandOptions = options.commandOptions || []
+  const containsOtherNonInteractiveFlag = commandOptions.reduce(
+    (memo: boolean, item: string | string[]) => {
+      return (
+        memo &&
+        !item.includes('--abort-on-container-exit') &&
+        !item.includes('--no-start')
+      )
+    },
+    true
+  )
+  return containsOtherNonInteractiveFlag
+}

-export const upAll = function (options?: IDockerComposeOptions): Promise<IDockerComposeResult> {
-  const args = shouldUseDefaultNonInteractiveFlag(options) ? [ '-d' ] : [];
-  return execCompose('up', args, options);
-};
+export const upAll = function (
+  options?: IDockerComposeOptions
+): Promise<IDockerComposeResult> {
+  const args = shouldUseDefaultNonInteractiveFlag(options) ? ['-d'] : []
+  return execCompose('up', args, options)
+}

-export const upMany = function (services: string[], options?: IDockerComposeOptions): Promise<IDockerComposeResult> {
-  const args = shouldUseDefaultNonInteractiveFlag(options) ? [ '-d' ].concat(services) : services;
-  return execCompose('up', args, options);
-};
+export const upMany = function (
+  services: string[],
+  options?: IDockerComposeOptions
+): Promise<IDockerComposeResult> {
+  const args = shouldUseDefaultNonInteractiveFlag(options)
+    ? ['-d'].concat(services)
+    : services
+  return execCompose('up', args, options)
+}

-export const upOne = function (service: string, options?: IDockerComposeOptions): Promise<IDockerComposeResult> {
-  const args = shouldUseDefaultNonInteractiveFlag(options) ? [ '-d', service ] : [ service ];
-  return execCompose('up', args, options);
-};
+export const upOne = function (
+  service: string,
+  options?: IDockerComposeOptions
+): Promise<IDockerComposeResult> {
+  const args = shouldUseDefaultNonInteractiveFlag(options)
+    ? ['-d', service]
+    : [service]
+  return execCompose('up', args, options)
+}

-export const down = function (options?: IDockerComposeOptions): Promise<IDockerComposeResult> {
-  return execCompose('down', [], options);
-};
+export const down = function (
+  options?: IDockerComposeOptions
+): Promise<IDockerComposeResult> {
+  return execCompose('down', [], options)
+}

-export const stop = function (options?: IDockerComposeOptions): Promise<IDockerComposeResult> {
-  return execCompose('stop', [], options);
-};
+export const stop = function (
+  options?: IDockerComposeOptions
+): Promise<IDockerComposeResult> {
+  return execCompose('stop', [], options)
+}

-export const stopOne = function (service: string, options?: IDockerComposeOptions): Promise<IDockerComposeResult> {
-  return execCompose('stop', [ service ], options);
-};
+export const stopOne = function (
+  service: string,
+  options?: IDockerComposeOptions
+): Promise<IDockerComposeResult> {
+  return execCompose('stop', [service], options)
+}

-export const kill = function (options?: IDockerComposeOptions): Promise<IDockerComposeResult> {
-  return execCompose('kill', [], options);
-};
+export const pauseOne = function (
+  service: string,
+  options?: IDockerComposeOptions
+): Promise<IDockerComposeResult> {
+  return execCompose('pause', [service], options)
+}

-export const rm = function (options?: IDockerComposeOptions, ...services: string[]): Promise<IDockerComposeResult> {
-  return execCompose('rm', [ '-f', ...services ], options);
-};
+export const unpauseOne = function (
+  service: string,
+  options?: IDockerComposeOptions
+): Promise<IDockerComposeResult> {
+  return execCompose('unpause', [service], options)
+}

-export const exec = function (container: string, command: string | string[], options?: IDockerComposeOptions): Promise<IDockerComposeResult> {
-  const args = Array.isArray(command) ? command : command.split(/\s+/);
+export const kill = function (
+  options?: IDockerComposeOptions
+): Promise<IDockerComposeResult> {
+  return execCompose('kill', [], options)
+}

-  return execCompose('exec', [ '-T', container ].concat(args), options);
-};
+export const rm = function (
+  options?: IDockerComposeOptions,
+  ...services: string[]
+): Promise<IDockerComposeResult> {
+  return execCompose('rm', ['-f', ...services], options)
+}

-export const run = function (container: string, command: string | string[], options?: IDockerComposeOptions): Promise<IDockerComposeResult> {
-  const args = Array.isArray(command) ? command : command.split(/\s+/);
+export const exec = function (
+  container: string,
+  command: string | string[],
+  options?: IDockerComposeOptions
+): Promise<IDockerComposeResult> {
+  const args = Array.isArray(command) ? command : command.split(/\s+/)

-  return execCompose('run', [ '-T', container ].concat(args), options);
-};
+  return execCompose('exec', ['-T', container].concat(args), options)
+}

-export const buildAll = function (options: IDockerComposeBuildOptions = {}): Promise<IDockerComposeResult> {
+export const run = function (
+  container: string,
+  command: string | string[],
+  options?: IDockerComposeOptions
+): Promise<IDockerComposeResult> {
+  const args = Array.isArray(command) ? command : command.split(/\s+/)
+
+  return execCompose('run', ['-T', container].concat(args), options)
+}
+
+export const buildAll = function (
+  options: IDockerComposeBuildOptions = {}
+): Promise<IDockerComposeResult> {
+  return execCompose('build', options.parallel ? ['--parallel'] : [], options)
+}
+
+export const buildMany = function (
+  services: string[],
+  options: IDockerComposeBuildOptions = {}
+): Promise<IDockerComposeResult> {
  return execCompose(
    'build',
-    options.parallel ? [ '--parallel' ] : [],
+    options.parallel ? ['--parallel'].concat(services) : services,
    options
-  );
-};
+  )
+}

-export const buildMany = function (services: string[], options: IDockerComposeBuildOptions = {}): Promise<IDockerComposeResult> {
-  return execCompose(
-    'build',
-    options.parallel ? [ '--parallel' ].concat(services) : services,
-    options
-  );
-};
+export const buildOne = function (
+  service: string,
+  options?: IDockerComposeBuildOptions
+): Promise<IDockerComposeResult> {
+  return execCompose('build', [service], options)
+}

-export const buildOne = function (service: string, options?: IDockerComposeBuildOptions): Promise<IDockerComposeResult> {
-  return execCompose('build', [ service ], options);
-};
+export const pullAll = function (
+  options: IDockerComposeOptions = {}
+): Promise<IDockerComposeResult> {
+  return execCompose('pull', [], options)
+}

-export const pullAll = function (options: IDockerComposeOptions = {}): Promise<IDockerComposeResult> {
-  return execCompose('pull', [], options);
-};
+export const pullMany = function (
+  services: string[],
+  options: IDockerComposeOptions = {}
+): Promise<IDockerComposeResult> {
+  return execCompose('pull', services, options)
+}

-export const pullMany = function (services: string[], options: IDockerComposeOptions = {}): Promise<IDockerComposeResult> {
-  return execCompose('pull', services, options);
-};
+export const pullOne = function (
+  service: string,
+  options?: IDockerComposeOptions
+): Promise<IDockerComposeResult> {
+  return execCompose('pull', [service], options)
+}

-export const pullOne = function (service: string, options?: IDockerComposeOptions): Promise<IDockerComposeResult> {
-  return execCompose('pull', [ service ], options);
-};
+export const config = async function (
+  options?: IDockerComposeOptions
+): Promise<TypedDockerComposeResult<DockerComposeConfigResult>> {
+  try {
+    const result = await execCompose('config', [], options)
+    const config = yaml.parse(result.out)
+    return {
+      ...result,
+      data: { config }
+    }
+  } catch (error) {
+    return Promise.reject(error)
+  }
+}

-export const config = function (options?: IDockerComposeOptions): Promise<IDockerComposeResult> {
-  return execCompose('config', [], options);
-};
+export const configServices = async function (
+  options?: IDockerComposeOptions
+): Promise<TypedDockerComposeResult<DockerComposeConfigServicesResult>> {
+  try {
+    const result = await execCompose('config', ['--services'], options)
+    const services = result.out.split('\n').filter(nonEmptyString)
+    return {
+      ...result,
+      data: { services }
+    }
+  } catch (error) {
+    return Promise.reject(error)
+  }
+}

-export const configServices = function (options?: IDockerComposeOptions): Promise<IDockerComposeResult> {
-  return execCompose('config', [ '--services' ], options);
-};
+export const configVolumes = async function (
+  options?: IDockerComposeOptions
+): Promise<TypedDockerComposeResult<DockerComposeConfigVolumesResult>> {
+  try {
+    const result = await execCompose('config', ['--volumes'], options)
+    const volumes = result.out.split('\n').filter(nonEmptyString)
+    return {
+      ...result,
+      data: { volumes }
+    }
+  } catch (error) {
+    return Promise.reject(error)
+  }
+}

-export const configVolumes = function (options?: IDockerComposeOptions): Promise<IDockerComposeResult> {
-  return execCompose('config', [ '--volumes' ], options);
-};
+export const ps = async function (
+  options?: IDockerComposeOptions
+): Promise<TypedDockerComposeResult<DockerComposePsResult>> {
+  try {
+    const result = await execCompose('ps', [], options)
+    const data = mapPsOutput(result.out)
+    return {
+      ...result,
+      data
+    }
+  } catch (error) {
+    return Promise.reject(error)
+  }
+}

-export const ps = function (options?: IDockerComposeOptions): Promise<IDockerComposeResult> {
-  return execCompose('ps', [], options);
-};
-
-export const push = function (options: IDockerComposePushOptions = {}): Promise<IDockerComposeResult> {
+export const push = function (
+  options: IDockerComposePushOptions = {}
+): Promise<IDockerComposeResult> {
  return execCompose(
    'push',
-    options.ignorePushFailures ? [ '--ignore-push-failures' ] : [],
+    options.ignorePushFailures ? ['--ignore-push-failures'] : [],
    options
-  );
-};
+  )
+}

-export const restartAll = function (options?: IDockerComposeOptions): Promise<IDockerComposeResult> {
-  return execCompose('restart', [], options);
-};
+export const restartAll = function (
+  options?: IDockerComposeOptions
+): Promise<IDockerComposeResult> {
+  return execCompose('restart', [], options)
+}

-export const restartMany = function (services: string[], options?: IDockerComposeOptions): Promise<IDockerComposeResult> {
-  return execCompose('restart', services, options);
-};
+export const restartMany = function (
+  services: string[],
+  options?: IDockerComposeOptions
+): Promise<IDockerComposeResult> {
+  return execCompose('restart', services, options)
+}

-export const restartOne = function (service: string, options?: IDockerComposeOptions): Promise<IDockerComposeResult> {
-  return restartMany([ service ], options);
-};
+export const restartOne = function (
+  service: string,
+  options?: IDockerComposeOptions
+): Promise<IDockerComposeResult> {
+  return restartMany([service], options)
+}

-export const logs = function (services: string | string[], options: IDockerComposeLogOptions = {}): Promise<IDockerComposeResult> {
-  let args = Array.isArray(services) ? services : [ services ];
+export const logs = function (
+  services: string | string[],
+  options: IDockerComposeLogOptions = {}
+): Promise<IDockerComposeResult> {
+  let args = Array.isArray(services) ? services : [services]

  if (options.follow) {
-    args = [ '--follow', ...args ];
+    args = ['--follow', ...args]
  }

-  return execCompose('logs', args, options);
-};
+  return execCompose('logs', args, options)
+}

-export const port = function (service: string, containerPort: string | number, options?: IDockerComposeOptions): Promise<IDockerComposeResult> {
-  const args = [ service, containerPort ];
+export const port = async function (
+  service: string,
+  containerPort: string | number,
+  options?: IDockerComposeOptions
+): Promise<TypedDockerComposeResult<DockerComposePortResult>> {
+  const args = [service, containerPort]

-  return execCompose('port', args, options);
-};
+  try {
+    const result = await execCompose('port', args, options)
+    const [address, port] = result.out.split(':')
+    return {
+      ...result,
+      data: {
+        address,
+        port: Number(port)
+      }
+    }
+  } catch (error) {
+    return Promise.reject(error)
+  }
+}

-export const version = function (options?: IDockerComposeOptions): Promise<IDockerComposeResult> {
-  return execCompose('version', [ '--short' ], options);
-};
+export const version = async function (
+  options?: IDockerComposeOptions
+): Promise<TypedDockerComposeResult<DockerComposeVersionResult>> {
+  try {
+    const result = await execCompose('version', ['--short'], options)
+    const version = result.out.replace('\n', '')
+    return {
+      ...result,
+      data: { version }
+    }
+  } catch (error) {
+    return Promise.reject(error)
+  }
+}
+
+export default {
+  upAll,
+  upMany,
+  upOne,
+  down,
+  stop,
+  stopOne,
+  pauseOne,
+  unpauseOne,
+  kill,
+  rm,
+  exec,
+  run,
+  buildAll,
+  buildMany,
+  buildOne,
+  pullAll,
+  pullMany,
+  pullOne,
+  config,
+  configServices,
+  configVolumes,
+  ps,
+  push,
+  restartAll,
+  restartMany,
+  restartOne,
+  logs,
+  port,
+  version
+}
--- a/src/map-ports.ts
+++ b/src/map-ports.ts
@ -0,0 +1,38 @@
+const mapPorts = (
+  ports: string
+): Array<{
+  mapped?: { address: string; port: number }
+  exposed: { port: number; protocol: string }
+}> => {
+  if (!ports) {
+    return []
+  }
+
+  return ports.split(',').map((untypedPort) => {
+    const exposedFragments = untypedPort.trim().split('->')
+
+    const [port, protocol] =
+      exposedFragments.length === 1
+        ? exposedFragments[0].split('/')
+        : exposedFragments[1].split('/')
+
+    const mapped = exposedFragments[0]
+    const lastDoubleColon = mapped.lastIndexOf(':')
+
+    if (lastDoubleColon === -1) {
+      return {
+        exposed: { port: Number(port), protocol }
+      }
+    }
+
+    const address = mapped.substr(0, lastDoubleColon)
+    const mappedPort = mapped.substr(lastDoubleColon + 1)
+
+    return {
+      exposed: { port: Number(port), protocol },
+      mapped: { port: Number(mappedPort), address }
+    }
+  })
+}
+
+export default mapPorts
--- a/test/docker-compose-2.yml
+++ b/test/docker-compose-2.yml
@ -1,11 +1,11 @@
 version: '2'

 services:
-  db:
+  web:
    image: nginx:1.16.0
-    container_name: compose_test_nginx_2
+    container_name: compose_test_web_2
    command: 'nginx -g "daemon off;"'
    environment:
-      NGINX_PORT: 5432
+      NGINX_PORT: 8888
    ports:
-      - "5432"
+      - 8888:8888
--- a/test/docker-compose-42.yml
+++ b/test/docker-compose-42.yml
@ -2,9 +2,10 @@ version: '3'

 services:
  some-service:
-    image: alpine:3.7.3
+    image: nginx:1.19.9-alpine
+    command: 'nginx -g "daemon off;"'
    volumes:
-      - ./volume:/mountedvolume
+      # - ./volume:/mountedvolume
      - db-data:/mountedsecondvolume

 volumes:
--- a/test/docker-compose.yml
+++ b/test/docker-compose.yml
@ -1,10 +1,17 @@
 version: '2'

 services:
-  db:
+  web:
    image: nginx:1.16.0
-    container_name: compose_test_nginx
+    container_name: compose_test_web
    command: 'nginx -g "daemon off;"'
-  alpine:
-    image: alpine:3.7.3
-    container_name: compose_test_alpine
+    ports: 
+      - '0.0.0.0:80:80'
+      - '0.0.0.0:443:443'
+  proxy:
+    image: nginx:1.19.9-alpine
+    container_name: compose_test_proxy
+    command: 'nginx -g "daemon off;"'
+  hello:
+    image: hello-world
+    container_name: compose_test_hello
--- a/test/index.test.ts
+++ b/test/index.test.ts
--- a/test/map-ports.test.ts
+++ b/test/map-ports.test.ts
@ -0,0 +1,58 @@
+import mapPorts from '../src/map-ports'
+
+test('map ports for empty string', () => {
+  expect(mapPorts('')).toEqual([])
+})
+
+test('map ports for exposed tcp', () => {
+  expect(mapPorts('80/tcp')).toEqual([
+    { exposed: { port: 80, protocol: 'tcp' } }
+  ])
+})
+
+test('map ports for exposed tcp on ivp4 interface', () => {
+  expect(mapPorts('0.0.0.0:443->443/tcp')).toEqual([
+    {
+      exposed: { port: 443, protocol: 'tcp' },
+      mapped: { address: '0.0.0.0', port: 443 }
+    }
+  ])
+})
+
+test('map multiple tcp ports exposed on ivp4 interfaces', () => {
+  expect(mapPorts('0.0.0.0:443->443/tcp, 0.0.0.0:80->80/tcp')).toEqual([
+    {
+      exposed: { port: 443, protocol: 'tcp' },
+      mapped: { address: '0.0.0.0', port: 443 }
+    },
+    {
+      exposed: { port: 80, protocol: 'tcp' },
+      mapped: { address: '0.0.0.0', port: 80 }
+    }
+  ])
+})
+
+test('map multiple tcp ports exposed on ipv4 and ipv6 interfaces', () => {
+  expect(
+    mapPorts(
+      '0.0.0.0:443->443/tcp,:::443->443/tcp, 0.0.0.0:80->80/tcp,:::80->80/tcp'
+    )
+  ).toEqual([
+    {
+      exposed: { port: 443, protocol: 'tcp' },
+      mapped: { address: '0.0.0.0', port: 443 }
+    },
+    {
+      exposed: { port: 443, protocol: 'tcp' },
+      mapped: { address: '::', port: 443 }
+    },
+    {
+      exposed: { port: 80, protocol: 'tcp' },
+      mapped: { address: '0.0.0.0', port: 80 }
+    },
+    {
+      exposed: { port: 80, protocol: 'tcp' },
+      mapped: { address: '::', port: 80 }
+    }
+  ])
+})
--- a/yarn.lock
+++ b/yarn.lock
Author	SHA1	Message	Date
Daniel Bulant	acb173b0dd	Update name	2021-12-12 10:33:03 +01:00
Daniel Bulant	18a9079ee6	Add service	2021-11-30 21:05:59 +01:00
Daniel Bulant	748ba3e368	Fix skipping first container in ps command	2021-11-30 21:00:04 +01:00
Alexander Zeitler	192979ffcc	chore(release): 0.23.14	2021-11-29 08:18:31 +01:00
upsilon01	f60e4d5a18	feat: passing callback to report progress (#191 ) * feat: passing callback to report progress * fix: add typing * fix: change test purpose * fix: lint errors * fix: update docs Co-authored-by: yshechter <yshechter@ravtech.co.il>	2021-11-29 07:57:04 +01:00
dependabot[bot]	dd4fe76eab	build(deps): bump tmpl from 1.0.4 to 1.0.5 Bumps [tmpl](https://github.com/daaku/nodejs-tmpl) from 1.0.4 to 1.0.5. - [Release notes](https://github.com/daaku/nodejs-tmpl/releases) - [Commits](https://github.com/daaku/nodejs-tmpl/commits/v1.0.5) --- updated-dependencies: - dependency-name: tmpl dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com>	2021-09-21 08:57:17 +02:00
dependabot[bot]	6b9ab6150c	build(deps): bump prismjs from 1.24.0 to 1.25.0 Bumps [prismjs](https://github.com/PrismJS/prism) from 1.24.0 to 1.25.0. - [Release notes](https://github.com/PrismJS/prism/releases) - [Changelog](https://github.com/PrismJS/prism/blob/master/CHANGELOG.md) - [Commits](https://github.com/PrismJS/prism/compare/v1.24.0...v1.25.0) --- updated-dependencies: - dependency-name: prismjs dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com>	2021-09-21 08:26:36 +02:00
Alexander Zeitler	a28e801590	Add gautaz as a contributor	2021-08-16 09:59:57 +02:00
gautaz	b0ab29bbb3	update commands documentation also: * fix port options * order the list alphabetically	2021-08-16 09:57:07 +02:00
Alexander Zeitler	d71e043be8	security: update dependencies to fix security issues	2021-08-13 12:07:22 +02:00
dependabot[bot]	764f33fe1b	build(deps): bump path-parse from 1.0.6 to 1.0.7 Bumps [path-parse](https://github.com/jbgutierrez/path-parse) from 1.0.6 to 1.0.7. - [Release notes](https://github.com/jbgutierrez/path-parse/releases) - [Commits](https://github.com/jbgutierrez/path-parse/commits/v1.0.7) --- updated-dependencies: - dependency-name: path-parse dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com>	2021-08-12 10:20:59 +02:00
Alexander Zeitler	9f84b89a45	build(release): shrink npm package size	2021-07-20 13:02:50 +02:00
Alexander Zeitler	d7fe723db3	chore(release): 0.23.13	2021-07-20 12:36:30 +02:00
Westlad	74b4d6ea22	fix: now lints correctly	2021-07-20 12:27:46 +02:00
Westlad	5921b51977	feat: single container pause and unpause added	2021-07-20 12:27:46 +02:00
dependabot[bot]	91abbfe63a	build(deps): bump hosted-git-info from 2.8.8 to 2.8.9 Bumps [hosted-git-info](https://github.com/npm/hosted-git-info) from 2.8.8 to 2.8.9. - [Release notes](https://github.com/npm/hosted-git-info/releases) - [Changelog](https://github.com/npm/hosted-git-info/blob/v2.8.9/CHANGELOG.md) - [Commits](https://github.com/npm/hosted-git-info/compare/v2.8.8...v2.8.9) --- updated-dependencies: - dependency-name: hosted-git-info dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com>	2021-06-29 18:14:48 +02:00
dependabot[bot]	639f9ceffd	build(deps): bump prismjs from 1.23.0 to 1.24.0 Bumps [prismjs](https://github.com/PrismJS/prism) from 1.23.0 to 1.24.0. - [Release notes](https://github.com/PrismJS/prism/releases) - [Changelog](https://github.com/PrismJS/prism/blob/master/CHANGELOG.md) - [Commits](https://github.com/PrismJS/prism/compare/v1.23.0...v1.24.0) --- updated-dependencies: - dependency-name: prismjs dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com>	2021-06-29 18:09:36 +02:00
Alexander Zeitler	a3fb7c09bd	docs: fix wording in vuepress docs	2021-06-15 12:36:31 +02:00
Alexander Zeitler	26a3f0e9d8	docs: fix wording	2021-06-15 11:56:08 +02:00
Alexander Zeitler	866ac8d595	docs: change shield from CircleCI to GitHub workflow	2021-06-15 11:26:11 +02:00
Alexander Zeitler	f7166c50c4	docs: remove Slack from vuepress based docs	2021-06-15 10:58:15 +02:00
Alexander Zeitler	2fea41e6c1	docs: remove slack	2021-06-15 10:50:26 +02:00
Alexander Zeitler	1a7fec4601	chore(release): 0.23.12	2021-06-06 16:47:02 +02:00
Alexander Zeitler	c4b60872ae	feat(dx): add default export	2021-06-06 16:36:20 +02:00
Alexander Zeitler	7eaf706be9	chore(release): 0.23.11	2021-06-04 17:20:41 +02:00
Paweł Niedzielski	3b8aaec914	expose execCompose function Fixes #162	2021-06-04 17:17:03 +02:00
dependabot[bot]	d9ed460405	build(deps): bump ws from 7.4.4 to 7.4.6 Bumps [ws](https://github.com/websockets/ws) from 7.4.4 to 7.4.6. - [Release notes](https://github.com/websockets/ws/releases) - [Commits](https://github.com/websockets/ws/compare/7.4.4...7.4.6) Signed-off-by: dependabot[bot] <support@github.com>	2021-05-30 21:58:01 +02:00
dependabot[bot]	0ebbc6f357	build(deps): bump dns-packet from 1.3.1 to 1.3.4 Bumps [dns-packet](https://github.com/mafintosh/dns-packet) from 1.3.1 to 1.3.4. - [Release notes](https://github.com/mafintosh/dns-packet/releases) - [Changelog](https://github.com/mafintosh/dns-packet/blob/master/CHANGELOG.md) - [Commits](https://github.com/mafintosh/dns-packet/compare/v1.3.1...v1.3.4) Signed-off-by: dependabot[bot] <support@github.com>	2021-05-27 21:16:05 +02:00
dependabot[bot]	f5fb0b3907	build(deps): bump browserslist from 4.16.3 to 4.16.6 Bumps [browserslist](https://github.com/browserslist/browserslist) from 4.16.3 to 4.16.6. - [Release notes](https://github.com/browserslist/browserslist/releases) - [Changelog](https://github.com/browserslist/browserslist/blob/main/CHANGELOG.md) - [Commits](https://github.com/browserslist/browserslist/compare/4.16.3...4.16.6) Signed-off-by: dependabot[bot] <support@github.com>	2021-05-27 19:54:37 +02:00
dependabot[bot]	5e969f588e	build(deps): bump postcss from 8.2.9 to 8.2.15 Bumps [postcss](https://github.com/postcss/postcss) from 8.2.9 to 8.2.15. - [Release notes](https://github.com/postcss/postcss/releases) - [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md) - [Commits](https://github.com/postcss/postcss/compare/8.2.9...8.2.15) Signed-off-by: dependabot[bot] <support@github.com>	2021-05-12 00:31:17 +02:00
Alexander Zeitler	e9bb9824a6	chore(release): 0.23.10	2021-05-11 22:06:03 +02:00
Paweł Niedzielski	53fb97196f	fix: fix mapping ipv6-based port mappings	2021-05-11 21:49:00 +02:00
Paweł Niedzielski	6dec0c6bb6	fix: fix mapping ipv6-based port mappings	2021-05-11 21:49:00 +02:00
Paweł Niedzielski	dbdb9008f2	fix: fix mapping ipv6-based port mappings	2021-05-11 21:49:00 +02:00
Paweł Niedzielski	8aa846553c	fix: fix mapping ipv6-based port mappings	2021-05-11 21:49:00 +02:00
Paweł Niedzielski	21b63cbc53	fix: fix mapping ipv6-based port mappings	2021-05-11 21:49:00 +02:00
Paweł Niedzielski	48c9f0841a	fix: fix mapping ipv6-based port mappings	2021-05-11 21:49:00 +02:00
Paweł Niedzielski	e7013dfab1	fix: fix mapping ipv6-based port mappings	2021-05-11 21:49:00 +02:00
Alexander Zeitler	963b51573f	chore(release): 0.23.9	2021-05-09 01:40:23 +02:00
Michael James	361131a76b	refactor: changed execPath to executablePath	2021-05-09 01:38:03 +02:00
Michael James	432413f087	docs: changed execPath to executablePath	2021-05-09 01:38:03 +02:00
Michael James	44f0e9eeb3	docs: Add details of execPath option	2021-05-09 01:38:03 +02:00
Michael James	58f09f4c74	feat: Add execPath option to set path to docker-compose executable	2021-05-09 01:38:03 +02:00
Alexander Zeitler	876a032001	ci: run on PRs	2021-05-09 01:14:40 +02:00
dependabot[bot]	17aaf53a12	build(deps): bump handlebars from 4.7.6 to 4.7.7 Bumps [handlebars](https://github.com/wycats/handlebars.js) from 4.7.6 to 4.7.7. - [Release notes](https://github.com/wycats/handlebars.js/releases) - [Changelog](https://github.com/handlebars-lang/handlebars.js/blob/master/release-notes.md) - [Commits](https://github.com/wycats/handlebars.js/compare/v4.7.6...v4.7.7) Signed-off-by: dependabot[bot] <support@github.com>	2021-05-09 00:31:47 +02:00
Alexander Zeitler	a3d0a52e36	chore(release): 0.23.8	2021-04-15 09:15:33 +02:00
Alexander Zeitler	e58387d82e	fix: ignore vuepress cache + temp files on release (#148 )	2021-04-15 09:14:56 +02:00
Alexander Zeitler	524fe42a07	chore(release): 0.23.7	2021-04-14 16:34:15 +02:00
Alexander Zeitler	2de793b145	ci: rename task to build + test	2021-04-14 16:33:34 +02:00
Alexander Zeitler	9c43efa2b2	ci: include typescript build	2021-04-14 16:33:34 +02:00
Alexander Zeitler	c7c6f01658	build: fix broken build	2021-04-14 16:33:34 +02:00
Alexander Zeitler	2b089ff660	refactor: rename test to match tested function	2021-04-14 16:17:03 +02:00
Alexander Zeitler	b487be048b	refactor: replace variable by chaining	2021-04-14 16:17:03 +02:00
Alexander Zeitler	57f00b36fe	refactor: improve naming	2021-04-14 16:17:03 +02:00
Alexander Zeitler	9443c7ebdc	refactor: replace variables by chaining	2021-04-14 16:17:03 +02:00
Alexander Zeitler	3be99e8360	refactor: replace if by ternary, improve variable naming	2021-04-14 16:17:03 +02:00
Alexander Zeitler	880d2522b5	feat: make result for `ps` command type safe	2021-04-14 16:17:03 +02:00
Alexander Zeitler	ed91eba770	fix: filter empty entries from `config --services` command	2021-04-14 16:17:03 +02:00
Alexander Zeitler	51b20b43d6	feat: make result for `config --volumes` command type safe	2021-04-14 16:17:03 +02:00
Alexander Zeitler	6f105ca160	feat: make result for `config --services` command type safe	2021-04-14 16:17:03 +02:00
Alexander Zeitler	a2f5a4ec0e	feat: make result for `config` command type safe	2021-04-14 16:17:03 +02:00
Alexander Zeitler	a7da0380a8	feat: make result for `version` command type safe	2021-04-14 16:17:03 +02:00
Alexander Zeitler	90421b7eb2	refactor: rename `result` to `data`	2021-04-14 16:17:03 +02:00
Alexander Zeitler	aa26e83884	refactor: use spread operator to build typed result	2021-04-14 16:17:03 +02:00
Alexander Zeitler	70a98f473b	feat: make result for `port` command type safe	2021-04-14 16:17:03 +02:00
Alexander Zeitler	b6eec0047d	docs: shrink README, link to docs	2021-04-11 00:30:42 +02:00
Alexander Zeitler	ecf4ba5e2b	docs: enable navbar, clean up text	2021-04-11 00:30:42 +02:00
Alexander Zeitler	bfd45f47fa	chore: git ignore vuepress cache and temp folders	2021-04-11 00:30:42 +02:00
Alexander Zeitler	1bc50ed7a0	build(docs:ci): set GITHUB_TOKEN	2021-04-11 00:30:42 +02:00
Alexander Zeitler	f83686e30e	docs: setup vuepress docs	2021-04-11 00:30:42 +02:00
Alexander Zeitler	8d3c162015	ci(style): lint	2021-04-10 23:33:09 +02:00
Alexander Zeitler	bf8210ae9b	style: fix lint errors	2021-04-10 23:25:54 +02:00
Alexander Zeitler	46cb725156	style: run prettier	2021-04-10 23:25:54 +02:00
Alexander Zeitler	bdbfc17de1	style: use prettier + typescript-eslint	2021-04-10 23:25:54 +02:00
Alexander Zeitler	f85e6885dd	style: append new line via `.editorconfig`	2021-04-10 22:06:43 +02:00
Alexander Zeitler	ad6e008e1a	build(ci): use github actions	2021-04-10 22:06:43 +02:00
Alexander Zeitler	a59476f65d	build(ci): remove circleci	2021-04-10 22:06:43 +02:00
Alexander Zeitler	d0bd17c8ec	docs: replace `npm` by `yarn`	2021-04-10 21:57:19 +02:00
Alexander Zeitler	3495f93468	build: remove `package-lock.json`	2021-04-10 21:57:19 +02:00
dependabot[bot]	397000087c	Bump lodash from 4.17.14 to 4.17.21 Bumps [lodash](https://github.com/lodash/lodash) from 4.17.14 to 4.17.21. - [Release notes](https://github.com/lodash/lodash/releases) - [Commits](https://github.com/lodash/lodash/compare/4.17.14...4.17.21) Signed-off-by: dependabot[bot] <support@github.com>	2021-04-10 21:47:09 +02:00
dependabot[bot]	00f90c9620	Bump dot-prop from 3.0.0 to 5.3.0 Bumps [dot-prop](https://github.com/sindresorhus/dot-prop) from 3.0.0 to 5.3.0. - [Release notes](https://github.com/sindresorhus/dot-prop/releases) - [Commits](https://github.com/sindresorhus/dot-prop/compare/v3.0.0...v5.3.0) Signed-off-by: dependabot[bot] <support@github.com>	2021-04-10 21:42:22 +02:00
Alexander Zeitler	c9abc11ffc	chore(style): remove dead / commented code	2021-04-10 21:38:12 +02:00
Alexander Zeitler	afb2b1116b	fix(test): fix broken tests Some tests failed because the used `alpine` service did start non-blocking which caused the container to stop immediately. Assertions expecting the container to run then failed. The new structure is to use two blocking `nginx` images which serve a scenario of web and proxy. For the `--abort-on-container-exit` flag tests a third - non-blocking by intend - service based on the `hello-world` image has been added.	2021-04-10 21:38:12 +02:00
Alexander Zeitler	d2df827d0f	docs: update docs to reflect latest readme	2021-04-10 17:41:13 +02:00
Alexander Zeitler	af6d77b308	test: fix broken tests	2021-04-10 17:00:37 +02:00
Alexander Zeitler	29cbab6298	build(deps): update dev dependencies	2021-04-10 17:00:37 +02:00
Noah Allen	ceb7ed6510	Add port to supported commands	2021-04-10 02:00:32 +02:00
dependabot[bot]	483e6827ad	Bump y18n from 4.0.0 to 4.0.1 Bumps [y18n](https://github.com/yargs/y18n) from 4.0.0 to 4.0.1. - [Release notes](https://github.com/yargs/y18n/releases) - [Changelog](https://github.com/yargs/y18n/blob/master/CHANGELOG.md) - [Commits](https://github.com/yargs/y18n/commits) Signed-off-by: dependabot[bot] <support@github.com>	2021-03-31 15:22:22 +02:00
Alexander Zeitler	98c271de01	Update readme.md	2021-01-15 00:43:14 +01:00
Alexander Zeitler	60e278d566	Update LICENSE	2021-01-15 00:43:14 +01:00