Mark Stacey
3b30984ce5
|
2 years ago | |
---|---|---|
.. | ||
transforms | 2 years ago | |
README.md | 2 years ago | |
constants.js | 2 years ago | |
display.js | 3 years ago | |
etc.js | 2 years ago | |
index.js | 2 years ago | |
manifest.js | 2 years ago | |
sass-compiler.js | 4 years ago | |
scripts.js | 2 years ago | |
static.js | 2 years ago | |
styles.js | 2 years ago | |
task.js | 3 years ago | |
utils.js | 2 years ago |
README.md
The MetaMask Build System
tl;dr
yarn dist
for prod,yarn start
for local development. Add--build-type flask
to build Flask, our canary distribution with more experimental features.
This directory contains the MetaMask build system, which is used to build the MetaMask Extension such that it can be used in a supported browser.
From the repository root, the build system entry file is located at ./development/build/index.js
.
Several package scripts invoke the build system.
For example, yarn start
creates a watched development build, and yarn dist
creates a production build.
Some of these scripts applies lavamoat
to the build system, and some do not.
For local development, building without lavamoat
is faster and therefore preferable.
The build system is not a full-featured CLI, but rather a script that expects some command line arguments and environment variables. For instructions regarding environment variables, see the main repository readme.
Generally speaking, the build system consists of gulp
tasks that either manipulate static assets or bundle source files using Browserify.
Production-ready zip files are written to the ./builds
directory, while "unpacked" extension builds
are written to the ./dist
directory.
Our JavaScript source files are transformed using Babel, specifically using
the babelify
Browserify transform.
Source file bundling tasks are implemented in the ./development/build/scripts.js
.
Locally implemented Browserify transforms, some of which affect how we write JavaScript, are listed and documented here.
Usage
See node ./development/build/index.js --help