dockly 3.21.2 → 3.22.0

package/README.md

@@ -10,17 +10,20 @@
 [![view on npm](http://img.shields.io/npm/v/dockly.svg)](https://www.npmjs.org/package/dockly)
 [![view on npm](http://img.shields.io/npm/l/dockly.svg)](https://www.npmjs.org/package/dockly)
 [![npm module downloads](http://img.shields.io/npm/dt/dockly.svg)](https://www.npmjs.org/package/dockly)
-[![Known Vulnerabilities](https://snyk.io/test/npm/dockly/badge.svg)](https://snyk.io/test/npm/dockly)
 [![Security Responsible Disclosure](https://img.shields.io/badge/Security-Responsible%20Disclosure-yellow.svg)](./SECURITY.md
 )
 [![dockly](https://snyk.io/advisor/npm-package/dockly/badge.svg)](https://snyk.io/advisor/npm-package/dockly)
 
-🌟 Featured on [![Awesome Docker](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/veggiemonk/awesome-docker) [![DevOps Weekly](https://img.shields.io/badge/DevOpsWeekly-%F0%9F%95%B6-yellow.svg
+Dockly has been highlighted, featured and chosen as favorite docker container management tool on:
+
+[![Awesome Docker](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/veggiemonk/awesome-docker) [![DevOps Weekly](https://img.shields.io/badge/DevOpsWeekly-%F0%9F%95%B6-yellow.svg
 )](http://devopsweekly.com) 
 [![terminals are sexy](https://img.shields.io/badge/TerminalsAreSexy-%F0%9F%92%BB-green.svg
-)](https://github.com/k4m4/terminals-are-sexy) 
-
+)](https://github.com/k4m4/terminals-are-sexy) [![Programmer's Weekly](https://img.shields.io/badge/ProgrammersWeekly-%F0%9F%95%B6-purple.svg
+)](https://mailchi.mp/programmerweekly/programmer-weekly-issue-94?e=e8c11d0390) [![Console.dev](https://img.shields.io/badge/ConsoleDotDev-%F0%9F%95%B6-blue.svg
+)](https://console.dev/tools/)
 
+<a href="https://console.dev" title="Visit Console - the best tools for developers"><img src="https://console.dev/img/badges/1.0/png/console-badge-pick-green1-dark.png" alt="Console - Developer Tool of the Week" /></a>
 
 ![dockly-demo-2](https://cloud.githubusercontent.com/assets/316371/25682867/c5212216-3027-11e7-8f36-72d38516d2af.gif)
 
@@ -46,6 +49,9 @@ It's also possible to provide command line options for dockly to customize the d
 | Param | Type | Description |
 | --- | --- | --- |
 | -s or --socketPath | string | Docker socket to connect to |
+| -H or --host | string | Remote docker daemon host to connect to |
+| -P or --port | string | Remote docker port to connect to  |
+| -T or --protocol | `http` \| `https` \| `ssh` | Remote docker protocol to connect to |
 | --containerFilters | string | String to apply to filter shown containers |
 | -h or --help | null | Display help |
 | -v or --version | null | Display version information |
@@ -110,10 +116,26 @@ Dockly requires Node.js v7.6 and above
 
 Follow the steps [in this comment](https://github.com/lirantal/dockly/issues/50#issuecomment-536190949) to enable VT100 support on the settings for the window
 
+3. Icons not working properly 
 
-# Author
-Liran Tal <liran.tal@gmail.com>
+set `LANG` and `LC_ALL` to c.UTF-8 like so
+```bash
+export LANG=C.UTF-8
+export LC_ALL=C.UTF-8
+```
+for more info please see [this issue](https://github.com/yaronn/blessed-contrib/issues/111)
 
 ## Alternatives
 
 See [Awesome Docker list](https://github.com/veggiemonk/awesome-docker/blob/master/README.md#terminal) for similar tools to work with Docker.
+
+# In the news
+
+- Admin Magazine article: [Visualizing containers with clarity
+](https://www.admin-magazine.com/Articles/Visualizing-containers-with-clarity)
+- [A learnk8s tweet](https://twitter.com/learnk8s/status/1075677503782563840)
+- [Dockly – Manage Docker Containers From Terminal](https://ostechnix.com/dockly-manage-docker-containers-from-terminal/)
+- [Clever cloud CEO, Quentin Adam, tweeting about dockly](https://twitter.com/waxzce/status/1123886351924043777)
+
+# Author
+Liran Tal <liran.tal@gmail.com>

package/hooks/containers.hook.js

@@ -1,10 +1,8 @@
 'use strict'
 
-const EventEmitter = require('events')
-const baseWidget = require('../src/baseWidget')
-const clipboardy = require('clipboardy')
+const baseHook = require('../src/widgetsTemplates/base.hook.template')
 
-class hook extends baseWidget(EventEmitter) {
+class hook extends baseHook {
   init () {
     // on startup we first emit data from the docker server
     this.getFreshData((err, data) => {
@@ -45,7 +43,7 @@ class hook extends baseWidget(EventEmitter) {
       }
 
       if (keyString === 'c') {
-        this.copyContainerIdToClipboard()
+        this.copyItemIdToClipboard()
       }
     })
 
@@ -167,20 +165,12 @@ class hook extends baseWidget(EventEmitter) {
     }
   }
 
-  copyContainerIdToClipboard () {
-    if (this.widgetsRepo && this.widgetsRepo.has('containerList')) {
-      const containerId = this.widgetsRepo.get('containerList').getSelectedContainer()
-      if (containerId) {
-        clipboardy.writeSync(containerId)
-
-        const actionStatus = this.widgetsRepo.get('actionStatus')
-        const message = `Container Id ${containerId} was copied to the clipboard`
-
-        actionStatus.emit('message', {
-          message: message
-        })
-      }
+  getSelectedItem () {
+    if (!this.widgetsRepo.has('containerList')) {
+      return null
     }
+
+    return this.widgetsRepo.get('containerList').getSelectedContainer()
   }
 }
 

package/hooks/images.hook.js

@@ -1,10 +1,8 @@
 'use strict'
 
-const EventEmitter = require('events')
-const baseWidget = require('../src/baseWidget')
-const clipboardy = require('clipboardy')
+const baseHook = require('../src/widgetsTemplates/base.hook.template')
 
-class hook extends baseWidget(EventEmitter) {
+class hook extends baseHook {
   init () {
     if (!this.widgetsRepo.has('toolbar')) {
       return null
@@ -21,25 +19,17 @@ class hook extends baseWidget(EventEmitter) {
       }
 
       if (keyString === 'c') {
-        this.copyImageIdToClipboard()
+        this.copyItemIdToClipboard()
       }
     })
   }
 
-  copyImageIdToClipboard () {
-    if (this.widgetsRepo && this.widgetsRepo.has('imageList')) {
-      const imageId = this.widgetsRepo.get('imageList').getSelectedImage()
-      if (imageId) {
-        clipboardy.writeSync(imageId)
-
-        const actionStatus = this.widgetsRepo.get('actionStatus')
-        const message = `Image Id ${imageId} was copied to the clipboard`
-
-        actionStatus.emit('message', {
-          message: message
-        })
-      }
+  getSelectedItem () {
+    if (!this.widgetsRepo.has('imageList')) {
+      return null
     }
+
+    return this.widgetsRepo.get('imageList').getSelectedImage()
   }
 
   notifyOnImageUpdate () {

package/hooks/services.hook.js

@@ -1,10 +1,8 @@
 'use strict'
 
-const EventEmitter = require('events')
-const baseWidget = require('../src/baseWidget')
-const clipboardy = require('clipboardy')
+const baseHook = require('../src/widgetsTemplates/base.hook.template')
 
-class hook extends baseWidget(EventEmitter) {
+class hook extends baseHook {
   init () {
     // on startup we first emit data from the docker server
     this.getFreshData((err, data) => {
@@ -36,7 +34,7 @@ class hook extends baseWidget(EventEmitter) {
       }
 
       if (keyString === 'c') {
-        this.copyServiceIdToClipboard()
+        this.copyItemIdToClipboard()
       }
     })
 
@@ -85,20 +83,12 @@ class hook extends baseWidget(EventEmitter) {
     })
   }
 
-  copyServiceIdToClipboard () {
-    if (this.widgetsRepo && this.widgetsRepo.has('servicesList')) {
-      const serviceId = this.widgetsRepo.get('servicesList').getSelectedService()
-      if (serviceId) {
-        clipboardy.writeSync(serviceId)
-
-        const actionStatus = this.widgetsRepo.get('actionStatus')
-        const message = `Service Id ${serviceId} was copied to the clipboard`
-
-        actionStatus.emit('message', {
-          message: message
-        })
-      }
+  getSelectedItem () {
+    if (!this.widgetsRepo.has('servicesList')) {
+      return null
     }
+
+    return this.widgetsRepo.get('servicesList').getSelectedService()
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dockly",
-  "version": "3.21.2",
+  "version": "3.22.0",
   "description": "Immersive terminal interface for managing docker containers and services",
   "main": "index.js",
   "scripts": {
@@ -67,14 +67,14 @@
   "homepage": "https://github.com/lirantal/dockly#readme",
   "dependencies": {
     "blessed": "^0.1.81",
-    "blessed-contrib": "^4.9.0",
+    "blessed-contrib": "^4.10.1",
     "chalk": "2.4.2",
     "clipboardy": "^2.3.0",
-    "command-line-args": "^5.1.1",
+    "command-line-args": "^5.1.2",
     "command-line-usage": "^5.0.5",
     "dockerode": "2.5.8",
     "figures": "^2.0.0",
-    "glob": "^7.1.6",
+    "glob": "^7.2.0",
     "lockfile-lint": "^3.0.9",
     "semver": "6.3.0"
   },
@@ -82,7 +82,7 @@
     "standard": "^12.0.1"
   },
   "release": {
-    "branch": "master"
+    "branches": "main"
   },
   "standard": {
     "ignore": [

package/src/cli.js

@@ -13,6 +13,24 @@ function Cli () {
       type: String,
       description: 'Docker daemon socket to connect to'
     },
+    {
+      name: 'host',
+      alias: 'H',
+      type: String,
+      description: 'Remote docker daemon host to connect to'
+    },
+    {
+      name: 'port',
+      alias: 'P',
+      type: Number,
+      description: 'Remote docker port to connect to'
+    },
+    {
+      name: 'protocol',
+      alias: 'T',
+      type: 'http' | 'https' | 'ssh',
+      description: 'Remote docker protocol to connect to'
+    },
     {
       name: 'help',
       alias: 'h',

package/src/dockerUtil.js

@@ -9,13 +9,14 @@ class Util {
     }
 
     // If a socketPath was explicitly specified, attempt connection based on it
-    if (config.socketPath) {
-      this.dockerCon = new DockerLib({
-        socketPath: config.socketPath
-      })
-    } else {
-      this.dockerCon = new DockerLib()
-    }
+    const dockerlibConfig = {}
+
+    if (config.socketPath) { dockerlibConfig.socketPath = config.socketPath }
+    if (config.host) { dockerlibConfig.host = config.host }
+    if (config.port) { dockerlibConfig.port = config.port }
+    if (config.protocol) { dockerlibConfig.protocol = config.protocol }
+
+    this.dockerCon = new DockerLib(dockerlibConfig)
 
     if (config.containerFilters) {
       this.containerFilters = JSON.stringify(config.containerFilters.split('&').reduce((carry, e) => {

package/src/widgetsTemplates/base.hook.template.js

@@ -0,0 +1,34 @@
+
+const baseWidget = require('../baseWidget')
+const EventEmitter = require('events')
+const clipboardy = require('clipboardy')
+
+class myWidget extends baseWidget(EventEmitter) {
+  copyItemIdToClipboard () {
+    const itemId = this.getSelectedItem()
+    if (!itemId) {
+      return
+    }
+
+    let message
+    try {
+      clipboardy.writeSync(itemId)
+
+      message = `Container Id ${itemId} was copied to the clipboard`
+    } catch (error) {
+      message = error
+    } finally {
+      const actionStatus = this.widgetsRepo.get('actionStatus')
+
+      actionStatus.emit('message', {
+        message: message
+      })
+    }
+  }
+
+  getSelectedItem () {
+    throw new Error('method getSelectedItem not implemented')
+  }
+}
+
+module.exports = myWidget

package/src/widgetsTemplates/list.widget.template.js

@@ -29,15 +29,15 @@ class myWidget extends baseWidget(EventEmitter) {
         return null
       }
 
-      // clear log box of previous logs
-      this.clearItemLogs()
-
       // get logs for the items
       this.getItemLogs(itemId, (err, stream) => {
         if (err) {
           return null
         }
 
+        // clear log box of previous logs
+        this.clearItemLogs()
+
         let str
         if (stream && stream.pipe) {
           stream.on('data', (chunk) => {

package/widgets/images/imageList.widget.js

@@ -111,6 +111,10 @@ class myWidget extends ListWidget {
   getSelectedImage () {
     return this.widget.getItem(this.widget.selected).getContent().toString().trim().split(' ').shift()
   }
+
+  getItemLogs (itemId, cb) {
+    cb(new Error('image view don\'t have log widget'))
+  }
 }
 
 module.exports = myWidget