mdformat-gherkin 0.1.0

• Features
• Installation
• Usage
• Example
• Pre-commit Hook
• License
• Acknowledgments

Features

• Formats Gherkin feature files within markdown code blocks
• Preserves all markdown formatting outside Gherkin code blocks
• Supports all standard Gherkin keywords and syntax
• Consistent formatting for better version control diffs
• Seamless integration with pre-commit hooks

Installation

pip install mdformat-gherkin

You may pin the reformat-gherkin dependency for formatting stability:

pip install mdformat-gherkin reformat-gherkin==v3.0.1

Usage

When using mdformat on the command line, Gherkin formatting will be automatically enabled after install.

When using mdformat Python API, code formatting for Gherkin will have to be enabled explicitly:

import mdformat

unformatted = """```gherkin
Feature: Test feature
  Scenario: Test scenario
    Given I have a test
    When I run the test
    Then it should pass
```"""

formatted = mdformat.text(unformatted, codeformatters={"gherkin"})
print(formatted)

Example

Before formatting:

```gherkin
Feature: Test feature
Scenario: Test scenario
Given I have a test
When I run the test
Then it should pass
```

After formatting with mdformat-gherkin:

```gherkin
Feature: Test feature

  Scenario: Test scenario
    Given I have a test
    When I run the test
    Then it should pass
```

Pre-commit Hook

You can use this plugin with pre-commit. Add the following to your .pre-commit-config.yaml:

  - repo: https://github.com/executablebooks/mdformat
    rev: 1.0.0  # Use the latest version
    hooks:
      - id: mdformat
        additional_dependencies:
          - mdformat-gherkin
        # Optional: pin specific versions
        # - reformat-gherkin==v3.0.1

License

This project is licensed under the BSD 3-Clause License - see the LICENSE file for details.

Acknowledgments

This project is based on the work of reformat-gherkin.