docker-stream-cleanser - npm Package Compare versions

Comparing version 0.1.2 to 0.2.0

package.json

 {
   "name": "docker-stream-cleanser",
-  "version": "0.1.2",
-  "main": "app.js",
-  "devDependencies": {
-    "lab": "^4.0.2"
-  },
+  "version": "0.2.0",
+  "main": "index.js",
   "description": "This module cleans the docker headers from the log stream from a container.  I never found them very useful, so I wrote this to clean them up either in bulk, or in between a piping.  It's not as simple as just removing the first 8 bytes on every message",
   "scripts": {
-    "test": "NODE_PATH=. node ./node_modules/lab/bin/lab tests.js"
+    "test": "lab -c test/*.js"
   },
@@ -27,3 +24,10 @@ "repository": {
     "cleaner",
-    "remove"
+    "remove",
+    "parse",
+    "parser",
+    "frame",
+    "header",
+    "payload",
+    "stdout",
+    "stderr"
   ],
@@ -35,3 +39,12 @@ "author": "Dominathan",
   },
-  "homepage": "https://github.com/Nathan219/docker-stream-cleanser"
+  "homepage": "https://github.com/Nathan219/docker-stream-cleanser",
+  "dependencies": {
+    "lab": "^5.2.1",
+    "through": "^2.3.6"
+  },
+  "devDependencies": {
+    "code": "^1.3.0",
+    "concat-stream": "^1.4.7",
+    "lab": "^4.0.2"
+  }
 }

README.md

