Refactor api for retext@1.0.0

Author: wooorm

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{json,mdastrc,eslintrc,sh}]
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

.eslintignore

@@ -0,0 +1,6 @@
+build/
+components/
+coverage/
+build.js
+retext-pos.js
+retext-pos.min.js

.eslintrc

@@ -1,7 +1,8 @@
 {
+  "extends": "eslint:recommended",
   "env": {
-    "node": true,
-    "browser": true
+    "browser": true,
+    "node": true
   },
   "rules": {
     "quotes": [2, "single"]

.gitignore

@@ -3,5 +3,6 @@
 bower_components/
 build/
 components/
-coverage/
 node_modules/
+coverage/
+build.js

.jscs.json

@@ -1,19 +1,27 @@
 {
-  "plugins": [
-    "jscs-jsdoc"
+  "excludeFiles": [
+    "build/",
+    "components/",
+    "coverage/",
+    "node_modules/",
+    "build.js",
+    "retext-pos.js",
+    "retext-pos.min.js"
   ],
   "jsDoc": {
     "checkAnnotations": "jsdoc3",
     "checkParamNames": true,
-    "requireParamTypes": true,
+    "checkRedundantAccess": true,
     "checkRedundantParams": true,
-    "checkReturnTypes": true,
     "checkRedundantReturns": true,
-    "requireReturnTypes": true,
+    "checkReturnTypes": true,
     "checkTypes": "strictNativeCase",
-    "checkRedundantAccess": true,
     "enforceExistence": true,
-    "requireHyphenBeforeDescription": true
+    "requireHyphenBeforeDescription": true,
+    "requireNewlineAfterDescription": true,
+    "requireParamTypes": true,
+    "requireParamDescription": true,
+    "requireReturnTypes": true
   },
   "requireCurlyBraces": [
     "if",
@@ -38,6 +46,9 @@
   "requireSpaceBeforeBlockStatements": true,
   "requireParenthesesAroundIIFE": true,
   "requireSpacesInConditionalExpression": true,
+  "requireSpacesInFunctionExpression": {
+    "beforeOpeningCurlyBrace": true
+  },
   "requireSpacesInAnonymousFunctionExpression": {
     "beforeOpeningRoundBrace": true,
     "beforeOpeningCurlyBrace": true
@@ -46,12 +57,7 @@
     "beforeOpeningRoundBrace": true,
     "beforeOpeningCurlyBrace": true
   },
-  "requireSpacesInFunctionExpression": {
-    "beforeOpeningCurlyBrace": true
-  },
-  "requireMultipleVarDecl": true,
   "requireBlocksOnNewline": true,
-  "disallowPaddingNewlinesInBlocks": true,
   "disallowEmptyBlocks": true,
   "disallowSpacesInsideObjectBrackets": true,
   "disallowSpacesInsideArrayBrackets": true,
@@ -135,10 +141,5 @@
   "requireCapitalizedConstructors": true,
   "safeContextKeyword": "self",
   "requireDotNotation": true,
-  "disallowYodaConditions": true,
-  "validateJSDoc": {
-    "checkParamNames": true,
-    "checkRedundantParams": true,
-    "requireParamTypes": true
-  }
+  "disallowYodaConditions": true
 }

.mdastignore

@@ -0,0 +1 @@
+components/

.mdastrc

@@ -0,0 +1,13 @@
+{
+  "output": true,
+  "plugins": [
+    "lint",
+    "github",
+    "comment-config",
+    "slug",
+    "validate-links"
+  ],
+  "settings": {
+    "bullet": "*"
+  }
+}

.npmignore

@@ -3,11 +3,7 @@ script: npm run-script test-travis
 node_js:
 - '0.10'
 - '0.11'
-after_script: npm install coveralls@2.10.0 && cat ./coverage/lcov.info | coveralls
-deploy:
-  provider: npm
-  email: tituswormer@gmail.com
-  api_key:
-    secure: PbT/C5VB+hTWibD0xsYQOFo5wKe9UK2stjHVQihKh7QfUYkKZc3SXdZmNceT+tSXyaSrbNRfpZlT7OGDcwtVkWsoSJqd6zFegClXrMoFd72lOChouvXnMCYxITc8z0wGkt40Gr+GvjU9EDZrdV/OtaDkJ18zJj+8zuMwjLqLk+c=
-  on:
-    repo: wooorm/retext-pos
+- '0.12'
+- iojs
+sudo: false
+after_script: npm install codecov.io && cat ./coverage/lcov.info | codecov

.travis.yml

@@ -1,110 +1,129 @@
+<!--mdast setext-->
+
+<!--lint disable no-multiple-toplevel-headings-->
+
+<!--lint disable maximum-line-length-->
 
 0.2.1 / 2015-01-18
 ==================
 
-  * Update `.gitignore` for bower
-  * Update `.npmignore` for bower
-  * Add Bower as an installation method in `Readme.md`
-  * Add `bower.json`
-  * Refactor `index.js` for updated installation methods
-  * Update `.npmignore` for component
-  * Update `.gitignore` for component
-  * Add Component as an instalation method in `Readme.md`
-  * Add `component.json`
+*   Update changelog for 0.2.1 ([dc893af](https://github.com/wooorm/retext-pos/commit/dc893af))
+*   Update `.gitignore` for bower ([9295897](https://github.com/wooorm/retext-pos/commit/9295897))
+*   Update `.npmignore` for bower ([379fa02](https://github.com/wooorm/retext-pos/commit/379fa02))
+*   Add Bower as an installation method in `Readme.md` ([03d3229](https://github.com/wooorm/retext-pos/commit/03d3229))
+*   Add `bower.json` ([558ddb3](https://github.com/wooorm/retext-pos/commit/558ddb3))
+*   Refactor `index.js` for updated installation methods ([a64e3a1](https://github.com/wooorm/retext-pos/commit/a64e3a1))
+*   Update `.npmignore` for component ([6d27ac7](https://github.com/wooorm/retext-pos/commit/6d27ac7))
+*   Update `.gitignore` for component ([94fbc76](https://github.com/wooorm/retext-pos/commit/94fbc76))
+*   Add Component as an instalation method in `Readme.md` ([b426136](https://github.com/wooorm/retext-pos/commit/b426136))
+*   Add `component.json` ([3fa175b](https://github.com/wooorm/retext-pos/commit/3fa175b))
 
 0.2.0 / 2015-01-14
 ==================
 
-  * Update copyright notice in `LICENSE` to include 2015
-  * Add link to whole license in `Readme.md`
-  * Add Duo as an instalation method in `Readme.md`
-  * Add support for duo
-  * Add links to installation methods in `Readme.md`
-  * Refactor fences code blocks in `Readme.md`
-  * Refactor to adhere to strict jsdoc style
-  * Add jscs-jsdoc configuration to `.jscs.json`
-  * Add jscs-jsdoc as a dev-dependency
-  * Refactor npm scripts for changes in npm
-  * Update eslint
-  * Refactor to use generic `changeinside` in new retext
-  * Update retext to stable release
+*   Update changelog for 0.2.0 ([68576f4](https://github.com/wooorm/retext-pos/commit/68576f4))
+*   Update copyright notice in `LICENSE` to include 2015 ([0cc8b77](https://github.com/wooorm/retext-pos/commit/0cc8b77))
+*   Add link to whole license in `Readme.md` ([34512ba](https://github.com/wooorm/retext-pos/commit/34512ba))
+*   Add Duo as an instalation method in `Readme.md` ([911d2c7](https://github.com/wooorm/retext-pos/commit/911d2c7))
+*   Add support for duo ([d7a8d1e](https://github.com/wooorm/retext-pos/commit/d7a8d1e))
+*   Add links to installation methods in `Readme.md` ([e91bf27](https://github.com/wooorm/retext-pos/commit/e91bf27))
+*   Refactor fences code blocks in `Readme.md` ([60bc007](https://github.com/wooorm/retext-pos/commit/60bc007))
+*   Refactor to adhere to strict jsdoc style ([3a18a69](https://github.com/wooorm/retext-pos/commit/3a18a69))
+*   Add jscs-jsdoc configuration to `.jscs.json` ([958cfd6](https://github.com/wooorm/retext-pos/commit/958cfd6))
+*   Add jscs-jsdoc as a dev-dependency ([2e80783](https://github.com/wooorm/retext-pos/commit/2e80783))
+*   Refactor npm scripts for changes in npm ([43fcf8b](https://github.com/wooorm/retext-pos/commit/43fcf8b))
+*   Update eslint ([889d215](https://github.com/wooorm/retext-pos/commit/889d215))
+*   Refactor to use generic `changeinside` in new retext ([deb2937](https://github.com/wooorm/retext-pos/commit/deb2937))
+*   Update retext to stable release ([1bf7542](https://github.com/wooorm/retext-pos/commit/1bf7542))
 
 0.1.9 / 2014-12-06
 ==================
 
- * Update retext
- * Add benchmark
- * Add rewording to docs in `Readme.md`
- * Refactor npm script targets in `package.json`
- * Update eslint
- * Add link to personal website to copyright in `Readme.md`
+*   Update changelog for 0.1.9 ([3f72014](https://github.com/wooorm/retext-pos/commit/3f72014))
+*   Update retext ([e7d11f0](https://github.com/wooorm/retext-pos/commit/e7d11f0))
+*   Add benchmark ([b96a908](https://github.com/wooorm/retext-pos/commit/b96a908))
+*   Add rewording to docs in `Readme.md` ([7473631](https://github.com/wooorm/retext-pos/commit/7473631))
+*   Refactor npm script targets in `package.json` ([1a5a5ee](https://github.com/wooorm/retext-pos/commit/1a5a5ee))
+*   Update eslint ([5a25b4e](https://github.com/wooorm/retext-pos/commit/5a25b4e))
+*   Add link to personal website to copyright in `Readme.md` ([82b51e2](https://github.com/wooorm/retext-pos/commit/82b51e2))
 
 0.1.8 / 2014-11-21
 ==================
 
- * Fix missing variable declaration in `test.js`
- * Refactor `Readme.md`
- * Add retext-inspect to dev-dependencies
- * Add flat badges to `Readme.md`
- * Fix incorrect executive rights on `test.js`
- * Refactor npm script targets in `package.json`
- * Add missing `.eslintrc` file
- * Update retext
+*   Update changelog for 0.1.8 ([1a5cd7c](https://github.com/wooorm/retext-pos/commit/1a5cd7c))
+*   Fix missing variable declaration in `test.js` ([410a686](https://github.com/wooorm/retext-pos/commit/410a686))
+*   Refactor `Readme.md` ([6644541](https://github.com/wooorm/retext-pos/commit/6644541))
+*   Add retext-inspect to dev-dependencies ([a205367](https://github.com/wooorm/retext-pos/commit/a205367))
+*   Add flat badges to `Readme.md` ([b3cf7f6](https://github.com/wooorm/retext-pos/commit/b3cf7f6))
+*   Fix incorrect executive rights on `test.js` ([d244879](https://github.com/wooorm/retext-pos/commit/d244879))
+*   Refactor npm script targets in `package.json` ([9ce5b0e](https://github.com/wooorm/retext-pos/commit/9ce5b0e))
+*   Add missing `.eslintrc` file ([f025dd0](https://github.com/wooorm/retext-pos/commit/f025dd0))
+*   Update retext ([fdb2077](https://github.com/wooorm/retext-pos/commit/fdb2077))
 
 0.1.7 / 2014-10-27
 ==================
 
- * Add `.eslintrc`
- * Refactor to disallow space after object keys
- * Refactor for changes in retext
- * Update eslint, mocha, retext, retext-visit, retext-content
+*   Update changelog for 0.1.7 ([3c33ef5](https://github.com/wooorm/retext-pos/commit/3c33ef5))
+*   Add `.eslintrc` ([244b8cb](https://github.com/wooorm/retext-pos/commit/244b8cb))
+*   Refactor to disallow space after object keys ([ce6de65](https://github.com/wooorm/retext-pos/commit/ce6de65))
+*   Refactor for changes in retext ([35a0077](https://github.com/wooorm/retext-pos/commit/35a0077))
+*   Update eslint, mocha, retext, retext-visit, retext-content ([55cecfe](https://github.com/wooorm/retext-pos/commit/55cecfe))
 
 0.1.6 / 2014-10-21
 ==================
 
- * Refactor test
- * Refactor .jscs.json
- * Update retext
+*   Update changelog for 0.1.6 ([4798952](https://github.com/wooorm/retext-pos/commit/4798952))
+*   Refactor test ([cf119ec](https://github.com/wooorm/retext-pos/commit/cf119ec))
+*   Refactor .jscs.json ([51e4a87](https://github.com/wooorm/retext-pos/commit/51e4a87))
+*   Update retext ([04fec58](https://github.com/wooorm/retext-pos/commit/04fec58))
 
 0.1.5 / 2014-10-14
 ==================
 
- * Fix test for retext-visit@0.2.0
+*   Update changelog for 0.1.5 ([155a14d](https://github.com/wooorm/retext-pos/commit/155a14d))
+*   Fix test for retext-visit@0.2.0 ([5445602](https://github.com/wooorm/retext-pos/commit/5445602))
 
 0.1.4 / 2014-10-14
 ==================
 
- * Update retext, retext-visit
- * Update .gitignore .npmignore
- * Move spec to test.js
+*   Update changelog for 0.1.4 ([e7925e2](https://github.com/wooorm/retext-pos/commit/e7925e2))
+*   Update retext, retext-visit ([ef32908](https://github.com/wooorm/retext-pos/commit/ef32908))
+*   Update .gitignore .npmignore ([c7d393e](https://github.com/wooorm/retext-pos/commit/c7d393e))
+*   Move spec to test.js ([b991ac5](https://github.com/wooorm/retext-pos/commit/b991ac5))
 
 0.1.3 / 2014-09-25
 ==================
 
- * Refactor Readme.md
- * Refactor API
- * Add npm deployment to travis
- * Remove `npm update` from travis
- * Remove browser test
- * Update .gitignore, .npmignore
- * Update Installation in docs
- * Fix property order in package.json
- * Update copyright in Readme.md
- * Remove testling
- * Refactor spec
- * Add retext-content as a dev-dependency
- * Update eslint, retext
+*   Update changelog for 0.1.3 ([6173dac](https://github.com/wooorm/retext-pos/commit/6173dac))
+*   Refactor Readme.md ([d39da1f](https://github.com/wooorm/retext-pos/commit/d39da1f))
+*   Refactor API ([aca12de](https://github.com/wooorm/retext-pos/commit/aca12de))
+*   Add npm deployment to travis ([8d0d4f6](https://github.com/wooorm/retext-pos/commit/8d0d4f6))
+*   Remove `npm update` from travis ([c917ad4](https://github.com/wooorm/retext-pos/commit/c917ad4))
+*   Remove browser test ([e2a23fc](https://github.com/wooorm/retext-pos/commit/e2a23fc))
+*   Update .gitignore, .npmignore ([58f089c](https://github.com/wooorm/retext-pos/commit/58f089c))
+*   Update Installation in docs ([469df29](https://github.com/wooorm/retext-pos/commit/469df29))
+*   Fix property order in package.json ([dedc6ec](https://github.com/wooorm/retext-pos/commit/dedc6ec))
+*   Update copyright in Readme.md ([4d2eb77](https://github.com/wooorm/retext-pos/commit/4d2eb77))
+*   Remove testling ([6c5c1e2](https://github.com/wooorm/retext-pos/commit/6c5c1e2))
+*   Refactor spec ([8655148](https://github.com/wooorm/retext-pos/commit/8655148))
+*   Add retext-content as a dev-dependency ([0c3f439](https://github.com/wooorm/retext-pos/commit/0c3f439))
+*   Update eslint, retext ([a40f409](https://github.com/wooorm/retext-pos/commit/a40f409))
 
 0.1.2 / 2014-07-31
 ==================
 
- * Fix a bug where on remove a parent would not recalculate (fixes #2)
+*   Update changelog for 0.1.2 ([4b0ee36](https://github.com/wooorm/retext-pos/commit/4b0ee36))
+*   Fix a bug where on remove a parent would not recalculate (fixes [#2](https://github.com/wooorm/retext-pos/issues/2)) ([d38ec14](https://github.com/wooorm/retext-pos/commit/d38ec14))
 
 0.1.1 / 2014-07-24
 ==================
 
- * Update usage example with new sample text
- * Fixed awareness of surrounding words
- * Update mocha to 1.21.0
- * Add retext as a peer dependency
- * Add spec/browser.spec.js to gitignore
+*   Update changelog for 0.1.1 ([1935a23](https://github.com/wooorm/retext-pos/commit/1935a23))
+*   Update usage example with new sample text ([ef5b29f](https://github.com/wooorm/retext-pos/commit/ef5b29f))
+*   Fixed awareness of surrounding words ([b92cde1](https://github.com/wooorm/retext-pos/commit/b92cde1))
+*   Update mocha to 1.21.0 ([e026a7c](https://github.com/wooorm/retext-pos/commit/e026a7c))
+*   Add retext as a peer dependency ([d48f778](https://github.com/wooorm/retext-pos/commit/d48f778))
+*   Add spec/browser.spec.js to gitignore ([8a85552](https://github.com/wooorm/retext-pos/commit/8a85552))
+
+0.0.1 / 2014-07-15
+==================