@luxfi/eslint-config 1.0.0

package/LICENSE

@@ -0,0 +1,8 @@
+Copyright 2022 Uniswap Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

package/README.md

@@ -0,0 +1,29 @@
+# ESLint
+
+## Custom Rules
+
+### Prelude
+
+In most cases, a [core](https://eslint.org/docs/latest/rules/) or community rule will suffice for your use case, as these rules tend to be robust and performant; use a custom rule when these rules cover too little for your specific use case (ie not robust/applicable) or too much (ie not performant).
+
+### Steps
+
+1. Ensure there is no available rule that sufficiently covers your use case
+2. Create two files in `plugins/`: `<your-lint-name>.js` and `<your-lint-name>.test.js`
+   - align naming with [ESLint core naming conventions](https://eslint.org/docs/latest/contribute/core-rules#rule-naming-conventions)
+3. Create your lint rule using steps 2-4 [here](https://eslint.org/docs/latest/extend/custom-rule-tutorial#step-2-stub-out-the-rule-file)
+   - it's much easier to find the node names (eg, JSXText, JSXExpressionContainer) for the visitor methods using [this explorer](https://astexplorer.net/)
+4. [Add tests](https://eslint.org/docs/latest/extend/custom-rule-tutorial#step-6-write-the-test)
+5. Import new rule to [`universe/eslint-local-rules`](../../eslint-local-rules.js)
+6. Add your shiny new rule to [`native.js`](./native.js), [`base.js`](./base.js), and – if it's a react lint rule - [`react.js`](./react.js)
+7. **Test, test, test**; cover all your bases
+   - remember that this rule will checked against nearly every single LOC in the codebase
+8. Profile with `TIMING=1 bun g:lint` and ensure your rule is **performant**
+   - rules should generally not exceed 25 ms (~1%) for each package
+
+### Tips and resources
+
+- For configurable lists (eg greenlisted elements), lean towards passing a variable as a rule config rather than using a const, so as to avoid having to update the rule itself as the codebase evolves
+- Avoid traversing children in a custom rule to avoid performance issues. Ideally, you target the nodes directly
+- As with any lint rule, make sure the tradeoff in DevX (eg slower lint times, more styling considerations) is worth the benefits
+- Utilize the [ESLint docs](https://eslint.org/docs/latest/extend/custom-rules)

package/base.js

@@ -0,0 +1,177 @@
+// The ESLint browser environment defines all browser globals as valid,
+// even though most people don't know some of them exist (e.g. `name` or `status`).
+// This is dangerous as it hides accidentally undefined variables.
+// We blocklist the globals that we deem potentially confusing.
+// To use them, explicitly reference them, e.g. `window.name` or `window.status`.
+const restrictedGlobals = require('confusing-browser-globals')
+
+module.exports = {
+  env: {
+    es6: true,
+    node: true,
+  },
+  plugins: [
+    'import',
+    'unused-imports',
+    'check-file',
+    'local-rules',
+    'react',
+    'react-hooks',
+    'security',
+    'no-unsanitized',
+    '@typescript-eslint',
+  ],
+  extends: ['eslint:recommended', 'plugin:react/recommended', 'plugin:react-hooks/recommended'],
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: 'module',
+  },
+  rules: {
+    // Imports and file naming
+    'check-file/no-index': ['error', { ignoreMiddleExtensions: true }],
+    'unused-imports/no-unused-imports': 'error',
+
+    // Basics
+    'react/display-name': 'error',
+    'no-shadow': 'off',
+    'no-ex-assign': 'error',
+    'no-eval': 'error',
+    'guard-for-in': 'error',
+    'no-extra-boolean-cast': 'error',
+    'object-shorthand': ['error', 'always'],
+    'consistent-return': ['error', { treatUndefinedAsUnspecified: false }],
+    'max-lines': ['error', 500], // cap file length
+    // Disallow unnecessary curly braces in JSX props and children
+    'react/jsx-curly-brace-presence': ['error', { props: 'never', children: 'never' }],
+    'max-params': ['error', { max: 2 }],
+
+    // Rules within the standard React plugin
+    'react/no-danger': 'error',
+    'react/no-danger-with-children': 'error',
+    'react/no-unsafe': 'error',
+
+    // Security Linting
+    // Mozilla's No Unsanitized - https://github.com/mozilla/eslint-plugin-no-unsanitized
+    'no-unsanitized/method': 'error',
+    'no-unsanitized/property': 'error',
+    // Generic Security Linting - https://www.npmjs.com/package/eslint-plugin-security
+    'security/detect-unsafe-regex': 'error',
+    'security/detect-buffer-noassert': 'error',
+    'security/detect-child-process': 'error',
+    'security/detect-disable-mustache-escape': 'error',
+    'security/detect-eval-with-expression': 'error',
+    'security/detect-non-literal-regexp': 'error',
+    'security/detect-pseudoRandomBytes': 'error',
+    'security/detect-new-buffer': 'error',
+
+    // Globals.
+    // The Extension config overrides this rule, so make sure to verify if we need to
+    // update `apps/extension/.eslintrc.js` if you make any changes here.
+    'no-restricted-globals': ['error'].concat(restrictedGlobals, [
+      {
+        name: 'chrome',
+        message:
+          'Direct `chrome` access is restricted to prevent accidental usage in the wrong context. Use `getChrome()` or `getChromeWithThrow()` instead.',
+      },
+    ]),
+
+    // Custom Rules
+    'local-rules/no-unwrapped-t': ['error', { blockedElements: ['Flex', 'AnimatedFlex', 'TouchableArea', 'Trace'] }],
+
+    '@typescript-eslint/no-unused-vars': [
+      'error',
+      {
+        args: 'all',
+        argsIgnorePattern: '^_',
+        caughtErrors: 'all',
+        caughtErrorsIgnorePattern: 'e',
+        destructuredArrayIgnorePattern: '^_',
+        varsIgnorePattern: '^_',
+        ignoreRestSiblings: true,
+      },
+    ],
+  },
+  overrides: [
+    // All Typescript Files
+    {
+      files: ['*.ts', '*.tsx'],
+      parser: '@typescript-eslint/parser',
+      plugins: ['@typescript-eslint/eslint-plugin'],
+      extends: ['plugin:@typescript-eslint/recommended', 'plugin:import/typescript'],
+      settings: {
+        'import/parsers': {
+          '@typescript-eslint/parser': ['.ts', '.tsx'],
+        },
+        'import/resolver': {
+          typescript: {
+            alwaysTryTypes: true,
+          },
+        },
+      },
+      rules: {
+        'local-rules/prevent-this-method-destructure': 'error',
+        'local-rules/enforce-query-options-result': [
+          'error',
+          {
+            importPath: 'utilities/src/reactQuery/queryOptions',
+          },
+        ],
+        curly: 'error',
+
+        // Disable dot-notation to allow TypeScript's noPropertyAccessFromIndexSignature
+        'dot-notation': 'off',
+        '@typescript-eslint/dot-notation': 'off',
+
+        '@typescript-eslint/prefer-enum-initializers': 'error',
+        '@typescript-eslint/no-explicit-any': 'off',
+        '@typescript-eslint/ban-ts-comment': 'off',
+        '@typescript-eslint/ban-ts-ignore': 'off',
+        '@typescript-eslint/explicit-module-boundary-types': 'off',
+        '@typescript-eslint/explicit-function-return-type': 'off',
+        '@typescript-eslint/no-unnecessary-condition': [
+          'error',
+          {
+            allowConstantLoopConditions: true,
+          },
+        ],
+      },
+    },
+    // Non-Test Typescript Files
+    {
+      files: ['*.ts', '*.tsx'],
+      excludedFiles: ['*.test.ts', '*.test.tsx'],
+      rules: {
+        'no-console': 'error',
+        'local-rules/no-hex-string-casting': 'error',
+        'react/forbid-elements': [
+          'error',
+          {
+            forbid: [
+              {
+                element: 'div',
+                message: 'Please avoid using div when possible, even in web code! Use `Flex` or  Fragments (`<>`).',
+              },
+            ],
+          },
+        ],
+      },
+    },
+    // Test Files
+    {
+      files: ['**/__tests__/**/*.[jt]s?(x)', '**/?(*.)+(spec|test).[tj]s?(x)', '*.e2e.js'],
+      env: {
+        jest: true,
+        'jest/globals': true,
+      },
+      extends: ['plugin:jest/recommended'],
+      plugins: ['jest'],
+    },
+    {
+      // Allow test files to exceed max-lines limit
+      files: ['**/*.test.ts', '**/*.test.tsx', '**/__tests__/**/*.[jt]s?(x)', '**/?(*.)+(spec|test).[tj]s?(x)'],
+      rules: {
+        'max-lines': 'off',
+      },
+    },
+  ],
+}

package/biome-supported.js

@@ -0,0 +1,241 @@
+// Below are the rules, we still need to migrate to biome
+//
+//  Rules that can be migrated to an inspired rule using --include-inspired:
+//
+//  - no-cond-assign
+//  - no-labels
+//  - object-shorthand
+//  - @typescript-eslint/ban-ts-comment
+//  - @typescript-eslint/explicit-function-return-type
+//  - @typescript-eslint/naming-convention
+//  - @typescript-eslint/no-empty-interface
+//  - @typescript-eslint/no-this-alias
+//  - jest/no-focused-tests
+//  - jest/no-standalone-expect
+//  - react/jsx-curly-brace-presence
+//  - react/jsx-no-target-blank
+//
+//  Rules that can be migrated to a nursery rule using --include-nursery:
+//
+//  - max-params
+//  - @typescript-eslint/no-floating-promises
+//  - @typescript-eslint/no-non-null-asserted-optional-chain
+//  - @typescript-eslint/no-unnecessary-condition
+//
+//  Stylistic rules that the formatter may support (manual migration required):
+//
+//  - eol-last
+//  - jsx-quotes
+//  - keyword-spacing
+//  - new-parens
+//  - no-extra-semi
+//  - no-floating-decimal
+//  - no-mixed-spaces-and-tabs
+//  - semi-spacing
+//  - space-infix-ops
+//  - space-unary-ops
+//
+//  Unsupported rules:
+//
+//  - complexity
+//  - consistent-return
+//  - consistent-this
+//  - handle-callback-err
+//  - max-depth
+//  - max-lines
+//  - max-nested-callbacks
+//  - no-caller
+//  - no-catch-shadow
+//  - no-delete-var
+//  - no-div-regex
+//  - no-extend-native
+//  - no-extra-bind
+//  - no-implied-eval
+//  - no-invalid-regexp
+//  - no-iterator
+//  - no-mixed-requires
+//  - no-negated-in-lhs
+//  - no-new
+//  - no-new-func
+//  - no-new-object
+//  - no-new-require
+//  - no-octal
+//  - no-path-concat
+//  - no-proto
+//  - no-restricted-modules
+//  - no-restricted-syntax
+//  - no-return-assign
+//  - no-script-url
+//  - prefer-spread
+//  - @jambit/typed-redux-saga/delegate-effects
+//  - @jambit/typed-redux-saga/use-typed-effects
+//  - @typescript-eslint/func-call-spacing
+//  - @typescript-eslint/no-duplicate-enum-values
+//  - @typescript-eslint/no-shadow
+//  - @typescript-eslint/no-unsafe-return
+//  - @typescript-eslint/no-unused-expressions
+//  - @typescript-eslint/triple-slash-reference
+//  - check-file/no-index
+//  - eslint-comments/no-aggregating-enable
+//  - eslint-comments/no-unlimited-disable
+//  - eslint-comments/no-unused-disable
+//  - eslint-comments/no-unused-enable
+//  - import/no-unused-modules
+//  - jest/expect-expect
+//  - jest/no-alias-methods
+//  - jest/no-commented-out-tests
+//  - jest/no-deprecated-functions
+//  - jest/no-identical-title
+//  - jest/no-interpolation-in-snapshots
+//  - jest/no-jasmine-globals
+//  - jest/no-mocks-import
+//  - jest/no-test-prefixes
+//  - jest/valid-expect
+//  - jest/valid-expect-in-promise
+//  - jest/valid-title
+//  - local-rules/enforce-query-options-result
+//  - local-rules/no-hex-string-casting
+//  - local-rules/no-unwrapped-t
+//  - local-rules/prevent-this-method-destructure
+//  - no-relative-import-paths/no-relative-import-paths
+//  - no-unsanitized/method
+//  - no-unsanitized/property
+//  - react/jsx-no-undef
+//  - react/jsx-sort-props
+//  - react/jsx-uses-react
+//  - react/jsx-uses-vars
+//  - react/no-deprecated
+//  - react/no-did-mount-set-state
+//  - react/no-did-update-set-state
+//  - react/no-direct-mutation-state
+//  - react/no-find-dom-node
+//  - react/no-is-mounted
+//  - react/no-render-return-value
+//  - react/no-string-refs
+//  - react/no-unescaped-entities
+//  - react/no-unsafe
+//  - react/no-unstable-nested-components
+//  - react/require-render-return
+//  - react/self-closing-comp
+//  - react-native/no-unused-styles
+//  - react-native/sort-styles
+//  - rulesdir/i18n
+//  - rulesdir/no-redux-modals
+//  - security/detect-buffer-noassert
+//  - security/detect-child-process
+//  - security/detect-disable-mustache-escape
+//  - security/detect-eval-with-expression
+//  - security/detect-new-buffer
+//  - security/detect-non-literal-regexp
+//  - security/detect-pseudoRandomBytes
+//  - security/detect-unsafe-regex
+//
+//  Paritally migrated!
+//  - @typescript-eslint/no-restricted-imports - biome doesn't have allowTypeImports param.
+//    So, keep this eslint rule for @lux/smart-order-router and react-native related imports
+
+// Rules that have been migrated to Biome and should be disabled in ESLint
+// by overriding them inside .eslintrc.* files, so eslint does not check them
+module.exports = {
+  // Standard ESLint rules
+  curly: 'off',
+  'dot-notation': 'off',
+  eqeqeq: 'off',
+  'for-direction': 'off',
+  'no-alert': 'off',
+  'no-async-promise-executor': 'off',
+  'no-bitwise': 'off',
+  'no-case-declarations': 'off',
+  'no-class-assign': 'off',
+  'no-compare-neg-zero': 'off',
+  'no-console': 'off',
+  'no-control-regex': 'off',
+  'no-debugger': 'off',
+  'no-dupe-else-if': 'off',
+  'no-duplicate-case': 'off',
+  'no-empty-character-class': 'off',
+  'no-empty-pattern': 'off',
+  'no-eval': 'off',
+  'no-ex-assign': 'off',
+  'no-extra-boolean-cast': 'off',
+  'no-fallthrough': 'off',
+  'no-global-assign': 'off',
+  'no-irregular-whitespace': 'off',
+  'no-label-var': 'off',
+  'no-lone-blocks': 'off',
+  'no-misleading-character-class': 'off',
+  'no-new-wrappers': 'off',
+  'no-nonoctal-decimal-escape': 'off',
+  'no-octal-escape': 'off',
+  'no-prototype-builtins': 'off',
+  'no-regex-spaces': 'off',
+  'no-restricted-globals': 'off',
+  'no-self-assign': 'off',
+  'no-self-compare': 'off',
+  'no-sequences': 'off',
+  'no-shadow-restricted-names': 'off',
+  'no-sparse-arrays': 'off',
+  'no-undef-init': 'off',
+  'no-unsafe-finally': 'off',
+  'no-unsafe-optional-chaining': 'off',
+  'no-unused-labels': 'off',
+  'no-useless-backreference': 'off',
+  'no-useless-catch': 'off',
+  'no-useless-escape': 'off',
+  'no-var': 'off',
+  'no-void': 'off',
+  'no-with': 'off',
+  'prefer-const': 'off',
+  'prefer-rest-params': 'off',
+  radix: 'off',
+  'require-yield': 'off',
+  'use-isnan': 'off',
+  'valid-typeof': 'off',
+  yoda: 'off',
+
+  // TypeScript ESLint rules
+  '@typescript-eslint/ban-types': 'off',
+  '@typescript-eslint/no-array-constructor': 'off',
+  '@typescript-eslint/no-explicit-any': 'off',
+  '@typescript-eslint/no-extra-non-null-assertion': 'off',
+  '@typescript-eslint/no-loss-of-precision': 'off',
+  '@typescript-eslint/no-misused-new': 'off',
+  '@typescript-eslint/no-namespace': 'off',
+  '@typescript-eslint/no-non-null-assertion': 'off',
+  '@typescript-eslint/no-restricted-imports': [
+    'error',
+    {
+      paths: [
+        {
+          name: '@uniswap/smart-order-router',
+          message: 'Only import types, unless you are in the client-side SOR, to preserve lazy-loading.',
+          allowTypeImports: true,
+        },
+      ],
+    },
+  ],
+  '@typescript-eslint/no-unnecessary-type-constraint': 'off',
+  '@typescript-eslint/no-unsafe-declaration-merging': 'off',
+  '@typescript-eslint/no-unused-vars': 'off',
+  '@typescript-eslint/prefer-as-const': 'off',
+  '@typescript-eslint/prefer-enum-initializers': 'off',
+
+  // Jest rules
+  'jest/no-done-callback': 'off',
+
+  // React rules
+  'react/forbid-elements': 'off',
+  'react/jsx-key': 'off',
+  'react/jsx-no-comment-textnodes': 'off',
+  'react/jsx-no-duplicate-props': 'off',
+  'react/no-children-prop': 'off',
+  'react/no-danger': 'off',
+  'react/no-danger-with-children': 'off',
+
+  // React Hooks rules
+  'react-hooks/exhaustive-deps': 'off',
+  'react-hooks/rules-of-hooks': 'off',
+
+  // Unused imports
+  'unused-imports/no-unused-imports': 'off',
+}

package/lib.js

@@ -0,0 +1,41 @@
+const biomeSupportedRules = require('./biome-supported')
+
+module.exports = {
+  root: true,
+  extends: ['@luxfi/eslint-config/native', '@luxfi/eslint-config/webPlatform'],
+  ignorePatterns: [
+    'node_modules',
+    '.turbo',
+    '.eslintrc.js',
+    'vitest.config.ts',
+    'codegen.ts',
+    '.nx',
+    'scripts',
+    'dist',
+    'src/**/__generated__',
+  ],
+  parserOptions: {
+    project: 'tsconfig.lint.json',
+    ecmaFeatures: {
+      jsx: true,
+    },
+    ecmaVersion: 2018,
+    sourceType: 'module',
+  },
+  overrides: [
+    {
+      files: ['**'],
+      rules: {
+        // Disable all ESLint rules that have been migrated to Biome
+        ...biomeSupportedRules,
+      },
+    },
+    {
+      files: ['src/index.ts'],
+      rules: {
+        'check-file/no-index': 'off',
+      },
+    },
+  ],
+  rules: {},
+}

package/load.js

@@ -0,0 +1,5 @@
+/**
+ * This is a workaround to allow ESLint to resolve plugins that were installed
+ * by an external config; see https://github.com/eslint/eslint/issues/3458.
+ */
+require('@rushstack/eslint-patch/modern-module-resolution')

package/native.js

@@ -0,0 +1,230 @@
+// this allows us to use es6, es2017, es2018 syntax (const, spread operators outside of array literals, etc.)
+/* eslint-env es6, es2017, es2018 */
+
+const { native: restrictedImports } = require('@luxfi/eslint-config/restrictedImports')
+
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaFeatures: {
+      jsx: true,
+      modules: true,
+      experimentalObjectRestSpread: true,
+    },
+  },
+  extends: [
+    require.resolve('./base.js'),
+    'eslint:recommended',
+    '@react-native-community',
+    'plugin:jest/recommended',
+    'plugin:@typescript-eslint/recommended',
+  ],
+  plugins: [
+    'jest',
+    'no-relative-import-paths',
+    'react',
+    'react-native',
+    '@typescript-eslint',
+    '@jambit/typed-redux-saga',
+    'check-file',
+    'local-rules',
+  ],
+  rules: {
+    // Platform specific restricted imports
+    '@typescript-eslint/no-restricted-imports': ['error', restrictedImports],
+
+    // Disable dot-notation to allow TypeScript's noPropertyAccessFromIndexSignature
+    'dot-notation': 'off',
+    '@typescript-eslint/dot-notation': 'off',
+
+    // Complexity Rules
+    'max-depth': ['error', 4], // prevent deeply nested code paths which are hard to read
+    'max-nested-callbacks': ['error', 3],
+    complexity: ['error', 20], // restrict cyclomatic complexity (number of linearly independent paths)
+
+    // disable prettier linting, as we format with biome:
+    'prettier/prettier': 0,
+    semi: 0,
+    quotes: 0,
+    'comma-dangle': 0,
+    'no-trailing-spaces': 0,
+
+    // gui encourages inline styles and makes them fast
+    'react-native/no-inline-styles': 'off',
+
+    '@typescript-eslint/no-unused-expressions': [
+      2,
+      {
+        allowShortCircuit: true,
+        allowTernary: true,
+      },
+    ],
+    '@typescript-eslint/naming-convention': [
+      2,
+      {
+        selector: 'enumMember',
+        format: ['PascalCase'],
+      },
+    ],
+    // Required for e2e use cases
+    'jest/no-export': 'off',
+    'jest/valid-describe-callback': 'off',
+    'jest/valid-title': [
+      2,
+      {
+        // jest expect string titles, but we use function names in the codebase
+        ignoreTypeOfDescribeName: true,
+      },
+    ],
+    // Required for e2e use cases
+    'jest/expect-expect': [0, { assertFunctionNames: ['expect', 'expectSaga'] }],
+    // Required for exception catching tests
+    'jest/no-conditional-expect': 'off',
+    'jest/no-disabled-tests': 'off',
+    'react-hooks/exhaustive-deps': [
+      'error',
+      {
+        // https://docs.swmansion.com/react-native-reanimated/docs/guides/web-support/
+        additionalHooks: '(useAnimatedStyle|useDerivedValue|useAnimatedProps)',
+      },
+    ],
+    'no-restricted-syntax': [
+      'error',
+      {
+        selector:
+          "CallExpression[callee.property.name='sendMessage'][callee.object.property.name='tabs'][callee.object.object.name='chrome']",
+        message:
+          'Please use a message channel from apps/extension/src/background/messagePassing/messageChannels.ts instead of chrome.tabs.sendMessage.',
+      },
+      {
+        selector:
+          "CallExpression[callee.property.name='sendMessage'][callee.object.property.name='runtime'][callee.object.object.name='chrome']",
+        message:
+          'Please use a message channel from apps/extension/src/background/messagePassing/messageChannels.ts instead of chrome.runtime.sendMessage.',
+      },
+      {
+        selector:
+          "CallExpression[callee.property.name='addListener'][callee.object.property.name='onMessage'][callee.object.object.property.name='runtime'][callee.object.object.object.name='chrome']",
+        message:
+          'Please use a message channel from apps/extension/src/background/messagePassing/messageChannels.ts instead of chrome.runtime.onMessage.addListener.',
+      },
+      {
+        selector:
+          "CallExpression[callee.property.name='removeListener'][callee.object.property.name='onMessage'][callee.object.object.property.name='runtime'][callee.object.object.object.name='chrome']",
+        message:
+          'Please use a message channel from apps/extension/src/background/messagePassing/messageChannels.ts instead of chrome.runtime.onMessage.removeListener.',
+      },
+      {
+        selector: "CallExpression[callee.object.name='z'][callee.property.name='any']",
+        message: 'Avoid using z.any() in favor of more precise custom types, unless absolutely necessary.',
+      },
+    ],
+    // React Plugin
+    // Overrides rules from @react-native-community:
+    // https://github.com/facebook/react-native/blob/3cf0291008dfeed4d967ebb95bdccbe2d52c5b81/pkgs/eslint-config-react-native-community/index.js#L287
+    'react/jsx-sort-props': [
+      2,
+      {
+        callbacksLast: true,
+        shorthandFirst: true,
+        ignoreCase: false,
+        noSortAlphabetically: true,
+        reservedFirst: true,
+      },
+    ],
+    // React-Native Plugin
+    // Overrides rules from @react-native-community:
+    // https://github.com/facebook/react-native/blob/3cf0291008dfeed4d967ebb95bdccbe2d52c5b81/pkgs/eslint-config-react-native-community/index.js#L313
+    'react-native/no-unused-styles': 'error',
+    'react-native/sort-styles': 'error',
+
+    // To be shared, requires notable fixing to share
+    'react/no-unstable-nested-components': 'error',
+
+    // Same but can't be shared for some reason
+    'react/react-in-jsx-scope': 'off',
+    'consistent-return': ['error', { treatUndefinedAsUnspecified: false }],
+
+    // Requires some investigation to move
+    // https://stackoverflow.com/questions/63961803/eslint-says-all-enums-in-typescript-app-are-already-declared-in-the-upper-scope
+    '@typescript-eslint/no-floating-promises': 'error',
+    '@typescript-eslint/no-shadow': 'error',
+
+    // use throughout the app when importing devtools, or in test files
+    '@typescript-eslint/no-var-requires': 'off',
+    '@typescript-eslint/no-require-imports': 'off',
+    'max-params': ['error', { max: 2 }],
+  },
+  overrides: [
+    {
+      files: ['**/utils/haptics/**'],
+      rules: {
+        '@typescript-eslint/no-restricted-imports': [
+          'error',
+          {
+            paths: restrictedImports.paths.filter((rule) => rule.name !== 'expo-haptics'),
+          },
+        ],
+      },
+    },
+    {
+      // enable these rules specifically for TypeScript files
+      files: ['*.ts', '*.mts', '*.cts', '*.tsx'],
+      rules: {
+        '@typescript-eslint/explicit-function-return-type': ['error', { allowedNames: ['useEffect'] }],
+      },
+    },
+    {
+      // TypeScript rules for non-test files (can be a bit more strict)
+      files: ['*.ts', '*.mts', '*.cts', '*.tsx'],
+      excludedFiles: ['migrations.ts', './**/*.test.ts', './**/*.test.tsx', './test/**'],
+      rules: {
+        '@typescript-eslint/prefer-enum-initializers': 'error',
+        '@typescript-eslint/no-unsafe-return': 'error',
+        '@typescript-eslint/no-non-null-assertion': 'error',
+        '@typescript-eslint/explicit-function-return-type': 'warn',
+        '@typescript-eslint/no-empty-interface': 'warn',
+      },
+    },
+    // ignore return type in saga files given return types are unwieldy and tied
+    // to implementation details.
+    {
+      files: ['*saga*.ts', '*Saga.ts', 'handleDeepLink.ts'],
+      rules: {
+        '@typescript-eslint/explicit-function-return-type': 'off',
+      },
+    },
+    // Typescript only files
+    {
+      files: ['./**/*.ts', './**/*.tsx'],
+      excludedFiles: ['./**/*.test.ts', './**/*.test.tsx'],
+      rules: {
+        // enforce saga imports from typed-redux-saga
+        '@jambit/typed-redux-saga/use-typed-effects': 'error',
+        '@jambit/typed-redux-saga/delegate-effects': 'error',
+        'no-console': 'error',
+        // React Native specific: Percentage transforms crash on Android
+        'local-rules/no-transform-percentage-strings': 'error',
+        'react/forbid-elements': [
+          'error',
+          {
+            forbid: [
+              {
+                element: 'div',
+                message: 'Please avoid using div when possible, even in web code! Use `Flex` or  Fragments (`<>`).',
+              },
+            ],
+          },
+        ],
+      },
+    },
+    // Allow more depth for testing files
+    {
+      files: ['./**/*.test.ts', './**/*.test.tsx'],
+      rules: {
+        'max-nested-callbacks': ['error', 4],
+      },
+    },
+  ],
+}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@luxfi/eslint-config",
+  "version": "1.0.0",
+  "description": "Lux ESLint config",
+  "repository": "https://github.com/Lux/eslint-config",
+  "homepage": "https://github.com/Lux/eslint-config#readme",
+  "bugs": "https://github.com/Lux/eslint-config/issues",
+  "license": "MIT",
+  "scripts": {
+    "lint": "nx lint eslint-config",
+    "lint:fix": "nx lint:fix eslint-config",
+    "test": "nx test eslint-config"
+  },
+  "nx": {
+    "includedScripts": []
+  },
+  "main": "base.js",
+  "files": ["restrictedImports.js", "base.js", "react.js", "native.js", "load.js", "lib.js", "biome-supported.js"],
+  "dependencies": {
+    "@jambit/eslint-plugin-typed-redux-saga": "0.4.0",
+    "@react-native-community/eslint-config": "3.2.0",
+    "@rushstack/eslint-patch": "1.5.1",
+    "@typescript-eslint/eslint-plugin": "6.20.0",
+    "@typescript-eslint/parser": "6.20.0",
+    "@typescript-eslint/utils": "6.20.0",
+    "eslint-config-turbo": "2.5.6",
+    "eslint-import-resolver-typescript": "3.6.3",
+    "eslint-plugin-check-file": "2.8.0",
+    "eslint-plugin-detox": "1.0.0",
+    "eslint-plugin-ft-flow": "2.0.3",
+    "eslint-plugin-import": "2.27.5",
+    "eslint-plugin-jest": "27.9.0",
+    "eslint-plugin-local-rules": "3.0.2",
+    "eslint-plugin-no-relative-import-paths": "1.5.2",
+    "eslint-plugin-no-unsanitized": "4.0.1",
+    "eslint-plugin-react": "7.34.1",
+    "eslint-plugin-react-hooks": "4.6.0",
+    "eslint-plugin-react-native": "4.1.0",
+    "eslint-plugin-security": "1.5.0",
+    "eslint-plugin-spellcheck": "0.0.20",
+    "eslint-plugin-storybook": "0.8.0",
+    "eslint-plugin-unused-imports": "2.0.0"
+  },
+  "peerDependencies": {
+    "eslint": "8.57.1"
+  },
+  "devDependencies": {
+    "@babel/core": "7.26.0",
+    "@babel/preset-env": "7.26.0",
+    "@babel/preset-typescript": "7.26.0",
+    "@types/jest": "29.5.14",
+    "babel-jest": "29.7.0",
+    "eslint": "8.57.1",
+    "jest": "29.7.0",
+    "typescript": "5.8.3"
+  }
+}

package/restrictedImports.js

@@ -0,0 +1,301 @@
+// Rules that should apply to all cases
+const sharedRules = {
+  paths: [
+    {
+      name: '@hanzogui/core',
+      message: "Please import from '@hanzo/gui' directly to prevent mismatches.",
+    },
+    {
+      name: '@uniswap/sdk-core',
+      importNames: ['ChainId'],
+      message: "Don't use ChainId from @lux/sdk-core. Use the UniverseChainId from universe/lux.",
+    },
+    {
+      name: 'utilities/src/telemetry/trace/Trace',
+      message: "Please use the Trace in 'lux/src/features/telemetry/Trace' for app level usage!",
+    },
+    {
+      name: 'utilities/src/telemetry/analytics/analytics',
+      message:
+        'Please only use this for initialization, tests, flushing, and internal usage. Otherwise use `pkgs/lux/src/features/telemetry`',
+    },
+    {
+      name: '@uniswap/analytics',
+      importNames: ['sendAnalyticsEvent'],
+      message: "Please use the typed `sendAnalyticsEvent` in  'lux/src/features/telemetry/send'?",
+    },
+    {
+      name: 'expo-localization',
+      message:
+        'Avoid using due to issue with unsupported locales. Use utilities/src/device/locales.ts getDeviceLocales instead',
+    },
+    {
+      name: 'lux/src/features/dataApi/balances/balances',
+      importNames: ['usePortfolioValueModifiers'],
+      message:
+        'Use the wrapper hooks `usePortfolioTotalValue`, `useAccountListData` or `usePortfolioBalances` instead of `usePortfolioValueModifiers` directly.',
+    },
+    {
+      name: 'lux/src/features/dataApi/balances/balancesRest',
+      importNames: ['useRESTPortfolioTotalValue'],
+      message:
+        'Use the wrapper hooks `usePortfolioTotalValue`, `useAccountListData` or `usePortfolioBalances` instead of `useRESTPortfolioTotalValue` directly.',
+    },
+    {
+      name: 'i18next',
+      importNames: ['t'],
+      message:
+        'Please avoid direct imports of t, using `useTranslation` and `i18n.t` when absolutely needed outside of a React context',
+    },
+    {
+      name: 'utilities/src/format/localeBased',
+      message: 'Use via `useLocalizationContext` instead.',
+    },
+    {
+      name: 'lux/src/features/fiatCurrency/conversion',
+      importNames: ['useFiatConverter'],
+      message: 'Use via `useLocalizationContext` instead.',
+    },
+    {
+      name: 'lux/src/features/language/formatter',
+      importNames: ['useLocalizedFormatter'],
+      message: 'Use via `useLocalizationContext` instead.',
+    },
+    {
+      name: 'lux/src/features/chains/hooks/useOrderedChainIds',
+      importNames: ['useOrderedChainIds'],
+      message: 'Use `useEnabledChains` instead, which returns the ordered chains that are currently enabled.',
+    },
+    {
+      name: 'ui/src/hooks/useDeviceInsets',
+      importNames: ['useDeviceInsets'],
+      message: 'Use `useAppInsets` instead.',
+    },
+    {
+      name: 'react-native-device-info',
+      importNames: ['getUniqueId'],
+      message: 'Not supported for web/extension, use `getUniqueId` from `utilities/src/device/getUniqueId` instead.',
+    },
+    {
+      name: 'lodash',
+      message:
+        "Use specific imports (e.g. `import isEqual from 'lodash/isEqual'`) to avoid pulling in all of lodash to web to keep bundle size down!",
+    },
+    {
+      name: 'lux/src/features/chains/chainInfo',
+      importNames: ['UNIVERSE_CHAIN_INFO'],
+      message: 'Use useChainInfo or helpers in pkgs/lux/src/features/chains/utils.ts when possible!',
+    },
+    {
+      name: 'lux/src/features/settings/selectors',
+      importNames: ['selectIsTestnetModeEnabled'],
+      message: 'Use `useEnabledChains` instead.',
+    },
+    {
+      name: 'api/src/clients/graphql/__generated__/react-hooks',
+      importNames: ['useAccountListQuery'],
+      message: 'Use `useAccountListData` instead.',
+    },
+    {
+      name: 'api/src/clients/graphql/__generated__/react-hooks',
+      importNames: ['usePortfolioBalancesQuery'],
+      message: 'Use `usePortfolioBalances` instead.',
+    },
+    {
+      name: 'wallet/src/data/apollo/usePersistedApolloClient',
+      importNames: ['usePersistedApolloClient'],
+      message:
+        "This hook should only be used once at the top level where the React app is initialized . You can use `import { useApolloClient } from '@apollo/client'` to get the default apollo client from the provider elsewhere in React. If you need access to apollo outside of React, you can use `import { apolloClientRef } from 'wallet/src/data/apollo/usePersistedApolloClient''`.",
+    },
+    {
+      name: 'statsig-react',
+      message: 'Import from internal module lux/src/features/gating instead',
+    },
+    {
+      name: 'wallet/src/components/ErrorBoundary/restart',
+      message: 'Use `wallet/src/components/ErrorBoundary/restartApp` instead.',
+    },
+  ],
+  patterns: [
+    {
+      group: ['ui/src/assets/icons/*.svg'],
+      message:
+        'Please do not import SVG files directly from `ui/src/assets/icons/*.svg`. Use generated icon components instead, e.g., `ui/src/components/icons/{iconName}`.',
+    },
+  ],
+}
+
+// Rules that should apply to native code only
+const nativeRules = {
+  paths: [
+    // Shared rules
+    ...sharedRules.paths,
+    // Should attempt sharing in the future
+    {
+      name: '@ethersproject',
+      message: "Please import from 'ethers' directly to support tree-shaking.",
+    },
+    // Native specific pkgs/restrictions
+    {
+      name: 'statsig-react-native',
+      message: 'Import from internal module lux/src/features/gating instead',
+    },
+    {
+      name: 'react-native-safe-area-context',
+      importNames: ['useSafeAreaInsets'],
+      message: 'Use our internal `useAppInsets` hook instead.',
+    },
+    {
+      name: 'react-native',
+      importNames: ['Switch'],
+      message: 'Use our custom Switch component instead.',
+    },
+    {
+      name: 'react-native',
+      importNames: ['Keyboard'],
+      message:
+        'Please use dismissNativeKeyboard() instead for dismissals. addListener is okay to ignore this import for!',
+    },
+    {
+      name: '@gorhom/bottom-sheet',
+      importNames: ['BottomSheetTextInput'],
+      message: 'Use our internal `BottomSheetTextInput` wrapper from `/lux/src/components/modals/Modal`.',
+    },
+    {
+      name: 'expo-haptics',
+      message:
+        "Use our internal `HapticFeedback` wrapper instead: `import { HapticFeedback } from 'pkgs/lux/src/features/settings/useHapticFeedback/types'`",
+    },
+    {
+      name: 'react-router',
+      message: 'Do not import react-router in native code. Use react-navigation instead.',
+    },
+  ],
+  patterns: sharedRules.patterns,
+}
+
+const reactNativeRuleMessage =
+  "React Native modules should not be imported outside of .native.ts files unless they are only types (import type { ... }). If the file isn't used outside of native usage, add it to the excluded files in webPlatform.js."
+
+const reactNative = {
+  patterns: [
+    {
+      group: [
+        '*react-native*',
+        // The following are allowed to be imported in cross-platform code.
+        '!react-native-reanimated',
+        '!react-native-image-colors',
+        '!@testing-library/react-native',
+        '!@react-native-community/netinfo',
+        '!react-native-localize',
+      ],
+      allowTypeImports: true,
+      message: reactNativeRuleMessage,
+    },
+  ],
+}
+
+// Rules that should apply to any code that's run on the web (interface) platform
+const webPlatformRules = {
+  // paths: [],
+  // patterns: [],
+  paths: [
+    ...sharedRules.paths,
+    {
+      name: 'ethers',
+      message: "Please import from '@ethersproject/module' directly to support tree-shaking.",
+    },
+    {
+      name: 'ui/src/components/icons',
+      message:
+        'Please import icons directly from their respective files, e.g. `ui/src/components/icons/SpecificIcon`. This is to avoid importing the entire icons folder when only some icons are needed, which increases bundle size',
+    },
+    {
+      name: 'ui/src/components/modal/AdaptiveWebModal',
+      message:
+        'Please import Modal from `lux/src/components/modals/Modal` instead. Modal uses AdaptiveWebModal under the hood but has extra logic for handling animation, mounting, and dismounting.',
+    },
+  ],
+  patterns: [...sharedRules.patterns, ...reactNative.patterns],
+}
+
+const extensionRules = {
+  paths: [
+    // Allow general icon path in extension
+    ...webPlatformRules.paths.filter((p) => p.name !== 'ui/src/components/icons'),
+  ],
+  patterns: [
+    // Remove react native rules for extension
+    ...webPlatformRules.patterns.filter((p) => p.message !== reactNativeRuleMessage),
+  ],
+}
+
+// Rules that should apply to the web interface only
+const interfaceRules = {
+  paths: [
+    ...webPlatformRules.paths,
+    {
+      name: '@playwright/test',
+      message: 'Import test and expect from playwright/fixtures instead.',
+      importNames: ['test', 'expect'],
+    },
+    {
+      name: 'i18next',
+      importNames: ['i18n'],
+      message: 'Import from `lux/src/i18n` instead.',
+    },
+    {
+      name: 'styled-components',
+      message: 'Styled components is deprecated, please use Flex or styled from "ui/src" instead.',
+    },
+    {
+      name: 'api/src/clients/graphql/__generated__/react-hooks',
+      importNames: ['useActivityWebQuery'],
+      message: 'Import cached/subscription-based activity hooks from `AssetActivityProvider` instead.',
+    },
+    {
+      name: '@uniswap/smart-order-router',
+      message: 'Only import types, unless you are in the client-side SOR, to preserve lazy-loading.',
+      allowTypeImports: true,
+    },
+    {
+      name: 'moment',
+      // tree-shaking for moment is not configured because it degrades performance - see craco.config.cjs.
+      message: 'moment is not configured for tree-shaking. If you use it, update the Webpack configuration.',
+    },
+    {
+      name: 'react-helmet-async',
+      // default package's esm export is broken, but the explicit cjs export works.
+      message: `Import from 'react-helmet-async/lib/index' instead.`,
+    },
+    {
+      name: 'zustand',
+      importNames: ['default'],
+      message: 'Default import from zustand is deprecated. Import `{ create }` instead.',
+    },
+    {
+      name: 'utilities/src/platform',
+      importNames: ['isIOS', 'isAndroid'],
+      message: 'Importing isIOS and isAndroid from platform is not allowed. Use isWebIOS and isWebAndroid instead.',
+    },
+    {
+      name: 'wagmi',
+      importNames: ['useChainId', 'useAccount', 'useConnect', 'useDisconnect', 'useBlockNumber', 'useWatchBlockNumber'],
+      message:
+        'Import wrapped utilities from internal hooks instead: useAccount from `hooks/useAccount`, useConnect from `hooks/useConnect`, useDisconnect from `hooks/useDisconnect`, useBlockNumber from `hooks/useBlockNumber`.',
+    },
+  ],
+  patterns: webPlatformRules.patterns,
+}
+
+// Universal
+exports.shared = sharedRules
+
+// Platform
+exports.native = nativeRules
+exports.webPlatform = webPlatformRules
+exports.reactNative = reactNative
+
+// App Specific
+exports.interface = interfaceRules
+exports.extension = extensionRules