separate remark plugin from mdast transformation

Author: eush77

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Eugene Sharygin
+Copyright (c) 2015, 2016 Eugene Sharygin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -4,11 +4,17 @@
 
 [![Build Status][travis-badge]][travis] [![Dependency Status][david-badge]][david]
 
-Remove empty paragraphs left from other [mdast] transformations.
+> :warning:
+>
+> This is an AST transformer for [mdast] syntax trees. A [remark] plugin has been split up into [a different project][remark-squeeze-paragraphs].
 
-Paragraph is considered empty if it is composed from whitespace characters.
+Remove empty paragraphs from [mdast] tree.
+
+Paragraph is considered empty if it is composed of whitespace characters only.
 
 [mdast]: https://github.com/wooorm/mdast
+[remark]: https://github.com/wooorm/remark
+[remark-squeeze-paragraphs]: https://github.com/eush77/remark-squeeze-paragraphs
 
 [travis]: https://travis-ci.org/eush77/mdast-squeeze-paragraphs
 [travis-badge]: https://travis-ci.org/eush77/mdast-squeeze-paragraphs.svg
@@ -18,33 +24,54 @@ Paragraph is considered empty if it is composed from whitespace characters.
 ## Example
 
 ```js
-> mdastSqueezeParagraphs = require('mdast-squeeze-paragraphs')
-
-> 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')
-'text\n'
+var squeezeParagraphs = require('mdast-squeeze-paragraphs');
+
+ast
+//=> {
+//     "type": "root",
+//     "children": [
+//       {
+//         "type": "paragraph",
+//         "children": []
+//       },
+//       {
+//         "type": "paragraph",
+//         "children": [
+//           {
+//             "type": "text",
+//             "value": "foo"
+//           }
+//         ]
+//       }
+//     ]
+//   }
+
+squeezeParagraphs(ast)
+//=> {
+//     "type": "root",
+//     "children": [
+//       {
+//         "type": "paragraph",
+//         "children": [
+//           {
+//             "type": "text",
+//             "value": "foo"
+//           }
+//         ]
+//       }
+//     ]
+//   }
 ```
 
 ## API
 
-```js
-var mdastSqueezeParagraphs = require('mdast-squeeze-paragraphs');
-
-mdast.use(mdastSqueezeParagraphs)
-```
+#### `squeezeParagraphs(ast)`
 
-Modifies AST in-place.
+Modifies AST in-place. Returns `ast`.
 
-## CLI
+## Related
 
-```
-mdast -u mdast-squeeze-paragraphs
-```
+- [remark-squeeze-paragraphs] — [remark] plugin wrapper.
 
 ## Install
 

index.js

@@ -1,14 +1,12 @@
 'use strict';
 
 
-module.exports = function () {
-  return function (ast) {
-    ast.children = ast.children.filter(function (node) {
-      return node.type != 'paragraph' || node.children.some(function (node) {
-        return node.type != 'text' || !/^\s*$/.test(node.value);
-      });
+module.exports = function (ast) {
+  ast.children = ast.children.filter(function (node) {
+    return node.type != 'paragraph' || node.children.some(function (node) {
+      return node.type != 'text' || !/^\s*$/.test(node.value);
     });
+  });
 
-    return ast;
-  };
+  return ast;
 };

package.json

@@ -1,7 +1,7 @@
 {
   "name": "mdast-squeeze-paragraphs",
   "version": "1.1.0",
-  "description": "Remove empty paragraphs left from other mdast transformations",
+  "description": "Remove empty paragraphs from mdast tree",
   "author": "Eugene Sharygin <[email protected]>",
   "license": "MIT",
   "scripts": {
@@ -17,8 +17,6 @@
   },
   "keywords": [
     "mdast",
-    "plugin",
-    "markdown",
     "squeeze",
     "remove",
     "empty",
@@ -32,8 +30,6 @@
   ],
   "dependencies": {},
   "devDependencies": {
-    "clone": "^1.0.2",
-    "mdast": "^0.26.2",
     "tape": "^4.0.0"
   }
 }

test/test.js

@@ -1,16 +1,14 @@
 'use strict';
 
-var mdastSqueezeParagraphs = require('..');
+var squeezeParagraphs = require('..');
 
-var test = require('tape'),
-    mdast = require('mdast'),
-    clone = require('clone');
+var test = require('tape');
 
 
 test(function (t) {
   var input = require('./input');
   var output = require('./output');
 
-  t.deepEqual(mdast.use(mdastSqueezeParagraphs).run(input), output);
+  t.deepEqual(squeezeParagraphs(input), output);
   t.end();
 });