🍅 ketchup-gherkin

Generate beautiful pages for Gherkin language .feature files in JavaScript JS HTML CSS.

Supports English and Portuguese.

🍅 Menu

• Required

• Start

• Install

• Config

• Run

• Usage

🍅 Required

Node v18+

npm v8+

Download Node and npm

🍅 Start

npm init -y

This command creates the package.json file.

🍅 Install

npm i ketchup-gherkin

This command install the package.

package npm page

🍅 Config

In package.json add

  "scripts": {
    "config": "node node_modules/ketchup-gherkin/createConfig.js",
    "ketchup": "node_modules/.bin/nodemon node_modules/.bin/ketchup-gherkin"
  }

npm run config

This command configure ketchup.

🍅 Run

npm run ketchup

This command starts the server.

With each change, the server is restarted and generates new HTML.

You need to reload the page in the browser.

Running in localhost:3000

🍅 Usage

Creates this folder structure Feature/feature-name/feature.feature

📂 your-project 🍅
       .
       ├── 📂 Features
       |          .
       |          ├── 📂 feature-name 
       |          |           └── 🥒 feature.feature
       |          |
       |          ├── 📂 feature-name 
       |          |           ├── 🥒 feature.feature
       |          |           └── 🥒 feature.feature
       |          . 
       ├── 🍅 ketchup.json
       .

--

📂 your-project 🍅 --> Your project folder.

📂 Features --> Folder with all Features.

📂 feature-name --> Feature folder.

🥒 feature.feature --> Feature in Gherkin language.

🍅 ketchup.json --> ketchup settings.

--

Enjoy 🍅

package github page