Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/richardruiter/gatsby-transformer-cucumber-report

Gatsby plugin for transforming sourced cucumber reports
https://github.com/richardruiter/gatsby-transformer-cucumber-report

bdd behavior-driven-development cucumber cucumber-json cucumber-reports gatsby gatsby-plugin gatsby-plugin-transformer gatsby-plugins gatsbyjs living-documentation livingdocs

Last synced: 11 days ago
JSON representation

Gatsby plugin for transforming sourced cucumber reports

Awesome Lists containing this project

README

        

# gatsby-transformer-cucumber-report

## Description

Gatsby plugin for transforming sourced cucumber reports

## How to install

`npm install --save gatsby-transformer-cucumber-report`

\- or -

`yarn add gatsby-transformer-cucumber-report`

## When do I use this plugin?

If you want to create living documentation using Gatsby. This plugin will transform any sources `.json` cucucumber report you have in your project and then query the contents.

## Examples of usage

```js
// In your gatsby-config.js
module.exports = {
plugins: [
`gatsby-transformer-cucumber-report`,
{
resolve: `gatsby-source-filesystem`,
options: {
path: `../my-e2e/.reports/cucumber`
}
}
]
};
```

To query the data your can for example look up a specific feature using it's name:

```js
export const pageQuery = graphql`
query($feature: String!) {
cucumberReport(features: { elemMatch: { name: { eq: $feature } } }) {
features {
keyword
name
elements {
name
steps {
name
keyword
embeddings {
data
mime_type
}
}
}
}
}
}
`;
```