feat: bump recommended-bump to latest & some tweaks

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

Author: Charlike Mike Reagent

.circleci/config.yml

@@ -55,8 +55,8 @@ jobtest: &jobtest
         name: Installing project dependencies
         command: yarn install --prefer-offline || yarn install
     - run:
-        name: Testing your project
-        command: yarn tunnckocore-scripts test
+        name: Linting and testing your project
+        command: yarn global add nyc@latest && yarn run lint && yarn test
     - save_cache:
         key: detect-next-version-{{ checksum "yarn.lock" }}
         paths: node_modules
@@ -97,17 +97,17 @@ jobs:
   #   <<: *node10osx
   #   <<: *jobtest
 
-  release:
+  publish:
     <<: *node10linux
     steps:
       - checkout
       - *restore_modules_cache
       - run:
           name: Bundling your awesome project
-          command: yarn tunnckocore-scripts build || echo "No build step."
+          command: yarn run build || echo "No build step."
       - run:
           name: Releasing and publishing
-          command: yarn tunnckocore-scripts release
+          command: yarn run release || (yarn global add @tunnckocore/release-cli && yarn run release)
 
 workflows:
   version: 2
@@ -137,7 +137,7 @@ workflows:
 
       # Release and NPM publish
       # Executed only on master
-      - release:
+      - publish:
           requires:
             # - test-node8osx
             # - test-node10osx
@@ -146,4 +146,4 @@ workflows:
           filters:
             branches:
               only: master
-          context: org-secret
+          context: org-global

.huskyrc.js

@@ -70,6 +70,8 @@ example usage. If all commit messages are of type that is not `patch|fix|minor|f
 or containing `BREAKING CHANGE:` label (e.g. the `chore` type), then the
 returned result won't have `nextVersion` and `increment` will be `false`.
 
+ProTip: See [parse-commit-message types](https://github.com/tunnckoCoreLabs/parse-commit-message#type-definitions) documentation!
+
 **Params**
 - `name` **{string}** a package name which you looking to update
 - `commits` **{string|}** directly passed to [recommended-bump][]
@@ -83,15 +85,13 @@ returned result won't have `nextVersion` and `increment` will be `false`.
 **Examples**
 ```ts
 type Commit = {
-  header: {
-    type: string,
-    scope: string,
-    subject: string,
-    toString: Function,
-  },
-  body: string | null,
-  footer: string | null
-}
+  header: Header;
+  body?: string | null;
+  footer?: string | null;
+  increment?: string | boolean;
+  isBreaking?: boolean;
+  mentions?: Array<Mention>;
+};
 ```
 ```javascript
 import detector from 'detect-next-version';
