wisp

This repo holds the Wisp json schema that can be used by other RF projects.

Currently the language consists of:

• Verbs:
  • Actions
  • Assertions
• Nouns

For more detail on how to add verbs and nouns see https://www.notion.so/rainforestqa/How-to-add-new-WISP-verbs-nouns-15eb4c4b9d564e73ad4c989a1ced8a89

Releasing

• Create a PR
• Get it reviewed
• Merge into master
• Push a tag (git tag vX.Y.Z; git push origin vX.Y.Z) from your local machine to trigger Circle CI
• Enjoy the fruits of your labour

Patching a previous version

• If it doesn't already exist create a branch named vX.Y-support-branch. You can checkout the version you want to patch using git checkout vX.Y.Z
• Create a PR targeting branch vX.Y-support-branch
• Get it reviewed
• Merge into branch vX.Y-support-branch
• Push a tag (git tag vX.Y.Z; git push origin vX.Y.Z) from branch vX.Y-support-branch on your local machine to trigger Circle CI
• Enjoy the fruits of your labour

Ruby gem

Install by adding to your Gemfile:

gem 'wisp-schema'

Then one can get schema from file as follows:

JSON.parse(File.read(Wisp::SCHEMA_PATH))
JSON.parse(File.read(Wisp::NOUNS_PATH))

...or in any other way you like

NPM Package

To install run

npm install @rainforestqa/wisp-schema

Then you can get the schema object like this:

const { schema, nouns, version } = require('@rainforestqa/wisp-schema')