fix(config): add default .env var values

gregswindle · web-flow · commit 7a71637014a8 · 2018-04-14T23:56:40.000-05:00
* fix(envvars): add default .env var values * Add api-client-options objects * Fix broken PULL_REQUEST_TEMPLATE.md image references * Refactor octicon link refs (make them shorter) * Replace module dotenv with dotenv-extended to enable defaults * Specify MIT license in /lib/index.js Resolves GH-11 and GH-10
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -101,8 +101,8 @@ $ npm test
 
 <!-- ⛔️ Logo img references ⛔️  -->
 
-[logo-eslint]: ./assets/img/logo-eslint.png
-[logo-jest]: ./assets/img/logo-jest.png
+[logo-eslint]: https://raw.githubusercontent.com/commonality/readme-inspector/master/.github/assets/img/logo-eslint.png
+[logo-jest]: https://raw.githubusercontent.com/commonality/readme-inspector/master/.github/assets/img/logo-jest.png
 
 <!-- ⛔️ Octicon img references ⛔️  -->
 
diff --git a/.travis.yml b/.travis.yml
@@ -1,54 +1,50 @@
----
 addons:
   sonarcloud:
-    organization:   "$SONAR_ORGANIZATION"
+    organization: "$SONAR_ORGANIZATION"
     token:
-      secure:       "$SONAR_TOKEN"
+      secure: "$SONAR_TOKEN"
     github_token:
-      secure:       "$GITHUB_ACCESS_TOKEN"
+      secure: "$GITHUB_ACCESS_TOKEN"
     branches:
-      - master
-      - /[build|chore|ci|docs|feat|fix|perf|refactor|revert|spike|style|test]\/.*/
-
+    - master
+    - "/[build|chore|ci|docs|feat|fix|perf|refactor|revert|spike|style|test]\\/.*/"
 jdk:
-  - oraclejdk8
-
+- oraclejdk8
 language: node_js
-
 node_js:
-  - 9
-  - 8
-  - 7
-
+- 9
+- 8
+- 7
 os:
-  - linux
-  - osx
-
+- linux
+- osx
 notifications:
   webhooks: https://app.fossa.io/hooks/travisci
-
 git:
   depth: 1
-
+before_install:
+- "[[ $(node -v) =~ ^v9.*$ ]] || npm install -g npm@latest"
+- npm install -g greenkeeper-lockfile@1
 before_script:
-   - npm dedupe
-
+- greenkeeper-lockfile-update
+- npm dedupe
 script:
-  - npm run test:config
-  - npm test
-
+- npm run test:config
+- npm test
 after_script:
-  - npm run posttest:ci:coverage:codacy
-  - sonar-scanner -Dproject.settings=./.github/config/sonar-project.properties -Dsonar.organization=$SONAR_ORGANIZATION -Dsonar.login=$SONAR_COMMONALITY_TOKEN -X
-
+- greenkeeper-lockfile-upload
+- npm run posttest:ci:coverage:codacy
+- sonar-scanner -Dproject.settings=./.github/config/sonar-project.properties -Dsonar.organization=$SONAR_ORGANIZATION
+  -Dsonar.login=$SONAR_COMMONALITY_TOKEN -X
 jobs:
   include:
