# 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

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

## Supported Platforms

| OS      | Status                                  |
| ------- | --------------------------------------- |
| Linux   | builds and works                        |
| MacOS   | builds, but may or may not do something |
| Windows | builds, but may or may not do something |

## Example usage

List all known actions:

```sh
beautytips list-actions
```

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

```sh
beautytips list-files --from-vcs=jj
```

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

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

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

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