Syntax Reference

Note

These pages contains detailed information about options when using the YAML syntax. It is advised to first read the Getting started guide.

• Targets
• Scopes
• Fixes
• Actions
• Templating

Searching for code in a recipe is done by choosing and configuring a target. Targets can also appear as children of a target, for example the owner option in annotation. They can even appear in suggestion actions, for example the position option in AddField.

The search can be narrowed down by adding a scope. This can check some conditions that may or may not be code related. Both the given search and the scope configuration have to match in order for the recipe to trigger.

Recipes contain a list of availableFixes. A fix defines a name, the actions that will be executed, and configuration regarding the import processing functionality of Sensei.

Actions are then used to be able to make automated changes to the code that was matched by the search.