From 02c4c9fa7a6897400daba1dc3d935f0ee1c05308 Mon Sep 17 00:00:00 2001 From: rrogowski Date: Tue, 11 Dec 2018 12:55:41 -0500 Subject: [PATCH 01/60] Fix callable-types should handle `new(): T` just like `(): T` (#4352) * callable-types handle new(): T * make FormatterConstructor comply with new callable-types rule bugfix * fix lint * avoid code duplication * lint and test fixes * ignore callable-types instead of trying to fix * edit comment * link to issue --- src/language/formatter/formatter.ts | 5 +++++ src/rules/callableTypesRule.ts | 5 +++-- test/rules/callable-types/test.ts.fix | 4 +++- test/rules/callable-types/test.ts.lint | 9 +++++++-- 4 files changed, 18 insertions(+), 5 deletions(-) diff --git a/src/language/formatter/formatter.ts b/src/language/formatter/formatter.ts index 24a0fde1ddf..a13a92cd2fa 100644 --- a/src/language/formatter/formatter.ts +++ b/src/language/formatter/formatter.ts @@ -46,7 +46,12 @@ export interface IFormatterMetadata { export type ConsumerType = "human" | "machine"; +// See https://github.com/palantir/tslint/issues/4364 +// TODO: Enable the `callable-types` rule below. Currently, it +// produces a lint error in several locations complaining about the +// `no-inferred-empty-object-type` rule. export interface FormatterConstructor { + // tslint:disable-next-line:callable-types new (): IFormatter; } diff --git a/src/rules/callableTypesRule.ts b/src/rules/callableTypesRule.ts index 152df3340b1..e24f5aab1c3 100644 --- a/src/rules/callableTypesRule.ts +++ b/src/rules/callableTypesRule.ts @@ -18,6 +18,7 @@ import { getChildOfKind, isCallSignatureDeclaration, + isConstructSignatureDeclaration, isIdentifier, isInterfaceDeclaration, isTypeLiteralNode, @@ -58,7 +59,7 @@ function walk(ctx: Lint.WalkContext) { ) { const member = node.members[0]; if ( - isCallSignatureDeclaration(member) && + (isConstructSignatureDeclaration(member) || isCallSignatureDeclaration(member)) && // avoid bad parse member.type !== undefined ) { @@ -96,7 +97,7 @@ function noSupertype(node: ts.InterfaceDeclaration): boolean { } function renderSuggestion( - call: ts.CallSignatureDeclaration, + call: ts.CallSignatureDeclaration | ts.ConstructSignatureDeclaration, parent: ts.InterfaceDeclaration | ts.TypeLiteralNode, sourceFile: ts.SourceFile, ): string { diff --git a/test/rules/callable-types/test.ts.fix b/test/rules/callable-types/test.ts.fix index e82feeb5cf7..350ce4ca699 100644 --- a/test/rules/callable-types/test.ts.fix +++ b/test/rules/callable-types/test.ts.fix @@ -26,7 +26,9 @@ interface K { } // handle modifiers -export type I = () => void; +export type I0 = () => void; + +export type I1 = new () => void; export type T = () => void diff --git a/test/rules/callable-types/test.ts.lint b/test/rules/callable-types/test.ts.lint index 7f9c3719aa8..fc36bcb058f 100644 --- a/test/rules/callable-types/test.ts.lint +++ b/test/rules/callable-types/test.ts.lint @@ -54,9 +54,14 @@ interface K { } // handle modifiers -export interface I { +export interface I0 { (): void; - ~~~~~~~~~ [interface % ('type I = () => void;')] + ~~~~~~~~~ [interface % ('type I0 = () => void;')] +} + +export interface I1 { + new (): void; + ~~~~~~~~~~~~~ [interface % ('type I1 = new () => void;')] } export type T = { From 6b0af8fabb4bc98338d8912a693f5f851812dfff Mon Sep 17 00:00:00 2001 From: Eric Anderson Date: Tue, 11 Dec 2018 17:13:23 -0500 Subject: [PATCH 02/60] Use 2018 for copyright (#4367) --- docs/_includes/footer.html | 2 +- scripts/buildDocs.ts | 2 +- src/configs/latest.ts | 2 +- src/configs/recommended.ts | 2 +- src/error.ts | 2 +- src/formatters/checkstyleFormatter.ts | 2 +- src/formatters/junitFormatter.ts | 2 +- src/formatters/msbuildFormatter.ts | 2 +- src/formatters/vsoFormatter.ts | 2 +- src/language/rule/typedRule.ts | 2 +- src/language/walker/programAwareRuleWalker.ts | 2 +- src/rules/arrayTypeRule.ts | 2 +- src/rules/arrowParensRule.ts | 2 +- src/rules/cyclomaticComplexityRule.ts | 2 +- src/rules/deprecationRule.ts | 2 +- src/rules/fileHeaderRule.ts | 2 +- src/rules/importBlacklistRule.ts | 2 +- src/rules/linebreakStyleRule.ts | 2 +- src/rules/maxClassesPerFileRule.ts | 2 +- src/rules/newParensRule.ts | 2 +- src/rules/noAngleBracketTypeAssertionRule.ts | 2 +- src/rules/noDefaultExportRule.ts | 2 +- src/rules/noFloatingPromisesRule.ts | 2 +- src/rules/noForInArrayRule.ts | 2 +- src/rules/noInferredEmptyObjectTypeRule.ts | 2 +- src/rules/noInvalidThisRule.ts | 2 +- src/rules/noMagicNumbersRule.ts | 2 +- src/rules/noMergeableNamespaceRule.ts | 2 +- src/rules/noNamespaceRule.ts | 2 +- src/rules/noReferenceRule.ts | 2 +- src/rules/noStringThrowRule.ts | 2 +- src/rules/noUnnecessaryTypeAssertionRule.ts | 2 +- src/rules/noUnsafeFinallyRule.ts | 2 +- src/rules/noVoidExpressionRule.ts | 2 +- src/rules/objectLiteralKeyQuotesRule.ts | 2 +- src/rules/objectLiteralShorthandRule.ts | 2 +- src/rules/oneVariablePerDeclarationRule.ts | 2 +- src/rules/orderedImportsRule.ts | 2 +- src/rules/preferForOfRule.ts | 2 +- src/rules/promiseFunctionAsyncRule.ts | 2 +- src/rules/restrictPlusOperandsRule.ts | 2 +- src/rules/spaceBeforeFunctionParenRule.ts | 2 +- src/rules/strictBooleanExpressionsRule.ts | 2 +- src/test.ts | 2 +- src/utils.ts | 2 +- src/verify/lines.ts | 2 +- src/verify/lintError.ts | 2 +- src/verify/parse.ts | 2 +- test/configurationTests.ts | 2 +- test/executable/executableTests.ts | 2 +- test/formatters/checkstyleFormatterTests.ts | 2 +- test/formatters/junitFormatterTests.ts | 2 +- test/rule-tester/linesTests.ts | 2 +- test/rule-tester/parseTests.ts | 2 +- test/rule-tester/testData.ts | 2 +- test/ruleTestRunner.ts | 2 +- test/utilsTests.ts | 2 +- 57 files changed, 57 insertions(+), 57 deletions(-) diff --git a/docs/_includes/footer.html b/docs/_includes/footer.html index 5f8dfce81df..e5e2121c862 100644 --- a/docs/_includes/footer.html +++ b/docs/_includes/footer.html @@ -2,7 +2,7 @@
diff --git a/scripts/buildDocs.ts b/scripts/buildDocs.ts index d944a01b05b..f34b2765877 100644 --- a/scripts/buildDocs.ts +++ b/scripts/buildDocs.ts @@ -1,5 +1,5 @@ /* - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/configs/latest.ts b/src/configs/latest.ts index 341334ddf38..f96fff8b091 100644 --- a/src/configs/latest.ts +++ b/src/configs/latest.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/configs/recommended.ts b/src/configs/recommended.ts index b9e81ec6fd4..b918e6aa6e5 100644 --- a/src/configs/recommended.ts +++ b/src/configs/recommended.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/error.ts b/src/error.ts index 3b120bec45f..0054f9f24ab 100644 --- a/src/error.ts +++ b/src/error.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/formatters/checkstyleFormatter.ts b/src/formatters/checkstyleFormatter.ts index 260cc20fee3..a77f0773f1e 100644 --- a/src/formatters/checkstyleFormatter.ts +++ b/src/formatters/checkstyleFormatter.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/formatters/junitFormatter.ts b/src/formatters/junitFormatter.ts index 4f3b5151839..a0ee610205e 100644 --- a/src/formatters/junitFormatter.ts +++ b/src/formatters/junitFormatter.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/formatters/msbuildFormatter.ts b/src/formatters/msbuildFormatter.ts index 2fea7a1a2f5..b5811b42eb5 100644 --- a/src/formatters/msbuildFormatter.ts +++ b/src/formatters/msbuildFormatter.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/formatters/vsoFormatter.ts b/src/formatters/vsoFormatter.ts index 82fc633d255..9d32a4eda97 100644 --- a/src/formatters/vsoFormatter.ts +++ b/src/formatters/vsoFormatter.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/language/rule/typedRule.ts b/src/language/rule/typedRule.ts index 289987424ff..fc377edf42e 100644 --- a/src/language/rule/typedRule.ts +++ b/src/language/rule/typedRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/language/walker/programAwareRuleWalker.ts b/src/language/walker/programAwareRuleWalker.ts index c5934102257..c2bbf650e53 100644 --- a/src/language/walker/programAwareRuleWalker.ts +++ b/src/language/walker/programAwareRuleWalker.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/arrayTypeRule.ts b/src/rules/arrayTypeRule.ts index cbf525555a1..a49abcf6c99 100644 --- a/src/rules/arrayTypeRule.ts +++ b/src/rules/arrayTypeRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/arrowParensRule.ts b/src/rules/arrowParensRule.ts index f57b1b19d94..25c278efece 100644 --- a/src/rules/arrowParensRule.ts +++ b/src/rules/arrowParensRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/cyclomaticComplexityRule.ts b/src/rules/cyclomaticComplexityRule.ts index e95773292b9..b38214d0eb1 100644 --- a/src/rules/cyclomaticComplexityRule.ts +++ b/src/rules/cyclomaticComplexityRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/deprecationRule.ts b/src/rules/deprecationRule.ts index 7b9f4883ebc..5d37442b4ce 100644 --- a/src/rules/deprecationRule.ts +++ b/src/rules/deprecationRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/fileHeaderRule.ts b/src/rules/fileHeaderRule.ts index 405aa72cdfa..2d90a0a2003 100644 --- a/src/rules/fileHeaderRule.ts +++ b/src/rules/fileHeaderRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/importBlacklistRule.ts b/src/rules/importBlacklistRule.ts index c8a3dcb95a0..981da1b4d99 100644 --- a/src/rules/importBlacklistRule.ts +++ b/src/rules/importBlacklistRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/linebreakStyleRule.ts b/src/rules/linebreakStyleRule.ts index 4e0d6db5e99..84ebe2d88bc 100644 --- a/src/rules/linebreakStyleRule.ts +++ b/src/rules/linebreakStyleRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/maxClassesPerFileRule.ts b/src/rules/maxClassesPerFileRule.ts index fd0deddef13..fe5adc6a643 100644 --- a/src/rules/maxClassesPerFileRule.ts +++ b/src/rules/maxClassesPerFileRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/newParensRule.ts b/src/rules/newParensRule.ts index 46587016009..8acc42c9789 100644 --- a/src/rules/newParensRule.ts +++ b/src/rules/newParensRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/noAngleBracketTypeAssertionRule.ts b/src/rules/noAngleBracketTypeAssertionRule.ts index 3392e203936..2ccba41fd1d 100644 --- a/src/rules/noAngleBracketTypeAssertionRule.ts +++ b/src/rules/noAngleBracketTypeAssertionRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/noDefaultExportRule.ts b/src/rules/noDefaultExportRule.ts index 2d2d21cd6bd..be54752c5cb 100644 --- a/src/rules/noDefaultExportRule.ts +++ b/src/rules/noDefaultExportRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/noFloatingPromisesRule.ts b/src/rules/noFloatingPromisesRule.ts index e8deb1b6772..a1d7a9c1795 100644 --- a/src/rules/noFloatingPromisesRule.ts +++ b/src/rules/noFloatingPromisesRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/noForInArrayRule.ts b/src/rules/noForInArrayRule.ts index 0a9aec10f83..89a1436e144 100644 --- a/src/rules/noForInArrayRule.ts +++ b/src/rules/noForInArrayRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/noInferredEmptyObjectTypeRule.ts b/src/rules/noInferredEmptyObjectTypeRule.ts index 76401272e94..212d6e16de7 100644 --- a/src/rules/noInferredEmptyObjectTypeRule.ts +++ b/src/rules/noInferredEmptyObjectTypeRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/noInvalidThisRule.ts b/src/rules/noInvalidThisRule.ts index f6286acbf6f..4b3b5b7734d 100644 --- a/src/rules/noInvalidThisRule.ts +++ b/src/rules/noInvalidThisRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/noMagicNumbersRule.ts b/src/rules/noMagicNumbersRule.ts index f98f41cb6a4..183bc78911a 100644 --- a/src/rules/noMagicNumbersRule.ts +++ b/src/rules/noMagicNumbersRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/noMergeableNamespaceRule.ts b/src/rules/noMergeableNamespaceRule.ts index af6e2971e6c..f29cac32aac 100644 --- a/src/rules/noMergeableNamespaceRule.ts +++ b/src/rules/noMergeableNamespaceRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/noNamespaceRule.ts b/src/rules/noNamespaceRule.ts index 62d6827cb47..773c701d78b 100644 --- a/src/rules/noNamespaceRule.ts +++ b/src/rules/noNamespaceRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/noReferenceRule.ts b/src/rules/noReferenceRule.ts index 6499dcc3bd6..31d18f41d19 100644 --- a/src/rules/noReferenceRule.ts +++ b/src/rules/noReferenceRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/noStringThrowRule.ts b/src/rules/noStringThrowRule.ts index f7600a71a79..aa54424e394 100644 --- a/src/rules/noStringThrowRule.ts +++ b/src/rules/noStringThrowRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/noUnnecessaryTypeAssertionRule.ts b/src/rules/noUnnecessaryTypeAssertionRule.ts index 4a9870f57a4..964c73ce03b 100644 --- a/src/rules/noUnnecessaryTypeAssertionRule.ts +++ b/src/rules/noUnnecessaryTypeAssertionRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/noUnsafeFinallyRule.ts b/src/rules/noUnsafeFinallyRule.ts index f4ae4b194e2..97d4102e07c 100644 --- a/src/rules/noUnsafeFinallyRule.ts +++ b/src/rules/noUnsafeFinallyRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/noVoidExpressionRule.ts b/src/rules/noVoidExpressionRule.ts index dac8663fc7e..873d65e560a 100644 --- a/src/rules/noVoidExpressionRule.ts +++ b/src/rules/noVoidExpressionRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/objectLiteralKeyQuotesRule.ts b/src/rules/objectLiteralKeyQuotesRule.ts index 572105dec39..ab517926570 100644 --- a/src/rules/objectLiteralKeyQuotesRule.ts +++ b/src/rules/objectLiteralKeyQuotesRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/objectLiteralShorthandRule.ts b/src/rules/objectLiteralShorthandRule.ts index 64c45911f94..0bc5e8dc5e9 100644 --- a/src/rules/objectLiteralShorthandRule.ts +++ b/src/rules/objectLiteralShorthandRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/oneVariablePerDeclarationRule.ts b/src/rules/oneVariablePerDeclarationRule.ts index 9aecbf9ed85..f3c9d08a6c8 100644 --- a/src/rules/oneVariablePerDeclarationRule.ts +++ b/src/rules/oneVariablePerDeclarationRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/orderedImportsRule.ts b/src/rules/orderedImportsRule.ts index 9e2733c127d..67c0a2adcf8 100644 --- a/src/rules/orderedImportsRule.ts +++ b/src/rules/orderedImportsRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/preferForOfRule.ts b/src/rules/preferForOfRule.ts index 67ea95b49ee..29e83e25999 100644 --- a/src/rules/preferForOfRule.ts +++ b/src/rules/preferForOfRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/promiseFunctionAsyncRule.ts b/src/rules/promiseFunctionAsyncRule.ts index 8c4bb739398..c15df7d3af2 100644 --- a/src/rules/promiseFunctionAsyncRule.ts +++ b/src/rules/promiseFunctionAsyncRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/restrictPlusOperandsRule.ts b/src/rules/restrictPlusOperandsRule.ts index 0af6cf88f5e..b4b8d7e4827 100644 --- a/src/rules/restrictPlusOperandsRule.ts +++ b/src/rules/restrictPlusOperandsRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/spaceBeforeFunctionParenRule.ts b/src/rules/spaceBeforeFunctionParenRule.ts index 8ee8748df3b..440a149df75 100644 --- a/src/rules/spaceBeforeFunctionParenRule.ts +++ b/src/rules/spaceBeforeFunctionParenRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/rules/strictBooleanExpressionsRule.ts b/src/rules/strictBooleanExpressionsRule.ts index c3c1250cae4..43ad8da2915 100644 --- a/src/rules/strictBooleanExpressionsRule.ts +++ b/src/rules/strictBooleanExpressionsRule.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/test.ts b/src/test.ts index 42c4eebd59f..25fd19233ae 100644 --- a/src/test.ts +++ b/src/test.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/utils.ts b/src/utils.ts index c670208aca8..6f212852cf3 100644 --- a/src/utils.ts +++ b/src/utils.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/verify/lines.ts b/src/verify/lines.ts index f7659485714..ea21ac16e55 100644 --- a/src/verify/lines.ts +++ b/src/verify/lines.ts @@ -1,6 +1,6 @@ /* * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/verify/lintError.ts b/src/verify/lintError.ts index f8eb70c89a3..c36bfa759de 100644 --- a/src/verify/lintError.ts +++ b/src/verify/lintError.ts @@ -1,6 +1,6 @@ /* * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/verify/parse.ts b/src/verify/parse.ts index a4a39e2a880..a505ce01f1d 100644 --- a/src/verify/parse.ts +++ b/src/verify/parse.ts @@ -1,6 +1,6 @@ /* * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/test/configurationTests.ts b/test/configurationTests.ts index 841c372bc74..e5f087a72d1 100644 --- a/test/configurationTests.ts +++ b/test/configurationTests.ts @@ -1,5 +1,5 @@ /* - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/test/executable/executableTests.ts b/test/executable/executableTests.ts index 091e9a8e929..30149417498 100644 --- a/test/executable/executableTests.ts +++ b/test/executable/executableTests.ts @@ -1,5 +1,5 @@ /* - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/test/formatters/checkstyleFormatterTests.ts b/test/formatters/checkstyleFormatterTests.ts index ac9625a603d..52fccea52de 100644 --- a/test/formatters/checkstyleFormatterTests.ts +++ b/test/formatters/checkstyleFormatterTests.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/test/formatters/junitFormatterTests.ts b/test/formatters/junitFormatterTests.ts index ee80755cd7c..4f1bc6c4a71 100644 --- a/test/formatters/junitFormatterTests.ts +++ b/test/formatters/junitFormatterTests.ts @@ -1,6 +1,6 @@ /** * @license - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/test/rule-tester/linesTests.ts b/test/rule-tester/linesTests.ts index 24ed99dec6b..3ba29992ef6 100644 --- a/test/rule-tester/linesTests.ts +++ b/test/rule-tester/linesTests.ts @@ -1,5 +1,5 @@ /* - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/test/rule-tester/parseTests.ts b/test/rule-tester/parseTests.ts index 6a353fafc39..99142d8404a 100644 --- a/test/rule-tester/parseTests.ts +++ b/test/rule-tester/parseTests.ts @@ -1,5 +1,5 @@ /* - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/test/rule-tester/testData.ts b/test/rule-tester/testData.ts index dc0fd1805de..57da9c732a2 100644 --- a/test/rule-tester/testData.ts +++ b/test/rule-tester/testData.ts @@ -1,5 +1,5 @@ /* - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/test/ruleTestRunner.ts b/test/ruleTestRunner.ts index 3223b863fb4..1429fd39fcf 100644 --- a/test/ruleTestRunner.ts +++ b/test/ruleTestRunner.ts @@ -1,5 +1,5 @@ /* - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/test/utilsTests.ts b/test/utilsTests.ts index e1ce48f1b89..a1023b07f7b 100644 --- a/test/utilsTests.ts +++ b/test/utilsTests.ts @@ -1,5 +1,5 @@ /* - * Copyright 2016 Palantir Technologies, Inc. + * Copyright 2018 Palantir Technologies, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. From 555825146890b6ad327f8a711bb6617ec6007bcc Mon Sep 17 00:00:00 2001 From: Simon Marchi Date: Tue, 11 Dec 2018 18:06:52 -0500 Subject: [PATCH 03/60] [no-void-expression] Allow void expressions in binary expressions (#4323) The no-void-expression rule currently warns in this case: x && console.log(x); I think this can be accepted, since it's a common way to make a compact "if". Same with the ignore-arrow-function-shorthand option, tslint currently warns for: [].forEach(x => x && console.log(x)) This patch changes the rule to accept these. Fixes #4297 Fixes #2919 --- src/rules/noVoidExpressionRule.ts | 4 ++++ test/rules/no-void-expression/default/test.ts.lint | 6 ++++++ .../ignore-arrow-function-shorthand/test.ts.lint | 2 ++ 3 files changed, 12 insertions(+) diff --git a/src/rules/noVoidExpressionRule.ts b/src/rules/noVoidExpressionRule.ts index 873d65e560a..6d851ffc912 100644 --- a/src/rules/noVoidExpressionRule.ts +++ b/src/rules/noVoidExpressionRule.ts @@ -99,6 +99,10 @@ function walk(ctx: Lint.WalkContext, checker: ts.TypeChecker): void { return true; case ts.SyntaxKind.ArrowFunction: return ignoreArrowFunctionShorthand; + + // Something like "x && console.log(x)". + case ts.SyntaxKind.BinaryExpression: + return isParentAllowedVoid(node.parent!); default: return false; } diff --git a/test/rules/no-void-expression/default/test.ts.lint b/test/rules/no-void-expression/default/test.ts.lint index 2d7108b65cd..663fe260c75 100644 --- a/test/rules/no-void-expression/default/test.ts.lint +++ b/test/rules/no-void-expression/default/test.ts.lint @@ -5,6 +5,9 @@ function print(strs) {} [].forEach(x => console.log(x)); ~~~~~~~~~~~~~~ [0] +[].forEach(x => x && console.log(x)); + ~~~~~~~~~~~~~~ [0] + async function f(): Promise { const x = doIt(); ~~~~~~ [0] @@ -14,6 +17,9 @@ async function f(): Promise { ~~~~~~~ [0] } +true && console.log(0); +false || console.log(0); + declare function doIt(): void; declare function doAsync(): Promise; declare function print(strs: TemplateStringsArray): void; diff --git a/test/rules/no-void-expression/ignore-arrow-function-shorthand/test.ts.lint b/test/rules/no-void-expression/ignore-arrow-function-shorthand/test.ts.lint index 6a27252c7d4..023f1861947 100644 --- a/test/rules/no-void-expression/ignore-arrow-function-shorthand/test.ts.lint +++ b/test/rules/no-void-expression/ignore-arrow-function-shorthand/test.ts.lint @@ -1,4 +1,6 @@ [].forEach(x => console.log(x)); +[].forEach(x => x && console.log(x)); +[].forEach(x => !x || console.log(x)); [].forEach(x => { return console.log(x); From 2729aaca74bccbfebe3f2df5e64ea533800c72ce Mon Sep 17 00:00:00 2001 From: Bowen Ni Date: Tue, 11 Dec 2018 15:10:07 -0800 Subject: [PATCH 04/60] Changes the node version from 4 to 6 for TS 2.1 tests. (#4282) Node 4 is no longer supported. Unblocks https://github.com/palantir/tslint/pull/4274 --- .circleci/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index b15baf9768e..39f28497765 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -43,7 +43,7 @@ jobs: - run: yarn test test2.1: docker: - - image: circleci/node:4 + - image: circleci/node:6 steps: - checkout - attach_workspace: From a21ba7da378b5e0d7b77af4267ebe12275ad9e5d Mon Sep 17 00:00:00 2001 From: ulrichb Date: Wed, 12 Dec 2018 02:01:55 +0100 Subject: [PATCH 05/60] Add exception for generators in "return-undefined" rule (#4370) * Add exception for generators in "return-undefined" rule * Fix linter error --- src/rules/returnUndefinedRule.ts | 5 +++++ test/rules/return-undefined/test.ts.lint | 14 ++++++++++++++ 2 files changed, 19 insertions(+) diff --git a/src/rules/returnUndefinedRule.ts b/src/rules/returnUndefinedRule.ts index c02bbbcbf97..315cc50f00e 100644 --- a/src/rules/returnUndefinedRule.ts +++ b/src/rules/returnUndefinedRule.ts @@ -117,6 +117,11 @@ function getReturnKind(node: FunctionLike, checker: ts.TypeChecker): ReturnKind return ReturnKind.Value; } + // Handle generator functions/methods: + if (node.asteriskToken !== undefined) { + return ReturnKind.Void; + } + const contextual = isFunctionExpressionLike(node) && node.type === undefined ? tryGetReturnType(checker.getContextualType(node), checker) diff --git a/test/rules/return-undefined/test.ts.lint b/test/rules/return-undefined/test.ts.lint index a14f014baf3..b646595ecab 100644 --- a/test/rules/return-undefined/test.ts.lint +++ b/test/rules/return-undefined/test.ts.lint @@ -78,5 +78,19 @@ test(async () => { ~~~~~~~~~~~~~~~~~ [VOID] }); + +function * generator(returnNothing: boolean) { + if (returnNothing) return; + yield 1; + return yield * [2, 3]; +} + +class ClassWithGeneratorMethod { + * generatorMethod(returnNothing: boolean) { + if (returnNothing) return; + yield 1; + } +} + [VOID]: `void` function should use `return;`, not `return undefined;`. [UNDEFINED]: Value-returning function should use `return undefined;`, not just `return;`. From 99e8605e21b83864214dc6376bf2b128439fe643 Mon Sep 17 00:00:00 2001 From: ulrichb Date: Wed, 12 Dec 2018 03:04:06 +0100 Subject: [PATCH 06/60] Update 'json-stringify-pretty-compact' to 1.2.0 and remove unnecessary type declaration (#4371) * Update 'json-stringify-pretty-compact' to 1.2.0 and remove unnecessary type declaration The typings are now included in the package (see https://github.com/lydell/json-stringify-pretty-compact/pull/16). This fixes "node_modules/json-stringify-pretty-compact/index.d.ts:7:12 - error TS2300: Duplicate identifier 'stringify'" compile errors. * Update yarn.lock --- package.json | 2 +- scripts/custom-typings.d.ts | 4 ---- yarn.lock | 8 ++++---- 3 files changed, 5 insertions(+), 9 deletions(-) delete mode 100644 scripts/custom-typings.d.ts diff --git a/package.json b/package.json index 65b29cf2f81..485ac2b8a0b 100644 --- a/package.json +++ b/package.json @@ -72,7 +72,7 @@ "chai": "^3.5.0", "github": "^8.2.1", "husky": "^0.14.3", - "json-stringify-pretty-compact": "^1.0.3", + "json-stringify-pretty-compact": "^1.2.0", "mocha": "^3.2.0", "npm-run-all": "^4.0.2", "nyc": "^10.2.0", diff --git a/scripts/custom-typings.d.ts b/scripts/custom-typings.d.ts deleted file mode 100644 index 65044950213..00000000000 --- a/scripts/custom-typings.d.ts +++ /dev/null @@ -1,4 +0,0 @@ -declare module "json-stringify-pretty-compact" { - function stringify(x: any): string; - export = stringify; -} diff --git a/yarn.lock b/yarn.lock index 22dcf39145a..6f4d8aa965e 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1075,10 +1075,10 @@ jsesc@^1.3.0: resolved "https://registry.yarnpkg.com/jsesc/-/jsesc-1.3.0.tgz#46c3fec8c1892b12b0833db9bc7622176dbab34b" integrity sha1-RsP+yMGJKxKwgz25vHYiF226s0s= -json-stringify-pretty-compact@^1.0.3: - version "1.0.4" - resolved "https://registry.yarnpkg.com/json-stringify-pretty-compact/-/json-stringify-pretty-compact-1.0.4.tgz#d5161131be27fd9748391360597fcca250c6c5ce" - integrity sha1-1RYRMb4n/ZdIORNgWX/MolDGxc4= +json-stringify-pretty-compact@^1.2.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/json-stringify-pretty-compact/-/json-stringify-pretty-compact-1.2.0.tgz#0bc316b5e6831c07041fc35612487fb4e9ab98b8" + integrity sha512-/11Pj1OyX814QMKO7K8l85SHPTr/KsFxHp8GE2zVa0BtJgGimDjXHfM3FhC7keQdWDea7+nXf+f1de7ATZcZkQ== json3@3.3.2: version "3.3.2" From 029854219ff083060c3aecca2c8abb3be62194af Mon Sep 17 00:00:00 2001 From: Eric Anderson Date: Wed, 12 Dec 2018 10:02:44 -0500 Subject: [PATCH 07/60] Use latest docs deps to avoid vulnerable libs (#4366) --- docs/Gemfile.lock | 214 ++++++++++++++++++++++++---------------------- 1 file changed, 112 insertions(+), 102 deletions(-) diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index 3eaa6478c32..de7c3788f57 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -1,7 +1,7 @@ GEM remote: https://rubygems.org/ specs: - activesupport (4.2.9) + activesupport (4.2.10) i18n (~> 0.7) minitest (~> 5.1) thread_safe (~> 0.3, >= 0.3.4) @@ -13,106 +13,115 @@ GEM execjs coffee-script-source (1.11.1) colorator (1.1.0) - commonmarker (0.17.7.1) + commonmarker (0.17.13) ruby-enum (~> 0.5) - concurrent-ruby (1.0.5) + concurrent-ruby (1.1.3) + dnsruby (1.61.2) + addressable (~> 2.5) + em-websocket (0.5.1) + eventmachine (>= 0.12.9) + http_parser.rb (~> 0.6.0) ethon (0.11.0) ffi (>= 1.3.0) + eventmachine (1.2.7) execjs (2.7.0) - faraday (0.13.1) + faraday (0.15.4) multipart-post (>= 1.2, < 3) - ffi (1.9.18) + ffi (1.9.25) forwardable-extended (2.6.0) gemoji (3.0.0) - github-pages (172) - activesupport (= 4.2.9) - github-pages-health-check (= 1.3.5) - jekyll (= 3.6.2) - jekyll-avatar (= 0.5.0) - jekyll-coffeescript (= 1.0.2) - jekyll-commonmark-ghpages (= 0.1.3) + github-pages (193) + activesupport (= 4.2.10) + github-pages-health-check (= 1.8.1) + jekyll (= 3.7.4) + jekyll-avatar (= 0.6.0) + jekyll-coffeescript (= 1.1.1) + jekyll-commonmark-ghpages (= 0.1.5) jekyll-default-layout (= 0.1.4) - jekyll-feed (= 0.9.2) - jekyll-gist (= 1.4.1) - jekyll-github-metadata (= 2.9.3) - jekyll-mentions (= 1.2.0) + jekyll-feed (= 0.11.0) + jekyll-gist (= 1.5.0) + jekyll-github-metadata (= 2.9.4) + jekyll-mentions (= 1.4.1) jekyll-optional-front-matter (= 0.3.0) jekyll-paginate (= 1.1.0) jekyll-readme-index (= 0.2.0) - jekyll-redirect-from (= 0.12.1) - jekyll-relative-links (= 0.5.2) - jekyll-remote-theme (= 0.2.3) - jekyll-sass-converter (= 1.5.0) - jekyll-seo-tag (= 2.3.0) - jekyll-sitemap (= 1.1.1) + jekyll-redirect-from (= 0.14.0) + jekyll-relative-links (= 0.5.3) + jekyll-remote-theme (= 0.3.1) + jekyll-sass-converter (= 1.5.2) + jekyll-seo-tag (= 2.5.0) + jekyll-sitemap (= 1.2.0) jekyll-swiss (= 0.4.0) - jekyll-theme-architect (= 0.1.0) - jekyll-theme-cayman (= 0.1.0) - jekyll-theme-dinky (= 0.1.0) - jekyll-theme-hacker (= 0.1.0) - jekyll-theme-leap-day (= 0.1.0) - jekyll-theme-merlot (= 0.1.0) - jekyll-theme-midnight (= 0.1.0) - jekyll-theme-minimal (= 0.1.0) - jekyll-theme-modernist (= 0.1.0) - jekyll-theme-primer (= 0.5.2) - jekyll-theme-slate (= 0.1.0) - jekyll-theme-tactile (= 0.1.0) - jekyll-theme-time-machine (= 0.1.0) - jekyll-titles-from-headings (= 0.5.0) - jemoji (= 0.8.1) - kramdown (= 1.14.0) + jekyll-theme-architect (= 0.1.1) + jekyll-theme-cayman (= 0.1.1) + jekyll-theme-dinky (= 0.1.1) + jekyll-theme-hacker (= 0.1.1) + jekyll-theme-leap-day (= 0.1.1) + jekyll-theme-merlot (= 0.1.1) + jekyll-theme-midnight (= 0.1.1) + jekyll-theme-minimal (= 0.1.1) + jekyll-theme-modernist (= 0.1.1) + jekyll-theme-primer (= 0.5.3) + jekyll-theme-slate (= 0.1.1) + jekyll-theme-tactile (= 0.1.1) + jekyll-theme-time-machine (= 0.1.1) + jekyll-titles-from-headings (= 0.5.1) + jemoji (= 0.10.1) + kramdown (= 1.17.0) liquid (= 4.0.0) - listen (= 3.0.6) + listen (= 3.1.5) mercenary (~> 0.3) - minima (= 2.1.1) + minima (= 2.5.0) + nokogiri (>= 1.8.2, < 2.0) rouge (= 2.2.1) terminal-table (~> 1.4) - github-pages-health-check (1.3.5) + github-pages-health-check (1.8.1) addressable (~> 2.3) - net-dns (~> 0.8) + dnsruby (~> 1.60) octokit (~> 4.0) public_suffix (~> 2.0) - typhoeus (~> 0.7) - html-pipeline (2.7.1) + typhoeus (~> 1.3) + html-pipeline (2.9.1) activesupport (>= 2) nokogiri (>= 1.4) - i18n (0.9.1) + http_parser.rb (0.6.0) + i18n (0.9.5) concurrent-ruby (~> 1.0) - jekyll (3.6.2) + jekyll (3.7.4) addressable (~> 2.4) colorator (~> 1.0) + em-websocket (~> 0.5) + i18n (~> 0.7) jekyll-sass-converter (~> 1.0) - jekyll-watch (~> 1.1) + jekyll-watch (~> 2.0) kramdown (~> 1.14) liquid (~> 4.0) mercenary (~> 0.3.3) pathutil (~> 0.9) - rouge (>= 1.7, < 3) + rouge (>= 1.7, < 4) safe_yaml (~> 1.0) - jekyll-avatar (0.5.0) + jekyll-avatar (0.6.0) jekyll (~> 3.0) - jekyll-coffeescript (1.0.2) + jekyll-coffeescript (1.1.1) coffee-script (~> 2.2) coffee-script-source (~> 1.11.1) - jekyll-commonmark (1.1.0) + jekyll-commonmark (1.2.0) commonmarker (~> 0.14) jekyll (>= 3.0, < 4.0) - jekyll-commonmark-ghpages (0.1.3) + jekyll-commonmark-ghpages (0.1.5) commonmarker (~> 0.17.6) jekyll-commonmark (~> 1) rouge (~> 2) jekyll-default-layout (0.1.4) jekyll (~> 3.0) - jekyll-feed (0.9.2) + jekyll-feed (0.11.0) jekyll (~> 3.3) - jekyll-gist (1.4.1) + jekyll-gist (1.5.0) octokit (~> 4.2) - jekyll-github-metadata (2.9.3) + jekyll-github-metadata (2.9.4) jekyll (~> 3.1) octokit (~> 4.0, != 4.4.0) - jekyll-mentions (1.2.0) - activesupport (~> 4.0) + jekyll-mentions (1.4.1) html-pipeline (~> 2.3) jekyll (~> 3.0) jekyll-optional-front-matter (0.3.0) @@ -120,98 +129,99 @@ GEM jekyll-paginate (1.1.0) jekyll-readme-index (0.2.0) jekyll (~> 3.0) - jekyll-redirect-from (0.12.1) + jekyll-redirect-from (0.14.0) jekyll (~> 3.3) - jekyll-relative-links (0.5.2) + jekyll-relative-links (0.5.3) jekyll (~> 3.3) - jekyll-remote-theme (0.2.3) + jekyll-remote-theme (0.3.1) jekyll (~> 3.5) rubyzip (>= 1.2.1, < 3.0) - typhoeus (>= 0.7, < 2.0) - jekyll-sass-converter (1.5.0) + jekyll-sass-converter (1.5.2) sass (~> 3.4) - jekyll-seo-tag (2.3.0) + jekyll-seo-tag (2.5.0) jekyll (~> 3.3) - jekyll-sitemap (1.1.1) + jekyll-sitemap (1.2.0) jekyll (~> 3.3) jekyll-swiss (0.4.0) - jekyll-theme-architect (0.1.0) + jekyll-theme-architect (0.1.1) jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-cayman (0.1.0) + jekyll-theme-cayman (0.1.1) jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-dinky (0.1.0) + jekyll-theme-dinky (0.1.1) jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-hacker (0.1.0) + jekyll-theme-hacker (0.1.1) jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-leap-day (0.1.0) + jekyll-theme-leap-day (0.1.1) jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-merlot (0.1.0) + jekyll-theme-merlot (0.1.1) jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-midnight (0.1.0) + jekyll-theme-midnight (0.1.1) jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-minimal (0.1.0) + jekyll-theme-minimal (0.1.1) jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-modernist (0.1.0) + jekyll-theme-modernist (0.1.1) jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-primer (0.5.2) + jekyll-theme-primer (0.5.3) jekyll (~> 3.5) jekyll-github-metadata (~> 2.9) - jekyll-seo-tag (~> 2.2) - jekyll-theme-slate (0.1.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-slate (0.1.1) jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-tactile (0.1.0) + jekyll-theme-tactile (0.1.1) jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-theme-time-machine (0.1.0) + jekyll-theme-time-machine (0.1.1) jekyll (~> 3.5) jekyll-seo-tag (~> 2.0) - jekyll-titles-from-headings (0.5.0) + jekyll-titles-from-headings (0.5.1) jekyll (~> 3.3) - jekyll-watch (1.5.1) + jekyll-watch (2.1.2) listen (~> 3.0) - jemoji (0.8.1) - activesupport (~> 4.0, >= 4.2.9) + jemoji (0.10.1) gemoji (~> 3.0) html-pipeline (~> 2.2) - jekyll (>= 3.0) - kramdown (1.14.0) + jekyll (~> 3.0) + kramdown (1.17.0) liquid (4.0.0) - listen (3.0.6) - rb-fsevent (>= 0.9.3) - rb-inotify (>= 0.9.7) + listen (3.1.5) + rb-fsevent (~> 0.9, >= 0.9.4) + rb-inotify (~> 0.9, >= 0.9.7) + ruby_dep (~> 1.2) mercenary (0.3.6) mini_portile2 (2.3.0) - minima (2.1.1) - jekyll (~> 3.3) - minitest (5.10.3) + minima (2.5.0) + jekyll (~> 3.5) + jekyll-feed (~> 0.9) + jekyll-seo-tag (~> 2.1) + minitest (5.11.3) multipart-post (2.0.0) - net-dns (0.8.0) - nokogiri (1.8.1) + nokogiri (1.8.5) mini_portile2 (~> 2.3.0) - octokit (4.8.0) + octokit (4.13.0) sawyer (~> 0.8.0, >= 0.5.3) - pathutil (0.16.1) + pathutil (0.16.2) forwardable-extended (~> 2.6) public_suffix (2.0.5) - rb-fsevent (0.10.2) + rb-fsevent (0.10.3) rb-inotify (0.9.10) ffi (>= 0.5.0, < 2) rouge (2.2.1) - ruby-enum (0.7.1) + ruby-enum (0.7.2) i18n - rubyzip (1.2.1) + ruby_dep (1.5.0) + rubyzip (1.2.2) safe_yaml (1.0.4) - sass (3.5.4) + sass (3.7.2) sass-listen (~> 4.0.0) sass-listen (4.0.0) rb-fsevent (~> 0.9, >= 0.9.4) @@ -222,11 +232,11 @@ GEM terminal-table (1.8.0) unicode-display_width (~> 1.1, >= 1.1.1) thread_safe (0.3.6) - typhoeus (0.8.0) - ethon (>= 0.8.0) - tzinfo (1.2.4) + typhoeus (1.3.1) + ethon (>= 0.9.0) + tzinfo (1.2.5) thread_safe (~> 0.1) - unicode-display_width (1.3.0) + unicode-display_width (1.4.0) PLATFORMS ruby From cd5d7d08563e55dd403d3a235d16fd56390a0208 Mon Sep 17 00:00:00 2001 From: Marvin Altemeier Date: Wed, 12 Dec 2018 16:07:28 +0100 Subject: [PATCH 08/60] Improve JUnit formatter (#4327) Fix documentation --- src/formatters/junitFormatter.ts | 13 ++++++++----- test/formatters/junitFormatterTests.ts | 25 ++++++++++++------------- 2 files changed, 20 insertions(+), 18 deletions(-) diff --git a/src/formatters/junitFormatter.ts b/src/formatters/junitFormatter.ts index a0ee610205e..7035b2fd945 100644 --- a/src/formatters/junitFormatter.ts +++ b/src/formatters/junitFormatter.ts @@ -32,8 +32,8 @@ export class Formatter extends AbstractFormatter { - - Missing semicolon + + Missing semicolon Line 1, Column 14 @@ -64,9 +64,12 @@ export class Formatter extends AbstractFormatter { output += ``; } - output += ``; - output += `${message}`; + output += ``; + output += `${message} `; + output += `Line ${lineAndCharacter.line + 1}, `; + output += `Column ${lineAndCharacter.character + 1}`; + output += ``; output += ""; } if (previousFilename !== null) { diff --git a/test/formatters/junitFormatterTests.ts b/test/formatters/junitFormatterTests.ts index 4f1bc6c4a71..04bbcdfe63a 100644 --- a/test/formatters/junitFormatterTests.ts +++ b/test/formatters/junitFormatterTests.ts @@ -79,29 +79,28 @@ describe("JUnit Formatter", () => { "warning", ), ]; - const expectedResult = ` - - first failure + + first failure Line 1, Column 1 - - &<>'" should be escaped + + &<>'" should be escaped Line 1, Column 3 - - last failure + + last failure Line 6, Column 3 - - first failure + + first failure Line 1, Column 1 - - &<>'" should be escaped + + &<>'" should be escaped Line 1, Column 3 - - last failure + + last failure Line 6, Column 3 `.replace(/>\s+/g, ">"); // Remove whitespace between tags; From 6fe8723ca2609454dd0bdd54bab8bc2c4ce946c7 Mon Sep 17 00:00:00 2001 From: Ifiok Jr Date: Wed, 12 Dec 2018 15:17:31 +0000 Subject: [PATCH 09/60] feat: allow whitelisted modules to start with `@` symbol (#4192) - tests added for no-implicit-dependencies @ symbols --- src/rules/noImplicitDependenciesRule.ts | 11 ++++++++--- .../no-implicit-dependencies/whitelist/test.ts.lint | 10 ++++++++++ .../no-implicit-dependencies/whitelist/tslint.json | 6 +++--- 3 files changed, 21 insertions(+), 6 deletions(-) diff --git a/src/rules/noImplicitDependenciesRule.ts b/src/rules/noImplicitDependenciesRule.ts index a1d8024f07f..681f910365f 100644 --- a/src/rules/noImplicitDependenciesRule.ts +++ b/src/rules/noImplicitDependenciesRule.ts @@ -91,7 +91,7 @@ function walk(ctx: Lint.WalkContext) { const whitelist = new Set(options.whitelist); for (const name of findImports(ctx.sourceFile, ImportKind.All)) { if (!ts.isExternalModuleNameRelative(name.text)) { - const packageName = getPackageName(name.text); + const packageName = getPackageName(name.text, whitelist); if ( !whitelist.has(packageName) && builtins.indexOf(packageName) === -1 && @@ -110,11 +110,16 @@ function walk(ctx: Lint.WalkContext) { } } -function getPackageName(name: string): string { +function getPackageName(name: string, whitelist: Set): string { const parts = name.split(/\//g); - if (name[0] !== "@") { + if (name[0] !== "@" || whitelist.has(parts[0])) { return parts[0]; } + + if (whitelist.has(name)) { + return name; + } + return `${parts[0]}/${parts[1]}`; } diff --git a/test/rules/no-implicit-dependencies/whitelist/test.ts.lint b/test/rules/no-implicit-dependencies/whitelist/test.ts.lint index 64c8000afb0..efc3c279f19 100644 --- a/test/rules/no-implicit-dependencies/whitelist/test.ts.lint +++ b/test/rules/no-implicit-dependencies/whitelist/test.ts.lint @@ -2,9 +2,19 @@ import * as ts from 'typescript'; import * from 'src/a'; +import * from '@components/a'; + +import * from '@com/fixer'; + import * from 'app/b'; import * from 'notapp/c'; ~~~~~~~~~~ [err % ('notapp')] +import * from '@notapp/c'; + ~~~~~~~~~~~ [err % ('@notapp/c')] + +import * from '@com/c'; + ~~~~~~~~ [err % ('@com/c')] + [err]: Module '%s' is not listed as dependency in package.json diff --git a/test/rules/no-implicit-dependencies/whitelist/tslint.json b/test/rules/no-implicit-dependencies/whitelist/tslint.json index 4bf72fd75e7..98121cf053c 100644 --- a/test/rules/no-implicit-dependencies/whitelist/tslint.json +++ b/test/rules/no-implicit-dependencies/whitelist/tslint.json @@ -1,5 +1,5 @@ { - "rules": { - "no-implicit-dependencies": [true, ["src", "app"]] - } + "rules": { + "no-implicit-dependencies": [true, ["src", "app", "@components", "@com/fixer"]] + } } From 70ca047ebf1eac094bdb55a6500347670587103f Mon Sep 17 00:00:00 2001 From: Daniel Reichhart <34721312+danielreichhart@users.noreply.github.com> Date: Wed, 12 Dec 2018 16:18:46 +0100 Subject: [PATCH 10/60] Added badges for dependencies status (#4160) --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index cdc4f0340d2..65dc989e2cc 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ [![NPM version](https://badge.fury.io/js/tslint.svg)](http://badge.fury.io/js/tslint) [![Downloads](http://img.shields.io/npm/dm/tslint.svg)](https://npmjs.org/package/tslint) +[![Dependency Status](https://david-dm.org/palantir/tslint.svg)](https://david-dm.org/palantir/tslint) +[![devDependency Status](https://david-dm.org/palantir/tslint/dev-status.svg)](https://david-dm.org/palantir/tslint/?type=dev) +[![peerDependency Status](https://david-dm.org/palantir/tslint/peer-status.svg)](https://david-dm.org/palantir/tslint/?type=peer) [![Circle CI](https://circleci.com/gh/palantir/tslint.svg?style=svg)](https://circleci.com/gh/palantir/tslint) # TSLint From b9fba261e42fd8cde16d6a821b6aa4ff42627108 Mon Sep 17 00:00:00 2001 From: Andrew MacLeay Date: Wed, 12 Dec 2018 11:06:33 -0500 Subject: [PATCH 11/60] no-invalid-this: false positive for method syntax (#4034) * no-invalid-this: false positive for method syntax * Keep track of evaluation context: look to the closest parent function and decide if it is allowed to refer to `this` * Fix a false negative in the tests from #3267 * no-invalid-this: stylistic cleanup --- src/rules/noInvalidThisRule.ts | 58 +++++++++++++------ .../no-invalid-this/enabled/test.ts.lint | 40 +++++++++++++ 2 files changed, 80 insertions(+), 18 deletions(-) diff --git a/src/rules/noInvalidThisRule.ts b/src/rules/noInvalidThisRule.ts index 4b3b5b7734d..c4a4d8dfe24 100644 --- a/src/rules/noInvalidThisRule.ts +++ b/src/rules/noInvalidThisRule.ts @@ -61,41 +61,63 @@ export class Rule extends Lint.Rules.AbstractRule { } } +const enum parentType { + None, + Class, + ClassMethod, + BoundRegularFunction, + UnboundRegularFunction, +} +const thisAllowedParents = new Set([parentType.ClassMethod, parentType.BoundRegularFunction]); + function walk(ctx: Lint.WalkContext): void { const { sourceFile, options: checkFuncInMethod } = ctx; + + let currentParent: parentType = parentType.None; let inClass = false; - let inFunctionInClass = false; ts.forEachChild(sourceFile, function cb(node: ts.Node) { + const originalParent = currentParent; + const originalInClass = inClass; switch (node.kind) { case ts.SyntaxKind.ClassDeclaration: case ts.SyntaxKind.ClassExpression: - if (!inClass) { - inClass = true; - ts.forEachChild(node, cb); - inClass = false; - return; - } - break; + inClass = true; + currentParent = parentType.Class; + ts.forEachChild(node, cb); + currentParent = originalParent; + inClass = originalInClass; + return; + case ts.SyntaxKind.MethodDeclaration: + case ts.SyntaxKind.GetAccessor: + case ts.SyntaxKind.SetAccessor: + case ts.SyntaxKind.Constructor: + case ts.SyntaxKind.PropertyDeclaration: case ts.SyntaxKind.FunctionDeclaration: case ts.SyntaxKind.FunctionExpression: - if ((node as ts.FunctionLikeDeclaration).parameters.some(isThisParameter)) { + if (currentParent === parentType.Class) { + currentParent = parentType.ClassMethod; + ts.forEachChild(node, cb); + currentParent = originalParent; return; - } - if (inClass) { - inFunctionInClass = true; + } else { + currentParent + = (node as ts.FunctionLikeDeclaration).parameters.some(isThisParameter) + ? parentType.BoundRegularFunction + : parentType.UnboundRegularFunction; ts.forEachChild(node, cb); - inFunctionInClass = false; + currentParent = originalParent; return; } - break; case ts.SyntaxKind.ThisKeyword: - if (!inClass) { - ctx.addFailureAtNode(node, Rule.FAILURE_STRING_OUTSIDE); - } else if (checkFuncInMethod && inFunctionInClass) { - ctx.addFailureAtNode(node, Rule.FAILURE_STRING_INSIDE); + if (!thisAllowedParents.has(currentParent)) { + if (!inClass) { + ctx.addFailureAtNode(node, Rule.FAILURE_STRING_OUTSIDE); + } else if (checkFuncInMethod) { + ctx.addFailureAtNode(node, Rule.FAILURE_STRING_INSIDE); + } } return; } diff --git a/test/rules/no-invalid-this/enabled/test.ts.lint b/test/rules/no-invalid-this/enabled/test.ts.lint index 166d8cc074e..47f50f57aa2 100644 --- a/test/rules/no-invalid-this/enabled/test.ts.lint +++ b/test/rules/no-invalid-this/enabled/test.ts.lint @@ -1,3 +1,23 @@ +function setSomeProperty(this: { someProperty: number }) { + this.someProperty = 7; +} + +function bindProperty(this: { someProperty: number }, fn: Function) { + return fn.bind(this); +} + +const objectLiteralStyle = { + bindProperty: function(this: { someProperty: number }, fn: Function) { + return fn.bind(this); + }, +}; + +const objectMethodStyle = { + bindProperty(this: { someProperty: number }, fn: Function) { + return fn.bind(this); + }, +}; + export function f(this: Observable): Observable { const nestedFunction = function(this) => { console.log(this) @@ -10,6 +30,7 @@ class ContextualThisClass { let nestedFunction: (this: number[]) => number[] = function(this) { [3,4].forEach(function(nr){ console.log(this); + ~~~~ [the "this" keyword is disallowed in function bodies inside class methods, use arrow functions instead] }); return this.map(i=>i); }; @@ -67,6 +88,25 @@ class AClass { [3,4].forEach(badFunction); let badFunction = nr => console.log(this.x === nr); } + + public fMethod() { + const objectLiteralStyle = { + bindProperty: function(this: { someProperty: number }, fn: Function) { + return fn.bind(this); + }, + }; + + const objectMethodStyle = { + bindProperty(this: { someProperty: number }, fn: Function) { + return fn.bind(this); + }, + }; + + return { + objectLiteralStyle, + objectMethodStyle, + }; + } } const AClassExpression = class { From cf35ec8d3e6003e8900179b9f194852e3f1e687c Mon Sep 17 00:00:00 2001 From: Pavel Birukov Date: Wed, 12 Dec 2018 17:13:49 +0100 Subject: [PATCH 12/60] [new-rule] no-default-import (#4023) * Implement 'no-default-import' rule * Improve wording in rationale --- src/configs/all.ts | 1 + src/rules/noDefaultImportRule.ts | 130 ++++++++++++++++++ .../no-default-import/default/test.ts.lint | 36 +++++ .../no-default-import/default/tslint.json | 5 + .../fromModules/test.ts.lint | 24 ++++ .../no-default-import/fromModules/tslint.json | 10 ++ 6 files changed, 206 insertions(+) create mode 100644 src/rules/noDefaultImportRule.ts create mode 100644 test/rules/no-default-import/default/test.ts.lint create mode 100644 test/rules/no-default-import/default/tslint.json create mode 100644 test/rules/no-default-import/fromModules/test.ts.lint create mode 100644 test/rules/no-default-import/fromModules/tslint.json diff --git a/src/configs/all.ts b/src/configs/all.ts index f61d9cb6d6a..25079bf1481 100644 --- a/src/configs/all.ts +++ b/src/configs/all.ts @@ -157,6 +157,7 @@ export const rules = { "max-file-line-count": [true, 1000], "max-line-length": [true, 120], "no-default-export": true, + "no-default-import": true, "no-duplicate-imports": true, "no-irregular-whitespace": true, "no-mergeable-namespace": true, diff --git a/src/rules/noDefaultImportRule.ts b/src/rules/noDefaultImportRule.ts new file mode 100644 index 00000000000..f242e60d142 --- /dev/null +++ b/src/rules/noDefaultImportRule.ts @@ -0,0 +1,130 @@ +/** + * @license + * Copyright 2016 Palantir Technologies, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { isImportDeclaration, isNamedImports, isStringLiteral } from "tsutils"; +import * as ts from "typescript"; +import * as Lint from "../index"; + +const fromModulesConfigOptionName = "fromModules"; +interface RawConfigOptions { + [fromModulesConfigOptionName]: string; +} +interface Options { + [fromModulesConfigOptionName]: RegExp; +} + +export class Rule extends Lint.Rules.AbstractRule { + /* tslint:disable:object-literal-sort-keys */ + public static metadata: Lint.IRuleMetadata = { + ruleName: "no-default-import", + description: "Disallows importing default members from certain ES6-style modules.", + descriptionDetails: "Import named members instead.", + rationale: Lint.Utils.dedent` + Named imports/exports [promote clarity](https://github.com/palantir/tslint/issues/1182#issue-151780453). + In addition, current tooling differs on the correct way to handle default imports/exports. + Avoiding them all together can help avoid tooling bugs and conflicts. + + The rule supposed to narrow the scope of your changes in the case of monorepo. + Say, you have packages \`A\`, \`B\`, \`C\` and \`utils\`, where \`A\`, \`B\`, \`C\` dependends on \`utils\`, + which is full of default exports. + \`"no-default-export"\` requires you to remove default _export_ from \`utils\`, which leads to changes + in packages \`A\`, \`B\`, \`C\`. It's harder to get merged bigger changeset by various reasons (harder to get your code approved + due to a number of required reviewers; longer build time due to a number of affected packages) + and could result in ignored \`"no-default-export"\` rule in \`utils'\`. + + Unlike \`"no-default-export"\`, the rule requires you to repalce default _import_ with named only in \`A\` you work on, + and \`utils\` you import from.`, + optionsDescription: "optionsDescription", + options: { + type: "array", + items: { + type: "object", + properties: { + [fromModulesConfigOptionName]: { type: "string" }, + }, + required: [ + "fromModules", + ], + }, + }, + optionExamples: [ + [true, { [fromModulesConfigOptionName]: "^palantir-|^_internal-*|^\\./|^\\.\\./" }], + ], + type: "maintainability", + typescriptOnly: false, + }; + /* tslint:enable:object-literal-sort-keys */ + + public static FAILURE_STRING = "Import of default members from this module is forbidden. Import named member instead"; + + public static getNamedDefaultImport(namedBindings: ts.NamedImports): ts.Identifier | null { + for (const importSpecifier of namedBindings.elements) { + if (importSpecifier.propertyName !== undefined && importSpecifier.propertyName.text === "default") { + return importSpecifier.propertyName; + } + } + return null; + } + + public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] { + return this.applyWithFunction(sourceFile, walk, this.getRuleOptions(this.ruleArguments)); + } + private isFromModulesConfigOption(option: boolean | RawConfigOptions): option is RawConfigOptions { + return typeof option === "object" && option[fromModulesConfigOptionName] !== undefined; + } + private getRuleOptions(options: ReadonlyArray): Options { + const fromModuleConfigOption = options.find(this.isFromModulesConfigOption); + if (fromModuleConfigOption !== undefined && typeof fromModuleConfigOption[fromModulesConfigOptionName] === "string") { + return { + [fromModulesConfigOptionName]: new RegExp(fromModuleConfigOption[fromModulesConfigOptionName]), + }; + } else { + return { + [fromModulesConfigOptionName]: new RegExp("^\\./|^\\.\\./"), + }; + } + } +} + +function walk(ctx: Lint.WalkContext) { + if (ctx.sourceFile.isDeclarationFile || !ts.isExternalModule(ctx.sourceFile)) { + return; + } + for (const statement of ctx.sourceFile.statements) { + if (isImportDeclaration(statement)) { + const { importClause, moduleSpecifier } = statement; + if ( + importClause !== undefined + && isStringLiteral(moduleSpecifier) + && ctx.options[fromModulesConfigOptionName].test(moduleSpecifier.text) + ) { + // module name matches specified in rule config + if (importClause.name !== undefined) { + // `import Foo...` syntax + const defaultImportedName = importClause.name; + ctx.addFailureAtNode(defaultImportedName, Rule.FAILURE_STRING); + } else if (importClause.namedBindings !== undefined && isNamedImports(importClause.namedBindings)) { + // `import { default...` syntax + const defaultMember = Rule.getNamedDefaultImport(importClause.namedBindings); + if (defaultMember !== null) { + ctx.addFailureAtNode(defaultMember, Rule.FAILURE_STRING); + } + } + } + } + } +} diff --git a/test/rules/no-default-import/default/test.ts.lint b/test/rules/no-default-import/default/test.ts.lint new file mode 100644 index 00000000000..399593ed9f6 --- /dev/null +++ b/test/rules/no-default-import/default/test.ts.lint @@ -0,0 +1,36 @@ +import * as Utils from "tslint-utils" + +import TslintUtils from "tslint-utils" + +import Bar, { Foo } from "tslint-misc" + +import Bar, * as Foo from "tslint-misc" + +import { default as Foo } from "tslint-misc" + +import { default as foo, bar } from "tslint-misc" + +import { bar, default as foo } from "tslint-misc" + +import TslintUtils from "../tslint-utils" + ~~~~~~~~~~~ [0] + +import TslintUtils from "./tslint-utils" + ~~~~~~~~~~~ [0] + +import Bar, { Foo } from "../tslint-misc" + ~~~ [0] + +import Bar, * as Foo from "./tslint-misc" + ~~~ [0] + +import { default as Foo } from "../tslint-misc" + ~~~~~~~ [0] + +import { default as foo, bar } from "./tslint-misc" + ~~~~~~~ [0] + +import { bar, default as foo } from "../tslint-misc" + ~~~~~~~ [0] + +[0]: Import of default members from this module is forbidden. Import named member instead diff --git a/test/rules/no-default-import/default/tslint.json b/test/rules/no-default-import/default/tslint.json new file mode 100644 index 00000000000..63855417715 --- /dev/null +++ b/test/rules/no-default-import/default/tslint.json @@ -0,0 +1,5 @@ +{ + "rules": { + "no-default-import": true + } +} diff --git a/test/rules/no-default-import/fromModules/test.ts.lint b/test/rules/no-default-import/fromModules/test.ts.lint new file mode 100644 index 00000000000..2b789830c6e --- /dev/null +++ b/test/rules/no-default-import/fromModules/test.ts.lint @@ -0,0 +1,24 @@ +import * as Utils from "tslint-utils" + +import TslintUtils from "../tslint-utils" + ~~~~~~~~~~~ [0] + +import TslintUtils from "tslint-utils" + ~~~~~~~~~~~ [0] + +import Bar, { Foo } from "tslint-misc" + ~~~ [0] + +import Bar, * as Foo from "tslint-misc" + ~~~ [0] + +import { default as Foo } from "tslint-misc" + ~~~~~~~ [0] + +import { default as foo, bar } from "tslint-misc" + ~~~~~~~ [0] + +import { bar, default as foo } from "tslint-misc" + ~~~~~~~ [0] + +[0]: Import of default members from this module is forbidden. Import named member instead diff --git a/test/rules/no-default-import/fromModules/tslint.json b/test/rules/no-default-import/fromModules/tslint.json new file mode 100644 index 00000000000..1d9bf38d79d --- /dev/null +++ b/test/rules/no-default-import/fromModules/tslint.json @@ -0,0 +1,10 @@ +{ + "rules": { + "no-default-import": [ + true, + { + "fromModules": "^tslint-|^\\./|^\\.\\./" + } + ] + } +} From 09bc89236270b4883bc9734660e838e8343775f0 Mon Sep 17 00:00:00 2001 From: Ethan Date: Wed, 12 Dec 2018 11:32:55 -0500 Subject: [PATCH 13/60] import-blacklist: support banning the import of specific named exports (#3926) * import-blacklist: support banning specific named imports * import-blacklist: small cleanup --- src/rules/importBlacklistRule.ts | 205 +++++++++++++++++++++-- test/rules/import-blacklist/test.ts.lint | 41 ++++- test/rules/import-blacklist/tslint.json | 2 +- 3 files changed, 226 insertions(+), 22 deletions(-) diff --git a/src/rules/importBlacklistRule.ts b/src/rules/importBlacklistRule.ts index 981da1b4d99..dd84a74fe8c 100644 --- a/src/rules/importBlacklistRule.ts +++ b/src/rules/importBlacklistRule.ts @@ -15,7 +15,13 @@ * limitations under the License. */ -import { findImports, ImportKind } from "tsutils"; +import { + findImports, + ImportKind, + isExportDeclaration, + isImportDeclaration, + isNamedImports +} from "tsutils"; import * as ts from "typescript"; import * as Lint from "../index"; @@ -24,25 +30,59 @@ export class Rule extends Lint.Rules.AbstractRule { public static metadata: Lint.IRuleMetadata = { ruleName: "import-blacklist", description: Lint.Utils.dedent` - Disallows importing the specified modules directly via \`import\` and \`require\`. - Instead only sub modules may be imported from that module.`, + Disallows importing the specified modules via \`import\` and \`require\`, + or importing specific named exports of the specified modules.`, rationale: Lint.Utils.dedent` - Some libraries allow importing their submodules instead of the entire module. - This is good practise as it avoids loading unused modules.`, - optionsDescription: "A list of blacklisted modules.", + For some libraries, importing the library directly can cause unused + submodules to be loaded, so you may want to block these imports and + require that users directly import only the submodules they need. + In other cases, you may simply want to ban an import because using + it is undesirable or unsafe.`, + optionsDescription: "A list of blacklisted modules or named imports.", options: { type: "array", items: { - type: "string", - }, - minLength: 1, + oneOf: [ + { + type: "string", + minLength: 1 + }, + { + type: "object", + additionalProperties: { + type: "array", + minItems: 1, + items: { + type: "string", + minLength: 1 + } + } + } + ] + } }, - optionExamples: [true, [true, "rxjs", "lodash"]], + optionExamples: [ + true, + [true, "rxjs", "lodash"], + [true, "lodash", { lodash: ["pull", "pullAll"] }] + ], type: "functionality", - typescriptOnly: false, + typescriptOnly: false }; - public static FAILURE_STRING = "This import is blacklisted, import a submodule instead"; + public static WHOLE_MODULE_FAILURE_STRING = + "Importing this module is blacklisted. Try importing a submodule instead."; + + public static IMPLICIT_NAMED_IMPORT_FAILURE_STRING = + "Some named exports from this module are blacklisted for importing " + + "(or re-exporting). Import/re-export only the specific values you want, " + + "instead of the whole module."; + + public static MAKE_NAMED_IMPORT_FAILURE_STRING(importName: string) { + return importName === "default" + ? "Importing (or re-exporting) the default export is blacklisted." + : `The export "${importName}" is blacklisted.`; + } public isEnabled(): boolean { return super.isEnabled() && this.ruleArguments.length > 0; @@ -53,10 +93,145 @@ export class Rule extends Lint.Rules.AbstractRule { } } -function walk(ctx: Lint.WalkContext) { +type Options = Array; + +function walk(ctx: Lint.WalkContext) { + interface BannedImports { + [moduleName: string]: true | Set; + } + + // Merge/normalize options. + // E.g., ["a", { "b": ["c"], "d": ["e", "e"] }, "f", { "f": ["g"] }] + // becomes { "a": true, "b": Set(["c"]), "d": Set(["e"]), "f": true }. + const bannedImports = ctx.options.reduce( + (acc, it) => { + if (typeof it === "string") { + acc[it] = true; + } else { + Object.keys(it).forEach(moduleName => { + if (acc[moduleName] instanceof Set) { + it[moduleName].forEach(bannedImport => { + (acc[moduleName] as Set).add(bannedImport); + }); + } else if (acc[moduleName] !== true) { + acc[moduleName] = new Set(it[moduleName]); + } + }); + } + return acc; + }, + Object.create(null) as BannedImports + ); + for (const name of findImports(ctx.sourceFile, ImportKind.All)) { - if (ctx.options.indexOf(name.text) !== -1) { - ctx.addFailure(name.getStart(ctx.sourceFile) + 1, name.end - 1, Rule.FAILURE_STRING); + // TODO #3963: Resolve/normalize relative file imports to a canonical path? + const importedModule = name.text; + const bansForModule = bannedImports[importedModule]; + + // Check if at least some imports from this module are banned. + if (bansForModule !== undefined) { + // If importing this module is totally banned, we can error now, + // without determining whether the user is importing the whole + // module or named exports. + if (bansForModule === true) { + ctx.addFailure( + name.getStart(ctx.sourceFile) + 1, + name.end - 1, + Rule.WHOLE_MODULE_FAILURE_STRING + ); + continue; + } + + // Otherwise, find the named imports, if any, and fail if the + // user tried to import any of them. We don't have named imports + // when the user is importing the whole module, which includes: + // + // - ImportKind.Require (i.e., `require('module-specifier')`), + // - ImportKind.DynamicImport (i.e., `import("module-specifier")`), + // - ImportKind.ImportEquals (i.e., `import x = require()`), + // - and ImportKind.ImportDeclaration, where there's a full namespace + // import (i.e. `import * as x from "module-specifier"`) + // + // However, namedImports will be an array when we have one of the + // various permutations of `import x, { a, b as c } from "y"`. + // + // We treat re-exports from other modules the same as attempting to + // import the re-exported binding(s), as the re-export is essentially + // an import followed by an export, and not treating these as an + // import would allow backdoor imports of the banned bindings. So, + // our last case is `ImportKind.ExportFrom`, and for that: + // + // - `export nameForDefault from "module"` isn't part of the ESM + // syntax (yet), so we only have to handle two cases below: + // `export { x } from "y"` and `export * from "specifier"`. + const parentNode = name.parent; + + // Disable strict-boolean-expressions for the next few lines so our && + // checks can help type inference figure out if when don't have undefined. + // tslint:disable strict-boolean-expressions + + const importClause = + parentNode && isImportDeclaration(parentNode) ? parentNode.importClause : undefined; + + const importsDefaultExport = importClause && Boolean(importClause.name); + + // Below, check isNamedImports to rule out the + // `import * as ns from "..."` case. + const importsSpecificNamedExports = + importClause && + importClause.namedBindings && + isNamedImports(importClause.namedBindings); + + // If parentNode is an ExportDeclaration, it must represent an + // `export from`, as findImports verifies that. Then, if exportClause + // is undefined, we're dealing with `export * from ...`. + const reExportsSpecificNamedExports = + parentNode && isExportDeclaration(parentNode) && Boolean(parentNode.exportClause); + + // tslint:enable strict-boolean-expressions + + if ( + importsDefaultExport || + importsSpecificNamedExports || + reExportsSpecificNamedExports + ) { + // Add an import for the default import and any named bindings. + // For the named bindings, we use the name of the export from the + // module (i.e., .propertyName) over its alias in the import when + // the two diverge. + const toExportName = (it: ts.ImportSpecifier | ts.ExportSpecifier) => + (it.propertyName || it.name).text; // tslint:disable-line strict-boolean-expressions + + const exportClause = reExportsSpecificNamedExports + ? (parentNode as ts.ExportDeclaration).exportClause! + : undefined; + + const namedImportsOrReExports = [ + ...(importsDefaultExport ? ["default"] : []), + ...(importsSpecificNamedExports + ? (importClause!.namedBindings as ts.NamedImports).elements.map( + toExportName + ) + : []), + ...(exportClause !== undefined ? exportClause.elements.map(toExportName) : []) + ]; + + for (const importName of namedImportsOrReExports) { + if (bansForModule.has(importName)) { + ctx.addFailureAtNode( + exportClause !== undefined ? exportClause : importClause!, + Rule.MAKE_NAMED_IMPORT_FAILURE_STRING(importName) + ); + } + } + } else { + // If we're here, the user tried to import/re-export the whole module + ctx.addFailure( + name.getStart(ctx.sourceFile) + 1, + name.end - 1, + Rule.IMPLICIT_NAMED_IMPORT_FAILURE_STRING + ); + } } } } diff --git a/test/rules/import-blacklist/test.ts.lint b/test/rules/import-blacklist/test.ts.lint index 14887486fd6..c66225fdc76 100644 --- a/test/rules/import-blacklist/test.ts.lint +++ b/test/rules/import-blacklist/test.ts.lint @@ -2,9 +2,12 @@ import { Observable } from 'rxjs'; ~~~~ [0] import { Observable } from 'rxjs/Observable'; -import forOwn = require('lodash'); - ~~~~~~ [0] -import forOwn = require('lodash/forOwn'); +import rxjs = require('rxjs'); + ~~~~ [0] +import Observable = require('rxjs/Observable'); + +import * as rxjs from "rxjs"; + ~~~~ [0] // non-static imports cannot be checked import {Observable} from rxjs; @@ -12,7 +15,33 @@ import forOwn = require(lodash); import * as notBlacklisted from "not-blacklisted"; -export * from 'lodash'; - ~~~~~~ [0] +export * from 'rxjs'; + ~~~~ [0] + +export { default } from "dummy"; + ~~~~~~~~~~~ [3] + +export * from "lodash"; + ~~~~~~ [1] + +import * as lodash from "lodash"; + ~~~~~~ [1] +import { difference } from "lodash"; + +import { pull, difference } from "lodash"; + ~~~~~~~~~~~~~~~~~~~~ [2] + +import lodash, { pull } from "lodash"; + ~~~~~~~~~~~~~~~~ [2] + +import { pull as notPull } from "lodash"; + ~~~~~~~~~~~~~~~~~~~ [2] + +import test from "dummy"; + ~~~~ [3] + -[0]: This import is blacklisted, import a submodule instead +[0]: Importing this module is blacklisted. Try importing a submodule instead. +[1]: Some named exports from this module are blacklisted for importing (or re-exporting). Import/re-export only the specific values you want, instead of the whole module. +[2]: The export "pull" is blacklisted. +[3]: Importing (or re-exporting) the default export is blacklisted. diff --git a/test/rules/import-blacklist/tslint.json b/test/rules/import-blacklist/tslint.json index 7abdb4f44a8..3c543ffa93f 100644 --- a/test/rules/import-blacklist/tslint.json +++ b/test/rules/import-blacklist/tslint.json @@ -1,5 +1,5 @@ { "rules": { - "import-blacklist": [true, "lodash", "rxjs"] + "import-blacklist": [true, "rxjs", { "lodash": ["pullAll", "pull"] }, { "dummy": ["default"] }] } } From 5d9f1bdf2220a94e8030946c41484c3b544b98c0 Mon Sep 17 00:00:00 2001 From: Dan Homola Date: Wed, 12 Dec 2018 17:36:19 +0100 Subject: [PATCH 14/60] ordered-imports: check that all imports of the same type are groupped (#3733) * ordered-imports: check that all imports of the same type are groupped Fixes #3727 * ordered-imports: make the error message more understandable --- src/rules/orderedImportsRule.ts | 22 +++++++++++++++++++ .../grouped-imports/test.ts.fix | 1 + .../grouped-imports/test.ts.lint | 4 ++++ 3 files changed, 27 insertions(+) diff --git a/src/rules/orderedImportsRule.ts b/src/rules/orderedImportsRule.ts index 67c0a2adcf8..f161883ff07 100644 --- a/src/rules/orderedImportsRule.ts +++ b/src/rules/orderedImportsRule.ts @@ -122,6 +122,8 @@ export class Rule extends Lint.Rules.AbstractRule { "Import sources of different groups must be sorted by: libraries, parent directories, current directory."; public static IMPORT_SOURCES_UNORDERED = "Import sources within a group must be alphabetized."; public static NAMED_IMPORTS_UNORDERED = "Named imports must be alphabetized."; + public static IMPORT_SOURCES_OF_SAME_TYPE_NOT_IN_ONE_GROUP = + "Import sources of the same type (package, same folder, different folder) must be grouped together."; public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] { return this.applyWithWalker( @@ -325,9 +327,29 @@ class Walker extends Lint.AbstractWalker { } private checkBlocksGrouping(): void { + this.checkBlocksUniqueness(); this.importsBlocks.some(this.checkBlockGroups, this); } + private checkBlocksUniqueness(): void { + const typesEncountered = new Map([ + [ImportType.LIBRARY_IMPORT, false], + [ImportType.PARENT_DIRECTORY_IMPORT, false], + [ImportType.CURRENT_DIRECTORY_IMPORT, false], + ]); + + const nonEmptyBlocks = this.importsBlocks.filter((block) => block.getImportDeclarations().length > 0); + nonEmptyBlocks.forEach((block) => { + // assume the whole block is of the same type, hence use the first one as the representing one + const firstInBlock = block.getImportDeclarations()[0]; + if (typesEncountered.get(firstInBlock.type)) { + this.addFailureAtNode(firstInBlock.node, Rule.IMPORT_SOURCES_OF_SAME_TYPE_NOT_IN_ONE_GROUP); + } else { + typesEncountered.set(firstInBlock.type, true); + } + }); + } + private checkBlockGroups(importsBlock: ImportsBlock): boolean { const oddImportDeclaration = this.getOddImportDeclaration(importsBlock); if (oddImportDeclaration !== undefined) { diff --git a/test/rules/ordered-imports/grouped-imports/test.ts.fix b/test/rules/ordered-imports/grouped-imports/test.ts.fix index a27584cf23d..cc27f31a6d2 100644 --- a/test/rules/ordered-imports/grouped-imports/test.ts.fix +++ b/test/rules/ordered-imports/grouped-imports/test.ts.fix @@ -7,5 +7,6 @@ import {bar} from '../bar'; import './baa'; import './baz'; // required +import './caa'; export class Test {} diff --git a/test/rules/ordered-imports/grouped-imports/test.ts.lint b/test/rules/ordered-imports/grouped-imports/test.ts.lint index 384fc26f5b9..2be0a501966 100644 --- a/test/rules/ordered-imports/grouped-imports/test.ts.lint +++ b/test/rules/ordered-imports/grouped-imports/test.ts.lint @@ -10,6 +10,10 @@ import './baz'; // required import './baa'; ~~~~~~~~~~~~~~~ [Import sources within a group must be alphabetized.] +import './caa'; +~~~~~~~~~~~~~~~ [Import sources of the same type (package, same folder, different folder) must be grouped together.] + import x = require('y'); +~~~~~~~~~~~~~~~~~~~~~~~~ [Import sources of the same type (package, same folder, different folder) must be grouped together.] export class Test {} From e8a620d5c40126c3c3fd8af3a1a34d0555f9c162 Mon Sep 17 00:00:00 2001 From: NN Date: Wed, 12 Dec 2018 18:53:59 +0200 Subject: [PATCH 15/60] Allow unknown in 'no-object-literal-type-assertion' rule. (#4362) * Fix #4355 Allow unknown in 'no-object-literal-type-assertion' rule. * Allow unknown in TS 2.0 as well. * Allow unknown type assertion --- src/rules/noObjectLiteralTypeAssertionRule.ts | 6 +++++- test/rules/no-object-literal-type-assertion/test.ts.lint | 4 ++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/src/rules/noObjectLiteralTypeAssertionRule.ts b/src/rules/noObjectLiteralTypeAssertionRule.ts index 64c42241dbb..f50ce702c08 100644 --- a/src/rules/noObjectLiteralTypeAssertionRule.ts +++ b/src/rules/noObjectLiteralTypeAssertionRule.ts @@ -30,7 +30,7 @@ export class Rule extends Lint.Rules.AbstractRule { ruleName: "no-object-literal-type-assertion", description: Lint.Utils.dedent` Forbids an object literal to appear in a type assertion expression. - Casting to \`any\` is still allowed.`, + Casting to \`any\` or to \`unknown\` is still allowed.`, rationale: Lint.Utils.dedent` Always prefer \`const x: T = { ... };\` to \`const x = { ... } as T;\`. The type assertion in the latter case is either unnecessary or hides an error. @@ -58,6 +58,10 @@ function walk(ctx: Lint.WalkContext): void { if ( isAssertionExpression(node) && node.type.kind !== ts.SyntaxKind.AnyKeyword && + // Compare with UnknownKeyword if using TS 3.0 or above + (!!(ts.SyntaxKind as any).UnknownKeyword ? + (node.type.kind !== (ts.SyntaxKind as any).UnknownKeyword) : + node.type.getText(ctx.sourceFile) !== "unknown") && isObjectLiteralExpression( isParenthesizedExpression(node.expression) ? node.expression.expression diff --git a/test/rules/no-object-literal-type-assertion/test.ts.lint b/test/rules/no-object-literal-type-assertion/test.ts.lint index 73405b74746..1ccea8ea1bf 100644 --- a/test/rules/no-object-literal-type-assertion/test.ts.lint +++ b/test/rules/no-object-literal-type-assertion/test.ts.lint @@ -12,4 +12,8 @@ x as T; {} as any; {}; +// Allow cast to 'unknown' +{} as unknown; + {}; + [0]: Type assertion on object literals is forbidden, use a type annotation instead. From e5f133fe0a3a0868e5954a5fffdad22b7ece7f24 Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Wed, 12 Dec 2018 08:59:27 -0800 Subject: [PATCH 16/60] New rule: no-unnecessary-bind (#3588) New rule: unnecessary-bind --- src/configs/all.ts | 1 + src/rules/unnecessaryBindRule.ts | 163 ++++++++++++++++++ .../rules/unnecessary-bind/typed/test.ts.lint | 73 ++++++++ .../unnecessary-bind/typed/tsconfig.json | 5 + test/rules/unnecessary-bind/typed/tslint.json | 5 + .../unnecessary-bind/untyped/test.ts.lint | 62 +++++++ .../unnecessary-bind/untyped/tslint.json | 5 + tslint.json | 126 +++++++------- 8 files changed, 372 insertions(+), 68 deletions(-) create mode 100644 src/rules/unnecessaryBindRule.ts create mode 100644 test/rules/unnecessary-bind/typed/test.ts.lint create mode 100644 test/rules/unnecessary-bind/typed/tsconfig.json create mode 100644 test/rules/unnecessary-bind/typed/tslint.json create mode 100644 test/rules/unnecessary-bind/untyped/test.ts.lint create mode 100644 test/rules/unnecessary-bind/untyped/tslint.json diff --git a/src/configs/all.ts b/src/configs/all.ts index 25079bf1481..dec41525ec8 100644 --- a/src/configs/all.ts +++ b/src/configs/all.ts @@ -252,6 +252,7 @@ export const rules = { "space-within-parens": [true, 0], "switch-final-break": true, "type-literal-delimiter": true, + "unnecessary-bind": true, "variable-name": [true, "ban-keywords", "check-format"], whitespace: [ true, diff --git a/src/rules/unnecessaryBindRule.ts b/src/rules/unnecessaryBindRule.ts new file mode 100644 index 00000000000..5462eb08d2c --- /dev/null +++ b/src/rules/unnecessaryBindRule.ts @@ -0,0 +1,163 @@ +/** + * @license + * Copyright 2017 Palantir Technologies, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import * as tsutils from "tsutils"; +import * as ts from "typescript"; + +import * as Lint from "../index"; + +export class Rule extends Lint.Rules.OptionallyTypedRule { + public static metadata: Lint.IRuleMetadata = { + description: "Prevents unnecessary and/or misleading scope bindings on functions.", + optionExamples: [true], + options: null, + optionsDescription: "Not configurable.", + rationale: Lint.Utils.dedent` + \`function\` expressions that are immediately bound to \`this\` are equivalent to \`() =>\` arrow lambdas. + Additionally, there's no use in binding a scope to an arrow lambda, as it already has one. + `, + requiresTypeInfo: true, + ruleName: "unnecessary-bind", + type: "style", + typescriptOnly: false + }; + + public static FAILURE_STRING_FUNCTION = + "Don't bind `this` without arguments as a scope to a function. Use an arrow lambda instead."; + + public static FAILURE_STRING_ARROW = + "Don't bind scopes to arrow lambdas, as they already have a bound scope."; + + public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] { + return this.applyWithFunction(sourceFile, walk); + } + + public applyWithProgram(sourceFile: ts.SourceFile, program: ts.Program): Lint.RuleFailure[] { + return this.applyWithFunction(sourceFile, walk, undefined, program.getTypeChecker()); + } +} + +function walk(context: Lint.WalkContext, typeChecker?: ts.TypeChecker) { + const variableUsage = tsutils.collectVariableUsage(context.sourceFile); + + function checkArrowFunction(node: ts.CallExpression): void { + if (node.arguments.length !== 1) { + return; + } + + context.addFailureAtNode(node, Rule.FAILURE_STRING_ARROW); + } + + function canFunctionExpressionBeFixed( + callExpression: ts.CallExpression, + valueDeclaration: ts.FunctionExpression + ): boolean { + if ( + callExpression.arguments.length !== 1 || + callExpression.arguments[0].kind !== ts.SyntaxKind.ThisKeyword || + valueDeclaration.asteriskToken !== undefined || + valueDeclaration.decorators !== undefined + ) { + return false; + } + + const { name } = valueDeclaration; + if (name === undefined) { + return true; + } + + const nameInfo = variableUsage.get(name); + return nameInfo === undefined || nameInfo.uses.length === 0; + } + + function checkFunctionExpression( + callExpression: ts.CallExpression, + valueDeclaration: ts.FunctionExpression + ): void { + if (!canFunctionExpressionBeFixed(callExpression, valueDeclaration)) { + return; + } + + context.addFailureAtNode(callExpression, Rule.FAILURE_STRING_FUNCTION); + } + + function getArrowFunctionDeclaration(node: ts.Node): ts.ArrowFunction | undefined { + if (typeChecker === undefined) { + return undefined; + } + + const { symbol } = typeChecker.getTypeAtLocation(node); + if (symbol === undefined) { + return undefined; + } + + const { valueDeclaration } = symbol; + if (valueDeclaration === undefined) { + return undefined; + } + + if (!tsutils.isArrowFunction(valueDeclaration)) { + return undefined; + } + + return valueDeclaration; + } + + function isDecoratedPropertyMember(node: ts.CallExpression): boolean { + return ( + node.parent !== undefined && + tsutils.isPropertyDeclaration(node.parent) && + node.parent.decorators !== undefined + ); + } + + function checkCallExpression(node: ts.CallExpression): void { + if (isDecoratedPropertyMember(node)) { + return; + } + + const bindExpression = node.expression; + if (!isBindPropertyAccess(bindExpression)) { + return; + } + + const boundExpression = Lint.unwrapParentheses(bindExpression.expression); + if (tsutils.isFunctionExpression(boundExpression)) { + checkFunctionExpression(node, boundExpression); + return; + } + + const valueDeclaration = getArrowFunctionDeclaration(boundExpression); + if (valueDeclaration !== undefined) { + checkArrowFunction(node); + } + } + + return ts.forEachChild(context.sourceFile, function callback(node: ts.Node): void { + if (ts.isCallExpression(node)) { + checkCallExpression(node); + } + + return ts.forEachChild(node, callback); + }); +} + +function isBindPropertyAccess( + node: ts.LeftHandSideExpression +): node is ts.PropertyAccessExpression { + return ts.isPropertyAccessExpression(node) && node.name.text === "bind"; +} diff --git a/test/rules/unnecessary-bind/typed/test.ts.lint b/test/rules/unnecessary-bind/typed/test.ts.lint new file mode 100644 index 00000000000..1edebe3976f --- /dev/null +++ b/test/rules/unnecessary-bind/typed/test.ts.lint @@ -0,0 +1,73 @@ +const arrowLambda = () => {}; +const functionVar = function () {}; + +declare const stubDecorator: any; + +class Class { + public constructor() { } + + public bind() { } + + public method() { } + + public boundFunction = function () {}.bind(this) + ~~~~~~~~~~~~~~~~~~~~~~~~~ [function] + + public boundAsyncFunction = (async function () {}).bind(this) + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [function] + + @stubDecorator + public decorated = function () {}.bind(this) +} + +const instance = new Class(); + +arrowLambda.bind(this); +~~~~~~~~~~~~~~~~~~~~~~ [arrow] +arrowLambda.bind(arrowLambda); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [arrow] +arrowLambda.bind(undefined); +~~~~~~~~~~~~~~~~~~~~~~~~~~~ [arrow] +arrowLambda.bind(this, 1); +arrowLambda.bind(this, undefined); + +functionVar.bind(this); +functionVar.bind(functionVar); +functionVar.bind(undefined); +functionVar.bind(this, 1); +functionVar.bind(this, undefined); + +const immediatelyBoundFunction = function () {}.bind(this); + ~~~~~~~~~~~~~~~~~~~~~~~~~ [function] +const immediatelyBoundFunctionReturn = function (i: number): number { return i; }.bind(this); + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [function] +const immediatelyBoundFunctionWrapped = (function () {}).bind(this); + ~~~~~~~~~~~~~~~~~~~~~~~~~~~ [function] +const immediatelyBoundFunctionWrappedReturn = (function (i: number): number { return i; }).bind(this); + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [function] +const immediatelyBoundFunctionArgs = function (i: number): number {}.bind(this, 1); +const immediatelyBoundFunctionArgsReturn = function (i: number): number { return i; }.bind(this, 1); +const immediatelyBoundFunctionNameUnused = function foo() { functionVar(); }.bind(this); + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [function] +const immediatelyBoundFunctionNameUsed = function foo() { foo(); }.bind(this); + +const immediatelyBoundArrow = ((i: number) => i).bind(this); + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [arrow] +const immediatelyBoundArrowArgs = ((i: number) => i).bind(this, 1); +const immediatelyBoundArrowArgsReturn = function (i: number): number { return i; }.bind(this, 1); + +const asyncFunction = async function () {}.bind(this); + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [function] +const asyncFunctionReturn = async function (): number { return 1; }.bind(this); + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [function] +const asyncArrow = (async () => {}).bind(this); + ~~~~~~~~~~~~~~~~~~~~~~~~~~~ [arrow] +const asyncArrowReturn = (async (): number => { return 1; }).bind(this); + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [arrow] + +(function* generator() {}).bind(this); +instance.method.bind(this); +instance.bind(this); +Class.bind(this); +[arrow]: Don't bind scopes to arrow lambdas, as they already have a bound scope. +[function]: Don't bind `this` without arguments as a scope to a function. Use an arrow lambda instead. diff --git a/test/rules/unnecessary-bind/typed/tsconfig.json b/test/rules/unnecessary-bind/typed/tsconfig.json new file mode 100644 index 00000000000..744a66c893a --- /dev/null +++ b/test/rules/unnecessary-bind/typed/tsconfig.json @@ -0,0 +1,5 @@ +{ + "compilerOptions": { + "module": "commonjs" + } +} diff --git a/test/rules/unnecessary-bind/typed/tslint.json b/test/rules/unnecessary-bind/typed/tslint.json new file mode 100644 index 00000000000..3a5cc6c8d6f --- /dev/null +++ b/test/rules/unnecessary-bind/typed/tslint.json @@ -0,0 +1,5 @@ +{ + "rules": { + "unnecessary-bind": true + } +} diff --git a/test/rules/unnecessary-bind/untyped/test.ts.lint b/test/rules/unnecessary-bind/untyped/test.ts.lint new file mode 100644 index 00000000000..48cbdff01d4 --- /dev/null +++ b/test/rules/unnecessary-bind/untyped/test.ts.lint @@ -0,0 +1,62 @@ +const arrowLambda = () => {}; +const functionVar = function () {}; + +class Class { + public constructor() { } + + public bind() { } + + public method() { } + + public boundFunction = function () {}.bind(this) + ~~~~~~~~~~~~~~~~~~~~~~~~~ [function] + + public boundAsyncFunction = (async function () {}).bind(this) + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [function] +} + +const instance = new Class(); + +arrowLambda.bind(this); +arrowLambda.bind(arrowLambda); +arrowLambda.bind(undefined); +arrowLambda.bind(this, 1); +arrowLambda.bind(this, undefined); + +functionVar.bind(this); +functionVar.bind(functionVar); +functionVar.bind(undefined); +functionVar.bind(this, 1); +functionVar.bind(this, undefined); + +const immediatelyBoundFunction = function () {}.bind(this); + ~~~~~~~~~~~~~~~~~~~~~~~~~ [function] +const immediatelyBoundFunctionReturn = function (i: number): number { return i; }.bind(this); + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [function] +const immediatelyBoundFunctionWrapped = (function () {}).bind(this); + ~~~~~~~~~~~~~~~~~~~~~~~~~~~ [function] +const immediatelyBoundFunctionWrappedReturn = (function (i: number): number { return i; }).bind(this); + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [function] +const immediatelyBoundFunctionArgs = function (i: number): number {}.bind(this, 1); +const immediatelyBoundFunctionArgsReturn = function (i: number): number { return i; }.bind(this, 1); +const immediatelyBoundFunctionNameUnused = function foo() { functionVar(); }.bind(this); + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [function] +const immediatelyBoundFunctionNameUsed = function foo() { foo(); }.bind(this); + +const immediatelyBoundArrow = ((i: number) => i).bind(this); +const immediatelyBoundArrowArgs = ((i: number) => i).bind(this, 1); +const immediatelyBoundArrowArgsReturn = function (i: number): number { return i; }.bind(this, 1); + +const asyncFunction = async function () {}.bind(this); + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [function] +const asyncFunctionReturn = async function (): number { return 1; }.bind(this); + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [function] +const asyncArrow = (async () => {}).bind(this); +const asyncArrowReturn = (async (): number => { return 1; }).bind(this); + +(function* generator() {}).bind(this); +instance.method.bind(this); +instance.bind(this); +Class.bind(this); +[arrow]: Don't bind scopes to arrow lambdas, as they already have a bound scope. +[function]: Don't bind `this` without arguments as a scope to a function. Use an arrow lambda instead. diff --git a/test/rules/unnecessary-bind/untyped/tslint.json b/test/rules/unnecessary-bind/untyped/tslint.json new file mode 100644 index 00000000000..3a5cc6c8d6f --- /dev/null +++ b/test/rules/unnecessary-bind/untyped/tslint.json @@ -0,0 +1,5 @@ +{ + "rules": { + "unnecessary-bind": true + } +} diff --git a/tslint.json b/tslint.json index 3b2ce4e7f04..f439c65b9ce 100644 --- a/tslint.json +++ b/tslint.json @@ -1,73 +1,63 @@ { - "lintOptions": { - "typeCheck": true - }, - "extends": ["tslint:all", "tslint-config-prettier"], - "rules": { - // Don't want these - "cyclomatic-complexity": false, - "increment-decrement": false, - "newline-before-return": false, - "no-parameter-properties": false, - "no-parameter-reassignment": false, - "no-unused-variable": false, - // TODO: Enable stricter options for these - "comment-format": [ - true, - "check-space" - ], - "member-access": true, - "only-arrow-functions": [ - true, - "allow-declarations", - "allow-named-functions" - ], + "lintOptions": { + "typeCheck": true + }, + "extends": ["tslint:all", "tslint-config-prettier"], + "rules": { + // Don't want these + "cyclomatic-complexity": false, + "increment-decrement": false, + "newline-before-return": false, + "no-parameter-properties": false, + "no-parameter-reassignment": false, + "no-unused-variable": false, + // TODO: Enable stricter options for these + "comment-format": [true, "check-space"], + "member-access": true, + "only-arrow-functions": [true, "allow-declarations", "allow-named-functions"], - // TODO: Enable these - "completed-docs": false, - "no-any": false, - "no-magic-numbers": false, - "no-non-null-assertion": false, - "no-null-keyword": false, - "no-require-imports": false, - "no-unbound-method": false, - "no-unnecessary-qualifier": false, - "no-use-before-declare": false, - "no-void-expression": false, - "prefer-function-over-method": false, - "strict-type-predicates": false, - "triple-equals": [true, "allow-undefined-check"], - "typedef": false, + // TODO: Enable these + "completed-docs": false, + "no-any": false, + "no-magic-numbers": false, + "no-non-null-assertion": false, + "no-null-keyword": false, + "no-require-imports": false, + "no-unbound-method": false, + "no-unnecessary-qualifier": false, + "no-use-before-declare": false, + "no-void-expression": false, + "prefer-function-over-method": false, + "strict-type-predicates": false, + "triple-equals": [true, "allow-undefined-check"], + "typedef": false, - "ban": [true, - ["describe", "only"], - ["it", "only"] - ], + "ban": [true, ["describe", "only"], ["it", "only"]], - "interface-name": false, - "file-header": [true, - "Copyright \\d{4} Palantir Technologies, Inc." - ], - "max-classes-per-file": false, - "max-line-length": [true, 140], - "member-ordering": [true, - "public-before-private", - "static-before-instance", - "variables-before-functions" - ], - "newline-per-chained-call": false, - "no-console": { - "options": ["log"] - }, - "no-switch-case-fall-through": true, - "strict-boolean-expressions": [true, "allow-boolean-or-undefined"], - "switch-default": false, - "variable-name": [true, - "ban-keywords", - "check-format", - "allow-leading-underscore", - "allow-pascal-case" - ], - "linebreak-style": false - } + "interface-name": false, + "file-header": [true, "Copyright \\d{4} Palantir Technologies, Inc."], + "max-classes-per-file": false, + "max-line-length": [true, 140], + "member-ordering": [ + true, + "public-before-private", + "static-before-instance", + "variables-before-functions" + ], + "newline-per-chained-call": false, + "no-console": { + "options": ["log"] + }, + "no-switch-case-fall-through": true, + "strict-boolean-expressions": [true, "allow-boolean-or-undefined"], + "switch-default": false, + "variable-name": [ + true, + "ban-keywords", + "check-format", + "allow-leading-underscore", + "allow-pascal-case" + ], + "linebreak-style": false + } } From ac70fab72338929fd2cca546b2e232951f72631f Mon Sep 17 00:00:00 2001 From: Ryan Waskiewicz Date: Wed, 12 Dec 2018 12:17:21 -0500 Subject: [PATCH 17/60] Update Configuration Documentation (#4258) - Add section on array syntax - Mark boolean syntax as legacy --- docs/usage/configuration/index.md | 63 ++++++++++++++----------------- 1 file changed, 29 insertions(+), 34 deletions(-) diff --git a/docs/usage/configuration/index.md b/docs/usage/configuration/index.md index 0aa088af90c..39a4679684f 100644 --- a/docs/usage/configuration/index.md +++ b/docs/usage/configuration/index.md @@ -11,29 +11,31 @@ configure which rules get run and each of their options. `tslint.json` or `tslint.yaml` files can have the following fields specified: -* `extends?: string | string[]`: -The name of a built-in configuration preset (see built-in presets below), or a path or -array of paths to other configuration files which are extended by this configuration. -This value is handled using node module resolution semantics. -For example, a value of `"tslint-config"` would tell TSLint to try and load the main file of a module -named "tslint-config" as a configuration file. Specific files inside node modules can also be -specified, eg. `"tslint-config/path/to/submodule"`. Relative paths to JSON files or JS modules -are also supported, e.g. `"./tslint-config"`. -* `rulesDirectory?: string | string[]`: -A path to a directory or an array of paths to directories of [custom rules][2]. These values are handled using node module resolution semantics, if an `index.js` is placed in your rules directory. We fallback to use relative or absolute paths, if the module can't be resolved. If you want to avoid module resolution you can directly use a relative or absolute path (e.g. with `./`). -* `rules?: { [name: string]: RuleSetting }`: A map of rule names to their configuration settings. - - These rules are applied to `.ts` and `.tsx` files. - - Each rule is associated with an object containing: - - `options?: any`: An array of values that are specific to a rule. - - `severity?: "default" | "error" | "warning" | "off"`: Severity level. Level "error" will cause exit code 2. - - A boolean value may be specified instead of the above object, and is equivalent to setting no options with default severity. - - Any rules specified in this block will override those configured in any base configuration being extended. - - [Check out the full rules list here][3]. -* `jsRules?: any | boolean`: Same format as `rules` or explicit `true` to copy all valid active rules from rules. These rules are applied to `.js` and `.jsx` files. -* `defaultSeverity?: "error" | "warning" | "off"`: The severity level that is applied to rules in this config file as well as rules in any inherited config files which have their severity set to "default". If undefined, "error" is used as the defaultSeverity. -* `linterOptions?: { exclude?: string[] }`: - - `exclude: string[]`: An array of globs. Any file matching these globs will not be linted. All exclude patterns are relative to the configuration file they were specified in. - - `format: string`: Default [lint formatter][4] +- `extends?: string | string[]`: + The name of a built-in configuration preset (see built-in presets below), or a path or + array of paths to other configuration files which are extended by this configuration. + This value is handled using node module resolution semantics. + For example, a value of `"tslint-config"` would tell TSLint to try and load the main file of a module + named "tslint-config" as a configuration file. Specific files inside node modules can also be + specified, eg. `"tslint-config/path/to/submodule"`. Relative paths to JSON files or JS modules + are also supported, e.g. `"./tslint-config"`. +- `rulesDirectory?: string | string[]`: + A path to a directory or an array of paths to directories of [custom rules][2]. These values are handled using node module resolution semantics, if an `index.js` is placed in your rules directory. We fallback to use relative or absolute paths, if the module can't be resolved. If you want to avoid module resolution you can directly use a relative or absolute path (e.g. with `./`). +- `rules?: { [name: string]: RuleSetting }`: A map of rule names to their configuration settings. + - These rules are applied to `.ts` and `.tsx` files. + - Each rule is associated with an object containing: + - `options?: any`: An array of values that are specific to a rule. + - `severity?: "default" | "error" | "warning" | "off"`: Severity level. Level "error" will cause exit code 2. + - Legacy: An array may be specified instead of the above object, and is equivalent to setting the rule with the default severity if the first value in the array is `true`, with configuration parameters in the remainder of the array. + - `"no-empty": [true, "allow-empty-catch"]` is strictly equivalent to `"no-empty": { "options": ['allow-empty-catch'], "severity": 'default' }` + - Legacy: A boolean value may be specified instead of the above object, and is equivalent to setting no options with default severity. + - Any rules specified in this block will override those configured in any base configuration being extended. + - [Check out the full rules list here][3]. +- `jsRules?: any | boolean`: Same format as `rules` or explicit `true` to copy all valid active rules from rules. These rules are applied to `.js` and `.jsx` files. +- `defaultSeverity?: "error" | "warning" | "off"`: The severity level that is applied to rules in this config file as well as rules in any inherited config files which have their severity set to "default". If undefined, "error" is used as the defaultSeverity. +- `linterOptions?: { exclude?: string[] }`: + - `exclude: string[]`: An array of globs. Any file matching these globs will not be linted. All exclude patterns are relative to the configuration file they were specified in. + - `format: string`: Default [lint formatter][4] `tslint.json` configuration files may have JavaScript-style `// single-line` and `/* multi-line */` comments in them (even though this is technically invalid JSON). If this confuses your syntax highlighter, you may want to switch it to JavaScript format. @@ -54,14 +56,7 @@ An example `tslint.json` file might look like this: "no-consecutive-blank-lines": false, "no-console": { "severity": "warning", - "options": [ - "debug", - "info", - "log", - "time", - "timeEnd", - "trace" - ] + "options": ["debug", "info", "log", "time", "timeEnd", "trace"] } }, "jsRules": { @@ -111,11 +106,11 @@ The severity level of each rule can be configured to `default`, `error`, `warnin TSLint ships with a handful of built-in configurations presets. You may inspect their source [here](https://github.com/palantir/tslint/tree/master/src/configs). -__`tslint:recommended`__ is a stable, somewhat opinionated set of rules which we encourage for general TypeScript programming. This configuration follows semver, so it will _not_ have breaking changes across minor or patch releases. +**`tslint:recommended`** is a stable, somewhat opinionated set of rules which we encourage for general TypeScript programming. This configuration follows semver, so it will _not_ have breaking changes across minor or patch releases. -__`tslint:latest`__ extends `tslint:recommended` and is continuously updated to include configuration for the latest rules in every TSLint release. Using this config may introduce breaking changes across minor releases as new rules are enabled which cause lint failures in your code. When TSLint reaches a major version bump, `tslint:recommended` will be updated to be identical to `tslint:latest`. +**`tslint:latest`** extends `tslint:recommended` and is continuously updated to include configuration for the latest rules in every TSLint release. Using this config may introduce breaking changes across minor releases as new rules are enabled which cause lint failures in your code. When TSLint reaches a major version bump, `tslint:recommended` will be updated to be identical to `tslint:latest`. -__`tslint:all`__ turns on all rules to their strictest settings. This will use type checking, so it must be combined with the `--project` option. +**`tslint:all`** turns on all rules to their strictest settings. This will use type checking, so it must be combined with the `--project` option. (Exceptions include rules such as [`"ban"`][rule-ban], [`"import-blacklist"`][rule-import-blacklist], and [`"file-header"`][rule-file-header], which have no sensible defaults, and deprecated rules.) ### Custom rules From 412604b63dc47b68ce9073436e90ce6536266286 Mon Sep 17 00:00:00 2001 From: Andrew MacLeay Date: Wed, 12 Dec 2018 12:20:09 -0500 Subject: [PATCH 18/60] Nit: UpperCamelCase enum in noInvalidThisRule (#4376) --- src/rules/noInvalidThisRule.ts | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/rules/noInvalidThisRule.ts b/src/rules/noInvalidThisRule.ts index c4a4d8dfe24..bd4f2e1a0cb 100644 --- a/src/rules/noInvalidThisRule.ts +++ b/src/rules/noInvalidThisRule.ts @@ -61,19 +61,19 @@ export class Rule extends Lint.Rules.AbstractRule { } } -const enum parentType { +const enum ParentType { None, Class, ClassMethod, BoundRegularFunction, UnboundRegularFunction, } -const thisAllowedParents = new Set([parentType.ClassMethod, parentType.BoundRegularFunction]); +const thisAllowedParents = new Set([ParentType.ClassMethod, ParentType.BoundRegularFunction]); function walk(ctx: Lint.WalkContext): void { const { sourceFile, options: checkFuncInMethod } = ctx; - let currentParent: parentType = parentType.None; + let currentParent: ParentType = ParentType.None; let inClass = false; ts.forEachChild(sourceFile, function cb(node: ts.Node) { @@ -83,7 +83,7 @@ function walk(ctx: Lint.WalkContext): void { case ts.SyntaxKind.ClassDeclaration: case ts.SyntaxKind.ClassExpression: inClass = true; - currentParent = parentType.Class; + currentParent = ParentType.Class; ts.forEachChild(node, cb); currentParent = originalParent; inClass = originalInClass; @@ -96,16 +96,16 @@ function walk(ctx: Lint.WalkContext): void { case ts.SyntaxKind.PropertyDeclaration: case ts.SyntaxKind.FunctionDeclaration: case ts.SyntaxKind.FunctionExpression: - if (currentParent === parentType.Class) { - currentParent = parentType.ClassMethod; + if (currentParent === ParentType.Class) { + currentParent = ParentType.ClassMethod; ts.forEachChild(node, cb); currentParent = originalParent; return; } else { currentParent = (node as ts.FunctionLikeDeclaration).parameters.some(isThisParameter) - ? parentType.BoundRegularFunction - : parentType.UnboundRegularFunction; + ? ParentType.BoundRegularFunction + : ParentType.UnboundRegularFunction; ts.forEachChild(node, cb); currentParent = originalParent; return; From f6044a5b9a92e1b570a0a0f49b4b20f4090d5ea6 Mon Sep 17 00:00:00 2001 From: Roman Rogowski Date: Wed, 12 Dec 2018 12:23:24 -0500 Subject: [PATCH 19/60] fix #4338 (#4374) --- src/rules/orderedImportsRule.ts | 30 +++++++++---------- .../{ => default}/test.ts.fix | 0 .../{ => default}/test.ts.lint | 0 .../{ => default}/tslint.json | 0 .../grouped-imports/test.ts.fix | 5 ++++ .../grouped-imports/test.ts.lint | 7 +++++ .../grouped-imports/tslint.json | 5 ++++ 7 files changed, 32 insertions(+), 15 deletions(-) rename test/rules/ordered-imports/import-sources-any/{ => default}/test.ts.fix (100%) rename test/rules/ordered-imports/import-sources-any/{ => default}/test.ts.lint (100%) rename test/rules/ordered-imports/import-sources-any/{ => default}/tslint.json (100%) create mode 100644 test/rules/ordered-imports/import-sources-any/grouped-imports/test.ts.fix create mode 100644 test/rules/ordered-imports/import-sources-any/grouped-imports/test.ts.lint create mode 100644 test/rules/ordered-imports/import-sources-any/grouped-imports/tslint.json diff --git a/src/rules/orderedImportsRule.ts b/src/rules/orderedImportsRule.ts index f161883ff07..370c9b1bc28 100644 --- a/src/rules/orderedImportsRule.ts +++ b/src/rules/orderedImportsRule.ts @@ -247,9 +247,7 @@ class Walker extends Lint.AbstractWalker { return; } - const source = this.options.importSourcesOrderTransform( - removeQuotes(node.moduleSpecifier.text), - ); + const source = removeQuotes(node.moduleSpecifier.text); this.checkSource(source, node); const { importClause } = node; @@ -277,14 +275,16 @@ class Walker extends Lint.AbstractWalker { return; } - const source = this.options.importSourcesOrderTransform(removeQuotes(expression.text)); + const source = removeQuotes(expression.text); this.checkSource(source, node); } - private checkSource(source: string, node: ImportDeclaration["node"]) { + private checkSource(originalSource: string, node: ImportDeclaration["node"]) { + const type = getImportType(originalSource); + const source = this.options.importSourcesOrderTransform(originalSource); const currentSource = this.options.moduleSourcePath(source); const previousSource = this.currentImportsBlock.getLastImportSource(); - this.currentImportsBlock.addImportDeclaration(this.sourceFile, node, currentSource); + this.currentImportsBlock.addImportDeclaration(this.sourceFile, node, currentSource, type); if (previousSource !== null && compare(currentSource, previousSource) === -1) { this.lastFix = []; @@ -454,11 +454,11 @@ class ImportsBlock { sourceFile: ts.SourceFile, node: ImportDeclaration["node"], sourcePath: string, + type: ImportType, ) { const start = this.getStartOffset(node); const end = this.getEndOffset(sourceFile, node); const text = sourceFile.text.substring(start, end); - const type = this.getImportType(sourcePath); if (start > node.getStart() || end === 0) { // skip block if any statements don't end with a newline to simplify implementation @@ -532,17 +532,17 @@ class ImportsBlock { private getLastImportDeclaration(): ImportDeclaration | undefined { return this.importDeclarations[this.importDeclarations.length - 1]; } +} - private getImportType(sourcePath: string): ImportType { - if (sourcePath.charAt(0) === ".") { - if (sourcePath.charAt(1) === ".") { - return ImportType.PARENT_DIRECTORY_IMPORT; - } else { - return ImportType.CURRENT_DIRECTORY_IMPORT; - } +function getImportType(sourcePath: string): ImportType { + if (sourcePath.charAt(0) === ".") { + if (sourcePath.charAt(1) === ".") { + return ImportType.PARENT_DIRECTORY_IMPORT; } else { - return ImportType.LIBRARY_IMPORT; + return ImportType.CURRENT_DIRECTORY_IMPORT; } + } else { + return ImportType.LIBRARY_IMPORT; } } diff --git a/test/rules/ordered-imports/import-sources-any/test.ts.fix b/test/rules/ordered-imports/import-sources-any/default/test.ts.fix similarity index 100% rename from test/rules/ordered-imports/import-sources-any/test.ts.fix rename to test/rules/ordered-imports/import-sources-any/default/test.ts.fix diff --git a/test/rules/ordered-imports/import-sources-any/test.ts.lint b/test/rules/ordered-imports/import-sources-any/default/test.ts.lint similarity index 100% rename from test/rules/ordered-imports/import-sources-any/test.ts.lint rename to test/rules/ordered-imports/import-sources-any/default/test.ts.lint diff --git a/test/rules/ordered-imports/import-sources-any/tslint.json b/test/rules/ordered-imports/import-sources-any/default/tslint.json similarity index 100% rename from test/rules/ordered-imports/import-sources-any/tslint.json rename to test/rules/ordered-imports/import-sources-any/default/tslint.json diff --git a/test/rules/ordered-imports/import-sources-any/grouped-imports/test.ts.fix b/test/rules/ordered-imports/import-sources-any/grouped-imports/test.ts.fix new file mode 100644 index 00000000000..c50e6025a06 --- /dev/null +++ b/test/rules/ordered-imports/import-sources-any/grouped-imports/test.ts.fix @@ -0,0 +1,5 @@ +import { getOr } from 'lodash/fp' +import { Request } from 'express' + +import { getStatusCode } from './errors' + diff --git a/test/rules/ordered-imports/import-sources-any/grouped-imports/test.ts.lint b/test/rules/ordered-imports/import-sources-any/grouped-imports/test.ts.lint new file mode 100644 index 00000000000..302d6943c30 --- /dev/null +++ b/test/rules/ordered-imports/import-sources-any/grouped-imports/test.ts.lint @@ -0,0 +1,7 @@ +import { getOr } from 'lodash/fp' + +import { Request } from 'express' +import { getStatusCode } from './errors' +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [grouped-imports] + +[grouped-imports]: Import sources of different groups must be sorted by: libraries, parent directories, current directory. diff --git a/test/rules/ordered-imports/import-sources-any/grouped-imports/tslint.json b/test/rules/ordered-imports/import-sources-any/grouped-imports/tslint.json new file mode 100644 index 00000000000..c49cdb90188 --- /dev/null +++ b/test/rules/ordered-imports/import-sources-any/grouped-imports/tslint.json @@ -0,0 +1,5 @@ +{ + "rules": { + "ordered-imports": [true, {"import-sources-order": "any", "grouped-imports": true}] + } + } From 13bd582ed6e92ed6e47fc0f3e7c321bbd5eb7a9a Mon Sep 17 00:00:00 2001 From: Eric Anderson Date: Wed, 12 Dec 2018 13:32:30 -0500 Subject: [PATCH 20/60] Fix semantic merge break from #4374 and #3733 (#4378) --- .../import-sources-any/grouped-imports/test.ts.lint | 2 ++ 1 file changed, 2 insertions(+) diff --git a/test/rules/ordered-imports/import-sources-any/grouped-imports/test.ts.lint b/test/rules/ordered-imports/import-sources-any/grouped-imports/test.ts.lint index 302d6943c30..f79e866e859 100644 --- a/test/rules/ordered-imports/import-sources-any/grouped-imports/test.ts.lint +++ b/test/rules/ordered-imports/import-sources-any/grouped-imports/test.ts.lint @@ -1,7 +1,9 @@ import { getOr } from 'lodash/fp' import { Request } from 'express' +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [1] import { getStatusCode } from './errors' ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [grouped-imports] [grouped-imports]: Import sources of different groups must be sorted by: libraries, parent directories, current directory. +[1]: Import sources of the same type (package, same folder, different folder) must be grouped together. From a4ff1859996af35777c5ab6dfcb0f4e37d6585fc Mon Sep 17 00:00:00 2001 From: Peter Safranek Date: Wed, 12 Dec 2018 16:45:30 -0800 Subject: [PATCH 21/60] Add object literal sort option to account for special characters (#4193) * Add object literal sort option to account for special characters * Improve locale-compare tests --- src/rules/objectLiteralSortKeysRule.ts | 39 ++++++++++++++----- .../locale-compare/test.ts.lint | 12 ++++++ .../locale-compare/tslint.json | 5 +++ 3 files changed, 47 insertions(+), 9 deletions(-) create mode 100644 test/rules/object-literal-sort-keys/locale-compare/test.ts.lint create mode 100644 test/rules/object-literal-sort-keys/locale-compare/tslint.json diff --git a/src/rules/objectLiteralSortKeysRule.ts b/src/rules/objectLiteralSortKeysRule.ts index a38ab9e6ac3..f8bf6dc65bf 100644 --- a/src/rules/objectLiteralSortKeysRule.ts +++ b/src/rules/objectLiteralSortKeysRule.ts @@ -28,11 +28,13 @@ import * as Lint from "../index"; import { codeExamples } from "./code-examples/objectLiteralSortKeys.examples"; const OPTION_IGNORE_CASE = "ignore-case"; +const OPTION_LOCALE_COMPARE = "locale-compare"; const OPTION_MATCH_DECLARATION_ORDER = "match-declaration-order"; const OPTION_SHORTHAND_FIRST = "shorthand-first"; interface Options { ignoreCase: boolean; + localeCompare: boolean; matchDeclarationOrder: boolean; shorthandFirst: boolean; } @@ -53,6 +55,7 @@ export class Rule extends Lint.Rules.OptionallyTypedRule { The following may optionally be passed: * \`${OPTION_IGNORE_CASE}\` will compare keys in a case insensitive way. + * \`${OPTION_LOCALE_COMPARE}\` will compare keys using the expected sort order of special characters, such as accents. * \`${OPTION_MATCH_DECLARATION_ORDER}\` will prefer to use the key ordering of the contextual type of the object literal, as in: \`\`\` @@ -69,15 +72,26 @@ export class Rule extends Lint.Rules.OptionallyTypedRule { `, options: { type: "string", - enum: [OPTION_IGNORE_CASE, OPTION_MATCH_DECLARATION_ORDER, OPTION_SHORTHAND_FIRST], + enum: [ + OPTION_IGNORE_CASE, + OPTION_LOCALE_COMPARE, + OPTION_MATCH_DECLARATION_ORDER, + OPTION_SHORTHAND_FIRST + ] }, optionExamples: [ true, - [true, OPTION_IGNORE_CASE, OPTION_MATCH_DECLARATION_ORDER, OPTION_SHORTHAND_FIRST], + [ + true, + OPTION_IGNORE_CASE, + OPTION_LOCALE_COMPARE, + OPTION_MATCH_DECLARATION_ORDER, + OPTION_SHORTHAND_FIRST + ] ], type: "maintainability", typescriptOnly: false, - codeExamples, + codeExamples }; /* tslint:enable:object-literal-sort-keys */ @@ -112,7 +126,7 @@ export class Rule extends Lint.Rules.OptionallyTypedRule { sourceFile, walk, parseOptions(this.ruleArguments), - program.getTypeChecker(), + program.getTypeChecker() ); } } @@ -120,8 +134,9 @@ export class Rule extends Lint.Rules.OptionallyTypedRule { function parseOptions(ruleArguments: any[]): Options { return { ignoreCase: has(OPTION_IGNORE_CASE), + localeCompare: has(OPTION_LOCALE_COMPARE), matchDeclarationOrder: has(OPTION_MATCH_DECLARATION_ORDER), - shorthandFirst: has(OPTION_SHORTHAND_FIRST), + shorthandFirst: has(OPTION_SHORTHAND_FIRST) }; function has(name: string) { @@ -132,7 +147,7 @@ function parseOptions(ruleArguments: any[]): Options { function walk(ctx: Lint.WalkContext, checker?: ts.TypeChecker): void { const { sourceFile, - options: { ignoreCase, matchDeclarationOrder, shorthandFirst }, + options: { ignoreCase, localeCompare, matchDeclarationOrder, shorthandFirst } } = ctx; ts.forEachChild(sourceFile, function cb(node): void { @@ -207,10 +222,16 @@ function walk(ctx: Lint.WalkContext, checker?: ts.TypeChecker): void { ? property.name.text.toLowerCase() : property.name.text; // comparison with undefined is expected - if (lastKey! > key && !hasBlankLineBefore(ctx.sourceFile, property)) { + const keyOrderDescending = + lastKey === undefined + ? false + : localeCompare + ? lastKey.localeCompare(key) === 1 + : lastKey > key; + if (keyOrderDescending && !hasBlankLineBefore(ctx.sourceFile, property)) { ctx.addFailureAtNode( property.name, - Rule.FAILURE_STRING_ALPHABETICAL(property.name.text), + Rule.FAILURE_STRING_ALPHABETICAL(property.name.text) ); return; // only show warning on first out-of-order property } @@ -223,7 +244,7 @@ function walk(ctx: Lint.WalkContext, checker?: ts.TypeChecker): void { function checkMatchesDeclarationOrder( { properties }: ts.ObjectLiteralExpression, type: TypeLike, - members: ReadonlyArray<{ name: ts.PropertyName }>, + members: ReadonlyArray<{ name: ts.PropertyName }> ): void { let memberIndex = 0; outer: for (const prop of properties) { diff --git a/test/rules/object-literal-sort-keys/locale-compare/test.ts.lint b/test/rules/object-literal-sort-keys/locale-compare/test.ts.lint new file mode 100644 index 00000000000..df4899f4926 --- /dev/null +++ b/test/rules/object-literal-sort-keys/locale-compare/test.ts.lint @@ -0,0 +1,12 @@ +const a = { + autor: 1, + título: 2, + type: 3 +} + +const b = { + autor: 1, + type: 3, + título: 2 + ~~~~~~ [The key 'título' is not sorted alphabetically] +} diff --git a/test/rules/object-literal-sort-keys/locale-compare/tslint.json b/test/rules/object-literal-sort-keys/locale-compare/tslint.json new file mode 100644 index 00000000000..43f902bfea3 --- /dev/null +++ b/test/rules/object-literal-sort-keys/locale-compare/tslint.json @@ -0,0 +1,5 @@ +{ + "rules": { + "object-literal-sort-keys": [true, "locale-compare"] + } +} From bfb673e49001f33895e1dbccf00f2d0232e6a8ab Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Wed, 12 Dec 2018 16:46:12 -0800 Subject: [PATCH 22/60] Added no-unnecessary-constructor rule (#3647) * Added no-unnecessary-constructor rule * Feedback: all.ts array; no fixer; no parameter allowances * Added missing tests for overload and constructor signatures * Renamed to unnecessary-constructor * Added missing 'add' --- src/configs/all.ts | 1 + src/rules/unnecessaryConstructorRule.ts | 72 ++++++++++++++++++ .../unnecessary-constructor/test.ts.lint | 76 +++++++++++++++++++ .../rules/unnecessary-constructor/tslint.json | 5 ++ 4 files changed, 154 insertions(+) create mode 100644 src/rules/unnecessaryConstructorRule.ts create mode 100644 test/rules/unnecessary-constructor/test.ts.lint create mode 100644 test/rules/unnecessary-constructor/tslint.json diff --git a/src/configs/all.ts b/src/configs/all.ts index dec41525ec8..bd4d1ba58db 100644 --- a/src/configs/all.ts +++ b/src/configs/all.ts @@ -144,6 +144,7 @@ export const rules = { "strict-type-predicates": true, "switch-default": true, "triple-equals": true, + "unnecessary-constructor": true, "use-default-type-parameter": true, "use-isnan": true, diff --git a/src/rules/unnecessaryConstructorRule.ts b/src/rules/unnecessaryConstructorRule.ts new file mode 100644 index 00000000000..34c63f9945f --- /dev/null +++ b/src/rules/unnecessaryConstructorRule.ts @@ -0,0 +1,72 @@ +/** + * @license + * Copyright 2017 Palantir Technologies, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { isConstructorDeclaration, isParameterProperty } from "tsutils"; +import * as ts from "typescript"; + +import * as Lint from "../index"; + +export class Rule extends Lint.Rules.AbstractRule { + public static metadata: Lint.IRuleMetadata = { + description: "Prevents blank constructors, as they are redundant.", + optionExamples: [true], + options: null, + optionsDescription: "Not configurable.", + rationale: Lint.Utils.dedent` + JavaScript implicitly adds a blank constructor when there isn't one. + It's not necessary to manually add one in. + `, + ruleName: "unnecessary-constructor", + type: "functionality", + typescriptOnly: false, + }; + + public static FAILURE_STRING = "Remove unnecessary empty constructor."; + + public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] { + return this.applyWithFunction(sourceFile, walk); + } +} + +const isEmptyConstructor = (node: ts.ConstructorDeclaration): boolean => + node.body !== undefined && node.body.statements.length === 0; + +const containsConstructorParameter = (node: ts.ConstructorDeclaration): boolean => { + for (const parameter of node.parameters) { + if (isParameterProperty(parameter)) { + return true; + } + } + + return false; +}; + +function walk(context: Lint.WalkContext) { + const callback = (node: ts.Node): void => { + if ( + isConstructorDeclaration(node) && + isEmptyConstructor(node) && + !containsConstructorParameter(node) + ) { + context.addFailureAtNode(node, Rule.FAILURE_STRING); + } else { + ts.forEachChild(node, callback); + } + }; + + return ts.forEachChild(context.sourceFile, callback); +} diff --git a/test/rules/unnecessary-constructor/test.ts.lint b/test/rules/unnecessary-constructor/test.ts.lint new file mode 100644 index 00000000000..9e700464694 --- /dev/null +++ b/test/rules/unnecessary-constructor/test.ts.lint @@ -0,0 +1,76 @@ +export class ExportedClass { + constructor() { } + ~~~~~~~~~~~~~~~~~ [0] +} + +class PublicConstructor { + public constructor() { } + ~~~~~~~~~~~~~~~~~~~~~~~~ [0] +} + +class ProtectedConstructor { + protected constructor() { } + ~~~~~~~~~~~~~~~~~~~~~~~~~~~ [0] +} + +class PrivateConstructor { + private constructor() { } + ~~~~~~~~~~~~~~~~~~~~~~~~~ [0] +} + +class SameLine { constructor() { } } + ~~~~~~~~~~~~~~~~~ [0] + +class WithPrecedingMember { + public member: string; + constructor() {} + ~~~~~~~~~~~~~~~~ [0] +} + +class WithFollowingMethod { + constructor() {} + ~~~~~~~~~~~~~~~~ [0] + public method() {} +} + +const classExpression = class { + constructor() { } + ~~~~~~~~~~~~~~~~~ [0] +} + +class ContainsContents { + constructor() { + console.log("Hello!"); + } +} + +class CallsSuper extends PublicConstructor { + constructor() { + super(); + } +} + +class ContainsParameter { + constructor(x: number) { } + ~~~~~~~~~~~~~~~~~~~~~~~~~~ [0] +} + +class ContainsParameterDeclaration { + constructor(public x: number) { } +} + +class ContainsParameterAndParameterDeclaration { + constructor(x: number, public y: number) { } +} + +class ConstructorOverload { + constructor(x: number); + constructor(x: number, y?: number) { } + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [0] +} + +interface IConstructorSignature { + new(): {}; +} + +[0]: Remove unnecessary empty constructor. diff --git a/test/rules/unnecessary-constructor/tslint.json b/test/rules/unnecessary-constructor/tslint.json new file mode 100644 index 00000000000..53a2dfbba1b --- /dev/null +++ b/test/rules/unnecessary-constructor/tslint.json @@ -0,0 +1,5 @@ +{ + "rules": { + "unnecessary-constructor": true + } +} From 198bb5acb31597f27bc99f1f28da1139407828e3 Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Wed, 12 Dec 2018 16:54:27 -0800 Subject: [PATCH 23/60] Added function-constructor rule (#4198) * Added function-constructor rule Blocks using the `Function()`/`new Function()` methods to create new functions. Fixes #3554. * Lint fixups --- src/configs/all.ts | 1 + src/configs/recommended.ts | 1 + .../functionConstructor.examples.ts | 45 ++++++++++++ src/rules/functionConstructorRule.ts | 73 +++++++++++++++++++ test/rules/function-constructor/test.ts.lint | 19 +++++ test/rules/function-constructor/tslint.json | 5 ++ 6 files changed, 144 insertions(+) create mode 100644 src/rules/code-examples/functionConstructor.examples.ts create mode 100644 src/rules/functionConstructorRule.ts create mode 100644 test/rules/function-constructor/test.ts.lint create mode 100644 test/rules/function-constructor/tslint.json diff --git a/src/configs/all.ts b/src/configs/all.ts index bd4d1ba58db..bb75db71b73 100644 --- a/src/configs/all.ts +++ b/src/configs/all.ts @@ -99,6 +99,7 @@ export const rules = { "ban-comma-operator": true, curly: true, forin: true, + "function-constructor": true, // "import-blacklist": no sensible default "label-position": true, "no-arg": true, diff --git a/src/configs/recommended.ts b/src/configs/recommended.ts index b918e6aa6e5..7314eea224d 100644 --- a/src/configs/recommended.ts +++ b/src/configs/recommended.ts @@ -47,6 +47,7 @@ export const rules = { "cyclomatic-complexity": false, eofline: true, forin: true, + "function-constructor": true, "import-spacing": true, indent: { options: ["spaces"], diff --git a/src/rules/code-examples/functionConstructor.examples.ts b/src/rules/code-examples/functionConstructor.examples.ts new file mode 100644 index 00000000000..47b222b5595 --- /dev/null +++ b/src/rules/code-examples/functionConstructor.examples.ts @@ -0,0 +1,45 @@ +/** + * @license + * Copyright 2013 Palantir Technologies, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import * as Lint from "../../index"; + +export const codeExamples = [ + { + config: Lint.Utils.dedent` + "rules": { "function-constructor": true } + `, + description: "Use inline lambdas instead of calling Function", + fail: Lint.Utils.dedent` + let doesNothing = new Function(); + `, + pass: Lint.Utils.dedent` + let doesNothing = () => {}; + ` + }, + { + config: Lint.Utils.dedent` + "rules": { "function-constructor": true } + `, + description: "Use parameters instead of constructor strings", + fail: Lint.Utils.dedent` + let addNumbers = new Function("a", "b", "return a + b"); + `, + pass: Lint.Utils.dedent` + let addNumbers = (a, b) => a + b; + ` + } +]; diff --git a/src/rules/functionConstructorRule.ts b/src/rules/functionConstructorRule.ts new file mode 100644 index 00000000000..eacbb928dac --- /dev/null +++ b/src/rules/functionConstructorRule.ts @@ -0,0 +1,73 @@ +/** + * @license + * Copyright 2013 Palantir Technologies, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { isCallExpression, isIdentifier, isNewExpression } from "tsutils"; +import * as ts from "typescript"; + +import * as Lint from ".."; +import { codeExamples } from "./code-examples/functionConstructor.examples"; + +export class Rule extends Lint.Rules.AbstractRule { + public static metadata: Lint.IRuleMetadata = { + codeExamples, + description: Lint.Utils.dedent` + Prevents using the built-in Function constructor. + `, + optionExamples: [true], + options: null, + optionsDescription: "Not configurable.", + rationale: Lint.Utils.dedent` + Calling the constructor directly is similar to \`eval\`, which is a symptom of design issues. + String inputs don't receive type checking and can cause performance issues, particularly when dynamically created. + + If you need to dynamically create functions, use "factory" functions that themselves return functions. + `, + ruleName: "function-constructor", + type: "functionality", + typescriptOnly: false + }; + + public static FAILURE = "Do not use the Function constructor to create functions."; + + public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] { + return this.applyWithFunction(sourceFile, walk); + } +} + +function walk(context: Lint.WalkContext): void { + ts.forEachChild(context.sourceFile, function cb(node): void { + if (isFunctionCallOrNewExpression(node)) { + addFailureAtNode(node); + } + + ts.forEachChild(node, cb); + }); + + function addFailureAtNode(node: CallOrNewExpression) { + context.addFailureAtNode(node, Rule.FAILURE); + } +} + +function isFunctionCallOrNewExpression(node: ts.Node): node is CallOrNewExpression { + if (isCallExpression(node) || isNewExpression(node)) { + return isIdentifier(node.expression) && node.expression.text === "Function"; + } + + return false; +} + +type CallOrNewExpression = ts.CallExpression | ts.NewExpression; diff --git a/test/rules/function-constructor/test.ts.lint b/test/rules/function-constructor/test.ts.lint new file mode 100644 index 00000000000..cc2f3829427 --- /dev/null +++ b/test/rules/function-constructor/test.ts.lint @@ -0,0 +1,19 @@ +function one() { } +const two = function () { }; +const three = () => {}; + +const noParametersNew = Function(); + ~~~~~~~~~~ [0] +const oneParameterNew = Function("a"); + ~~~~~~~~~~~~~ [0] +const twoParametersNew = Function("a", "b"); + ~~~~~~~~~~~~~~~~~~ [0] + +const noParametersNew = new Function(); + ~~~~~~~~~~~~~~ [0] +const oneParameterNew = new Function("a"); + ~~~~~~~~~~~~~~~~~ [0] +const twoParametersNew = new Function("a", "b"); + ~~~~~~~~~~~~~~~~~~~~~~ [0] + +[0]: Do not use the Function constructor to create functions. diff --git a/test/rules/function-constructor/tslint.json b/test/rules/function-constructor/tslint.json new file mode 100644 index 00000000000..9f48491ff28 --- /dev/null +++ b/test/rules/function-constructor/tslint.json @@ -0,0 +1,5 @@ +{ + "rules": { + "function-constructor": true + } +} From c7fc99b58e5525642fd198114f4ac4415975becd Mon Sep 17 00:00:00 2001 From: Bowen Ni Date: Fri, 14 Dec 2018 16:07:58 -0800 Subject: [PATCH 24/60] Upgrade TSLint to support TS 3.1 (#4274) * Upgrade TSLint so it supports TS 3.1 * Fix lint errors. * Changes the node version from 4 to 6 for TS 2.1 tests. Node 4 is no longer supported. Unblocks https://github.com/palantir/tslint/pull/4274 * Revert tsutils upgrade. * Revert unrelated yarn.lock changes --- package.json | 2 +- src/language/utils.ts | 21 +++++----- src/rules/arrayTypeRule.ts | 2 +- src/rules/arrowReturnShorthandRule.ts | 2 +- src/rules/banCommaOperatorRule.ts | 2 +- src/rules/callableTypesRule.ts | 2 +- .../functionConstructor.examples.ts | 6 +-- src/rules/completed-docs/tagExclusion.ts | 2 +- src/rules/completedDocsRule.ts | 6 +-- src/rules/curlyRule.ts | 2 +- src/rules/cyclomaticComplexityRule.ts | 6 ++- src/rules/deprecationRule.ts | 16 ++++---- src/rules/functionConstructorRule.ts | 2 +- src/rules/importBlacklistRule.ts | 32 +++++++-------- src/rules/noAngleBracketTypeAssertionRule.ts | 2 +- src/rules/noDefaultImportRule.ts | 40 +++++++++++++------ src/rules/noDuplicateSuperRule.ts | 4 +- src/rules/noDuplicateVariableRule.ts | 6 ++- src/rules/noEmptyRule.ts | 2 +- src/rules/noInvalidThisRule.ts | 5 ++- src/rules/noMagicNumbersRule.ts | 2 +- src/rules/noNullKeywordRule.ts | 2 +- src/rules/noObjectLiteralTypeAssertionRule.ts | 6 +-- src/rules/noParameterReassignmentRule.ts | 2 +- src/rules/noRequireImportsRule.ts | 2 +- src/rules/noReturnAwaitRule.ts | 12 ++++-- src/rules/noShadowedVariableRule.ts | 10 ++--- src/rules/noStringThrowRule.ts | 2 +- src/rules/noUnboundMethodRule.ts | 2 +- src/rules/noUnnecessaryInitializerRule.ts | 2 +- src/rules/noUnsafeAnyRule.ts | 6 ++- src/rules/noUnsafeFinallyRule.ts | 8 +++- src/rules/noUnusedExpressionRule.ts | 11 ++--- src/rules/noVarKeywordRule.ts | 6 +-- src/rules/noVoidExpressionRule.ts | 4 +- src/rules/objectLiteralShorthandRule.ts | 2 +- src/rules/objectLiteralSortKeysRule.ts | 22 +++++----- src/rules/oneLineRule.ts | 4 +- src/rules/orderedImportsRule.ts | 11 +++-- src/rules/preferConstRule.ts | 12 +++--- src/rules/preferForOfRule.ts | 2 +- src/rules/preferFunctionOverMethodRule.ts | 6 +-- src/rules/preferObjectSpreadRule.ts | 2 +- src/rules/preferReadonlyRule.ts | 8 +++- src/rules/quotemarkRule.ts | 4 +- src/rules/semicolonRule.ts | 12 +++--- src/rules/switchFinalBreakRule.ts | 2 +- src/rules/typedefRule.ts | 14 +++---- src/rules/unnecessaryBindRule.ts | 8 ++-- src/rules/variableNameRule.ts | 2 +- src/rules/whitespaceRule.ts | 2 +- src/utils.ts | 37 +++++++++++++++++ yarn.lock | 8 ++-- 53 files changed, 238 insertions(+), 159 deletions(-) diff --git a/package.json b/package.json index 485ac2b8a0b..daf86d04cdc 100644 --- a/package.json +++ b/package.json @@ -83,7 +83,7 @@ "tslint": "^5.8.0", "tslint-config-prettier": "^1.13.0", "tslint-test-config-non-relative": "file:test/external/tslint-test-config-non-relative", - "typescript": "~2.9.2" + "typescript": "~3.1.6" }, "license": "Apache-2.0", "engines": { diff --git a/src/language/utils.ts b/src/language/utils.ts index 71fe23c91da..9160d82b508 100644 --- a/src/language/utils.ts +++ b/src/language/utils.ts @@ -74,7 +74,7 @@ export function isBlockScopedVariable( node: ts.VariableDeclaration | ts.VariableStatement, ): boolean { if (node.kind === ts.SyntaxKind.VariableDeclaration) { - const parent = node.parent!; + const parent = node.parent; return ( parent.kind === ts.SyntaxKind.CatchClause || isBlockScopedVariableDeclarationList(parent) @@ -95,7 +95,7 @@ export function isBlockScopedBindingElement(node: ts.BindingElement): boolean { export function getBindingElementVariableDeclaration( node: ts.BindingElement, ): ts.VariableDeclaration | null { - let currentParent = node.parent! as ts.Node; + let currentParent = node.parent as ts.Node; while (currentParent.kind !== ts.SyntaxKind.VariableDeclaration) { if (currentParent.parent === undefined) { return null; // function parameter, no variable declaration @@ -177,7 +177,10 @@ export function isCombinedNodeFlagSet(node: ts.Node, flagToCheck: ts.NodeFlags): * * @deprecated no longer used */ -export function isCombinedModifierFlagSet(node: ts.Node, flagToCheck: ts.ModifierFlags): boolean { +export function isCombinedModifierFlagSet( + node: ts.Declaration, + flagToCheck: ts.ModifierFlags, +): boolean { // tslint:disable-next-line:no-bitwise return (ts.getCombinedModifierFlags(node) & flagToCheck) !== 0; } @@ -378,7 +381,7 @@ export function forEachToken( fullText, token.kind, { tokenStart, fullStart: token.pos, end: token.end }, - token.parent!, + token.parent, ); } } @@ -396,7 +399,7 @@ function createTriviaHandler(sourceFile: ts.SourceFile, cb: ForEachTokenCallback * This includes trailing trivia of the last token and the leading trivia of the current token */ function handleTrivia(start: number, end: number, token: ts.Node) { - const parent = token.parent!; + const parent = token.parent; // prevent false positives by not scanning inside JsxText if (!canHaveLeadingTrivia(token.kind, parent)) { return; @@ -471,7 +474,7 @@ function canHaveLeadingTrivia(tokenKind: ts.SyntaxKind, parent: ts.Node): boolea // before a JsxExpression inside a JsxElement's body can only be other JsxChild, but no trivia return ( parent.kind !== ts.SyntaxKind.JsxExpression || - parent.parent!.kind !== ts.SyntaxKind.JsxElement + parent.parent.kind !== ts.SyntaxKind.JsxElement ); case ts.SyntaxKind.LessThanToken: @@ -481,7 +484,7 @@ function canHaveLeadingTrivia(tokenKind: ts.SyntaxKind, parent: ts.Node): boolea case ts.SyntaxKind.JsxOpeningElement: case ts.SyntaxKind.JsxSelfClosingElement: // there can only be leading trivia if we are at the end of the top level element - return parent.parent!.parent!.kind !== ts.SyntaxKind.JsxElement; + return parent.parent.parent.kind !== ts.SyntaxKind.JsxElement; default: return true; } @@ -502,7 +505,7 @@ function canHaveTrailingTrivia(tokenKind: ts.SyntaxKind, parent: ts.Node): boole // after a JsxExpression inside a JsxElement's body can only be other JsxChild, but no trivia return ( parent.kind !== ts.SyntaxKind.JsxExpression || - parent.parent!.kind !== ts.SyntaxKind.JsxElement + parent.parent.kind !== ts.SyntaxKind.JsxElement ); case ts.SyntaxKind.GreaterThanToken: @@ -512,7 +515,7 @@ function canHaveTrailingTrivia(tokenKind: ts.SyntaxKind, parent: ts.Node): boole case ts.SyntaxKind.JsxClosingElement: case ts.SyntaxKind.JsxSelfClosingElement: // there can only be trailing trivia if we are at the end of the top level element - return parent.parent!.parent!.kind !== ts.SyntaxKind.JsxElement; + return parent.parent.parent.kind !== ts.SyntaxKind.JsxElement; default: return true; diff --git a/src/rules/arrayTypeRule.ts b/src/rules/arrayTypeRule.ts index a49abcf6c99..92804c9fa15 100644 --- a/src/rules/arrayTypeRule.ts +++ b/src/rules/arrayTypeRule.ts @@ -85,7 +85,7 @@ function walk(ctx: Lint.WalkContext