2017-05-28 00:38:50 +02:00
"use strict" ;
/ * *
* @ license
* Copyright 2015 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" ) ;
2017-12-10 21:51:33 +01:00
var tsutils _1 = require ( "tsutils" ) ;
2017-05-28 00:38:50 +02:00
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 ) {
2017-12-10 21:51:33 +01:00
return this . applyWithFunction ( sourceFile , walk ) ;
2017-05-28 00:38:50 +02:00
} ;
2017-08-14 05:01:11 +02:00
/* tslint:disable:object-literal-sort-keys */
Rule . metadata = {
ruleName : "no-conditional-assignment" ,
description : "Disallows any type of assignment in conditionals." ,
2017-12-10 21:51:33 +01:00
descriptionDetails : "This applies to `do-while`, `for`, `if`, and `while` statements and conditional (ternary) expressions." ,
2017-08-14 05:01:11 +02:00
rationale : ( _a = [ "\n Assignments in conditionals are often typos:\n for example `if (var1 = var2)` instead of `if (var1 == var2)`.\n They also can be an indicator of overly clever code which decreases maintainability." ] , _a . raw = [ "\n Assignments in conditionals are often typos:\n for example \\`if (var1 = var2)\\` instead of \\`if (var1 == var2)\\`.\n They also can be an indicator of overly clever code which decreases maintainability." ] , Lint . Utils . dedent ( _a ) ) ,
optionsDescription : "Not configurable." ,
options : null ,
optionExamples : [ true ] ,
type : "functionality" ,
typescriptOnly : false ,
} ;
/* tslint:enable:object-literal-sort-keys */
Rule . FAILURE _STRING = "Assignments in conditional expressions are forbidden" ;
2017-05-28 00:38:50 +02:00
return Rule ;
} ( Lint . Rules . AbstractRule ) ) ;
exports . Rule = Rule ;
2017-12-10 21:51:33 +01:00
function walk ( ctx ) {
var checking = 0 ;
return ts . forEachChild ( ctx . sourceFile , cb ) ;
function cb ( node ) {
var kind = node . kind ;
if ( ! tsutils _1 . isNodeKind ( kind ) ) {
return ; // return early for tokens
2017-05-28 00:38:50 +02:00
}
2017-12-10 21:51:33 +01:00
switch ( kind ) {
case ts . SyntaxKind . ConditionalExpression :
check ( node . condition ) ;
cb ( node . whenTrue ) ;
cb ( node . whenFalse ) ;
return ;
case ts . SyntaxKind . IfStatement :
check ( node . expression ) ;
cb ( node . thenStatement ) ;
maybeCallback ( cb , node . elseStatement ) ;
return ;
case ts . SyntaxKind . DoStatement :
case ts . SyntaxKind . WhileStatement :
check ( node . expression ) ;
cb ( node . statement ) ;
return ;
case ts . SyntaxKind . ForStatement :
maybeCallback ( cb , node . initializer ) ;
maybeCallback ( check , node . condition ) ;
maybeCallback ( cb , node . incrementor ) ;
cb ( node . statement ) ;
return ;
2017-05-28 00:38:50 +02:00
}
2017-12-10 21:51:33 +01:00
if ( checking !== 0 ) {
switch ( kind ) {
case ts . SyntaxKind . BinaryExpression :
if ( tsutils _1 . isAssignmentKind ( node . operatorToken . kind ) ) {
ctx . addFailureAtNode ( node , Rule . FAILURE _STRING ) ;
}
cb ( node . left ) ;
cb ( node . right ) ;
return ;
case ts . SyntaxKind . ParenthesizedExpression :
case ts . SyntaxKind . NonNullExpression :
case ts . SyntaxKind . AsExpression :
case ts . SyntaxKind . TypeAssertionExpression :
return cb ( node . expression ) ;
case ts . SyntaxKind . PrefixUnaryExpression :
return cb ( node . operand ) ;
default :
return noCheck ( node ) ;
}
2017-05-28 00:38:50 +02:00
}
2017-12-10 21:51:33 +01:00
return ts . forEachChild ( node , cb ) ;
}
function check ( node ) {
++ checking ;
cb ( node ) ;
-- checking ;
}
function noCheck ( node ) {
var old = checking ;
checking = 0 ;
ts . forEachChild ( node , cb ) ;
checking = old ;
}
}
function maybeCallback ( cb , node ) {
if ( node !== undefined ) {
cb ( node ) ;
}
2017-05-28 00:38:50 +02:00
}
var _a ;