fix(codacy-coverage): update to v3.0.0

* fix(lint-staged): update to version 7.0.5

* style(color): make colors consistent

Make badge colors with GitHub issue and PR status colors, and create
greater contrast for the contributing button.

* test(jest): extend timeout for api tests

Add done calls

* test(jest): extend timeout for api tests

Add done calls

* test(jest): extend timeout for api tests

Add done calls

* fix(codacy-coverage): update to version 3.0.0

* fix(codacy-coverage): update to v3.0.0

Author: greenkeeper[bot]

.env.defaults

@@ -10,19 +10,21 @@
 
 # ENV VARS defaults for readme-inspector:
 
-# ReadmeAppraisal
+# ReadmeAppraisal REST API
+# 💼 Modify this if you are using a company hosted installation.
 API_ENDPOINT_README_SCORE="http://readme-score-api.herokuapp.com/score.json?url=&human_breakdown=false&force=false"
 
-# Bitbucket REST API v1.0 and v2.0 base url. Modify this if you're using
-# on-premise, company-hosted Bitbucket servers.
+# Bitbucket REST API v1.0 and v2.0 base url.
+# 💼 Modify this if you're using on-premise, company-hosted Bitbucket servers.
 BITBUCKET_API_BASE_URL="https://api.bitbucket.org"
 
 ## Google Analytics trackingCode
 GA_README_INSPECTOR="UA-117338111-1"
 
-# GitHub REST API v3 baseUrl. Modify this if you're using GitHub Enterprise.
+# GitHub REST API v3 baseUrl.
+# 💼 Modify this if you're using GitHub Enterprise.
 GITHUB_API_BASE_URL="https://api.github.com"
 
-# readme-score-api base url. Modify this if you're using it
-# behind a company firewall.
+# readme-score-api base url.
+# 💼 Modify this if you've installed it behind a company firewall.
 README_SCORE_API_BASE_URL="http://readme-score-api.herokuapp.com"

.env.schema

@@ -10,9 +10,16 @@
 
 # ENV VARS required for readme-inspector
 ## Add values to these ENV VARs and save to
-## {your-project-root-directory}/.env
+## {your-project-root-directory}/.env, e.g.,
+## if your root project directory is
+##
+## $ more-bort-license-plates/
+##
+## then save your .env file to
+##
+## $ more-bort-license-plates/.env
 
-# 🔹 OPTIONAL env vars:
+# 🔹 OPTIONAL env vars (set in .env.defaults):
 API_ENDPOINT_README_SCORE=
 BITBUCKET_API_BASE_URL=
 GA_README_INSPECTOR=

.github/CONTRIBUTING.md

