mirror of
https://github.com/RGBCube/alejandra
synced 2025-08-01 13:07:47 +00:00
refactor: organize readme
This commit is contained in:
parent
c4f01f25de
commit
f85392e639
1 changed files with 51 additions and 45 deletions
96
README.md
96
README.md
|
@ -30,6 +30,51 @@
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- ✔️ **Fast**
|
||||||
|
|
||||||
|
It's written in [Rust](https://www.rust-lang.org/)
|
||||||
|
and formats [Nixpkgs](https://github.com/NixOS/nixpkgs)
|
||||||
|
in just a few seconds[^benchmark-specs].
|
||||||
|
|
||||||
|
| Cores | Seconds |
|
||||||
|
|:-----:|:--------:
|
||||||
|
| 1 | 40 |
|
||||||
|
| 2 | 21 |
|
||||||
|
| 4 | 15 |
|
||||||
|
| 8 | 11 |
|
||||||
|
| 16 | 10 |
|
||||||
|
|
||||||
|
- ✔️ **Powerful**
|
||||||
|
|
||||||
|
All elements in the Nix grammar have a totally defined style.
|
||||||
|
|
||||||
|
- ✔️ **Reliable**
|
||||||
|
|
||||||
|
Coverage is currently 80%,
|
||||||
|
and we'll have 💯% soon.
|
||||||
|
|
||||||
|
- ✔️ **Developer aware**
|
||||||
|
|
||||||
|
Syntax errors are gracefully handled
|
||||||
|
by leaving that specific zone unformatted.
|
||||||
|
|
||||||
|
The rest of the file will be formatted normally.
|
||||||
|
|
||||||
|
- ✔️ **Reproducible**
|
||||||
|
|
||||||
|
Formatting many times yields the same results.
|
||||||
|
|
||||||
|
- 🚧 **Beautiful**
|
||||||
|
|
||||||
|
Beauty is subjective, right?
|
||||||
|
|
||||||
|
Yet there are a few improvements to implement like:
|
||||||
|
- Multiline strings indentation is missing `'' ... ''`.
|
||||||
|
|
||||||
|
Style is negotiable at this moment.
|
||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
|
||||||
Let's get Alejandra on our systems:
|
Let's get Alejandra on our systems:
|
||||||
|
@ -57,57 +102,16 @@ Let's get Alejandra on our systems:
|
||||||
$ alejandra --help
|
$ alejandra --help
|
||||||
```
|
```
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
- ✔️ **Fast**
|
|
||||||
|
|
||||||
It's written in [Rust](https://www.rust-lang.org/)
|
|
||||||
and formats [Nixpkgs](https://github.com/NixOS/nixpkgs)
|
|
||||||
in just a few seconds[^benchmark-specs].
|
|
||||||
|
|
||||||
| Cores | Seconds |
|
|
||||||
|:-----:|:--------:
|
|
||||||
| 1 | 40 |
|
|
||||||
| 2 | 21 |
|
|
||||||
| 4 | 15 |
|
|
||||||
| 8 | 11 |
|
|
||||||
| 16 | 10 |
|
|
||||||
|
|
||||||
- ✔️ **Highly tested**
|
|
||||||
|
|
||||||
Coverage currently > 80%,
|
|
||||||
aiming to 💯% soon.
|
|
||||||
|
|
||||||
- ✔️ **Comprehensive**
|
|
||||||
|
|
||||||
All elements in the Nix grammar have a rule,
|
|
||||||
so there won't be portions of code without style.
|
|
||||||
|
|
||||||
- ✔️ **Tolerant to syntax errors**
|
|
||||||
|
|
||||||
We'll format the portions of a file that is valid Nix code,
|
|
||||||
and leave as-is the portions that contain syntax errors.
|
|
||||||
|
|
||||||
- ✔️ **Reproducible**
|
|
||||||
|
|
||||||
Formatting many times yields the same results.
|
|
||||||
|
|
||||||
- 🚧 **Beautiful**
|
|
||||||
|
|
||||||
Beauty is subjective, right?
|
|
||||||
|
|
||||||
Yet there are a few improvements to implement like:
|
|
||||||
- Multiline strings indentation is missing `'' ... ''`.
|
|
||||||
|
|
||||||
Style is negotiable at this moment.
|
|
||||||
|
|
||||||
## Do I need to configure anything?
|
## Do I need to configure anything?
|
||||||
|
|
||||||
- No.
|
- No.
|
||||||
|
|
||||||
## References
|
## Discussion
|
||||||
|
|
||||||
- [RFC 0101 - Nix formatting](https://github.com/NixOS/rfcs/pull/101)
|
- [RFC 0101 - Nix formatting](https://github.com/NixOS/rfcs/pull/101)
|
||||||
|
|
||||||
|
## Cool libraries
|
||||||
|
|
||||||
- [rnix-parser](https://github.com/nix-community/rnix-parser)
|
- [rnix-parser](https://github.com/nix-community/rnix-parser)
|
||||||
|
|
||||||
## Alternatives
|
## Alternatives
|
||||||
|
@ -115,6 +119,8 @@ Let's get Alejandra on our systems:
|
||||||
- [nixpkgs-fmt](https://github.com/nix-community/nixpkgs-fmt)
|
- [nixpkgs-fmt](https://github.com/nix-community/nixpkgs-fmt)
|
||||||
- [nixfmt](https://github.com/serokell/nixfmt)
|
- [nixfmt](https://github.com/serokell/nixfmt)
|
||||||
|
|
||||||
|
## Footnotes
|
||||||
|
|
||||||
[^benchmark-specs]:
|
[^benchmark-specs]:
|
||||||
|
|
||||||
Running on a [machine](https://github.com/kamadorueda/machine) with:
|
Running on a [machine](https://github.com/kamadorueda/machine) with:
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue