chore: Add tooling for code coverage, changelogs, and conventional co…

…mmits (#10)

*  rename license
* setup codecov and badges
*  commitlint and standard version setup
* upgrade to grumbler-scripts v5

.github/workflows/main.yml

@@ -24,8 +24,14 @@ jobs:
         with:
           useLockFile: false
 
+      - name: 👕 Lint commit messages
+        uses: wagoid/commitlint-github-action@v4
+
       - name: ▶️ Run flow-typed script
         run: npm run flow-typed
 
       - name: ▶️ Run build script
         run: npm run build
+
+      - name: ⬆️ Upload karma coverage report
+        uses: codecov/codecov-action@v2

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit "$1"

README.md

@@ -1,8 +1,14 @@
 zalgo-promise
 -------------
 
+[![build status][build-badge]][build]
+[![code coverage][coverage-badge]][coverage]
 [![npm version][version-badge]][package]
 
+[build-badge]: https://img.shields.io/github/workflow/status/krakenjs/zalgo-promise/build?logo=github&style=flat-square
+[build]: https://github.com/krakenjs/zalgo-promise/actions?query=workflow%3Abuild
+[coverage-badge]: https://img.shields.io/codecov/c/github/krakenjs/zalgo-promise.svg?style=flat-square
+[coverage]: https://codecov.io/github/krakenjs/zalgo-promise/
 [version-badge]: https://img.shields.io/npm/v/zalgo-promise.svg?style=flat-square
 [package]: https://www.npmjs.com/package/zalgo-promise
 

commitlint.config.js

@@ -0,0 +1,6 @@
+/* @flow */
+/* eslint import/no-commonjs: off */
+
+module.exports = {
+    extends: [ '@commitlint/config-conventional' ]
+};

package.json

@@ -13,13 +13,53 @@
     "webpack": "babel-node --plugins=transform-es2015-modules-commonjs ./node_modules/.bin/webpack --display-optimization-bailout --progress",
     "test": "npm run lint && npm run flow-typed && npm run flow && npm run karma",
     "build": "npm run test && npm run babel && npm run webpack",
-    "release": "./publish.sh",
-    "release:patch": "./publish.sh patch",
-    "release:minor": "./publish.sh minor",
-    "release:major": "./publish.sh major",
     "clean": "rimraf dist coverage",
     "reinstall": "rimraf flow-typed && rimraf node_modules && npm install && flow-typed install",
-    "debug": "cross-env NODE_ENV=debug"
+    "debug": "cross-env NODE_ENV=debug",
+    "prepare": "husky install",
+    "prerelease": "npm run clean && npm run build && git add dist && git commit -m 'ci: check in dist folder' || echo 'Nothing to distribute'",
+    "release": "standard-version",
+    "postrelease": "git push && git push --follow-tags && npm publish"
+  },
+  "standard-version": {
+    "types": [
+      {
+        "type": "feat",
+        "section": "Features"
+      },
+      {
+        "type": "fix",
+        "section": "Bug Fixes"
+      },
+      {
+        "type": "chore",
+        "hidden": false
+      },
+      {
+        "type": "docs",
+        "hidden": false
+      },
+      {
+        "type": "style",
+        "hidden": false
+      },
+      {
+        "type": "refactor",
+        "hidden": false
+      },
+      {
+        "type": "perf",
+        "hidden": false
+      },
+      {
+        "type": "test",
+        "hidden": false
+      },
+      {
+        "type": "ci",
+        "hidden": true
+      }
+    ]
   },
   "repository": {
     "type": "git",
@@ -40,9 +80,13 @@
   ],
   "readmeFilename": "README.md",
   "devDependencies": {
+    "@commitlint/cli": "^16.2.1",
+    "@commitlint/config-conventional": "^16.2.1",
     "flow-bin": "0.155.0",
-    "grumbler-scripts": "^3",
-    "mocha": "^4"
+    "grumbler-scripts": "^5.0.3",
+    "husky": "^7.0.4",
+    "mocha": "^4",
+    "standard-version": "^9.3.2"
   },
   "dependencies": {}
 }

src/promise.js

@@ -1,24 +1,25 @@
 /* @flow */
+/* eslint no-use-before-define: off */
 
 import { isPromise } from './utils';
 import { onPossiblyUnhandledException, dispatchPossiblyUnhandledError } from './exceptions';
 import { startActive, endActive, awaitActive } from './flush';
 
 export class ZalgoPromise<R : mixed> {
 
-    resolved : boolean
-    rejected : boolean
-    errorHandled : boolean
-    value : R
-    error : mixed
+    resolved : boolean;
+    rejected : boolean;
+    errorHandled : boolean;
+    value : R;
+    error : mixed;
     // eslint-disable-next-line flowtype/no-mutable-array
     handlers : Array<{|
         promise : ZalgoPromise<*>,
         onSuccess : void | (result : R) => mixed,
         onError : void | (error : mixed) => mixed
-    |}>
-    dispatching : boolean
-    stack : string
+    |}>;
+    dispatching : boolean;
+    stack : string;
 
     constructor(handler : ?(resolve : (result : R) => void, reject : (error : mixed) => void) => void) {
 
@@ -135,7 +136,7 @@ export class ZalgoPromise<R : mixed> {
         this.reject(error);
         return this;
     }
-    
+
     dispatch() {
 
         const { dispatching, resolved, rejected, handlers } = this;
@@ -340,7 +341,7 @@ export class ZalgoPromise<R : mixed> {
 
         const promise = new ZalgoPromise();
         let count = promises.length;
-        // eslint-disable-next-line no-undef
+        // eslint-disable-next-line no-undef, unicorn/prefer-spread
         const results = ([] : $TupleMap<X, <Y>(ZalgoPromise<Y> | Y) => Y>).slice();
 
         if (!count) {
@@ -402,7 +403,7 @@ export class ZalgoPromise<R : mixed> {
                 }
             }
         }
-        
+
         return ZalgoPromise.all(awaitPromises).then(() => result);
     }
 
@@ -424,7 +425,7 @@ export class ZalgoPromise<R : mixed> {
         let result : ZalgoPromise<X> | Y;
 
         startActive();
-        
+
         try {
             result = method.apply(context, args || []);
         } catch (err) {