tslint-ban-snippets
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • RuleWalker
    • StatementsWalker

Implements

  • IWalker

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private config

config: BanSnippetsRuleConfig

Methods

addFailure

  • addFailure(failure: RuleFailure): void
  • deprecated

    Prefer addFailureAt and its variants.

    Parameters

    • failure: RuleFailure

    Returns void

addFailureAt

  • addFailureAt(start: number, width: number, failure: string, fix?: Fix): void

  • Add a failure with any arbitrary span. Prefer addFailureAtNode if possible.

    Parameters

    • start: number
    • width: number
    • failure: string
    • Optional fix: Fix

    Returns void

addFailureAtNode

  • addFailureAtNode(node: Node, failure: string, fix?: Fix): void

  • Add a failure using a node's span.

    Parameters

    • node: Node
    • failure: string
    • Optional fix: Fix

    Returns void

addFailureFromStartToEnd

  • addFailureFromStartToEnd(start: number, end: number, failure: string, fix?: Fix): void

  • Like addFailureAt but uses start and end instead of start and width.

    Parameters

    • start: number
    • end: number
    • failure: string
    • Optional fix: Fix

    Returns void

appendText

  • appendText(start: number, text: string): Replacement

  • Parameters

    • start: number
    • text: string

    Returns Replacement

Private checkBannedSnippet

  • checkBannedSnippet(snippets: string[], text: string, node: Node, message?: undefined | string): void

  • Parameters

    • snippets: string[]
    • text: string
    • node: Node
    • Optional message: undefined | string

    Returns void

Private checkRegexBannedSnippet

  • checkRegexBannedSnippet(regexSnippets: string[], text: string, node: Node, message?: undefined | string): void

  • Parameters

    • regexSnippets: string[]
    • text: string
    • node: Node
    • Optional message: undefined | string

    Returns void

createFailure

  • createFailure(start: number, width: number, failure: string, fix?: Fix): RuleFailure
  • deprecated

    Prefer addFailureAt and its variants.

    Parameters

    • start: number
    • width: number
    • failure: string
    • Optional fix: Fix

    Returns RuleFailure

createReplacement

  • createReplacement(start: number, length: number, text: string): Replacement

  • Parameters

    • start: number
    • length: number
    • text: string

    Returns Replacement

deleteFromTo

  • deleteFromTo(start: number, end: number): Replacement

  • Parameters

    • start: number
    • end: number

    Returns Replacement

deleteText

  • deleteText(start: number, length: number): Replacement

  • Parameters

    • start: number
    • length: number

    Returns Replacement

Private failRule

  • failRule(node: Node, bannedCodeFound: string[], message?: undefined | string): void

  • Parameters

    • node: Node
    • bannedCodeFound: string[]
    • Optional message: undefined | string

    Returns void

getFailures

  • getFailures(): RuleFailure[]

  • Returns RuleFailure[]

getLimit

  • getLimit(): number

  • Returns number

getLineAndCharacterOfPosition

  • getLineAndCharacterOfPosition(position: number): LineAndCharacter

  • Parameters

    • position: number

    Returns LineAndCharacter

getOptions

  • getOptions(): any

  • Returns any

Private getRelevantBanned

getRuleName

  • getRuleName(): string

  • Returns string

getSourceFile

  • getSourceFile(): SourceFile

  • Returns SourceFile

hasOption

  • hasOption(option: string): boolean

  • Parameters

    • option: string

    Returns boolean

Protected visitAnyKeyword

  • visitAnyKeyword(node: Node): void

  • Parameters

    • node: Node

    Returns void

Protected visitArrayLiteralExpression

  • visitArrayLiteralExpression(node: ArrayLiteralExpression): void

  • Parameters

    • node: ArrayLiteralExpression

    Returns void

Protected visitArrayType

  • visitArrayType(node: ArrayTypeNode): void

  • Parameters

    • node: ArrayTypeNode

    Returns void

Protected visitArrowFunction

  • visitArrowFunction(node: ArrowFunction): void

  • Parameters

    • node: ArrowFunction

    Returns void

Protected visitBinaryExpression

  • visitBinaryExpression(node: BinaryExpression): void

  • Parameters

    • node: BinaryExpression

    Returns void

