tslint-folders - v0.0.0-semantically-released
Options
All
  • Public
  • Public/Protected
  • All
Menu

Custom version of the standard file-name-casing rule, that allows for multiple casings. ref: https://github.com/palantir/tslint/blob/master/src/rules/fileNameCasingRule.ts

Hierarchy

  • AbstractRule
  • AbstractRule
  • AbstractRule
  • AbstractRule
  • AbstractRule
    • Rule

Implements

  • IRule
  • IRule
  • IRule
  • IRule
  • IRule

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Rule(options: IOptions): Rule

  • Parameters

    • options: IOptions

    Returns Rule

Properties

Protected ruleArguments

ruleArguments: any[]

ruleName

ruleName: string

Protected ruleSeverity

ruleSeverity: RuleSeverity

Static metadata

metadata: IRuleMetadata

Methods

apply

  • apply(sourceFile: SourceFile): RuleFailure[]

Protected applyWithFunction

  • applyWithFunction(sourceFile: SourceFile, walkFn: function): RuleFailure[]
  • applyWithFunction<T>(sourceFile: SourceFile, walkFn: function, options: NoInfer<T>): RuleFailure[]
  • applyWithFunction<T, U>(sourceFile: SourceFile, walkFn: function, options: NoInfer<T>, checker: NoInfer<U>): RuleFailure[]

  • Parameters

    • sourceFile: SourceFile
    • walkFn: function
        • (ctx: WalkContext): void

        • Parameters

          • ctx: WalkContext

          Returns void

    Returns RuleFailure[]

  • Type parameters

    • T

    Parameters

    • sourceFile: SourceFile
    • walkFn: function
        • (ctx: WalkContext<T>): void

        • Parameters

          • ctx: WalkContext<T>

          Returns void

    • options: NoInfer<T>

    Returns RuleFailure[]

  • Type parameters

    • T

    • U

    Parameters

    • sourceFile: SourceFile
    • walkFn: function
        • (ctx: WalkContext<T>, programOrChecker: U): void

        • Parameters

          • ctx: WalkContext<T>
          • programOrChecker: U

          Returns void

    • options: NoInfer<T>
    • checker: NoInfer<U>

    Returns RuleFailure[]

applyWithWalker

  • applyWithWalker(walker: IWalker): RuleFailure[]

  • Parameters

    • walker: IWalker

    Returns RuleFailure[]

Protected filterFailures

  • filterFailures(failures: RuleFailure[]): RuleFailure[]
  • deprecated

    Failures will be filtered based on tslint:disable comments by tslint. This method now does nothing.

    Parameters

    • failures: RuleFailure[]

    Returns RuleFailure[]

Private getDisallowedFolders

getOptions

  • getOptions(): IOptions

  • Returns IOptions

isEnabled

  • isEnabled(): boolean

  • Returns boolean

Static Private FAILURE_STRING

  • FAILURE_STRING(expectedCasings: Casing[]): string

Static Private stylizedNameForCasing

  • stylizedNameForCasing(casing: Casing): string

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • 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