Add support for onparse, onstringify callbacks

wooorm · Mar 27, 2015 · a34166e · a34166e
1 parent 784088e
commit a34166e
Show file tree

Hide file tree

Showing 5 changed files with 82 additions and 2 deletions.
diff --git a/Readme.md b/Readme.md
@@ -109,7 +109,9 @@ Adds a `yaml` property to [**YAML**](https://github.com/wooorm/mdast/blob/master
     *   `library` (`Object?`, default: [`nodeca/js-yaml`](https://github.com/nodeca/js-yaml));
     *   `parse` (`string?`, default [`"safeLoad"`](https://github.com/nodeca/js-yaml#safeload-string---options-));
     *   `stringify` (`string?`, default [`"safeDump"`](https://github.com/nodeca/js-yaml#safedump-object---options-));
-    *   `prettify` (`boolean?`, default: `true`) — When true, the node’s content will be overwritten by the result of `library[stringify](node.yaml)`.
+    *   `prettify` (`boolean?`, default: `true`) — When true, the node’s content will be overwritten by the result of `library[stringify](node.yaml)`;
+    *   `onparse` (`function(Node)`, default `function () {}`) — Invoked when YAML is parsed, during parsing;
+    *   `onstringify` (`function(Node)`, default `function () {}`) — Invoked when YAML is stringified, during stringification.
 
 ## License
 

diff --git a/index.js b/index.js
@@ -10,6 +10,11 @@ try {
     jsYAML = require('js-yaml');
 } catch (exception) {}
 
+/**
+ * No-operation.
+ */
+function noop() {}
+
 /**
  * Remove trailing newline.
  *
@@ -31,6 +36,7 @@ function removeLastLine(value) {
 function parse(tokenize, settings) {
     var parser = settings.library || jsYAML;
     var method = settings.parse || 'safeLoad';
+    var callback = settings.onparse || noop;
 
     /**
      * Parse YAML, if available, using the bound
@@ -52,6 +58,8 @@ function parse(tokenize, settings) {
         });
 
         eat($0)(node);
+
+        callback(node, this);
     };
 }
 
@@ -64,6 +72,7 @@ function parse(tokenize, settings) {
 function stringify(compile, settings) {
     var stringifier = settings.library || jsYAML;
     var method = settings.stringify || 'safeDump';
+    var callback = settings.onstringify || noop;
 
     if (settings.prettify === false) {
         return compile;
@@ -81,6 +90,8 @@ function stringify(compile, settings) {
             node.value = removeLastLine(stringifier[method](node.yaml));
         }
 
+        callback(node, this);
+
         return compile.apply(this, arguments);
     };
 }

diff --git a/mdast-yaml.js b/mdast-yaml.js
@@ -11,6 +11,11 @@ try {
     jsYAML = require('js-yaml');
 } catch (exception) {}
 
+/**
+ * No-operation.
+ */
+function noop() {}
+
 /**
  * Remove trailing newline.
  *
@@ -32,6 +37,7 @@ function removeLastLine(value) {
 function parse(tokenize, settings) {
     var parser = settings.library || jsYAML;
     var method = settings.parse || 'safeLoad';
+    var callback = settings.onparse || noop;
 
     /**
      * Parse YAML, if available, using the bound
@@ -53,6 +59,8 @@ function parse(tokenize, settings) {
         });
 
         eat($0)(node);
+
+        callback(node, this);
     };
 }
 
@@ -65,6 +73,7 @@ function parse(tokenize, settings) {
 function stringify(compile, settings) {
     var stringifier = settings.library || jsYAML;
     var method = settings.stringify || 'safeDump';
+    var callback = settings.onstringify || noop;
 
     if (settings.prettify === false) {
         return compile;
@@ -82,6 +91,8 @@ function stringify(compile, settings) {
             node.value = removeLastLine(stringifier[method](node.yaml));
         }
 
+        callback(node, this);
+
         return compile.apply(this, arguments);
     };
 }

diff --git a/mdast-yaml.min.js b/mdast-yaml.min.js
diff --git a/test/index.js b/test/index.js
@@ -143,4 +143,60 @@ describe('mdast-yaml()', function () {
         assert('yaml' in ast);
         assert(ast.yaml === 'hello');
     });
+
+    it('should accept `onparse`', function () {
+        var isInvoked;
+
+        /**
+         * Assertion.
+         */
+        function onparse(node) {
+            assert(node.type === 'yaml');
+            assert(node.value === '"hello": "world"');
+            assert(node.yaml.hello === 'world');
+
+            isInvoked = true;
+        }
+
+        yaml([
+            '---',
+            '"hello": "world"',
+            '---',
+            '',
+            '# Foo bar',
+            ''
+        ].join('\n'), {
+            'onparse': onparse
+        });
+
+        assert(isInvoked === true);
+    });
+
+    it('should accept `onstringify`', function () {
+        var isInvoked;
+
+        /**
+         * Assertion.
+         */
+        function onstringify(node) {
+            assert(node.type === 'yaml');
+            assert(node.value === 'hello: world');
+            assert(node.yaml.hello === 'world');
+
+            isInvoked = true;
+        }
+
+        yaml([
+            '---',
+            '"hello": "world"',
+            '---',
+            '',
+            '# Foo bar',
+            ''
+        ].join('\n'), {
+            'onstringify': onstringify
+        });
+
+        assert(isInvoked === true);
+    });
 });