chore: set codecov for all packages (#134)

docs: format tables in readme
fix node_modules cache in circleci
Signed-off-by: Olivier Albertini <[email protected]>

.circleci/checksum.sh

@@ -21,6 +21,6 @@ fi
 
 openssl md5 package.json >> $FILE
 
-find packages/*/package.json | xargs -I{} openssl md5 {} >> $FILE
+find packages/*/package.json examples/*/package.json | xargs -I{} openssl md5 {} >> $FILE
 
-sort -o $FILE $FILE
+sort -o $FILE $FILE

.circleci/config.yml

@@ -5,6 +5,12 @@ cache_1: &cache_1
   paths:
     - ./node_modules
     - ./yarn.lock
+    - examples/basic/node_modules
+    - examples/binding/node_modules
+    - examples/event/node_modules
+    - examples/failure-strategy/node_modules
+    - examples/opentelemetry/node_modules
+    - examples/parallel/node_modules
     - packages/workit-bpm-client/node_modules
     - packages/workit-camunda/node_modules
     - packages/workit-cli/node_modules
@@ -20,9 +26,19 @@ node_tests: &node_tests
     - run:
         name: Create Checksum
         command: sh .circleci/checksum.sh /tmp/checksums.txt
+    - run:
+        name: Setup environment variables
+        command: |
+          echo "export CIRCLE_NODE_VERSION=\$(node --version | grep -oE 'v[0-9]+')" >> $BASH_ENV
+          source $BASH_ENV
+    - run:
+        name: Log out node.js version
+        command: |
+          node --version
+          echo "CIRCLE_NODE_VERSION=${CIRCLE_NODE_VERSION}"
     - restore_cache:
         keys:
-          - npm-cache-{{ checksum "/tmp/checksums.txt" }}
+          - npm-cache-01-{{ .Environment.CIRCLE_JOB }}-{{ checksum "/tmp/checksums.txt" }}-1
     - run:
         name: Install Dependencies
         command: yarn install
@@ -43,10 +59,10 @@ node_tests: &node_tests
           echo Failed waiting for Zeebe && exit 1
     - run:
         name: test
-        command: npm run test:integration
+        command: npm run test:all
     - run:
-        name: codecov
-        command: npm run codecov
+        name: report coverage
+        command: if [ "${CIRCLE_NODE_VERSION}" = "v12" ]; then npm run codecov; fi
 docs_filters: &docs_filters # Ignores any commit on any branch by default
   branches:
     ignore: gh-pages

README.md

@@ -32,18 +32,18 @@ This package can be useful because:
 
 ### API
 
-| <div style="width:100px">Package</div> | Description |
-| -------------------------------------------- | -----------------|
+| Package                 | Description |
+| ----------------------- | -----------------|
 | [workit-types](https://github.com/VilledeMontreal/workit/tree/master/packages/workit-types) | This package provides TypeScript interfaces and enums for the Workit core model. |
 | [workit-core](https://github.com/VilledeMontreal/workit/tree/master/packages/workit-core) | This package provides default and no-op implementations of the Workit types for Camunda Bpm and Zeebe. |
 
 ### Implementation / Clients
 
-| <div style="width:150px">Package</div>  | Description |
-| --------------------------------------- | -----------------|
-| [workit-bpm-client](https://github.com/VilledeMontreal/workit/tree/master/packages/workit-bpm-client) | This module provides a full control over the Camunda Bpm platform. It use [`camunda-external-task-client-js`](https://github.com/camunda/camunda-external-task-client-js) by default. |
-| [workit-zeebe-client](https://github.com/VilledeMontreal/workit/tree/master/packages/workit-zeebe-client) | This module provides a full control over the Zeebe platform. It use [`zeebe-node`](https://github.com/creditsenseau/zeebe-client-node-js) and [`zeebe-elasticsearch-client`](https://github.com/VilledeMontreal/workit/tree/master/packages/zeebe-elasticsearch-client)  by default. |
-| [workit-camunda](https://github.com/VilledeMontreal/workit/tree/master/packages/workit-camunda) | This module allows you to switch between Camunda BPM and Zeebe easily. It use [`workit-bpm-client`](https://github.com/VilledeMontreal/workit/tree/master/packages/workit-bpm-client) and [`workit-zeebe-client`](https://github.com/VilledeMontreal/workit/tree/master/packages/workit-zeebe-client) by default. |
+| Package                                  | Description |
+| ---------------------------------------- | -----------------|
+| [workit-bpm-client](https://github.com/VilledeMontreal/workit/tree/master/packages/workit-bpm-client) | This module provides a full control over the Camunda Bpm platform.<br> It use [`camunda-external-task-client-js`](https://github.com/camunda/camunda-external-task-client-js) by default. |
+| [workit-zeebe-client](https://github.com/VilledeMontreal/workit/tree/master/packages/workit-zeebe-client) | This module provides a full control over the Zeebe platform.<br> It use [`zeebe-node`](https://github.com/creditsenseau/zeebe-client-node-js) and [`zeebe-elasticsearch-client`](https://github.com/VilledeMontreal/workit/tree/master/packages/zeebe-elasticsearch-client)  by default. |
+| [workit-camunda](https://github.com/VilledeMontreal/workit/tree/master/packages/workit-camunda) | This module allows you to switch between Camunda BPM and Zeebe easily.<br> It use [`workit-bpm-client`](https://github.com/VilledeMontreal/workit/tree/master/packages/workit-bpm-client) and [`workit-zeebe-client`](https://github.com/VilledeMontreal/workit/tree/master/packages/workit-zeebe-client) by default. |
 
 ## Installing
 

README_FR.md

@@ -30,18 +30,18 @@ Ce framework offre les avantages suivants:
 
 ### API
 
-| <div style="width:100px">Librairie</div> | Description |
-| ---------------------------------------- | -----------------|
+| Librairie               | Description |
+| ----------------------- | -----------------|
 | [workit-types](https://github.com/VilledeMontreal/workit/tree/master/packages/workit-types) | Cette librairie fournit les interfaces / enums TypeScript pour les classes de Workit|
 | [workit-core](https://github.com/VilledeMontreal/workit/tree/master/packages/workit-core) | Cette librairie fournit les implémentations par défaut de la librairie "Workit types" pour Camunda Bpm et Zeebe. |
 
 ### Implémentation / Clients
 
-| <div style="width:150px">Librairie</div>     | Description |
-| -------------------------------------------- | -----------------|
-| [workit-bpm-client](https://github.com/VilledeMontreal/workit/tree/master/packages/workit-bpm-client) | Ce module fournit un contrôle complet pour intéragir avec la plateforme Camunda Bpm. Il utilise [`camunda-external-task-client-js`](https://github.com/camunda/camunda-external-task-client-js) par défaut. |
-| [workit-zeebe-client](https://github.com/VilledeMontreal/workit/tree/master/packages/workit-zeebe-client) | Ce module fournit un contrôle complet pour intéragir avec la plateforme Zeebe. Il utilise [`zeebe-node`](https://github.com/creditsenseau/zeebe-client-node-js) and [`zeebe-elasticsearch-client`](https://github.com/VilledeMontreal/workit/tree/master/packages/zeebe-elasticsearch-client) par défaut. |
-| [workit-camunda](https://github.com/VilledeMontreal/workit/tree/master/packages/workit-camunda) | Ce module permet de changer de plateforme (Camunda BPM / Zeebe) très facilement. Il suffit de remplacer un flag. Il utilise [`workit-bpm-client`](https://github.com/VilledeMontreal/workit/tree/master/packages/workit-bpm-client) and [`workit-zeebe-client`](https://github.com/VilledeMontreal/workit/tree/master/packages/workit-zeebe-client) par défaut. |
+| Librairie               | Description |
+| ----------------------- | -----------------|
+| [workit-bpm-client](https://github.com/VilledeMontreal/workit/tree/master/packages/workit-bpm-client) | Ce module fournit un contrôle complet pour intéragir avec la plateforme Camunda Bpm.<br> Il utilise [`camunda-external-task-client-js`](https://github.com/camunda/camunda-external-task-client-js) par défaut. |
+| [workit-zeebe-client](https://github.com/VilledeMontreal/workit/tree/master/packages/workit-zeebe-client) | Ce module fournit un contrôle complet pour intéragir avec la plateforme Zeebe.<br> Il utilise [`zeebe-node`](https://github.com/creditsenseau/zeebe-client-node-js) and [`zeebe-elasticsearch-client`](https://github.com/VilledeMontreal/workit/tree/master/packages/zeebe-elasticsearch-client) par défaut. |
+| [workit-camunda](https://github.com/VilledeMontreal/workit/tree/master/packages/workit-camunda) | Ce module permet de changer de plateforme (Camunda BPM / Zeebe) très facilement. Il suffit de remplacer un flag.<br> Il utilise [`workit-bpm-client`](https://github.com/VilledeMontreal/workit/tree/master/packages/workit-bpm-client) and [`workit-zeebe-client`](https://github.com/VilledeMontreal/workit/tree/master/packages/workit-zeebe-client) par défaut. |
 
 ## L'installation
 

codecov.yml

@@ -0,0 +1,15 @@
+codecov:
+    notify:
+      require_ci_to_pass: no
+  comment:
+    layout: "header, changes, diff, files"
+    behavior: default
+  coverage:
+    status:
+      patch:
+        default:
+          target: 80%
+      project:
+        default:
+          target: auto
+          threshold: 1%

examples/basic/package.json

@@ -6,7 +6,9 @@
   "main": "lib/src/worker.js",
   "typings": "lib/src/worker.d.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\"",
+    "test": "echo \"no test specified\"",
+    "test:all": "echo \"no test specified\"",
+    "codecov": "echo \"no tests yet\"",
     "docs": "echo \"no doc specified\"",
     "compile": "rm -rf ./lib/ && npm run build",
     "build": "tsc -p ./tsconfig.json",
@@ -44,7 +46,7 @@
     "camunda",
     "zeebe"
   ],
-  "author": "Olivier Albertini <[email protected]>",
+  "author": "Montreal City Authors",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/VilledeMontreal/workit/issues"

examples/binding/package.json

@@ -6,7 +6,9 @@
   "main": "lib/src/worker.js",
   "typings": "lib/src/worker.d.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\"",
+    "test": "echo \"no test specified\"",
+    "test:all": "echo \"no test specified\"",
+    "codecov": "echo \"no tests yet\"",
     "docs": "echo \"no doc specified\"",
     "compile": "rm -rf ./lib/ && npm run build",
     "build": "tsc -p ./tsconfig.json",
@@ -44,7 +46,7 @@
     "camunda",
     "zeebe"
   ],
-  "author": "Olivier Albertini <[email protected]>",
+  "author": "Montreal City Authors",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/VilledeMontreal/workit/issues"

examples/event/package.json

@@ -6,8 +6,10 @@
   "main": "lib/src/worker.js",
   "typings": "lib/src/worker.d.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\"",
+    "test": "echo \"no test specified\"",
+    "test:all": "echo \"no test specified\"",
     "docs": "echo \"no doc specified\"",
+    "codecov": "echo \"no tests yet\"",
     "compile": "rm -rf ./lib/ && npm run build",
     "build": "tsc -p ./tsconfig.json",
     "watch": "tsc -p ./tsconfig.json --watch",
@@ -44,7 +46,7 @@
     "camunda",
     "zeebe"
   ],
-  "author": "Olivier Albertini <[email protected]>",
+  "author": "Montreal City Authors",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/VilledeMontreal/workit/issues"

examples/failure-strategy/package.json

@@ -6,7 +6,9 @@
   "main": "lib/src/worker.js",
   "typings": "lib/src/worker.d.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\"",
+    "test": "echo \"no test specified\"",
+    "test:all": "echo \"no test specified\"",
+    "codecov": "echo \"no tests yet\"",
     "docs": "echo \"no doc specified\"",
     "compile": "rm -rf ./lib/ && npm run build",
     "build": "tsc -p ./tsconfig.json",
@@ -43,7 +45,7 @@
     "example",
     "camunda"
   ],
-  "author": "Olivier Albertini <[email protected]>",
+  "author": "Montreal City Authors",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/VilledeMontreal/workit/issues"

examples/opentelemetry/package.json

@@ -6,7 +6,9 @@
   "main": "lib/src/worker.js",
   "typings": "lib/src/worker.d.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\"",
+    "test": "echo \"no test specified\"",
+    "test:all": "echo \"no test specified\"",
+    "codecov": "echo \"no tests yet\"",
     "docs": "echo \"no doc specified\"",
     "compile": "rm -rf ./lib/ && npm run build",
     "build": "tsc -p ./tsconfig.json",
@@ -49,7 +51,7 @@
     "camunda",
     "zeebe"
   ],
-  "author": "Olivier Albertini <[email protected]>",
+  "author": "Montreal City Authors",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/VilledeMontreal/workit/issues"

examples/parallel/package.json

@@ -6,7 +6,9 @@
   "main": "lib/src/worker.js",
   "typings": "lib/src/worker.d.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\"",
+    "test": "echo \"no test specified\"",
+    "test:all": "echo \"no test specified\"",
+    "codecov": "echo \"no tests yet\"",
     "docs": "echo \"no doc specified\"",
     "compile": "rm -rf ./lib/ && npm run build",
     "build": "tsc -p ./tsconfig.json",
@@ -44,7 +46,7 @@
     "camunda",
     "zeebe"
   ],
-  "author": "Olivier Albertini <[email protected]>",
+  "author": "Montreal City Authors",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/VilledeMontreal/workit/issues"

greenkeeper.json

@@ -8,6 +8,7 @@
         "examples/event/package.json",
         "examples/opentelemetry/package.json",
         "examples/parallel/package.json",
+        "examples/failure-strategy/package.json",
         "packages/workit-types/package.json",
         "packages/workit-core/package.json",
         "packages/workit-bpm-client/package.json",

package.json

@@ -10,20 +10,21 @@
     "build": "lerna run build",
     "lint-fix": "lerna run lint-fix",
     "test": "lerna run test",
+    "test:all": "lerna run test:all",
     "test:integration": "lerna run test:integration --scope=workit-camunda",
     "clean": "lerna clean -y",
     "publish:ci": "lerna run lint-fix && lerna publish --canary --yes",
     "publish": "lerna run lint-fix && lerna publish",
     "bootstrap": "lerna bootstrap",
     "bump": "lerna publish",
     "remark-lint": "remark .",
-    "codecov": "codecov -f ./packages/workit-camunda/coverage/*.json"
+    "codecov": "lerna run codecov"
   },
   "devDependencies": {
     "@types/node": "^13.1.6",
     "@commitlint/cli": "^8.2.0",
     "@commitlint/config-conventional": "^8.2.0",
-    "codecov": "^3.6.1",
+    "codecov": "^3.6.2",
     "lerna": "^3.19.0",
     "lerna-changelog": "^0.8.3",
     "remark-cli": "^7.0.1",

packages/workit-bpm-client/package.json

@@ -2,7 +2,7 @@
   "name": "workit-bpm-client",
   "version": "4.0.3",
   "description": "Camunda BPM client for WorkIt that works with Camunda platform powered by TypeScript",
-  "author": "Olivier Albertini <[email protected]>",
+  "author": "Montreal City Authors",
   "homepage": "https://github.com/VilledeMontreal/workit#readme",
   "license": "MIT",
   "main": "lib/src/index.js",
@@ -44,19 +44,22 @@
     "tslint-consistent-codestyle": "^1.16.0",
     "tslint-microsoft-contrib": "^6.2.0",
     "typedoc": "^0.16.0",
+    "codecov": "^3.6.2",
     "typescript": "^3.7.4"
   },
   "engines": {
     "node": ">=8.11.4"
   },
   "scripts": {
     "test": "jest --testPathIgnorePatterns integration --coverage",
+    "test:all": "jest **/tests/**/*.spec.ts --coverage",
     "compile": "rm -rf ./lib/ && npm run build",
     "build": "tsc -p ./tsconfig.json",
     "watch": "tsc -p ./tsconfig.json --watch",
     "lint": "tslint --project ./tsconfig.json && prettier -l \"src/**/*.ts\"",
     "lint-fix": "tslint --project ./tsconfig.json --fix && prettier \"src/**/*.ts\" --write",
-    "docs": "typedoc --out ./docs --tsconfig ./tsconfig.json --excludePrivate --mode file"
+    "docs": "typedoc --out ./docs --tsconfig ./tsconfig.json --excludePrivate --mode file",
+    "codecov": "codecov -f coverage/*.json -p ../../"
   },
   "husky": {
     "hooks": {
@@ -76,7 +79,10 @@
     "test": "__tests__"
   },
   "files": [
-    "lib"
+    "lib/src/**/*.js",
+    "lib/src/**/*.d.ts",
+    "LICENSE",
+    "README.md"
   ],
   "repository": {
     "type": "git",

packages/workit-camunda/package.json

@@ -2,7 +2,7 @@
   "name": "workit-camunda",
   "version": "4.0.3",
   "description": "Worker for Node.js system with pluggable Camunda clients that works with both Zeebe and Camunda platform powered by TypeScript",
-  "author": "Olivier Albertini <[email protected]>",
+  "author": "Montreal City Authors",
   "homepage": "https://github.com/VilledeMontreal/workit#readme",
   "license": "MIT",
   "main": "lib/src/index.js",
@@ -40,21 +40,23 @@
     "tslint-config-prettier": "^1.18.0",
     "tslint-consistent-codestyle": "^1.16.0",
     "tslint-microsoft-contrib": "^6.2.0",
-    "typedoc": "^0.16.0",
+    "typedoc": "^0.16.9",
+    "codecov": "^3.6.2",
     "typescript": "^3.7.4"
   },
   "engines": {
     "node": ">=8.11.4"
   },
   "scripts": {
     "test": "jest --testPathIgnorePatterns integration --coverage",
-    "test:integration": "jest **/tests/**/*.spec.ts --runInBand --detectOpenHandles --coverage",
+    "test:all": "jest **/tests/**/*.spec.ts --runInBand --detectOpenHandles --coverage",
     "compile": "rm -rf ./lib/ && npm run build",
     "build": "tsc -p ./tsconfig.json",
     "watch": "tsc -p ./tsconfig.json --watch",
     "lint": "tslint --project ./tsconfig.json && prettier -l \"src/**/*.ts\"",
     "lint-fix": "tslint --project ./tsconfig.json --fix && prettier \"src/**/*.ts\" --write",
-    "docs": "typedoc --out ./docs --tsconfig ./tsconfig.json --excludePrivate --mode file"
+    "docs": "typedoc --out ./docs --tsconfig ./tsconfig.json --excludePrivate --mode file",
+    "codecov": "codecov -f coverage/*.json -p ../../"
   },
   "husky": {
     "hooks": {
@@ -76,7 +78,10 @@
     "test": "__tests__"
   },
   "files": [
-    "lib"
+    "lib/src/**/*.js",
+    "lib/src/**/*.d.ts",
+    "LICENSE",
+    "README.md"
   ],
   "repository": {
     "type": "git",