Skip to content

Commit e750d99

Browse files
sandydoosandydoo
committed
Add a description to each hook
1 parent 85a9a97 commit e750d99

File tree

1 file changed

+43
-43
lines changed

1 file changed

+43
-43
lines changed

‎modules/hooks.nix

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ in
5555
options.hooks =
5656
{
5757
alejandra = mkOption {
58-
description = "";
58+
description = lib.mdDoc "Additional alejandra settings";
5959
type = types.submodule {
6060
imports = hookModule;
6161
options.settings = {
@@ -91,7 +91,7 @@ in
9191
};
9292
};
9393
ansible-lint = mkOption {
94-
description = "";
94+
description = lib.mdDoc "Additional ansible-lint settings";
9595
type = types.submodule {
9696
imports = hookModule;
9797
options.settings = {
@@ -111,7 +111,7 @@ in
111111
};
112112
};
113113
autoflake = mkOption {
114-
description = "";
114+
description = lib.mdDoc "Additional autoflake settings";
115115
type = types.submodule {
116116
imports = hookModule;
117117
options.settings = {
@@ -135,7 +135,7 @@ in
135135
};
136136
};
137137
clippy = mkOption {
138-
description = "";
138+
description = lib.mdDoc "Additional clippy settings";
139139
type = types.submodule {
140140
imports = hookModule;
141141
options.settings = {
@@ -158,7 +158,7 @@ in
158158
};
159159
};
160160
cmake-format = mkOption {
161-
description = "";
161+
description = lib.mdDoc "Additional cmake-format settings";
162162
type = types.submodule {
163163
imports = hookModule;
164164
options.settings = {
@@ -172,7 +172,7 @@ in
172172
};
173173
};
174174
credo = mkOption {
175-
description = "";
175+
description = lib.mdDoc "Additional credo settings";
176176
type = types.submodule {
177177
imports = hookModule;
178178
options.settings = {
@@ -186,7 +186,7 @@ in
186186
};
187187
};
188188
deadnix = mkOption {
189-
description = "";
189+
description = lib.mdDoc "Additional deadnix settings";
190190
type = types.submodule {
191191
imports = hookModule;
192192
options.settings = {
@@ -242,7 +242,7 @@ in
242242
};
243243
};
244244
denofmt = mkOption {
245-
description = "";
245+
description = lib.mdDoc "Additional denofmt settings";
246246
type = types.submodule {
247247
imports = hookModule;
248248
options.settings = {
@@ -264,7 +264,7 @@ in
264264
};
265265
};
266266
denolint = mkOption {
267-
description = "";
267+
description = lib.mdDoc "Additional denolint settings";
268268
type = types.submodule {
269269
imports = hookModule;
270270
options.settings = {
@@ -287,7 +287,7 @@ in
287287
};
288288
};
289289
dune-fmt = mkOption {
290-
description = "";
290+
description = lib.mdDoc "Additional dune-fmt settings";
291291
type = types.submodule {
292292
imports = hookModule;
293293
options.settings = {
@@ -308,7 +308,7 @@ in
308308
};
309309
};
310310
eclint = mkOption {
311-
description = "";
311+
description = lib.mdDoc "Additional eclint settings";
312312
type = types.submodule {
313313
imports = hookModule;
314314
options.settings = {
@@ -346,7 +346,7 @@ in
346346
};
347347
};
348348
eslint = mkOption {
349-
description = "";
349+
description = lib.mdDoc "Additional eslint settings";
350350
type = types.submodule {
351351
imports = hookModule;
352352
options.settings = {
@@ -370,7 +370,7 @@ in
370370
};
371371
};
372372
flake8 = mkOption {
373-
description = "";
373+
description = lib.mdDoc "Additional flake8 settings";
374374
type = types.submodule {
375375
imports = hookModule;
376376
options.settings = {
@@ -400,7 +400,7 @@ in
400400
};
401401
};
402402
flynt = mkOption {
403-
description = "";
403+
description = lib.mdDoc "Additional flynt settings";
404404
type = types.submodule {
405405
imports = hookModule;
406406
options.settings = {
@@ -475,7 +475,7 @@ in
475475
};
476476
};
477477
headache = mkOption {
478-
description = "";
478+
description = lib.mdDoc "Additional headache settings";
479479
type = types.submodule {
480480
imports = hookModule;
481481
options.settings = {
@@ -488,7 +488,7 @@ in
488488
};
489489
};
490490
hlint = mkOption {
491-
description = "";
491+
description = lib.mdDoc "Additional hlint settings";
492492
type = types.submodule {
493493
imports = hookModule;
494494
options.settings = {
@@ -502,7 +502,7 @@ in
502502
};
503503
};
504504
hpack = mkOption {
505-
description = "";
505+
description = lib.mdDoc "Additional hpack settings";
506506
type = types.submodule {
507507
imports = hookModule;
508508
options.settings = {
@@ -516,7 +516,7 @@ in
516516
};
517517
};
518518
isort = mkOption {
519-
description = "";
519+
description = lib.mdDoc "Additional isort settings";
520520
type = types.submodule {
521521
imports = hookModule;
522522
options.settings = {
@@ -536,7 +536,7 @@ in
536536
};
537537
};
538538
latexindent = mkOption {
539-
description = "";
539+
description = lib.mdDoc "Additional latexindent settings";
540540
type = types.submodule {
541541
imports = hookModule;
542542
options.settings = {
@@ -550,7 +550,7 @@ in
550550
};
551551
};
552552
lua-ls = mkOption {
553-
description = "";
553+
description = lib.mdDoc "Additional lua-ls settings";
554554
type = types.submodule {
555555
imports = hookModule;
556556
options.settings = {
@@ -570,7 +570,7 @@ in
570570
};
571571
};
572572
lychee = mkOption {
573-
description = "";
573+
description = lib.mdDoc "Additional lychee settings";
574574
type = types.submodule {
575575
imports = hookModule;
576576
options.settings = {
@@ -590,7 +590,7 @@ in
590590
};
591591
};
592592
markdownlint = mkOption {
593-
description = "";
593+
description = lib.mdDoc "Additional markdownlint settings";
594594
type = types.submodule {
595595
imports = hookModule;
596596
options.settings = {
@@ -605,7 +605,7 @@ in
605605
};
606606
};
607607
mdl = mkOption {
608-
description = "";
608+
description = lib.mdDoc "Additional mdl settings";
609609
type = types.submodule {
610610
imports = hookModule;
611611
options.settings = {
@@ -685,7 +685,7 @@ in
685685
};
686686
};
687687
mkdocs-linkcheck = mkOption {
688-
description = "";
688+
description = lib.mdDoc "Additional mkdocs-linkcheck settings";
689689
type = types.submodule {
690690
imports = hookModule;
691691
options.settings = {
@@ -737,7 +737,7 @@ in
737737
};
738738
};
739739
mypy = mkOption {
740-
description = "";
740+
description = lib.mdDoc "Additional mypy settings";
741741
type = types.submodule {
742742
imports = hookModule;
743743
options.settings = {
@@ -754,7 +754,7 @@ in
754754
};
755755
};
756756
nixfmt = mkOption {
757-
description = "";
757+
description = lib.mdDoc "Additional nixfmt settings";
758758
type = types.submodule {
759759
imports = hookModule;
760760
options.settings = {
@@ -768,7 +768,7 @@ in
768768
};
769769
};
770770
ormolu = mkOption {
771-
description = "";
771+
description = lib.mdDoc "Additional ormolu settings";
772772
type = types.submodule {
773773
imports = hookModule;
774774
options.settings = {
@@ -788,7 +788,7 @@ in
788788
};
789789
};
790790
php-cs-fixer = mkOption {
791-
description = "";
791+
description = lib.mdDoc "Additional php-cs-fixer settings";
792792
type = types.submodule {
793793
imports = hookModule;
794794
options.settings = {
@@ -805,7 +805,7 @@ in
805805
};
806806
};
807807
phpcbf = mkOption {
808-
description = "";
808+
description = lib.mdDoc "Additional phpcbf settings";
809809
type = types.submodule {
810810
imports = hookModule;
811811
options.settings = {
@@ -822,7 +822,7 @@ in
822822
};
823823
};
824824
phpcs = mkOption {
825-
description = "";
825+
description = lib.mdDoc "Additional phpcs settings";
826826
type = types.submodule {
827827
imports = hookModule;
828828
options.settings = {
@@ -839,7 +839,7 @@ in
839839
};
840840
};
841841
phpstan = mkOption {
842-
description = "";
842+
description = lib.mdDoc "Additional phpstan settings";
843843
type = types.submodule {
844844
imports = hookModule;
845845
options.settings = {
@@ -858,7 +858,7 @@ in
858858
# See all CLI flags for prettier [here](https://prettier.io/docs/en/cli.html).
859859
# See all options for prettier [here](https://prettier.io/docs/en/options.html).
860860
prettier = mkOption {
861-
description = "";
861+
description = lib.mdDoc "Additional prettier settings";
862862
type = types.submodule {
863863
imports = hookModule;
864864
options.settings = {
@@ -1101,7 +1101,7 @@ in
11011101
};
11021102
};
11031103
psalm = mkOption {
1104-
description = "";
1104+
description = lib.mdDoc "Additional psalm settings";
11051105
type = types.submodule {
11061106
imports = hookModule;
11071107
options.settings = {
@@ -1118,7 +1118,7 @@ in
11181118
};
11191119
};
11201120
pylint = mkOption {
1121-
description = "";
1121+
description = lib.mdDoc "Additional pylint settings";
11221122
type = types.submodule {
11231123
imports = hookModule;
11241124
options.settings = {
@@ -1147,7 +1147,7 @@ in
11471147
};
11481148
};
11491149
pyright = mkOption {
1150-
description = "";
1150+
description = lib.mdDoc "Additional pyright settings";
11511151
type = types.submodule {
11521152
imports = hookModule;
11531153
options.settings = {
@@ -1164,7 +1164,7 @@ in
11641164
};
11651165
};
11661166
pyupgrade = mkOption {
1167-
description = "";
1167+
description = lib.mdDoc "Additional pyupgrade settings";
11681168
type = types.submodule {
11691169
imports = hookModule;
11701170
options.settings = {
@@ -1181,7 +1181,7 @@ in
11811181
};
11821182
};
11831183
revive = mkOption {
1184-
description = "";
1184+
description = lib.mdDoc "Additional revive settings";
11851185
type = types.submodule {
11861186
imports = hookModule;
11871187
options.settings = {
@@ -1197,7 +1197,7 @@ in
11971197
};
11981198
};
11991199
rome = mkOption {
1200-
description = "";
1200+
description = lib.mdDoc "Additional rome settings";
12011201
type = types.submodule {
12021202
imports = hookModule;
12031203
options.settings = {
@@ -1227,7 +1227,7 @@ in
12271227
};
12281228
};
12291229
statix = mkOption {
1230-
description = "";
1230+
description = lib.mdDoc "Additional statix settings";
12311231
type = types.submodule {
12321232
imports = hookModule;
12331233
options.settings = {
@@ -1250,7 +1250,7 @@ in
12501250
};
12511251
# TODO: how do we provide a default package for this?
12521252
# treefmt = mkOption {
1253-
# description = "";
1253+
# description = lib.mdDoc "Additional treefmt settings";
12541254
# type = types.submodule {
12551255
# imports = hookModule;
12561256
# options.settings = {
@@ -1283,7 +1283,7 @@ in
12831283
# };
12841284
# };
12851285
typos = mkOption {
1286-
description = "";
1286+
description = lib.mdDoc "Additional typos settings";
12871287
type = types.submodule {
12881288
imports = hookModule;
12891289
options.settings = {
@@ -1365,7 +1365,7 @@ in
13651365
};
13661366
};
13671367
vale = mkOption {
1368-
description = "";
1368+
description = lib.mdDoc "Additional vale settings";
13691369
type = types.submodule {
13701370
imports = hookModule;
13711371
options.settings = {
@@ -1396,7 +1396,7 @@ in
13961396
};
13971397
};
13981398
yamllint = mkOption {
1399-
description = "";
1399+
description = lib.mdDoc "Additional yamllint settings";
14001400
type = types.submodule {
14011401
imports = hookModule;
14021402
options.settings = {

0 commit comments

Comments
 (0)