A Swift package for working with gherkin based .feature files.
Warning: This package only handles a limited subset of Gherkin. I'd like to improve this. If you would like to help, see the Gherkin Subset section.
You can initialize a Feature from a String or from some Data. These initializers will throw an Error if the parser cannot read the content.
import Gherkin
do {
let text = """
Feature: Registration
Users may want to register to save lists
Scenario: Successful registration
Given I am on the registration screen
When I enter <email> into the email field
And submit the form
Then I see the registration page
Examples:
| email |
| 1@notanemail.com |
| 1+gmail@notanemail.com |
"""
let feature = try Feature(text)
print(feature.name) // Registration
let firstScenario = feature.scenarios[0]
print(firstScenario.steps.count) // 4
print(firstScenario.examples) // ["1@notanemail.com", "1+gmail@notanemail.com"]
}The Scenario type is an enum that has two cases .simple(ScenarioSimple) & .outline(ScenarioOutline). The parser ensures that a 'Scenario Outline:' must have at least one example.
To install using Swift Package Manager, add this to the dependencies: section in your Package.swift file:
.package(url: "https://github.com/iainsmith/SwiftGherkin.git", .upToNextMinor(from: "0.2.0")),Example Swift 4 Package
let package = Package(
name: "MyPackage",
products: [
.library(
name: "MyPackage",
targets: ["MyPackage"]),
],
dependencies: [
.package(url: "https://github.com/iainsmith/SwiftGherkin.git", .upToNextMinor(from: "0.2.0")),
],
targets: [
.target(
name: "MyPackage",
dependencies: ["Gherkin"])
]
)- Feature:
- Scenario:
- Scenario Outline:
- Examples:
- Steps
- Adding support for
- Comments
- Background steps
- Converting a feature file back to the canonical gherkin text
- General Gherkin parsing improvements
- CocoaPods support
If you'd like to add any of these please:
- Add a test case to GherkinTests.swift
- Update Parser.swift & Transform.swift until all the tests pass
- Create a Pull Request
Gherkin is built on top of Consumer. You will probably want to read the Consumer documentation to work on the parse & transform.
If you'd like to add a different feature to this library, please raise an issue to discuss the details.
Gherkin is built on top of a parser generator called Consumer by Nick Lockwood.
SwiftGherkin currently supports swift 4.2 and higher.
If you add new tests, run swift test --generate-linuxmain to make sure they are added to the XCTestManifests.swift file.
The Feature type conforms to Codable. It's likely that the JSON representation will not be compatible between versions.