This repository has been archived by the owner on Nov 9, 2023. It is now read-only.
generated from MetaMask/metamask-module-template
-
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Align ESLint, Prettier packages and configs with core monorepo ahead …
…of migration (#28) ## Description - This PR aligns the ESLint and Prettier packages and configs in this repo with the core monorepo. - This is a preparation step for migrating the `eth-json-rpc-provider` package into the core monorepo. - Originally, the plan was to decrement the TypeScript version to align with the core monorepo, but following [this discussion](#27), we've opted to use TypeScript version v4.8.4, and preserve the compiler options in this package that aren't enabled in the core monorepo. ## References - See MetaMask/core#1551 - Closes MetaMask/core#1683 - Closes MetaMask/core#1682 (is superseded by this PR)
- Loading branch information
Showing
4 changed files
with
1,233 additions
and
825 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,36 +1,135 @@ | ||
| module.exports = { | ||
| root: true, | ||
|
|
||
| extends: ['@metamask/eslint-config'], | ||
|
|
||
| extends: ['@metamask/eslint-config', '@metamask/eslint-config-nodejs'], | ||
| ignorePatterns: [ | ||
| '!.eslintrc.js', | ||
| '!jest.config.js', | ||
| 'node_modules', | ||
| 'dist', | ||
| 'docs', | ||
| 'coverage', | ||
| // 'merged-packages', | ||
| ], | ||
| overrides: [ | ||
| { | ||
| files: ['*.ts'], | ||
| extends: ['@metamask/eslint-config-typescript'], | ||
| files: ['*.test.{ts,js}', '**/tests/**/*.{ts,js}'], | ||
| extends: ['@metamask/eslint-config-jest'], | ||
| rules: { | ||
| // TODO: Re-enable | ||
| 'import/no-named-as-default-member': 'off', | ||
| 'jest/no-conditional-expect': 'off', | ||
| }, | ||
| }, | ||
| { | ||
| // These files are test helpers, not tests. We still use the Jest ESLint | ||
| // config here to ensure that ESLint expects a test-like environment, but | ||
| // various rules meant just to apply to tests have been disabled. | ||
| files: ['**/tests/**/*.{ts,js}', '!*.test.{ts,js}'], | ||
| rules: { | ||
| 'jest/no-export': 'off', | ||
| 'jest/require-top-level-describe': 'off', | ||
| 'jest/no-if': 'off', | ||
| 'jest/no-test-return-statement': 'off', | ||
| // TODO: Re-enable this rule; we can accomodate this even in our test helpers | ||
| 'jest/expect-expect': 'off', | ||
| }, | ||
| }, | ||
|
|
||
| { | ||
| files: ['*.js'], | ||
| parserOptions: { | ||
| sourceType: 'script', | ||
| ecmaVersion: '2018', | ||
| }, | ||
| extends: ['@metamask/eslint-config-nodejs'], | ||
| }, | ||
| { | ||
| files: ['*.ts'], | ||
| extends: ['@metamask/eslint-config-typescript'], | ||
| parserOptions: { | ||
| tsconfigRootDir: __dirname, | ||
| project: ['./tsconfig.json'], | ||
| }, | ||
| rules: { | ||
| // disabled due to incompatibility with Record<string, unknown> | ||
| // See https://github.com/Microsoft/TypeScript/issues/15300#issuecomment-702872440 | ||
| '@typescript-eslint/consistent-type-definitions': 'off', | ||
|
|
||
| // TODO: auto-fix breaks stuff | ||
| '@typescript-eslint/promise-function-async': 'off', | ||
|
|
||
| // TODO: re-enble most of these rules | ||
| '@typescript-eslint/await-thenable': 'warn', | ||
| '@typescript-eslint/naming-convention': 'off', | ||
| '@typescript-eslint/no-floating-promises': 'warn', | ||
| '@typescript-eslint/no-for-in-array': 'warn', | ||
| '@typescript-eslint/no-loss-of-precision': 'warn', | ||
| '@typescript-eslint/no-misused-promises': 'warn', | ||
| '@typescript-eslint/no-unnecessary-type-assertion': 'off', | ||
| '@typescript-eslint/unbound-method': 'off', | ||
| '@typescript-eslint/prefer-enum-initializers': 'off', | ||
| '@typescript-eslint/prefer-nullish-coalescing': 'off', | ||
| '@typescript-eslint/prefer-optional-chain': 'off', | ||
| '@typescript-eslint/prefer-reduce-type-parameter': 'off', | ||
| '@typescript-eslint/restrict-plus-operands': 'warn', | ||
| '@typescript-eslint/restrict-template-expressions': 'warn', | ||
| 'no-restricted-syntax': 'off', | ||
| 'no-restricted-globals': 'off', | ||
| }, | ||
| }, | ||
| { | ||
| files: ['tests/setupAfterEnv/matchers.ts'], | ||
| parserOptions: { | ||
| sourceType: 'script', | ||
| }, | ||
| }, | ||
| { | ||
| files: ['*.test.ts', '*.test.js'], | ||
| extends: [ | ||
| '@metamask/eslint-config-jest', | ||
| '@metamask/eslint-config-nodejs', | ||
| ], | ||
| files: ['*.d.ts'], | ||
| rules: { | ||
| '@typescript-eslint/naming-convention': 'warn', | ||
| 'import/unambiguous': 'off', | ||
| }, | ||
| }, | ||
| { | ||
| files: ['scripts/*.ts'], | ||
| rules: { | ||
| // All scripts will have shebangs. | ||
| 'n/shebang': 'off', | ||
| }, | ||
| }, | ||
| ], | ||
| rules: { | ||
| // Left disabled because various properties throughough this repo are snake_case because the | ||
| // names come from external sources or must comply with standards | ||
| // e.g. `txreceipt_status`, `signTypedData_v4`, `token_id` | ||
| camelcase: 'off', | ||
| 'id-length': 'off', | ||
|
|
||
| ignorePatterns: [ | ||
| '!.eslintrc.js', | ||
| '!.prettierrc.js', | ||
| 'dist/', | ||
| 'docs/', | ||
| '.yarn/', | ||
| ], | ||
| // TODO: re-enble most of these rules | ||
| '@typescript-eslint/naming-convention': 'off', | ||
| 'function-paren-newline': 'off', | ||
| 'guard-for-in': 'off', | ||
| 'id-denylist': 'off', | ||
| 'implicit-arrow-linebreak': 'off', | ||
| 'import/no-anonymous-default-export': 'off', | ||
| 'import/no-unassigned-import': 'off', | ||
| 'lines-around-comment': 'off', | ||
| 'n/no-sync': 'off', | ||
| 'no-async-promise-executor': 'off', | ||
| 'no-case-declarations': 'off', | ||
| 'no-invalid-this': 'off', | ||
| 'no-negated-condition': 'off', | ||
| 'no-new': 'off', | ||
| 'no-param-reassign': 'off', | ||
| 'no-restricted-syntax': 'off', | ||
| radix: 'off', | ||
| 'require-atomic-updates': 'off', | ||
| 'jsdoc/match-description': [ | ||
| 'off', | ||
| { matchDescription: '^[A-Z`\\d_][\\s\\S]*[.?!`>)}]$' }, | ||
| ], | ||
| }, | ||
| settings: { | ||
| 'import/resolver': { | ||
| typescript: {}, | ||
| }, | ||
| }, | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.