Update API to remove remark dependency

wooorm · wooorm · commit 3edfeeef4249 · 2016-01-17T10:56:31.000+01:00
diff --git a/example.js b/example.js
@@ -1,31 +1,34 @@
 var heading = require('./index.js');
 var remark = require('remark');
 
-// Callback invoked when a heading is found.
-function onrun(start, nodes, end) {
-    return [
-        start,
-        {
-            'type': 'paragraph',
-            'children': [
-                {
-                    'type': 'text',
-                    'value': 'Qux.'
-                }
-            ]
-        },
-        end
-    ];
-}
-
 // Process a document.
-var doc = remark().use(heading('foo', onrun)).process(
-    '# Foo\n' +
-    '\n' +
-    'Bar.\n' +
-    '\n' +
-    '# Baz\n'
-);
+var doc = remark()
+    .use(function () {
+        return function (node) {
+            heading(node, 'foo', function (start, nodes, end) {
+                return [
+                    start,
+                    {
+                        'type': 'paragraph',
+                        'children': [
+                            {
+                                'type': 'text',
+                                'value': 'Qux.'
+                            }
+                        ]
+                    },
+                    end
+                ];
+            });
+        }
+    }).process([
+        '# Foo',
+        '',
+        'Bar.',
+        '',
+        '# Baz',
+        ''
+    ].join('\n'));
 
 // Yields:
 console.log('markdown', doc);
diff --git a/index.js b/index.js
@@ -159,15 +159,15 @@ function search(root, test, callback) {
 }
 
 /**
- * Wrapper.
+ * Search `node` for `heading` and invoke `callback`.
  *
+ * @param {Node} node - Node to search in.
  * @param {string|RegExp|Function} heading - Heading to
  *   search for.
  * @param {Function} callback - Callback invoked when
  *   found.
- * @return {function(node)} - Attacher.
  */