-    # Define the release stage that runs semantic-release
-    - stage: release
-      node_js: lts/*
-      deploy:
-        provider: script
-        skip_cleanup: true
-        script:
-          # - npm run docs:changelog
-          - npx travis-deploy-once "npx semantic-release"
+  - stage: release
+    node_js: lts/*
+    deploy:
+      provider: script
+      skip_cleanup: true
+      script:
+      - npx travis-deploy-once "npx semantic-release"
+env:
+  global:
+    secure: VFXeKWEb3ji3GXHQ4u0GLmyqnuVDHfe3dvP/6AD00Dzf25iox4kC4Ru2an7UPca7q19rB35RVXY3mYCIvC6IYRZO611HwI8/zZlUQVmz4KOGYCGXZpc9ylHzQUwwPq+5DyMHWKwDLsWvlm4IziPYURPIrc33CagrqMuAijyf0SVdZVRVZXQXlQ39YNxhnjqGP6ezOhvjlV22Be97HNo3R+18wnMTIdStOfayKHRTF7akEMWrrugZTUga3aJDflTBREfGrkkiyfOEfu8rR1wuWbgSVLC38c3y/3di5jmj6qH8c/Tqgt2FJEDEC+iXeIOb9a4imgsNdhz4raYe/sdcCvC/cqdR6Q8dKWTEm3p0waam4pA8tReFg8JHF0Jfu3rXi+JroF6ZbIB4223Ez73L715rrGwnNvepWoXqkT4NqAvPTxgmowr2I4BZnCjauO1u9yLuZaP6xkFFDiZh9GsuCtQRSeDgrNxRMiKCCsyEgoVNoFIILvAFiC2cJdS8/tRZGV6hSaFef4WmOEtBxJh0O8vYiZH/X8B/MX0IME6pN703k9z5WpTFZvUEhqYHPfE8+TiL6dm1jwgg1RIreu8V3fqb5o37C5XQLDXERmGY2y/u6wR8KkBs4XIMQ9RwuF2+KeVoQBJgqDmNnohVNrOXMpZfmMaPxl3TgrqYFpxYrzY=
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,7 +10,7 @@ All notable changes to this project will be documented in this file. See [standa
 
 * **module:readme-inspector:** Verify the existence—and assess the quality—of README files
 
-  > ![quote][icon-octicon-quote] READMEs do more than explain how to use your project. They also
+  > ![quote][octicon-quote] READMEs do more than explain how to use your project. They also
   > explain why your project matters, and what your users can do with it.
   >
   > In your README, try to answer the following questions:
@@ -52,4 +52,4 @@ All notable changes to this project will be documented in this file. See [standa
 
   ([e04a07a](https://github.com/commonality/readme-inspector/commit/e04a07a)), closes [#1](https://github.com/commonality/readme-inspector/issues/1)
 
-[icon-octicon-quote]: https://cdnjs.cloudflare.com/ajax/libs/octicons/4.4.0/svg/quote.svg
+[octicon-quote]: https://cdnjs.cloudflare.com/ajax/libs/octicons/4.4.0/svg/quote.svg
diff --git a/README.md b/README.md
diff --git a/lib/.env.defaults b/lib/.env.defaults
@@ -0,0 +1,17 @@
+# .env.defaults, committed to repo
+
+## See https://github.com/keithmorris/node-dotenv-extended/#readme
+## ⛔️
+## 🚫  DO NOT COMMIT YOUR ACTUAL .env file to version control.
+## 🚫  It should only include environment-specific values such
+## 🚫  as database passwords or API keys.
+## 🚫  Your production database should have a different password
+## 🚫  than your development database.
+
+# ENV VARS defaults for readme-inspector:
+
+## Google Analytics trackingCode
+GA_README_INSPECTOR="UA-117338111-1"
+
+# ReadmeScore
+API_ENDPOINT_README_SCORE="http://readme-score-api.herokuapp.com/score.json?url=&human_breakdown=false&force=false"
diff --git a/lib/.env.example b/lib/.env.example
diff --git a/lib/.env.schema b/lib/.env.schema
@@ -0,0 +1,22 @@
+# .env.schema, committed to repo
+
+## See https://github.com/keithmorris/node-dotenv-extended/#readme
+## ⛔️
+## 🚫  DO NOT COMMIT YOUR ACTUAL .env file to version control.
+## 🚫  It should only include environment-specific values such
+## 🚫  as database passwords or API keys.
+## 🚫  Your production database should have a different password
+## 🚫  than your development database.
+
+# ENV VARS required for readme-inspector
+## Add values to these ENV VARs and save to
+## {your-project-root-directory}/.env
+
+# ▫️ OPTIONAL env vars:
+API_ENDPOINT_README_SCORE=
+CODACY_PROJECT_TOKEN=
+GA_README_INSPECTOR=
+
+# 🔸 RECOMMENDED vars (to extend GitHub API rate limits)
+GH_TOKEN=
+GITHUB_ACCESS_TOKEN=
diff --git a/lib/__tests__/__mocks__/dotenv-extended.js b/lib/__tests__/__mocks__/dotenv-extended.js
@@ -0,0 +1,13 @@
+const dotenvExtended = jest.genMockFromModule('dotenv-extended')
+
+const envConfig = {
+  'API_ENDPOINT_README_SCORE':
+      'http://readme-score-api.herokuapp.com/score.json?url=',
+  'CODACY_PROJECT_TOKEN': 'MOCK_CODACY_PROJECT_TOKEN',
+  'GA_README_INSPECTOR': 'UA-111111111-1',
+  'GH_TOKEN': 'MOCK_GITHUB_ACCESS_TOKEN'
+}
+
+dotenvExtended.config = jest.fn().mockReturnValue(envConfig)
+
+module.exports = dotenvExtended
diff --git a/lib/__tests__/__mocks__/dotenv.js b/lib/__tests__/__mocks__/dotenv.js
diff --git a/lib/__tests__/index.test.js b/lib/__tests__/index.test.js
@@ -1,4 +1,6 @@
 /* eslint node/no-unpublished-require:0 */
