@uscreen.de/dev-service 0.13.0 → 0.14.0

package/README.md

@@ -129,7 +129,7 @@ Install all services specified in package.json.
 
 ##### `--enable-volumes-id`
 
-> ***experimental feature***
+> **_experimental feature_**
 
 Creates a unique ID and uses it when naming the services' volumes, thus avoiding conflicts between volumes of different dev-service instances. Every subsequent call of `service install` will (re-)create volume names with the same ID.
 
@@ -137,7 +137,7 @@ Creates a unique ID and uses it when naming the services' volumes, thus avoiding
 
 ##### `--enable-mapped-volumes`
 
-> ***experimental feature***
+> **_experimental feature_**
 
 Maps services' volumes into local directories (`./services/.volumes/<volume-name>`) instead of storing them inside of the Docker Desktop virtual machine. Every subsequent call of `service install` will use this mappings.
 
@@ -181,12 +181,27 @@ Pulls current images for all or given installed service(s).
 
 This action updates already existing images - within the boundaries of the respective service's tag. For updating an image beyond these boundaries, adjust the respective service's tag in your service definition and rerun `service install`.
 
+### $ service status
+
+Show paths and versions of used docker and docker-compose (docker compose preferred over docker-compose if both are available). Example output:
+
+```bash
+Detected tools:
+
+  docker          /Users/<...>/.local/bin/docker
+                  Docker version 28.5.2, build ecc6942
+
+  docker compose  plugin  2.40.3 [active]
+  docker-compose  /Users/<...>/.local/bin/docker-compose
+                  Docker Compose version v2.40.3
+```
+
 ## Provided services
 
 All provided services use their respective default ports:
 
 | service       | used ports  |
-|---------------|-------------|
+| ------------- | ----------- |
 | redis         | 6379        |
 | mongo         | 27017       |
 | nats          | 4222, 8222  |
@@ -252,11 +267,11 @@ Say you want to add a specific version of elasticsearch with some customizing en
 Running `service install` will automatically create a partial docker-compose file from this directives in your `services/.compose` folder:
 
 ```yaml
-version: "2.4"
+version: '2.4'
 services:
   elasticsearch:
     image: docker.elastic.co/elasticsearch/elasticsearch:6.4.2
-    container_name: "your-dev-repo_elasticsearch"
+    container_name: your-dev-repo_elasticsearch
     ports:
       - 9200:9200
     volumes:
@@ -268,7 +283,7 @@ services:
       - thread_pool.bulk.queue_size=200
 volumes:
   elasticsearch-data:
-    name: "foobar-dev-repo-elasticsearch-data"
+    name: foobar-dev-repo-elasticsearch-data
 ```
 
 This action has the following features & caveats:
@@ -327,136 +342,201 @@ And the folder structure would look like this:
 
 > Format according to https://keepachangelog.com
 
+### v0.14.0
+
+#### Added
+- new `service status` command to show paths and versions of used docker and docker-compose (docker compose preferred over docker-compose if both are available)
+
 ### v0.13.0
+
 #### Changed
+
 - adjust node requirements
 - upgrade multiple packages
 - replace tap with native node tests
 - migrate to pnpm
 
 ### v0.12.11
+
 #### Fixed
+
 - fix "'version' is obsolete" bug
 
 ### v0.12.6
+
 #### Fixed
+
 - work with current docker compose
 
 ### v0.12.0
+
 #### Added
+
 - mariadb template
 
 ### v0.11.17
+
 #### Fixed
+
 - custom services with container ports lower than 60 now work as expected
 
 ### v0.11.0
+
 #### Added
+
 - new `service pull` command
 
 ### v0.10.0
-##### Added
+
+#### Added
+
 - `service install` options to customize volume naming/creation
 
 ### v0.9.4
-##### Fixed
+
+#### Fixed
+
 - `service check` no more checks for ports given as `CONTAINER` part of a port mapping (`HOST:CONTAINER`)
 
 ### v0.9.3
+
 #### Added
+
 - validation of custom service definitions
 
 #### Fixed
+
 - vulnerabilites due to used packages
 
 ### v0.9.2
+
 #### Fixed
+
 - bug with mismatching PIDs
 
 ### v0.9.1
+
 #### Fixed
+
 - adjust node requirements
 
 ### v0.9.0
+
 #### Added
+
 - display warning if other dev-service instances are running
 
 #### Changed
+
 - migrate to ESM (due to package requirements)
 
 #### Fixed
+
 - don’t observe own ports in port check.
 
 #### Removed
+
 - support for node 10 (due to migration to ESM)
 
 ### v0.8.1
+
 #### Fixed
+
 - avoiding errors when projectname contains certain special characters
 
 ### v0.8.0
