Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork2.8k
feat(eslint-plugin): [no-misused-object-likes] add rule#10104
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Closed
abrahamguo wants to merge15 commits intotypescript-eslint:mainfromabrahamguo:no-misused-object-likes
Uh oh!
There was an error while loading.Please reload this page.
Closed
Changes fromall commits
Commits
Show all changes
15 commits Select commitHold shift + click to select a range
1f024a2 bring previous PR
abrahamguo0e39ae1 cleanup
abrahamguob08e8a5 Merge branch 'main' of github.com:abrahamguo/typescript-eslint into n…
abrahamguo54cd241 fix TS error and support readonly
abrahamguo813dd7d update description
abrahamguoad28a4a generate-configs
abrahamguoc0ba704 add docs page
abrahamguo139d0e7 WIP
abrahamguo0af7510 Merge branch 'main' of github.com:abrahamguo/typescript-eslint into n…
abrahamguoc1ebe07 implement 'in' operator
abrahamguo605c8e2 lint
abrahamguo0ccee09 check whether symbol is from default library
abrahamguoa5658fd WIP
abrahamguo2d21b9a Merge branch 'main' of github.com:abrahamguo/typescript-eslint into n…
abrahamguo8dec282 lint
abrahamguoFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
34 changes: 34 additions & 0 deletionspackages/eslint-plugin/docs/rules/no-misused-object-likes.mdx
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,34 @@ | ||
| --- | ||
| description: 'Disallow using `Object.{assign|entries|hasOwn|keys|values}(...)` and the `in` operator on Map/Set objects.' | ||
| --- | ||
| import Tabs from '@theme/Tabs'; | ||
| import TabItem from '@theme/TabItem'; | ||
| > 🛑 This file is source code, not the primary documentation location! 🛑 | ||
| > | ||
| > See **https://typescript-eslint.io/rules/no-misused-object-likes** for documentation. | ||
| Methods like `Object.assign()`, `Object.entries()`, `Object.hasOwn()`, `Object.keys()`, and `Object.values()` can be | ||
| used work with collections of data stored in objects. However, when working with `Map` or `Set` objects, even though | ||
| they are collections, using these methods are a mistake because they do not properly write to (in the case of | ||
| `Object.assign()`) or read from the object. | ||
| This rule prevents such methods from being used on `Map` and `Set` objects. | ||
| <Tabs> | ||
| <TabItem value="❌ Incorrect"> | ||
| ```ts | ||
| console.log(Object.values(new Set('abc'))); | ||
| Object.assign(new Map(), { k: 'v' }); | ||
| ``` | ||
| </TabItem> | ||
| <TabItem value="✅ Correct"> | ||
| ```ts | ||
| console.log([...new Set('abc').values()]); | ||
| new Map().set('k', 'v'); | ||
| ``` | ||
| </TabItem> | ||
| </Tabs> | ||
| {/* Intentionally Omitted: When Not To Use It */} |
1 change: 1 addition & 0 deletionspackages/eslint-plugin/src/configs/all.ts
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
1 change: 1 addition & 0 deletionspackages/eslint-plugin/src/configs/disable-type-checked.ts
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
2 changes: 2 additions & 0 deletionspackages/eslint-plugin/src/rules/index.ts
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
80 changes: 80 additions & 0 deletionspackages/eslint-plugin/src/rules/no-misused-object-likes.ts
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,80 @@ | ||
| import type { TSESTree } from '@typescript-eslint/utils'; | ||
| import type * as ts from 'typescript'; | ||
| import { isSymbolFromDefaultLibrary } from '@typescript-eslint/type-utils'; | ||
| import { AST_NODE_TYPES } from '@typescript-eslint/utils'; | ||
| import { | ||
| createRule, | ||
| getParserServices, | ||
| getStaticMemberAccessValue, | ||
| } from '../util'; | ||
| const METHODS = ['assign', 'entries', 'hasOwn', 'keys', 'values']; | ||
| export default createRule({ | ||
| name: 'no-misused-object-likes', | ||
| meta: { | ||
| type: 'problem', | ||
| docs: { | ||
| description: `Disallow using \`Object.{${METHODS.join(`|`)}}(...)\` and the \`in\` operator on Map/Set objects`, | ||
| requiresTypeChecking: true, | ||
| }, | ||
| messages: { | ||
| misusedObjectLike: | ||
| "Don't use {{used}} on {{objectClass}} objects — it will not properly check the contents.", | ||
| }, | ||
| schema: [], | ||
| }, | ||
| defaultOptions: [], | ||
| create(context) { | ||
| const getSymbolIfFromDefaultLibrary = ( | ||
| node: TSESTree.Node, | ||
| ): ts.Symbol | undefined => { | ||
| const services = getParserServices(context); | ||
| const symbol = services.getTypeAtLocation(node).getSymbol(); | ||
| return isSymbolFromDefaultLibrary(services.program, symbol) | ||
| ? symbol | ||
| : undefined; | ||
| }; | ||
| const checkClassAndReport = (node: TSESTree.Node, used: string): void => { | ||
| const objectClass = getSymbolIfFromDefaultLibrary(node)?.name; | ||
| if (objectClass && /^(Readonly|Weak)?(Map|Set)$/.test(objectClass)) { | ||
| context.report({ | ||
| node, | ||
| messageId: 'misusedObjectLike', | ||
| data: { objectClass, used }, | ||
| }); | ||
| } | ||
| }; | ||
| return { | ||
| BinaryExpression(node): void { | ||
| if (node.operator === 'in') { | ||
| checkClassAndReport(node.right, 'the `in` operator'); | ||
| } | ||
| }, | ||
| CallExpression(node): void { | ||
| const { arguments: args, callee } = node; | ||
| if ( | ||
| args.length !== 1 || | ||
| callee.type !== AST_NODE_TYPES.MemberExpression | ||
| ) { | ||
| return; | ||
| } | ||
| const { object } = callee; | ||
| if ( | ||
| object.type !== AST_NODE_TYPES.Identifier || | ||
| object.name !== 'Object' || | ||
| getSymbolIfFromDefaultLibrary(object) | ||
| ) { | ||
| return; | ||
| } | ||
| const method = getStaticMemberAccessValue(callee, context); | ||
| if (typeof method === 'string' && METHODS.includes(method)) { | ||
| checkClassAndReport(args[0], `\`Object.${method}()\``); | ||
| } | ||
| }, | ||
| }; | ||
| }, | ||
| }); |
18 changes: 18 additions & 0 deletionspackages/eslint-plugin/tests/docs-eslint-output-snapshots/no-misused-object-likes.shot
Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
120 changes: 120 additions & 0 deletionspackages/eslint-plugin/tests/rules/no-misused-object-likes.test.ts
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,120 @@ | ||
| import { RuleTester } from '@typescript-eslint/rule-tester'; | ||
| import rule from '../../src/rules/no-misused-object-likes'; | ||
| import { getFixturesRootDir } from '../RuleTester'; | ||
| const rootPath = getFixturesRootDir(); | ||
| const ruleTester = new RuleTester({ | ||
| languageOptions: { | ||
| parserOptions: { | ||
| project: './tsconfig.json', | ||
| tsconfigRootDir: rootPath, | ||
| }, | ||
| }, | ||
| }); | ||
| ruleTester.run('no-misused-object-likes', rule, { | ||
| valid: [ | ||
| ` | ||
| class ExMap extends Map {} | ||
| const map = new ExMap(); | ||
| Object.keys(map); | ||
| `, | ||
| ` | ||
| class ExMap extends Map {} | ||
| const map = new ExMap(); | ||
| Object.values(map); | ||
| `, | ||
| ` | ||
| class ExMap extends Map {} | ||
| const map = new ExMap(); | ||
| Object.entries(map); | ||
| `, | ||
| ` | ||
| const test = {}; | ||
| Object.entries(test); | ||
| `, | ||
| ` | ||
| const test = {}; | ||
| Object.keys(test); | ||
| `, | ||
| ` | ||
| const test = {}; | ||
| Object.values(test); | ||
| `, | ||
| ` | ||
| const test = []; | ||
| Object.keys(test); | ||
| `, | ||
| ` | ||
| const test = []; | ||
| Object.values(test); | ||
| `, | ||
| ` | ||
| const test = []; | ||
| Object.entries(test); | ||
| `, | ||
| ` | ||
| const test = 123; | ||
| Object.keys(test); | ||
| `, | ||
| 'Object.values(new (class Map {})());', | ||
| ` | ||
| const Object = { keys: () => {} }; | ||
| Object.keys(new Map()); | ||
| `, | ||
| ], | ||
| invalid: [ | ||
| { | ||
| code: ` | ||
| const map = new Map(); | ||
| const result = Object.keys(map); | ||
| `, | ||
| errors: [{ messageId: 'misusedObjectLike' }], | ||
| }, | ||
| { | ||
| code: ` | ||
| const map = new Map(); | ||
| const result = Object.entries(map); | ||
| `, | ||
| errors: [{ messageId: 'misusedObjectLike' }], | ||
| }, | ||
| { | ||
| code: ` | ||
| const map = new Map(); | ||
| const result = Object.values(map); | ||
| `, | ||
| errors: [{ messageId: 'misusedObjectLike' }], | ||
| }, | ||
| { | ||
| code: ` | ||
| const set = new Set(); | ||
| const result = Object.keys(set); | ||
| `, | ||
| errors: [{ messageId: 'misusedObjectLike' }], | ||
| }, | ||
| { | ||
| code: ` | ||
| const set = new Set(); | ||
| const result = Object.entries(set); | ||
| `, | ||
| errors: [{ messageId: 'misusedObjectLike' }], | ||
| }, | ||
| { | ||
| code: ` | ||
| const set = new Set(); | ||
| const result = Object.values(set); | ||
| `, | ||
| errors: [{ messageId: 'misusedObjectLike' }], | ||
| }, | ||
| { | ||
| code: ` | ||
| const test = new WeakMap(); | ||
| Object.keys(test); | ||
| `, | ||
| errors: [{ messageId: 'misusedObjectLike' }], | ||
| }, | ||
| { code: '4 in new Set();', errors: [{ messageId: 'misusedObjectLike' }] }, | ||
| ], | ||
| }); |
14 changes: 14 additions & 0 deletionspackages/eslint-plugin/tests/schema-snapshots/no-misused-object-likes.shot
Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
1 change: 1 addition & 0 deletionspackages/typescript-eslint/src/configs/all.ts
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
1 change: 1 addition & 0 deletionspackages/typescript-eslint/src/configs/disable-type-checked.ts
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.
Uh oh!
There was an error while loading.Please reload this page.
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.