Protected visitBindingElement

  • visitBindingElement(node: BindingElement): void

  • Parameters

    • node: BindingElement

    Returns void

Protected visitBindingPattern

  • visitBindingPattern(node: ts.BindingPattern): void

  • Parameters

    • node: ts.BindingPattern

    Returns void

Protected visitBlock

  • visitBlock(node: Block): void

  • Parameters

    • node: Block

    Returns void

Protected visitBreakStatement

  • visitBreakStatement(node: ts.BreakOrContinueStatement): void

  • Parameters

    • node: ts.BreakOrContinueStatement

    Returns void

Protected visitCallExpression

  • visitCallExpression(node: CallExpression): void

  • Parameters

    • node: CallExpression

    Returns void

Protected visitCallSignature

  • visitCallSignature(node: ts.SignatureDeclaration): void

  • Parameters

    • node: ts.SignatureDeclaration

    Returns void

Protected visitCaseClause

  • visitCaseClause(node: CaseClause): void

  • Parameters

    • node: CaseClause

    Returns void

Protected visitCatchClause

  • visitCatchClause(node: CatchClause): void

  • Parameters

    • node: CatchClause

    Returns void

Protected visitClassDeclaration

  • visitClassDeclaration(node: ClassDeclaration): void

  • Parameters

    • node: ClassDeclaration

    Returns void

Protected visitClassExpression

  • visitClassExpression(node: ClassExpression): void

  • Parameters

    • node: ClassExpression

    Returns void

Protected visitConditionalExpression

  • visitConditionalExpression(node: ConditionalExpression): void

  • Parameters

    • node: ConditionalExpression

    Returns void

Protected visitConstructSignature

  • visitConstructSignature(node: ConstructSignatureDeclaration): void

  • Parameters

    • node: ConstructSignatureDeclaration

    Returns void

Protected visitConstructorDeclaration

  • visitConstructorDeclaration(node: ConstructorDeclaration): void

  • Parameters

    • node: ConstructorDeclaration

    Returns void

Protected visitConstructorType

  • visitConstructorType(node: ts.FunctionOrConstructorTypeNode): void

  • Parameters

    • node: ts.FunctionOrConstructorTypeNode

    Returns void

Protected visitContinueStatement

  • visitContinueStatement(node: ts.BreakOrContinueStatement): void

  • Parameters

    • node: ts.BreakOrContinueStatement

    Returns void

Protected visitDebuggerStatement

  • visitDebuggerStatement(node: Statement): void

  • Parameters

    • node: Statement

    Returns void

Protected visitDefaultClause

  • visitDefaultClause(node: DefaultClause): void

  • Parameters

    • node: DefaultClause

    Returns void

Protected visitDoStatement

  • visitDoStatement(node: DoStatement): void

  • Parameters

    • node: DoStatement

    Returns void

Protected visitElementAccessExpression

  • visitElementAccessExpression(node: ElementAccessExpression): void

  • Parameters

    • node: ElementAccessExpression

    Returns void

Protected visitEndOfFileToken

  • visitEndOfFileToken(node: Node): void

  • Parameters

    • node: Node

    Returns void

Protected visitEnumDeclaration

  • visitEnumDeclaration(node: EnumDeclaration): void

  • Parameters

    • node: EnumDeclaration

    Returns void

Protected visitEnumMember

  • visitEnumMember(node: EnumMember): void

  • Parameters

    • node: EnumMember

    Returns void

Protected visitExportAssignment

  • visitExportAssignment(node: ExportAssignment): void

  • Parameters

    • node: ExportAssignment

    Returns void

Protected visitExpressionStatement

  • visitExpressionStatement(node: ExpressionStatement): void

  • Parameters

    • node: ExpressionStatement

    Returns void

Protected visitForInStatement

  • visitForInStatement(node: ForInStatement): void

  • Parameters

    • node: ForInStatement

    Returns void

Protected visitForOfStatement

  • visitForOfStatement(node: ForOfStatement): void

  • Parameters

    • node: ForOfStatement

    Returns void

Protected visitForStatement

  • visitForStatement(node: ForStatement): void

  • Parameters

    • node: ForStatement

    Returns void

Protected visitFunctionDeclaration

  • visitFunctionDeclaration(node: FunctionDeclaration): void

  • Parameters

    • node: FunctionDeclaration

    Returns void

