retext-keywords
Advanced tools
Comparing version 0.1.4 to 0.1.5
{ | ||
"name": "retext-keywords", | ||
"version": "0.1.4", | ||
"version": "0.1.5", | ||
"description": "Keyword extraction with Retext", | ||
@@ -25,3 +25,3 @@ "license": "MIT", | ||
"devDependencies": { | ||
"eslint": "^0.9.0", | ||
"eslint": "^0.10.0", | ||
"istanbul": "^0.3.0", | ||
@@ -31,3 +31,3 @@ "jscs": "^1.0.0", | ||
"mocha": "^2.0.0", | ||
"retext": "^0.4.0" | ||
"retext": "^0.5.0-rc.1" | ||
}, | ||
@@ -38,3 +38,2 @@ "scripts": { | ||
"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", | ||
@@ -44,2 +43,3 @@ "lint-test": "node_modules/.bin/eslint test.js --env mocha", | ||
"lint-style": "node_modules/.bin/jscs index.js test.js benchmark.js --reporter=inline", | ||
"lint": "npm run lint-api && npm run lint-test && npm run lint-benchmark && npm run lint-style", | ||
"make": "npm run lint && npm run coverage", | ||
@@ -46,0 +46,0 @@ "benchmark": "node_modules/.bin/matcha benchmark.js" |
@@ -89,3 +89,3 @@ # retext-keywords [![Build Status](https://img.shields.io/travis/wooorm/retext-keywords.svg?style=flat)](https://travis-ci.org/wooorm/retext-keywords) [![Coverage Status](https://img.shields.io/coveralls/wooorm/retext-keywords.svg?style=flat)](https://coveralls.io/r/wooorm/retext-keywords?branch=master) | ||
### [TextOM.Parent](https://github.com/wooorm/textom#textomparent-nlcstparent)#keywords({minimum=5}?) | ||
### [TextOM.Parent](https://github.com/wooorm/textom#textomparent-nlcstparent)#keywords(options?) | ||
@@ -103,3 +103,3 @@ Extract keywords, based on the number of times they (nouns) occur in text. | ||
- minimum: Return at least (when possible) `minimum` keywords. | ||
- minimum (non-negative integer `number`) — Return at least (when possible) `minimum` keywords. | ||
@@ -109,6 +109,6 @@ Results: An array, containing match-objects: | ||
- stem: The stem of the word (see [retext-porter-stemmer](https://github.com/wooorm/retext-porter-stemmer/)); | ||
- score: A value between 0 and (including) 1. the first match has a score of 1; | ||
- nodes: An array containing all matched word nodes. | ||
- score: A value between `0` and (including) `1`. The first match has a score of 1; | ||
- nodes: An array containing all matched [`WordNode`](https://github.com/wooorm/textom#textomwordnode-nlcstwordnode)s. | ||
### [TextOM.Parent](https://github.com/wooorm/textom#textomparent-nlcstparent)#keyphrases({minimum=5}?) | ||
### [TextOM.Parent](https://github.com/wooorm/textom#textomparent-nlcstparent)#keyphrases(options?) | ||
@@ -157,3 +157,3 @@ Extract keyphrases, based on the number of times they (one or more nouns) occur in text. | ||
- minimum: Return at least (when possible) `minimum` phrases. | ||
- minimum (non-negative integer `number`) — Return at least (when possible) `minimum` phrases. | ||
@@ -163,4 +163,4 @@ Results: An array, containing match-objects: | ||
- stems: An array containing the stems of all matched word nodes inside the phrase(s); | ||
- score: A value between 0 and (including) 1. the first match has a score of 1; | ||
- nodes: An array containing array-phrases, each containing word nodes. | ||
- score: A value between `0` and (including) `1`. The first match has a score of 1; | ||
- nodes: An array containing arrays of [`WordNode`](https://github.com/wooorm/textom#textomwordnode-nlcstwordnode)s. | ||
@@ -173,8 +173,8 @@ ## Benchmark | ||
A big section (10 paragraphs) | ||
3,784 op/s » Finding keywords | ||
788 op/s » Finding keyphrases | ||
4,026 op/s » Finding keywords | ||
625 op/s » Finding keyphrases | ||
A big article (100 paragraphs) | ||
401 op/s » Finding keywords | ||
48 op/s » Finding keyphrases | ||
438 op/s » Finding keywords | ||
59 op/s » Finding keyphrases | ||
``` | ||
@@ -184,2 +184,2 @@ | ||
MIT © Titus Wormer | ||
MIT © [Titus Wormer](http://wooorm.com) |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
17702