fix: update readme, allow node >=8.10 (because aws)

Signed-off-by: Charlike Mike Reagent <mameto2011@gmail.com>

Author: Charlike Mike Reagent

.verb.md

@@ -38,6 +38,8 @@ Project is [semantically](https://semver.org) & automatically published with [ne
 -->
 
 
+## Highlights
+
 - Understands and follows [Conventional Commits](https://conventionalcommits.org/) Specification
 - Closed cycle: utilities for parsing, stringifying **and** validation
 - Infinitely extensible through plugins, [two built-in](#mappers)

README.md

@@ -37,6 +37,8 @@ Project is [semantically](https://semver.org) & automatically published with [ne
 
 -->
 
+## Highlights
+
 - Understands and follows [Conventional Commits](https://conventionalcommits.org/) Specification
 - Closed cycle: utilities for parsing, stringifying **and** validation
 - Infinitely extensible through plugins, [two built-in](#mappers)
@@ -87,7 +89,7 @@ _(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](
 
 ## Install
 
-This project requires [**Node.js**](https://nodejs.org) **^8.11.0 || >=10.13.0**. Install it using
+This project requires [**Node.js**](https://nodejs.org) **^8.10.0 || >=10.13.0**. Install it using
 [**yarn**](https://yarnpkg.com) or [**npm**](https://npmjs.com).  
 _We highly recommend to use Yarn when you think to contribute to this project._
 
@@ -776,7 +778,7 @@ existance!
 - [asia](https://www.npmjs.com/package/asia): Blazingly fast, magical and minimalist testing framework, for Today and Tomorrow | [homepage](https://github.com/olstenlarck/asia#readme "Blazingly fast, magical and minimalist testing framework, for Today and Tomorrow")
 - [charlike](https://www.npmjs.com/package/charlike): Small, fast and streaming project scaffolder with support for hundreds of… [more](https://github.com/tunnckoCoreLabs/charlike) | [homepage](https://github.com/tunnckoCoreLabs/charlike "Small, fast and streaming project scaffolder with support for hundreds of template engines and sane defaults")
 - [docks](https://www.npmjs.com/package/docks): Extensible system for parsing and generating documentation. It just freaking works! | [homepage](https://github.com/tunnckoCore/docks "Extensible system for parsing and generating documentation. It just freaking works!")
-- [git-commits-since](https://www.npmjs.com/package/git-commits-since): Get all commits since given period of time or by default… [more](https://github.com/tunnckoCoreLabs/git-commits-since) | [homepage](https://github.com/tunnckoCoreLabs/git-commits-since "Get all commits since given period of time or by default from latest git semver tag. Also detects and calculates next needed / recommended bump for your package. Based on [recommended-bump][], [parse-commit-message][], [detect-next-version][], [git-semver")
+- [git-commits-since](https://www.npmjs.com/package/git-commits-since): Get all commits since given period of time or by default… [more](https://github.com/tunnckoCoreLabs/git-commits-since) | [homepage](https://github.com/tunnckoCoreLabs/git-commits-since "Get all commits since given period of time or by default from latest git semver tag. Understands and follows both SemVer and the Conventional Commits specification.")
 - [gitcommit](https://www.npmjs.com/package/gitcommit): Lightweight and joyful `git commit` replacement. Conventional Commits compliant. | [homepage](https://github.com/tunnckoCore/gitcommit "Lightweight and joyful `git commit` replacement. Conventional Commits compliant.")
 
 **[back to top](#thetop)**
@@ -881,6 +883,6 @@ Released under the [Apache-2.0 License][license-url].
 [detect-next-version]: https://github.com/tunnckoCoreLabs/detect-next-version
 [execa]: https://github.com/sindresorhus/execa
 [new-release]: https://github.com/tunnckoCore/new-release
-[parse-commit-message]: https://github.com/olstenlarck/parse-commit-message
+[parse-commit-message]: https://github.com/tunnckoCoreLabs/parse-commit-message
 [recommended-bump]: https://github.com/tunnckoCoreLabs/recommended-bump
 [semantic-release]: https://github.com/semantic-release/semantic-release

package.json

@@ -6,16 +6,17 @@
   "scripts": {
     "docs": "docks --outfile .verb.md && verb",
     "lint": "eslint '**/*.js' --cache --fix --quiet --format codeframe",
+    "test-only": "asia -r esm",
     "test": "nyc asia",
-    "test-only": "asia -r esm -u",
-    "commit": "yarn lint && yarn test && yarn dry",
-    "dry": "git add -A && git status --porcelain && gitcommit -sS",
+    "precommit": "yarn run lint && yarn run test-only",
+    "commit": "yarn dry",
+    "dry": "git add -A && git status --porcelain && gitcommit",
     "release": "tunnckocore-release",
     "clean": "rm -rf node_modules",
     "clean:cache": "rm -rf node_modules/.cache"
   },
   "engines": {
-    "node": "^8.11.0 || >=10.13.0"
+    "node": "^8.10.0 || >=10.13.0"
   },
   "dependencies": {
     "collect-mentions": "^1.0.2",

test/commit/snapshots/check.test.snapshot.json

@@ -0,0 +1 @@
+{".checkCommit throw if not object given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":1,"str":"(t) => {\n  t.throws(() => checkCommit({}), TypeError);\n  t.throws(() => checkCommit([]), TypeError);\n  t.throws(() => checkCommit(null), TypeError);\n  t.throws(() => checkCommit(123), /expect `commit` to be an object/);\n}","title":".checkCommit throw if not object given"},".checkCommit throw if commit.header.type is not a string":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":2,"str":"(t) => {\n  const fixture = () => checkCommit({ header: { foo: 'bar' } });\n  t.throws(fixture, /type should be non empty string/);\n}","title":".checkCommit throw if commit.header.type is not a string"},".checkCommit throw if commit.header.subject is not a string":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":3,"str":"(t) => {\n  t.throws(\n    () => checkCommit({ header: { type: 'fix' } }),\n    /subject should be non empty string/,\n  );\n  t.throws(\n    () => checkCommit({ header: { type: 'fix', subject: '' } }),\n    /subject should be non empty string/,\n  );\n}","title":".checkCommit throw if commit.header.subject is not a string"},".checkCommit throw if commit.header.scope is not a string when given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":4,"str":"(t) => {\n  const commit = { header: { type: 'fix', subject: 'qux zaz', scope: 123 } };\n  t.throws(\n    () => checkCommit(commit),\n    /scope should be non empty string when given/,\n  );\n}","title":".checkCommit throw if commit.header.scope is not a string when given"},".checkCommit throw if commit.body is not a string when given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":5,"str":"(t) => {\n  const commit = { header: { type: 'fix', subject: 'qux zaz' }, body: 123 };\n  t.throws(() => checkCommit(commit), /body should be string when given/);\n}","title":".checkCommit throw if commit.body is not a string when given"},".checkCommit throw if commit.footer is not a string when given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":6,"str":"(t) => {\n  const commit = { header: { type: 'fix', subject: 'qux zaz' }, footer: 123 };\n  t.throws(() => checkCommit(commit), /footer should be string when given/);\n}","title":".checkCommit throw if commit.footer is not a string when given"},".checkCommit should commit.body be `null` when explicitly null given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":7,"str":"(t) => {\n  const header = { type: 'fix', scope: 'cli', subject: 'zzz' };\n  const commit = { header, body: null, footer: 'xyz' };\n  const result = checkCommit(commit);\n\n  t.deepStrictEqual(result, {\n    header: { type: 'fix', scope: 'cli', subject: 'zzz' },\n    body: null,\n    footer: 'xyz',\n  });\n}","title":".checkCommit should commit.body be `null` when explicitly null given"},".checkCommit should commit.body be null when not given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":8,"str":"(t) => {\n  const header = { type: 'feat', scope: 'zazzy', subject: 'okey dude' };\n  const commit = { header, footer: 'ok ok' };\n  const result = checkCommit(commit);\n\n  t.deepStrictEqual(result, { header, body: null, footer: 'ok ok' });\n}","title":".checkCommit should commit.body be null when not given"},".checkCommit should commit.footer be `null` when explicitly null given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":9,"str":"(t) => {\n  const header = { type: 'fix', scope: 'cli', subject: 'zzz' };\n  const commit = { header, footer: null, body: 'BREAKING CHANGE: whoa!' };\n  const result = checkCommit(commit);\n\n  t.deepStrictEqual(result, {\n    header: { type: 'fix', scope: 'cli', subject: 'zzz' },\n    body: 'BREAKING CHANGE: whoa!',\n    footer: null,\n  });\n}","title":".checkCommit should commit.footer be `null` when explicitly null given"},".checkCommit should commit.footer be null when not given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":10,"str":"(t) => {\n  const header = { type: 'feat', scope: 'zazzy', subject: 'okey dude' };\n  const commit = { header };\n  const result = checkCommit(commit);\n  t.deepStrictEqual(result, { header, body: null, footer: null });\n}","title":".checkCommit should commit.footer be null when not given"},".checkCommit object with scope, body and footer":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":11,"str":"(t) => {\n  const commit = {\n    header: {\n      type: 'feat',\n      scope: 'quxie',\n      subject: 'woo hoo',\n    },\n    body: 'qux zaz faz',\n    footer: 'Breaking yeah',\n  };\n  t.deepStrictEqual(checkCommit(commit), commit);\n}","title":".checkCommit object with scope, body and footer"},"should checkCommit allow empty string body (git commit deafults)":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":12,"str":"(t) => {\n  const header = { type: 'feat', scope: 'zazzy', subject: 'okey dude' };\n  const commit = { header, body: '' };\n  const result = checkCommit(commit);\n\n  t.strictEqual(result.body, '');\n}","title":"should checkCommit allow empty string body (git commit deafults)"},"should checkCommit allow empty string footer (git commit deafults)":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":13,"str":"(t) => {\n  const header = { type: 'feat', scope: 'zazzy', subject: 'okey dude' };\n  const commit = { header, footer: '' };\n  const result = checkCommit(commit);\n\n  t.strictEqual(result.footer, '');\n}","title":"should checkCommit allow empty string footer (git commit deafults)"}}

test/commit/snapshots/stringify.test.snapshot.json

@@ -0,0 +1 @@
+{".stringifyCommit throw if invalid header is given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":1,"str":"(t) => {\n  t.throws(() => stringifyCommit(1234), TypeError);\n  t.throws(() => stringifyCommit({ header: { type: 'foo' } }), TypeError);\n  t.throws(() => stringifyCommit(), /expect `commit` to be an object/);\n}","title":".stringifyCommit throw if invalid header is given"},".stringifyCommit object":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":2,"str":"(t) => {\n  const header = { type: 'fix', scope: 'huh', subject: 'yeah yeah' };\n  const result = stringifyCommit({ header });\n\n  t.strictEqual(result, 'fix(huh): yeah yeah');\n\n  const cmt = {\n    header,\n    body: 'resolves #1\\nfixes #3',\n    footer: 'BREAKING CHANGE: yeah!',\n  };\n  const commitMessage = dedent`${result}\n\n  resolves #1\n  fixes #3\n\n  BREAKING CHANGE: yeah!`;\n\n  t.strictEqual(stringifyCommit(cmt), commitMessage);\n}","title":".stringifyCommit object"},".stringifyCommit object without scope":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":3,"str":"(t) => {\n  const header = {\n    header: { type: 'fix', subject: 'yeah yeah' },\n    body: 'woo hoo',\n  };\n  const result = stringifyCommit(header);\n\n  t.strictEqual(result, 'fix: yeah yeah\\n\\nwoo hoo');\n}","title":".stringifyCommit object without scope"}}

test/commit/snapshots/validate.test.snapshot.json

@@ -0,0 +1 @@
+{".parseHeader throw if not a string given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":1,"str":"(t) => {\n  t.throws(() => parseHeader(123), TypeError);\n  t.throws(() => parseHeader(123), /expect `header` to be non empty string/);\n  t.throws(() => parseHeader(''), /expect `header` to be non empty string/);\n}","title":".parseHeader throw if not a string given"},".parseHeader throw when invalid conventional commits":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":2,"str":"(t) => {\n  function fixture() {\n    parseHeader('fix bar qux');\n  }\n  t.throws(fixture, Error);\n  t.throws(fixture, /<type>\\[optional scope\\]: <description>/);\n}","title":".parseHeader throw when invalid conventional commits"},".parseHeader NOT throw when header is valid by conventional commits":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":3,"str":"(t) => {\n  const one = parseHeader('fix: zzz qux');\n  const two = parseHeader('fix(cli): aaaa qux');\n  const res = parseHeader('fix(cli): qqqqq qux\\n\\nSome awesome body');\n\n  t.ok(isObject(one));\n  t.ok(isObject(two));\n  t.ok(isObject(res));\n}","title":".parseHeader NOT throw when header is valid by conventional commits"},".parseHeader correctly header string without scope":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":4,"str":"(t) => {\n  const result = parseHeader('fix: bar qux');\n\n  t.deepStrictEqual(result, { type: 'fix', scope: null, subject: 'bar qux' });\n}","title":".parseHeader correctly header string without scope"},".parseHeader header string with scope":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":5,"str":"(t) => {\n  t.deepStrictEqual(parseHeader('fix(cli): bar qux'), {\n    type: 'fix',\n    scope: 'cli',\n    subject: 'bar qux',\n  });\n}","title":".parseHeader header string with scope"}}

test/header/snapshots/parse.test.snapshot.json

@@ -0,0 +1 @@
+{"should check(string) be able to accept a string and return an array of object items":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":1,"str":"(t) => {\n  const res = check('fix: bar qux');\n\n  t.strictEqual(Array.isArray(res), true);\n  t.strictEqual(res.length, 1);\n  t.strictEqual(typeof res[0], 'object');\n  t.deepStrictEqual(res[0], {\n    header: {\n      type: 'fix',\n      scope: null,\n      subject: 'bar qux',\n    },\n    body: null,\n    footer: null,\n  });\n}","title":"should check(string) be able to accept a string and return an array of object items"},"should check(string) support flat=true":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":2,"str":"(t) => {\n  const res = check('fix: bar', true);\n  t.strictEqual(Array.isArray(res), false);\n  t.strictEqual(typeof res, 'object');\n}","title":"should check(string) support flat=true"},"should check(object|array) return array even with flat=true, if more than 1 commits":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":3,"str":"(t) => {\n  const commits = [\n    'feat(ci): tweaks bar\\n\\nAwesome body',\n    { header: { type: 'refactor', subject: 'woo hoo' } },\n  ];\n  const res = check(commits, true);\n  t.strictEqual(Array.isArray(res), true);\n\n  const [one, two] = res;\n\n  t.deepStrictEqual(one, {\n    header: { type: 'feat', scope: 'ci', subject: 'tweaks bar' },\n    body: 'Awesome body',\n    footer: null,\n  });\n  t.deepStrictEqual(two, {\n    header: { type: 'refactor', scope: null, subject: 'woo hoo' },\n    body: null,\n    footer: null,\n  });\n}","title":"should check(object|array) return array even with flat=true, if more than 1 commits"},"should check('') fail when empty string given":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":4,"str":"(t) => {\n  t.throws(() => check(''), TypeError);\n  t.throws(() => check(''), /expect `commit` to be non empty string/);\n}","title":"should check('') fail when empty string given"},"should check fail on false values, correctly":{"skip":false,"todo":false,"run":false,"isPending":false,"isRejected":false,"isFulfilled":true,"id":5,"str":"(t) => {\n  t.throws(() => check(), TypeError);\n  t.throws(() => check(), /expect `commit` to be an object/);\n\n  t.throws(() => check(undefined), TypeError);\n  t.throws(() => check(undefined), /expect `commit` to be an object/);\n\n  t.throws(() => check(null), TypeError);\n  t.throws(() => check(null), /expect `commit` to be an object/);\n}","title":"should check fail on false values, correctly"}}