https://github.com/jeffnyman/scribal

Test Specification Display Generator
https://github.com/jeffnyman/scribal

Last synced: 2 months ago
JSON representation

Test Specification Display Generator

• Host: GitHub
• URL: https://github.com/jeffnyman/scribal
• Owner: jeffnyman
• License: mit
• Created: 2017-01-18T15:04:26.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-01-18T15:31:20.000Z (over 8 years ago)
• Last Synced: 2025-01-08T06:36:17.111Z (5 months ago)
• Language: JavaScript
• Size: 3.91 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# scribal

> Test Specification Display Generator

[![npm version](https://badge.fury.io/js/scribal.svg)](https://badge.fury.io/js/scribal)

[![Build Status](https://travis-ci.org/jeffnyman/scribal.svg?branch=master)](https://travis-ci.org/jeffnyman/scribal)

[![Dependency Status](https://david-dm.org/jeffnyman/scribal.svg)](https://david-dm.org/jeffnyman/scribal)

The goal of Scribal is to help create a readable representation of a test specification repository. Currently that repository must be based on Gherkin. This means you have to provide Scribal with a repository that contains feature files that are consistent with the Gherkin API.

This code is based on a similar tool called [FeatureBook](https://github.com/SOFTWARE-CLINIC/featurebook). One of my concerns with FeatureBook is that it was not adhering to Gherkin 4.x, which is the latest evolution of Gherkin. So I have updated it accordingly as well as a few other updates, such as moving from Jade (now deprecated) to Pug. I also ultimately want to support more than just Gherkin format as well as have the code that sits behind Gherkin explorable as well.