WIP: Relates to #81. Update to Electron v4.1.0 (#91)

* fix: Fixes #81. Update to Electron 4

* misc: Contributor instructions. Minimum Node.js version check for Electron 4

* Add contributor instructions for forking, cloning, testing, linting, and building

* Add contributor instructions for checking if dependencies need updating

* Add contributor instructions for updating dependencies and checking that latest
library updates integrate with other repos by adding a version number to the package.json
so that it may be installed from a remote branch.

* Add minimum Node.js version compatible with Electron 4.

* docs: Use NPM outdated

* fix: Add typescript to devDependencies of abi package to fix missing tsc when install as dependency

* fix: Add Typescript dependency to all packages to avoid missing tsc binary error when install as dependency

* fix: Use tsc binary of package not global version

* fix: Install dependencies first before run tsc

* fix: Install dependencies before run tsc

* Able to run yarn and yarn build using Node.js v10.11.0

* feat: Relates to #81. Update to Electron v3.1.0

* Update to Electron v3.1.0 - https://github.com/electron/electron/releases

* Update Readme

* Update dependencies versions

* Add .nvmrc

* fix: Add version to NPM package.json

Otherwise when try to use the package from a remote branch such as
```
"@parity/electron": "https://github.com/paritytech/js-libs.git#luke-81-electron-3",
```
Then it produces error:
```
error Can't add "@parity/electron": invalid package version undefined.
```

* fix: Update dependencies. See commit details

When I add this to the fether-electron package.json dependency with:
```
    "@parity/electron": "https://github.com/paritytech/js-libs.git#luke-81-electron-3",
```
And then try to run `yarn; yarn build;`, it gives the following error:

```
scon @ ~/code/src/paritytech/fether - [luke-309-electron-3] $ yarn; yarn build
yarn install v1.12.3
[1/5] 🔍  Validating package.json...
[2/5] 🔍  Resolving packages...
[3/5] 🚚  Fetching packages...
[4/5] 🔗  Linking dependencies...
warning " > [email protected]" has unmet peer dependency "eslint@>= 4.12.1".
warning " > [email protected]" has unmet peer dependency "prop-types@^15.6.1".
warning " > [email protected]" has unmet peer dependency "react@^16.4.0".
warning "workspace-aggregator-cc67e372-3487-4efc-8fcb-a403fb15962c > fether-react > @parity/[email protected]" has incorrect peer dependency "rxjs@~6.2.2".
warning "workspace-aggregator-cc67e372-3487-4efc-8fcb-a403fb15962c > fether-react > @parity/[email protected]" has incorrect peer dependency "rxjs@~6.2.2".
warning "workspace-aggregator-cc67e372-3487-4efc-8fcb-a403fb15962c > fether-react > [email protected]" has unmet peer dependency "prop-types@^15.6.0".
warning "workspace-aggregator-cc67e372-3487-4efc-8fcb-a403fb15962c > fether-react > [email protected]" has unmet peer dependency "prop-types@^15.6.0".
warning "workspace-aggregator-cc67e372-3487-4efc-8fcb-a403fb15962c > fether-react > @babel/[email protected]" has unmet peer dependency "@babel/core@^7.0.0-0".
warning "workspace-aggregator-cc67e372-3487-4efc-8fcb-a403fb15962c > fether-ui > [email protected]" has unmet peer dependency "react-dom@>=0.14.0 <= 16".
warning "workspace-aggregator-cc67e372-3487-4efc-8fcb-a403fb15962c > fether-react > @babel/plugin-proposal-decorators > @babel/[email protected]" has unmet peer dependency "@babel/core@^7.0.0-0".
[5/5] 📃  Building fresh packages...
[1/2] ⠄ @parity/electron
error /Users/scon/code/src/paritytech/fether/node_modules/@parity/electron: Command failed.
Exit code: 1
Command: yarn build
Arguments:
Directory: /Users/scon/code/src/paritytech/fether/node_modules/@parity/electron
Output:
yarn run v1.12.3
$ lerna exec yarn build --stream
lerna notice cli v3.10.1
lerna info Executing command in 6 packages: "yarn build"
@parity/abi: $ rimraf lib
@parity/electron: $ rimraf lib
@parity/abi: $ tsc
@parity/abi: /bin/sh: tsc: command not found
@parity/electron: $ tsc
@parity/abi: error Command failed with exit code 127.
@parity/abi: info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
@parity/electron: /bin/sh: tsc: command not found
lerna ERR! yarn build exited 1 in '@parity/abi'
lerna WARN complete Waiting for 1 child process to exit. CTRL-C to exit immediately.
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
```

* review-fix: Updates to address comments in the electron 3 PR

* fix: Remove useless .nvmrc file

* review-fix: Update Readme Step 7

* review-fix: Revert back to just tsc command since resolved Step 7 issue

* review-fix: Remove version number from main package.json. See Readme updates

* fix: Remove .npmrc file

* remove .nvmrc

* review-fix: Fix to resolve CI failing as cannot find matching electron version

Tries to solve the following error when push to Github and CI runs
```
CI is failing with error Couldn't find any versions for "electron" that matches "^2.0.2 | ^3.1.0 | ^4.0.1"
```

* review-fix: Remove version number

* review-fix: Revert to just tsc in package.json build

Author: ltfschoen

README.md

