Finish PR 17 - Fix Gzip example (#36)

* fix example

Update node dependencies and fix example.

* Update changelog

* Drop eslint 'global Buffer' usage

* Remove extra whitespace

* Drop package-lock.json

Co-authored-by: Matthew Leon <[email protected]>

.eslintrc.json

@@ -4,6 +4,7 @@
   },
   "extends": "eslint:recommended",
   "env": {
+    "node": true,
     "commonjs": true
   },
   "rules": {

CHANGELOG.md

@@ -11,6 +11,7 @@ New features:
 Bugfixes:
 
 Other improvements:
+- Fix `Gzip` example (#17, #36 by @matthewleon and @JordanMartinez)
 
 ## [v5.0.0](https://github.com/purescript-node/purescript-posix-types/releases/tag/v5.0.0) - 2021-02-26
 

README.md

@@ -6,6 +6,8 @@
 
 A wrapper for Node's [Stream API](https://nodejs.org/api/stream.html).
 
+See the `example` directory for a usage example.
+
 ## Installation
 
 ```

example/Gzip.js

@@ -1,9 +1,5 @@
-/* global exports */
-/* global require */
 "use strict";
 
-// module Gzip
-
-exports.gzip = require('zlib').createGzip;
+exports.gzip = require("zlib").createGzip;
+exports.fileStream = require("fs").createReadStream("example/Gzip.txt");
 exports.stdout = process.stdout;
-exports.stdin = process.stdin;

example/Gzip.purs

@@ -3,15 +3,17 @@ module Gzip where
 import Prelude
 
 import Effect (Effect)
-import Node.Stream (Duplex, Readable, Writable, pipe)
-
+import Effect.Console (log)
+import Node.Stream (Duplex, Readable, Writable, onEnd, pipe)
 
 foreign import gzip :: Effect Duplex
-foreign import stdin :: Readable ()
+foreign import fileStream :: Readable ()
 foreign import stdout :: Writable ()
 
-main :: Effect (Writable ())
+main :: Effect Unit
 main = do
   z <- gzip
-  _ <- stdin `pipe` z
-  z     `pipe` stdout
+  _ <- fileStream `pipe` z
+  _ <- z `pipe` stdout
+  void $ onEnd fileStream do
+    log "Done reading file, gzip output below"

example/Gzip.txt

@@ -0,0 +1 @@
+Compress me pretty please!

package.json

@@ -3,6 +3,8 @@
   "scripts": {
     "clean": "rimraf output && rimraf .pulp-cache",
     "build": "eslint src && pulp build -- --censor-lib --strict",
+    "example:build": "eslint example && pulp build -I example -- --censor-lib --strict",
+    "example": "eslint example && pulp run -I example -m Gzip",
     "test": "pulp test -- --censor-lib --strict"
   },
   "devDependencies": {

src/Node/Stream.js

@@ -1,4 +1,3 @@
-/* global Buffer */
 "use strict";
 
 exports.undefined = undefined;