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): add rule no-unsafe-call#1647
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
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
File 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
1 change: 1 addition & 0 deletionspackages/eslint-plugin/README.md
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
41 changes: 41 additions & 0 deletionspackages/eslint-plugin/docs/rules/no-unsafe-call.md
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,41 @@ | ||
| # Disallows calling an any type value (`no-unsafe-call`) | ||
| Despite your best intentions, the `any` type can sometimes leak into your codebase. | ||
| Member access on `any` typed variables is not checked at all by TypeScript, so it creates a potential safety hole, and source of bugs in your codebase. | ||
| ## Rule Details | ||
| This rule disallows calling any variable that is typed as `any`. | ||
| Examples of **incorrect** code for this rule: | ||
| ```ts | ||
| declare const anyVar: any; | ||
| declare const nestedAny: { prop: any }; | ||
| anyVar(); | ||
| anyVar.a.b(); | ||
| nestedAny.prop(); | ||
| nestedAny.prop['a'](); | ||
| new anyVar(); | ||
| new nestedAny.prop(); | ||
| ``` | ||
| Examples of **correct** code for this rule: | ||
| ```ts | ||
| declare const properlyTyped: { prop: { a: () => void } }; | ||
| nestedAny.prop.a(); | ||
| (() => {})(); | ||
| new Map(); | ||
| ``` | ||
| ## Related to | ||
| - [`no-explicit-any`](./no-explicit-any.md) | ||
| - TSLint: [`no-unsafe-any`](https://palantir.github.io/tslint/rules/no-unsafe-any/) |
1 change: 1 addition & 0 deletionspackages/eslint-plugin/src/configs/all.json
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
52 changes: 52 additions & 0 deletionspackages/eslint-plugin/src/rules/no-unsafe-call.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,52 @@ | ||
| import { TSESTree } from '@typescript-eslint/experimental-utils'; | ||
| import * as util from '../util'; | ||
| type MessageIds = 'unsafeCall' | 'unsafeNew'; | ||
| export default util.createRule<[], MessageIds>({ | ||
| name: 'no-unsafe-call', | ||
| meta: { | ||
| type: 'problem', | ||
| docs: { | ||
| description: 'Disallows calling an any type value', | ||
| category: 'Possible Errors', | ||
| recommended: false, | ||
| requiresTypeChecking: true, | ||
| }, | ||
| messages: { | ||
| unsafeCall: 'Unsafe call of an any typed value', | ||
| unsafeNew: 'Unsafe construction of an any type value', | ||
| }, | ||
| schema: [], | ||
| }, | ||
| defaultOptions: [], | ||
| create(context) { | ||
| const { program, esTreeNodeToTSNodeMap } = util.getParserServices(context); | ||
| const checker = program.getTypeChecker(); | ||
| function checkCall( | ||
| node: | ||
| | TSESTree.CallExpression | ||
| | TSESTree.OptionalCallExpression | ||
| | TSESTree.NewExpression, | ||
| reportingNode: TSESTree.Expression = node.callee, | ||
| messageId: MessageIds = 'unsafeCall', | ||
| ): void { | ||
| const tsNode = esTreeNodeToTSNodeMap.get(node.callee); | ||
| const type = checker.getTypeAtLocation(tsNode); | ||
| if (util.isTypeAnyType(type)) { | ||
| context.report({ | ||
| node: reportingNode, | ||
| messageId: messageId, | ||
| }); | ||
| } | ||
| } | ||
| return { | ||
| 'CallExpression, OptionalCallExpression': checkCall, | ||
| NewExpression(node): void { | ||
| checkCall(node, node, 'unsafeNew'); | ||
| }, | ||
| }; | ||
| }, | ||
| }); |
106 changes: 106 additions & 0 deletionspackages/eslint-plugin/tests/rules/no-unsafe-call.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,106 @@ | ||
| import rule from '../../src/rules/no-unsafe-call'; | ||
| import { | ||
| RuleTester, | ||
| batchedSingleLineTests, | ||
| getFixturesRootDir, | ||
| } from '../RuleTester'; | ||
| const ruleTester = new RuleTester({ | ||
| parser: '@typescript-eslint/parser', | ||
| parserOptions: { | ||
| project: './tsconfig.json', | ||
| tsconfigRootDir: getFixturesRootDir(), | ||
| }, | ||
| }); | ||
| ruleTester.run('no-unsafe-call', rule, { | ||
| valid: [ | ||
| 'function foo(x: () => void) { x() }', | ||
| 'function foo(x?: { a: () => void }) { x?.a() }', | ||
| 'function foo(x: { a?: () => void }) { x.a?.() }', | ||
| 'new Map()', | ||
| ], | ||
| invalid: [ | ||
| ...batchedSingleLineTests({ | ||
| code: ` | ||
| function foo(x: any) { x() } | ||
| function foo(x: any) { x?.() } | ||
| function foo(x: any) { x.a.b.c.d.e.f.g() } | ||
| function foo(x: any) { x.a.b.c.d.e.f.g?.() } | ||
| `, | ||
| errors: [ | ||
| { | ||
| messageId: 'unsafeCall', | ||
| line: 2, | ||
| column: 24, | ||
| endColumn: 25, | ||
| }, | ||
| { | ||
| messageId: 'unsafeCall', | ||
| line: 3, | ||
| column: 24, | ||
| endColumn: 25, | ||
| }, | ||
| { | ||
| messageId: 'unsafeCall', | ||
| line: 4, | ||
| column: 24, | ||
| endColumn: 39, | ||
| }, | ||
| { | ||
| messageId: 'unsafeCall', | ||
| line: 5, | ||
| column: 24, | ||
| endColumn: 39, | ||
| }, | ||
| ], | ||
| }), | ||
| ...batchedSingleLineTests({ | ||
| code: ` | ||
| function foo(x: { a: any }) { x.a() } | ||
| function foo(x: { a: any }) { x?.a() } | ||
| function foo(x: { a: any }) { x.a?.() } | ||
| `, | ||
| errors: [ | ||
| { | ||
| messageId: 'unsafeCall', | ||
| line: 2, | ||
| column: 31, | ||
| endColumn: 34, | ||
| }, | ||
| { | ||
| messageId: 'unsafeCall', | ||
| line: 3, | ||
| column: 31, | ||
| endColumn: 35, | ||
| }, | ||
| { | ||
| messageId: 'unsafeCall', | ||
| line: 4, | ||
| column: 31, | ||
| endColumn: 34, | ||
| }, | ||
| ], | ||
| }), | ||
| ...batchedSingleLineTests({ | ||
| code: ` | ||
| function foo(x: any) { new x() } | ||
| function foo(x: { a: any }) { new x.a() } | ||
| `, | ||
| errors: [ | ||
| { | ||
| messageId: 'unsafeNew', | ||
| line: 2, | ||
| column: 24, | ||
| endColumn: 31, | ||
| }, | ||
| { | ||
| messageId: 'unsafeNew', | ||
| line: 3, | ||
| column: 31, | ||
| endColumn: 40, | ||
| }, | ||
| ], | ||
| }), | ||
| ], | ||
| }); |
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.