# pickler

> Turn your Jest+Enzyme+React unit tests into Gherkin

Latest version **0.0.5** (published 2017-11-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install pickler
pnpm add pickler
yarn add pickler
bun add pickler
```

Provides the command `pickler`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2017-11-01 |
| First published | 2017-11-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ryan Schumacher |
| Maintainers | jrschumacher |

## Links

- npm: https://www.npmjs.com/package/pickler
- Repository: https://github.com/pcklr/pickler
- Homepage: https://github.com/pcklr/pickler#readme
- Issues: https://github.com/pcklr/pickler/issues
- npm.io page: https://npm.io/package/pickler

## Recent versions

- 0.0.5 (latest) — 2017-11-01
- 0.0.4 — 2017-11-01
- 0.0.3 — 2017-11-01
- 0.0.2 — 2017-11-01
- 0.0.1 — 2017-11-01

## README

# pickler

Turn your React+Jest+Enzyme unit tests into Gherkin.

# Overview

Pickler is a tool which allows one to convert their unit tests into Gherkin. It was developed with the need to meet a job requirement which was to write all requirements in Gherkin so they could be both requirement documentation and functional tests.

# How it Works

The pickler tool will parse your unit tests and convert them to Gherkin using this basic approach:

```
describe('As a user, I want to pickle my cucumbers, so that I can eat pickles', () => {
  // 🥒 Scenario: As a user, I want to pickle my cucumbers, so that I can eat pickles

  it('should have a jar of water, salt, and enzymes', () => {
  // 🥒 Given I should have a jar of salt water and enzymes

    const water = '1 pint';
    const salt = '1 cup';
    const enzymes = '1 tbsp';
    const cucumbers = '5';

    const wrapper = shallow(<PickleJar water={water} salt={salt} enzymes={enzymes} cucumbers={cucumbers}/>);
    // 🥒 And I gather water, salt, enzymes, and cucumbers to PickleJar

    wrapper.find('btn.add-water').simulate('click')
    // 🥒 When I click "btn.add-water"
    wrapper.find('btn.add-salt').simulate('click')
    // 🥒 And I click "btn.add-salt"
    wrapper.find('btn.add-enzymes').simulate('click')
    // 🥒 And I click "btn.add-enzymes"
    wrapper.find('btn.stir').simulate('click')
    // 🥒 And I click "btn.stir"
    wrapper.find('btn.add-cucumbers').simulate('click')
    // 🥒 And I click "btn.add-cucumbers"

    expect(wrapper.find('ul.jar-contents').containsAllMatchingElements([
      `<li>1 pint of water</li>`,
      // 🥒 Then I expect "ul.jar-contents" to contain "<li>1 pint of water</li>"
      `<li>1 cup of salt</li>`,
      // 🥒 And I expect "ul.jar-contents" to contain "<li>1 cup of salt</li>"
      `<li>1 tbsp of enzymes</li>`,
      // 🥒 And I expect "ul.jar-contents" to contain "<li>1 tbsp of enzymes</li>"
      `<li>5 cucumbers</li>`
      // 🥒 And I expect "ul.jar-contents" to contain "<li>5 cucumbers</li>"
    ])
  })
})
```

# Install

```
npm -g install pickler

# or

yarn global add pickler
```

# Usage

See [man](bin/src/help.md)

---
_Source: https://npm.io/package/pickler · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._