@@ -114,14 +114,14 @@ async function main() {
 main().catch(console.error);
 ```
 ```javascript
-import { parse, plugins } from 'parse-commit-message';
-import detectNextVersion from 'detect-next-version';
+import { parse } from 'parse-commit-message';
+import detector from 'detect-next-version';
 
 async function main() {
-  const commitOne = parse('fix: foo bar', plugins);
-  const commitTwo = parse('feat: some feature subject', plugins);
+  const commitOne = parse('fix: foo bar');
+  const commitTwo = parse('feat: some feature subject');
 
-  const result = detectNextVersion('@my-org/my-awesomepkg', [commitOne, commitTwo]);
+  const result = await detector('@my-org/my-awesomepkg', [commitOne, commitTwo]);
   console.log(result.increment); // => 'minor'
 }
 
@@ -136,8 +136,8 @@ main().catch(console.error);
 
 ## See Also
 
-Some of these projects are used here or were inspiration for this one, others are just related. So, thanks for your
-existance!
+Some of these projects are used here or were inspiration for this one, others are just related. So, thanks for your existance!
+
 {%= related(verb.related.list, { words: 10 }) %}
 
 **[back to top](#thetop)**

.verb.md

@@ -51,6 +51,8 @@ Project is [semantically](https://semver.org) & automatically released on [Circl
   * [Wonderful Contributors](#wonderful-contributors)
 - [License](#license)
 
+_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_
+
 ## Install
 
 This project requires [**Node.js**](https://nodejs.org) **^8.11.0 || >=10.13.0**. Install it using
@@ -80,6 +82,8 @@ example usage. If all commit messages are of type that is not `patch|fix|minor|f
 or containing `BREAKING CHANGE:` label (e.g. the `chore` type), then the
 returned result won't have `nextVersion` and `increment` will be `false`.
 
+ProTip: See [parse-commit-message types](https://github.com/tunnckoCoreLabs/parse-commit-message#type-definitions) documentation!
+
 **Params**
 - `name` **{string}** a package name which you looking to update
 - `commits` **{string|}** directly passed to [recommended-bump][]
@@ -93,15 +97,13 @@ returned result won't have `nextVersion` and `increment` will be `false`.
 **Examples**
 ```ts
 type Commit = {
-  header: {
-    type: string,
-    scope: string,
-    subject: string,
-    toString: Function,
-  },
-  body: string | null,
-  footer: string | null
-}
+  header: Header;
+  body?: string | null;
+  footer?: string | null;
+  increment?: string | boolean;
+  isBreaking?: boolean;
+  mentions?: Array<Mention>;
+};
 ```
 ```javascript
 import detector from 'detect-next-version';
@@ -124,14 +126,14 @@ async function main() {
 main().catch(console.error);
 ```
 ```javascript
-import { parse, plugins } from 'parse-commit-message';
-import detectNextVersion from 'detect-next-version';
+import { parse } from 'parse-commit-message';
+import detector from 'detect-next-version';
 
 async function main() {
-  const commitOne = parse('fix: foo bar', plugins);
-  const commitTwo = parse('feat: some feature subject', plugins);
+  const commitOne = parse('fix: foo bar');
+  const commitTwo = parse('feat: some feature subject');
 
-  const result = detectNextVersion('@my-org/my-awesomepkg', [commitOne, commitTwo]);
+  const result = await detector('@my-org/my-awesomepkg', [commitOne, commitTwo]);
   console.log(result.increment); // => 'minor'
 }
 
@@ -144,17 +146,11 @@ main().catch(console.error);
 
 ## See Also
 
-Some of these projects are used here or were inspiration for this one, others are just related. So, thanks for your
-existance!
-- [@tunnckocore/config](https://www.npmjs.com/package/@tunnckocore/config): All the configs for all the tools, in one place | [homepage](https://github.com/tunnckoCoreLabs/config "All the configs for all the tools, in one place")
-- [@tunnckocore/create-github-repo](https://www.npmjs.com/package/@tunnckocore/create-github-repo): Small and fast way to create GitHub repository! Provides API… [more](https://github.com/tunnckoCoreLabs/create-github-repo) | [homepage](https://github.com/tunnckoCoreLabs/create-github-repo "Small and fast way to create GitHub repository! Provides API and CLI")
-- [@tunnckocore/create-project](https://www.npmjs.com/package/@tunnckocore/create-project): Create and scaffold a new project, its GitHub repository and… [more](https://github.com/tunnckoCoreLabs/create-project) | [homepage](https://github.com/tunnckoCoreLabs/create-project "Create and scaffold a new project, its GitHub repository and contents")
-- [@tunnckocore/execa](https://www.npmjs.com/package/@tunnckocore/execa): Thin layer on top of [execa][] that allows executing multiple… [more](https://github.com/tunnckoCoreLabs/execa) | [homepage](https://github.com/tunnckoCoreLabs/execa "Thin layer on top of [execa][] that allows executing multiple commands in parallel or in sequence")
-- [@tunnckocore/scripts](https://www.npmjs.com/package/@tunnckocore/scripts): Universal and minimalist scripts & tasks runner. | [homepage](https://github.com/tunnckoCoreLabs/scripts "Universal and minimalist scripts & tasks runner.")
-- [@tunnckocore/update](https://www.npmjs.com/package/@tunnckocore/update): Update a repository with latest templates from `charlike`. | [homepage](https://github.com/tunnckoCoreLabs/update "Update a repository with latest templates from `charlike`.")
-- [charlike](https://www.npmjs.com/package/charlike): Small & fast project scaffolder with sane defaults. Supports hundreds… [more](https://github.com/tunnckoCoreLabs/charlike) | [homepage](https://github.com/tunnckoCoreLabs/charlike "Small & fast project scaffolder with sane defaults. Supports hundreds of template engines through the @JSTransformers API or if you want custom `render` function passed through options")
-- [execa](https://www.npmjs.com/package/execa): A better `child_process` | [homepage](https://github.com/sindresorhus/execa#readme "A better `child_process`")
+Some of these projects are used here or were inspiration for this one, others are just related. So, thanks for your existance!
+
+- [git-commits-since](https://www.npmjs.com/package/git-commits-since): Get all commits since given period of time or by… [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.")
+- [parse-commit-message](https://www.npmjs.com/package/parse-commit-message): Extensible parser for git commit messages following Conventional Commits Specification | [homepage](https://github.com/tunnckoCoreLabs/parse-commit-message "Extensible parser for git commit messages following Conventional Commits Specification")
 - [recommended-bump](https://www.npmjs.com/package/recommended-bump): Calculates recommended bump (next semver version) based on given array… [more](https://github.com/tunnckoCoreLabs/recommended-bump) | [homepage](https://github.com/tunnckoCoreLabs/recommended-bump "Calculates recommended bump (next semver version) based on given array of commit messages following Conventional Commits specification")
 
 **[back to top](#thetop)**
@@ -255,8 +251,7 @@ Released under the [Apache-2.0 License][license-url].
 [shareb]: https://badgen.net/badge/twitter/share/1da1f2?icon=twitter
 [open-issue-url]: https://github.com/tunnckoCoreLabs/detect-next-version/issues/new
 
-[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

README.md

@@ -4,25 +4,23 @@
   "license": "Apache-2.0",
   "licenseStart": "2017",
   "scripts": {
-    "start": "tunnckocore-scripts",
-    "extends": "@tunnckocore/config/scripts",
-    "docs": "tunnckocore-scripts docs",
-    "lint": "tunnckocore-scripts lint",
-    "test": "tunnckocore-scripts test",
-    "commit": "tunnckocore-scripts commit"
+    "docs": "docks --outfile .verb.md && verb",
+    "lint": "eslint '**/*.js' --cache --fix --quiet --format codeframe",
+    "test": "nyc asia",
+    "commit": "yarn lint && yarn test && yarn dry",
+    "dry": "git add -A && git status --porcelain && gitcommit -sS",
+    "release": "tunnckocore-release"
   },
   "engines": {
     "node": "^8.11.0 || >=10.13.0"
   },
   "dependencies": {
     "@tunnckocore/package-json": "^1.0.1",
     "esm": "^3.0.84",
-    "parse-commit-message": "1.1.2",
-    "recommended-bump": "^1.2.0"
+    "recommended-bump": "^1.3.0"
   },
   "devDependencies": {
-    "@tunnckocore/config": "^0.5.1",
-    "@tunnckocore/scripts": "^1.1.0",
+    "@tunnckocore/config": "^1.0.2",
     "asia": "^0.19.7"
   },
   "files": [
@@ -32,7 +30,7 @@
   "main": "index.js",
   "module": "src/index.js",
   "typings": "src/index.d.ts",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "repository": "tunnckoCoreLabs/detect-next-version",
   "homepage": "https://github.com/tunnckoCoreLabs/detect-next-version",
   "author": "Charlike Mike Reagent (https://tunnckocore.com)",
@@ -48,25 +46,17 @@
     "toc": {
       "render": true,
       "method": "preWrite",
-      "maxdepth": 4,
-      "footer": ""
+      "maxdepth": 4
     },
     "layout": "empty",
     "tasks": [
       "readme"
     ],
     "related": {
       "list": [
-        "execa",
-        "charlike",
         "gitcommit",
-        "@tunnckocore/create-github-repo",
-        "@tunnckocore/create-project",
-        "@tunnckocore/package-json",
-        "@tunnckocore/execa",
-        "@tunnckocore/update",
-        "@tunnckocore/scripts",
-        "@tunnckocore/config",
+        "git-commits-since",
+        "parse-commit-message",
         "recommended-bump"
       ]
     },
@@ -76,9 +66,8 @@
     "reflinks": [
       "new-release",
       "semantic-release",
-      "execa",
       "parse-commit-message",
       "recommended-bump"
     ]
   }
-}
+}

package.json

@@ -14,17 +14,17 @@ import increment from './semver-inc';
  * or containing `BREAKING CHANGE:` label (e.g. the `chore` type), then the
  * returned result won't have `nextVersion` and `increment` will be `false`.
  *
+ * ProTip: See [parse-commit-message types](https://github.com/tunnckoCoreLabs/parse-commit-message#type-definitions) documentation!
+ *
  * @example ts
  * type Commit = {
- *   header: {
- *     type: string,
- *     scope: string,
- *     subject: string,
- *     toString: Function,
- *   },
- *   body: string | null,
- *   footer: string | null
- * }
+ *   header: Header;
+ *   body?: string | null;
+ *   footer?: string | null;
+ *   increment?: string | boolean;
+ *   isBreaking?: boolean;
+ *   mentions?: Array<Mention>;
+ * };
  *
  * @example
  * import detector from 'detect-next-version';
@@ -47,14 +47,14 @@ import increment from './semver-inc';
  * main().catch(console.error);
  *
  * @example
- * import { parse, plugins } from 'parse-commit-message';
- * import detectNextVersion from 'detect-next-version';
+ * import { parse } from 'parse-commit-message';
+ * import detector from 'detect-next-version';
  *
  * async function main() {
- *   const commitOne = parse('fix: foo bar', plugins);
- *   const commitTwo = parse('feat: some feature subject', plugins);
+ *   const commitOne = parse('fix: foo bar');
+ *   const commitTwo = parse('feat: some feature subject');
  *
- *   const result = detectNextVersion('@my-org/my-awesomepkg', [commitOne, commitTwo]);
+ *   const result = await detector('@my-org/my-awesomepkg', [commitOne, commitTwo]);
  *   console.log(result.increment); // => 'minor'
  * }
  *
@@ -69,22 +69,22 @@ import increment from './semver-inc';
  * @returns {object} an object which is basically the return of [recommended-bump][]
  *                  plus `{ pkg, lastVersion, nextVersion? }`.
  */
-export default async function detector(name, commitMessages, options = {}) {
+export default async function detector(name, commits, options = {}) {
   const opts = Object.assign({}, options);
 
   if (typeof name !== 'string') {
     throw new TypeError('expect `name` to be string');
   }
-  const commits = [].concat(commitMessages).filter(Boolean);
+  const cmts = [].concat(commits).filter(Boolean);
 
-  if (commits.length === 0) {
+  if (cmts.length === 0) {
     throw new TypeError(
-      'expect `commitMessages` to be string or array of strings',
+      'expect `commits` to be string, array of strings or array of objects',
     );
   }
 
   const pkg = await packageJson(name, opts.endpoint);
-  const recommended = recommendedBump(commits, opts.plugins);
+  const recommended = recommendedBump(cmts, opts.plugins);
   const lastVersion = pkg.version;
 
   if (!recommended.increment) {