retext - npm Package Compare versions

Comparing version 0.4.0 to 0.5.0-rc.1

package.json

 {
   "name": "retext",
-  "version": "0.4.0",
+  "version": "0.5.0-rc.1",
   "description": "Extensible system for analysing and manipulating natural language",
@@ -16,5 +16,5 @@ "license": "MIT",
   "dependencies": {
-    "nlcst-to-textom": "^0.1.0",
+    "nlcst-to-textom": "^0.2.0",
     "parse-latin": "^0.4.0",
-    "textom": "^0.3.1",
+    "textom": "^0.4.0-rc.2",
     "ware": "^1.2.0"
@@ -28,3 +28,3 @@ },
   "devDependencies": {
-    "eslint": "^0.9.0",
+    "eslint": "^0.10.0",
     "istanbul": "^0.3.0",
@@ -39,3 +39,2 @@ "jscs": "^1.0.0",
     "coverage": "node_modules/.bin/istanbul cover node_modules/.bin/_mocha -- -- test.js",
-    "lint": "npm run lint-api && npm run lint-test && npm run lint-benchmark && npm run lint-style",
     "lint-api": "node_modules/.bin/eslint index.js",
@@ -45,5 +44,6 @@ "lint-test": "node_modules/.bin/eslint test.js --env mocha",
     "lint-style": "node_modules/.bin/jscs index.js test.js benchmark.js --reporter=inline",
-    "benchmark": "node_modules/.bin/matcha benchmark.js",
-    "make": "npm run lint && npm run coverage"
+    "lint": "npm run lint-api && npm run lint-test && npm run lint-benchmark && npm run lint-style",
+    "make": "npm run lint && npm run coverage",
+    "benchmark": "node_modules/.bin/matcha benchmark.js"
   }
 }

Readme.md

@@ -87,3 +87,3 @@ # ![Retext](https://cdn.rawgit.com/wooorm/retext/master/logo.svg)
 /* There, ol’ chap. */
-retext.parse(/* ...some English... */, function (err, tree) {/* ... */});
+retext.parse('Some English', function (err, tree) {/* ... */});
 ```
@@ -93,8 +93,8 @@
 
-### Retext#use([plugin](plugin), options?)
+### Retext#use([plugin](#plugin), options?)
 
 Takes a plugin—a humble function to transform the object model.
-Optionally takes an `options` object, but its up to plugin authors to support settings.
+Optionally takes an `options` object, but it’s up to plugin authors to support settings.
 
-### Retext#parse(value, options?, function(Error, NLCSTNode))
+### Retext#parse(value, options?, done(err, tree))
 
@@ -107,8 +107,8 @@ Parses the given source and, when done, passes either an error (the first argument), or the (by `use`d plugins, modified) document (the second argument) to the callback.
 
-The plugin can return another function: `function(NLCSTNode, options, next?)`. This function is invokeded when a document is parsed. It’s given the document as created by `Retext#parse()` before its given to the user.
+The plugin can return another function: `function(NLCSTNode, options, next?)`. This function is invokeded when a document is parsed. It’s given the document as created by `Retext#parse()` before it’s given to the user.
 
 ## Plugins
 
-- [retext-ast](https://github.com/wooorm/retext-ast) — Encoding and decoding between AST (JSON) and TextOM object model;
 - [retext-content](https://github.com/wooorm/retext-content) — Append, prepend, remove, and replace content into/from Retext nodes;
+- [retext-cst](https://github.com/wooorm/retext-ast) — Encoding and decoding between AST (JSON) and TextOM object model;
 - [retext-directionality](https://github.com/wooorm/retext-directionality) — (**[demo](http://wooorm.github.io/retext-directionality/)**) — Detect the direction text is written in;
@@ -133,3 +133,3 @@ - [retext-dom](https://github.com/wooorm/retext-dom) — (**[demo](http://wooorm.github.io/retext-dom/)**) — Create a (living) DOM tree from a TextOM tree;
 - [retext-soundex](https://github.com/wooorm/retext-soundex) — (**[demo](http://wooorm.github.io/retext-soundex/)**) — Implementation of the Soundex algorithm;
-- [retext-syllable](https://github.com/wooorm/retext-syllable) — Syllable count;
+- [retext-syllable](https://github.com/wooorm/retext-syllable) — (**[demo](http://wooorm.github.io/retext-syllable/)**) — Syllable count;
 - [retext-visit](https://github.com/wooorm/retext-visit) — (**[demo](http://wooorm.github.io/retext-visit/)**) — Visit nodes, optionally by type;
@@ -144,3 +144,2 @@ - [retext-walk](https://github.com/wooorm/retext-walk) — Walk trees, optionally by type.
 - retext-date — Detect time and date in text;
-- retext-emoticon — Like **retext-emoji**, but for general emoticons;
 - retext-frequent-words — Like **retext-keywords**, but based on frequency and stop-words instead of a POS-tagger;
@@ -166,8 +165,8 @@ - retext-hyphen — Insert soft-hyphens where needed; this might have to be implemented with some sort of node which doesn’t stringify;
 
-On a MacBook Air, it parses about 2 big articles, 22 sections, or 202 paragraphs per second.
+On a MacBook Air, it parses about 2 big articles, 25 sections, or 230 paragraphs per second.
 
 ```
-              retext.parse(source);
-  202 op/s » A paragraph (5 sentences, 100 words)
-   22 op/s » A section (10 paragraphs, 50 sentences, 1,000 words)
+           retext.parse(value, callback);
+  230 op/s » A paragraph (5 sentences, 100 words)
+   25 op/s » A section (10 paragraphs, 50 sentences, 1,000 words)
     2 op/s » An article (100 paragraphs, 500 sentences, 10,000 words)
@@ -183,2 +182,2 @@ ```
 
-MIT © Titus Wormer
+MIT © [Titus Wormer](http://wooorm.com)

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

Improved metrics

Total package byte prevSize

18496

increased by0.06%

Worsened metrics

Number of lines in readme file

177

decreased by-0.56%

Dependency changes

• + Addednlcst-to-textom@0.2.1(transitive)

• + Addedtextom@0.4.1(transitive)

• - Removednlcst-to-textom@0.1.0(transitive)

• - Removedtextom@0.3.1(transitive)

• Updatednlcst-to-textom@^0.2.0

• Updatedtextom@^0.4.0-rc.2