2017-05-28 00:38:50 +02:00
"use strict" ;
/ * *
* @ 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 .
* /
Object . defineProperty ( exports , "__esModule" , { value : true } ) ;
var tslib _1 = require ( "tslib" ) ;
var tsutils _1 = require ( "tsutils" ) ;
var ts = require ( "typescript" ) ;
var Lint = require ( "../index" ) ;
var BAN _SINGLE _ARG _PARENS = "ban-single-arg-parens" ;
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 , {
banSingleArgParens : this . ruleArguments . indexOf ( BAN _SINGLE _ARG _PARENS ) !== - 1 ,
} ) ;
} ;
2017-08-14 05:01:11 +02:00
/* tslint:disable:object-literal-sort-keys */
Rule . metadata = {
ruleName : "arrow-parens" ,
description : "Requires parentheses around the parameters of arrow function definitions." ,
hasFix : true ,
rationale : "Maintains stylistic consistency with other arrow function definitions." ,
optionsDescription : ( _a = [ "\n If `" , "` is specified, then arrow functions with one parameter\n must not have parentheses if removing them is allowed by TypeScript." ] , _a . raw = [ "\n If \\`" , "\\` is specified, then arrow functions with one parameter\n must not have parentheses if removing them is allowed by TypeScript." ] , Lint . Utils . dedent ( _a , BAN _SINGLE _ARG _PARENS ) ) ,
options : {
type : "string" ,
enum : [ BAN _SINGLE _ARG _PARENS ] ,
} ,
optionExamples : [ true , [ true , BAN _SINGLE _ARG _PARENS ] ] ,
type : "style" ,
typescriptOnly : false ,
} ;
/* tslint:enable:object-literal-sort-keys */
Rule . FAILURE _STRING _MISSING = "Parentheses are required around the parameters of an arrow function definition" ;
Rule . FAILURE _STRING _EXISTS = "Parentheses are prohibited around the parameter in this single parameter arrow function" ;
2017-05-28 00:38:50 +02:00
return Rule ;
} ( Lint . Rules . AbstractRule ) ) ;
exports . Rule = Rule ;
function walk ( ctx ) {
function cb ( node ) {
if ( tsutils _1 . isArrowFunction ( node ) && parensAreOptional ( node ) ) {
var openParen = tsutils _1 . getChildOfKind ( node , ts . SyntaxKind . OpenParenToken ) ;
if ( openParen === undefined ) {
if ( ! ctx . options . banSingleArgParens ) {
var parameter = node . parameters [ 0 ] ;
var start = parameter . getStart ( ctx . sourceFile ) ;
var end = parameter . end ;
ctx . addFailure ( start , end , Rule . FAILURE _STRING _MISSING , [
Lint . Replacement . appendText ( start , "(" ) ,
Lint . Replacement . appendText ( end , ")" ) ,
] ) ;
}
}
else if ( ctx . options . banSingleArgParens ) {
var closeParen = tsutils _1 . getChildOfKind ( node , ts . SyntaxKind . CloseParenToken ) ;
ctx . addFailureAtNode ( node . parameters [ 0 ] , Rule . FAILURE _STRING _EXISTS , [
2017-12-10 21:51:33 +01:00
Lint . Replacement . replaceFromTo ( openParen . pos , node . parameters [ 0 ] . getStart ( ctx . sourceFile ) , " " ) ,
Lint . Replacement . deleteFromTo ( node . parameters [ 0 ] . end , closeParen . end ) ,
2017-05-28 00:38:50 +02:00
] ) ;
}
}
return ts . forEachChild ( node , cb ) ;
}
return ts . forEachChild ( ctx . sourceFile , cb ) ;
}
function parensAreOptional ( node ) {
return node . parameters . length === 1 &&
node . typeParameters === undefined &&
node . type === undefined &&
isSimpleParameter ( node . parameters [ 0 ] ) ;
}
function isSimpleParameter ( parameter ) {
return parameter . name . kind === ts . SyntaxKind . Identifier
&& parameter . dotDotDotToken === undefined
&& parameter . initializer === undefined
&& parameter . questionToken === undefined
&& parameter . type === undefined ;
}
var _a ;