Spectacle

Generates HTML from Specification/Markdown files. This is a plugin for gauge.

Installation

gauge install spectacle

To install a specific version of spectacle plugin use the --version flag.

gauge install spectacle --version $VERSION

Offline Installation

Download the plugin zip from the Github Releases.

use the --file or -f flag to install the plugin from zip file.

gauge install spectacle --file ZIP_FILE_PATH

Build from Source

Requirements

• Golang

Compiling

go run build/make.go

For cross-platform compilation

go run build/make.go --all-platforms

Installing

After compilation

go run build/make.go --install

Creating distributable

Note: Run after compiling

go run build/make.go --distro

For distributable across platforms: Windows and Linux for both x86 and x86_64

go run build/make.go --distro --all-platforms

Usage

Export to HTML

Run the following command to export to HTML in a Gauge project

gauge docs spectacle <path to specs dir>

The html docs are generated in docs directory inside the project.

Filter Specification/Scenario based on Tags

Tags allow you to filter the specs and scenarios. Add the tags to the textbox in the report to view all the specs and scenarios which are labeled with certain tags. Tag expressions with operators |, &, ! are supported.

In the following image, the specs/scenarios are filtered using a tag expression(\ refactoring & !api).

License

Spectacle is released under the Apache License, Version 2.0. See LICENSE for the full license text.