-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into no-misused-promises
- Loading branch information
Showing
13 changed files
with
1,396 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
57 changes: 57 additions & 0 deletions
57
packages/eslint-plugin/docs/rules/strict-boolean-expressions.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| # Boolean expressions are limited to booleans (strict-boolean-expressions) | ||
|
|
||
| Requires that any boolean expression is limited to true booleans rather than | ||
| casting another primitive to a boolean at runtime. | ||
|
|
||
| It is useful to be explicit, for example, if you were trying to check if a | ||
| number was defined. Doing `if (number)` would evaluate to `false` if `number` | ||
| was defined and `0`. This rule forces these expressions to be explicit and to | ||
| strictly use booleans. | ||
|
|
||
| The following nodes are checked: | ||
|
|
||
| - Arguments to the `!`, `&&`, and `||` operators | ||
| - The condition in a conditional expression `(cond ? x : y)` | ||
| - Conditions for `if`, `for`, `while`, and `do-while` statements. | ||
|
|
||
| Examples of **incorrect** code for this rule: | ||
|
|
||
| ```ts | ||
| const number = 0; | ||
| if (number) { | ||
| return; | ||
| } | ||
|
|
||
| let foo = bar || 'foobar'; | ||
|
|
||
| let undefinedItem; | ||
| let foo = undefinedItem ? 'foo' : 'bar'; | ||
|
|
||
| let str = 'foo'; | ||
| while (str) { | ||
| break; | ||
| } | ||
| ``` | ||
|
|
||
| Examples of **correct** code for this rule: | ||
|
|
||
| ```ts | ||
| const number = 0; | ||
| if (typeof number !== 'undefined') { | ||
| return; | ||
| } | ||
|
|
||
| let foo = typeof bar !== 'undefined' ? bar : 'foobar'; | ||
|
|
||
| let undefinedItem; | ||
| let foo = typeof undefinedItem !== 'undefined' ? 'foo' : 'bar'; | ||
|
|
||
| let str = 'foo'; | ||
| while (typeof str !== 'undefined') { | ||
| break; | ||
| } | ||
| ``` | ||
|
|
||
| ## Related To | ||
|
|
||
| - TSLint: [strict-boolean-expressions](https://palantir.github.io/tslint/rules/strict-boolean-expressions) |
58 changes: 58 additions & 0 deletions
58
packages/eslint-plugin/docs/rules/triple-slash-reference.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| # Sets preference level for triple slash directives versus ES6-style import declarations. (triple-slash-reference) | ||
|
|
||
| Use of triple-slash reference type directives is discouraged in favor of the newer `import` style. This rule allows you to ban use of `/// <reference path="" />`, `/// <reference types="" />`, or `/// <reference lib="" />` directives. | ||
|
|
||
| Consider using this rule in place of [`no-triple-slash-reference`](./no-triple-slash-reference.md) which has been deprecated. | ||
|
|
||
| ## Rule Details | ||
|
|
||
| With `{ "path": "never", "types": "never", "lib": "never" }` options set, the following will all be **incorrect** usage: | ||
|
|
||
| ```ts | ||
| /// <reference path="foo" /> | ||
| /// <reference types="bar" /> | ||
| /// <reference lib="baz" /> | ||
| ``` | ||
|
|
||
| Examples of **incorrect** code for the `{ "types": "prefer-import" }` option. Note that these are only errors when **both** stlyes are used for the **same** module: | ||
|
|
||
| ```ts | ||
| /// <reference types="foo" /> | ||
| import * as foo from 'foo'; | ||
| ``` | ||
|
|
||
| ```ts | ||
| /// <reference types="foo" /> | ||
| import foo = require('foo'); | ||
| ``` | ||
|
|
||
| With `{ "path": "always", "types": "always", "lib": "always" }` options set, the following will all be **correct** usage: | ||
|
|
||
| ```ts | ||
| /// <reference path="foo" /> | ||
| /// <reference types="bar" /> | ||
| /// <reference lib="baz" /> | ||
| ``` | ||
|
|
||
| Examples of **correct** code for the `{ "types": "prefer-import" }` option: | ||
|
|
||
| ```ts | ||
| import * as foo from 'foo'; | ||
| ``` | ||
|
|
||
| ```ts | ||
| import foo = require('foo'); | ||
| ``` | ||
|
|
||
| ## When To Use It | ||
|
|
||
| If you want to ban use of one or all of the triple slash reference directives, or any time you might use triple-slash type reference directives and ES6 import declarations in the same file. | ||
|
|
||
| ## When Not To Use It | ||
|
|
||
| If you want to use all flavors of triple slash reference directives. | ||
|
|
||
| ## Compatibility | ||
|
|
||
| - TSLint: [no-reference](http://palantir.github.io/tslint/rules/no-reference/) | ||
| - TSLint: [no-reference-import](https://palantir.github.io/tslint/rules/no-reference-import/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
101 changes: 101 additions & 0 deletions
101
packages/eslint-plugin/src/rules/strict-boolean-expressions.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| import { | ||
| TSESTree, | ||
| AST_NODE_TYPES, | ||
| } from '@typescript-eslint/experimental-utils'; | ||
| import ts from 'typescript'; | ||
| import * as tsutils from 'tsutils'; | ||
| import * as util from '../util'; | ||
|
|
||
| type ExpressionWithTest = | ||
| | TSESTree.ConditionalExpression | ||
| | TSESTree.DoWhileStatement | ||
| | TSESTree.ForStatement | ||
| | TSESTree.IfStatement | ||
| | TSESTree.WhileStatement; | ||
|
|
||
| export default util.createRule({ | ||
| name: 'strict-boolean-expressions', | ||
| meta: { | ||
| type: 'suggestion', | ||
| docs: { | ||
| description: 'Restricts the types allowed in boolean expressions', | ||
| category: 'Best Practices', | ||
| recommended: false, | ||
| }, | ||
| schema: [], | ||
| messages: { | ||
| strictBooleanExpression: 'Unexpected non-boolean in conditional.', | ||
| }, | ||
| }, | ||
| defaultOptions: [], | ||
| create(context) { | ||
| const service = util.getParserServices(context); | ||
| const checker = service.program.getTypeChecker(); | ||
|
|
||
| /** | ||
| * Determines if the node has a boolean type. | ||
| */ | ||
| function isBooleanType(node: TSESTree.Node): boolean { | ||
| const tsNode = service.esTreeNodeToTSNodeMap.get<ts.ExpressionStatement>( | ||
| node, | ||
| ); | ||
| const type = util.getConstrainedTypeAtLocation(checker, tsNode); | ||
| return tsutils.isTypeFlagSet(type, ts.TypeFlags.BooleanLike); | ||
| } | ||
|
|
||
| /** | ||
| * Asserts that a testable expression contains a boolean, reports otherwise. | ||
| * Filters all LogicalExpressions to prevent some duplicate reports. | ||
| */ | ||
| function assertTestExpressionContainsBoolean( | ||
| node: ExpressionWithTest, | ||
| ): void { | ||
| if ( | ||
| node.test !== null && | ||
| node.test.type !== AST_NODE_TYPES.LogicalExpression && | ||
| !isBooleanType(node.test) | ||
| ) { | ||
| reportNode(node.test); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Asserts that a logical expression contains a boolean, reports otherwise. | ||
| */ | ||
| function assertLocalExpressionContainsBoolean( | ||
| node: TSESTree.LogicalExpression, | ||
| ): void { | ||
| if (!isBooleanType(node.left) || !isBooleanType(node.right)) { | ||
| reportNode(node); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Asserts that a unary expression contains a boolean, reports otherwise. | ||
| */ | ||
| function assertUnaryExpressionContainsBoolean( | ||
| node: TSESTree.UnaryExpression, | ||
| ): void { | ||
| if (!isBooleanType(node.argument)) { | ||
| reportNode(node.argument); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Reports an offending node in context. | ||
| */ | ||
| function reportNode(node: TSESTree.Node): void { | ||
| context.report({ node, messageId: 'strictBooleanExpression' }); | ||
| } | ||
|
|
||
| return { | ||
| ConditionalExpression: assertTestExpressionContainsBoolean, | ||
| DoWhileStatement: assertTestExpressionContainsBoolean, | ||
| ForStatement: assertTestExpressionContainsBoolean, | ||
| IfStatement: assertTestExpressionContainsBoolean, | ||
| WhileStatement: assertTestExpressionContainsBoolean, | ||
| LogicalExpression: assertLocalExpressionContainsBoolean, | ||
| 'UnaryExpression[operator="!"]': assertUnaryExpressionContainsBoolean, | ||
| }; | ||
| }, | ||
| }); |
Oops, something went wrong.