chore(release): publish v1.0.1 to NPM and GitHub

* chore(eslint-plugin-jsdoc): udate to latest

* ci(travis): update configuration tasks

  1. Remove failing Greenkeeper lockfile tasks, as they cause Travis-CI builds to fail.
  2. Remove env.secret key from config

* docs(community): update documentation

  1. Add links to PULL_REQUEST_TEMPLATE.md QA user guides
  2. Format all markdown files
  3. Show dotenv-extended example
  4. Demo loading variables to authenticate

GH-13,GH-14,GH-15

Author: gregswindle

.github/CONTRIBUTING.md

@@ -624,7 +624,7 @@
  | [[email protected]](https://github.com/standard/eslint-config-standard) | JavaScript Standard Style - ESLint Shareable Config | 11.0.0 | MIT | dev | 
  | [[email protected]](https://github.com/xojs/eslint-config-xo#readme) | ESLint shareable config for XO | 0.20.1 | MIT | dev | 
  | [[email protected]](https://github.com/benmosher/eslint-plugin-import) | Import with sanity. | 2.11.0 | MIT | dev | 
- | [[email protected].2](https://github.com/gajus/eslint-plugin-jsdoc#readme) | JSDoc linting rules for ESLint. | 3.6.2 | BSD-3-Clause | dev | 
+ | [[email protected].3](https://github.com/gajus/eslint-plugin-jsdoc#readme) | JSDoc linting rules for ESLint. | 3.6.3 | BSD-3-Clause | dev | 
  | [[email protected]](https://github.com/azeemba/eslint-plugin-json#readme) | Lint JSON files | 1.2.0 | ISC | dev | 
  | [[email protected]](https://github.com/mozfreddyb/eslint-plugin-no-unsafe-innerhtml/) | custom ESLint rule to disallows unsafe innerHTML, outerHTML and insertAdjacentHTML | 1.0.16 | MPL-2.0 | dev | 
  | [[email protected]](https://github.com/mysticatea/eslint-plugin-node#readme) | Additional ESLint's rules for Node.js | 6.0.1 | MIT | dev | 
@@ -642,6 +642,7 @@
  | [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 | 
  | [[email protected]](https://github.com/okonet/lint-staged#readme) | Lint files staged by git | 7.0.4 | MIT | dev | 
  | [[email protected]](https://lodash.com/) | The modern build of lodash’s `_.isUndefined` as a module. | 3.0.1 | MIT | dev | 
+ | [[email protected]](https://lodash.com/) | The lodash method `_.set` exported as a module. | 4.3.2 | MIT | dev | 
  | [[email protected]](https://github.com/DavidWells/markdown-magic#readme) | Automatically update markdown files with content from external sources | 0.1.21 | MIT | dev | 
  | [[email protected]](https://github.com/camacho/markdown-magic-dependency-table#readme) | Generate table of information about dependencies automatically in markdown | 1.3.2 | MIT | dev | 
  | [[email protected]](https://github.com/camacho/markdown-magic-install-command#readme) | Print install command for markdown file | 1.3.1 | MIT | dev | 

.github/PULL_REQUEST_TEMPLATE.md

@@ -35,7 +35,6 @@ plugins:
 - xss
 extends:
 - eslint:all
-- eslint-config-standard
 globals:
   document: false
   navigator: false
@@ -441,6 +440,20 @@ rules:
   scanjs-rules/property_localStorage: error
   scanjs-rules/property_mgmt: error
   scanjs-rules/property_sessionStorage: error
+
+  security/detect-unsafe-regex: 1
+  security/detect-buffer-noassert: 1
+  security/detect-child-process: 1
+  security/detect-disable-mustache-escape: 1
+  security/detect-eval-with-expression: 1
+  security/detect-no-csrf-before-method-override: 1
+  security/detect-non-literal-fs-filename: 1
+  security/detect-non-literal-regexp: 1
+  security/detect-non-literal-require: 1
+  security/detect-object-injection: 1
+  security/detect-possible-timing-attacks: 1
+  security/detect-pseudoRandomBytes: 1
+
   unicorn/catch-error-name:
   - error
   - name: err

.github/assets/img/logo-jest.png

@@ -30,7 +30,7 @@ sonar.sourceEncoding=UTF-8
 sonar.organization=commonality
 sonar.projectKey=readme-inspector
 sonar.projectName=readme-inspector
-sonar.projectVersion=1.0.0
+sonar.projectVersion=1.0.1
 
 # =====================================================
 #   Meta-data for the project

.github/config/.eslintrc.yml

@@ -24,15 +24,12 @@ git:
   depth: 1
 before_install:
 - "[[ $(node -v) =~ ^v9.*$ ]] || npm install -g npm@latest"
-- npm install -g greenkeeper-lockfile@1
 before_script:
-- greenkeeper-lockfile-update
 - npm dedupe
 script:
 - npm run test:config
 - npm test
 after_script:
-- 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
@@ -45,6 +42,3 @@ jobs:
       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=

.github/config/sonar-project.properties

@@ -23,10 +23,7 @@ All notable changes to this project will be documented in this file. See [standa
   > You can use your README to answer other questions, like how you handle
   > contributions, what the goals of the project are, and information about
   > licenses and attribution. If you don’t want to accept contributions, or
-  > your project is not yet ready for production, write this information down.
-  >
-  > "Starting An Open Source Project." Open Source Guides.
-  > N. p., 2018. Web. 12 Apr. 2018.
+  > your project is not yet ready for production, write this information down. <sup><a href="#ref-1" title="View reference.">[1]</a></sup>
 
   **Public API**
 
@@ -52,4 +49,9 @@ 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)
 
+## References
+
+<a name="ref-1"></a>
+**[1]** _Starting an Open Source Project._ (2018). _Open Source Guides._ Retrieved 15 April 2018, from <https://opensource.guide/starting-a-project/#writing-a-readme>
+
 [octicon-quote]: https://cdnjs.cloudflare.com/ajax/libs/octicons/4.4.0/svg/quote.svg

.travis.yml

@@ -72,7 +72,7 @@ $ npm install --save readme-inspector
 
 ---
 
-<details><summary>Click here for detailed <samp>.env</samp> variable initialization instructions</summary><p>
+<details><summary>Click here for detailed <samp>.env</samp> variable initialization instructions</summary><pre>
 
 <!-- AUTO-GENERATED-CONTENT:START (CODE:src=./lib/.env.schema) -->
 <!-- The below code snippet is automatically added from ./lib/.env.schema -->
@@ -102,7 +102,7 @@ GITHUB_ACCESS_TOKEN=
 ```
 <!-- AUTO-GENERATED-CONTENT:END -->
 
-</p></details>
+</pre></details>
 
 ---
 
@@ -192,10 +192,15 @@ The `readmeInspector` module detects whether or not a README document exists at
 
 > ```javascript
 > // Token (https://github.com/settings/tokens)
+> // Load your GH_TOKEN or GITHUB_ACCESS_TOKEN from
+> // environment variables:
+> const dotenvExtended = require('dotenv-extended')
+> const envConfig = dotenvExtended.config()
+>
 > const readmeInspector = require('readme-inspector')
 >
 > readmeInspector.authenticate({
->   token: 'secrettoken123',
+>   token: envConfig.GH_TOKEN,
 >   type: 'token'
 > })
 > ```

CHANGELOG.md

@@ -15,3 +15,6 @@ 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"
+
+# Codacy code coverage
+CODACY_PROJECT_TOKEN=$CODACY_PROJECT_TOKEN_README_INSPECTOR

README.md

@@ -1,4 +1,5 @@
 /* eslint node/no-unpublished-require:0 */
+/* eslint security/detect-object-injection:0 */
 /* eslint no-console:0 */
 /* eslint max-len:0 */
 const nullReadmeInfo = require('./__fixtures__/null-readme-info.json')