New build pipeline

.gitignore

@@ -17,3 +17,4 @@ dist/
 packages/web3/dist/
 lerna-debug.log
 !./dist/web3.min.js
+.nyc_output

.jshintrc

@@ -15,5 +15,6 @@
     "undef": true,
     "predef": [
         "console"
-    ]
+    ],
+    "esversion": 6
 }

.nycrc

@@ -0,0 +1,4 @@
+{
+    "extends": "@istanbuljs/nyc-config-babel",
+    "reporter": ["json", "html"]
+}

CHANGELOG.md

@@ -46,8 +46,6 @@ Released with 1.0.0-beta.37 code base.
 - ``requestOptions`` added to ``WebsocketProvider`` (#2979)
 - Node >= v8.0.0 support (#2938)
 
-## [Unreleased]
-
 ## [1.2.2]
 
 ### Added
@@ -83,11 +81,16 @@ Released with 1.0.0-beta.37 code base.
 - The receipt will now returned on a EVM error (this got removed on beta.18) (#3129)
 - Fixes transaction confirmations with the HttpProvider (#3140)
 
+## [Unreleased]
+
 ## [1.2.3]
 
 ### Added
 
-### Fixed
+- New build pipeline (#3160)
+
+## Fixed
 
+- ``regeneratorRuntime`` error fixed (#3155)
 - Fix TS types for eth.subscribe syncing, newBlockHeaders, pendingTransactions (#3159)
 - Improve web3-eth-abi decodeParameters error message (#3134)

README.md

@@ -36,17 +36,15 @@ _Note_: works only in the Browser for now. (PR welcome).
 meteor add ethereum:web3
 ```
 
-### In the Browser
+### Browser
 
-Use the prebuild `dist/web3.min.js`, or
-build using the [web3.js][repo] repository:
+There are three ways to use this package in the browser:
 
-```bash
-npm run-script build
-```
+- Install it with ``npm`` and bundle it with the preferred bundler (rollup, webpack, or parcel).
+- Use the ``unpkg`` or ``jsdelivr`` CDN.
+- Install it with ``npm`` and load the minified file from the ``node_modules`` folder.
 
-Then include `dist/web3.js` in your html file.
-This will expose `Web3` on the window object.
+If you use the CDN or minified version from the ``node_modules`` folder, a ``Web3`` property will be exposed on the ``window`` object in your browser.
 
 ## Usage
 
@@ -115,27 +113,79 @@ sudo apt-get install nodejs
 sudo apt-get install npm
 ```
 
-### Building (gulp)
-
-Build only the web3.js package
-
-```bash
-npm run-script build
+### Build Pipeline
+
+**Scripts**
+
+- ``build:all`` - Creates CJS and ESM bundles for all packages
+- ``build:all:cjs`` - Creates CJS bundles for all packages
+- ``build:all:esm`` - Creates ESM bundles for all packages
+- ``build:all:minified`` - Creates minified UMD bundles with the cjs bundles as the source for all packages
+- ``build:all:release`` - Creates CJS, ESM, and minified UMD bundles for all packages.
+- ``build:web3`` - Creates just the CJS and ESM bundle of the web3 umbrella package
+- ``build:web3:minified`` - Creates all CJS and ESM bundles of all packages and creates a web3.min after
+
+**Generated Bundles**
+
+- ``main`` 
+  + Will be used in nodejs on a normal ``require(...)`` and does have the CJS module format.
+- ``module``
+  + Will be used for ESM-ready tools and does have the ES format.
+- ``unpkg`` 
+  + Will be used from the ``unpkg`` CDN and does contain the minified UMD formatted bundle.
+- ``jsdelivr``
+  + Will be used from the ``jsdelivr`` CDN and does contain the minified UMD formatted bundle.
+
+**Configuration**
+
+The base configuration is located in the root folder of this repository and does return the configuration function which will be used in each package of this project. 
+
+Properties of the [config function](https://github.com/ethereum/web3.js/tree/1.x/rollup.config.js): 
+
+- ``name: string``
+  + Will be used for named exports
+- ``outputFileName: string``
+  + Name of the output file
+- ``globals: {[key: string]: string}``
+  + pre-defined names for the globally available packages (used in CJS and ESM)
+- ``dedupe: string[]``
+  + Will be used to remove duplicated modules in the minified UMD bundles.
+- ``namedExports: boolean``
+  + Simple config to activate named exports for the bundles of a package
+
+Example Usage:
+``` javascript
+import pkg from './package.json';
+import rollupConfig from '../../rollup.config';
+
+export default rollupConfig(
+    'Web3Net',
+    pkg.name,
+    {
+        'web3-core': 'Web3Core',
+        'web3-core-method': 'Web3CoreMethod',
+        'web3-utils': 'Web3Utils'
+    },
+    ['bn.js', 'elliptic', 'js-sha3', 'underscore']
+);
 ```
 
-Or build all sub packages as well:
 
-```bash
-npm run-script build-all
-```
+### Testing 
 
-This will put all the browser build files into the `dist` folder.
+**Scripts**
 
-### Testing (mocha)
+- ``test:unit`` - Runs just the unit tests
+- ``test:e2e:ganache`` - Runs the e2e tests with ganache
+- ``test:e2e:geth:auto`` - Runs the e2e tests with geth automine
+- ``test:e2e:geth:insta`` - Runs the e2e tests with geth instaseal
+- ``test:e2e:clients`` - Runs the e2e tests with geth and ganache
+- ``test:e2e:chrome`` - Runs the e2e tests in Chrome
+- ``test:e2e:firefox`` - Runs the e2e tests in Firefox
+- ``test:e2e:browsers`` - Runs the e2e tests in Chrome and Firefox
+- ``test:e2e:publish`` - Creates a virtual npm registry for running third party tests
+- ``test:e2e:truffle`` - Runs the truffle tests with the current working state of web3
 
-```bash
-npm test
-```
 
 ### Contributing
 

docs/getting-started.rst

@@ -24,7 +24,7 @@ First you need to get web3.js into your project. This can be done using the foll
 
 - npm: ``npm install web3``
 - meteor: ``meteor add ethereum:web3``
-- pure js: link the ``dist/web3.min.js``
+- browser (without bundler): link the ``dist/web3.min.js`` from your ``node_modules`` folder or use the ``unpkg`` or ``jsdelivr`` CDN.
 
 After that you need to create a web3 instance and set a provider.
 Ethereum supported Browsers like Mist or MetaMask will have a ``ethereumProvider`` or ``web3.currentProvider`` available. For  web3.js, check ``Web3.givenProvider``.