studies

Studies are a way to constrain the user of tyche and prevent them from making common mistakes. It requires the user to be using git as their source control provider as well as running tyche init before the feature can be utilized. It works through git-hooks.

To add a study:

{
    "study": [
        {
            "on": "commit",
            "watch": [
                "package.json",
                "src/**/*.js"
            ],
            "message": {
                "error": "Please run `tyche test` before committing"
            },
            "reset": [
                "test"
            ]
        }
    ]
}

In this example, if package.json or any javascript file changes in the src/ directory tree, then the user will be given an error message and prevented from committing to the repo until they run tyche test. Once the “test” task is run, it will reset the error and allow them to commit to the repo.

on

What action on the repo will trigger this message?

watch

Which files/folders to watch for changes

message

reset

Running any of these tasks will reset the warning/error and prevent it from stopping them.