Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/getgauge/gauge-js

JavaScript language plugin for Gauge
https://github.com/getgauge/gauge-js

gauge gauge-plugin test-automation

Last synced: about 1 month ago
JSON representation

JavaScript language plugin for Gauge

Awesome Lists containing this project

README

        

# Gauge-JS

[![Actions Status](https://github.com/getgauge/gauge-js/workflows/build/badge.svg)](https://github.com/getgauge/gauge-js/actions)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)

This project adds Javascript [language plugin](https://gauge.org/plugins/) for [gauge](https://gauge.org).

## Getting started

### Pre-requisite

- [Gauge](https://gauge.org/index.html)

### Installation
```
gauge install js
```

### Create a gauge-js project
```
gauge init js
```

### Run tests
```
gauge run specs
```

## Documentation

For other details refer the documentation [here](https://docs.gauge.org)

## Demos and examples

### Plain Javascript

Run the following command to create a [sample](https://github.com/getgauge/gauge-repository/tree/master/templates/js_simple) gauge template

```
$ gauge init js_simple
```

### Taiko

Run the following command to create a [sample](https://github.com/getgauge/gauge-repository/tree/master/templates/js_puppeteer) [Taiko](https://github.com/getgauge/taiko) template

```
$ gauge init js
```

### Alternate Installation options

#### Install specific version
```
gauge install js --version
```

### Install from zip file
* Download the plugin from [Releases](https://github.com/getgauge/gauge-js/releases)
```
gauge install js --file gauge-js-.zip
```

#### Build from Source
The plugin is authored in [Javascript](https://en.wikipedia.org/wiki/JavaScript).
Gauge is authored in golang. These are independent processes talking to each other over TCP on port GAUGE_INTERNAL_PORT (env variable) using [Protobuf](https://github.com/getgauge/gauge-proto).

##### Pre-Requisites
* [Node.js](https://nodejs.org/en/) - Version >= 18

##### Compiling
```
npm install
```

##### Run tests:
```
npm test
```

##### Installing from source
```
npm run installPlugin
```

##### Create package
```
npm run package
```

You can then install the offline zip archive created using
```
gauge install js --file gauge-js-.zip
```

## Copyright

Copyright 2018 ThoughtWorks, Inc.