Pre-commit hook

A supported pre-commit hook is provided to scan repos.

yaml

repos:
  - repo: https://github.com/mrsimonemms/toodaloo
    rev: "" # Use the ref you want to point at
    hooks:
      - id: scan

This makes some changes to the default options passed in to the scan command.

The --git-files flag is always applied. This ensures that it scans the files in the HEAD of the repo.
It defaults to output the data in markdown and names the file toodaloo.md. This can be overridden if desired.

See the scan command for more details on the available flag.

If using in CI, you will need to clone the whole Git history for the "get author" functionality to work

Pre-commit hook ​