Skip to content

Commit efbf556

Browse files
MattSturgeonfricklerhandwerk
authored andcommitted
treefmt: add longDescription linking to Nixpkgs Manual
Link to the treefmt section of the Nixpkgs Manual in the `treefmt` package's long description. Additionally, link to treefmt-nix.
1 parent 6e5c68b commit efbf556

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

pkgs/by-name/tr/treefmt/package.nix

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,19 @@ buildGoModule rec {
4646

4747
meta = {
4848
description = "one CLI to format the code tree";
49+
longDescription = ''
50+
[treefmt](${meta.homepage}) streamlines the process of applying formatters
51+
to your project, making it a breeze with just one command line.
52+
53+
The `treefmt` package provides functions for configuring treefmt using
54+
the module system, which are documented in the [treefmt section] of the
55+
Nixpkgs Manual.
56+
57+
Alternatively, treefmt can be configured using [treefmt-nix].
58+
59+
[treefmt section]: https://nixos.org/manual/nixpkgs/unstable#treefmt
60+
[treefmt-nix]: https://github.com/numtide/treefmt-nix
61+
'';
4962
homepage = "https://github.com/numtide/treefmt";
5063
license = lib.licenses.mit;
5164
maintainers = with lib.maintainers; [

0 commit comments

Comments
 (0)