Protected visitFunctionExpression

  • visitFunctionExpression(node: FunctionExpression): void

  • Parameters

    • node: FunctionExpression

    Returns void

Protected visitFunctionType

  • visitFunctionType(node: ts.FunctionOrConstructorTypeNode): void

  • Parameters

    • node: ts.FunctionOrConstructorTypeNode

    Returns void

Protected visitGetAccessor

  • visitGetAccessor(node: ts.AccessorDeclaration): void

  • Parameters

    • node: ts.AccessorDeclaration

    Returns void

Protected visitIdentifier

  • visitIdentifier(node: Identifier): void

  • Parameters

    • node: Identifier

    Returns void

Protected visitIfStatement

  • visitIfStatement(node: IfStatement): void

  • Parameters

    • node: IfStatement

    Returns void

Protected visitImportDeclaration

  • visitImportDeclaration(node: ImportDeclaration): void

  • Parameters

    • node: ImportDeclaration

    Returns void

Protected visitImportEqualsDeclaration

  • visitImportEqualsDeclaration(node: ImportEqualsDeclaration): void

  • Parameters

    • node: ImportEqualsDeclaration

    Returns void

Protected visitIndexSignatureDeclaration

  • visitIndexSignatureDeclaration(node: IndexSignatureDeclaration): void

  • Parameters

    • node: IndexSignatureDeclaration

    Returns void

Protected visitInterfaceDeclaration

  • visitInterfaceDeclaration(node: InterfaceDeclaration): void

  • Parameters

    • node: InterfaceDeclaration

    Returns void

Protected visitJsxAttribute

  • visitJsxAttribute(node: JsxAttribute): void

  • Parameters

    • node: JsxAttribute

    Returns void

Protected visitJsxElement

  • visitJsxElement(node: JsxElement): void

  • Parameters

    • node: JsxElement

    Returns void

Protected visitJsxExpression

  • visitJsxExpression(node: JsxExpression): void

  • Parameters

    • node: JsxExpression

    Returns void

Protected visitJsxSelfClosingElement

  • visitJsxSelfClosingElement(node: JsxSelfClosingElement): void

  • Parameters

    • node: JsxSelfClosingElement

    Returns void

Protected visitJsxSpreadAttribute

  • visitJsxSpreadAttribute(node: JsxSpreadAttribute): void

  • Parameters

    • node: JsxSpreadAttribute

    Returns void

Protected visitLabeledStatement

  • visitLabeledStatement(node: LabeledStatement): void

  • Parameters

    • node: LabeledStatement

    Returns void

Protected visitMethodDeclaration

  • visitMethodDeclaration(node: MethodDeclaration): void

  • Parameters

    • node: MethodDeclaration

    Returns void

Protected visitMethodSignature

  • visitMethodSignature(node: ts.SignatureDeclaration): void

  • Parameters

    • node: ts.SignatureDeclaration

    Returns void

Protected visitModuleDeclaration

  • visitModuleDeclaration(node: ModuleDeclaration): void

  • Parameters

    • node: ModuleDeclaration

    Returns void

Protected visitNamedImports

  • visitNamedImports(node: NamedImports): void

  • Parameters

    • node: NamedImports

    Returns void

Protected visitNamespaceImport

  • visitNamespaceImport(node: NamespaceImport): void

  • Parameters

    • node: NamespaceImport

    Returns void

Protected visitNewExpression

  • visitNewExpression(node: NewExpression): void

  • Parameters

    • node: NewExpression

    Returns void

Protected visitNode

  • visitNode(node: Node): void

  • Parameters

    • node: Node

    Returns void

Protected visitNonNullExpression

  • visitNonNullExpression(node: NonNullExpression): void

  • Parameters

    • node: NonNullExpression

    Returns void

Protected visitNumericLiteral

  • visitNumericLiteral(node: NumericLiteral): void

  • Parameters

    • node: NumericLiteral

    Returns void

Protected visitObjectLiteralExpression

  • visitObjectLiteralExpression(node: ObjectLiteralExpression): void

  • Parameters

    • node: ObjectLiteralExpression

    Returns void

Protected visitParameterDeclaration

  • visitParameterDeclaration(node: ParameterDeclaration): void

  • Parameters

    • node: ParameterDeclaration

    Returns void

