feat: output latest wanted version according to semver caret range

The output of the application will now also show the latest available
version, according to the image's current version semver-caret-range.
This is especially helpful, if an installed image cannot be updated to
the next major version but still wants to be notified about
patch/minor updates.

BREAKING CHANGE: Output schema of the application changed -> Column
"Upgrade Type" was removed

Author: hellivan

README.md

@@ -1,12 +1,13 @@
 # dc-outdated
 
-_dc-outdated_ (docker-compose-outdated) is a command line utiltiy that allows to easily check for outdated docker images in your docker-compose.yml file (just like _outdated_ command in _npm_ or _yarn_).
+Command line utiliy for checking outdated docker-compose images.
 
-Therefore it fetches for each image definition in your docker-compose.yml file, the latest available tag (according to the _semver_ versioning schema -> tags that do not match the semver versioning schema will be ignored) from the according docker registry. If the version (tag) of the image definition in the _docker-compose.yml_ file.
+_dc-outdated_ (docker-compose-outdated) is a command line utiltiy that allows to easily check for outdated docker images in your docker-compose.yml file (just like _outdated_ command in _npm_ or _yarn_). Therefore it iterates over each image definition in your docker-compose.yml file, and fetches the latest available tag-name form the appropriate docker registry (according to the _semver_ versioning schema). Tags that do not match the semver versioning schema will be ignored.
 
 ## Prerequisites
 
-If you are using images from a private registry it is neccessary to login to that registry (_docker login_ command) before executing this application. This is required, since _dc-outdated_ reads login-credentials from the user's docker config file by default. By default, this application searches for a _docker-compose.yml_ file in the current working directory (same behavior as docker-compose utility). Hence, the directory in which the application is executed, must contain a valid **docker-compose.yml** file.
+If you are using images from a private registry it is neccessary to login to that registry (_docker login_ command) before executing this application. This is required, since _dc-outdated_ reads login-credentials from the user's docker config file by default.
+By default, this application searches for a _docker-compose.yml_ file in the current working directory (same behavior as docker-compose utility). Hence, the directory in which the application is executed, must contain a valid **docker-compose.yml** file.
 In order to make this tool work correctly it is neccessary that all images in the _docker-compose.yml_ file are specified with a semver compliant tag. Otherwise execution will fail.
 
 
@@ -20,14 +21,14 @@ cd /path/to/your/project
 dc-outdated
 ```
 
-If the compose file contains outdated docker images, the programm will list the outdated image names as well as the current and latest version of the image:
+If the compose file contains outdated docker images, the programm will list the outdated image names. Besides the image name, the application will also output the **current** image version (as specified in the _docker-compose.yml_ file), the next **wanted** version (max possible version according to the image's current version caret range) and the **latest** version of the image.
 
 ```
