Skip to content

Latest commit

 

History

History
21 lines (13 loc) · 1.39 KB

README.md

File metadata and controls

21 lines (13 loc) · 1.39 KB

Flipper Expressions

A schema for Flipper Expressions

The structure for flipper Expressions is defined in schemas/schema.json using JSON Schema (draft-07).

To learn more about JSON Schema, read Understanding JSON Schema or the Ajv JSON schema validator docs.

Adding a new expression

  1. Describe arguments by creating a new file in schemas/ named NewName.schema.json. You can copy an existing function that has similar semantics to get started.
  2. Add the new function in schemas/schema.json to definitions/function.
  3. Create a new file in examples/ named NewName.json with valid and invalid examples for the new function. See other examples for inspiration.
  4. Run yarn test and ensure tests pass.

Implement the expression in @flippercloud/flipper:

  1. Add lib/flipper/expressions/new_name.rb to @flippercloud/flipper.
  2. Run rspec to ensure tests pass.

See this commit that adds Min/Max functions for a concrete example.