Exclude files from builds by build type (#12521)
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.
feature/default_network_editable
Erik Marks
3 years ago
committed by
GitHub
parent
0c229e2d4a
commit
a2d3d942ec
@ -0,0 +1,21 @@ |
||||
diff --git a/node_modules/@eslint/eslintrc/lib/config-array-factory.js b/node_modules/@eslint/eslintrc/lib/config-array-factory.js
|
||||
index c7ff6a0..6a88c6d 100644
|
||||
--- a/node_modules/@eslint/eslintrc/lib/config-array-factory.js
|
||||
+++ b/node_modules/@eslint/eslintrc/lib/config-array-factory.js
|
||||
@@ -41,7 +41,6 @@
|
||||
|
||||
const fs = require("fs");
|
||||
const path = require("path");
|
||||
-const importFresh = require("import-fresh");
|
||||
const stripComments = require("strip-json-comments");
|
||||
const ConfigValidator = require("./shared/config-validator");
|
||||
const naming = require("./shared/naming");
|
||||
@@ -222,7 +221,7 @@ function loadLegacyConfigFile(filePath) {
|
||||
function loadJSConfigFile(filePath) {
|
||||
debug(`Loading JS config file: ${filePath}`);
|
||||
try {
|
||||
- return importFresh(filePath);
|
||||
+ return require(filePath);
|
||||
} catch (e) {
|
||||
debug(`Error reading JavaScript file: ${filePath}`);
|
||||
e.message = `Cannot read config file: ${filePath}\nError: ${e.message}`;
|
||||
@ -0,0 +1,13 @@ |
||||
diff --git a/node_modules/eslint/lib/linter/linter.js b/node_modules/eslint/lib/linter/linter.js
|
||||
index adb5c21..4a4be92 100644
|
||||
--- a/node_modules/eslint/lib/linter/linter.js
|
||||
+++ b/node_modules/eslint/lib/linter/linter.js
|
||||
@@ -560,7 +560,7 @@ function resolveParserOptions(parserName, providedOptions, enabledEnvironments)
|
||||
*/
|
||||
function resolveGlobals(providedGlobals, enabledEnvironments) {
|
||||
return Object.assign(
|
||||
- {},
|
||||
+ Object.create(null),
|
||||
...enabledEnvironments.filter(env => env.globals).map(env => env.globals),
|
||||
providedGlobals
|
||||
);
|
||||
@ -0,0 +1,23 @@ |
||||
diff --git a/node_modules/object.values/index.js b/node_modules/object.values/index.js
|
||||
index b8ba091..2dc8083 100644
|
||||
--- a/node_modules/object.values/index.js
|
||||
+++ b/node_modules/object.values/index.js
|
||||
@@ -1,17 +1,3 @@
|
||||
'use strict';
|
||||
|
||||
-var define = require('define-properties');
|
||||
-
|
||||
-var implementation = require('./implementation');
|
||||
-var getPolyfill = require('./polyfill');
|
||||
-var shim = require('./shim');
|
||||
-
|
||||
-var polyfill = getPolyfill();
|
||||
-
|
||||
-define(polyfill, {
|
||||
- getPolyfill: getPolyfill,
|
||||
- implementation: implementation,
|
||||
- shim: shim
|
||||
-});
|
||||
-
|
||||
-module.exports = polyfill;
|
||||
+module.exports = Object.values;
|
||||
Loading…
Reference in new issue