Upgrade to MM eslint-config-* v15 + ESLint 9 #168
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,5 +1,10 @@ | ||
| #!/usr/bin/env node | ||
|
|
||
| // Three things: | ||
| // - This file doesn't export anything, as it's a script. | ||
| // - We are using a `.js` extension because that's what appears in `dist/`. | ||
| // - This file will only exist after running `yarn build`. We don't want | ||
| // developers or CI to receive a lint error if the script has not been run. | ||
| // (A warning will appear if the script *has* been run, but that is okay.) | ||
| // eslint-disable-next-line import-x/no-unassigned-import, import-x/extensions, import-x/no-unresolved | ||
| import '../dist/cli.js'; |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| import base, { createConfig } from '@metamask/eslint-config'; | ||
| import jest from '@metamask/eslint-config-jest'; | ||
| import nodejs from '@metamask/eslint-config-nodejs'; | ||
| import typescript from '@metamask/eslint-config-typescript'; | ||
|
|
||
| const config = createConfig([ | ||
| { | ||
| ignores: ['dist/', 'docs/', '.yarn/'], | ||
| }, | ||
|
|
||
| { | ||
| extends: base, | ||
|
|
||
| languageOptions: { | ||
| sourceType: 'module', | ||
| parserOptions: { | ||
| tsconfigRootDir: import.meta.dirname, | ||
| }, | ||
| }, | ||
|
|
||
| rules: { | ||
| // Consider copying this to @metamask/eslint-config | ||
| 'jsdoc/require-jsdoc': [ | ||
| 'error', | ||
| { | ||
| require: { | ||
| // Classes | ||
| ClassDeclaration: true, | ||
| // Function declarations | ||
| FunctionDeclaration: true, | ||
| // Methods | ||
| MethodDefinition: true, | ||
| }, | ||
| contexts: [ | ||
| // Type interfaces that are not defined within `declare` blocks | ||
| ':not(TSModuleBlock) > TSInterfaceDeclaration', | ||
| // Type aliases | ||
| 'TSTypeAliasDeclaration', | ||
| // Enums | ||
| 'TSEnumDeclaration', | ||
| // Arrow functions that are not contained within plain objects or | ||
| // are not arguments to functions or methods | ||
| ':not(Property, NewExpression, CallExpression) > ArrowFunctionExpression', | ||
| // Function expressions that are not contained within plain objects | ||
| // or are not arguments to functions or methods | ||
| ':not(Property, NewExpression, CallExpression) > FunctionExpression', | ||
| // Exported variables at the root | ||
| 'ExportNamedDeclaration:has(> VariableDeclaration)', | ||
| ], | ||
| }, | ||
| ], | ||
| // Consider copying this to @metamask/eslint-config | ||
| 'jsdoc/no-blank-blocks': 'error', | ||
|
Contributor
Author
There was a problem hiding this comment. I realized that this existed and I found this to be a helpful rule. It seemed that with the new JSDoc rules, running |
||
| }, | ||
|
|
||
| settings: { | ||
| 'import-x/extensions': ['.js', '.mjs'], | ||
| }, | ||
| }, | ||
|
|
||
| { | ||
| files: ['**/*.ts'], | ||
| extends: typescript, | ||
| rules: { | ||
| // Consider copying this to @metamask/eslint-config | ||
| '@typescript-eslint/explicit-function-return-type': [ | ||
| 'error', | ||
| { | ||
| allowExpressions: true, | ||
|
Contributor
Author
There was a problem hiding this comment. Again, I found that this new rule was too strict. For instance: return {
// A return type is now required for this function
message: () => 'foo',
pass: false,
} |
||
| }, | ||
| ], | ||
| // Consider copying this to @metamask/eslint-config | ||
| 'jsdoc/require-jsdoc': [ | ||
| 'error', | ||
| { | ||
| require: { | ||
| // Classes | ||
| ClassDeclaration: true, | ||
| // Function declarations | ||
| FunctionDeclaration: true, | ||
| // Methods | ||
| MethodDefinition: true, | ||
| }, | ||
| contexts: [ | ||
| // Type interfaces that are not defined within `declare` blocks | ||
| ':not(TSModuleBlock) > TSInterfaceDeclaration', | ||
| // Type aliases | ||
| 'TSTypeAliasDeclaration', | ||
| // Enums | ||
| 'TSEnumDeclaration', | ||
| // Arrow functions that are not contained within plain objects or | ||
| // are not arguments to functions or methods | ||
| ':not(Property, NewExpression, CallExpression) > ArrowFunctionExpression', | ||
| // Function expressions that are not contained within plain objects | ||
| // or are not arguments to functions or methods | ||
| ':not(Property, NewExpression, CallExpression) > FunctionExpression', | ||
| // Exported variables at the root | ||
| 'ExportNamedDeclaration:has(> VariableDeclaration)', | ||
| ], | ||
| }, | ||
| ], | ||
| // Consider copying this to @metamask/eslint-config | ||
| 'jsdoc/no-blank-blocks': 'error', | ||
| }, | ||
| }, | ||
|
|
||
| { | ||
| files: ['**/*.js', '**/*.cjs', '**/*.ts', '**/*.test.ts', '**/*.test.js'], | ||
| ignores: ['src/ui/**'], | ||
| extends: nodejs, | ||
| }, | ||
|
|
||
| { | ||
| files: ['**/*.test.ts'], | ||
| extends: jest, | ||
| }, | ||
|
|
||
| // List this last to override any settings inherited from plugins, | ||
| // especially `eslint-config-n`, which mistakenly assumes that all `.cjs` | ||
| // files are modules (since we specified `type: module` in `package.json`) | ||
| { | ||
| files: ['**/*.js', '**/*.cjs'], | ||
| // This *is* a script, but is written using ESM. | ||
| ignores: ['bin/create-release-branch.js'], | ||
| languageOptions: { | ||
| sourceType: 'script', | ||
| }, | ||
| }, | ||
| ]); | ||
|
|
||
| export default config; | ||
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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,14 +1,11 @@ | ||
| import { dirname } from 'path'; | ||
| import { fileURLToPath } from 'url'; | ||
|
|
||
| /** | ||
| * Get the current directory path. | ||
| * | ||
| * @returns The current directory path. | ||
| */ | ||
| export function getCurrentDirectoryPath(): string { | ||
| return dirname(fileURLToPath(import.meta.url)); | ||
| } |
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As stated in the PR description, I found the new changes to this rule in MetaMask/eslint-config#394 rather strict. I removed
TSPropertySignatureas it began asking that properties in adhoc object types were documented. For instance:I also found a similar thing for arrow functions:
So, I amended what this rule is looking for, which is explained in the comments below. I feel like this makes more sense, but happy to know y'all's thoughts.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For future reference, I used https://astexplorer.net/ to test out the selectors (make sure to select
@typescript-eslint/parserand Transform > ESLint v8).