Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(eslint-plugin): use isTypeArrayTypeOrUnionOfArrayTypes util for checking if type is array #1728

Merged
merged 3 commits into from Apr 13, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 5 additions & 3 deletions packages/eslint-plugin/src/rules/no-for-in-array.ts
Expand Up @@ -25,11 +25,13 @@ export default util.createRule({
const checker = parserServices.program.getTypeChecker();
const originalNode = parserServices.esTreeNodeToTSNodeMap.get(node);

const type = checker.getTypeAtLocation(originalNode.expression);
const type = util.getConstrainedTypeAtLocation(
checker,
originalNode.expression,
);

if (
(typeof type.symbol !== 'undefined' &&
type.symbol.name === 'Array') ||
util.isTypeArrayTypeOrUnionOfArrayTypes(type, checker) ||
(type.flags & ts.TypeFlags.StringLike) !== 0
) {
context.report({
Expand Down
3 changes: 2 additions & 1 deletion packages/eslint-plugin/src/rules/no-unsafe-call.ts
Expand Up @@ -31,7 +31,8 @@ export default util.createRule<[], MessageIds>({
messageId: MessageIds,
): void {
const tsNode = esTreeNodeToTSNodeMap.get(node);
const type = checker.getTypeAtLocation(tsNode);
const type = util.getConstrainedTypeAtLocation(checker, tsNode);

if (util.isTypeAnyType(type)) {
context.report({
node: reportingNode,
Expand Down
3 changes: 2 additions & 1 deletion packages/eslint-plugin/src/rules/no-unsafe-return.ts
Expand Up @@ -74,7 +74,8 @@ export default util.createRule({
}

// function has an explicit return type, so ensure it's a safe return
const returnNodeType = checker.getTypeAtLocation(
const returnNodeType = util.getConstrainedTypeAtLocation(
checker,
esTreeNodeToTSNodeMap.get(returnNode),
);
const functionTSNode = esTreeNodeToTSNodeMap.get(functionNode);
Expand Down
27 changes: 8 additions & 19 deletions packages/eslint-plugin/src/rules/require-array-sort-compare.ts
@@ -1,5 +1,4 @@
import { TSESTree } from '@typescript-eslint/experimental-utils';
import * as ts from 'typescript';
import * as util from '../util';

export default util.createRule({
Expand Down Expand Up @@ -27,26 +26,16 @@ export default util.createRule({

return {
":matches(CallExpression, OptionalCallExpression)[arguments.length=0] > :matches(MemberExpression, OptionalMemberExpression)[property.name='sort'][computed=false]"(
node: TSESTree.MemberExpression | TSESTree.OptionalMemberExpression,
callee: TSESTree.MemberExpression | TSESTree.OptionalMemberExpression,
): void {
// Get the symbol of the `sort` method.
const tsNode = service.esTreeNodeToTSNodeMap.get(node);
const sortSymbol = checker.getSymbolAtLocation(tsNode);
if (sortSymbol == null) {
return;
}
const tsNode = service.esTreeNodeToTSNodeMap.get(callee.object);
const calleeObjType = util.getConstrainedTypeAtLocation(
checker,
tsNode,
);

// Check the owner type of the `sort` method.
for (const methodDecl of sortSymbol.declarations) {
const typeDecl = methodDecl.parent;
if (
ts.isInterfaceDeclaration(typeDecl) &&
ts.isSourceFile(typeDecl.parent) &&
typeDecl.name.escapedText === 'Array'
) {
context.report({ node: node.parent!, messageId: 'requireCompare' });
return;
}
if (util.isTypeArrayTypeOrUnionOfArrayTypes(calleeObjType, checker)) {
G-Rath marked this conversation as resolved.
Show resolved Hide resolved
context.report({ node: callee.parent!, messageId: 'requireCompare' });
}
},
};
Expand Down
12 changes: 1 addition & 11 deletions packages/eslint-plugin/src/rules/restrict-plus-operands.ts
Expand Up @@ -54,16 +54,6 @@ export default util.createRule<Options, MessageIds>({
* Helper function to get base type of node
*/
function getBaseTypeOfLiteralType(type: ts.Type): BaseLiteral {
const constraint = type.getConstraint();
if (
constraint &&
// for generic types with union constraints, it will return itself from getConstraint
// so we have to guard against infinite recursion...
constraint !== type
) {
return getBaseTypeOfLiteralType(constraint);
}

if (type.isNumberLiteral()) {
return 'number';
}
Expand Down Expand Up @@ -98,7 +88,7 @@ export default util.createRule<Options, MessageIds>({
*/
function getNodeType(node: TSESTree.Expression): BaseLiteral {
const tsNode = service.esTreeNodeToTSNodeMap.get(node);
const type = typeChecker.getTypeAtLocation(tsNode);
const type = util.getConstrainedTypeAtLocation(typeChecker, tsNode);

return getBaseTypeOfLiteralType(type);
}
Expand Down
Expand Up @@ -98,21 +98,12 @@ export default util.createRule<Options, MessageId>({
*/
function getNodeType(node: TSESTree.Expression): BaseType[] {
const tsNode = service.esTreeNodeToTSNodeMap.get(node);
const type = typeChecker.getTypeAtLocation(tsNode);
const type = util.getConstrainedTypeAtLocation(typeChecker, tsNode);

return getBaseType(type);
}

function getBaseType(type: ts.Type): BaseType[] {
const constraint = type.getConstraint();
if (
constraint &&
// for generic types with union constraints, it will return itself
constraint !== type
) {
return getBaseType(constraint);
}

if (type.isStringLiteral()) {
return ['string'];
}
Expand Down
17 changes: 17 additions & 0 deletions packages/eslint-plugin/src/util/types.ts
Expand Up @@ -13,6 +13,23 @@ import {
} from 'tsutils';
import * as ts from 'typescript';

/**
* Checks if the given type is either an array type,
* or a union made up solely of array types.
*/
export function isTypeArrayTypeOrUnionOfArrayTypes(
type: ts.Type,
checker: ts.TypeChecker,
): boolean {
for (const t of unionTypeParts(type)) {
if (!checker.isArrayType(t)) {
return false;
}
}

return true;
}

/**
* @param type Type being checked by name.
* @param allowedNames Symbol names checking on the type.
Expand Down
45 changes: 45 additions & 0 deletions packages/eslint-plugin/tests/rules/no-for-in-array.test.ts
Expand Up @@ -54,5 +54,50 @@ for (const x in z) {
},
],
},
{
code: `
const fn = (arr: number[]) => {
for (const x in arr) {
console.log(x);
}
};
`,
errors: [
{
messageId: 'forInViolation',
type: AST_NODE_TYPES.ForInStatement,
},
],
},
{
code: `
const fn = (arr: number[] | string[]) => {
for (const x in arr) {
console.log(x);
}
};
`,
errors: [
{
messageId: 'forInViolation',
type: AST_NODE_TYPES.ForInStatement,
},
],
},
{
code: `
const fn = <T extends any[]>(arr: T) => {
for (const x in arr) {
console.log(x);
}
};
`,
errors: [
{
messageId: 'forInViolation',
type: AST_NODE_TYPES.ForInStatement,
},
],
},
],
});
7 changes: 7 additions & 0 deletions packages/eslint-plugin/tests/rules/no-unsafe-call.test.ts
Expand Up @@ -47,6 +47,7 @@ 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?.() }
function foo<T extends any>(x: T) { x() }
`,
errors: [
{
Expand All @@ -73,6 +74,12 @@ function foo(x: any) { x.a.b.c.d.e.f.g?.() }
column: 24,
endColumn: 39,
},
{
messageId: 'unsafeCall',
line: 6,
column: 37,
endColumn: 38,
},
],
}),
...batchedSingleLineTests({
Expand Down
18 changes: 18 additions & 0 deletions packages/eslint-plugin/tests/rules/no-unsafe-return.test.ts
Expand Up @@ -73,6 +73,24 @@ function foo(): Set<number> {
`,
],
invalid: [
{
code: `
function fn<T extends any>(x: T) {
return x;
}
`,
errors: [
{
messageId: 'unsafeReturnAssignment',
data: {
sender: 'any',
receiver: 'T',
},
line: 3,
column: 3,
},
],
},
...batchedSingleLineTests({
code: noFormat`
function foo() { return (1 as any); }
Expand Down