background-setup-only.ts

import { switchOrSeveritySchema } from '../schemas'
import Schema from '../schema'
import Rule from '../rule'
import { RawSchema, AcceptedSchema } from '../types'
import Document from '../document'

export default class BackgroundSetupOnly implements Rule {
  public readonly name: string = 'background-setup-only'

  public readonly acceptedSchema: AcceptedSchema = switchOrSeveritySchema

  public readonly schema: Schema

  public constructor(rawSchema: RawSchema) {
    this.schema = new Schema(rawSchema)
  }

  public async run(document: Document): Promise<void> {
    document.feature.children.forEach((child) => {
      if (!child.background) {
        return
      }

      child.background.steps.forEach((step): void => {
        if (!['Given', '*'].includes(step.keyword.trim())) {
          document.addError(
            this,
            `Background should only be used for set up. Found "${step.keyword.trim()}".`,
            step.location,
          )
        }
      })
    })
  }
}