+
 #### Added
+
 - tests for `service check`
 
 #### Changed
+
 - `service start` checks for used ports before starting any service(s)
 - updating list of provided services in readme
 
 ### v0.7.1
+
 #### Fixed
+
 - fixing further false positives `service check`
 - package upgrades
 
 ### v0.7.0
+
 #### Changed
+
 - refactoring `service check` to avoid false positives
 
 ### v0.6.2
+
 #### Fixed
+
 - avoiding side effects between different dev repos
 
 ### v0.6.1
+
 #### Fixed
+
 - making tests work again after change in docker client api
 
 ### v0.6.0
+
 #### Added
+
 - new service: `elasticsearch`
 - new service: `rabbitmq`
 
 ### v0.5.0
+
 #### Added
+
 - new `service check` to find processes blocking required ports
 
 ### v0.4.0
+
 #### Added
+
 - optional service customization
 
 ### v0.3.0
+
 #### Added
+
 - new `service restart` command
 
 #### Changed
+
 - expanding `service start`, `service stop` and `service logs` by optional `[service]` parameter
 
 ### v0.2.2
+
 #### Fixed
+
 - package upgrades
 
 ### v0.2.1
+
 #### Fixed
+
 - typo in readme
 
 ### v0.2.0
+
 #### Added
+
 - new `service logs` command
 
 ### v0.1.1
+
 #### changed
+
 - configure git ignore services/.compose folder
 
 ### v0.1.0
+
 #### Added
+
 - initial version with basic commands
 
 ---

package/bin/cli-check.js

@@ -1,9 +1,10 @@
 #!/usr/bin/env node
 
+import process from 'node:process'
 import { program } from 'commander'
 
+import { checkOtherServices, checkUsedPorts } from '../src/check.js'
 import { version } from '../src/constants.js'
-import { checkUsedPorts, checkOtherServices } from '../src/check.js'
 import { error } from '../src/utils.js'
 
 program
@@ -15,10 +16,12 @@ program
 
       if (service) {
         await checkUsedPorts(service)
-      } else {
+      }
+      else {
         await checkUsedPorts()
       }
-    } catch (e) {
+    }
+    catch (e) {
       error(e)
     }
   })

package/bin/cli-install.js

@@ -1,23 +1,25 @@
 #!/usr/bin/env node
 
+import process from 'node:process'
 import { program } from 'commander'
 
 import { version } from '../src/constants.js'
-import { error } from '../src/utils.js'
 import { install } from '../src/install.js'
+import { error } from '../src/utils.js'
 
 program
   .version(version)
   .option(
     '--enable-classic-volumes',
-    "Deriving volume names from current project's name"
+    'Deriving volume names from current project\'s name'
   )
   .option('--enable-volumes-id', 'Deriving volume names from a unique ID')
   .option('--enable-mapped-volumes', 'Mapping volumes into local file system')
   .action(async (options) => {
     try {
       await install(options)
-    } catch (e) {
+    }
+    catch (e) {
       error(e)
     }
   })

package/bin/cli-list.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 
+import process from 'node:process'
 import { program } from 'commander'
 
 import { version } from '../src/constants.js'
@@ -9,7 +10,8 @@ import { compose, error } from '../src/utils.js'
 program.version(version).action(async () => {
   try {
     await compose('ps')
-  } catch (e) {
+  }
+  catch (e) {
     error(e)
   }
 })

package/bin/cli-logs.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 
+import process from 'node:process'
 import { program } from 'commander'
 
 import { version } from '../src/constants.js'
@@ -13,10 +14,12 @@ program
     try {
       if (service) {
         await compose('logs', '-f', service)
-      } else {
+      }
+      else {
         await compose('logs', '-f')
       }
-    } catch (e) {
+    }
+    catch (e) {
       error(e)
     }
   })

package/bin/cli-pull.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 
+import process from 'node:process'
 import { program } from 'commander'
 
 import { version } from '../src/constants.js'
@@ -12,10 +13,12 @@ program
     try {
       if (service) {
         await compose('pull', service)
-      } else {
+      }
+      else {
         await compose('pull')
       }
-    } catch (e) {
+    }
+    catch (e) {
       error(e)
     }
   })

package/bin/cli-restart.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 
+import process from 'node:process'
 import { program } from 'commander'
 
 import { version } from '../src/constants.js'
@@ -13,10 +14,12 @@ program
     try {
       if (service) {
         await compose('restart', service)
-      } else {
+      }
+      else {
         await compose('restart')
       }
-    } catch (e) {
+    }
+    catch (e) {
       error(e)
     }
   })

package/bin/cli-start.js

