Add AST transform

Author: eush77

README.md

@@ -2,20 +2,28 @@
 
 # mdast-squeeze-paragraphs
 
-[![Build Status](https://travis-ci.org/eush77/mdast-squeeze-paragraphs.svg)](https://travis-ci.org/eush77/mdast-squeeze-paragraphs)
-[![Dependency Status][david-badge]][david]
+[![Build Status][travis-badge]][travis] [![Dependency Status][david-badge]][david]
 
-Remove empty paragraphs left from other [mdast](http://mdast.js.org) transformations.
+Remove empty paragraphs left from other [mdast] transformations.
 
+This module provides both AST transformation and a plugin.
+
+[mdast]: https://github.com/wooorm/mdast
+
+[travis]: https://travis-ci.org/eush77/mdast-squeeze-paragraphs
+[travis-badge]: https://travis-ci.org/eush77/mdast-squeeze-paragraphs.svg
 [david]: https://david-dm.org/eush77/mdast-squeeze-paragraphs
 [david-badge]: https://david-dm.org/eush77/mdast-squeeze-paragraphs.png
 
 ## Example
 
 ```js
+> mdastSqueezeParagraphs = require('mdast-squeeze-paragraphs/plugin')
+
 > mdast.use(mdastStripBadges)
        .process('![](http://img.shields.io/)\n\ntext')
 '\n\ntext\n'
+
 > mdast.use(mdastStripBadges)
        .use(mdastSqueezeParagraphs)
        .process('![](http://img.shields.io/)\n\ntext')
@@ -24,9 +32,13 @@ Remove empty paragraphs left from other [mdast](http://mdast.js.org) transformat
 
 ## API
 
-#### `mdast.use(mdastSqueezeParagraphs)`
+#### `mdastSqueezeParagraphs(ast)`
+
+Remove empty paragraphs from the AST. Return the reference to the AST for convenience.
+
+#### `mdast.use(require('mdast-squeeze-paragraphs/plugin'))`
 
-Remove empty paragraphs from the AST.
+Use this transformation as a plugin.
 
 ## Install
 

index.js

@@ -1,10 +1,10 @@
 'use strict';
 
 
-module.exports = function () {
-  return function (ast) {
-    ast.children = ast.children.filter(function (node) {
-      return !(node.type == 'paragraph' && !node.children.length);
-    });
-  };
+module.exports = function (ast) {
+  ast.children = ast.children.filter(function (node) {
+    return !(node.type == 'paragraph' && !node.children.length);
+  });
+
+  return ast;
 };

package.json

@@ -8,7 +8,8 @@
     "test": "tape test/*.js"
   },
   "files": [
-    "index.js"
+    "index.js",
+    "plugin.js"
   ],
   "homepage": "https://github.com/eush77/mdast-squeeze-paragraphs",
   "repository": "eush77/mdast-squeeze-paragraphs",
@@ -32,6 +33,7 @@
   ],
   "dependencies": {},
   "devDependencies": {
+    "clone": "^1.0.2",
     "mdast": "^0.26.2",
     "tape": "^4.0.0"
   }

plugin.js

@@ -0,0 +1,8 @@
+'use strict';
+
+var squeezeParagraphs = require('./');
+
+
+module.exports = function () {
+  return squeezeParagraphs;
+};

test/test.js

@@ -1,15 +1,20 @@
 'use strict';
 
-var mdastSqueezeParagraphs = require('..');
+var mdastSqueezeParagraphs = require('..'),
+    mdastSqueezeParagraphsPlugin = require('../plugin');
 
 var test = require('tape'),
-    mdast = require('mdast');
+    mdast = require('mdast'),
+    clone = require('clone');
 
 
 test(function (t) {
   var input = require('./input');
   var output = require('./output');
 
-  t.deepEqual(mdast().use(mdastSqueezeParagraphs).run(input), output);
+  t.deepEqual(mdastSqueezeParagraphs(clone(input)), output,
+              'Works as an AST transformation');
+  t.deepEqual(mdast.use(mdastSqueezeParagraphsPlugin).run(input), output,
+              'Works as a plugin');
   t.end();
 });