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 ;
}
2018-09-20 02:56:13 +02:00
Rule . id = function ( input ) {
return input ;
} ;
2017-05-28 00:38:50 +02:00
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 : "no-string-literal" ,
2018-09-20 02:56:13 +02:00
description : Lint . Utils . dedent ( templateObject _1 || ( templateObject _1 = tslib _1 . _ _makeTemplateObject ( [ "\n Forbids unnecessary string literal property access.\n Allows `obj[\"prop-erty\"]` (can't be a regular property access).\n Disallows `obj[\"property\"]` (should be `obj.property`)." ] , [ "\n Forbids unnecessary string literal property access.\n Allows \\`obj[\"prop-erty\"]\\` (can't be a regular property access).\n Disallows \\`obj[\"property\"]\\` (should be \\`obj.property\\`)." ] ) ) ) ,
rationale : Lint . Utils . dedent ( templateObject _2 || ( templateObject _2 = tslib _1 . _ _makeTemplateObject ( [ "\n If `--noImplicitAny` is turned off,\n property access via a string literal will be 'any' if the property does not exist." ] , [ "\n If \\`--noImplicitAny\\` is turned off,\n property access via a string literal will be 'any' if the property does not exist." ] ) ) ) ,
2017-08-14 05:01:11 +02:00
optionsDescription : "Not configurable." ,
options : null ,
optionExamples : [ true ] ,
type : "functionality" ,
typescriptOnly : false ,
hasFix : true ,
} ;
/* tslint:enable:object-literal-sort-keys */
Rule . FAILURE _STRING = "object access via string literals is disallowed" ;
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 . isElementAccessExpression ( node ) ) {
var argument = node . argumentExpression ;
if ( argument !== undefined && tsutils _1 . isStringLiteral ( argument ) && tsutils _1 . isValidPropertyAccess ( argument . text ) ) {
2018-09-20 02:56:13 +02:00
// typescript@<2.5.0 has an extra underscore in escaped identifier text content,
// to avoid fixing issue `expr['__foo'] → expr.___foo`, unescapeIdentifier() is to be used
// As of typescript@3, unescapeIdentifier() removed, thus check in runtime, if the method exists
// tslint:disable-next-line no-unsafe-any strict-boolean-expressions
var unescapeIdentifier = ts . unescapeIdentifier || Rule . id ;
var propertyName = unescapeIdentifier ( argument . text ) ;
2017-05-28 00:38:50 +02:00
ctx . addFailureAtNode ( argument , Rule . FAILURE _STRING ,
// expr['foo'] -> expr.foo
2017-12-10 21:51:33 +01:00
Lint . Replacement . replaceFromTo ( node . expression . end , node . end , "." + propertyName ) ) ;
2017-05-28 00:38:50 +02:00
}
}
return ts . forEachChild ( node , cb ) ;
} ) ;
}
2018-09-20 02:56:13 +02:00
var templateObject _1 , templateObject _2 ;