2 ms·
The README could use some work. I'm already to the installation instructions and I have no idea what it does or how it works. What languages does it apply to? W
by tornato7 3y ago
The README could use some work. I'm already to the installation instructions and I have no idea what it does or how it works. What languages does it apply to? What code quality tools does it use underneath? I used ChatGPT to summarize and it helps a bit - this is closer to what the top of the README should look like:
---
Precious is a code quality tool that consolidates various linters and tidiers into a single command. It simplifies the management of code quality tools, especially in multi-language projects, by centralizing their configuration in one place.
Features of Precious include:
- A single configuration file (precious.toml) for all code quality tools
- Easy integration with commit hooks and CI systems
- Multiple installation options, such as binary releases, ubi, or cargo
- Parallel execution of commands by default, with one process per CPU
- Support for lint and tidy subcommands
- Selectable paths to operate on, such as all paths, modified files according to git, staged files according to git, and more
- Selectable commands with labels
- Respects VCS ignore files and allows global and per-command exclude rules
Precious is designed to be flexible and easy to use, making it suitable for various scenarios and configurations. It can be run as a commit hook, execute commands in a specific order, and handle different code quality tools across multiple languages.
- oalders 3y agoRight. This is actually not a bad summary at all. It's basically a very flexible harness which can be configured to be used with most linters and tidiers. I have passed this info on to the maintainer. Thanks for the feedback!