m/metamask-extension
1
0
Fork 0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-12-23 09:52:26 +01:00
Code
a0f3ea7e82
metamask-extension/development/build
History
Mark Stacey 8a85d220e2
Fix testDev builds with LavaMoat enabled (#19506) 
* Fix `devTest` build that have LavaMoat enabled

The build script compiles the LavaMoat runtime during each root task,
but it was not recognizing `testDev` as a root task. As a result, all
`testDev` builds were broken unless LavaMoat was disabled.

The list of root tasks has been updated to include `testDev`. It should
now be complete.

* Use BUILD_TARGETS constant, and enable scuttling in start:test
2023-06-19 16:14:08 -02:30
..
transforms feat: add yaml feature management (#18125) 2023-04-25 16:32:51 +02:00
config.js Have mmi build being generated (#19441) 2023-06-06 16:43:31 +01:00
constants.js Add validation to production build script (#15468) 2022-08-19 15:46:18 -02:30
display.js
etc.js feat: add yaml feature management (#18125) 2023-04-25 16:32:51 +02:00
index.js Fix testDev builds with LavaMoat enabled (#19506) 2023-06-19 16:14:08 -02:30
manifest.js Fix build types not overriding the manifest (#19027) 2023-05-05 18:40:43 +02:00
README.md
sass-compiler.js
scripts.js Deprecated Icon and ButtonIcon clean up (#19220) 2023-05-19 10:33:02 -07:00
static.js feat: add yaml feature management (#18125) 2023-04-25 16:32:51 +02:00
styles.js deps: replace gulp-dart-sass with gulp-sass. (#16302) 2023-04-25 09:37:30 -05:00
task.js Improve logging at build-time (#18780) 2023-04-25 20:33:36 -10:00
utils.js feat: add yaml feature management (#18125) 2023-04-25 16:32:51 +02: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