Merge branch 'main' into feat/add-monad-failover-rpc

Author: khanti42

.depcheckrc.yml

@@ -82,6 +82,7 @@ ignores:
   - 'path-browserify' # polyfill
   - 'nyc' # coverage
   - 'core-js-pure' # polyfills
+  - 'react-compiler-webpack' # build tool
   # babel
   - '@babel/plugin-transform-logical-assignment-operators'
   - 'babel-plugin-react-compiler'

.eslintrc.base.js

@@ -1,10 +1,7 @@
-const path = require('path');
-
 module.exports = {
-  extends: [
-    '@metamask/eslint-config',
-    path.resolve(__dirname, '.eslintrc.jsdoc.js'),
-  ],
+  extends: ['@metamask/eslint-config'],
+
+  plugins: ['@metamask/design-tokens'],
 
   globals: {
     document: 'readonly',
@@ -15,10 +12,13 @@ module.exports = {
     AggregateError: 'readonly',
   },
 
-  rules: {
-    // TODO: re-enable once the proposed feature at https://github.com/gajus/eslint-plugin-jsdoc/pull/964#issuecomment-1936470252 is available
-    'jsdoc/check-line-alignment': 'off',
+  settings: {
+    jsdoc: {
+      mode: 'typescript',
+    },
+  },
 
+  rules: {
     'default-param-last': 'off',
     'prefer-object-spread': 'error',
     'require-atomic-updates': 'off',
@@ -82,5 +82,57 @@ module.exports = {
 
     // This is necessary to run eslint on Windows and not get a thousand CRLF errors
     'prettier/prettier': ['error', { endOfLine: 'auto' }],
+
+    '@metamask/design-tokens/color-no-hex': 'error',
+    'import/no-restricted-paths': [
+      'error',
+      {
+        basePath: './',
+        zones: [
+          {
+            target: './app',
+            from: './ui',
+            message:
+              'Should not import from UI in background, use shared directory instead',
+          },
+          {
+            target: './ui',
+            from: './app',
+            message:
+              'Should not import from background in UI, use shared directory instead',
+          },
+          {
+            target: './shared',
+            from: './app',
+            message: 'Should not import from background in shared',
+          },
+          {
+            target: './shared',
+            from: './ui',
+            message: 'Should not import from UI in shared',
+          },
+        ],
+      },
+    ],
+
+    /* JSDoc plugin rules */
+
+    // TODO: re-enable once the proposed feature at https://github.com/gajus/eslint-plugin-jsdoc/pull/964#issuecomment-1936470252 is available
+    'jsdoc/check-line-alignment': 'off',
+
+    // Allow tag `jest-environment` to work around Jest bug
+    // See: https://github.com/facebook/jest/issues/7780
+    'jsdoc/check-tag-names': ['error', { definedTags: ['jest-environment'] }],
+
+    // TODO: Re-enable these
+    'jsdoc/match-description': 'off',
+    'jsdoc/require-description': 'off',
+    'jsdoc/require-jsdoc': 'off',
+    'jsdoc/require-param-description': 'off',
+    'jsdoc/require-param-type': 'off',
+    'jsdoc/require-returns-description': 'off',
+    'jsdoc/require-returns-type': 'off',
+    'jsdoc/require-returns': 'off',
+    'jsdoc/valid-types': 'off',
   },
 };

.eslintrc.js

@@ -12,51 +12,15 @@ const tsconfig = ts.parseJsonConfigFileContent(config, ts.sys, './');
  */
 module.exports = {
   root: true,
-  // Suggested addition from the storybook 6.5 update
-  extends: ['plugin:storybook/recommended'],
   // Ignore files which are also in .prettierignore
   ignorePatterns: readFileSync('.prettierignore', 'utf8').trim().split('\n'),
   // eslint's parser, esprima, is not compatible with ESM, so use the babel parser instead
   parser: '@babel/eslint-parser',
-  plugins: ['@metamask/design-tokens'],
-  rules: {
-    '@metamask/design-tokens/color-no-hex': 'error',
-    'import/no-restricted-paths': [
-      'error',
-      {
-        basePath: './',
-        zones: [
-          {
-            target: './app',
-            from: './ui',
-            message:
-              'Should not import from UI in background, use shared directory instead',
-          },
-          {
-            target: './ui',
-            from: './app',
-            message:
-              'Should not import from background in UI, use shared directory instead',
-          },
-          {
-            target: './shared',
-            from: './app',
-            message: 'Should not import from background in shared',
-          },
-          {
-            target: './shared',
-            from: './ui',
-            message: 'Should not import from UI in shared',
-          },
-        ],
-      },
-    ],
-  },
   overrides: [
     /**
      * == Modules ==
      *
-     * The first two sections here, which cover module syntax, are mutually
+     * The first three sections here, which cover module syntax, are mutually
      * exclusive: the set of files covered between them may NOT overlap. This is
      * because we do not allow a file to use two different styles for specifying
      * imports and exports (however theoretically possible it may be).
@@ -73,6 +37,8 @@ module.exports = {
         '.eslintrc.*.js',
         '.mocharc.js',
         '*.config.js',
+        'app/scripts/lockdown-run.js',
+        'app/scripts/lockdown-more.js',
         'development/**/*.js',
         'test/e2e/**/*.js',
         'test/helpers/*.js',
@@ -112,7 +78,6 @@ module.exports = {
       files: [
         'app/**/*.js',
         'shared/**/*.js',
-        'shared/**/*.ts',
         'ui/**/*.js',
         '**/*.test.js',
         'test/lib/**/*.js',
@@ -121,6 +86,10 @@ module.exports = {
         'test/stub/**/*.js',
         'test/unit-global/**/*.js',
       ],
+      excludedFiles: [
+        'app/scripts/lockdown-run.js',
+        'app/scripts/lockdown-more.js',
+      ],
       extends: [
         path.resolve(__dirname, '.eslintrc.base.js'),
         path.resolve(__dirname, '.eslintrc.node.js'),
@@ -289,12 +258,6 @@ module.exports = {
         },
       },
     },
-    {
-      files: ['*.d.ts'],
-      parserOptions: {
-        sourceType: 'script',
-      },
-    },
     /**
      * == Everything else ==
      *
@@ -434,6 +397,9 @@ module.exports = {
         // things like force the test to fail.
         '@babel/no-invalid-this': 'off',
         'mocha/no-setup-in-describe': 'off',
+
+        // Static hex values are only discouraged in application code, using them in tests is OK.
+        '@metamask/design-tokens/color-no-hex': 'off',
       },
     },
     /**
@@ -481,6 +447,10 @@ module.exports = {
       rules: {
         'import/unambiguous': 'off',
         'import/named': 'off',
+
+        // Static hex values are only discouraged in application code, using them in tests is OK.
+        '@metamask/design-tokens/color-no-hex': 'off',
+
         // *.snap files weren't parsed by previous versions of this eslint
         // config section, but something got fixed somewhere, and now this rule
         // causes failures. We need to turn it off instead of fix them because
@@ -512,17 +482,25 @@ module.exports = {
       },
     },
     /**
-     * Migrations
+     * Jest files that aren't currently covered by Jest configuration above
+     *
+     * TODO: Update the `files` list for the Jest configuration.
      */
     {
-      files: ['app/scripts/migrations/*.js', '**/*.stories.js'],
+      files: ['**/*.test.{js,ts,tsx}'],
       rules: {
-        'import/no-anonymous-default-export': [
-          'error',
-          {
-            allowObject: true,
-          },
-        ],
+        // Static hex values are only discouraged in application code, using them in tests is OK.
+        '@metamask/design-tokens/color-no-hex': 'off',
+      },
+    },
+    /**
+     * Legacy migrations
+     */
+    {
+      files: ['app/scripts/migrations/*.js'],
+      rules: {
+        // Disable various rules that our legacy migrations don't follow
+        'import/no-anonymous-default-export': 'off',
       },
     },
     /**
@@ -555,12 +533,30 @@ module.exports = {
         Compartment: 'readonly',
       },
     },
+    /**
+     * Storybook
+     */
     {
-      files: ['app/scripts/lockdown-run.js', 'app/scripts/lockdown-more.js'],
-      parserOptions: {
-        sourceType: 'script',
+      files: ['**/*.stories.js', '**/*.stories.ts', '**/*.stories.tsx'],
+      // Suggested addition from the storybook 6.5 update
+      extends: ['plugin:storybook/recommended'],
+      rules: {
+        // Anonymous object exports are conventional for Storybook files
+        'import/no-anonymous-default-export': [
+          'error',
+          {
+            allowObject: true,
+          },
+        ],
+        // Static hex values are only discouraged in application code, using them in stories is OK.
+        '@metamask/design-tokens/color-no-hex': 'off',
       },
     },
+    /**
+     * Modules with sorted keys (to be expanded over time)
+     *
+     * TODO: Either continue migrating code to this rule, or abandon the effort.
+     */
     {
       files: ['ui/pages/settings/*.js'],
       rules: {
@@ -573,13 +569,13 @@ module.exports = {
         ],
       },
     },
+    /**
+     * Modules with sorted imports
+     *
+     * TODO: Remove in favor of `import-x/order`, which our shared config uses.
+     */
     {
       files: ['ui/components/multichain/**/*.{js}'],
-      extends: [
-        path.resolve(__dirname, '.eslintrc.base.js'),
-        path.resolve(__dirname, '.eslintrc.node.js'),
-        path.resolve(__dirname, '.eslintrc.babel.js'),
-      ],
       rules: {
         'sort-imports': [
           'error',
@@ -594,18 +590,23 @@ module.exports = {
       },
     },
     /**
-     * Don't check for static hex values in .test, .spec or .stories files
+     * TypeScript declaration files.
+     *
+     * TODO: Move this to `@metamask/eslint-config-typescript`
      */
     {
-      files: [
-        '**/*.test.{js,ts,tsx}',
-        '**/*.spec.{js,ts,tsx}',
-        '**/*.stories.{js,ts,tsx}',
-      ],
+      files: ['**/*.d.ts'],
       rules: {
-        '@metamask/design-tokens/color-no-hex': 'off',
+        'import/unambiguous': 'off',
       },
     },
+    /**
+     * Prevent new references to deprecated "globally selected network"
+     *
+     * This can be removed after all usages have been removed.
+     *
+     * TODO: Expand coverage to include non-confirmation UI as well.
+     */
     {
       files: ['ui/pages/confirmations/**/*.{js,ts,tsx}'],
       rules: {