Add typescript support (web3#3652)

* modernize web3-core

* add tsconfig

* add tsc to package.json

* ignore lib

* build works

* tests pass

* update script

* remove old dist

* address comments

* change main

* bump cache

* add build step to ci

* add pre build step for ci tests

* remove comments

* update changelog

* revert to old dist

Author: GregTheGreek

.github/workflows/build.yml

@@ -26,7 +26,7 @@ jobs:
                   path: |
                       node_modules
                       */*/node_modules
-                  key: 0-${{ runner.os }}-node12-${{ hashFiles('**/package-lock.json') }}
+                  key: 2-${{ runner.os }}-node12-${{ hashFiles('**/package-lock.json') }}
             - run: bash ./scripts/install.sh
               if: steps.cache-deps.outputs.cache-hit != 'true'
             - run: bash ./scripts/ci.sh
@@ -48,7 +48,7 @@ jobs:
                   path: |
                       node_modules
                       */*/node_modules
-                  key: 0-${{ runner.os }}-node${{ matrix.node }}-${{ hashFiles('**/package-lock.json') }}
+                  key: 2-${{ runner.os }}-node${{ matrix.node }}-${{ hashFiles('**/package-lock.json') }}
             - run: bash ./scripts/install.sh
               if: steps.cache-deps.outputs.cache-hit != 'true'
             - run: bash ./scripts/ci.sh
@@ -78,7 +78,7 @@ jobs:
                   path: |
                       node_modules
                       */*/node_modules
-                  key: 0-${{ runner.os }}-node12-${{ hashFiles('**/package-lock.json') }}
+                  key: 2-${{ runner.os }}-node12-${{ hashFiles('**/package-lock.json') }}
             - run: bash ./scripts/install.sh
               if: steps.cache-deps.outputs.cache-hit != 'true'
             - run: bash ./scripts/ci.sh

.gitignore

@@ -19,3 +19,4 @@ contracts/
 migrations/
 truffle-config.js
 test/config/ensAddresses.json
+*/**/lib

CHANGELOG.md

@@ -270,7 +270,12 @@ Released with 1.0.0-beta.37 code base.
 
 ### Added
 
+- Support for typescript files (.ts) to be writtern alongside regular .js files (#3652)
+
 ### Changed
 
+- `npm run build` now uses TSC to compile (.js allowed) and the build folder is now located under `lib` (#3652)
+- Modernized web3-core to use newer es syntax (#3652)
+
 ### Fixed
 

package-lock.json

@@ -17,12 +17,12 @@
     "scripts": {
         "version": "npm run build",
         "postinstall": "npm run bootstrap",
-        "build": "npm run bootstrap && webpack && cp -r ./dist ./packages/web3",
+        "build": "npm run bootstrap && lerna run tsc && webpack && cp -r ./dist ./packages/web3",
         "publish": "lerna publish",
         "bootstrap": "lerna bootstrap --hoist",
         "lint": "jshint *.js packages",
-        "test": "mocha --grep E2E --invert; jshint *.js packages",
-        "test:unit": "nyc --no-clean --silent _mocha -- -R spec --grep E2E --invert --exit",
+        "test": "mocha -R spec --require ts-node/register --grep E2E --invert",
+        "test:unit": "nyc --no-clean --silent _mocha -- -R spec --require ts-node/register --grep E2E --invert --exit",
         "test:cov": "npm run cov:clean; npm run test:unit; npm run test:e2e:clients; npm run cov:merge_reports",
         "dtslint": "lerna run dtslint",
         "depcheck": "lerna exec dependency-check -- --missing --verbose .",
@@ -128,6 +128,7 @@
         "nyc": "^14.1.1",
         "pify": "^4.0.1",
         "sandboxed-module": "^2.0.3",
+        "ts-node": "^8.10.2",
         "typescript": "^3.9.5",
         "underscore": "1.9.1",
         "wait-port": "^0.2.6",

package.json

@@ -9,9 +9,10 @@
     },
     "types": "types/index.d.ts",
     "scripts": {
+        "tsc": "tsc -b tsconfig.json",
         "dtslint": "dtslint --localTs ../../node_modules/typescript/lib types"
     },
-    "main": "src/index.js",
+    "main": "lib/index.js",
     "dependencies": {
         "@types/node": "^12.12.6",
         "got": "9.6.0",

packages/web3-bzz/package.json

@@ -0,0 +1,9 @@
+{
+    "extends": "../../tsconfig.json",
+    "compilerOptions": {
+      "outDir": "./lib"
+    },
+    "include": [
+      "./src"
+    ]
+   }

packages/web3-bzz/tsconfig.json

@@ -9,9 +9,10 @@
     },
     "types": "types/index.d.ts",
     "scripts": {
+        "tsc": "tsc -b tsconfig.json",
         "dtslint": "dtslint --localTs ../../node_modules/typescript/lib types"
     },
-    "main": "src/index.js",
+    "main": "lib/index.js",
     "dependencies": {
         "underscore": "1.9.1",
         "web3-eth-iban": "1.2.11",

packages/web3-core-helpers/package.json

@@ -0,0 +1,9 @@
+{
+    "extends": "../../tsconfig.json",
+    "compilerOptions": {
+      "outDir": "./lib"
+    },
+    "include": [
+      "./src"
+    ]
+   }

packages/web3-core-helpers/tsconfig.json

@@ -9,9 +9,10 @@
     },
     "types": "types/index.d.ts",
     "scripts": {
+        "tsc": "tsc -b tsconfig.json",
         "dtslint": "dtslint --localTs ../../node_modules/typescript/lib types"
     },
-    "main": "src/index.js",
+    "main": "lib/index.js",
     "dependencies": {
         "@ethersproject/transactions": "^5.0.0-beta.135",
         "underscore": "1.9.1",