@grove-dev/core 0.4.0 → 0.5.0-next.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/awesome-readme.d.ts +63 -0
- package/dist/awesome-readme.d.ts.map +1 -0
- package/dist/awesome-readme.js +164 -0
- package/dist/awesome-readme.js.map +1 -0
- package/dist/build-data.d.ts.map +1 -1
- package/dist/build-data.js +4 -3
- package/dist/build-data.js.map +1 -1
- package/dist/collections.d.ts +6 -0
- package/dist/collections.d.ts.map +1 -1
- package/dist/collections.js.map +1 -1
- package/dist/content-body.d.ts +109 -0
- package/dist/content-body.d.ts.map +1 -0
- package/dist/content-body.js +194 -0
- package/dist/content-body.js.map +1 -0
- package/dist/decisions.js +1 -1
- package/dist/decisions.js.map +1 -1
- package/dist/directory-display.d.ts +7 -0
- package/dist/directory-display.d.ts.map +1 -1
- package/dist/directory-display.js +57 -0
- package/dist/directory-display.js.map +1 -1
- package/dist/directory-search.d.ts.map +1 -1
- package/dist/directory-search.js +9 -2
- package/dist/directory-search.js.map +1 -1
- package/dist/index.d.ts +7 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +18 -1
- package/dist/index.js.map +1 -1
- package/dist/io.d.ts.map +1 -1
- package/dist/io.js +9 -1
- package/dist/io.js.map +1 -1
- package/dist/schema.d.ts +81 -44
- package/dist/schema.d.ts.map +1 -1
- package/dist/schema.js +37 -1
- package/dist/schema.js.map +1 -1
- package/dist/validate.d.ts.map +1 -1
- package/dist/validate.js +9 -3
- package/dist/validate.js.map +1 -1
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -36,12 +36,12 @@ export declare const healthStatusSchema: z.ZodEnum<{
|
|
|
36
36
|
unavailable: "unavailable";
|
|
37
37
|
}>;
|
|
38
38
|
export declare const decisionVisibilitySchema: z.ZodEnum<{
|
|
39
|
+
hide: "hide";
|
|
40
|
+
remove: "remove";
|
|
39
41
|
historical: "historical";
|
|
40
42
|
needs_review: "needs_review";
|
|
41
43
|
highlight: "highlight";
|
|
42
44
|
keep: "keep";
|
|
43
|
-
hide: "hide";
|
|
44
|
-
remove: "remove";
|
|
45
45
|
}>;
|
|
46
46
|
export type DecisionVisibility = z.infer<typeof decisionVisibilitySchema>;
|
|
47
47
|
export declare const healthTierSchema: z.ZodEnum<{
|
|
@@ -61,6 +61,7 @@ export declare const projectTypeSchema: z.ZodEnum<{
|
|
|
61
61
|
template: "template";
|
|
62
62
|
}>;
|
|
63
63
|
export declare const resourceTypeSchema: z.ZodEnum<{
|
|
64
|
+
other: "other";
|
|
64
65
|
tool: "tool";
|
|
65
66
|
guide: "guide";
|
|
66
67
|
comparison: "comparison";
|
|
@@ -71,7 +72,6 @@ export declare const resourceTypeSchema: z.ZodEnum<{
|
|
|
71
72
|
course: "course";
|
|
72
73
|
book: "book";
|
|
73
74
|
podcast: "podcast";
|
|
74
|
-
other: "other";
|
|
75
75
|
}>;
|
|
76
76
|
export declare const entityTypeSchema: z.ZodEnum<{
|
|
77
77
|
other: "other";
|
|
@@ -206,12 +206,12 @@ export declare const healthBlockSchema: z.ZodObject<{
|
|
|
206
206
|
hidden: "hidden";
|
|
207
207
|
}>>;
|
|
208
208
|
visibility: z.ZodDefault<z.ZodEnum<{
|
|
209
|
+
hide: "hide";
|
|
210
|
+
remove: "remove";
|
|
209
211
|
historical: "historical";
|
|
210
212
|
needs_review: "needs_review";
|
|
211
213
|
highlight: "highlight";
|
|
212
214
|
keep: "keep";
|
|
213
|
-
hide: "hide";
|
|
214
|
-
remove: "remove";
|
|
215
215
|
}>>;
|
|
216
216
|
cleanupCandidate: z.ZodDefault<z.ZodBoolean>;
|
|
217
217
|
staleReason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
@@ -283,12 +283,12 @@ export declare const healthEntrySchema: z.ZodObject<{
|
|
|
283
283
|
hidden: "hidden";
|
|
284
284
|
}>>;
|
|
285
285
|
visibility: z.ZodDefault<z.ZodEnum<{
|
|
286
|
+
hide: "hide";
|
|
287
|
+
remove: "remove";
|
|
286
288
|
historical: "historical";
|
|
287
289
|
needs_review: "needs_review";
|
|
288
290
|
highlight: "highlight";
|
|
289
291
|
keep: "keep";
|
|
290
|
-
hide: "hide";
|
|
291
|
-
remove: "remove";
|
|
292
292
|
}>>;
|
|
293
293
|
cleanupCandidate: z.ZodDefault<z.ZodBoolean>;
|
|
294
294
|
staleReason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
@@ -361,12 +361,12 @@ export declare const healthFileSchema: z.ZodUnion<readonly [z.ZodArray<z.ZodObje
|
|
|
361
361
|
hidden: "hidden";
|
|
362
362
|
}>>;
|
|
363
363
|
visibility: z.ZodDefault<z.ZodEnum<{
|
|
364
|
+
hide: "hide";
|
|
365
|
+
remove: "remove";
|
|
364
366
|
historical: "historical";
|
|
365
367
|
needs_review: "needs_review";
|
|
366
368
|
highlight: "highlight";
|
|
367
369
|
keep: "keep";
|
|
368
|
-
hide: "hide";
|
|
369
|
-
remove: "remove";
|
|
370
370
|
}>>;
|
|
371
371
|
cleanupCandidate: z.ZodDefault<z.ZodBoolean>;
|
|
372
372
|
staleReason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
@@ -439,12 +439,12 @@ export declare const healthFileSchema: z.ZodUnion<readonly [z.ZodArray<z.ZodObje
|
|
|
439
439
|
hidden: "hidden";
|
|
440
440
|
}>>;
|
|
441
441
|
visibility: z.ZodDefault<z.ZodEnum<{
|
|
442
|
+
hide: "hide";
|
|
443
|
+
remove: "remove";
|
|
442
444
|
historical: "historical";
|
|
443
445
|
needs_review: "needs_review";
|
|
444
446
|
highlight: "highlight";
|
|
445
447
|
keep: "keep";
|
|
446
|
-
hide: "hide";
|
|
447
|
-
remove: "remove";
|
|
448
448
|
}>>;
|
|
449
449
|
cleanupCandidate: z.ZodDefault<z.ZodBoolean>;
|
|
450
450
|
staleReason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
@@ -461,12 +461,12 @@ export declare const decisionSchema: z.ZodObject<{
|
|
|
461
461
|
id: z.ZodString;
|
|
462
462
|
decision: z.ZodObject<{
|
|
463
463
|
visibility: z.ZodEnum<{
|
|
464
|
+
hide: "hide";
|
|
465
|
+
remove: "remove";
|
|
464
466
|
historical: "historical";
|
|
465
467
|
needs_review: "needs_review";
|
|
466
468
|
highlight: "highlight";
|
|
467
469
|
keep: "keep";
|
|
468
|
-
hide: "hide";
|
|
469
|
-
remove: "remove";
|
|
470
470
|
}>;
|
|
471
471
|
reason: z.ZodString;
|
|
472
472
|
reviewedBy: z.ZodOptional<z.ZodString>;
|
|
@@ -477,12 +477,12 @@ export declare const decisionsFileSchema: z.ZodUnion<readonly [z.ZodArray<z.ZodO
|
|
|
477
477
|
id: z.ZodString;
|
|
478
478
|
decision: z.ZodObject<{
|
|
479
479
|
visibility: z.ZodEnum<{
|
|
480
|
+
hide: "hide";
|
|
481
|
+
remove: "remove";
|
|
480
482
|
historical: "historical";
|
|
481
483
|
needs_review: "needs_review";
|
|
482
484
|
highlight: "highlight";
|
|
483
485
|
keep: "keep";
|
|
484
|
-
hide: "hide";
|
|
485
|
-
remove: "remove";
|
|
486
486
|
}>;
|
|
487
487
|
reason: z.ZodString;
|
|
488
488
|
reviewedBy: z.ZodOptional<z.ZodString>;
|
|
@@ -493,12 +493,12 @@ export declare const decisionsFileSchema: z.ZodUnion<readonly [z.ZodArray<z.ZodO
|
|
|
493
493
|
id: z.ZodString;
|
|
494
494
|
decision: z.ZodObject<{
|
|
495
495
|
visibility: z.ZodEnum<{
|
|
496
|
+
hide: "hide";
|
|
497
|
+
remove: "remove";
|
|
496
498
|
historical: "historical";
|
|
497
499
|
needs_review: "needs_review";
|
|
498
500
|
highlight: "highlight";
|
|
499
501
|
keep: "keep";
|
|
500
|
-
hide: "hide";
|
|
501
|
-
remove: "remove";
|
|
502
502
|
}>;
|
|
503
503
|
reason: z.ZodString;
|
|
504
504
|
reviewedBy: z.ZodOptional<z.ZodString>;
|
|
@@ -567,12 +567,12 @@ export declare const projectRecordSchema: z.ZodObject<{
|
|
|
567
567
|
overall: z.ZodOptional<z.ZodNumber>;
|
|
568
568
|
}, z.core.$strip>>;
|
|
569
569
|
visibility: z.ZodDefault<z.ZodEnum<{
|
|
570
|
+
hide: "hide";
|
|
571
|
+
remove: "remove";
|
|
570
572
|
historical: "historical";
|
|
571
573
|
needs_review: "needs_review";
|
|
572
574
|
highlight: "highlight";
|
|
573
575
|
keep: "keep";
|
|
574
|
-
hide: "hide";
|
|
575
|
-
remove: "remove";
|
|
576
576
|
}>>;
|
|
577
577
|
kind: z.ZodLiteral<"project">;
|
|
578
578
|
name: z.ZodString;
|
|
@@ -589,6 +589,7 @@ export declare const projectRecordSchema: z.ZodObject<{
|
|
|
589
589
|
stack: z.ZodOptional<z.ZodString>;
|
|
590
590
|
stacks: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
591
591
|
platforms: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
592
|
+
licenses: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
592
593
|
difficulty: z.ZodOptional<z.ZodEnum<{
|
|
593
594
|
beginner: "beginner";
|
|
594
595
|
intermediate: "intermediate";
|
|
@@ -684,12 +685,12 @@ export declare const projectRecordSchema: z.ZodObject<{
|
|
|
684
685
|
hidden: "hidden";
|
|
685
686
|
}>>;
|
|
686
687
|
visibility: z.ZodDefault<z.ZodEnum<{
|
|
688
|
+
hide: "hide";
|
|
689
|
+
remove: "remove";
|
|
687
690
|
historical: "historical";
|
|
688
691
|
needs_review: "needs_review";
|
|
689
692
|
highlight: "highlight";
|
|
690
693
|
keep: "keep";
|
|
691
|
-
hide: "hide";
|
|
692
|
-
remove: "remove";
|
|
693
694
|
}>>;
|
|
694
695
|
cleanupCandidate: z.ZodDefault<z.ZodBoolean>;
|
|
695
696
|
staleReason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
@@ -750,16 +751,17 @@ export declare const resourceRecordSchema: z.ZodObject<{
|
|
|
750
751
|
overall: z.ZodOptional<z.ZodNumber>;
|
|
751
752
|
}, z.core.$strip>>;
|
|
752
753
|
visibility: z.ZodDefault<z.ZodEnum<{
|
|
754
|
+
hide: "hide";
|
|
755
|
+
remove: "remove";
|
|
753
756
|
historical: "historical";
|
|
754
757
|
needs_review: "needs_review";
|
|
755
758
|
highlight: "highlight";
|
|
756
759
|
keep: "keep";
|
|
757
|
-
hide: "hide";
|
|
758
|
-
remove: "remove";
|
|
759
760
|
}>>;
|
|
760
761
|
kind: z.ZodLiteral<"resource">;
|
|
761
762
|
title: z.ZodString;
|
|
762
763
|
type: z.ZodEnum<{
|
|
764
|
+
other: "other";
|
|
763
765
|
tool: "tool";
|
|
764
766
|
guide: "guide";
|
|
765
767
|
comparison: "comparison";
|
|
@@ -770,7 +772,6 @@ export declare const resourceRecordSchema: z.ZodObject<{
|
|
|
770
772
|
course: "course";
|
|
771
773
|
book: "book";
|
|
772
774
|
podcast: "podcast";
|
|
773
|
-
other: "other";
|
|
774
775
|
}>;
|
|
775
776
|
topic: z.ZodString;
|
|
776
777
|
related: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
@@ -826,12 +827,12 @@ export declare const entityRecordSchema: z.ZodObject<{
|
|
|
826
827
|
overall: z.ZodOptional<z.ZodNumber>;
|
|
827
828
|
}, z.core.$strip>>;
|
|
828
829
|
visibility: z.ZodDefault<z.ZodEnum<{
|
|
830
|
+
hide: "hide";
|
|
831
|
+
remove: "remove";
|
|
829
832
|
historical: "historical";
|
|
830
833
|
needs_review: "needs_review";
|
|
831
834
|
highlight: "highlight";
|
|
832
835
|
keep: "keep";
|
|
833
|
-
hide: "hide";
|
|
834
|
-
remove: "remove";
|
|
835
836
|
}>>;
|
|
836
837
|
kind: z.ZodLiteral<"entity">;
|
|
837
838
|
name: z.ZodString;
|
|
@@ -902,12 +903,12 @@ export declare const resourceSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
|
902
903
|
overall: z.ZodOptional<z.ZodNumber>;
|
|
903
904
|
}, z.core.$strip>>;
|
|
904
905
|
visibility: z.ZodDefault<z.ZodEnum<{
|
|
906
|
+
hide: "hide";
|
|
907
|
+
remove: "remove";
|
|
905
908
|
historical: "historical";
|
|
906
909
|
needs_review: "needs_review";
|
|
907
910
|
highlight: "highlight";
|
|
908
911
|
keep: "keep";
|
|
909
|
-
hide: "hide";
|
|
910
|
-
remove: "remove";
|
|
911
912
|
}>>;
|
|
912
913
|
kind: z.ZodLiteral<"project">;
|
|
913
914
|
name: z.ZodString;
|
|
@@ -924,6 +925,7 @@ export declare const resourceSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
|
924
925
|
stack: z.ZodOptional<z.ZodString>;
|
|
925
926
|
stacks: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
926
927
|
platforms: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
928
|
+
licenses: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
927
929
|
difficulty: z.ZodOptional<z.ZodEnum<{
|
|
928
930
|
beginner: "beginner";
|
|
929
931
|
intermediate: "intermediate";
|
|
@@ -1019,12 +1021,12 @@ export declare const resourceSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
|
1019
1021
|
hidden: "hidden";
|
|
1020
1022
|
}>>;
|
|
1021
1023
|
visibility: z.ZodDefault<z.ZodEnum<{
|
|
1024
|
+
hide: "hide";
|
|
1025
|
+
remove: "remove";
|
|
1022
1026
|
historical: "historical";
|
|
1023
1027
|
needs_review: "needs_review";
|
|
1024
1028
|
highlight: "highlight";
|
|
1025
1029
|
keep: "keep";
|
|
1026
|
-
hide: "hide";
|
|
1027
|
-
remove: "remove";
|
|
1028
1030
|
}>>;
|
|
1029
1031
|
cleanupCandidate: z.ZodDefault<z.ZodBoolean>;
|
|
1030
1032
|
staleReason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
@@ -1083,16 +1085,17 @@ export declare const resourceSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
|
1083
1085
|
overall: z.ZodOptional<z.ZodNumber>;
|
|
1084
1086
|
}, z.core.$strip>>;
|
|
1085
1087
|
visibility: z.ZodDefault<z.ZodEnum<{
|
|
1088
|
+
hide: "hide";
|
|
1089
|
+
remove: "remove";
|
|
1086
1090
|
historical: "historical";
|
|
1087
1091
|
needs_review: "needs_review";
|
|
1088
1092
|
highlight: "highlight";
|
|
1089
1093
|
keep: "keep";
|
|
1090
|
-
hide: "hide";
|
|
1091
|
-
remove: "remove";
|
|
1092
1094
|
}>>;
|
|
1093
1095
|
kind: z.ZodLiteral<"resource">;
|
|
1094
1096
|
title: z.ZodString;
|
|
1095
1097
|
type: z.ZodEnum<{
|
|
1098
|
+
other: "other";
|
|
1096
1099
|
tool: "tool";
|
|
1097
1100
|
guide: "guide";
|
|
1098
1101
|
comparison: "comparison";
|
|
@@ -1103,7 +1106,6 @@ export declare const resourceSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
|
1103
1106
|
course: "course";
|
|
1104
1107
|
book: "book";
|
|
1105
1108
|
podcast: "podcast";
|
|
1106
|
-
other: "other";
|
|
1107
1109
|
}>;
|
|
1108
1110
|
topic: z.ZodString;
|
|
1109
1111
|
related: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
@@ -1157,12 +1159,12 @@ export declare const resourceSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
|
1157
1159
|
overall: z.ZodOptional<z.ZodNumber>;
|
|
1158
1160
|
}, z.core.$strip>>;
|
|
1159
1161
|
visibility: z.ZodDefault<z.ZodEnum<{
|
|
1162
|
+
hide: "hide";
|
|
1163
|
+
remove: "remove";
|
|
1160
1164
|
historical: "historical";
|
|
1161
1165
|
needs_review: "needs_review";
|
|
1162
1166
|
highlight: "highlight";
|
|
1163
1167
|
keep: "keep";
|
|
1164
|
-
hide: "hide";
|
|
1165
|
-
remove: "remove";
|
|
1166
1168
|
}>>;
|
|
1167
1169
|
kind: z.ZodLiteral<"entity">;
|
|
1168
1170
|
name: z.ZodString;
|
|
@@ -1233,12 +1235,12 @@ export declare const recordsFileSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
|
1233
1235
|
overall: z.ZodOptional<z.ZodNumber>;
|
|
1234
1236
|
}, z.core.$strip>>;
|
|
1235
1237
|
visibility: z.ZodDefault<z.ZodEnum<{
|
|
1238
|
+
hide: "hide";
|
|
1239
|
+
remove: "remove";
|
|
1236
1240
|
historical: "historical";
|
|
1237
1241
|
needs_review: "needs_review";
|
|
1238
1242
|
highlight: "highlight";
|
|
1239
1243
|
keep: "keep";
|
|
1240
|
-
hide: "hide";
|
|
1241
|
-
remove: "remove";
|
|
1242
1244
|
}>>;
|
|
1243
1245
|
kind: z.ZodLiteral<"project">;
|
|
1244
1246
|
name: z.ZodString;
|
|
@@ -1255,6 +1257,7 @@ export declare const recordsFileSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
|
1255
1257
|
stack: z.ZodOptional<z.ZodString>;
|
|
1256
1258
|
stacks: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
1257
1259
|
platforms: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
1260
|
+
licenses: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
1258
1261
|
difficulty: z.ZodOptional<z.ZodEnum<{
|
|
1259
1262
|
beginner: "beginner";
|
|
1260
1263
|
intermediate: "intermediate";
|
|
@@ -1350,12 +1353,12 @@ export declare const recordsFileSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
|
1350
1353
|
hidden: "hidden";
|
|
1351
1354
|
}>>;
|
|
1352
1355
|
visibility: z.ZodDefault<z.ZodEnum<{
|
|
1356
|
+
hide: "hide";
|
|
1357
|
+
remove: "remove";
|
|
1353
1358
|
historical: "historical";
|
|
1354
1359
|
needs_review: "needs_review";
|
|
1355
1360
|
highlight: "highlight";
|
|
1356
1361
|
keep: "keep";
|
|
1357
|
-
hide: "hide";
|
|
1358
|
-
remove: "remove";
|
|
1359
1362
|
}>>;
|
|
1360
1363
|
cleanupCandidate: z.ZodDefault<z.ZodBoolean>;
|
|
1361
1364
|
staleReason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
@@ -1414,16 +1417,17 @@ export declare const recordsFileSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
|
1414
1417
|
overall: z.ZodOptional<z.ZodNumber>;
|
|
1415
1418
|
}, z.core.$strip>>;
|
|
1416
1419
|
visibility: z.ZodDefault<z.ZodEnum<{
|
|
1420
|
+
hide: "hide";
|
|
1421
|
+
remove: "remove";
|
|
1417
1422
|
historical: "historical";
|
|
1418
1423
|
needs_review: "needs_review";
|
|
1419
1424
|
highlight: "highlight";
|
|
1420
1425
|
keep: "keep";
|
|
1421
|
-
hide: "hide";
|
|
1422
|
-
remove: "remove";
|
|
1423
1426
|
}>>;
|
|
1424
1427
|
kind: z.ZodLiteral<"resource">;
|
|
1425
1428
|
title: z.ZodString;
|
|
1426
1429
|
type: z.ZodEnum<{
|
|
1430
|
+
other: "other";
|
|
1427
1431
|
tool: "tool";
|
|
1428
1432
|
guide: "guide";
|
|
1429
1433
|
comparison: "comparison";
|
|
@@ -1434,7 +1438,6 @@ export declare const recordsFileSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
|
1434
1438
|
course: "course";
|
|
1435
1439
|
book: "book";
|
|
1436
1440
|
podcast: "podcast";
|
|
1437
|
-
other: "other";
|
|
1438
1441
|
}>;
|
|
1439
1442
|
topic: z.ZodString;
|
|
1440
1443
|
related: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
@@ -1488,12 +1491,12 @@ export declare const recordsFileSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
|
1488
1491
|
overall: z.ZodOptional<z.ZodNumber>;
|
|
1489
1492
|
}, z.core.$strip>>;
|
|
1490
1493
|
visibility: z.ZodDefault<z.ZodEnum<{
|
|
1494
|
+
hide: "hide";
|
|
1495
|
+
remove: "remove";
|
|
1491
1496
|
historical: "historical";
|
|
1492
1497
|
needs_review: "needs_review";
|
|
1493
1498
|
highlight: "highlight";
|
|
1494
1499
|
keep: "keep";
|
|
1495
|
-
hide: "hide";
|
|
1496
|
-
remove: "remove";
|
|
1497
1500
|
}>>;
|
|
1498
1501
|
kind: z.ZodLiteral<"entity">;
|
|
1499
1502
|
name: z.ZodString;
|
|
@@ -1595,6 +1598,26 @@ export declare const auditSchema: z.ZodObject<{
|
|
|
1595
1598
|
sample: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1596
1599
|
}, z.core.$strip>>;
|
|
1597
1600
|
}, z.core.$strip>;
|
|
1601
|
+
/**
|
|
1602
|
+
* README preamble configuration. Every field is optional; unset fields
|
|
1603
|
+
* fall back to the matching site.* field, or to a sensible default.
|
|
1604
|
+
*
|
|
1605
|
+
* `intro` is rendered as raw markdown between the H1 and the
|
|
1606
|
+
* `## Contents` TOC, so curators can write a hand-rolled lead section
|
|
1607
|
+
* (sub-headings, paragraphs, lists) without editing the generated
|
|
1608
|
+
* README on every regeneration.
|
|
1609
|
+
*/
|
|
1610
|
+
export declare const readmeConfigSchema: z.ZodObject<{
|
|
1611
|
+
title: z.ZodOptional<z.ZodString>;
|
|
1612
|
+
tagline: z.ZodOptional<z.ZodString>;
|
|
1613
|
+
description: z.ZodOptional<z.ZodString>;
|
|
1614
|
+
url: z.ZodOptional<z.ZodString>;
|
|
1615
|
+
browseLabel: z.ZodOptional<z.ZodString>;
|
|
1616
|
+
intro: z.ZodOptional<z.ZodString>;
|
|
1617
|
+
showBadge: z.ZodDefault<z.ZodBoolean>;
|
|
1618
|
+
showToc: z.ZodDefault<z.ZodBoolean>;
|
|
1619
|
+
showBrowseLink: z.ZodDefault<z.ZodBoolean>;
|
|
1620
|
+
}, z.core.$strip>;
|
|
1598
1621
|
export declare const groveConfigSchema: z.ZodObject<{
|
|
1599
1622
|
blueprint: z.ZodDefault<z.ZodEnum<{
|
|
1600
1623
|
"project-directory": "project-directory";
|
|
@@ -1681,6 +1704,17 @@ export declare const groveConfigSchema: z.ZodObject<{
|
|
|
1681
1704
|
sample: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1682
1705
|
}, z.core.$strip>>;
|
|
1683
1706
|
}, z.core.$strip>>;
|
|
1707
|
+
readme: z.ZodOptional<z.ZodObject<{
|
|
1708
|
+
title: z.ZodOptional<z.ZodString>;
|
|
1709
|
+
tagline: z.ZodOptional<z.ZodString>;
|
|
1710
|
+
description: z.ZodOptional<z.ZodString>;
|
|
1711
|
+
url: z.ZodOptional<z.ZodString>;
|
|
1712
|
+
browseLabel: z.ZodOptional<z.ZodString>;
|
|
1713
|
+
intro: z.ZodOptional<z.ZodString>;
|
|
1714
|
+
showBadge: z.ZodDefault<z.ZodBoolean>;
|
|
1715
|
+
showToc: z.ZodDefault<z.ZodBoolean>;
|
|
1716
|
+
showBrowseLink: z.ZodDefault<z.ZodBoolean>;
|
|
1717
|
+
}, z.core.$strip>>;
|
|
1684
1718
|
components: z.ZodDefault<z.ZodObject<{
|
|
1685
1719
|
Header: z.ZodOptional<z.ZodString>;
|
|
1686
1720
|
Footer: z.ZodOptional<z.ZodString>;
|
|
@@ -1726,6 +1760,7 @@ export type EntityType = z.infer<typeof entityTypeSchema>;
|
|
|
1726
1760
|
export type AppLabel = z.infer<typeof appLabelSchema>;
|
|
1727
1761
|
export type Score = z.infer<typeof scoreSchema>;
|
|
1728
1762
|
export type Links = z.infer<typeof linksSchema>;
|
|
1763
|
+
export type ReadmeConfig = z.infer<typeof readmeConfigSchema>;
|
|
1729
1764
|
export declare function unwrapHealth(value: HealthFile): HealthEntry[];
|
|
1730
1765
|
export declare function unwrapDecisions(value: DecisionsFile): Decision[];
|
|
1731
1766
|
export declare function unwrapOverrides(value: OverridesFile): Override[];
|
|
@@ -1748,6 +1783,7 @@ export interface IndexBase {
|
|
|
1748
1783
|
description: string;
|
|
1749
1784
|
content?: string | undefined;
|
|
1750
1785
|
curation: ProjectRecord["curation"];
|
|
1786
|
+
licenses: string[];
|
|
1751
1787
|
}
|
|
1752
1788
|
export interface IndexGithubSummary {
|
|
1753
1789
|
fullName: string | undefined;
|
|
@@ -1766,6 +1802,7 @@ export interface IndexProjectRecord extends IndexBase {
|
|
|
1766
1802
|
stack: ProjectRecord["stack"];
|
|
1767
1803
|
stacks: string[];
|
|
1768
1804
|
platforms: string[];
|
|
1805
|
+
licenses: string[];
|
|
1769
1806
|
projectType: ProjectRecord["projectType"];
|
|
1770
1807
|
repoUrl: ProjectRecord["repoUrl"];
|
|
1771
1808
|
logoUrl: ProjectRecord["logoUrl"];
|
package/dist/schema.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAOxB;;;;;GAKG;AACH,eAAO,MAAM,eAAe;;;;EAI1B,CAAC;AAEH,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAExD;;;;GAIG;AACH,eAAO,MAAM,kBAAkB;;;;EAA4C,CAAC;AAE5E,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,SAAS,EAAE,YAAY,CAIzD,CAAC;AAMF,eAAO,MAAM,kBAAkB;;;;;;;;;;;EAW7B,CAAC;AAEH,eAAO,MAAM,wBAAwB;;;;;;;EAOnC,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E,eAAO,MAAM,gBAAgB;;;;;EAK3B,CAAC;AAMH,eAAO,MAAM,iBAAiB;;;;;;;;;EAS5B,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;EAY7B,CAAC;AAEH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;EAY3B,CAAC;AAEH,eAAO,MAAM,cAAc;;;;;EAA+C,CAAC;AAE3E,eAAO,MAAM,WAAW;;;;;;;iBAOtB,CAAC;AAMH,eAAO,MAAM,WAAW;;;;;kCAQV,CAAC;AAMf,eAAO,MAAM,mBAAmB;;;;;mBASnB,CAAC;AAEd,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA+BnB,CAAC;AAEjB,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoC/B,CAAC;AAEH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAS5B,CAAC;AAEH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAI5B,CAAC;AAEH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAG3B,CAAC;AAMH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;iBAQzB,CAAC;AAEH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAG9B,CAAC;AAMH,eAAO,MAAM,cAAc;;;iBAGzB,CAAC;AAEH,eAAO,MAAM,mBAAmB;;;;;;;;mBAG9B,CAAC;AAwDH,eAAO,MAAM,mBAAmB
|
|
1
|
+
{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAOxB;;;;;GAKG;AACH,eAAO,MAAM,eAAe;;;;EAI1B,CAAC;AAEH,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAExD;;;;GAIG;AACH,eAAO,MAAM,kBAAkB;;;;EAA4C,CAAC;AAE5E,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,SAAS,EAAE,YAAY,CAIzD,CAAC;AAMF,eAAO,MAAM,kBAAkB;;;;;;;;;;;EAW7B,CAAC;AAEH,eAAO,MAAM,wBAAwB;;;;;;;EAOnC,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E,eAAO,MAAM,gBAAgB;;;;;EAK3B,CAAC;AAMH,eAAO,MAAM,iBAAiB;;;;;;;;;EAS5B,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;EAY7B,CAAC;AAEH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;EAY3B,CAAC;AAEH,eAAO,MAAM,cAAc;;;;;EAA+C,CAAC;AAE3E,eAAO,MAAM,WAAW;;;;;;;iBAOtB,CAAC;AAMH,eAAO,MAAM,WAAW;;;;;kCAQV,CAAC;AAMf,eAAO,MAAM,mBAAmB;;;;;mBASnB,CAAC;AAEd,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA+BnB,CAAC;AAEjB,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoC/B,CAAC;AAEH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAS5B,CAAC;AAEH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAI5B,CAAC;AAEH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAG3B,CAAC;AAMH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;iBAQzB,CAAC;AAEH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAG9B,CAAC;AAMH,eAAO,MAAM,cAAc;;;iBAGzB,CAAC;AAEH,eAAO,MAAM,mBAAmB;;;;;;;;mBAG9B,CAAC;AAwDH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAuD9B,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAMhE,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAQ/B,CAAC;AAEH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAMlE,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAQ7B,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAM9D,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAIzB,CAAC;AAEH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAiBtD,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAAiB,CAAC;AAEhD,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAM5D,eAAO,MAAM,aAAa;;;iBAGxB,CAAC;AAEH,eAAO,MAAM,mBAAmB;;;;iBAE9B,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;;;;iBAG7B,CAAC;AAEH,eAAO,MAAM,YAAY;;;;;;;;;;;kBAME,CAAC;AAE5B,eAAO,MAAM,gBAAgB;;;;;;kBAQM,CAAC;AAEpC,eAAO,MAAM,uBAAuB;;;;mBAOlC,CAAC;AAEH,eAAO,MAAM,WAAW;;;;;;;;;;;;;iBAKtB,CAAC;AAEH,eAAO,MAAM,uBAAuB;;;;;;iBAMlC,CAAC;AAuBH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;iBAGtB,CAAC;AAEH;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;iBAU7B,CAAC;AAEH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAsH5B,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAC5D,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AACjE,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AACpD,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AACxD,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAChE,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AAChD,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAClE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AACtE,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAC9D,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAC1D,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAC1D,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAC5D,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAChE,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AACtD,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAChE,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AACtD,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAC5D,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAC9D,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAC1D,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AACtD,MAAM,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AAChD,MAAM,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AAChD,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAM9D,wBAAgB,YAAY,CAAC,KAAK,EAAE,UAAU,GAAG,WAAW,EAAE,CAE7D;AAED,wBAAgB,eAAe,CAAC,KAAK,EAAE,aAAa,GAAG,QAAQ,EAAE,CAEhE;AAED,wBAAgB,eAAe,CAAC,KAAK,EAAE,aAAa,GAAG,QAAQ,EAAE,CAEhE;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,GACf,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAUzB;AAED,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAM3E;AAED,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,GACjC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAQxC;AAgBD,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,YAAY,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,QAAQ,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IACpC,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,kBAAmB,SAAQ,SAAS;IACnD,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;IAC9B,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,WAAW,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC;IAC1C,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IAClC,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IAClC,UAAU,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;IACxC,YAAY,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;IAC5C,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChC,sEAAsE;IACtE,UAAU,EAAE,kBAAkB,CAAC;IAC/B,MAAM,EAAE,kBAAkB,GAAG,SAAS,CAAC;CACxC;AAED,MAAM,WAAW,mBAAoB,SAAQ,SAAS;IACpD,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,WAAW,EAAE,cAAc,CAAC,aAAa,CAAC,CAAC;IAC3C,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC;IACjC,kFAAkF;IAClF,UAAU,EAAE,kBAAkB,CAAC;CAChC;AAED,MAAM,WAAW,iBAAkB,SAAQ,SAAS;IAClD,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;IAC3B,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC;IACjC,QAAQ,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC;IACnC,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC;IACjC,MAAM,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC;IAC/B,kFAAkF;IAClF,UAAU,EAAE,kBAAkB,CAAC;CAChC;AAED,MAAM,MAAM,WAAW,GACnB,kBAAkB,GAClB,mBAAmB,GACnB,iBAAiB,CAAC;AAEtB,wBAAgB,cAAc,CAAC,CAAC,EAAE,WAAW,GAAG,CAAC,IAAI,kBAAkB,CAEtE;AACD,wBAAgB,eAAe,CAAC,CAAC,EAAE,WAAW,GAAG,CAAC,IAAI,mBAAmB,CAExE;AACD,wBAAgB,aAAa,CAAC,CAAC,EAAE,WAAW,GAAG,CAAC,IAAI,iBAAiB,CAEpE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,QAAQ,GAAG,WAAW,CAsF3D"}
|
package/dist/schema.js
CHANGED
|
@@ -296,6 +296,10 @@ export const projectRecordSchema = resourceBaseSchema.extend({
|
|
|
296
296
|
stack: z.string().optional(),
|
|
297
297
|
stacks: z.array(z.string()).default([]),
|
|
298
298
|
platforms: z.array(z.string()).default([]),
|
|
299
|
+
// SPDX license identifiers (e.g. ["mit"], ["apache-2.0"]). Hand-
|
|
300
|
+
// authored when a record is curated; otherwise derived from the
|
|
301
|
+
// GitHub sync's `license.spdx_id` field at build time.
|
|
302
|
+
licenses: z.array(z.string()).default([]),
|
|
299
303
|
difficulty: z.enum(["beginner", "intermediate", "advanced"]).optional(),
|
|
300
304
|
codebaseSize: z.enum(["small", "medium", "large", "huge"]).optional(),
|
|
301
305
|
// Canonical repo URL. Distinct from `links.github`, which is the
|
|
@@ -459,6 +463,26 @@ export const auditSchema = z.object({
|
|
|
459
463
|
baseUrl: z.string().url().optional(),
|
|
460
464
|
pages: z.array(auditPageManifestEntrySchema).min(1),
|
|
461
465
|
});
|
|
466
|
+
/**
|
|
467
|
+
* README preamble configuration. Every field is optional; unset fields
|
|
468
|
+
* fall back to the matching site.* field, or to a sensible default.
|
|
469
|
+
*
|
|
470
|
+
* `intro` is rendered as raw markdown between the H1 and the
|
|
471
|
+
* `## Contents` TOC, so curators can write a hand-rolled lead section
|
|
472
|
+
* (sub-headings, paragraphs, lists) without editing the generated
|
|
473
|
+
* README on every regeneration.
|
|
474
|
+
*/
|
|
475
|
+
export const readmeConfigSchema = z.object({
|
|
476
|
+
title: z.string().min(1).optional(),
|
|
477
|
+
tagline: z.string().optional(),
|
|
478
|
+
description: z.string().optional(),
|
|
479
|
+
url: z.string().url().optional(),
|
|
480
|
+
browseLabel: z.string().min(1).optional(),
|
|
481
|
+
intro: z.string().optional(),
|
|
482
|
+
showBadge: z.boolean().default(true),
|
|
483
|
+
showToc: z.boolean().default(true),
|
|
484
|
+
showBrowseLink: z.boolean().default(true),
|
|
485
|
+
});
|
|
462
486
|
export const groveConfigSchema = z.object({
|
|
463
487
|
blueprint: blueprintSchema.default("project-directory"),
|
|
464
488
|
site: z.object({
|
|
@@ -528,6 +552,13 @@ export const groveConfigSchema = z.object({
|
|
|
528
552
|
* Each entry is a canonical page the audit must score 100×4.
|
|
529
553
|
*/
|
|
530
554
|
audit: auditSchema.optional(),
|
|
555
|
+
/**
|
|
556
|
+
* Override the awesome-list README preamble generated by
|
|
557
|
+
* `grove readme generate`. Any field left unset falls back to the
|
|
558
|
+
* matching site.* field, so a project can opt into customization
|
|
559
|
+
* incrementally without rewriting everything.
|
|
560
|
+
*/
|
|
561
|
+
readme: readmeConfigSchema.optional(),
|
|
531
562
|
components: componentOverrideSchema.default({}),
|
|
532
563
|
paths: z
|
|
533
564
|
.object({
|
|
@@ -574,7 +605,11 @@ export function unwrapOverrides(value) {
|
|
|
574
605
|
* `kind` field on the YAML selects which blueprint schema to apply.
|
|
575
606
|
*/
|
|
576
607
|
export function parseRecordYaml(text, fileSlug) {
|
|
577
|
-
|
|
608
|
+
// `schema: 'core'` opts out of custom-tag interpretation so a
|
|
609
|
+
// record file cannot smuggle `!!binary` / `!!js/function` / etc.
|
|
610
|
+
// into host objects. The default schema would interpret them.
|
|
611
|
+
// (Implementation-checklist.md #27.)
|
|
612
|
+
const raw = parse(text, { schema: "core" }) ?? {};
|
|
578
613
|
if (typeof raw !== "object" || Array.isArray(raw)) {
|
|
579
614
|
throw new Error(`${fileSlug}: record file must contain a YAML mapping`);
|
|
580
615
|
}
|
|
@@ -630,6 +665,7 @@ export function toIndexRecord(record) {
|
|
|
630
665
|
description: record.description,
|
|
631
666
|
content: record.content,
|
|
632
667
|
curation: record.curation,
|
|
668
|
+
licenses: record.kind === "project" ? record.licenses ?? [] : [],
|
|
633
669
|
};
|
|
634
670
|
if (record.kind === "project") {
|
|
635
671
|
const r = record;
|