Merge pull request #18 from stackhtml/accept-stream

rreusser · web-flow · commit aa69c29bc166 · 2017-11-18T13:54:17.000-08:00
Accept stream input for `html`
diff --git a/README.md b/README.md
@@ -18,6 +18,9 @@ Modular HTML bundler.
     Start bundling HTML
     $ documentify .
 
+    Bundle HTML from a stream
+    $ cat index.html | documentify
+
   Running into trouble? Feel free to file an issue:
   https://github.com/stackhtml/documentify/issues/new
 
@@ -63,9 +66,11 @@ function transform (opts) {
 
 ## API
 ### `document = documentify(entry, [html], [opts])`
-Create a new documentify instance. If `entry` is a `.html` file, it'll be used
-as the source. Otherwise uses an empty HTML file with just a body and head as
-the source.
+Create a new documentify instance. If `entry` is a `.html` file, it'll be
+used as the source. If `entry` is falsy and `html` is a string or readable
+stream, that will be used as the input instead. Otherwise if `entry` is falsy
+and `html` is omitted, an empty HTML file with just a body and head will be
+used as the source.
 
 ### `document.transform(fn, [opts])`
 Pass a transform to the document instance
diff --git a/bin.js b/bin.js
@@ -45,17 +45,22 @@ var argv = subarg(process.argv.slice(2), {
 
 ;(function main (argv) {
   var entry = argv._[0]
+  var html = null
 
   // If entry isn't an absolute path, convert to absolute path
   if (!entry) entry = process.cwd()
   if (!/^\//.test(entry)) entry = path.join(process.cwd(), entry)
 
+  if (!process.stdin.isTTY) {
+    html = process.stdin
+  }
+
   if (argv.help) {
     console.log(USAGE)
   } else if (argv.version) {
     console.log(require('./package.json').version)
   } else {
-    var bundler = Documentify(entry, {
+    var bundler = Documentify(entry, html, {
       transform: normalizeTransforms(argv.transform)
     })
     pump(bundler.bundle(), process.stdout, function (err) {
@@ -72,6 +77,7 @@ function clr (text, color) {
 }
 
 function normalizeTransforms (transforms) {
+  if (!transforms) return []
   if (!Array.isArray(transforms)) transforms = [transforms]
   return transforms.map(function (t) {
     if (typeof t === 'object' && Array.isArray(t._)) {
diff --git a/index.js b/index.js
@@ -15,20 +15,26 @@ module.exports = Documentify
 
 var defaultHtml = '<!DOCTYPE html><html><head></head><body></body></html>'
 
+function isStream (maybe) {
+  return maybe !== null && typeof maybe === 'object' && typeof maybe.pipe === 'function'
+}
+
 function Documentify (entry, html, opts) {
   if (!(this instanceof Documentify)) return new Documentify(entry, html, opts)
 
   EventEmitter.call(this)
 
-  assert.equal(typeof entry, 'string', 'documentify: entry should be type string')
+  if (entry) {
+    assert.equal(typeof entry, 'string', 'documentify: entry should be type string')
+  }
 
-  if (typeof html === 'object') {
+  if (typeof html === 'object' && !isStream(html)) {
     opts = html
     html = null
   }
 
-  if (html) {
-    assert.equal(typeof html, 'string', 'documentify: html should be type string')
+  if (html && !isStream(html)) {
+    assert.equal(typeof html, 'string', 'documentify: html should be type string or stream')
   }
 
   opts = opts || {}
@@ -119,7 +125,7 @@ Documentify.prototype.bundle = function () {
   return pts
 
   function findTransforms (done) {
-    var entry = path.join(path.dirname(self.entry), path.basename(self.entry))
+    var entry = self.entry ? path.join(path.dirname(self.entry), path.basename(self.entry)) : self.basedir
     findup(entry, 'package.json', function (err, pathname) {
       // no package.json found - just run local transforms
       if (err) return done()
@@ -163,8 +169,8 @@ Documentify.prototype.bundle = function () {
   }
 
   function createSource (done) {
-    if (typeof self.html === 'string') {
-      source = fromString(self.html)
+    if (typeof self.html === 'string' || isStream(self.html)) {
+      source = isStream(self.html) ? self.html : fromString(self.html)
       return done()
     }
     resolve(self.entry, { extensions: [ '.html' ] }, function (err, entry) {
diff --git a/test/input.js b/test/input.js
@@ -4,8 +4,25 @@ var documentify = require('../')
 var concat = require('concat-stream')
 var assertHtml = require('assert-html')
 var dedent = require('dedent')
+var fromString = require('from2-string')
 
 test('input', function (t) {
+  t.test('throws if the input is not a string', function (t) {
+    t.plan(3)
+
+    var truthyButNotAString = [
+      12,
+      {foo: 'bar'},
+      true
+    ]
+
+    for (var i = 0; i < truthyButNotAString.length; i++) {
+      t.throws(function () {
+        documentify(truthyButNotAString[i]).bundle()
+      }, /entry should be type string/)
+    }
+  })
+
   t.test('uses input text if specified', function (t) {
     t.plan(10)
     var sourceHtml = `
@@ -27,6 +44,52 @@ test('input', function (t) {
       }))
   })
 
+  t.test('accepts a html stream', function (t) {
+    t.plan(10)
+
+    var sourceHtml = `
+      <!DOCTYPE html>
+      <html>
+      <head>
+        <title>test</title>
+      </head>
+      <body>
+        beep boop
+      </body>
+      </html>
+    `.replace(/\n +/g, '')
+    var sourceStream = fromString(sourceHtml)
+
+    documentify(null, sourceStream, {})
+      .bundle()
+      .pipe(concat({ encoding: 'string' }, function (html) {
+        assertHtml(t, sourceHtml, html)
+      }))
+  })
+
+  t.test('accepts a html stream without options provided', function (t) {
+    t.plan(10)
+
+    var sourceHtml = `
+      <!DOCTYPE html>
+      <html>
+      <head>
+        <title>test</title>
+      </head>
+      <body>
+        beep boop
+      </body>
+      </html>
+    `.replace(/\n +/g, '')
+    var sourceStream = fromString(sourceHtml)
+
+    documentify(null, sourceStream)
+      .bundle()
+      .pipe(concat({ encoding: 'string' }, function (html) {
+        assertHtml(t, sourceHtml, html)
+      }))
+  })
+
   t.test('defaults to empty document', function (t) {
     t.plan(7)
     documentify(path.join(__dirname, 'test.html'))
