daltonclaybrook / captain Goto Github PK

Tasks:

• Parse the .captain.yml file and fail if parsing fails
• Filter out all hooks that are not part of the currently running git hook
• Evaluate each hook and fail if one fails

Questions:

• Can we check the calling process and fail if it's not git?

Evaluate staged changes in git using a regex string. If any matches are found, evaluation fails.

This command should:

• Make sure a .captain.yml file exists at the specified config path, or fail
• Make sure a git repo exists at the specified project directory, or fail
• Parse .captain.yml and fail if parsing fails
• Parse all existing files in the hooks directory. If any exist that are not added by captain (and --force is not specified), fail. If --force is specified, delete these existing hooks
• Install a one-line bash script for each git hook that calls: captain run <git hook>, e.g. captain run pre-commit

Out of scope:

• Clone sources and use third-party custom hooks

Should this be specified globally or per-regex?

https://www.conventionalcommits.org

Run a script specified in a hook. If this script fails, the evaluator fails.

Right now, the template config file is stored as a text block, but this is error-prone.

Instead, it should be constructed using a Config object and encoded using YAMLEncoder.

Before it has been released, it must have tests