Protected visitPostfixUnaryExpression

  • visitPostfixUnaryExpression(node: PostfixUnaryExpression): void

  • Parameters

    • node: PostfixUnaryExpression

    Returns void

Protected visitPrefixUnaryExpression

  • visitPrefixUnaryExpression(node: PrefixUnaryExpression): void

  • Parameters

    • node: PrefixUnaryExpression

    Returns void

Protected visitPropertyAccessExpression

  • visitPropertyAccessExpression(node: PropertyAccessExpression): void

  • Parameters

    • node: PropertyAccessExpression

    Returns void

Protected visitPropertyAssignment

  • visitPropertyAssignment(node: PropertyAssignment): void

  • Parameters

    • node: PropertyAssignment

    Returns void

Protected visitPropertyDeclaration

  • visitPropertyDeclaration(node: PropertyDeclaration): void

  • Parameters

    • node: PropertyDeclaration

    Returns void

Protected visitPropertySignature

  • visitPropertySignature(node: Node): void

  • Parameters

    • node: Node

    Returns void

Protected visitRegularExpressionLiteral

  • visitRegularExpressionLiteral(node: Node): void

  • Parameters

    • node: Node

    Returns void

visitReturnStatement

  • visitReturnStatement(node: ReturnStatement): void

  • Parameters

    • node: ReturnStatement

    Returns void

Protected visitSetAccessor

  • visitSetAccessor(node: ts.AccessorDeclaration): void

  • Parameters

    • node: ts.AccessorDeclaration

    Returns void

Private visitSomeNode

  • visitSomeNode(node: Node): void

Protected visitSourceFile

  • visitSourceFile(node: SourceFile): void

  • Parameters

    • node: SourceFile

    Returns void

Protected visitStringLiteral

  • visitStringLiteral(node: StringLiteral): void

  • Parameters

    • node: StringLiteral

    Returns void

Protected visitSwitchStatement

  • visitSwitchStatement(node: SwitchStatement): void

  • Parameters

    • node: SwitchStatement

    Returns void

Protected visitTemplateExpression

  • visitTemplateExpression(node: TemplateExpression): void

  • Parameters

    • node: TemplateExpression

    Returns void

Protected visitThrowStatement

  • visitThrowStatement(node: ThrowStatement): void

  • Parameters

    • node: ThrowStatement

    Returns void

Protected visitTryStatement

  • visitTryStatement(node: TryStatement): void

  • Parameters

    • node: TryStatement

    Returns void

Protected visitTupleType

  • visitTupleType(node: TupleTypeNode): void

  • Parameters

    • node: TupleTypeNode

    Returns void

Protected visitTypeAliasDeclaration

  • visitTypeAliasDeclaration(node: TypeAliasDeclaration): void

  • Parameters

    • node: TypeAliasDeclaration

    Returns void

Protected visitTypeAssertionExpression

  • visitTypeAssertionExpression(node: TypeAssertion): void

  • Parameters

    • node: TypeAssertion

    Returns void

Protected visitTypeLiteral

  • visitTypeLiteral(node: TypeLiteralNode): void

  • Parameters

    • node: TypeLiteralNode

    Returns void

Protected visitTypeReference

  • visitTypeReference(node: TypeReferenceNode): void

  • Parameters

    • node: TypeReferenceNode

    Returns void

Protected visitVariableDeclaration

  • visitVariableDeclaration(node: VariableDeclaration): void

  • Parameters

    • node: VariableDeclaration

    Returns void

Protected visitVariableDeclarationList

  • visitVariableDeclarationList(node: VariableDeclarationList): void

  • Parameters

    • node: VariableDeclarationList

    Returns void

Protected visitVariableStatement

  • visitVariableStatement(node: VariableStatement): void

  • Parameters

    • node: VariableStatement

    Returns void

Protected visitWhileStatement

  • visitWhileStatement(node: WhileStatement): void

  • Parameters

    • node: WhileStatement

    Returns void

Protected visitWithStatement

  • visitWithStatement(node: WithStatement): void

  • Parameters

    • node: WithStatement

    Returns void

walk

  • walk(node: Node): void

  • Parameters

    • node: Node

    Returns void

Protected walkChildren

  • walkChildren(node: Node): void

  • Parameters

    • node: Node

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc