fail

Learn how to terminate execution with an error.

This action terminates template execution with an error message.

It works well as an early guard to abort when a required condition is not met. For example, you can stop execution with a clear message and helpful links when no supported framework is detected in the current directory.

Example

The following template checks for a Next.js project and fails with a helpful message if none is found:

template.json5

{  "$schema": "https://schema.croct.com/json/v1/template.json",  "title": "Next.js check",  "description": "Fails if no Next.js project is detected.",  "actions": [    {      "name": "test",      "condition": "${project.platform === 'unknown'}",      "then": [        {          "name": "fail",          "title": "Project not found",          "message": "This template requires a Next.js project.",          "details": [            "No supported framework detected in the current directory."          ],          "suggestions": [            "Navigate to your project directory and try again."          ],          "links": [            {              "label": "Getting started",              "url": "https://croct.com/docs/getting-started"            }          ]        }      ]    }  ]}