@@ -623,7 +623,7 @@
  | [lodash.camelcase@4.3.0](https://lodash.com/) | The lodash method `_.camelCase` exported as a module. | 4.3.0 | MIT | production | 
  | [lodash.mapkeys@4.6.0](https://lodash.com/) | The lodash method `_.mapKeys` exported as a module. | 4.6.0 | MIT | production | 
  | [lodash.noop@3.0.1](https://lodash.com/) | The lodash method `_.noop` exported as a module. | 3.0.1 | MIT | production | 
- | [meow@5.0.0](https://github.com/sindresorhus/meow#readme) | CLI app helper | 4.0.0 | MIT | production | 
+ | [meow@5.0.0](https://github.com/sindresorhus/meow#readme) | CLI app helper | 5.0.0 | MIT | production | 
 <!-- AUTO-GENERATED-CONTENT:END -->
 
 ### 7.2. Development
@@ -638,7 +638,7 @@
  | [@semantic-release/npm@3.2.4](https://github.com/semantic-release/npm#readme) | Set of semantic-release plugins to publish to a npm registry | 3.2.4 | MIT | dev | 
  | [ajv@6.4.0](https://github.com/epoberezkin/ajv) | Another JSON Schema Validator | 6.4.0 | MIT | dev | 
  | [ajv-keywords@3.1.0](https://github.com/epoberezkin/ajv-keywords#readme) | Custom JSON-Schema keywords for Ajv validator | 3.1.0 | MIT | dev | 
- | [codacy-coverage@2.1.1](https://github.com/codacy/node-codacy-coverage) | Code Coverage reporter for Codacy.com | 2.1.1 | MIT | dev | 
+ | [codacy-coverage@3.0.0](https://github.com/codacy/node-codacy-coverage) | Code Coverage reporter for Codacy.com | 2.1.1 | MIT | dev | 
  | [commitplease@3.2.0](https://github.com/jzaefferer/commitplease#readme) | Validates strings as commit messages | 3.2.0 | MIT | dev | 
  | [coveralls@3.0.0](https://github.com/nickmerwin/node-coveralls#readme) | takes json-cov output into stdin and POSTs to coveralls.io | 3.0.0 | BSD-2-Clause | dev | 
  | [eslint@4.19.1](https://eslint.org) | An AST-based pattern checker for JavaScript. | 4.19.1 | MIT | dev | 
@@ -654,7 +654,7 @@
  | [eslint-plugin-prettier@^2.2.0](https://github.com/prettier/eslint-plugin-prettier#readme) | Runs prettier as an eslint rule | 2.6.0 | MIT | dev | 
  | [eslint-plugin-promise@3.7.0](https://github.com/xjamundx/eslint-plugin-promise#readme) | Enforce best practices for JavaScript promises | 3.7.0 | ISC | 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.1.0](https://github.com/xjamundx/eslint-plugin-standard#readme) | ESlint Plugin for the Standard Linter | 3.0.1 | MIT | dev | 
+ | [eslint-plugin-standard@3.1.0](https://github.com/xjamundx/eslint-plugin-standard#readme) | ESlint Plugin for the Standard Linter | 3.1.0 | MIT | dev | 
  | [eslint-plugin-unicorn@4.0.3](https://github.com/sindresorhus/eslint-plugin-unicorn#readme) | Various awesome ESLint rules | 4.0.3 | 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 | 
  | [fixpack@2.3.1](https://github.com/henrikjoreteg/fixpack) | cli tool that cleans up package.json files. | 2.3.1 | MIT | dev | 
@@ -663,7 +663,7 @@
  | [jest-runner-eslint@0.4.0](https://github.com/jest-community/jest-runner-eslint) | An experimental ESLint runner for Jest | 0.4.0 | MIT | 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 | 
- | [lint-staged@7.0.5](https://github.com/okonet/lint-staged#readme) | Lint files staged by git | 7.0.4 | MIT | dev | 
+ | [lint-staged@7.0.5](https://github.com/okonet/lint-staged#readme) | Lint files staged by git | 7.0.5 | MIT | dev | 
  | [lodash.isundefined@3.0.1](https://lodash.com/) | The modern build of lodash’s `_.isUndefined` as a module. | 3.0.1 | MIT | dev | 
  | [lodash.set@4.3.2](https://lodash.com/) | The lodash method `_.set` exported as a module. | 4.3.2 | MIT | dev | 
  | [markdown-magic@0.1.21](https://github.com/DavidWells/markdown-magic#readme) | Automatically update markdown files with content from external sources | 0.1.21 | MIT | dev | 

.github/assets/examples/usage.js

@@ -19,10 +19,10 @@ readmeInspector.authenticate({
 // 1. Has a README, and
 // 2. Score the README for quality.
 
-const info = await readmeInspector.check(
-  'gregswindle',
-  'github-resource-converter'
-)
+const info = await readmeInspector.check({
+  owner: 'gregswindle',
+  repo:  'github-resource-converter'
+})
 
 // Display the resulting readmeInfo as a
 // JSON string.

CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+<a name="2.0.5"></a>
+
+## [2.0.5](https://github.com/commonality/readme-inspector/compare/v2.0.4...v2.0.5) (2018-04-27)
+
+### Bug Fixes
+
+* **codacy-coverage:** update to v3.0.0 ([3892fc5](https://github.com/commonality/readme-inspector/commit/3892fc5))
+* **codacy-coverage:** update to version 3.0.0 ([6990e17](https://github.com/commonality/readme-inspector/commit/6990e17))
+* **lint-staged:** update to version 7.0.5 ([5c257cd](https://github.com/commonality/readme-inspector/commit/5c257cd))
+
 <a name="2.0.2"></a>
 
 ## [2.0.2](https://github.com/commonality/readme-inspector/compare/v2.0.3...v2.0.2) (2018-04-26)

README.md

@@ -21,6 +21,7 @@
 <!-- 🚫 AUTO-GENERATED-CONTENT:START (TOC:excludeText=Table of contents) -->
 - [1. Installation](#1-installation)
 - [2. Configuration](#2-configuration)
+  * [2.1. Setting environment variables](#21-setting-environment-variables)
 - [2. Usage](#2-usage)
 - [3. API](#3-api)
   * [3.1. `authenticate({token, type, key})`](#31-authenticatetoken-type-key)
@@ -61,22 +62,34 @@ The `commonality/readme-inspector` module combines the mediator, proxy, and fact
 * README detection with the `readmeInfo` object, and
 * Quality assessment with the `readmeInfo.appraisal` object.
 
-Since both of these features invoke Web services to return information, they both use `.env` variables
+### 2.1. Setting environment variables
+
+`readme-inspector` invokes Web services to return information. These services use `.env` variables
 that require configuration:
 
 ```properties
-# 🔹 OPTIONAL env vars
+# ENV VARS defaults for readme-inspector:
 
-# API endpoint for the readme-score-api (with default value)
+# ReadmeAppraisal REST API
+# 💼 Modify this if you are using a company hosted installation.
 API_ENDPOINT_README_SCORE="http://readme-score-api.herokuapp.com/score.json?url=&human_breakdown=false&force=false"
 
-# Google Analytics trackingCode (with default value)
+# Bitbucket REST API v1.0 and v2.0 base url.
+# 💼 Modify this if you're using on-premise,
+#    company-hosted Bitbucket servers.
+BITBUCKET_API_BASE_URL="https://api.bitbucket.org"
+
+## Google Analytics trackingCode
 GA_README_INSPECTOR="UA-117338111-1"
 
-# 🔸 GitHub token variables to extend GitHub API rate limits
-#    from 60 requests per minute to 5,000 requests per minute:
-GH_TOKEN=
-GITHUB_ACCESS_TOKEN=
+# GitHub REST API v3 baseUrl.
+# 💼 Modify this if you're using GitHub Enterprise, e.g.,
+# GITHUB_API_BASE_URL="https://evilcorp.github.com/v3
+GITHUB_API_BASE_URL="https://api.github.com"
+
+# readme-score-api base url.
+# 💼 Modify this if you've installed it behind a company firewall.
+README_SCORE_API_BASE_URL="http://readme-score-api.herokuapp.com"
 ```
 
 > ![light-bulb][octicon-light-bulb] **To avoid rate-limiting**, you should [create a personal access token ![External link][octicon-link-external]](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) and save your personal access token in an environment variable called `GH_TOKEN`.
@@ -107,9 +120,16 @@ Defines a schema of what variables should be defined in the combination of
 
 # ENV VARS required for readme-inspector
 ## Add values to these ENV VARs and save to
-## {your-project-root-directory}/.env
-
-# 🔹 OPTIONAL env vars:
+## {your-project-root-directory}/.env, e.g.,
+## if your root project directory is
+##
+## $ more-bort-license-plates/
+##
+## then save your .env file to
+##
+## $ more-bort-license-plates/.env
+
+# 🔹 OPTIONAL env vars (set in .env.defaults):
 API_ENDPOINT_README_SCORE=
 BITBUCKET_API_BASE_URL=
 GA_README_INSPECTOR=
@@ -149,21 +169,23 @@ file.
 
 # ENV VARS defaults for readme-inspector:
 
-# ReadmeAppraisal
+# ReadmeAppraisal REST API
+# 💼 Modify this if you are using a company hosted installation.
 API_ENDPOINT_README_SCORE="http://readme-score-api.herokuapp.com/score.json?url=&human_breakdown=false&force=false"
 
-# Bitbucket REST API v1.0 and v2.0 base url. Modify this if you're using
-# on-premise, company-hosted Bitbucket servers.
+# Bitbucket REST API v1.0 and v2.0 base url.
+# 💼 Modify this if you're using on-premise, company-hosted Bitbucket servers.
 BITBUCKET_API_BASE_URL="https://api.bitbucket.org"
 
 ## Google Analytics trackingCode
 GA_README_INSPECTOR="UA-117338111-1"
 
-# GitHub REST API v3 baseUrl. Modify this if you're using GitHub Enterprise.
+# GitHub REST API v3 baseUrl.
+# 💼 Modify this if you're using GitHub Enterprise.
 GITHUB_API_BASE_URL="https://api.github.com"
 
-# readme-score-api base url. Modify this if you're using it
-# behind a company firewall.
+# readme-score-api base url.
+# 💼 Modify this if you've installed it behind a company firewall.
 README_SCORE_API_BASE_URL="http://readme-score-api.herokuapp.com"
 ```
 <!-- AUTO-GENERATED-CONTENT:END -->
@@ -223,10 +245,10 @@ readmeInspector.authenticate({
 // 1. Has a README, and
 // 2. Score the README for quality.
 
-const info = await readmeInspector.check(
-  'gregswindle',
-  'github-resource-converter'
-)
+const info = await readmeInspector.check({
+  owner: 'gregswindle',
+  repo:  'github-resource-converter'
+})
 
 // Display the resulting readmeInfo as a
 // JSON string.
@@ -414,7 +436,7 @@ If a README is found, then the `readme-score-api` is invoked:
   > ```js
   > const readmeInfo = await readmeInspector.check({
   >   owner: 'commonality',
-  >   ref: 'GH-1-feat-inspect-readmes',
+  >   ref: 'GH-1-a-topic-branch',
   >   repo: 'readme-inspector'
   > })
   > ```
@@ -425,7 +447,7 @@ If a README is found, then the `readme-score-api` is invoked:
   > readmeInspector
   >   .check({
   >     owner: 'commonality',
-  >     ref: 'GH-1-feat-inspect-readmes',
+  >     ref: 'GH-1-a-topic-branch',
   >     repo: 'readme-inspector'
   >   })
   >   .then(readmeInfo => {})
@@ -510,7 +532,7 @@ Retrieves README information _without_ any `AppraisalData`.
   > ```js
   > const readmeInfo = await readmeInspector.getInfo({
   >   owner: 'commonality',
-  >   ref: 'GH-1-feat-inspect-readmes',
+  >   ref: 'GH-1-a-topic-branch',
   >   repo: 'readme-inspector'
   > })
   > ```
@@ -521,11 +543,13 @@ Retrieves README information _without_ any `AppraisalData`.
   > readmeInspector
   >   .getInfo({
   >     owner: 'commonality',
-  >     ref: 'GH-1-feat-inspect-readmes',
+  >     ref: 'GH-1-a-topic-branch',
   >     repo: 'readme-inspector'
   >   })
-  >   .then(readmeInfo => {})
-  >   .catch(err => {})
+  >   .then(readmeInfo => readmeInfo)
+  >   .catch(err => {
+  >     console.error(err)
+  >   })
   > ```
 
 ### 3.4. `getAppraisal(url)`

docs/api/readme-inspector/2.0.2/ReadmeAppraisal.html

@@ -472,7 +472,7 @@ <h5>Example</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Apr 26 2018 03:59:57 GMT-0500 (CDT) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 27 2018 16:18:04 GMT-0500 (CDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/api/readme-inspector/2.0.2/appraisal-data.js.html

@@ -177,7 +177,7 @@ <h1 class="page-title">appraisal-data.js</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Apr 26 2018 03:59:57 GMT-0500 (CDT) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 27 2018 16:18:04 GMT-0500 (CDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/api/readme-inspector/2.0.2/external-Contents.html

@@ -161,7 +161,7 @@ <h3>Example</h3>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Apr 26 2018 03:59:57 GMT-0500 (CDT) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 27 2018 16:18:04 GMT-0500 (CDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/api/readme-inspector/2.0.2/external-Octokit.html

@@ -139,7 +139,7 @@ <h2>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Apr 26 2018 03:59:57 GMT-0500 (CDT) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Apr 27 2018 16:18:04 GMT-0500 (CDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>