Détail du package

picklesdoc

saasquatch1.4kMIT1.3.1

Compile spec documents written in Gherkin language to JSON, XLSX, or LaTeX

readme

PicklesDoc

npm version

PicklesDoc is a program that converts .feature files written in Gherkin language into Excel spreadsheets, LaTeX documents or JSON data.

This program is a cross-platform NodeJS port of the popular Pickles program written in C#.

Installation

npm install --global picklesdoc

Usage

picklesdoc <command> [args]

picklesdoc xlsx <input> [out]

Convert the provided file or directory into XLSX

Positionals
  • input Input feature file or directory [required]
  • out Output file or directory
    Options
  • -h --help Show help [boolean]
  • --testers Number of tester columns to generate (for QA purposes) [number] [default: 0]
    Examples
    picklesdoc xlsx ./features my-spreadsheet.xlsx --testers=2
picklesdoc xlsx my-feature.feature my-spreadsheet.xlsx
picklesdoc xlsx ./features ./out --testers=3

picklesdoc tex <input> [out]

Generate a LaTeX report of the feature or features. After generating the LaTeX document you will need another program to convert it to a PDF. picklesdoc development uses pdflatex for all its testing.

Positionals
  • input Input feature file or directory [required]
  • out Output file or directory. Will print to STDOUT if not specified
    Options
  • -h --help Show help [boolean]
  • --title Title for the LaTeX document. [string] [default: "Features Report"]
    Examples
    picklesdoc tex ./features my-document.tex --title="Company Features Report"
picklesdoc tex my-feature.feature my-document.tex
picklesdoc tex ./features > output.tex

picklesdoc json <input> [out]

Convert the provided file or directory into JSON

Positionals
  • input Input feature file or directory [required]
  • out Output file or directory. Will print to STDOUT if not specified
    Options
  • -h --help Show help [boolean]
    Examples
    picklesdoc json ./features my-output-file.json
picklesdoc json my-feature.feature > output.json
picklesdoc json my-feature.feature | jq

changelog

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

1.3.1 - (2023-04-20)

Changed

  • Updated license copyright to be in line with SaaSquatch open-source policy.

1.3.0 - (2022-09-13)

Added

  • Added Gherkin JSON types to library exports so they can be consumed by other code

Changed

  • Changed Gherkin parser from gherkin to @cucumber/gherkin
  • Enabled NodeJS sourcemaps for CLI executable
  • Updated license copyright years
  • Upgraded to NodeJS 16
  • Improved error messages while parsing feature files

Removed

  • Removed TypeScript preprocessor.js

1.2.1 - (2021-05-27)

Changed

  • Greatly improved line spacing and indentation in LaTeX output to make editing the output by hand easier
  • Added aliases for common LaTeX commands to make the output size smaller and improve editing by hand

1.2.0 - (2021-05-25)

Added

  • Added support for generating LaTeX documents out of Gherkin specs

Removed

  • Removed Unreleased section from CHANGELOG.md

1.1.2 - (2021-05-24)

Added

  • Added README installation instructions, usage, and examples

Fixed

  • Fix crash caused by duplicate sheet slug names

Security

  • Updated package versions to resolve CVEs

1.1.1 - (2020-02-20)

Added

  • Add location data to JSON type definitions

1.1.0 - (2020-02-20)

Added

  • Add location data for feature elements to JSON output

1.0.0 - (2019-12-03)

Added

  • Initial release