-Image                 Upgrade Type  Current Version  Latest Version
---------------------  ------------  ---------------  --------------
-library/rabbitmq       minor         3.6.16           3.7.7         
-library/mongo          minor         3.4.16           3.6.6         
-library/influxdb       major         0.13.0           1.5.4 
+Image                 Current    Wanted[^]    Latest
+--------------------  ---------  -----------  ------------
+library/rabbitmq      3.6.16     3.7.11       3.8.0-beta.2
+library/mongo         3.4.16     3.7.9        4.1.7
+library/influxdb      0.13.0     1.7.3        1.7.3
 ```
 
 For advanced usage, command line flags can be used to change the default behavoir of the application:
@@ -45,4 +46,4 @@ However, for a fully detailed description of all flags that can be used, see the
 ## TODOs
 
 * For now only docker compose files of version 2.x were tested. For the future docker-compose version 3 should be supported too
-* At this moment checking for outdated images on against the official docker registry is not fully working. Hence, only images from a self-hosted docker registry (v2) can be checked reliable. This will be changed in the future so that all kind of docker registries are supported. For now you will have to login to _registry-1.docker.io_ in order to verfy images from offical docker registry.
+* At this moment checking for outdated images against the official docker registry is not fully working. Hence, only images from a self-hosted docker registry (v2) can be checked reliable. This will be changed in the future so that all kind of docker registries are supported. For now you will have to login to _registry-1.docker.io_ in order to verfy images from offical docker registry.

src/lib/docker-utils.ts

@@ -173,14 +173,26 @@ export async function listRepositories(registryHost: string, credentialsStore: C
 }
 
 export async function getLatestImageVersion(credentialsStore: CredentialsStore, dockerImage: DockerImage): Promise<string> {
-    const tags = await listTags(credentialsStore, dockerImage);
+    const {latest} = await getImageUpdateTags(credentialsStore, dockerImage);
+    return latest;
+}
+
+export async function getImageUpdateTags(credentialsStore: CredentialsStore, dockerImage: DockerImage): Promise<{wanted: string, latest: string}> {
+    let wanted;
     let latest;
-    if (tags) {
+    const tags = await listTags(credentialsStore, dockerImage);
+    if(tags) {
         const validTags = tags.filter(semver.valid);
         validTags.sort(semver.compare);
         latest = _.last(validTags);
+
+        if(dockerImage.tag && semver.valid(dockerImage.tag)) {
+            wanted = semver.maxSatisfying(validTags, `^${dockerImage.tag}`);
+        }
     }
-    return latest;
+
+
+    return {wanted, latest}
 }
 
 export async function readDockerConfig(dockerConfigPath: string): Promise<any> {

src/lib/index.ts

@@ -1,8 +1,17 @@
 import * as cliProgress from 'cli-progress';
 import * as EasyTable from 'easy-table';
 import * as semver from 'semver';
-import { getComposeImages } from './compose-utils';
-import { Credentials, CredentialsStore, DEFAULT_REGISTRY_HOST, DockerImage, getLatestImageVersion, listRepositories, readDockerConfig } from './docker-utils';
+import {getComposeImages} from './compose-utils';
+import {
+    Credentials,
+    CredentialsStore,
+    DEFAULT_REGISTRY_HOST,
+    DockerImage,
+    getImageUpdateTags,
+    getLatestImageVersion,
+    listRepositories,
+    readDockerConfig
+} from './docker-utils';
 
 
 
@@ -49,7 +58,7 @@ export interface Options {
 
 export interface OutdatedImage {
     image: DockerImage;
-    versionDiff: string;
+    wantedVersion: string;
     latestVersion: string;
 }
 
@@ -88,14 +97,15 @@ export async function listOutdated(options: Options): Promise<OutdatedImage[]> {
 
     try {
         for (const image of filteredImages) {
-            const latestVersion = await getLatestImageVersion(credentials, image);
+            const {latest, wanted} = await getImageUpdateTags(credentials, image);
 
-            const versionDiff = semver.diff(image.tag, latestVersion);
-            if (versionDiff) {
+            const wantedDiff = semver.diff(image.tag, wanted);
+            const latestDiff = semver.diff(image.tag, latest);
+            if (wantedDiff || latestDiff) {
                 outdatedImages.push({
                     image,
-                    versionDiff,
-                    latestVersion
+                    wantedVersion: wanted,
+                    latestVersion: latest
                 });
             }
             progressBar.increment(1);
@@ -108,11 +118,11 @@ export async function listOutdated(options: Options): Promise<OutdatedImage[]> {
 
     const table = new EasyTable();
 
-    outdatedImages.forEach(({image, versionDiff, latestVersion}) => {
+    outdatedImages.forEach(({image, wantedVersion, latestVersion}) => {
         table.cell('Image', image.name);
-        table.cell('Upgrade Type', versionDiff);
-        table.cell('Current Version', image.tag);
-        table.cell('Latest Version', latestVersion);
+        table.cell('Current', image.tag);
+        table.cell('Wanted[^]', wantedVersion);
+        table.cell('Latest', latestVersion);
         table.newRow();
     });