beautytips
| Crates.io | beautytips |
| lib.rs | beautytips |
| version | 0.2.0 |
| created_at | 2024-06-15 23:23:53.87183+00 |
| updated_at | 2024-09-15 21:15:21.705307+00 |
| description | The beautytips code prettifier |
| homepage | https://github.com/hunger/beautytips |
| repository | https://github.com/hunger/beautytips |
| max_upload_size | |
| id | 1273186 |
| size | 183,317 |
Tobias Hunger (hunger)
documentation
README
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
gitrepos- can configure itself as commit hook
- works with
jjrepos - works with
pijulrepos - 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
actionlintinstalled) - cspell (needs
cspellinstalled)
- 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:
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_*'