Class JsonFormatter

Hierarchy

Formatter
- JsonFormatter

Constructors

constructor

new JsonFormatter(options): JsonFormatter
Parameters
- options: IFormatterOptions
Returns JsonFormatter
Overrides Formatter.constructor
- Defined in formatter/json_formatter.ts:88

Properties

`Protected` colorFns

colorFns: IColorFns

`Protected` cwd

cwd: string

`Protected` eventDataCollector

eventDataCollector: EventDataCollector

`Protected` log

log: IFormatterLogFn

`Protected` printAttachments

printAttachments: boolean

`Protected` snippetBuilder

snippetBuilder: default

`Protected` stream

stream: Writable

`Protected` supportCodeLibrary

supportCodeLibrary: SupportCodeLibrary

`Static` `Readonly` documentation

documentation: string = 'Prints the feature as JSON. The JSON format is in maintenance mode. Please consider using the message formatter with the standalone json-formatter (https://github.com/cucumber/json-formatter).'

Methods

convertNameToId

convertNameToId(obj): string
Parameters
- obj: Pickle | Feature
Returns string
- Defined in formatter/json_formatter.ts:97

finished

finished(): Promise<void>
Returns Promise<void>
Inherited from Formatter.finished
- Defined in formatter/index.ts:72

formatDataTable

formatDataTable(dataTable): any
Parameters
- dataTable: PickleTable
Returns any
- Defined in formatter/json_formatter.ts:101

formatDocString

formatDocString(docString, gherkinStep): any
Parameters
- docString: PickleDocString
- gherkinStep: Step
Returns any
- Defined in formatter/json_formatter.ts:109

`Private` formatScenarioId

formatScenarioId(__namedParameters): string
Parameters
- __namedParameters: {
      feature: Feature;
      gherkinExampleRuleMap: Record<string, Rule>;
      pickle: Pickle;
  }
  - feature: Feature
  - gherkinExampleRuleMap: Record<string, Rule>
  - pickle: Pickle
Returns string
- Defined in formatter/json_formatter.ts:231

formatStepArgument

formatStepArgument(stepArgument, gherkinStep): any
Parameters
- stepArgument: PickleStepArgument
- gherkinStep: Step
Returns any
- Defined in formatter/json_formatter.ts:119

getFeatureData

getFeatureData(__namedParameters): IJsonFeature
Parameters
- __namedParameters: IBuildJsonFeatureOptions
Returns IJsonFeature
- Defined in formatter/json_formatter.ts:188

getFeatureTags

getFeatureTags(feature): IJsonTag[]
Parameters
- feature: Feature
Returns IJsonTag[]
- Defined in formatter/json_formatter.ts:307

getScenarioData

getScenarioData(__namedParameters): IJsonScenario
Parameters
- __namedParameters: IBuildJsonScenarioOptions
Returns IJsonScenario
- Defined in formatter/json_formatter.ts:205

`Private` getScenarioTag

getScenarioTag(tagData, feature, scenario): IJsonTag
Parameters
- tagData: PickleTag
- feature: Feature
- scenario: Scenario
Returns IJsonTag
- Defined in formatter/json_formatter.ts:331

getScenarioTags

getScenarioTags(__namedParameters): IJsonTag[]
Parameters
- __namedParameters: {
      feature: Feature;
      gherkinScenarioMap: Record<string, Scenario>;
      pickle: Pickle;
  }
  - feature: Feature
  - gherkinScenarioMap: Record<string, Scenario>
  - pickle: Pickle
Returns IJsonTag[]
- Defined in formatter/json_formatter.ts:314

getStepData

getStepData(__namedParameters): IJsonStep
Parameters
- __namedParameters: IBuildJsonStepOptions
Returns IJsonStep
- Defined in formatter/json_formatter.ts:250

onTestRunFinished

onTestRunFinished(): void
Returns void
- Defined in formatter/json_formatter.ts:134

Class JsonFormatter

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: IFormatterOptions

Returns JsonFormatter

Properties

Protected colorFns

Protected cwd

Protected eventDataCollector

Protected log

Protected printAttachments

Protected snippetBuilder

Protected stream

Protected supportCodeLibrary

Static Readonly documentation

Methods

convertNameToId

Parameters

obj: Pickle | Feature

Returns string

finished

Returns Promise<void>

formatDataTable

Parameters

dataTable: PickleTable

Returns any

formatDocString

Parameters

docString: PickleDocString

gherkinStep: Step

Returns any

Private formatScenarioId

Parameters

__namedParameters: { feature: Feature; gherkinExampleRuleMap: Record<string, Rule>; pickle: Pickle; }

feature: Feature

gherkinExampleRuleMap: Record<string, Rule>

pickle: Pickle

Returns string

formatStepArgument

Parameters

stepArgument: PickleStepArgument

gherkinStep: Step

Returns any

getFeatureData

Parameters

__namedParameters: IBuildJsonFeatureOptions

Returns IJsonFeature

getFeatureTags

Parameters

feature: Feature

Returns IJsonTag[]

getScenarioData

Parameters

__namedParameters: IBuildJsonScenarioOptions

Returns IJsonScenario

Private getScenarioTag

Parameters

tagData: PickleTag

feature: Feature

scenario: Scenario

Returns IJsonTag

getScenarioTags

Parameters

__namedParameters: { feature: Feature; gherkinScenarioMap: Record<string, Scenario>; pickle: Pickle; }

feature: Feature

gherkinScenarioMap: Record<string, Scenario>

pickle: Pickle

Returns IJsonTag[]

getStepData

Parameters

__namedParameters: IBuildJsonStepOptions

Returns IJsonStep

onTestRunFinished

Returns void

`Protected` colorFns

`Protected` cwd

`Protected` eventDataCollector

`Protected` log

`Protected` printAttachments

`Protected` snippetBuilder

`Protected` stream

`Protected` supportCodeLibrary

`Static` `Readonly` documentation

`Private` formatScenarioId

__namedParameters: {
feature: Feature;
gherkinExampleRuleMap: Record<string, Rule>;
pickle: Pickle;
}

`Private` getScenarioTag

__namedParameters: {
feature: Feature;
gherkinScenarioMap: Record<string, Scenario>;
pickle: Pickle;
}