retext - npm Package Compare versions

Comparing version 0.1.0-rc.2 to 0.1.0-rc.3

component.json

@@ -5,3 +5,3 @@ {
   "description": "Extensible system for analysing and manipulating natural language",
-  "version": "0.1.0-rc.2",
+  "version": "0.1.0-rc.3",
   "keywords": [
@@ -17,3 +17,4 @@ "natural",
   "dependencies": {
-    "wooorm/parse-english": "^0.0.23"
+    "parse-latin": "^0.1.0-rc.6",
+    "textom": "^0.1.0-rc.3"
   },
@@ -20,0 +21,0 @@ "scripts" : [

History.md

 
+0.1.0-rc.3 / 2014-07-12
+==================
+
+ * Update dependencies in component.json
+ * Removed functionality to pass strings to the Retext constructor
+ * Added an example to the Retext docs on how to use custom parsers
+ * Added a missing semicolon
+ * Retext now exposes an `applyPlugins` method (fixes #8)
+ * Added unit tests for Retext#applyPlugins
+
 0.1.0-rc.2 / 2014-07-11
@@ -3,0 +13,0 @@ ==================

index.js

 'use strict';
 
-var TextOMConstructor = require('textom');
+var TextOMConstructor = require('textom'),
+    ParseLatin = require('parse-latin');
 
@@ -44,4 +45,3 @@ function fromAST(TextOM, ast) {
  *
- * @param {(Object|String)?} parser - the parser, or its name, to use.
- *                                    Defaults to "parse-latin".
+ * @param {Function?} parser - the parser to use. Defaults to parse-latin.
  * @api public
@@ -54,17 +54,5 @@ * @constructor
     if (!parser) {
-        parser = 'parse-latin';
+        parser = new ParseLatin();
     }
 
-    if (typeof parser === 'string') {
-        /* istanbul ignore else: TODO / TOSPEC */
-        /* Load the parser for vendors without dynamic-require's */
-        if (parser === 'parse-latin') {
-            parser = require('parse-latin');
-        } else {
-            parser = require(parser);
-        }
-
-        parser = parser();
-    }
-
     self.parser = parser;
@@ -117,2 +105,19 @@ self.TextOM = parser.TextOM = new TextOMConstructor();
  *
+ * @param {String?} source - The source to convert.
+ * @return {Node} - A RootNode containing the tokenised source.
+ * @api public
+ */
+Retext.prototype.parse = function (source) {
+    var self = this,
+        rootNode = fromAST(self.TextOM, self.parser.tokenizeRoot(source));
+
+    self.applyPlugins(rootNode);
+
+    return rootNode;
+};
+
+/**
+ * `Retext#applyPlugins` applies the plugins bound to the retext instance to a
+ * given tree.
+ *
  * Note that, during the parsing stage, when the `use` plugin is called
@@ -122,23 +127,18 @@ * by a plugin, the nested plugin is immediately called, before continuing
  *
- * @param {(String|Node)?} source - The source to convert.
- * @return {Node} - A RootNode containing the tokenised source.
+ * @param {Node} tree - The tree to apply plugins to.
  * @api public
  */
-Retext.prototype.parse = function (source) {
+Retext.prototype.applyPlugins = function (tree) {
     var self = this,
-        parser = self.parser,
         plugins = self.plugins.concat(),
         iterator = -1,
-        use = self.use,
-        rootNode = fromAST(self.TextOM, parser.tokenizeRoot(source));
+        use = self.use;
 
-    self.use = useImmediately(rootNode, use);
+    self.use = useImmediately(tree, use);
 
     while (plugins[++iterator]) {
-        plugins[iterator](rootNode, this);
+        plugins[iterator](tree, this);
     }
 
     self.use = use;
-
-    return rootNode;
 };
@@ -145,0 +145,0 @@

package.json

 {
   "name": "retext",
-  "version": "0.1.0-rc.2",
+  "version": "0.1.0-rc.3",
   "description": "Extensible system for analysing and manipulating natural language",
@@ -5,0 +5,0 @@ "keywords": [

Readme.md

@@ -42,3 +42,3 @@ # ![Retext logo](http://i58.tinypic.com/5xpx5z.png)
         'who hears no evil; and Iwazaru (:speak_no_evil:), ' +
-        'covering his mouth, who speaks no evil.'
+        'covering his mouth, who speaks no evil.';
 
@@ -66,5 +66,11 @@ var text = new Retext()
 ### Retext(parser)
+```js
+var Retext = require('retext'),
+    ParseEnglish = require('parse-english');
 
-Return a new `Retext` instance with the given parser (defaults to `"parse-english"`).
+var retext = new Retext(new ParseEnglish()).parse(/* ...some english... */);
+```
 
+Return a new `Retext` instance with the given parser (defaults to parse-latin).
+
 ### Retext.prototype.use(plugin)
@@ -71,0 +77,0 @@

spec/retext.spec.js

@@ -240,1 +240,8 @@ 'use strict';
 });
+
+describe('Retext#applyPlugins', function () {
+    it('should be of type `function`', function () {
+        assert(typeof Retext.prototype.applyPlugins === 'function');
+        assert(typeof (new Retext()).applyPlugins === 'function');
+    });
+});

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

29903

increased by2.29%

Lines of code

537

increased by1.32%

Number of lines in readme file

116

increased by5.45%

Number of low supply chain risk alerts

0

decreased by-100%

No dependency changes