Class FormatResult

Index

Constructors

Properties

fixResult? lintResult? ruleInfo runMessage? status ERROR IGNORED RULE_NOT_PASSED_ERROR RULE_NOT_PASSED_WARN RULE_PASSED

Methods

CreateError CreateIgnored CreateLintAndFix CreateLintOnly getAllStatus getStatus

Constructors

constructor

new FormatResult(
    ruleInfo: RuleInfo,
    message: string | undefined,
    status: FormatResultStatus,
    lintResult: Result | undefined,
    fixResult: Result | undefined,
): FormatResult
Parameters
- ruleInfo: RuleInfo
- message: string | undefined
- status: FormatResultStatus
- lintResult: Result | undefined
- fixResult: Result | undefined
Returns FormatResult
- Defined in lib/formatresult.ts:85

Properties

`Optional`fixResult

fixResult?: Result

`Optional`lintResult

lintResult?: Result

ruleInfo

ruleInfo: RuleInfo

`Optional`runMessage

runMessage?: string

status

status: FormatResultStatus

`Static` `Readonly`ERROR

ERROR: FormatResultStatus = 'ERROR'

`Static` `Readonly`IGNORED

IGNORED: FormatResultStatus = 'IGNORED'

`Static` `Readonly`RULE_NOT_PASSED_ERROR

RULE_NOT_PASSED_ERROR: FormatResultStatus = 'NOT_PASSED_ERROR'

`Static` `Readonly`RULE_NOT_PASSED_WARN

RULE_NOT_PASSED_WARN: FormatResultStatus = 'NOT_PASSED_WARN'

`Static` `Readonly`RULE_PASSED

RULE_PASSED: FormatResultStatus = 'PASSED'

Methods

`Static`CreateError

CreateError(ruleInfo: RuleInfo, message: string): FormatResult
Parameters
- ruleInfo: RuleInfo
- message: string
Returns FormatResult
- Defined in lib/formatresult.ts:51

`Static`CreateIgnored

CreateIgnored(ruleInfo: RuleInfo, message: string): FormatResult
Parameters
- ruleInfo: RuleInfo
- message: string
Returns FormatResult
- Defined in lib/formatresult.ts:41

`Static`CreateLintAndFix

CreateLintAndFix(
    ruleInfo: RuleInfo,
    lintResult: Result,
    fixResult: Result,
): FormatResult
Parameters
- ruleInfo: RuleInfo
- lintResult: Result
- fixResult: Result
Returns FormatResult
- Defined in lib/formatresult.ts:65

`Static`CreateLintOnly

CreateLintOnly(ruleInfo: RuleInfo, lintResult: Result): FormatResult
Parameters
- ruleInfo: RuleInfo
- lintResult: Result
Returns FormatResult
- Defined in lib/formatresult.ts:55

`Static`getAllStatus

getAllStatus(): FormatResultStatus[]
Returns FormatResultStatus[]
- Defined in lib/formatresult.ts:31

`Static`getStatus

getStatus(ruleInfo: RuleInfo, lintResult: Result): FormatResultStatus
Parameters
- ruleInfo: RuleInfo
- lintResult: Result
Returns FormatResultStatus
- Defined in lib/formatresult.ts:18