@@ -8,7 +8,5 @@ [![NPM](https://nodei.co/npm/docker-stream-cleanser.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/docker-stream-cleanser/)
 
-Docker Stream Cleanser is a drop-in module to clean the headers from Docker Logs
+Docker Stream Cleanser is a drop-in module to clean the headers from Docker Logs (container attach or container logs)
 
-  - Cleans the header from finished, stored logs
-  - Cleans as it pipes from one stream to another
-  - Accounts for any irregularities in streaming
+  - Removes headers from a Docker logs streams and keeps payload
   - Handles any encoding (Ones compatible with Node.js Buffer)
@@ -24,41 +22,40 @@
 ----
-For clearing from stored logs:
 
-```sh
-var streamCleanser = require('docker-stream-cleanser');
+Usage with Docker Data Stream
+```js
+var streamCleanser = require('docker-stream-cleanser')();
 
-function(theData) {
-    var cleansed = streamCleanser(theData, 'hex');
-}
+dockerLogStream
+  .pipe(streamCleanser)
+  .pipe(/* stream */);
+```
 
-OR
+Usage with [Dockerode](https://github.com/apocas/dockerode)
+```js
+var Docker = require('dockerode');
+var container = new Docker().getContainer(containerId);
+var streamCleanser = require('docker-stream-cleanser')();
 
-var streamCleanser = require('docker-stream-cleanser');
-
-function(theStream) {
-    var cleansed = streamCleanser.async(theStream, 'hex', function(data) {
-      console.log('the data!', data);
-    });
-}
-
+container.logs({ stderr: true, stdout: true }, function (err, stream) {
+  stream
+    .pipe(streamCleanser)
+    .pipe(/* stream */);
+});
 ```
 
-For clearing between streams:
+Usage with Docker Data Buffer
+```js
+var streamCleanser = require('docker-stream-cleanser')();
+var concat = require('concat-stream');
 
-```sh
-var streamCleanser = require('docker-stream-cleanser');
-function(theStream) {
-    var cleansed = streamCleanser.cleanStreams(theStream, process.stdout, 'hex', true);
-}
+streamCleanser
+  .pipe(concat(function (cleanDockerData) {
+    // use cleanDockerData here..
+  }));
 
-
-
-// cleanStreams(inputStream, outputStream, encoding, addCarraigeReturn)
-// addCarraigeReturn is a flag to replace all \n's in the stream with \r\n
+streamCleanser.write(dockerDataBuffer);
+streamCleanser.end();
 ```
 
 
-For more info, look at the header comments and the tests
-
-
 Installation
@@ -65,0 +62,0 @@ --------------

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Number of package files

24

increased by9.09%

Worsened metrics

Total package byte prevSize

76771

decreased by-11.27%

Dependency count

2

increased byInfinity%

Dev dependency count

3

increased by200%

Lines of code

293

decreased by-33.86%

Number of lines in readme file

71

decreased by-4.05%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedlab@^5.2.1

• + Addedthrough@^2.3.6

• + Addedabbrev@1.1.1(transitive)

• + Addedamdefine@1.0.1(transitive)

• + Addedansi-regex@1.1.12.1.1(transitive)

• + Addedansi-styles@2.2.1(transitive)

• + Addedargparse@1.0.10(transitive)

• + Addedbalanced-match@1.0.2(transitive)

• + Addedbossy@1.0.3(transitive)

• + Addedbrace-expansion@1.1.11(transitive)

• + Addedbuffer-from@1.1.2(transitive)

• + Addedchalk@1.1.3(transitive)

• + Addedcircular-json@0.3.3(transitive)

• + Addedcli-width@1.1.1(transitive)

• + Addedconcat-map@0.0.1(transitive)

• + Addedconcat-stream@1.6.2(transitive)

• + Addedcore-util-is@1.0.3(transitive)

• + Addedd@1.0.2(transitive)

• + Addeddebug@2.6.9(transitive)

• + Addeddeep-is@0.1.4(transitive)

• + Addeddiff@2.2.3(transitive)

• + Addeddoctrine@0.6.40.7.2(transitive)

• + Addedes5-ext@0.10.64(transitive)

• + Addedes6-iterator@2.0.3(transitive)

• + Addedes6-map@0.1.5(transitive)

• + Addedes6-set@0.1.6(transitive)

• + Addedes6-symbol@3.1.4(transitive)

• + Addedes6-weak-map@2.0.3(transitive)

• + Addedescape-string-regexp@1.0.5(transitive)

• + Addedescope@3.6.0(transitive)

• + Addedeslint@0.24.11.5.1(transitive)

• + Addedeslint-config-hapi@2.0.1(transitive)

• + Addedeslint-plugin-hapi@1.2.2(transitive)

• + Addedesniff@2.0.1(transitive)

• + Addedespree@2.2.5(transitive)

• + Addedesprima@4.0.1(transitive)

• + Addedesrecurse@4.3.0(transitive)

• + Addedestraverse@4.3.05.3.0(transitive)

• + Addedestraverse-fb@1.3.2(transitive)

• + Addedesutils@1.1.6(transitive)

• + Addedevent-emitter@0.3.5(transitive)

• + Addedexit@0.1.2(transitive)

• + Addedext@1.7.0(transitive)

• + Addedfast-levenshtein@1.0.7(transitive)

• + Addedfigures@1.7.0(transitive)

• + Addedfile-entry-cache@1.3.1(transitive)

• + Addedflat-cache@1.3.4(transitive)

• + Addedfs.realpath@1.0.0(transitive)

• + Addedgenerate-function@2.3.1(transitive)

• + Addedgenerate-object-property@1.2.0(transitive)

• + Addedget-stdin@3.0.2(transitive)

• + Addedglob@4.5.35.0.157.2.3(transitive)

• + Addedglobals@8.18.0(transitive)

• + Addedgraceful-fs@4.2.11(transitive)

• + Addedhandlebars@4.7.8(transitive)

• + Addedhapi-capitalize-modules@1.1.6(transitive)

• + Addedhapi-scope-start@1.1.4(transitive)

• + Addedhas-ansi@2.0.0(transitive)

• + Addedhoek@2.16.3(transitive)

• + Addedinflight@1.0.6(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedinquirer@0.8.50.9.0(transitive)

• + Addedis-my-ip-valid@1.0.1(transitive)

• + Addedis-my-json-valid@2.20.6(transitive)

• + Addedis-property@1.0.2(transitive)

• + Addedis-resolvable@1.1.0(transitive)

• + Addedisarray@0.0.11.0.0(transitive)

• + Addeditems@1.1.1(transitive)

• + Addedjs-yaml@3.14.1(transitive)

• + Addedjslint@0.9.8(transitive)

• + Addedjson-stringify-safe@5.0.1(transitive)

• + Addedjsonpointer@5.0.1(transitive)

• + Addedlab@5.18.1(transitive)

• + Addedlevn@0.2.5(transitive)

• + Addedlodash@3.10.1(transitive)

• + Addedlodash._arraycopy@3.0.0(transitive)

• + Addedlodash._arrayeach@3.0.0(transitive)

• + Addedlodash._arraymap@3.0.0(transitive)

• + Addedlodash._baseassign@3.2.0(transitive)

• + Addedlodash._baseclone@3.3.0(transitive)

• + Addedlodash._basecopy@3.0.1(transitive)

• + Addedlodash._basedifference@3.0.3(transitive)

• + Addedlodash._baseflatten@3.1.4(transitive)

• + Addedlodash._basefor@3.0.3(transitive)

• + Addedlodash._baseindexof@3.1.0(transitive)

• + Addedlodash._bindcallback@3.0.1(transitive)

• + Addedlodash._cacheindexof@3.0.2(transitive)

• + Addedlodash._createassigner@3.1.1(transitive)

• + Addedlodash._createcache@3.1.2(transitive)

• + Addedlodash._getnative@3.9.1(transitive)

• + Addedlodash._isiterateecall@3.0.9(transitive)

• + Addedlodash._pickbyarray@3.0.2(transitive)

• + Addedlodash._pickbycallback@3.0.0(transitive)

• + Addedlodash.clonedeep@3.0.2(transitive)

• + Addedlodash.isarguments@3.1.0(transitive)

• + Addedlodash.isarray@3.0.4(transitive)

• + Addedlodash.isplainobject@3.2.0(transitive)

• + Addedlodash.istypedarray@3.0.6(transitive)

• + Addedlodash.keys@3.1.2(transitive)

• + Addedlodash.keysin@3.0.8(transitive)

• + Addedlodash.merge@3.3.2(transitive)

• + Addedlodash.omit@3.1.0(transitive)

• + Addedlodash.restparam@3.6.1(transitive)

• + Addedlodash.toplainobject@3.0.0(transitive)

• + Addedminimatch@2.0.103.1.2(transitive)

• + Addedminimist@1.2.8(transitive)

• + Addedmkdirp@0.5.6(transitive)

• + Addedms@2.0.0(transitive)

• + Addedmute-stream@0.0.4(transitive)

• + Addedneo-async@2.6.2(transitive)

• + Addednext-tick@1.1.0(transitive)

• + Addedno-shadow-relaxed@1.0.1(transitive)

• + Addednopt@3.0.6(transitive)

• + Addedobject-assign@2.1.14.1.1(transitive)

• + Addedonce@1.4.0(transitive)

• + Addedoptionator@0.5.0(transitive)

• + Addedpath-is-absolute@1.0.1(transitive)

• + Addedpath-is-inside@1.0.2(transitive)

• + Addedprelude-ls@1.1.2(transitive)

• + Addedprocess-nextick-args@2.0.1(transitive)

• + Addedreadable-stream@1.0.342.3.8(transitive)

• + Addedreadline2@0.1.1(transitive)

• + Addedrimraf@2.6.3(transitive)

• + Addedrun-async@0.1.0(transitive)

• + Addedrx@2.5.3(transitive)

• + Addedrx-lite@2.5.2(transitive)

• + Addedsafe-buffer@5.1.2(transitive)

• + Addedshelljs@0.3.0(transitive)

• + Addedsource-map@0.1.320.6.1(transitive)

• + Addedsource-map-support@0.3.3(transitive)

• + Addedsprintf-js@1.0.3(transitive)

• + Addedstring_decoder@0.10.311.1.1(transitive)

• + Addedstrip-ansi@2.0.13.0.1(transitive)

• + Addedstrip-json-comments@1.0.4(transitive)

• + Addedsupports-color@2.0.0(transitive)

• + Addedtext-table@0.2.0(transitive)

• + Addedthrough@2.3.8(transitive)

• + Addedto-double-quotes@1.0.2(transitive)

• + Addedto-single-quotes@1.0.4(transitive)

• + Addedtype@2.7.3(transitive)

• + Addedtype-check@0.3.2(transitive)

• + Addedtypedarray@0.0.6(transitive)

• + Addeduglify-js@3.18.0(transitive)

• + Addeduser-home@1.1.1(transitive)

• + Addedutil-deprecate@1.0.2(transitive)

• + Addedwordwrap@0.0.31.0.0(transitive)

• + Addedwrappy@1.0.2(transitive)

• + Addedwrite@0.2.1(transitive)

• + Addedxml-escape@1.0.0(transitive)

• + Addedxtend@4.0.2(transitive)