Closed #4

Author: Malte Legenhausen

README.md

@@ -45,9 +45,26 @@ console.log(text);
 
 You can configure the behaviour of html-to-text with the following options:
 
- * `tables` allows to select certain tables by the `class` attribute from the HTML document. This is necessary because the majority of HTML E-Mails uses a table based layout. So you have to define which tables should be treaded as `table`. All other tables are ignored.
- * `wordwrap` defines after how many chars a line break should follow in `p` elements.
- 
+ * `tables` allows to select certain tables by the `class` attribute from the HTML document. This is necessary because the majority of HTML E-Mails uses a table based layout. So you have to define which tables should be treaded as `table`. All other tables are ignored. Default: `[]`
+ * `wordwrap` defines after how many chars a line break should follow in `p` elements. Default: `80`
+
+## Command Line Interface
+
+It is possible to use html-to-text as command line interface. This allows an easy validation of your generated text and the integration in other systems that does not run on node.js.
+
+`html-to-text` uses `stdin` and `stdout` for data in and output. So you can use `html-to-html` the following way:
+
+```
+cat examples/test.html | html-to-text > test.txt
+```
+
+There also all options available as described above. You can use them like this:
+
+```
+cat examples/test.html | html-to-text --tables=invoice,address --wordwrap=100 > test.txt
+```
+
+The `tables` option has to be declared as comma separated list without whitespaces.
 
 ## Example
 

bin/cli.js

@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+var optimist = require('optimist');
+
+var htmlToText = require('../lib/html-to-text');
+
+var argv = optimist.default('tables', '').default('wordwrap', 80).argv;
+var text = '';
+
+process.title = 'html-to-text';
+
+process.stdin.resume();
+process.stdin.setEncoding('utf8');
+process.stdin.on('data', function data(data) {
+	text += data;
+});
+
+process.stdout.setEncoding('utf8');
+process.stdin.on('end', function end() {
+	text = htmlToText.fromString(text, {
+		tables: argv.tables.split(','),
+		wordwrap: argv.wordwrap
+	});
+	process.stdout.write(text + '\n');
+});

package.json

@@ -1,7 +1,7 @@
 {
   "name": "html-to-text",
   "version": "0.0.3",
-  "description": "Simple html to text converter",
+  "description": "Simple html to plain text converter",
   "main": "index.js",
   "scripts": {
 
@@ -11,16 +11,21 @@
   "dependencies": {
   	"htmlparser": "1.x.x",
   	"underscore": "1.x.x",
-  	"underscore.string": "2.x.x"
+  	"underscore.string": "2.x.x",
+    "optimist": "0.x.x" 
   },
   "keywords": [
-  	"html",
+    "html",
   	"node",
   	"text",
   	"mail",
+    "plain",
   	"converter"
   ],
   "engines": { 
   	"node": "*" 
+  },
+  "bin": {
+    "html-to-text": "./bin/cli.js"
   }
 }