8c3a22f994
We now use two separate Infura project IDs for production builds, and for all other builds. Previously all CI builds used the production Infura project ID. Separating them will make our Infura dashboard metrics more representative of real production usage. The new environment variable for production has been setup in CI already, but the old environment variable will remain set to the production project ID until this commit is included in a release. We can't switch the old environment variable out until we're confident that it won't get used for a production build. We now use constants for the various different build environments. This was done to improve the JSDoc types of the `getInfuraProjectId` helper method. The `getConfigValue` function was added to make it easier to validate that required config values are set. This should ensure builds fail early with an informative error message when they are missing the necessary configuration. |
||
---|---|---|
.. | ||
transforms | ||
display.js | ||
etc.js | ||
index.js | ||
manifest.js | ||
README.md | ||
sass-compiler.js | ||
scripts.js | ||
static.js | ||
styles.js | ||
task.js | ||
utils.js |
The MetaMask Build System
tl;dr
yarn dist
for prod,yarn start
for local development
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
Usage: yarn build <entry-task> [options]
Commands:
yarn build prod Create an optimized build for production environments.
yarn build dev Create an unoptimized, live-reloaded build for local
development.
yarn build test Create an optimized build for running e2e tests.
yarn build testDev Create an unoptimized, live-reloaded build for running
e2e tests.
Options:
--build-type The "type" of build to create. One of: "beta", "main"
[string] [default: "main"]
--lint-fence-files Whether files with code fences should be linted after
fences have been removed by the code fencing transform.
The build will fail if linting fails.
Defaults to `false` if the entry task is `dev` or
`testDev`, and `true` otherwise.
[boolean] [default: <varies>]
--omit-lockdown Whether to omit SES lockdown files from the extension
bundle. Useful when linking dependencies that are
incompatible with lockdown.
[boolean] [default: false]
--skip-stats Whether to refrain from logging build progress. Mostly
used internally.
[boolean] [default: false]