-function wrapper(heading, callback) {
+function headingRange(node, heading, callback) {
     var test = heading;
 
     if (typeof test === 'string') {
@@ -178,29 +178,11 @@ function wrapper(heading, callback) {
         test = wrapExpression(test);
     }
 
-    /**
-     * Find a range based on a starting heading matching
-     * `test`, up until the following closing with
-     * equal or higher depth.
-     *
-     * @param {Node} node - Node to search in.
-     */
-    function transformer(node) {
-        search(node, test, callback);
-    }
-
-    /**
-     * `Attacher`.
-     */
-    function attacher() {
-        return transformer;
-    }
-
-    return attacher;
+    search(node, test, callback);
 }
 
 /*
  * Expose.
  */
 
-module.exports = wrapper;
+module.exports = headingRange;
diff --git a/mdast-util-heading-range.js b/mdast-util-heading-range.js
@@ -160,15 +160,15 @@ function search(root, test, callback) {
 }
 
 /**
- * Wrapper.
+ * Search `node` for `heading` and invoke `callback`.
  *
+ * @param {Node} node - Node to search in.
  * @param {string|RegExp|Function} heading - Heading to
  *   search for.
  * @param {Function} callback - Callback invoked when
  *   found.
- * @return {function(node)} - Attacher.
  */
-function wrapper(heading, callback) {
+function headingRange(node, heading, callback) {
     var test = heading;
 
     if (typeof test === 'string') {
@@ -179,32 +179,14 @@ function wrapper(heading, callback) {
         test = wrapExpression(test);
     }
 
-    /**
-     * Find a range based on a starting heading matching
-     * `test`, up until the following closing with
-     * equal or higher depth.
-     *
-     * @param {Node} node - Node to search in.
-     */
-    function transformer(node) {
-        search(node, test, callback);
-    }
-
-    /**
-     * `Attacher`.
-     */
-    function attacher() {
-        return transformer;
-    }
-
-    return attacher;
+    search(node, test, callback);
 }
 
 /*
  * Expose.
  */
 
-module.exports = wrapper;
+module.exports = headingRange;
 
 },{"mdast-util-to-string":2}],2:[function(require,module,exports){
 /**
diff --git a/mdast-util-heading-range.min.js b/mdast-util-heading-range.min.js
diff --git a/readme.md b/readme.md
@@ -21,36 +21,36 @@ var heading = require('mdast-util-heading-range');
 var remark = require('remark');
 ```
 
-Callback invoked when a heading is found.
-
-```javascript
-function onrun(start, nodes, end) {
-    return [
-        start,
-        {
-            'type': 'paragraph',
-            'children': [
-                {
-                    'type': 'text',
-                    'value': 'Qux.'
-                }
-            ]
-        },
-        end
-    ];
-}
-```
-
 Process a document.
 
 ```javascript
-var doc = remark().use(heading('foo', onrun)).process(
-    '# Foo\n' +
-    '\n' +
-    'Bar.\n' +
-    '\n' +
-    '# Baz\n'
-);
+var doc = remark()
+    .use(function () {
+        return function (node) {
+            heading(node, 'foo', function (start, nodes, end) {
+                return [
+                    start,
+                    {
+                        'type': 'paragraph',
+                        'children': [
+                            {
+                                'type': 'text',
+                                'value': 'Qux.'
+                            }
+                        ]
+                    },
+                    end
+                ];
+            });
+        }
+    }).process([
+        '# Foo',
+        '',
+        'Bar.',
+        '',
+        '# Baz',
+        ''
+    ].join('\n'));
 ```
 
 Yields:
@@ -65,14 +65,16 @@ Qux.
 
 ## API
 
-### heading(test, onrun)
+### `heading(node, test, onrun)`
 
 Transform part of a document without affecting other parts, by changing a
 section: a heading which passes `test`, until the next heading of the same
 or lower depth, or the end of the document.
 
 **Parameters**
 
+*   `node` ([`Node`][mdast-node]) — Node to search;
+
 *   `test` (`string`, `RegExp`, `function(string, Node): boolean`)
     — Heading to look for:
 
@@ -86,11 +88,7 @@ or lower depth, or the end of the document.
     (`Array.<Node>? = function (start, nodes, end)`)
     — Callback invoked when a range is found.
 
-**Returns**
-
-`Function` — Should be passed to [`mdast.use()`](https://github.com/wooorm/mdast#mdastuseplugin-options).
-
-#### function onrun(start, nodes, end?, scope)
+#### `function onrun(start, nodes, end?, scope)`
 
 **Parameters**
 
@@ -127,6 +125,8 @@ or lower depth, or the end of the document.
 
 [mdast]: https://github.com/wooorm/mdast
 
+[mdast-node]: https://github.com/wooorm/mdast#node
+
 [npm-install]: https://docs.npmjs.com/cli/install
 
 [duo]: http://duojs.org/#getting-started
diff --git a/test.js b/test.js
@@ -23,19 +23,21 @@ var heading = require('./');
  *
  * @param {Object} t - Test.
  * @param {string} value - Value to process.
- * @param {*} options - configuration.
+ * @param {*} name - Configuration.
  * @return {string} - Processed value.
  */
-function process(t, value, options) {
-    return remark().use(function (processor, name) {
-        processor.use(heading(name, function (start, nodes, end, scope) {
-            t.equal(typeof scope.start, 'number');
-            t.assert(typeof scope.end === 'number' || scope.end === null);
-            t.equal(scope.parent.type, 'root');
+function process(t, value, name) {
+    return remark().use(function () {
+        return function (node) {
+            heading(node, name, function (start, nodes, end, scope) {
+                t.equal(typeof scope.start, 'number');
+                t.assert(typeof scope.end === 'number' || scope.end === null);
+                t.equal(scope.parent.type, 'root');
 
-            return [start].concat(end ? [end] : []);
-        }));
-    }, options).process(value);
+                return [start].concat(end ? [end] : []);
+            });
+        };
+    }).process(value);
 }
 
 /*
@@ -241,10 +243,12 @@ test('mdast-util-heading-range()', function (t) {
         'should not fail with empty headings'
     );
 
-    remark().use(function (processor) {
-        processor.use(heading('foo', function () {
-            return null;
-        }));
+    remark().use(function () {
+        return function (node) {
+            heading(node, 'foo', function () {
+                return null;
+            });
+        };
     }).process([
         'Foo',
         '',
@@ -265,10 +269,12 @@ test('mdast-util-heading-range()', function (t) {
         ].join('\n'), 'should not remove anything when `null` is given');
     });
 
-    remark().use(function (processor) {
-        processor.use(heading('foo', function () {
-            return [];
-        }));
+    remark().use(function () {
+        return function (node) {
+            heading(node, 'foo', function () {
+                return [];
+            });
+        };
     }).process([
         'Foo',
         '',
@@ -285,16 +291,18 @@ test('mdast-util-heading-range()', function (t) {
         ].join('\n'), 'should replace all previous nodes otherwise');
     });
 
-    remark().use(function (processor) {
-        processor.use(heading('foo', function (start, nodes, end) {
-            return [
-                start,
-                {
-                    'type': 'horizontalRule'
-                },
-                end
-            ];
-        }));
+    remark().use(function () {
+        return function (node) {
+            heading(node, 'foo', function (start, nodes, end) {
+                return [
+                    start,
+                    {
+                        'type': 'horizontalRule'
+                    },
+                    end
+                ];
+            });
+        };
     }).process([
         'Foo',
         '',
@@ -319,12 +327,14 @@ test('mdast-util-heading-range()', function (t) {
         ].join('\n'), 'should insert all returned nodes');
     });
 
-    remark().use(function (processor) {
-        processor.use(heading('foo', function (start, nodes, end) {
-            t.equal(nodes.length, 3);
+    remark().use(function () {
+        return function (node) {
+            heading(node, 'foo', function (start, nodes, end) {
+                t.equal(nodes.length, 3);
 
-            return [start].concat(nodes, end);
-        }));
+                return [start].concat(nodes, end);
+            });
+        };
     }).process([
         '# Alpha',
         '',
