mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-12-23 09:52:26 +01:00
a2d3d942ec
This PR enables the exclusion of JavaScript and JSON source by `buildType`, and enables the running of `eslint` under LavaMoat. 80-90% of the changes in this PR are `.patch` files and LavaMoat policy additions.
The file exclusion is designed to work in conjunction with our code fencing. If you forget to fence an import statement of an excluded file, the application will now error on boot. **This PR commits us to a particular naming convention for files intended only for certain builds.** Continue reading for details.
### Code Fencing and ESLint
When a file is modified by the code fencing transform, we run ESLint on it to ensure that we fail early for syntax-related issues. This PR adds the first code fences that will be actually be removed in production builds. As a consequence, this was also the first time we attempted to run ESLint under LavaMoat. Making that work required a lot of manual labor because of ESLint's use of dynamic imports, but the manual changes necessary were ultimately quite minor.
### File Exclusion
For all builds, any file in `app/`, `shared/` or `ui/` in a sub-directory matching `**/${otherBuildType}/**` (where `otherBuildType` is any build type except `main`) will be added to the list of excluded files, regardless of its file extension. For example, if we want to add one or more pages to the UI settings in Flask, we'd create the folder `ui/pages/settings/flask`, add any necessary files or sub-folders there, and fence the import statements for anything in that folder. If we wanted the same thing for Beta, we would name the directory `ui/pages/settings/beta`.
As it happens, we already organize some of our source files in this way, namely the logo JSON for Beta and Flask builds. See `ui/helpers/utils/build-types.js` to see how this works in practice.
Because the list of ignored filed is only passed to `browserify.exclude()`, any files not bundled by `browserify` will be ignored. For our purposes, this is mostly relevant for `.scss`. Since we don't have anything like code fencing for SCSS, we'll have to consider how to handle our styles separately.
|
||
|---|---|---|
| .. | ||
| build | ||
| highlights | ||
| lib | ||
| announcer.js | ||
| chromereload.js | ||
| create-static-server.js | ||
| empty.js | ||
| generate-migration.sh | ||
| gource-viz.sh | ||
| jest.config.js | ||
| metamaskbot-build-announce.js | ||
| missing-locale-strings.js | ||
| mock-3box.js | ||
| mock-segment.js | ||
| README.md | ||
| run-ganache.sh | ||
| sentry-publish.js | ||
| sentry-upload-artifacts.sh | ||
| shellcheck.sh | ||
| show-deps-install-scripts.js | ||
| source-map-explorer.sh | ||
| sourcemap-validator.js | ||
| static-server.js | ||
| stream-flat-map.js | ||
| verify-locale-strings.js | ||
Development
Several files which are needed for developing on MetaMask.
Usually each file or directory contains information about its scope / usage.