m/metamask-extension
1
0
Fork 0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-11-25 20:02:58 +01:00
Code
0ac54e40ee
metamask-extension/development/build
History
Danica Shen f5e2183a7f
feat(17494): beta build trigger in release branch and cleanup (#17749) 
* feat(17494): test separate commit triggered build

* feat(17493): keep consistent commit message

* feat(17493): use trim to get rid of white space in branch name

* feat(17493): bring back some pipelines

* Version v10.25.0-beta.0

* ERC1155 Import & Dapp interaction E2E tests (#17885)

* feat(17494): test separate commit triggered build

* feat(17493): remove testing beta commit in package.json

---------

Co-authored-by: Thomas Huang <tmashuang@users.noreply.github.com>
2023-03-04 12:51:04 +00:00
..
transforms [MMI] Adds mmi build type + manifest files and images (#17842) 2023-03-01 09:38:15 +00:00
config.js [MMI] Adds mmi build type + manifest files and images (#17842) 2023-03-01 09:38:15 +00:00
constants.js
display.js
etc.js
index.js
manifest.js
README.md Migrate the build script to yargs (#14836) 2022-06-21 17:37:05 -02:30
sass-compiler.js
scripts.js [MMI] Conditional change title in home if buildType is MMI (#17898) 2023-03-02 10:18:46 -06:00
static.js [MMI] Adds mmi build type + manifest files and images (#17842) 2023-03-01 09:38:15 +00:00
styles.js
task.js
utils.js feat(17494): beta build trigger in release branch and cleanup (#17749) 2023-03-04 12:51:04 +00:00

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