create-typescript-app 2.40.0 → 2.40.1
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 +11 -11
- package/lib/base.js +1 -1
- package/lib/blocks/blockAllContributors.d.ts +1 -1
- package/lib/blocks/blockAreTheTypesWrong.d.ts +1 -1
- package/lib/blocks/blockCSpell.d.ts +1 -1
- package/lib/blocks/blockCTATransitions.d.ts +1 -1
- package/lib/blocks/blockCodecov.d.ts +1 -1
- package/lib/blocks/blockContributingDocs.d.ts +1 -1
- package/lib/blocks/blockContributorCovenant.d.ts +1 -1
- package/lib/blocks/blockDevelopmentDocs.d.ts +1 -1
- package/lib/blocks/blockESLint.d.ts +1 -1
- package/lib/blocks/blockESLintComments.d.ts +1 -1
- package/lib/blocks/blockESLintJSDoc.d.ts +1 -1
- package/lib/blocks/blockESLintJSONC.d.ts +1 -1
- package/lib/blocks/blockESLintMarkdown.d.ts +1 -1
- package/lib/blocks/blockESLintMoreStyling.d.ts +1 -1
- package/lib/blocks/blockESLintNode.d.ts +1 -1
- package/lib/blocks/blockESLintPackageJson.d.ts +1 -1
- package/lib/blocks/blockESLintPerfectionist.d.ts +1 -1
- package/lib/blocks/blockESLintPlugin.d.ts +1 -1
- package/lib/blocks/blockESLintPlugin.js +46 -5
- package/lib/blocks/blockESLintRegexp.d.ts +1 -1
- package/lib/blocks/blockESLintYML.d.ts +1 -1
- package/lib/blocks/blockExampleFiles.d.ts +2 -1
- package/lib/blocks/blockExampleFiles.js +9 -1
- package/lib/blocks/blockFunding.d.ts +1 -1
- package/lib/blocks/blockGitHubActionsCI.d.ts +1 -1
- package/lib/blocks/blockGitHubApps.d.ts +1 -1
- package/lib/blocks/blockGitHubIssueTemplates.d.ts +1 -1
- package/lib/blocks/blockGitHubPRTemplate.d.ts +1 -1
- package/lib/blocks/blockGitignore.d.ts +1 -1
- package/lib/blocks/blockKnip.d.ts +1 -1
- package/lib/blocks/blockMITLicense.d.ts +1 -1
- package/lib/blocks/blockMain.d.ts +1 -1
- package/lib/blocks/blockMarkdownlint.d.ts +1 -1
- package/lib/blocks/blockNcc.d.ts +1 -1
- package/lib/blocks/blockNvmrc.d.ts +1 -1
- package/lib/blocks/blockPRCompliance.d.ts +1 -1
- package/lib/blocks/blockPackageJson.d.ts +1 -1
- package/lib/blocks/blockPnpmDedupe.d.ts +1 -1
- package/lib/blocks/blockPrettier.d.ts +1 -1
- package/lib/blocks/blockPrettierPluginCurly.d.ts +1 -1
- package/lib/blocks/blockPrettierPluginPackageJson.d.ts +1 -1
- package/lib/blocks/blockPrettierPluginSh.d.ts +1 -1
- package/lib/blocks/blockREADME.d.ts +2 -1
- package/lib/blocks/blockREADME.js +3 -2
- package/lib/blocks/blockReleaseIt.d.ts +1 -1
- package/lib/blocks/blockRemoveDependencies.d.ts +1 -1
- package/lib/blocks/blockRemoveFiles.d.ts +1 -1
- package/lib/blocks/blockRemoveWorkflows.d.ts +1 -1
- package/lib/blocks/blockRenovate.d.ts +1 -1
- package/lib/blocks/blockRepositoryBranchRuleset.d.ts +1 -1
- package/lib/blocks/blockRepositoryLabels.d.ts +1 -1
- package/lib/blocks/blockRepositorySecrets.d.ts +1 -1
- package/lib/blocks/blockRepositorySettings.d.ts +1 -1
- package/lib/blocks/blockSecurityDocs.d.ts +1 -1
- package/lib/blocks/blockTSup.d.ts +1 -1
- package/lib/blocks/blockTemplatedWith.d.ts +1 -1
- package/lib/blocks/blockTypeScript.d.ts +1 -1
- package/lib/blocks/blockTypeScript.js +11 -1
- package/lib/blocks/blockVSCode.d.ts +1 -1
- package/lib/blocks/blockVitest.d.ts +1 -1
- package/lib/blocks/blockWebExt.d.ts +1 -1
- package/lib/blocks/index.d.ts +48 -47
- package/lib/data/packageData.d.ts +1 -1
- package/lib/index.d.ts +6 -6
- package/lib/options/readDocumentation.d.ts +1 -1
- package/lib/options/readReadmeUsage.d.ts +1 -1
- package/lib/options/readReadmeUsage.js +14 -10
- package/lib/presets/common.d.ts +5 -5
- package/lib/presets/everything.d.ts +5 -5
- package/lib/presets/index.d.ts +15 -15
- package/lib/presets/minimal.d.ts +5 -5
- package/lib/schemas.d.ts +10 -10
- package/lib/schemas.js +1 -1
- package/lib/template.d.ts +5 -5
- package/package.json +1 -1
- package/lib/options/readUsageFromReadme.d.ts +0 -3
- package/lib/options/readUsageFromReadme.js +0 -17
package/lib/blocks/index.d.ts
CHANGED
|
@@ -56,10 +56,10 @@ declare const blocks: {
|
|
|
56
56
|
directory: string;
|
|
57
57
|
documentation: {
|
|
58
58
|
readme: {
|
|
59
|
-
usage: string;
|
|
60
59
|
additional?: string | undefined;
|
|
61
60
|
explainer?: string | undefined;
|
|
62
61
|
footnotes?: string | undefined;
|
|
62
|
+
usage?: string | undefined;
|
|
63
63
|
};
|
|
64
64
|
development?: string | undefined;
|
|
65
65
|
};
|
|
@@ -124,10 +124,10 @@ declare const blocks: {
|
|
|
124
124
|
directory: string;
|
|
125
125
|
documentation: {
|
|
126
126
|
readme: {
|
|
127
|
-
usage: string;
|
|
128
127
|
additional?: string | undefined;
|
|
129
128
|
explainer?: string | undefined;
|
|
130
129
|
footnotes?: string | undefined;
|
|
130
|
+
usage?: string | undefined;
|
|
131
131
|
};
|
|
132
132
|
development?: string | undefined;
|
|
133
133
|
};
|
|
@@ -194,10 +194,10 @@ declare const blocks: {
|
|
|
194
194
|
directory: string;
|
|
195
195
|
documentation: {
|
|
196
196
|
readme: {
|
|
197
|
-
usage: string;
|
|
198
197
|
additional?: string | undefined;
|
|
199
198
|
explainer?: string | undefined;
|
|
200
199
|
footnotes?: string | undefined;
|
|
200
|
+
usage?: string | undefined;
|
|
201
201
|
};
|
|
202
202
|
development?: string | undefined;
|
|
203
203
|
};
|
|
@@ -262,10 +262,10 @@ declare const blocks: {
|
|
|
262
262
|
directory: string;
|
|
263
263
|
documentation: {
|
|
264
264
|
readme: {
|
|
265
|
-
usage: string;
|
|
266
265
|
additional?: string | undefined;
|
|
267
266
|
explainer?: string | undefined;
|
|
268
267
|
footnotes?: string | undefined;
|
|
268
|
+
usage?: string | undefined;
|
|
269
269
|
};
|
|
270
270
|
development?: string | undefined;
|
|
271
271
|
};
|
|
@@ -330,10 +330,10 @@ declare const blocks: {
|
|
|
330
330
|
directory: string;
|
|
331
331
|
documentation: {
|
|
332
332
|
readme: {
|
|
333
|
-
usage: string;
|
|
334
333
|
additional?: string | undefined;
|
|
335
334
|
explainer?: string | undefined;
|
|
336
335
|
footnotes?: string | undefined;
|
|
336
|
+
usage?: string | undefined;
|
|
337
337
|
};
|
|
338
338
|
development?: string | undefined;
|
|
339
339
|
};
|
|
@@ -401,10 +401,10 @@ declare const blocks: {
|
|
|
401
401
|
directory: string;
|
|
402
402
|
documentation: {
|
|
403
403
|
readme: {
|
|
404
|
-
usage: string;
|
|
405
404
|
additional?: string | undefined;
|
|
406
405
|
explainer?: string | undefined;
|
|
407
406
|
footnotes?: string | undefined;
|
|
407
|
+
usage?: string | undefined;
|
|
408
408
|
};
|
|
409
409
|
development?: string | undefined;
|
|
410
410
|
};
|
|
@@ -483,10 +483,10 @@ declare const blocks: {
|
|
|
483
483
|
directory: string;
|
|
484
484
|
documentation: {
|
|
485
485
|
readme: {
|
|
486
|
-
usage: string;
|
|
487
486
|
additional?: string | undefined;
|
|
488
487
|
explainer?: string | undefined;
|
|
489
488
|
footnotes?: string | undefined;
|
|
489
|
+
usage?: string | undefined;
|
|
490
490
|
};
|
|
491
491
|
development?: string | undefined;
|
|
492
492
|
};
|
|
@@ -580,10 +580,10 @@ declare const blocks: {
|
|
|
580
580
|
directory: string;
|
|
581
581
|
documentation: {
|
|
582
582
|
readme: {
|
|
583
|
-
usage: string;
|
|
584
583
|
additional?: string | undefined;
|
|
585
584
|
explainer?: string | undefined;
|
|
586
585
|
footnotes?: string | undefined;
|
|
586
|
+
usage?: string | undefined;
|
|
587
587
|
};
|
|
588
588
|
development?: string | undefined;
|
|
589
589
|
};
|
|
@@ -648,10 +648,10 @@ declare const blocks: {
|
|
|
648
648
|
directory: string;
|
|
649
649
|
documentation: {
|
|
650
650
|
readme: {
|
|
651
|
-
usage: string;
|
|
652
651
|
additional?: string | undefined;
|
|
653
652
|
explainer?: string | undefined;
|
|
654
653
|
footnotes?: string | undefined;
|
|
654
|
+
usage?: string | undefined;
|
|
655
655
|
};
|
|
656
656
|
development?: string | undefined;
|
|
657
657
|
};
|
|
@@ -716,10 +716,10 @@ declare const blocks: {
|
|
|
716
716
|
directory: string;
|
|
717
717
|
documentation: {
|
|
718
718
|
readme: {
|
|
719
|
-
usage: string;
|
|
720
719
|
additional?: string | undefined;
|
|
721
720
|
explainer?: string | undefined;
|
|
722
721
|
footnotes?: string | undefined;
|
|
722
|
+
usage?: string | undefined;
|
|
723
723
|
};
|
|
724
724
|
development?: string | undefined;
|
|
725
725
|
};
|
|
@@ -784,10 +784,10 @@ declare const blocks: {
|
|
|
784
784
|
directory: string;
|
|
785
785
|
documentation: {
|
|
786
786
|
readme: {
|
|
787
|
-
usage: string;
|
|
788
787
|
additional?: string | undefined;
|
|
789
788
|
explainer?: string | undefined;
|
|
790
789
|
footnotes?: string | undefined;
|
|
790
|
+
usage?: string | undefined;
|
|
791
791
|
};
|
|
792
792
|
development?: string | undefined;
|
|
793
793
|
};
|
|
@@ -852,10 +852,10 @@ declare const blocks: {
|
|
|
852
852
|
directory: string;
|
|
853
853
|
documentation: {
|
|
854
854
|
readme: {
|
|
855
|
-
usage: string;
|
|
856
855
|
additional?: string | undefined;
|
|
857
856
|
explainer?: string | undefined;
|
|
858
857
|
footnotes?: string | undefined;
|
|
858
|
+
usage?: string | undefined;
|
|
859
859
|
};
|
|
860
860
|
development?: string | undefined;
|
|
861
861
|
};
|
|
@@ -920,10 +920,10 @@ declare const blocks: {
|
|
|
920
920
|
directory: string;
|
|
921
921
|
documentation: {
|
|
922
922
|
readme: {
|
|
923
|
-
usage: string;
|
|
924
923
|
additional?: string | undefined;
|
|
925
924
|
explainer?: string | undefined;
|
|
926
925
|
footnotes?: string | undefined;
|
|
926
|
+
usage?: string | undefined;
|
|
927
927
|
};
|
|
928
928
|
development?: string | undefined;
|
|
929
929
|
};
|
|
@@ -988,10 +988,10 @@ declare const blocks: {
|
|
|
988
988
|
directory: string;
|
|
989
989
|
documentation: {
|
|
990
990
|
readme: {
|
|
991
|
-
usage: string;
|
|
992
991
|
additional?: string | undefined;
|
|
993
992
|
explainer?: string | undefined;
|
|
994
993
|
footnotes?: string | undefined;
|
|
994
|
+
usage?: string | undefined;
|
|
995
995
|
};
|
|
996
996
|
development?: string | undefined;
|
|
997
997
|
};
|
|
@@ -1056,10 +1056,10 @@ declare const blocks: {
|
|
|
1056
1056
|
directory: string;
|
|
1057
1057
|
documentation: {
|
|
1058
1058
|
readme: {
|
|
1059
|
-
usage: string;
|
|
1060
1059
|
additional?: string | undefined;
|
|
1061
1060
|
explainer?: string | undefined;
|
|
1062
1061
|
footnotes?: string | undefined;
|
|
1062
|
+
usage?: string | undefined;
|
|
1063
1063
|
};
|
|
1064
1064
|
development?: string | undefined;
|
|
1065
1065
|
};
|
|
@@ -1124,10 +1124,10 @@ declare const blocks: {
|
|
|
1124
1124
|
directory: string;
|
|
1125
1125
|
documentation: {
|
|
1126
1126
|
readme: {
|
|
1127
|
-
usage: string;
|
|
1128
1127
|
additional?: string | undefined;
|
|
1129
1128
|
explainer?: string | undefined;
|
|
1130
1129
|
footnotes?: string | undefined;
|
|
1130
|
+
usage?: string | undefined;
|
|
1131
1131
|
};
|
|
1132
1132
|
development?: string | undefined;
|
|
1133
1133
|
};
|
|
@@ -1194,10 +1194,10 @@ declare const blocks: {
|
|
|
1194
1194
|
directory: string;
|
|
1195
1195
|
documentation: {
|
|
1196
1196
|
readme: {
|
|
1197
|
-
usage: string;
|
|
1198
1197
|
additional?: string | undefined;
|
|
1199
1198
|
explainer?: string | undefined;
|
|
1200
1199
|
footnotes?: string | undefined;
|
|
1200
|
+
usage?: string | undefined;
|
|
1201
1201
|
};
|
|
1202
1202
|
development?: string | undefined;
|
|
1203
1203
|
};
|
|
@@ -1262,10 +1262,10 @@ declare const blocks: {
|
|
|
1262
1262
|
directory: string;
|
|
1263
1263
|
documentation: {
|
|
1264
1264
|
readme: {
|
|
1265
|
-
usage: string;
|
|
1266
1265
|
additional?: string | undefined;
|
|
1267
1266
|
explainer?: string | undefined;
|
|
1268
1267
|
footnotes?: string | undefined;
|
|
1268
|
+
usage?: string | undefined;
|
|
1269
1269
|
};
|
|
1270
1270
|
development?: string | undefined;
|
|
1271
1271
|
};
|
|
@@ -1330,10 +1330,10 @@ declare const blocks: {
|
|
|
1330
1330
|
directory: string;
|
|
1331
1331
|
documentation: {
|
|
1332
1332
|
readme: {
|
|
1333
|
-
usage: string;
|
|
1334
1333
|
additional?: string | undefined;
|
|
1335
1334
|
explainer?: string | undefined;
|
|
1336
1335
|
footnotes?: string | undefined;
|
|
1336
|
+
usage?: string | undefined;
|
|
1337
1337
|
};
|
|
1338
1338
|
development?: string | undefined;
|
|
1339
1339
|
};
|
|
@@ -1398,10 +1398,10 @@ declare const blocks: {
|
|
|
1398
1398
|
directory: string;
|
|
1399
1399
|
documentation: {
|
|
1400
1400
|
readme: {
|
|
1401
|
-
usage: string;
|
|
1402
1401
|
additional?: string | undefined;
|
|
1403
1402
|
explainer?: string | undefined;
|
|
1404
1403
|
footnotes?: string | undefined;
|
|
1404
|
+
usage?: string | undefined;
|
|
1405
1405
|
};
|
|
1406
1406
|
development?: string | undefined;
|
|
1407
1407
|
};
|
|
@@ -1482,10 +1482,10 @@ declare const blocks: {
|
|
|
1482
1482
|
directory: string;
|
|
1483
1483
|
documentation: {
|
|
1484
1484
|
readme: {
|
|
1485
|
-
usage: string;
|
|
1486
1485
|
additional?: string | undefined;
|
|
1487
1486
|
explainer?: string | undefined;
|
|
1488
1487
|
footnotes?: string | undefined;
|
|
1488
|
+
usage?: string | undefined;
|
|
1489
1489
|
};
|
|
1490
1490
|
development?: string | undefined;
|
|
1491
1491
|
};
|
|
@@ -1550,10 +1550,10 @@ declare const blocks: {
|
|
|
1550
1550
|
directory: string;
|
|
1551
1551
|
documentation: {
|
|
1552
1552
|
readme: {
|
|
1553
|
-
usage: string;
|
|
1554
1553
|
additional?: string | undefined;
|
|
1555
1554
|
explainer?: string | undefined;
|
|
1556
1555
|
footnotes?: string | undefined;
|
|
1556
|
+
usage?: string | undefined;
|
|
1557
1557
|
};
|
|
1558
1558
|
development?: string | undefined;
|
|
1559
1559
|
};
|
|
@@ -1618,10 +1618,10 @@ declare const blocks: {
|
|
|
1618
1618
|
directory: string;
|
|
1619
1619
|
documentation: {
|
|
1620
1620
|
readme: {
|
|
1621
|
-
usage: string;
|
|
1622
1621
|
additional?: string | undefined;
|
|
1623
1622
|
explainer?: string | undefined;
|
|
1624
1623
|
footnotes?: string | undefined;
|
|
1624
|
+
usage?: string | undefined;
|
|
1625
1625
|
};
|
|
1626
1626
|
development?: string | undefined;
|
|
1627
1627
|
};
|
|
@@ -1688,10 +1688,10 @@ declare const blocks: {
|
|
|
1688
1688
|
directory: string;
|
|
1689
1689
|
documentation: {
|
|
1690
1690
|
readme: {
|
|
1691
|
-
usage: string;
|
|
1692
1691
|
additional?: string | undefined;
|
|
1693
1692
|
explainer?: string | undefined;
|
|
1694
1693
|
footnotes?: string | undefined;
|
|
1694
|
+
usage?: string | undefined;
|
|
1695
1695
|
};
|
|
1696
1696
|
development?: string | undefined;
|
|
1697
1697
|
};
|
|
@@ -1760,10 +1760,10 @@ declare const blocks: {
|
|
|
1760
1760
|
directory: string;
|
|
1761
1761
|
documentation: {
|
|
1762
1762
|
readme: {
|
|
1763
|
-
usage: string;
|
|
1764
1763
|
additional?: string | undefined;
|
|
1765
1764
|
explainer?: string | undefined;
|
|
1766
1765
|
footnotes?: string | undefined;
|
|
1766
|
+
usage?: string | undefined;
|
|
1767
1767
|
};
|
|
1768
1768
|
development?: string | undefined;
|
|
1769
1769
|
};
|
|
@@ -1831,10 +1831,10 @@ declare const blocks: {
|
|
|
1831
1831
|
directory: string;
|
|
1832
1832
|
documentation: {
|
|
1833
1833
|
readme: {
|
|
1834
|
-
usage: string;
|
|
1835
1834
|
additional?: string | undefined;
|
|
1836
1835
|
explainer?: string | undefined;
|
|
1837
1836
|
footnotes?: string | undefined;
|
|
1837
|
+
usage?: string | undefined;
|
|
1838
1838
|
};
|
|
1839
1839
|
development?: string | undefined;
|
|
1840
1840
|
};
|
|
@@ -1901,10 +1901,10 @@ declare const blocks: {
|
|
|
1901
1901
|
directory: string;
|
|
1902
1902
|
documentation: {
|
|
1903
1903
|
readme: {
|
|
1904
|
-
usage: string;
|
|
1905
1904
|
additional?: string | undefined;
|
|
1906
1905
|
explainer?: string | undefined;
|
|
1907
1906
|
footnotes?: string | undefined;
|
|
1907
|
+
usage?: string | undefined;
|
|
1908
1908
|
};
|
|
1909
1909
|
development?: string | undefined;
|
|
1910
1910
|
};
|
|
@@ -1969,10 +1969,10 @@ declare const blocks: {
|
|
|
1969
1969
|
directory: string;
|
|
1970
1970
|
documentation: {
|
|
1971
1971
|
readme: {
|
|
1972
|
-
usage: string;
|
|
1973
1972
|
additional?: string | undefined;
|
|
1974
1973
|
explainer?: string | undefined;
|
|
1975
1974
|
footnotes?: string | undefined;
|
|
1975
|
+
usage?: string | undefined;
|
|
1976
1976
|
};
|
|
1977
1977
|
development?: string | undefined;
|
|
1978
1978
|
};
|
|
@@ -2039,10 +2039,10 @@ declare const blocks: {
|
|
|
2039
2039
|
directory: string;
|
|
2040
2040
|
documentation: {
|
|
2041
2041
|
readme: {
|
|
2042
|
-
usage: string;
|
|
2043
2042
|
additional?: string | undefined;
|
|
2044
2043
|
explainer?: string | undefined;
|
|
2045
2044
|
footnotes?: string | undefined;
|
|
2045
|
+
usage?: string | undefined;
|
|
2046
2046
|
};
|
|
2047
2047
|
development?: string | undefined;
|
|
2048
2048
|
};
|
|
@@ -2107,10 +2107,10 @@ declare const blocks: {
|
|
|
2107
2107
|
directory: string;
|
|
2108
2108
|
documentation: {
|
|
2109
2109
|
readme: {
|
|
2110
|
-
usage: string;
|
|
2111
2110
|
additional?: string | undefined;
|
|
2112
2111
|
explainer?: string | undefined;
|
|
2113
2112
|
footnotes?: string | undefined;
|
|
2113
|
+
usage?: string | undefined;
|
|
2114
2114
|
};
|
|
2115
2115
|
development?: string | undefined;
|
|
2116
2116
|
};
|
|
@@ -2252,10 +2252,10 @@ declare const blocks: {
|
|
|
2252
2252
|
directory: string;
|
|
2253
2253
|
documentation: {
|
|
2254
2254
|
readme: {
|
|
2255
|
-
usage: string;
|
|
2256
2255
|
additional?: string | undefined;
|
|
2257
2256
|
explainer?: string | undefined;
|
|
2258
2257
|
footnotes?: string | undefined;
|
|
2258
|
+
usage?: string | undefined;
|
|
2259
2259
|
};
|
|
2260
2260
|
development?: string | undefined;
|
|
2261
2261
|
};
|
|
@@ -2320,10 +2320,10 @@ declare const blocks: {
|
|
|
2320
2320
|
directory: string;
|
|
2321
2321
|
documentation: {
|
|
2322
2322
|
readme: {
|
|
2323
|
-
usage: string;
|
|
2324
2323
|
additional?: string | undefined;
|
|
2325
2324
|
explainer?: string | undefined;
|
|
2326
2325
|
footnotes?: string | undefined;
|
|
2326
|
+
usage?: string | undefined;
|
|
2327
2327
|
};
|
|
2328
2328
|
development?: string | undefined;
|
|
2329
2329
|
};
|
|
@@ -2388,10 +2388,10 @@ declare const blocks: {
|
|
|
2388
2388
|
directory: string;
|
|
2389
2389
|
documentation: {
|
|
2390
2390
|
readme: {
|
|
2391
|
-
usage: string;
|
|
2392
2391
|
additional?: string | undefined;
|
|
2393
2392
|
explainer?: string | undefined;
|
|
2394
2393
|
footnotes?: string | undefined;
|
|
2394
|
+
usage?: string | undefined;
|
|
2395
2395
|
};
|
|
2396
2396
|
development?: string | undefined;
|
|
2397
2397
|
};
|
|
@@ -2466,10 +2466,10 @@ declare const blocks: {
|
|
|
2466
2466
|
directory: string;
|
|
2467
2467
|
documentation: {
|
|
2468
2468
|
readme: {
|
|
2469
|
-
usage: string;
|
|
2470
2469
|
additional?: string | undefined;
|
|
2471
2470
|
explainer?: string | undefined;
|
|
2472
2471
|
footnotes?: string | undefined;
|
|
2472
|
+
usage?: string | undefined;
|
|
2473
2473
|
};
|
|
2474
2474
|
development?: string | undefined;
|
|
2475
2475
|
};
|
|
@@ -2534,10 +2534,10 @@ declare const blocks: {
|
|
|
2534
2534
|
directory: string;
|
|
2535
2535
|
documentation: {
|
|
2536
2536
|
readme: {
|
|
2537
|
-
usage: string;
|
|
2538
2537
|
additional?: string | undefined;
|
|
2539
2538
|
explainer?: string | undefined;
|
|
2540
2539
|
footnotes?: string | undefined;
|
|
2540
|
+
usage?: string | undefined;
|
|
2541
2541
|
};
|
|
2542
2542
|
development?: string | undefined;
|
|
2543
2543
|
};
|
|
@@ -2602,10 +2602,10 @@ declare const blocks: {
|
|
|
2602
2602
|
directory: string;
|
|
2603
2603
|
documentation: {
|
|
2604
2604
|
readme: {
|
|
2605
|
-
usage: string;
|
|
2606
2605
|
additional?: string | undefined;
|
|
2607
2606
|
explainer?: string | undefined;
|
|
2608
2607
|
footnotes?: string | undefined;
|
|
2608
|
+
usage?: string | undefined;
|
|
2609
2609
|
};
|
|
2610
2610
|
development?: string | undefined;
|
|
2611
2611
|
};
|
|
@@ -2670,10 +2670,10 @@ declare const blocks: {
|
|
|
2670
2670
|
directory: string;
|
|
2671
2671
|
documentation: {
|
|
2672
2672
|
readme: {
|
|
2673
|
-
usage: string;
|
|
2674
2673
|
additional?: string | undefined;
|
|
2675
2674
|
explainer?: string | undefined;
|
|
2676
2675
|
footnotes?: string | undefined;
|
|
2676
|
+
usage?: string | undefined;
|
|
2677
2677
|
};
|
|
2678
2678
|
development?: string | undefined;
|
|
2679
2679
|
};
|
|
@@ -2743,6 +2743,7 @@ declare const blocks: {
|
|
|
2743
2743
|
after: string;
|
|
2744
2744
|
} | undefined;
|
|
2745
2745
|
}[];
|
|
2746
|
+
defaultUsage: string[];
|
|
2746
2747
|
notices: string[];
|
|
2747
2748
|
}, {
|
|
2748
2749
|
access: "public" | "restricted";
|
|
@@ -2750,10 +2751,10 @@ declare const blocks: {
|
|
|
2750
2751
|
directory: string;
|
|
2751
2752
|
documentation: {
|
|
2752
2753
|
readme: {
|
|
2753
|
-
usage: string;
|
|
2754
2754
|
additional?: string | undefined;
|
|
2755
2755
|
explainer?: string | undefined;
|
|
2756
2756
|
footnotes?: string | undefined;
|
|
2757
|
+
usage?: string | undefined;
|
|
2757
2758
|
};
|
|
2758
2759
|
development?: string | undefined;
|
|
2759
2760
|
};
|
|
@@ -2823,10 +2824,10 @@ declare const blocks: {
|
|
|
2823
2824
|
directory: string;
|
|
2824
2825
|
documentation: {
|
|
2825
2826
|
readme: {
|
|
2826
|
-
usage: string;
|
|
2827
2827
|
additional?: string | undefined;
|
|
2828
2828
|
explainer?: string | undefined;
|
|
2829
2829
|
footnotes?: string | undefined;
|
|
2830
|
+
usage?: string | undefined;
|
|
2830
2831
|
};
|
|
2831
2832
|
development?: string | undefined;
|
|
2832
2833
|
};
|
|
@@ -2893,10 +2894,10 @@ declare const blocks: {
|
|
|
2893
2894
|
directory: string;
|
|
2894
2895
|
documentation: {
|
|
2895
2896
|
readme: {
|
|
2896
|
-
usage: string;
|
|
2897
2897
|
additional?: string | undefined;
|
|
2898
2898
|
explainer?: string | undefined;
|
|
2899
2899
|
footnotes?: string | undefined;
|
|
2900
|
+
usage?: string | undefined;
|
|
2900
2901
|
};
|
|
2901
2902
|
development?: string | undefined;
|
|
2902
2903
|
};
|
|
@@ -2961,10 +2962,10 @@ declare const blocks: {
|
|
|
2961
2962
|
directory: string;
|
|
2962
2963
|
documentation: {
|
|
2963
2964
|
readme: {
|
|
2964
|
-
usage: string;
|
|
2965
2965
|
additional?: string | undefined;
|
|
2966
2966
|
explainer?: string | undefined;
|
|
2967
2967
|
footnotes?: string | undefined;
|
|
2968
|
+
usage?: string | undefined;
|
|
2968
2969
|
};
|
|
2969
2970
|
development?: string | undefined;
|
|
2970
2971
|
};
|
|
@@ -3029,10 +3030,10 @@ declare const blocks: {
|
|
|
3029
3030
|
directory: string;
|
|
3030
3031
|
documentation: {
|
|
3031
3032
|
readme: {
|
|
3032
|
-
usage: string;
|
|
3033
3033
|
additional?: string | undefined;
|
|
3034
3034
|
explainer?: string | undefined;
|
|
3035
3035
|
footnotes?: string | undefined;
|
|
3036
|
+
usage?: string | undefined;
|
|
3036
3037
|
};
|
|
3037
3038
|
development?: string | undefined;
|
|
3038
3039
|
};
|
|
@@ -3101,10 +3102,10 @@ declare const blocks: {
|
|
|
3101
3102
|
directory: string;
|
|
3102
3103
|
documentation: {
|
|
3103
3104
|
readme: {
|
|
3104
|
-
usage: string;
|
|
3105
3105
|
additional?: string | undefined;
|
|
3106
3106
|
explainer?: string | undefined;
|
|
3107
3107
|
footnotes?: string | undefined;
|
|
3108
|
+
usage?: string | undefined;
|
|
3108
3109
|
};
|
|
3109
3110
|
development?: string | undefined;
|
|
3110
3111
|
};
|
|
@@ -3281,10 +3282,10 @@ declare const blocks: {
|
|
|
3281
3282
|
directory: string;
|
|
3282
3283
|
documentation: {
|
|
3283
3284
|
readme: {
|
|
3284
|
-
usage: string;
|
|
3285
3285
|
additional?: string | undefined;
|
|
3286
3286
|
explainer?: string | undefined;
|
|
3287
3287
|
footnotes?: string | undefined;
|
|
3288
|
+
usage?: string | undefined;
|
|
3288
3289
|
};
|
|
3289
3290
|
development?: string | undefined;
|
|
3290
3291
|
};
|
|
@@ -3366,10 +3367,10 @@ declare const blocks: {
|
|
|
3366
3367
|
directory: string;
|
|
3367
3368
|
documentation: {
|
|
3368
3369
|
readme: {
|
|
3369
|
-
usage: string;
|
|
3370
3370
|
additional?: string | undefined;
|
|
3371
3371
|
explainer?: string | undefined;
|
|
3372
3372
|
footnotes?: string | undefined;
|
|
3373
|
+
usage?: string | undefined;
|
|
3373
3374
|
};
|
|
3374
3375
|
development?: string | undefined;
|
|
3375
3376
|
};
|
|
@@ -3443,10 +3444,10 @@ declare const blocks: {
|
|
|
3443
3444
|
directory: string;
|
|
3444
3445
|
documentation: {
|
|
3445
3446
|
readme: {
|
|
3446
|
-
usage: string;
|
|
3447
3447
|
additional?: string | undefined;
|
|
3448
3448
|
explainer?: string | undefined;
|
|
3449
3449
|
footnotes?: string | undefined;
|
|
3450
|
+
usage?: string | undefined;
|
|
3450
3451
|
};
|
|
3451
3452
|
development?: string | undefined;
|
|
3452
3453
|
};
|
|
@@ -3511,10 +3512,10 @@ declare const blocks: {
|
|
|
3511
3512
|
directory: string;
|
|
3512
3513
|
documentation: {
|
|
3513
3514
|
readme: {
|
|
3514
|
-
usage: string;
|
|
3515
3515
|
additional?: string | undefined;
|
|
3516
3516
|
explainer?: string | undefined;
|
|
3517
3517
|
footnotes?: string | undefined;
|
|
3518
|
+
usage?: string | undefined;
|
|
3518
3519
|
};
|
|
3519
3520
|
development?: string | undefined;
|
|
3520
3521
|
};
|
package/lib/index.d.ts
CHANGED
|
@@ -89,32 +89,32 @@ declare const createConfig: bingo.CreateTemplateConfig<{
|
|
|
89
89
|
additional: zod.ZodOptional<zod.ZodString>;
|
|
90
90
|
explainer: zod.ZodOptional<zod.ZodString>;
|
|
91
91
|
footnotes: zod.ZodOptional<zod.ZodString>;
|
|
92
|
-
usage: zod.ZodString
|
|
92
|
+
usage: zod.ZodOptional<zod.ZodString>;
|
|
93
93
|
}, "strip", zod.ZodTypeAny, {
|
|
94
|
-
usage: string;
|
|
95
94
|
additional?: string | undefined;
|
|
96
95
|
explainer?: string | undefined;
|
|
97
96
|
footnotes?: string | undefined;
|
|
97
|
+
usage?: string | undefined;
|
|
98
98
|
}, {
|
|
99
|
-
usage: string;
|
|
100
99
|
additional?: string | undefined;
|
|
101
100
|
explainer?: string | undefined;
|
|
102
101
|
footnotes?: string | undefined;
|
|
102
|
+
usage?: string | undefined;
|
|
103
103
|
}>;
|
|
104
104
|
}, "strip", zod.ZodTypeAny, {
|
|
105
105
|
readme: {
|
|
106
|
-
usage: string;
|
|
107
106
|
additional?: string | undefined;
|
|
108
107
|
explainer?: string | undefined;
|
|
109
108
|
footnotes?: string | undefined;
|
|
109
|
+
usage?: string | undefined;
|
|
110
110
|
};
|
|
111
111
|
development?: string | undefined;
|
|
112
112
|
}, {
|
|
113
113
|
readme: {
|
|
114
|
-
usage: string;
|
|
115
114
|
additional?: string | undefined;
|
|
116
115
|
explainer?: string | undefined;
|
|
117
116
|
footnotes?: string | undefined;
|
|
117
|
+
usage?: string | undefined;
|
|
118
118
|
};
|
|
119
119
|
development?: string | undefined;
|
|
120
120
|
}>;
|
|
@@ -229,10 +229,10 @@ declare const createConfig: bingo.CreateTemplateConfig<{
|
|
|
229
229
|
directory: string;
|
|
230
230
|
documentation: {
|
|
231
231
|
readme: {
|
|
232
|
-
usage: string;
|
|
233
232
|
additional?: string | undefined;
|
|
234
233
|
explainer?: string | undefined;
|
|
235
234
|
footnotes?: string | undefined;
|
|
235
|
+
usage?: string | undefined;
|
|
236
236
|
};
|
|
237
237
|
development?: string | undefined;
|
|
238
238
|
};
|
|
@@ -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>, getReadmeFootnotes: () => 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 | undefined>): Promise<Documentation>;
|
|
5
5
|
|
|
6
6
|
export { readDocumentation };
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
declare function readReadmeUsage(
|
|
1
|
+
declare function readReadmeUsage(getReadme: () => Promise<string>): Promise<string | undefined>;
|
|
2
2
|
|
|
3
3
|
export { readReadmeUsage };
|
|
@@ -1,13 +1,17 @@
|
|
|
1
|
-
|
|
2
|
-
async function readReadmeUsage(
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
1
|
+
const startUsage = "## Usage";
|
|
2
|
+
async function readReadmeUsage(getReadme) {
|
|
3
|
+
const readme = await getReadme();
|
|
4
|
+
const indexOfUsage = readme.indexOf(startUsage);
|
|
5
|
+
if (indexOfUsage === -1) {
|
|
6
|
+
return void 0;
|
|
7
|
+
}
|
|
8
|
+
const offset = indexOfUsage + startUsage.length;
|
|
9
|
+
const indexOfNextKnownHeading = readme.slice(offset).search(/## (?:Development|Contributing|Contributors)/);
|
|
10
|
+
if (indexOfNextKnownHeading === -1) {
|
|
11
|
+
return readme.slice(offset) || void 0;
|
|
12
|
+
}
|
|
13
|
+
const usage = readme.slice(offset, indexOfNextKnownHeading + offset).trim();
|
|
14
|
+
return usage || void 0;
|
|
11
15
|
}
|
|
12
16
|
export {
|
|
13
17
|
readReadmeUsage
|
package/lib/presets/common.d.ts
CHANGED
|
@@ -32,32 +32,32 @@ declare const presetCommon: bingo_stratum.Preset<{
|
|
|
32
32
|
additional: zod.ZodOptional<zod.ZodString>;
|
|
33
33
|
explainer: zod.ZodOptional<zod.ZodString>;
|
|
34
34
|
footnotes: zod.ZodOptional<zod.ZodString>;
|
|
35
|
-
usage: zod.ZodString
|
|
35
|
+
usage: zod.ZodOptional<zod.ZodString>;
|
|
36
36
|
}, "strip", zod.ZodTypeAny, {
|
|
37
|
-
usage: string;
|
|
38
37
|
additional?: string | undefined;
|
|
39
38
|
explainer?: string | undefined;
|
|
40
39
|
footnotes?: string | undefined;
|
|
40
|
+
usage?: string | undefined;
|
|
41
41
|
}, {
|
|
42
|
-
usage: string;
|
|
43
42
|
additional?: string | undefined;
|
|
44
43
|
explainer?: string | undefined;
|
|
45
44
|
footnotes?: string | undefined;
|
|
45
|
+
usage?: string | undefined;
|
|
46
46
|
}>;
|
|
47
47
|
}, "strip", zod.ZodTypeAny, {
|
|
48
48
|
readme: {
|
|
49
|
-
usage: string;
|
|
50
49
|
additional?: string | undefined;
|
|
51
50
|
explainer?: string | undefined;
|
|
52
51
|
footnotes?: string | undefined;
|
|
52
|
+
usage?: string | undefined;
|
|
53
53
|
};
|
|
54
54
|
development?: string | undefined;
|
|
55
55
|
}, {
|
|
56
56
|
readme: {
|
|
57
|
-
usage: string;
|
|
58
57
|
additional?: string | undefined;
|
|
59
58
|
explainer?: string | undefined;
|
|
60
59
|
footnotes?: string | undefined;
|
|
60
|
+
usage?: string | undefined;
|
|
61
61
|
};
|
|
62
62
|
development?: string | undefined;
|
|
63
63
|
}>;
|