Skip to content

Fix docstring indent issue in feature files - #85

Merged
swissspidy merged 1 commit into
mainfrom
refine-feature-files
Apr 10, 2025
Merged

swissspidy merged 1 commit into
mainfrom
refine-feature-files

Conversation

@ernilambar

@ernilambar ernilambar commented Apr 10, 2025 •

Copy link
Copy Markdown
Member

Before:

    When I run `curl -sS localhost:8181`
    Then STDOUT should contain:
    """
    Just another WordPress site
    """

After:

    When I run `curl -sS localhost:8181`
    Then STDOUT should contain:
      """
      Just another WordPress site
      """

In our feature tests, we generally use indented docstring block. Majority of tests use this convention but there are some files which does not abide this.

Since there is no rules for this in gherkin-lint, I have developed custom rule for gherkin-lint. https://github.com/ernilambar/gherkin-lint-rules/blob/main/custom-rules/docstring-indent.js
Currently I am running this locally to detect issue and working on preparing PR for WPCLI repos. We can also integrate this rule in the central repo if deemed feasible.

@codecov

codecov Bot commented Apr 10, 2025

Copy link
Copy Markdown

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

@ernilambar
ernilambar marked this pull request as ready for review April 10, 2025 10:31
@ernilambar
ernilambar requested a review from a team as a code owner April 10, 2025 10:31
@swissspidy swissspidy added this to the 2.0.15 milestone Apr 10, 2025
@swissspidy swissspidy added the scope:testing Related to testing label Apr 10, 2025
@swissspidy
swissspidy merged commit 80a9243 into main Apr 10, 2025
@swissspidy
swissspidy deleted the refine-feature-files branch April 10, 2025 11:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

scope:testing Related to testing

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants