create-typescript-app 2.24.4 → 2.24.5
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/lib/base.d.ts +5 -0
- package/lib/base.js +5 -0
- package/lib/blocks/blockAllContributors.d.ts +1 -0
- package/lib/blocks/blockAreTheTypesWrong.d.ts +1 -0
- package/lib/blocks/blockCSpell.d.ts +1 -0
- package/lib/blocks/blockCTATransitions.d.ts +1 -0
- package/lib/blocks/blockCodecov.d.ts +1 -0
- package/lib/blocks/blockContributingDocs.d.ts +1 -0
- package/lib/blocks/blockContributorCovenant.d.ts +1 -0
- package/lib/blocks/blockDevelopmentDocs.d.ts +1 -0
- package/lib/blocks/blockESLint.d.ts +1 -0
- package/lib/blocks/blockESLintComments.d.ts +1 -0
- package/lib/blocks/blockESLintJSDoc.d.ts +1 -0
- package/lib/blocks/blockESLintJSONC.d.ts +1 -0
- package/lib/blocks/blockESLintMarkdown.d.ts +1 -0
- package/lib/blocks/blockESLintMoreStyling.d.ts +1 -0
- package/lib/blocks/blockESLintNode.d.ts +1 -0
- package/lib/blocks/blockESLintPackageJson.d.ts +1 -0
- package/lib/blocks/blockESLintPerfectionist.d.ts +1 -0
- package/lib/blocks/blockESLintRegexp.d.ts +1 -0
- package/lib/blocks/blockESLintYML.d.ts +1 -0
- package/lib/blocks/blockExampleFiles.d.ts +1 -0
- package/lib/blocks/blockFunding.d.ts +1 -0
- package/lib/blocks/blockGitHubActionsCI.d.ts +1 -0
- package/lib/blocks/blockGitHubApps.d.ts +1 -0
- package/lib/blocks/blockGitHubIssueTemplates.d.ts +1 -0
- package/lib/blocks/blockGitHubPRTemplate.d.ts +1 -0
- package/lib/blocks/blockGitignore.d.ts +1 -0
- package/lib/blocks/blockKnip.d.ts +1 -0
- package/lib/blocks/blockMITLicense.d.ts +1 -0
- package/lib/blocks/blockMain.d.ts +1 -0
- package/lib/blocks/blockMarkdownlint.d.ts +1 -0
- package/lib/blocks/blockNcc.d.ts +1 -0
- package/lib/blocks/blockNvmrc.d.ts +1 -0
- package/lib/blocks/blockPRCompliance.d.ts +1 -0
- package/lib/blocks/blockPackageJson.d.ts +1 -0
- package/lib/blocks/blockPnpmDedupe.d.ts +1 -0
- package/lib/blocks/blockPrettier.d.ts +1 -0
- package/lib/blocks/blockPrettierPluginCurly.d.ts +1 -0
- package/lib/blocks/blockPrettierPluginPackageJson.d.ts +1 -0
- package/lib/blocks/blockPrettierPluginSh.d.ts +1 -0
- package/lib/blocks/blockREADME.d.ts +1 -0
- package/lib/blocks/blockREADME.js +6 -2
- package/lib/blocks/blockReleaseIt.d.ts +1 -0
- package/lib/blocks/blockRemoveDependencies.d.ts +1 -0
- package/lib/blocks/blockRemoveFiles.d.ts +1 -0
- package/lib/blocks/blockRemoveWorkflows.d.ts +1 -0
- package/lib/blocks/blockRenovate.d.ts +1 -0
- package/lib/blocks/blockRepositoryBranchRuleset.d.ts +1 -0
- package/lib/blocks/blockRepositoryLabels.d.ts +1 -0
- package/lib/blocks/blockRepositorySecrets.d.ts +1 -0
- package/lib/blocks/blockRepositorySettings.d.ts +1 -0
- package/lib/blocks/blockSecurityDocs.d.ts +1 -0
- package/lib/blocks/blockTSup.d.ts +1 -0
- package/lib/blocks/blockTemplatedWith.d.ts +1 -0
- package/lib/blocks/blockTypeScript.d.ts +1 -0
- package/lib/blocks/blockVSCode.d.ts +1 -0
- package/lib/blocks/blockVitest.d.ts +1 -0
- package/lib/blocks/index.d.ts +45 -0
- package/lib/data/packageData.d.ts +1 -1
- package/lib/index.d.ts +6 -0
- package/lib/options/readDocumentation.d.ts +1 -1
- package/lib/options/readDocumentation.js +4 -2
- package/lib/options/readReadmeAdditional.js +2 -2
- package/lib/options/readReadmeFootnotes.d.ts +4 -0
- package/lib/options/readReadmeFootnotes.js +17 -0
- package/lib/presets/common.d.ts +5 -0
- package/lib/presets/everything.d.ts +5 -0
- package/lib/presets/index.d.ts +15 -0
- package/lib/presets/minimal.d.ts +5 -0
- package/lib/schemas.d.ts +8 -0
- package/lib/schemas.js +1 -0
- package/lib/template.d.ts +5 -0
- package/package.json +1 -1
package/lib/blocks/index.d.ts
CHANGED
|
@@ -57,6 +57,7 @@ declare const blocks: {
|
|
|
57
57
|
usage: string;
|
|
58
58
|
additional?: string | undefined;
|
|
59
59
|
explainer?: string | undefined;
|
|
60
|
+
footnotes?: string | undefined;
|
|
60
61
|
};
|
|
61
62
|
development?: string | undefined;
|
|
62
63
|
};
|
|
@@ -124,6 +125,7 @@ declare const blocks: {
|
|
|
124
125
|
usage: string;
|
|
125
126
|
additional?: string | undefined;
|
|
126
127
|
explainer?: string | undefined;
|
|
128
|
+
footnotes?: string | undefined;
|
|
127
129
|
};
|
|
128
130
|
development?: string | undefined;
|
|
129
131
|
};
|
|
@@ -193,6 +195,7 @@ declare const blocks: {
|
|
|
193
195
|
usage: string;
|
|
194
196
|
additional?: string | undefined;
|
|
195
197
|
explainer?: string | undefined;
|
|
198
|
+
footnotes?: string | undefined;
|
|
196
199
|
};
|
|
197
200
|
development?: string | undefined;
|
|
198
201
|
};
|
|
@@ -260,6 +263,7 @@ declare const blocks: {
|
|
|
260
263
|
usage: string;
|
|
261
264
|
additional?: string | undefined;
|
|
262
265
|
explainer?: string | undefined;
|
|
266
|
+
footnotes?: string | undefined;
|
|
263
267
|
};
|
|
264
268
|
development?: string | undefined;
|
|
265
269
|
};
|
|
@@ -327,6 +331,7 @@ declare const blocks: {
|
|
|
327
331
|
usage: string;
|
|
328
332
|
additional?: string | undefined;
|
|
329
333
|
explainer?: string | undefined;
|
|
334
|
+
footnotes?: string | undefined;
|
|
330
335
|
};
|
|
331
336
|
development?: string | undefined;
|
|
332
337
|
};
|
|
@@ -397,6 +402,7 @@ declare const blocks: {
|
|
|
397
402
|
usage: string;
|
|
398
403
|
additional?: string | undefined;
|
|
399
404
|
explainer?: string | undefined;
|
|
405
|
+
footnotes?: string | undefined;
|
|
400
406
|
};
|
|
401
407
|
development?: string | undefined;
|
|
402
408
|
};
|
|
@@ -478,6 +484,7 @@ declare const blocks: {
|
|
|
478
484
|
usage: string;
|
|
479
485
|
additional?: string | undefined;
|
|
480
486
|
explainer?: string | undefined;
|
|
487
|
+
footnotes?: string | undefined;
|
|
481
488
|
};
|
|
482
489
|
development?: string | undefined;
|
|
483
490
|
};
|
|
@@ -571,6 +578,7 @@ declare const blocks: {
|
|
|
571
578
|
usage: string;
|
|
572
579
|
additional?: string | undefined;
|
|
573
580
|
explainer?: string | undefined;
|
|
581
|
+
footnotes?: string | undefined;
|
|
574
582
|
};
|
|
575
583
|
development?: string | undefined;
|
|
576
584
|
};
|
|
@@ -638,6 +646,7 @@ declare const blocks: {
|
|
|
638
646
|
usage: string;
|
|
639
647
|
additional?: string | undefined;
|
|
640
648
|
explainer?: string | undefined;
|
|
649
|
+
footnotes?: string | undefined;
|
|
641
650
|
};
|
|
642
651
|
development?: string | undefined;
|
|
643
652
|
};
|
|
@@ -705,6 +714,7 @@ declare const blocks: {
|
|
|
705
714
|
usage: string;
|
|
706
715
|
additional?: string | undefined;
|
|
707
716
|
explainer?: string | undefined;
|
|
717
|
+
footnotes?: string | undefined;
|
|
708
718
|
};
|
|
709
719
|
development?: string | undefined;
|
|
710
720
|
};
|
|
@@ -772,6 +782,7 @@ declare const blocks: {
|
|
|
772
782
|
usage: string;
|
|
773
783
|
additional?: string | undefined;
|
|
774
784
|
explainer?: string | undefined;
|
|
785
|
+
footnotes?: string | undefined;
|
|
775
786
|
};
|
|
776
787
|
development?: string | undefined;
|
|
777
788
|
};
|
|
@@ -839,6 +850,7 @@ declare const blocks: {
|
|
|
839
850
|
usage: string;
|
|
840
851
|
additional?: string | undefined;
|
|
841
852
|
explainer?: string | undefined;
|
|
853
|
+
footnotes?: string | undefined;
|
|
842
854
|
};
|
|
843
855
|
development?: string | undefined;
|
|
844
856
|
};
|
|
@@ -906,6 +918,7 @@ declare const blocks: {
|
|
|
906
918
|
usage: string;
|
|
907
919
|
additional?: string | undefined;
|
|
908
920
|
explainer?: string | undefined;
|
|
921
|
+
footnotes?: string | undefined;
|
|
909
922
|
};
|
|
910
923
|
development?: string | undefined;
|
|
911
924
|
};
|
|
@@ -973,6 +986,7 @@ declare const blocks: {
|
|
|
973
986
|
usage: string;
|
|
974
987
|
additional?: string | undefined;
|
|
975
988
|
explainer?: string | undefined;
|
|
989
|
+
footnotes?: string | undefined;
|
|
976
990
|
};
|
|
977
991
|
development?: string | undefined;
|
|
978
992
|
};
|
|
@@ -1040,6 +1054,7 @@ declare const blocks: {
|
|
|
1040
1054
|
usage: string;
|
|
1041
1055
|
additional?: string | undefined;
|
|
1042
1056
|
explainer?: string | undefined;
|
|
1057
|
+
footnotes?: string | undefined;
|
|
1043
1058
|
};
|
|
1044
1059
|
development?: string | undefined;
|
|
1045
1060
|
};
|
|
@@ -1107,6 +1122,7 @@ declare const blocks: {
|
|
|
1107
1122
|
usage: string;
|
|
1108
1123
|
additional?: string | undefined;
|
|
1109
1124
|
explainer?: string | undefined;
|
|
1125
|
+
footnotes?: string | undefined;
|
|
1110
1126
|
};
|
|
1111
1127
|
development?: string | undefined;
|
|
1112
1128
|
};
|
|
@@ -1174,6 +1190,7 @@ declare const blocks: {
|
|
|
1174
1190
|
usage: string;
|
|
1175
1191
|
additional?: string | undefined;
|
|
1176
1192
|
explainer?: string | undefined;
|
|
1193
|
+
footnotes?: string | undefined;
|
|
1177
1194
|
};
|
|
1178
1195
|
development?: string | undefined;
|
|
1179
1196
|
};
|
|
@@ -1241,6 +1258,7 @@ declare const blocks: {
|
|
|
1241
1258
|
usage: string;
|
|
1242
1259
|
additional?: string | undefined;
|
|
1243
1260
|
explainer?: string | undefined;
|
|
1261
|
+
footnotes?: string | undefined;
|
|
1244
1262
|
};
|
|
1245
1263
|
development?: string | undefined;
|
|
1246
1264
|
};
|
|
@@ -1308,6 +1326,7 @@ declare const blocks: {
|
|
|
1308
1326
|
usage: string;
|
|
1309
1327
|
additional?: string | undefined;
|
|
1310
1328
|
explainer?: string | undefined;
|
|
1329
|
+
footnotes?: string | undefined;
|
|
1311
1330
|
};
|
|
1312
1331
|
development?: string | undefined;
|
|
1313
1332
|
};
|
|
@@ -1390,6 +1409,7 @@ declare const blocks: {
|
|
|
1390
1409
|
usage: string;
|
|
1391
1410
|
additional?: string | undefined;
|
|
1392
1411
|
explainer?: string | undefined;
|
|
1412
|
+
footnotes?: string | undefined;
|
|
1393
1413
|
};
|
|
1394
1414
|
development?: string | undefined;
|
|
1395
1415
|
};
|
|
@@ -1457,6 +1477,7 @@ declare const blocks: {
|
|
|
1457
1477
|
usage: string;
|
|
1458
1478
|
additional?: string | undefined;
|
|
1459
1479
|
explainer?: string | undefined;
|
|
1480
|
+
footnotes?: string | undefined;
|
|
1460
1481
|
};
|
|
1461
1482
|
development?: string | undefined;
|
|
1462
1483
|
};
|
|
@@ -1524,6 +1545,7 @@ declare const blocks: {
|
|
|
1524
1545
|
usage: string;
|
|
1525
1546
|
additional?: string | undefined;
|
|
1526
1547
|
explainer?: string | undefined;
|
|
1548
|
+
footnotes?: string | undefined;
|
|
1527
1549
|
};
|
|
1528
1550
|
development?: string | undefined;
|
|
1529
1551
|
};
|
|
@@ -1593,6 +1615,7 @@ declare const blocks: {
|
|
|
1593
1615
|
usage: string;
|
|
1594
1616
|
additional?: string | undefined;
|
|
1595
1617
|
explainer?: string | undefined;
|
|
1618
|
+
footnotes?: string | undefined;
|
|
1596
1619
|
};
|
|
1597
1620
|
development?: string | undefined;
|
|
1598
1621
|
};
|
|
@@ -1662,6 +1685,7 @@ declare const blocks: {
|
|
|
1662
1685
|
usage: string;
|
|
1663
1686
|
additional?: string | undefined;
|
|
1664
1687
|
explainer?: string | undefined;
|
|
1688
|
+
footnotes?: string | undefined;
|
|
1665
1689
|
};
|
|
1666
1690
|
development?: string | undefined;
|
|
1667
1691
|
};
|
|
@@ -1732,6 +1756,7 @@ declare const blocks: {
|
|
|
1732
1756
|
usage: string;
|
|
1733
1757
|
additional?: string | undefined;
|
|
1734
1758
|
explainer?: string | undefined;
|
|
1759
|
+
footnotes?: string | undefined;
|
|
1735
1760
|
};
|
|
1736
1761
|
development?: string | undefined;
|
|
1737
1762
|
};
|
|
@@ -1801,6 +1826,7 @@ declare const blocks: {
|
|
|
1801
1826
|
usage: string;
|
|
1802
1827
|
additional?: string | undefined;
|
|
1803
1828
|
explainer?: string | undefined;
|
|
1829
|
+
footnotes?: string | undefined;
|
|
1804
1830
|
};
|
|
1805
1831
|
development?: string | undefined;
|
|
1806
1832
|
};
|
|
@@ -1868,6 +1894,7 @@ declare const blocks: {
|
|
|
1868
1894
|
usage: string;
|
|
1869
1895
|
additional?: string | undefined;
|
|
1870
1896
|
explainer?: string | undefined;
|
|
1897
|
+
footnotes?: string | undefined;
|
|
1871
1898
|
};
|
|
1872
1899
|
development?: string | undefined;
|
|
1873
1900
|
};
|
|
@@ -1935,6 +1962,7 @@ declare const blocks: {
|
|
|
1935
1962
|
usage: string;
|
|
1936
1963
|
additional?: string | undefined;
|
|
1937
1964
|
explainer?: string | undefined;
|
|
1965
|
+
footnotes?: string | undefined;
|
|
1938
1966
|
};
|
|
1939
1967
|
development?: string | undefined;
|
|
1940
1968
|
};
|
|
@@ -2002,6 +2030,7 @@ declare const blocks: {
|
|
|
2002
2030
|
usage: string;
|
|
2003
2031
|
additional?: string | undefined;
|
|
2004
2032
|
explainer?: string | undefined;
|
|
2033
|
+
footnotes?: string | undefined;
|
|
2005
2034
|
};
|
|
2006
2035
|
development?: string | undefined;
|
|
2007
2036
|
};
|
|
@@ -2146,6 +2175,7 @@ declare const blocks: {
|
|
|
2146
2175
|
usage: string;
|
|
2147
2176
|
additional?: string | undefined;
|
|
2148
2177
|
explainer?: string | undefined;
|
|
2178
|
+
footnotes?: string | undefined;
|
|
2149
2179
|
};
|
|
2150
2180
|
development?: string | undefined;
|
|
2151
2181
|
};
|
|
@@ -2213,6 +2243,7 @@ declare const blocks: {
|
|
|
2213
2243
|
usage: string;
|
|
2214
2244
|
additional?: string | undefined;
|
|
2215
2245
|
explainer?: string | undefined;
|
|
2246
|
+
footnotes?: string | undefined;
|
|
2216
2247
|
};
|
|
2217
2248
|
development?: string | undefined;
|
|
2218
2249
|
};
|
|
@@ -2280,6 +2311,7 @@ declare const blocks: {
|
|
|
2280
2311
|
usage: string;
|
|
2281
2312
|
additional?: string | undefined;
|
|
2282
2313
|
explainer?: string | undefined;
|
|
2314
|
+
footnotes?: string | undefined;
|
|
2283
2315
|
};
|
|
2284
2316
|
development?: string | undefined;
|
|
2285
2317
|
};
|
|
@@ -2357,6 +2389,7 @@ declare const blocks: {
|
|
|
2357
2389
|
usage: string;
|
|
2358
2390
|
additional?: string | undefined;
|
|
2359
2391
|
explainer?: string | undefined;
|
|
2392
|
+
footnotes?: string | undefined;
|
|
2360
2393
|
};
|
|
2361
2394
|
development?: string | undefined;
|
|
2362
2395
|
};
|
|
@@ -2424,6 +2457,7 @@ declare const blocks: {
|
|
|
2424
2457
|
usage: string;
|
|
2425
2458
|
additional?: string | undefined;
|
|
2426
2459
|
explainer?: string | undefined;
|
|
2460
|
+
footnotes?: string | undefined;
|
|
2427
2461
|
};
|
|
2428
2462
|
development?: string | undefined;
|
|
2429
2463
|
};
|
|
@@ -2491,6 +2525,7 @@ declare const blocks: {
|
|
|
2491
2525
|
usage: string;
|
|
2492
2526
|
additional?: string | undefined;
|
|
2493
2527
|
explainer?: string | undefined;
|
|
2528
|
+
footnotes?: string | undefined;
|
|
2494
2529
|
};
|
|
2495
2530
|
development?: string | undefined;
|
|
2496
2531
|
};
|
|
@@ -2558,6 +2593,7 @@ declare const blocks: {
|
|
|
2558
2593
|
usage: string;
|
|
2559
2594
|
additional?: string | undefined;
|
|
2560
2595
|
explainer?: string | undefined;
|
|
2596
|
+
footnotes?: string | undefined;
|
|
2561
2597
|
};
|
|
2562
2598
|
development?: string | undefined;
|
|
2563
2599
|
};
|
|
@@ -2637,6 +2673,7 @@ declare const blocks: {
|
|
|
2637
2673
|
usage: string;
|
|
2638
2674
|
additional?: string | undefined;
|
|
2639
2675
|
explainer?: string | undefined;
|
|
2676
|
+
footnotes?: string | undefined;
|
|
2640
2677
|
};
|
|
2641
2678
|
development?: string | undefined;
|
|
2642
2679
|
};
|
|
@@ -2709,6 +2746,7 @@ declare const blocks: {
|
|
|
2709
2746
|
usage: string;
|
|
2710
2747
|
additional?: string | undefined;
|
|
2711
2748
|
explainer?: string | undefined;
|
|
2749
|
+
footnotes?: string | undefined;
|
|
2712
2750
|
};
|
|
2713
2751
|
development?: string | undefined;
|
|
2714
2752
|
};
|
|
@@ -2776,6 +2814,7 @@ declare const blocks: {
|
|
|
2776
2814
|
usage: string;
|
|
2777
2815
|
additional?: string | undefined;
|
|
2778
2816
|
explainer?: string | undefined;
|
|
2817
|
+
footnotes?: string | undefined;
|
|
2779
2818
|
};
|
|
2780
2819
|
development?: string | undefined;
|
|
2781
2820
|
};
|
|
@@ -2843,6 +2882,7 @@ declare const blocks: {
|
|
|
2843
2882
|
usage: string;
|
|
2844
2883
|
additional?: string | undefined;
|
|
2845
2884
|
explainer?: string | undefined;
|
|
2885
|
+
footnotes?: string | undefined;
|
|
2846
2886
|
};
|
|
2847
2887
|
development?: string | undefined;
|
|
2848
2888
|
};
|
|
@@ -2910,6 +2950,7 @@ declare const blocks: {
|
|
|
2910
2950
|
usage: string;
|
|
2911
2951
|
additional?: string | undefined;
|
|
2912
2952
|
explainer?: string | undefined;
|
|
2953
|
+
footnotes?: string | undefined;
|
|
2913
2954
|
};
|
|
2914
2955
|
development?: string | undefined;
|
|
2915
2956
|
};
|
|
@@ -2981,6 +3022,7 @@ declare const blocks: {
|
|
|
2981
3022
|
usage: string;
|
|
2982
3023
|
additional?: string | undefined;
|
|
2983
3024
|
explainer?: string | undefined;
|
|
3025
|
+
footnotes?: string | undefined;
|
|
2984
3026
|
};
|
|
2985
3027
|
development?: string | undefined;
|
|
2986
3028
|
};
|
|
@@ -3160,6 +3202,7 @@ declare const blocks: {
|
|
|
3160
3202
|
usage: string;
|
|
3161
3203
|
additional?: string | undefined;
|
|
3162
3204
|
explainer?: string | undefined;
|
|
3205
|
+
footnotes?: string | undefined;
|
|
3163
3206
|
};
|
|
3164
3207
|
development?: string | undefined;
|
|
3165
3208
|
};
|
|
@@ -3243,6 +3286,7 @@ declare const blocks: {
|
|
|
3243
3286
|
usage: string;
|
|
3244
3287
|
additional?: string | undefined;
|
|
3245
3288
|
explainer?: string | undefined;
|
|
3289
|
+
footnotes?: string | undefined;
|
|
3246
3290
|
};
|
|
3247
3291
|
development?: string | undefined;
|
|
3248
3292
|
};
|
|
@@ -3319,6 +3363,7 @@ declare const blocks: {
|
|
|
3319
3363
|
usage: string;
|
|
3320
3364
|
additional?: string | undefined;
|
|
3321
3365
|
explainer?: string | undefined;
|
|
3366
|
+
footnotes?: string | undefined;
|
|
3322
3367
|
};
|
|
3323
3368
|
development?: string | undefined;
|
|
3324
3369
|
};
|
package/lib/index.d.ts
CHANGED
|
@@ -86,21 +86,25 @@ declare const createConfig: bingo.CreateTemplateConfig<{
|
|
|
86
86
|
readme: zod.ZodObject<{
|
|
87
87
|
additional: zod.ZodOptional<zod.ZodString>;
|
|
88
88
|
explainer: zod.ZodOptional<zod.ZodString>;
|
|
89
|
+
footnotes: zod.ZodOptional<zod.ZodString>;
|
|
89
90
|
usage: zod.ZodString;
|
|
90
91
|
}, "strip", zod.ZodTypeAny, {
|
|
91
92
|
usage: string;
|
|
92
93
|
additional?: string | undefined;
|
|
93
94
|
explainer?: string | undefined;
|
|
95
|
+
footnotes?: string | undefined;
|
|
94
96
|
}, {
|
|
95
97
|
usage: string;
|
|
96
98
|
additional?: string | undefined;
|
|
97
99
|
explainer?: string | undefined;
|
|
100
|
+
footnotes?: string | undefined;
|
|
98
101
|
}>;
|
|
99
102
|
}, "strip", zod.ZodTypeAny, {
|
|
100
103
|
readme: {
|
|
101
104
|
usage: string;
|
|
102
105
|
additional?: string | undefined;
|
|
103
106
|
explainer?: string | undefined;
|
|
107
|
+
footnotes?: string | undefined;
|
|
104
108
|
};
|
|
105
109
|
development?: string | undefined;
|
|
106
110
|
}, {
|
|
@@ -108,6 +112,7 @@ declare const createConfig: bingo.CreateTemplateConfig<{
|
|
|
108
112
|
usage: string;
|
|
109
113
|
additional?: string | undefined;
|
|
110
114
|
explainer?: string | undefined;
|
|
115
|
+
footnotes?: string | undefined;
|
|
111
116
|
};
|
|
112
117
|
development?: string | undefined;
|
|
113
118
|
}>;
|
|
@@ -225,6 +230,7 @@ declare const createConfig: bingo.CreateTemplateConfig<{
|
|
|
225
230
|
usage: string;
|
|
226
231
|
additional?: string | undefined;
|
|
227
232
|
explainer?: string | undefined;
|
|
233
|
+
footnotes?: string | undefined;
|
|
228
234
|
};
|
|
229
235
|
development?: string | undefined;
|
|
230
236
|
};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Documentation } from '../schemas.js';
|
|
2
2
|
import 'zod';
|
|
3
3
|
|
|
4
|
-
declare function readDocumentation(getDevelopmentDocumentation: () => Promise<string | undefined>, getReadmeAdditional: () => Promise<string | undefined>, getReadmeExplainer: () => Promise<string | undefined>, getReadmeUsage: () => Promise<string>): Promise<Documentation>;
|
|
4
|
+
declare function readDocumentation(getDevelopmentDocumentation: () => Promise<string | undefined>, getReadmeAdditional: () => Promise<string | undefined>, getReadmeExplainer: () => Promise<string | undefined>, getReadmeFootnotes: () => Promise<string | undefined>, getReadmeUsage: () => Promise<string>): Promise<Documentation>;
|
|
5
5
|
|
|
6
6
|
export { readDocumentation };
|
|
@@ -1,7 +1,8 @@
|
|
|
1
|
-
async function readDocumentation(getDevelopmentDocumentation, getReadmeAdditional, getReadmeExplainer, getReadmeUsage) {
|
|
2
|
-
const [additional, explainer, development, usage] = await Promise.all([
|
|
1
|
+
async function readDocumentation(getDevelopmentDocumentation, getReadmeAdditional, getReadmeExplainer, getReadmeFootnotes, getReadmeUsage) {
|
|
2
|
+
const [additional, explainer, footnotes, development, usage] = await Promise.all([
|
|
3
3
|
getReadmeAdditional(),
|
|
4
4
|
getReadmeExplainer(),
|
|
5
|
+
getReadmeFootnotes(),
|
|
5
6
|
getDevelopmentDocumentation(),
|
|
6
7
|
getReadmeUsage()
|
|
7
8
|
]);
|
|
@@ -10,6 +11,7 @@ async function readDocumentation(getDevelopmentDocumentation, getReadmeAdditiona
|
|
|
10
11
|
readme: {
|
|
11
12
|
additional,
|
|
12
13
|
explainer,
|
|
14
|
+
footnotes,
|
|
13
15
|
usage
|
|
14
16
|
}
|
|
15
17
|
};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
+
import { indicatorTemplatedBy } from "./readReadmeFootnotes.js";
|
|
1
2
|
const indicatorAfterAllContributors = /<!--\s*ALL-CONTRIBUTORS-LIST:END\s*-->/;
|
|
2
3
|
const indicatorAfterAllContributorsSpellCheck = /<!--\s*spellchecker:\s*enable\s*-->/;
|
|
3
|
-
const indicatorBeforeTemplatedBy = /> .* This package (?:is|was) (?:based|build|templated) (?:on|with) |<!-- You can remove this notice/;
|
|
4
4
|
async function readReadmeAdditional(getReadme) {
|
|
5
5
|
const readme = await getReadme();
|
|
6
6
|
if (!readme) {
|
|
@@ -10,7 +10,7 @@ async function readReadmeAdditional(getReadme) {
|
|
|
10
10
|
if (!indexAfterContributors) {
|
|
11
11
|
return void 0;
|
|
12
12
|
}
|
|
13
|
-
const templatedByMatch =
|
|
13
|
+
const templatedByMatch = indicatorTemplatedBy.exec(readme);
|
|
14
14
|
return readme.slice(
|
|
15
15
|
indexAfterContributors.index + indexAfterContributors[0].length,
|
|
16
16
|
templatedByMatch?.index
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
const indicatorTemplatedBy = /> .* This package (?:is|was) (?:based|build|templated) (?:on|with) |<!-- You can remove this notice/;
|
|
2
|
+
async function readReadmeFootnotes(getReadme) {
|
|
3
|
+
const readme = await getReadme();
|
|
4
|
+
if (!readme) {
|
|
5
|
+
return void 0;
|
|
6
|
+
}
|
|
7
|
+
const indexOfTemplatedBy = indicatorTemplatedBy.exec(readme)?.index;
|
|
8
|
+
if (!indexOfTemplatedBy) {
|
|
9
|
+
return void 0;
|
|
10
|
+
}
|
|
11
|
+
const indexOfNextLine = readme.indexOf("\n", indexOfTemplatedBy);
|
|
12
|
+
return readme.slice(indexOfNextLine).trim() || void 0;
|
|
13
|
+
}
|
|
14
|
+
export {
|
|
15
|
+
indicatorTemplatedBy,
|
|
16
|
+
readReadmeFootnotes
|
|
17
|
+
};
|
package/lib/presets/common.d.ts
CHANGED
|
@@ -31,21 +31,25 @@ declare const presetCommon: bingo_stratum.Preset<{
|
|
|
31
31
|
readme: zod.ZodObject<{
|
|
32
32
|
additional: zod.ZodOptional<zod.ZodString>;
|
|
33
33
|
explainer: zod.ZodOptional<zod.ZodString>;
|
|
34
|
+
footnotes: zod.ZodOptional<zod.ZodString>;
|
|
34
35
|
usage: zod.ZodString;
|
|
35
36
|
}, "strip", zod.ZodTypeAny, {
|
|
36
37
|
usage: string;
|
|
37
38
|
additional?: string | undefined;
|
|
38
39
|
explainer?: string | undefined;
|
|
40
|
+
footnotes?: string | undefined;
|
|
39
41
|
}, {
|
|
40
42
|
usage: string;
|
|
41
43
|
additional?: string | undefined;
|
|
42
44
|
explainer?: string | undefined;
|
|
45
|
+
footnotes?: string | undefined;
|
|
43
46
|
}>;
|
|
44
47
|
}, "strip", zod.ZodTypeAny, {
|
|
45
48
|
readme: {
|
|
46
49
|
usage: string;
|
|
47
50
|
additional?: string | undefined;
|
|
48
51
|
explainer?: string | undefined;
|
|
52
|
+
footnotes?: string | undefined;
|
|
49
53
|
};
|
|
50
54
|
development?: string | undefined;
|
|
51
55
|
}, {
|
|
@@ -53,6 +57,7 @@ declare const presetCommon: bingo_stratum.Preset<{
|
|
|
53
57
|
usage: string;
|
|
54
58
|
additional?: string | undefined;
|
|
55
59
|
explainer?: string | undefined;
|
|
60
|
+
footnotes?: string | undefined;
|
|
56
61
|
};
|
|
57
62
|
development?: string | undefined;
|
|
58
63
|
}>;
|
|
@@ -31,21 +31,25 @@ declare const presetEverything: bingo_stratum.Preset<{
|
|
|
31
31
|
readme: zod.ZodObject<{
|
|
32
32
|
additional: zod.ZodOptional<zod.ZodString>;
|
|
33
33
|
explainer: zod.ZodOptional<zod.ZodString>;
|
|
34
|
+
footnotes: zod.ZodOptional<zod.ZodString>;
|
|
34
35
|
usage: zod.ZodString;
|
|
35
36
|
}, "strip", zod.ZodTypeAny, {
|
|
36
37
|
usage: string;
|
|
37
38
|
additional?: string | undefined;
|
|
38
39
|
explainer?: string | undefined;
|
|
40
|
+
footnotes?: string | undefined;
|
|
39
41
|
}, {
|
|
40
42
|
usage: string;
|
|
41
43
|
additional?: string | undefined;
|
|
42
44
|
explainer?: string | undefined;
|
|
45
|
+
footnotes?: string | undefined;
|
|
43
46
|
}>;
|
|
44
47
|
}, "strip", zod.ZodTypeAny, {
|
|
45
48
|
readme: {
|
|
46
49
|
usage: string;
|
|
47
50
|
additional?: string | undefined;
|
|
48
51
|
explainer?: string | undefined;
|
|
52
|
+
footnotes?: string | undefined;
|
|
49
53
|
};
|
|
50
54
|
development?: string | undefined;
|
|
51
55
|
}, {
|
|
@@ -53,6 +57,7 @@ declare const presetEverything: bingo_stratum.Preset<{
|
|
|
53
57
|
usage: string;
|
|
54
58
|
additional?: string | undefined;
|
|
55
59
|
explainer?: string | undefined;
|
|
60
|
+
footnotes?: string | undefined;
|
|
56
61
|
};
|
|
57
62
|
development?: string | undefined;
|
|
58
63
|
}>;
|
package/lib/presets/index.d.ts
CHANGED
|
@@ -35,21 +35,25 @@ declare const presets: {
|
|
|
35
35
|
readme: zod.ZodObject<{
|
|
36
36
|
additional: zod.ZodOptional<zod.ZodString>;
|
|
37
37
|
explainer: zod.ZodOptional<zod.ZodString>;
|
|
38
|
+
footnotes: zod.ZodOptional<zod.ZodString>;
|
|
38
39
|
usage: zod.ZodString;
|
|
39
40
|
}, "strip", zod.ZodTypeAny, {
|
|
40
41
|
usage: string;
|
|
41
42
|
additional?: string | undefined;
|
|
42
43
|
explainer?: string | undefined;
|
|
44
|
+
footnotes?: string | undefined;
|
|
43
45
|
}, {
|
|
44
46
|
usage: string;
|
|
45
47
|
additional?: string | undefined;
|
|
46
48
|
explainer?: string | undefined;
|
|
49
|
+
footnotes?: string | undefined;
|
|
47
50
|
}>;
|
|
48
51
|
}, "strip", zod.ZodTypeAny, {
|
|
49
52
|
readme: {
|
|
50
53
|
usage: string;
|
|
51
54
|
additional?: string | undefined;
|
|
52
55
|
explainer?: string | undefined;
|
|
56
|
+
footnotes?: string | undefined;
|
|
53
57
|
};
|
|
54
58
|
development?: string | undefined;
|
|
55
59
|
}, {
|
|
@@ -57,6 +61,7 @@ declare const presets: {
|
|
|
57
61
|
usage: string;
|
|
58
62
|
additional?: string | undefined;
|
|
59
63
|
explainer?: string | undefined;
|
|
64
|
+
footnotes?: string | undefined;
|
|
60
65
|
};
|
|
61
66
|
development?: string | undefined;
|
|
62
67
|
}>;
|
|
@@ -196,21 +201,25 @@ declare const presets: {
|
|
|
196
201
|
readme: zod.ZodObject<{
|
|
197
202
|
additional: zod.ZodOptional<zod.ZodString>;
|
|
198
203
|
explainer: zod.ZodOptional<zod.ZodString>;
|
|
204
|
+
footnotes: zod.ZodOptional<zod.ZodString>;
|
|
199
205
|
usage: zod.ZodString;
|
|
200
206
|
}, "strip", zod.ZodTypeAny, {
|
|
201
207
|
usage: string;
|
|
202
208
|
additional?: string | undefined;
|
|
203
209
|
explainer?: string | undefined;
|
|
210
|
+
footnotes?: string | undefined;
|
|
204
211
|
}, {
|
|
205
212
|
usage: string;
|
|
206
213
|
additional?: string | undefined;
|
|
207
214
|
explainer?: string | undefined;
|
|
215
|
+
footnotes?: string | undefined;
|
|
208
216
|
}>;
|
|
209
217
|
}, "strip", zod.ZodTypeAny, {
|
|
210
218
|
readme: {
|
|
211
219
|
usage: string;
|
|
212
220
|
additional?: string | undefined;
|
|
213
221
|
explainer?: string | undefined;
|
|
222
|
+
footnotes?: string | undefined;
|
|
214
223
|
};
|
|
215
224
|
development?: string | undefined;
|
|
216
225
|
}, {
|
|
@@ -218,6 +227,7 @@ declare const presets: {
|
|
|
218
227
|
usage: string;
|
|
219
228
|
additional?: string | undefined;
|
|
220
229
|
explainer?: string | undefined;
|
|
230
|
+
footnotes?: string | undefined;
|
|
221
231
|
};
|
|
222
232
|
development?: string | undefined;
|
|
223
233
|
}>;
|
|
@@ -357,21 +367,25 @@ declare const presets: {
|
|
|
357
367
|
readme: zod.ZodObject<{
|
|
358
368
|
additional: zod.ZodOptional<zod.ZodString>;
|
|
359
369
|
explainer: zod.ZodOptional<zod.ZodString>;
|
|
370
|
+
footnotes: zod.ZodOptional<zod.ZodString>;
|
|
360
371
|
usage: zod.ZodString;
|
|
361
372
|
}, "strip", zod.ZodTypeAny, {
|
|
362
373
|
usage: string;
|
|
363
374
|
additional?: string | undefined;
|
|
364
375
|
explainer?: string | undefined;
|
|
376
|
+
footnotes?: string | undefined;
|
|
365
377
|
}, {
|
|
366
378
|
usage: string;
|
|
367
379
|
additional?: string | undefined;
|
|
368
380
|
explainer?: string | undefined;
|
|
381
|
+
footnotes?: string | undefined;
|
|
369
382
|
}>;
|
|
370
383
|
}, "strip", zod.ZodTypeAny, {
|
|
371
384
|
readme: {
|
|
372
385
|
usage: string;
|
|
373
386
|
additional?: string | undefined;
|
|
374
387
|
explainer?: string | undefined;
|
|
388
|
+
footnotes?: string | undefined;
|
|
375
389
|
};
|
|
376
390
|
development?: string | undefined;
|
|
377
391
|
}, {
|
|
@@ -379,6 +393,7 @@ declare const presets: {
|
|
|
379
393
|
usage: string;
|
|
380
394
|
additional?: string | undefined;
|
|
381
395
|
explainer?: string | undefined;
|
|
396
|
+
footnotes?: string | undefined;
|
|
382
397
|
};
|
|
383
398
|
development?: string | undefined;
|
|
384
399
|
}>;
|
package/lib/presets/minimal.d.ts
CHANGED
|
@@ -31,21 +31,25 @@ declare const presetMinimal: bingo_stratum.Preset<{
|
|
|
31
31
|
readme: zod.ZodObject<{
|
|
32
32
|
additional: zod.ZodOptional<zod.ZodString>;
|
|
33
33
|
explainer: zod.ZodOptional<zod.ZodString>;
|
|
34
|
+
footnotes: zod.ZodOptional<zod.ZodString>;
|
|
34
35
|
usage: zod.ZodString;
|
|
35
36
|
}, "strip", zod.ZodTypeAny, {
|
|
36
37
|
usage: string;
|
|
37
38
|
additional?: string | undefined;
|
|
38
39
|
explainer?: string | undefined;
|
|
40
|
+
footnotes?: string | undefined;
|
|
39
41
|
}, {
|
|
40
42
|
usage: string;
|
|
41
43
|
additional?: string | undefined;
|
|
42
44
|
explainer?: string | undefined;
|
|
45
|
+
footnotes?: string | undefined;
|
|
43
46
|
}>;
|
|
44
47
|
}, "strip", zod.ZodTypeAny, {
|
|
45
48
|
readme: {
|
|
46
49
|
usage: string;
|
|
47
50
|
additional?: string | undefined;
|
|
48
51
|
explainer?: string | undefined;
|
|
52
|
+
footnotes?: string | undefined;
|
|
49
53
|
};
|
|
50
54
|
development?: string | undefined;
|
|
51
55
|
}, {
|
|
@@ -53,6 +57,7 @@ declare const presetMinimal: bingo_stratum.Preset<{
|
|
|
53
57
|
usage: string;
|
|
54
58
|
additional?: string | undefined;
|
|
55
59
|
explainer?: string | undefined;
|
|
60
|
+
footnotes?: string | undefined;
|
|
56
61
|
};
|
|
57
62
|
development?: string | undefined;
|
|
58
63
|
}>;
|