Beautytips

Make your code prettier.

Beautytips is a tool to run a set of checks on files and report back on the results.

Typically you run linters and formatters on code in a repository.

Features

• works with git repos
  • can configure itself as commit hook
• works with jj repos
• works with pijul repos
• runs tools in parallel if possible
• Supports configurable tools
  • ... on a user level
  • ... on a repository level
• Has builtin definitions
  • for rustfmt, clippy, etc. (needs cargo + co. installed)
  • github actions (needs actionlint installed)
  • cspell (needs cspell installed)
• can manage the installation of necessary tools

Supported Platforms

Example usage

List all known actions:

beautytips list-actions

List all files beautytips will run actions on. In this case check the jj version control system for changed files.

beautytips list-files --from-vcs=jj

Run all 'check' actions on all files in the current directory:

beautytips run --from-dir . '*/check_*'

Run all fix actions cargo namespace on all files git considers changed:

beautytips run --from-vcs=git 'cargo/fix_*'