mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-11-26 04:20:53 +01:00
3de3765425
This PR adds build-time code exclusion by means of code fencing. For details, please see the README in `./development/build/transforms`. Note that linting of transformed files as a form of validation is added in a follow-up, #12075. Hopefully exhaustive tests are added to ensure that the transform works according to its specification. Since these tests are Node-only, they required their own Jest config. The recommended way to work with multiple Jest configs is using the `projects` field in the Jest config, however [that feature breaks coverage collection](https://github.com/facebook/jest/issues/9628). That being the case, I had to set up two separate Jest configs. In order to get both test suites to run in parallel, Jest is now invoked via a script, `./test/run-jest.sh`. By way of example, this build system feature allows us to add fences like this: ```javascript this.store.updateStructure({ ..., GasFeeController: this.gasFeeController, TokenListController: this.tokenListController, ///: BEGIN:ONLY_INCLUDE_IN(beta) PluginController: this.pluginController, ///: END:ONLY_INCLUDE_IN }); ``` Which at build time are transformed to the following if the build type is not `beta`: ```javascript this.store.updateStructure({ ..., GasFeeController: this.gasFeeController, TokenListController: this.tokenListController, }); ``` Co-authored-by: Mark Stacey <markjstacey@gmail.com>
213 lines
4.8 KiB
JavaScript
213 lines
4.8 KiB
JavaScript
module.exports = {
|
|
root: true,
|
|
parser: '@babel/eslint-parser',
|
|
parserOptions: {
|
|
sourceType: 'module',
|
|
ecmaVersion: 2017,
|
|
ecmaFeatures: {
|
|
experimentalObjectRestSpread: true,
|
|
impliedStrict: true,
|
|
modules: true,
|
|
blockBindings: true,
|
|
arrowFunctions: true,
|
|
objectLiteralShorthandMethods: true,
|
|
objectLiteralShorthandProperties: true,
|
|
templateStrings: true,
|
|
classes: true,
|
|
jsx: true,
|
|
},
|
|
},
|
|
|
|
ignorePatterns: [
|
|
'!.eslintrc.js',
|
|
'node_modules/**',
|
|
'dist/**',
|
|
'builds/**',
|
|
'test-*/**',
|
|
'docs/**',
|
|
'coverage/',
|
|
'jest-coverage/',
|
|
'development/chromereload.js',
|
|
'app/vendor/**',
|
|
'test/e2e/send-eth-with-private-key-test/**',
|
|
'nyc_output/**',
|
|
'.vscode/**',
|
|
'lavamoat/*/policy.json',
|
|
],
|
|
|
|
extends: [
|
|
'@metamask/eslint-config',
|
|
'@metamask/eslint-config-nodejs',
|
|
'prettier',
|
|
],
|
|
|
|
plugins: ['@babel', 'import', 'prettier'],
|
|
|
|
globals: {
|
|
document: 'readonly',
|
|
window: 'readonly',
|
|
},
|
|
|
|
rules: {
|
|
'default-param-last': 'off',
|
|
'prefer-object-spread': 'error',
|
|
'require-atomic-updates': 'off',
|
|
|
|
// This is the same as our default config, but for the noted exceptions
|
|
'spaced-comment': [
|
|
'error',
|
|
'always',
|
|
{
|
|
markers: [
|
|
'global',
|
|
'globals',
|
|
'eslint',
|
|
'eslint-disable',
|
|
'*package',
|
|
'!',
|
|
',',
|
|
// Local additions
|
|
'/:', // This is for our code fences
|
|
],
|
|
exceptions: ['=', '-'],
|
|
},
|
|
],
|
|
|
|
'import/no-unassigned-import': 'off',
|
|
|
|
'no-invalid-this': 'off',
|
|
'@babel/no-invalid-this': 'error',
|
|
|
|
// Prettier handles this
|
|
'@babel/semi': 'off',
|
|
|
|
'node/no-process-env': 'off',
|
|
|
|
// TODO: re-enable these rules
|
|
'node/no-sync': 'off',
|
|
'node/no-unpublished-import': 'off',
|
|
'node/no-unpublished-require': 'off',
|
|
},
|
|
overrides: [
|
|
{
|
|
files: ['ui/**/*.js', 'test/lib/render-helpers.js', 'test/jest/*.js'],
|
|
plugins: ['react'],
|
|
extends: ['plugin:react/recommended', 'plugin:react-hooks/recommended'],
|
|
rules: {
|
|
'react/no-unused-prop-types': 'error',
|
|
'react/no-unused-state': 'error',
|
|
'react/jsx-boolean-value': 'error',
|
|
'react/jsx-curly-brace-presence': [
|
|
'error',
|
|
{ props: 'never', children: 'never' },
|
|
],
|
|
'react/no-deprecated': 'error',
|
|
'react/default-props-match-prop-types': 'error',
|
|
'react/jsx-no-duplicate-props': 'error',
|
|
},
|
|
},
|
|
{
|
|
files: ['test/e2e/**/*.spec.js'],
|
|
extends: ['@metamask/eslint-config-mocha'],
|
|
rules: {
|
|
'mocha/no-hooks-for-single-case': 'off',
|
|
'mocha/no-setup-in-describe': 'off',
|
|
},
|
|
},
|
|
{
|
|
files: ['app/scripts/migrations/*.js', '*.stories.js'],
|
|
rules: {
|
|
'import/no-anonymous-default-export': ['error', { allowObject: true }],
|
|
},
|
|
},
|
|
{
|
|
files: ['app/scripts/migrations/*.js'],
|
|
rules: {
|
|
'node/global-require': 'off',
|
|
},
|
|
},
|
|
{
|
|
files: ['**/*.test.js'],
|
|
excludedFiles: [
|
|
'ui/**/*.test.js',
|
|
'ui/__mocks__/*.js',
|
|
'shared/**/*.test.js',
|
|
'development/**/*.test.js',
|
|
],
|
|
extends: ['@metamask/eslint-config-mocha'],
|
|
rules: {
|
|
'mocha/no-setup-in-describe': 'off',
|
|
},
|
|
},
|
|
{
|
|
files: ['**/__snapshots__/*.snap'],
|
|
plugins: ['jest'],
|
|
rules: {
|
|
'jest/no-large-snapshots': [
|
|
'error',
|
|
{ maxSize: 50, inlineMaxSize: 50 },
|
|
],
|
|
},
|
|
},
|
|
{
|
|
files: [
|
|
'ui/**/*.test.js',
|
|
'ui/__mocks__/*.js',
|
|
'shared/**/*.test.js',
|
|
'development/**/*.test.js',
|
|
],
|
|
extends: ['@metamask/eslint-config-jest'],
|
|
rules: {
|
|
'jest/no-restricted-matchers': 'off',
|
|
'import/unambiguous': 'off',
|
|
'import/named': 'off',
|
|
},
|
|
},
|
|
{
|
|
files: [
|
|
'development/**/*.js',
|
|
'test/e2e/benchmark.js',
|
|
'test/helpers/setup-helper.js',
|
|
],
|
|
rules: {
|
|
'node/no-process-exit': 'off',
|
|
'node/shebang': 'off',
|
|
},
|
|
},
|
|
{
|
|
files: [
|
|
'.eslintrc.js',
|
|
'babel.config.js',
|
|
'nyc.config.js',
|
|
'stylelint.config.js',
|
|
'app/scripts/lockdown-run.js',
|
|
'development/**/*.js',
|
|
'test/e2e/**/*.js',
|
|
'test/lib/wait-until-called.js',
|
|
'test/env.js',
|
|
'test/setup.js',
|
|
'jest.config.js',
|
|
],
|
|
parserOptions: {
|
|
sourceType: 'script',
|
|
},
|
|
},
|
|
{
|
|
files: [
|
|
'app/scripts/lockdown-run.js',
|
|
'test/unit-global/protect-intrinsics.test.js',
|
|
],
|
|
globals: {
|
|
harden: 'readonly',
|
|
Compartment: 'readonly',
|
|
},
|
|
},
|
|
],
|
|
|
|
settings: {
|
|
react: {
|
|
version: 'detect',
|
|
},
|
|
},
|
|
};
|