@@ -1,9 +1,10 @@
 #!/usr/bin/env node
 
+import process from 'node:process'
 import { program } from 'commander'
 
+import { checkOtherServices, checkUsedPorts } from '../src/check.js'
 import { version } from '../src/constants.js'
-import { checkUsedPorts, checkOtherServices } from '../src/check.js'
 import { compose, error } from '../src/utils.js'
 
 program
@@ -16,11 +17,13 @@ program
       if (service) {
         await checkUsedPorts(service)
         await compose('up', '-d', service)
-      } else {
+      }
+      else {
         await checkUsedPorts()
         await compose('up', '-d')
       }
-    } catch (e) {
+    }
+    catch (e) {
       error(e)
     }
   })

package/bin/cli-status.js

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+
+import process from 'node:process'
+import { program } from 'commander'
+
+import { version } from '../src/constants.js'
+import { status } from '../src/status.js'
+import { error } from '../src/utils.js'
+
+program.version(version).action(async () => {
+  try {
+    await status()
+  }
+  catch (e) {
+    error(e)
+  }
+})
+
+program.parse(process.argv)

package/bin/cli-stop.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 
+import process from 'node:process'
 import { program } from 'commander'
 
 import { version } from '../src/constants.js'
@@ -14,13 +15,15 @@ program
       // stop service(s):
       if (service) {
         await compose('stop', service)
-      } else {
+      }
+      else {
         await compose('stop')
       }
 
       // clean up:
       await compose('rm', '-fv')
-    } catch (e) {
+    }
+    catch (e) {
       error(e)
     }
   })

package/bin/cli.js

@@ -1,7 +1,8 @@
 #!/usr/bin/env node
 
+import { createRequire } from 'node:module'
+import process from 'node:process'
 import { Command } from 'commander'
-import { createRequire } from 'module'
 
 const require = createRequire(import.meta.url)
 const program = new Command()
@@ -27,6 +28,7 @@ program
     'pull [service]',
     'pulls current images for all or given installed services'
   )
+  .command('status', 'show detected docker tools and their versions')
 
 /**
  * read args

package/package.json

@@ -1,9 +1,16 @@
 {
   "name": "@uscreen.de/dev-service",
-  "version": "0.13.0",
+  "type": "module",
+  "version": "0.14.0",
   "description": "cli to manage services in dev repos",
+  "author": "Martin Herting <herting@uscreen.de>",
+  "license": "MIT",
+  "homepage": "https://github.com/uscreen/dev-service",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/uscreen/dev-service.git"
+  },
   "main": "index.js",
-  "type": "module",
   "bin": {
     "service": "./bin/cli.js",
     "service-install": "./bin/cli-install.js",
@@ -13,40 +20,38 @@
     "service-stop": "./bin/cli-stop.js",
     "service-restart": "./bin/cli-restart.js",
     "service-check": "./bin/cli-check.js",
-    "service-pull": "./bin/cli-pull.js"
-  },
-  "homepage": "https://github.com/uscreen/dev-service",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/uscreen/dev-service.git"
-  },
-  "author": "Martin Herting <herting@uscreen.de>",
-  "license": "MIT",
-  "engines": {
-    "node": ">=20"
+    "service-pull": "./bin/cli-pull.js",
+    "service-status": "./bin/cli-status.js"
   },
   "files": [
     "bin/",
     "src/",
     "templates"
   ],
-  "devDependencies": {
-    "@uscreen.de/eslint-config-prettystandard-node": "^0.2.12",
-    "c8": "^10.1.3"
+  "engines": {
+    "node": ">=20"
   },
   "dependencies": {
     "chalk": "^5.6.2",
-    "commander": "^14.0.2",
-    "fs-extra": "^11.3.2",
-    "nanoid": "^5.1.6",
+    "commander": "^14.0.3",
+    "fs-extra": "^11.3.4",
+    "nanoid": "^5.1.7",
     "parse-json": "^8.3.0",
-    "read-pkg": "^9.0.1",
-    "yaml": "^2.8.1"
+    "read-pkg": "^10.1.0",
+    "yaml": "^2.8.3"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "^7.7.3",
+    "c8": "^11.0.0",
+    "eslint": "^9.39.4",
+    "eslint-plugin-format": "^2.0.1"
   },
   "scripts": {
     "preinstall": "npx only-allow pnpm",
     "test": "node --test --test-concurrency=1 --test-reporter spec",
     "test:cov": "c8 --reporter=html --reporter=text node --test --test-concurrency=1",
-    "test:ci": "c8 --reporter=lcov --reporter=text node --test --test-concurrency=1"
+    "test:ci": "c8 --reporter=lcov --reporter=text node --test --test-concurrency=1",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
   }
 }