+/* eslint no-console:0 */
+/* eslint max-len:0 */
 const nullReadmeInfo = require('./__fixtures__/null-readme-info.json')
 const readmeInfo = require('./__fixtures__/http/200/readme-info')
 const readmeInspector = require('..')
diff --git a/lib/__tests__/readme-score.test.js b/lib/__tests__/readme-score.test.js
@@ -1,3 +1,4 @@
+/* eslint max-len:0 */
 let got = require('got')
 const ReadmeScore = require('../readme-score')
 const scoreNoReadme = require('./__fixtures__/http/404/readme-score')
diff --git a/lib/github-rest-client-options.js b/lib/github-rest-client-options.js
@@ -10,7 +10,7 @@ const acceptHeaders = [
 /**
  * All available @octokit/rest.js client options, with default values.
  *
- * @name restClientOptions
+ * @name githubRestClientOptions
  * @memberOf readme-inspector
  *
  * @prop [string='https://api.github.com'] baseUrl - A serialzied URL origin
@@ -39,7 +39,7 @@ const acceptHeaders = [
  *  seconds--means "no timeout."
  */
 
-const restClientOptions = {
+const githubRestClientOptions = {
   'baseUrl': 'https://api.github.com',
   'headers': {
     'Accept': acceptHeaders.join(','),
@@ -51,4 +51,4 @@ const restClientOptions = {
   'timeout': 0
 }
 
-module.exports = restClientOptions
+module.exports = githubRestClientOptions
diff --git a/lib/index.js b/lib/index.js
@@ -1,3 +1,18 @@
+// Copyright (c) 2018 commonality <greg@swindle.net> (https://github.com/commonality). All rights reserved.
+
+// See LICENSE <https://github.com/commonality/readme-inspector/blob/master/LICENSE>.
+
+/*
+ * Load required environment variables
+ * @see /lib/.env.example
+ * @private
+ * @ignore
+ */
+
+const dotenvExtended = require('dotenv-extended')
+
+const envConfig = dotenvExtended.config()
+
 /**
  * Detect whether or not a README document exists at the root of a
  * GitHub or GitHub Enterprise repository. If a README exists,
@@ -9,21 +24,17 @@
  * @see https://github.com/octokit/rest.js/#readme
  * @see https://octokit.github.io/rest.js/
  *
+ * @prop {ReadmeScore} ReadmeScore - An API proxy/wrapper that
+ * invokes the readme-score-api in order to assess and grade
+ * the quality of a README file.
+ *
  * @exports readme-inspector
  */
 
-const dotenv = require('dotenv')
-const readmeInfo = require('./readme-info')
+const githubRestClientOptions = require('./github-rest-client-options')
 const Octokit = require('@octokit/rest')
+const readmeInfo = require('./readme-info')
 const ReadmeScore = require('./readme-score')
-const restClientOptions = require('./rest-client-options')
-
-/*
- * Load required environment variables
- * @see /lib/.env.example
- */
-
-const envConfig = dotenv.config()
 
 /**
  * Octokit GitHubAPI shadow instance.
@@ -32,7 +43,7 @@ const envConfig = dotenv.config()
  * @ignore
  */
 
-const octokit = new Octokit(restClientOptions)
+const octokit = new Octokit(githubRestClientOptions)
 
 const readmeInspector = {
   ReadmeScore,
@@ -59,7 +70,7 @@ const readmeInspector = {
 
   authenticate (credentials) {
     const creds = credentials || {
-      'token': envConfig.required.GH_TOKEN,
+      'token': envConfig.GH_TOKEN,
       'type': 'token'
     }
     octokit.authenticate(creds)
diff --git a/lib/readme-score-api-client-options.js b/lib/readme-score-api-client-options.js
@@ -0,0 +1,24 @@
+const {format, URL} = require('url')
+const dotenvExtended = require('dotenv-extended')
+const envConfig = dotenvExtended.config()
+
+/**
+ * The readme-score-api on Heroku.
+ * @ignore
+ * @private
+ */
+
+const apiEndpoint = new URL(envConfig.API_ENDPOINT_README_SCORE)
+
+const readmeScoreApiClientOptions = {
+  'baseUrl': apiEndpoint.toString(),
+  format,
+  'href': apiEndpoint.href,
+  'params': {
+    'force': false,
+    'human_breakdown': false,
+    'url': ''
+  }
+}
+
+module.exports = readmeScoreApiClientOptions
diff --git a/lib/readme-score.js b/lib/readme-score.js
@@ -1,11 +1,12 @@
+const dotenvExtended = require('dotenv-extended')
+const envConfig = dotenvExtended.config()
+
 const camelCase = require('lodash.camelcase')
-const dotenv = require('dotenv')
 const got = require('got')
+const readmeScoreApiClientOptions = require('./readme-score-api-client-options')
 const scoreData = require('./score-data')
 const transform = require('lodash.transform')
 
-const envConfig = dotenv.config()
-
 /**
  * Transform Ruby snake-case convention into JavaScript's camel-case
  * convention.
@@ -32,29 +33,31 @@ const adapt = (result) => {
 }
 
 /**
- * Grades README files.
+ * An API proxy/wrapper that invokes the readme-score-api
+ * in order to assess and grade the quality of a README file.
  *
- * @name ReadmeScore
+ * @typedef {Object} ReadmeScore
  * @memberOf module:readme-inspector
  */
 
 const ReadmeScore = {
   /**
    * Evalutate the root-level README in a repository (if present).
    *
-   * @static
+   * @method for
    * @param {string} url - A URL or repository slug.
+   * @param {string} [apiEndpoint=http://readme-score-api.herokuapp.com/score.json?url=] - The API endpoint.
    * @returns {Promise<ScoreData>} ScoreData for a README.
-   * @memberof ReadmeScore
+   * @memberof @memberOf module:readme-inspector.ReadmeScore
    * @example
    * const ReadmeScore = require('./readme-score')
    *
    * // Parameters: url|slug|string<html>
    * const result = await ReadmeScore.for('commonality/readme-inspector')
    */
 
-  async for (url) {
-    const uri = `${envConfig.required.API_ENDPOINT_README_SCORE}${url}`
+  async for (url, apiEndpoint = readmeScoreApiClientOptions.href) {
+    const uri = `${envConfig.API_ENDPOINT_README_SCORE}${url}`
     let result = scoreData.factory()
     try {
       const response = await got(uri)
diff --git a/lib/score-data.js b/lib/score-data.js
diff --git a/package.json b/package.json
