🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Book a DemoInstallSign in
Socket

picklesdoc

Package Overview
Dependencies
Maintainers
2
Versions
15
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

picklesdoc

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

1.3.1
latest
Source
npm
Version published
Weekly downloads
149
-54.15%
Maintainers
2
Weekly downloads
 
Created
Source

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

FAQs

Package last updated on 20 Apr 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts