2017-05-28 00:38:50 +02:00
"use strict" ;
/ * *
* @ 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 .
* /
Object . defineProperty ( exports , "__esModule" , { value : true } ) ;
var tslib _1 = require ( "tslib" ) ;
var tsutils _1 = require ( "tsutils" ) ;
var ts = require ( "typescript" ) ;
var Lint = require ( "../index" ) ;
2017-10-14 18:40:54 +02:00
var Rule = /** @class */ ( function ( _super ) {
2017-05-28 00:38:50 +02:00
tslib _1 . _ _extends ( Rule , _super ) ;
function Rule ( ) {
return _super !== null && _super . apply ( this , arguments ) || this ;
}
Rule . prototype . apply = function ( sourceFile ) {
return this . applyWithFunction ( sourceFile , walk ) ;
} ;
2017-08-14 05:01:11 +02:00
/* tslint:disable:object-literal-sort-keys */
Rule . metadata = {
ruleName : "use-isnan" ,
description : "Enforces use of the `isNaN()` function to check for NaN references instead of a comparison to the `NaN` constant." ,
2018-09-20 02:56:13 +02:00
rationale : Lint . Utils . dedent ( templateObject _1 || ( templateObject _1 = tslib _1 . _ _makeTemplateObject ( [ "\n Since `NaN !== NaN`, comparisons with regular operators will produce unexpected results.\n So, instead of `if (myVar === NaN)`, do `if (isNaN(myVar))`." ] , [ "\n Since \\`NaN !== NaN\\`, comparisons with regular operators will produce unexpected results.\n So, instead of \\`if (myVar === NaN)\\`, do \\`if (isNaN(myVar))\\`." ] ) ) ) ,
2017-08-14 05:01:11 +02:00
optionsDescription : "Not configurable." ,
options : null ,
optionExamples : [ true ] ,
type : "functionality" ,
typescriptOnly : false ,
} ;
/* tslint:enable:object-literal-sort-keys */
Rule . FAILURE _STRING = "Found an invalid comparison for NaN: " ;
2017-05-28 00:38:50 +02:00
return Rule ;
} ( Lint . Rules . AbstractRule ) ) ;
exports . Rule = Rule ;
function walk ( ctx ) {
return ts . forEachChild ( ctx . sourceFile , function cb ( node ) {
if ( tsutils _1 . isBinaryExpression ( node ) ) {
switch ( node . operatorToken . kind ) {
case ts . SyntaxKind . LessThanToken :
case ts . SyntaxKind . GreaterThanToken :
case ts . SyntaxKind . LessThanEqualsToken :
case ts . SyntaxKind . GreaterThanEqualsToken :
case ts . SyntaxKind . EqualsEqualsToken :
case ts . SyntaxKind . ExclamationEqualsToken :
case ts . SyntaxKind . EqualsEqualsEqualsToken :
case ts . SyntaxKind . ExclamationEqualsEqualsToken :
if ( isExpressionNaN ( node . right ) || isExpressionNaN ( node . left ) ) {
ctx . addFailureAtNode ( node , Rule . FAILURE _STRING + node . getText ( ctx . sourceFile ) ) ;
}
}
}
return ts . forEachChild ( node , cb ) ;
} ) ;
}
function isExpressionNaN ( node ) {
return node . kind === ts . SyntaxKind . Identifier && node . text === "NaN" ;
}
2018-09-20 02:56:13 +02:00
var templateObject _1 ;