@@ -31,6 +31,69 @@ And below are the lower-level packages, used internally, or by advanced users.
 | [`@parity/contracts`](/packages/contracts) | [![npm (scoped)](https://img.shields.io/npm/v/@parity/contracts.svg)](https://www.npmjs.com/package/@parity/contracts) | [![README](https://img.shields.io/badge/docs-README-green.svg)](/packages/contracts#readme)      | Parity's [contracts](https://github.com/parity-contracts) as ES6 classes. |
 | [`@parity/electron`](/packages/electron)   | [![npm (scoped)](https://img.shields.io/npm/v/@parity/electron.svg)](https://www.npmjs.com/package/@parity/electron)   | [![README](https://img.shields.io/badge/docs-README-green.svg)](/packages/electron#readme)       | Control the Parity Ethereum node from Electron.                           |
 
+### Contributing
+
+#### Dependencies
+
+Install at least `yarn` version 1.4.2 and [Node.js >=10.10.0](https://nodejs.org/en/)
+
+```
+yarn --version // Should be at least 1.4.2
+```
+
+#### Tests
+
+```
+yarn test
+```
+
+#### Build
+
+```
+yarn build
+```
+
+#### Maintenance
+
+1. Fork the repo
+
+2. Clone your fork
+```bash
+git clone https://github.com/<INSERT_YOUR_GITHUB_USERNAME>/js-libs
+```
+
+3. Check outdated dependencies
+
+```bash
+yarn outdated
+```
+
+4. Create a branch
+
+```bash
+git checkout -b <INSERT_YOUR_BRANCH_NAME>
+```
+
+5. Run tests, linting, and build
+
+```bash
+yarn test; yarn lint; yarn build
+```
+
+6. Push the branch to your fork of the repo
+
+7. Integrate the updated library as a dependency. Example: If you want to test a branch of one of the js-lib packages in another project like Fether temporarily, then build js-libs and replace the /lib directory where it's a dependency on the Fether project. Then run Fether to use it:
+
+```bash
+~/paritytech/js-libs [my-branch-name] $ yarn build
+~/paritytech/js-libs [my-branch-name] $ cp -r packages/my-package/lib ../fether/node_modules/@parity/my-package/lib
+~/paritytech/js-libs [my-branch-name] $ cd ../fether
+~/paritytech/fether [master] $ yarn start
+```
+
+8. Create a pull request from your fork of the repo to the upstream master branch
+
+
 ## License
 
 All Parity's JavaScript libraries are open-source software [licensed as MIT](/LICENSE).

package.json

@@ -17,6 +17,10 @@
       "packages/*"
     ]
   },
+  "engines": {
+    "node": ">=10.10.0",
+    "yarn": "^1.4.2"
+  },
   "scripts": {
     "build": "lerna exec yarn build --stream",
     "lint": "tslint 'packages/**/*.ts'",

packages/abi/package.json

@@ -21,7 +21,8 @@
     "test": "jest"
   },
   "devDependencies": {
-    "@types/utf8": "^2.1.6"
+    "@types/utf8": "^2.1.6",
+    "typescript": "^3.1.6"
   },
   "dependencies": {
     "bignumber.js": "^8.0.1",

packages/api/package.json

@@ -35,7 +35,8 @@
     "sinon": "1.17.7",
     "sinon-as-promised": "4.0.2",
     "sinon-chai": "2.8.0",
-    "ts-node": "^7.0.1"
+    "ts-node": "^7.0.1",
+    "typescript": "^3.1.6"
   },
   "dependencies": {
     "@parity/abi": "^3.0.25",

packages/contracts/package.json

@@ -25,5 +25,8 @@
     "@parity/abi": "^3.0.25",
     "@parity/api": "^3.0.25",
     "bignumber.js": "^8.0.1"
+  },
+  "devDependencies": {
+    "typescript": "^3.1.6"
   }
 }

packages/electron/package.json

@@ -21,21 +21,22 @@
     "test": "jest"
   },
   "dependencies": {
-    "async-retry": "^1.2.1",
+    "async-retry": "^1.2.3",
     "axios": "^0.18.0",
     "checksum": "^0.1.1",
-    "command-exists": "^1.2.6",
-    "debug": "^4.1.0",
-    "electron-dl": "^1.11.0",
+    "command-exists": "^1.2.8",
+    "debug": "^4.1.1",
+    "electron-dl": "^1.12.0",
     "promise-any": "^0.2.0",
-    "sntp": "^3.0.1"
+    "sntp": "^3.0.2"
   },
   "devDependencies": {
     "@types/async-retry": "^1.2.1",
     "@types/checksum": "^0.1.30",
-    "electron": "^2.0.2"
+    "electron": "^4.0.1",
+    "typescript": "^3.1.6"
   },
   "peerDependencies": {
-    "electron": "^2.0.3"
+    "electron": "^2.0.2 | ^3.1.0 | ^4.0.1"
   }
 }

packages/light.js-react/package.json

@@ -38,7 +38,8 @@
     "enzyme-adapter-react-16": "^1.2.0",
     "jest-enzyme": "^6.0.3",
     "react": "^16.4.2",
-    "react-dom": "^16.4.2"
+    "react-dom": "^16.4.2",
+    "typescript": "^3.1.6"
   },
   "peerDependencies": {
     "@parity/light.js": "^3.0.0",

packages/light.js/package.json

@@ -37,7 +37,8 @@
     "@types/debug": "^0.0.30",
     "@types/memoizee": "^0.4.2",
     "eventemitter3": "^3.1.0",
-    "rxjs": "~6.2.2"
+    "rxjs": "~6.2.2",
+    "typescript": "^3.1.6"
   },
   "peerDependencies": {
     "rxjs": "~6.2.2"