refactor(responsibilities): use documentation.js

#44,#187
gregswindle · Feb 21, 2018 · addbef8 · addbef8
1 parent d8ec2b3
commit addbef8
Show file tree

Hide file tree

Showing 74 changed files with 1,861 additions and 627 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -0,0 +1,39 @@
+# Javascript Node CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-javascript/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: circleci/node:8.9.4
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/mongo:3.4.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "package.json" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run: npm install
+
+      - save_cache:
+          paths:
+            - node_modules
+          key: v1-dependencies-{{ checksum "package.json" }}
+
+      # run tests!
+      - run: npm test
+
+
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -884,27 +884,28 @@
 <!-- AUTO-GENERATED-CONTENT:START (DEPENDENCYTABLE) -->
 | **Dependency** | **Description** | **Version** | **License** | **Type** |
 | -------------- | --------------- | ----------- | ----------- | -------- |
- | [boom@3.1.3](https://github.com/hapijs/boom#readme) | HTTP-friendly error objects | 3.1.3 | BSD-3-Clause | production | 
+ | [boom@7.1.1](https://github.com/hapijs/boom#readme) | HTTP-friendly error objects | 7.1.1 | BSD-3-Clause | production | 
  | [bunyan@1.8.12](https://github.com/trentm/node-bunyan#readme) | a JSON logging library for node.js services | 1.8.12 | MIT | production | 
  | [catharsis@0.8.9](https://github.com/hegemonic/catharsis#readme) | A JavaScript parser for Google Closure Compiler and JSDoc type expressions. | 0.8.9 | MIT | production | 
  | [chalk@2.3.1](https://github.com/chalk/chalk#readme) | Terminal string styling done right | 2.3.1 | MIT | production | 
  | [compromise@11.4.0](https://github.com/nlp-compromise/compromise#readme) | natural language processing in the browser | 11.4.0 | MIT | production | 
- | [cryptiles@3.0.0](https://github.com/hapijs/cryptiles#readme) | General purpose crypto utilities | 3.0.0 | BSD-3-Clause | production | 
- | [debug@2.6.9](https://github.com/visionmedia/debug#readme) | small debugging utility | 2.6.9 | MIT | production | 
+ | [cryptiles@4.1.1](https://github.com/hapijs/cryptiles#readme) | General purpose crypto utilities | 4.1.1 | BSD-3-Clause | production | 
+ | [debug@3.1.0](https://github.com/visionmedia/debug#readme) | small debugging utility | 3.1.0 | MIT | production | 
  | [doctrine@2.1.0](https://github.com/eslint/doctrine) | JSDoc parser | 2.1.0 | Apache-2.0 | production | 
  | [documentation@5.4.0](https://github.com/documentationjs/documentation#readme) | a documentation generator | 5.4.0 | ISC | production | 
  | [escomplex@2.0.0-alpha](https://github.com/jared-stilwell/escomplex) | Software complexity analysis of JavaScript-family abstract syntax trees. | 2.0.0-alpha | MIT | production | 
- | [eslint@4.18.0](https://eslint.org) | An AST-based pattern checker for JavaScript. | 4.18.0 | MIT | production | 
+ | [eslint@4.18.1](https://eslint.org) | An AST-based pattern checker for JavaScript. | 4.18.1 | MIT | production | 
  | [eslint-scope@3.7.1](http://github.com/eslint/eslint-scope) | ECMAScript scope analyzer for ESLint | 3.7.1 | BSD-2-Clause | production | 
  | [espree@3.5.3](https://github.com/eslint/espree) | An Esprima-compatible JavaScript parser built on Acorn | 3.5.3 | BSD-2-Clause | production | 
  | [esquery@1.0.0](https://github.com/jrfeenst/esquery#readme) | A query library for ECMAScript AST using a CSS selector like query language. | 1.0.0 | BSD | production | 
  | [estraverse@4.2.0](https://github.com/estools/estraverse) | ECMAScript JS AST traversal functions | 4.2.0 | BSD-2-Clause | production | 
  | [fs-extra@5.0.0](https://github.com/jprichardson/node-fs-extra) | fs-extra contains methods that aren't included in the vanilla Node.js fs package. Such as mkdir -p, cp -r, and rm -rf. | 5.0.0 | MIT | production | 
- | [hawk@5.0.0](https://github.com/hueniverse/hawk#readme) | HTTP Hawk Authentication Scheme | 5.0.0 | BSD-3-Clause | production | 
+ | [hawk@7.0.7](https://github.com/hueniverse/hawk#readme) | HTTP Hawk Authentication Scheme | 7.0.7 | BSD-3-Clause | production | 
  | [lodash@4.17.5](https://lodash.com/) | Lodash modular utilities. | 4.17.5 | MIT | production | 
+ | [markdown-it@8.4.1](https://github.com/markdown-it/markdown-it#readme) | Markdown-it - modern pluggable markdown parser. | 8.4.1 | MIT | production | 
  | [markdown-toc@1.2.0](https://github.com/jonschlinkert/markdown-toc) | Generate a markdown TOC (table of contents) with Remarkable. | 1.2.0 | MIT | production | 
  | [meow@4.0.0](https://github.com/sindresorhus/meow#readme) | CLI app helper | 4.0.0 | MIT | production | 
- | [request@2.82.0](https://github.com/request/request#readme) | Simplified HTTP request client. | 2.82.0 | Apache-2.0 | production | 
+ | [request@2.83.0](https://github.com/request/request#readme) | Simplified HTTP request client. | 2.83.0 | Apache-2.0 | production | 
  | [requireindex@1.2.0](https://github.com/stephenhandley/requireindex) | Write minimal node index.js files that require and export siblings by file basename | 1.2.0 | MIT | production | 
  | [@semantic-release/changelog@1.0.1](https://github.com/semantic-release/changelog#readme) | Set of semantic-release plugins for creating or updating a changelog file | 1.0.1 | MIT | dev | 
  | [@semantic-release/git@3.0.1](https://github.com/semantic-release/git#readme) | Set of semantic-release plugins to publish to a git repository | 3.0.1 | MIT | dev | 
@@ -916,22 +917,22 @@
  | [eslint-config-scanjs@1.0.0-beta4](https://github.com/mozfreddyb/eslint-config-scanjs#readme) | umbrella config to get scanjs-like functionality from eslint | 1.0.0-beta4 | MPL-2.0 | dev | 
  | [eslint-config-xo-space@0.18.0](https://github.com/xojs/eslint-config-xo-space#readme) | ESLint shareable config for XO with 2-space indent | 0.18.0 | MIT | dev | 
  | [eslint-plugin-import@2.8.0](https://github.com/benmosher/eslint-plugin-import) | Import with sanity. | 2.8.0 | MIT | dev | 
- | [eslint-plugin-jsdoc@3.4.1](https://github.com/gajus/eslint-plugin-jsdoc#readme) | JSDoc linting rules for ESLint. | 3.4.1 | BSD-3-Clause | dev | 
+ | [eslint-plugin-jsdoc@3.5.0](https://github.com/gajus/eslint-plugin-jsdoc#readme) | JSDoc linting rules for ESLint. | 3.5.0 | BSD-3-Clause | dev | 
  | [eslint-plugin-node@6.0.0](https://github.com/mysticatea/eslint-plugin-node#readme) | Additional ESLint's rules for Node.js | 6.0.0 | MIT | dev | 
  | [eslint-plugin-promise@3.6.0](https://github.com/xjamundx/eslint-plugin-promise#readme) | Enforce best practices for JavaScript promises | 3.6.0 | ISC | dev | 
  | [eslint-plugin-scanjs-rules@0.2.1](https://github.com/mozfreddyb/eslint-plugin-scanjs-rules/) | ESLint plugin that contains ScanJS rules | 0.2.1 | MPL-2.0 | dev | 
  | [eslint-plugin-security@1.4.0](https://github.com/nodesecurity/eslint-plugin-security#readme) | Security rules for eslint | 1.4.0 | Apache-2.0 | dev | 
  | [eslint-plugin-standard@3.0.1](https://github.com/xjamundx/eslint-plugin-standard#readme) | ESlint Plugin for the Standard Linter | 3.0.1 | MIT | dev | 
  | [eslint-plugin-unicorn@4.0.2](https://github.com/sindresorhus/eslint-plugin-unicorn#readme) | Various awesome ESLint rules | 4.0.2 | MIT | dev | 
  | [eslint-plugin-xss@0.1.9](https://github.com/Rantanen/eslint-plugin-xss#readme) | Validates XSS related issues of mixing HTML and non-HTML content in variables. | 0.1.9 | ISC | dev | 
- | [hoek@4.2.1](https://github.com/hapijs/hoek#readme) | General purpose node utilities | 4.2.1 | BSD-3-Clause | dev | 
+ | [hoek@5.0.3](https://github.com/hapijs/hoek#readme) | General purpose node utilities | 5.0.3 | BSD-3-Clause | dev | 
  | [jsdoc@3.5.5](https://github.com/jsdoc3/jsdoc#readme) | An API documentation generator for JavaScript. | 3.5.5 | Apache-2.0 | dev | 
  | [lec@^1.0.1](https://github.com/iShafayet/lec) | Command Line Wrapper for Line Ending Corrector (An utility that makes sure your files have consistent line endings) | 1.0.1 | MIT | dev | 
  | [markdown-magic@0.1.20](https://github.com/DavidWells/markdown-magic#readme) | Automatically update markdown files with content from external sources | 0.1.20 | MIT | dev | 
  | [markdown-magic-dependency-table@1.3.2](https://github.com/camacho/markdown-magic-dependency-table#readme) | Generate table of information about dependencies automatically in markdown | 1.3.2 | MIT | dev | 
  | [markdown-magic-package-scripts@1.2.1](https://github.com/camacho/markdown-magic-package-scripts#readme) | Print list of scripts in package.json with descriptions | 1.2.1 | MIT | dev | 
  | [mocha@5.0.1](https://mochajs.org) | simple, flexible, fun test framework | 5.0.1 | MIT | dev | 
- | [nodemon@1.15.0](http://nodemon.io) | Simple monitor script for use during development of a node.js app. | 1.15.0 | MIT | dev | 
+ | [nodemon@1.15.1](http://nodemon.io) | Simple monitor script for use during development of a node.js app. | 1.15.1 | MIT | dev | 
  | [nsp@3.2.1](https://github.com/nodesecurity/nsp#readme) | The Node Security (nodesecurity.io) command line interface | 3.2.1 | Apache-2.0 | dev | 
  | [nyc@11.4.1](https://github.com/istanbuljs/nyc#readme) | the Istanbul command line interface | 11.4.1 | ISC | dev | 
  | [properties-parser@0.3.1](https://github.com/xavi-/node-properties-parser#readme) | A parser for .properties files written in javascript | 0.3.1 | MIT | dev |