create-typescript-app 2.24.2 → 2.24.3
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 -1
- package/lib/base.js +5 -4
- 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/blockESLintRegexp.d.ts +1 -1
- package/lib/blocks/blockESLintYML.d.ts +1 -1
- package/lib/blocks/blockExampleFiles.d.ts +1 -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 +1 -1
- package/lib/blocks/blockREADME.js +2 -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/blockVSCode.d.ts +1 -1
- package/lib/blocks/blockVitest.d.ts +1 -1
- package/lib/blocks/index.d.ts +45 -45
- package/lib/data/packageData.d.ts +1 -1
- package/lib/index.d.ts +6 -2
- package/lib/options/readDocumentation.d.ts +1 -1
- package/lib/options/readDocumentation.js +4 -2
- package/lib/options/readReadmeExplainer.d.ts +3 -0
- package/lib/options/readReadmeExplainer.js +30 -0
- package/lib/presets/common.d.ts +5 -1
- package/lib/presets/everything.d.ts +5 -1
- package/lib/presets/index.d.ts +15 -3
- package/lib/presets/minimal.d.ts +5 -1
- package/lib/schemas.d.ts +8 -0
- package/lib/schemas.js +1 -0
- package/lib/template.d.ts +5 -1
- package/package.json +1 -1
- package/lib/options/readExplainer.d.ts +0 -3
- package/lib/options/readExplainer.js +0 -12
package/lib/index.d.ts
CHANGED
|
@@ -85,24 +85,29 @@ declare const createConfig: bingo.CreateTemplateConfig<{
|
|
|
85
85
|
development: zod.ZodOptional<zod.ZodString>;
|
|
86
86
|
readme: zod.ZodObject<{
|
|
87
87
|
additional: zod.ZodOptional<zod.ZodString>;
|
|
88
|
+
explainer: zod.ZodOptional<zod.ZodString>;
|
|
88
89
|
usage: zod.ZodString;
|
|
89
90
|
}, "strip", zod.ZodTypeAny, {
|
|
90
91
|
usage: string;
|
|
91
92
|
additional?: string | undefined;
|
|
93
|
+
explainer?: string | undefined;
|
|
92
94
|
}, {
|
|
93
95
|
usage: string;
|
|
94
96
|
additional?: string | undefined;
|
|
97
|
+
explainer?: string | undefined;
|
|
95
98
|
}>;
|
|
96
99
|
}, "strip", zod.ZodTypeAny, {
|
|
97
100
|
readme: {
|
|
98
101
|
usage: string;
|
|
99
102
|
additional?: string | undefined;
|
|
103
|
+
explainer?: string | undefined;
|
|
100
104
|
};
|
|
101
105
|
development?: string | undefined;
|
|
102
106
|
}, {
|
|
103
107
|
readme: {
|
|
104
108
|
usage: string;
|
|
105
109
|
additional?: string | undefined;
|
|
110
|
+
explainer?: string | undefined;
|
|
106
111
|
};
|
|
107
112
|
development?: string | undefined;
|
|
108
113
|
}>;
|
|
@@ -136,7 +141,6 @@ declare const createConfig: bingo.CreateTemplateConfig<{
|
|
|
136
141
|
description: string;
|
|
137
142
|
color: string;
|
|
138
143
|
}>, "many">>;
|
|
139
|
-
explainer: zod.ZodOptional<zod.ZodArray<zod.ZodString, "many">>;
|
|
140
144
|
funding: zod.ZodOptional<zod.ZodString>;
|
|
141
145
|
guide: zod.ZodOptional<zod.ZodObject<{
|
|
142
146
|
href: zod.ZodString;
|
|
@@ -220,6 +224,7 @@ declare const createConfig: bingo.CreateTemplateConfig<{
|
|
|
220
224
|
readme: {
|
|
221
225
|
usage: string;
|
|
222
226
|
additional?: string | undefined;
|
|
227
|
+
explainer?: string | undefined;
|
|
223
228
|
};
|
|
224
229
|
development?: string | undefined;
|
|
225
230
|
};
|
|
@@ -250,7 +255,6 @@ declare const createConfig: bingo.CreateTemplateConfig<{
|
|
|
250
255
|
description: string;
|
|
251
256
|
color: string;
|
|
252
257
|
}[] | undefined;
|
|
253
|
-
explainer?: string[] | undefined;
|
|
254
258
|
funding?: string | undefined;
|
|
255
259
|
guide?: {
|
|
256
260
|
href: string;
|
|
@@ -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>, getReadmeUsage: () => Promise<string>): Promise<Documentation>;
|
|
4
|
+
declare function readDocumentation(getDevelopmentDocumentation: () => Promise<string | undefined>, getReadmeAdditional: () => Promise<string | undefined>, getReadmeExplainer: () => Promise<string | undefined>, getReadmeUsage: () => Promise<string>): Promise<Documentation>;
|
|
5
5
|
|
|
6
6
|
export { readDocumentation };
|
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
async function readDocumentation(getDevelopmentDocumentation, getReadmeAdditional, getReadmeUsage) {
|
|
2
|
-
const [additional, development, usage] = await Promise.all([
|
|
1
|
+
async function readDocumentation(getDevelopmentDocumentation, getReadmeAdditional, getReadmeExplainer, getReadmeUsage) {
|
|
2
|
+
const [additional, explainer, development, usage] = await Promise.all([
|
|
3
3
|
getReadmeAdditional(),
|
|
4
|
+
getReadmeExplainer(),
|
|
4
5
|
getDevelopmentDocumentation(),
|
|
5
6
|
getReadmeUsage()
|
|
6
7
|
]);
|
|
@@ -8,6 +9,7 @@ async function readDocumentation(getDevelopmentDocumentation, getReadmeAdditiona
|
|
|
8
9
|
development,
|
|
9
10
|
readme: {
|
|
10
11
|
additional,
|
|
12
|
+
explainer,
|
|
11
13
|
usage
|
|
12
14
|
}
|
|
13
15
|
};
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
async function readReadmeExplainer(getReadme) {
|
|
2
|
+
const readme = await getReadme();
|
|
3
|
+
const indexOfUsageH2 = /## Usage/.exec(readme)?.index ?? readme.indexOf("##");
|
|
4
|
+
if (indexOfUsageH2 === -1) {
|
|
5
|
+
return void 0;
|
|
6
|
+
}
|
|
7
|
+
const beforeUsageH2 = readme.slice(0, indexOfUsageH2);
|
|
8
|
+
const [indexOfLastTag, lastTagMatcher] = lastLastIndexOf(beforeUsageH2, [
|
|
9
|
+
`">`,
|
|
10
|
+
"/p>",
|
|
11
|
+
"/>"
|
|
12
|
+
]);
|
|
13
|
+
if (!lastTagMatcher) {
|
|
14
|
+
return void 0;
|
|
15
|
+
}
|
|
16
|
+
return readme.slice(indexOfLastTag + lastTagMatcher.length, indexOfUsageH2).trim();
|
|
17
|
+
}
|
|
18
|
+
function lastLastIndexOf(text, matchers) {
|
|
19
|
+
let pair = [-1, void 0];
|
|
20
|
+
for (const matcher of matchers) {
|
|
21
|
+
const indexOf = text.lastIndexOf(matcher);
|
|
22
|
+
if (indexOf > pair[0]) {
|
|
23
|
+
pair = [indexOf, matcher];
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
return pair;
|
|
27
|
+
}
|
|
28
|
+
export {
|
|
29
|
+
readReadmeExplainer
|
|
30
|
+
};
|
package/lib/presets/common.d.ts
CHANGED
|
@@ -30,24 +30,29 @@ declare const presetCommon: bingo_stratum.Preset<{
|
|
|
30
30
|
development: zod.ZodOptional<zod.ZodString>;
|
|
31
31
|
readme: zod.ZodObject<{
|
|
32
32
|
additional: zod.ZodOptional<zod.ZodString>;
|
|
33
|
+
explainer: zod.ZodOptional<zod.ZodString>;
|
|
33
34
|
usage: zod.ZodString;
|
|
34
35
|
}, "strip", zod.ZodTypeAny, {
|
|
35
36
|
usage: string;
|
|
36
37
|
additional?: string | undefined;
|
|
38
|
+
explainer?: string | undefined;
|
|
37
39
|
}, {
|
|
38
40
|
usage: string;
|
|
39
41
|
additional?: string | undefined;
|
|
42
|
+
explainer?: string | undefined;
|
|
40
43
|
}>;
|
|
41
44
|
}, "strip", zod.ZodTypeAny, {
|
|
42
45
|
readme: {
|
|
43
46
|
usage: string;
|
|
44
47
|
additional?: string | undefined;
|
|
48
|
+
explainer?: string | undefined;
|
|
45
49
|
};
|
|
46
50
|
development?: string | undefined;
|
|
47
51
|
}, {
|
|
48
52
|
readme: {
|
|
49
53
|
usage: string;
|
|
50
54
|
additional?: string | undefined;
|
|
55
|
+
explainer?: string | undefined;
|
|
51
56
|
};
|
|
52
57
|
development?: string | undefined;
|
|
53
58
|
}>;
|
|
@@ -81,7 +86,6 @@ declare const presetCommon: bingo_stratum.Preset<{
|
|
|
81
86
|
description: string;
|
|
82
87
|
color: string;
|
|
83
88
|
}>, "many">>;
|
|
84
|
-
explainer: zod.ZodOptional<zod.ZodArray<zod.ZodString, "many">>;
|
|
85
89
|
funding: zod.ZodOptional<zod.ZodString>;
|
|
86
90
|
guide: zod.ZodOptional<zod.ZodObject<{
|
|
87
91
|
href: zod.ZodString;
|
|
@@ -30,24 +30,29 @@ declare const presetEverything: bingo_stratum.Preset<{
|
|
|
30
30
|
development: zod.ZodOptional<zod.ZodString>;
|
|
31
31
|
readme: zod.ZodObject<{
|
|
32
32
|
additional: zod.ZodOptional<zod.ZodString>;
|
|
33
|
+
explainer: zod.ZodOptional<zod.ZodString>;
|
|
33
34
|
usage: zod.ZodString;
|
|
34
35
|
}, "strip", zod.ZodTypeAny, {
|
|
35
36
|
usage: string;
|
|
36
37
|
additional?: string | undefined;
|
|
38
|
+
explainer?: string | undefined;
|
|
37
39
|
}, {
|
|
38
40
|
usage: string;
|
|
39
41
|
additional?: string | undefined;
|
|
42
|
+
explainer?: string | undefined;
|
|
40
43
|
}>;
|
|
41
44
|
}, "strip", zod.ZodTypeAny, {
|
|
42
45
|
readme: {
|
|
43
46
|
usage: string;
|
|
44
47
|
additional?: string | undefined;
|
|
48
|
+
explainer?: string | undefined;
|
|
45
49
|
};
|
|
46
50
|
development?: string | undefined;
|
|
47
51
|
}, {
|
|
48
52
|
readme: {
|
|
49
53
|
usage: string;
|
|
50
54
|
additional?: string | undefined;
|
|
55
|
+
explainer?: string | undefined;
|
|
51
56
|
};
|
|
52
57
|
development?: string | undefined;
|
|
53
58
|
}>;
|
|
@@ -81,7 +86,6 @@ declare const presetEverything: bingo_stratum.Preset<{
|
|
|
81
86
|
description: string;
|
|
82
87
|
color: string;
|
|
83
88
|
}>, "many">>;
|
|
84
|
-
explainer: zod.ZodOptional<zod.ZodArray<zod.ZodString, "many">>;
|
|
85
89
|
funding: zod.ZodOptional<zod.ZodString>;
|
|
86
90
|
guide: zod.ZodOptional<zod.ZodObject<{
|
|
87
91
|
href: zod.ZodString;
|
package/lib/presets/index.d.ts
CHANGED
|
@@ -34,24 +34,29 @@ declare const presets: {
|
|
|
34
34
|
development: zod.ZodOptional<zod.ZodString>;
|
|
35
35
|
readme: zod.ZodObject<{
|
|
36
36
|
additional: zod.ZodOptional<zod.ZodString>;
|
|
37
|
+
explainer: zod.ZodOptional<zod.ZodString>;
|
|
37
38
|
usage: zod.ZodString;
|
|
38
39
|
}, "strip", zod.ZodTypeAny, {
|
|
39
40
|
usage: string;
|
|
40
41
|
additional?: string | undefined;
|
|
42
|
+
explainer?: string | undefined;
|
|
41
43
|
}, {
|
|
42
44
|
usage: string;
|
|
43
45
|
additional?: string | undefined;
|
|
46
|
+
explainer?: string | undefined;
|
|
44
47
|
}>;
|
|
45
48
|
}, "strip", zod.ZodTypeAny, {
|
|
46
49
|
readme: {
|
|
47
50
|
usage: string;
|
|
48
51
|
additional?: string | undefined;
|
|
52
|
+
explainer?: string | undefined;
|
|
49
53
|
};
|
|
50
54
|
development?: string | undefined;
|
|
51
55
|
}, {
|
|
52
56
|
readme: {
|
|
53
57
|
usage: string;
|
|
54
58
|
additional?: string | undefined;
|
|
59
|
+
explainer?: string | undefined;
|
|
55
60
|
};
|
|
56
61
|
development?: string | undefined;
|
|
57
62
|
}>;
|
|
@@ -85,7 +90,6 @@ declare const presets: {
|
|
|
85
90
|
description: string;
|
|
86
91
|
color: string;
|
|
87
92
|
}>, "many">>;
|
|
88
|
-
explainer: zod.ZodOptional<zod.ZodArray<zod.ZodString, "many">>;
|
|
89
93
|
funding: zod.ZodOptional<zod.ZodString>;
|
|
90
94
|
guide: zod.ZodOptional<zod.ZodObject<{
|
|
91
95
|
href: zod.ZodString;
|
|
@@ -191,24 +195,29 @@ declare const presets: {
|
|
|
191
195
|
development: zod.ZodOptional<zod.ZodString>;
|
|
192
196
|
readme: zod.ZodObject<{
|
|
193
197
|
additional: zod.ZodOptional<zod.ZodString>;
|
|
198
|
+
explainer: zod.ZodOptional<zod.ZodString>;
|
|
194
199
|
usage: zod.ZodString;
|
|
195
200
|
}, "strip", zod.ZodTypeAny, {
|
|
196
201
|
usage: string;
|
|
197
202
|
additional?: string | undefined;
|
|
203
|
+
explainer?: string | undefined;
|
|
198
204
|
}, {
|
|
199
205
|
usage: string;
|
|
200
206
|
additional?: string | undefined;
|
|
207
|
+
explainer?: string | undefined;
|
|
201
208
|
}>;
|
|
202
209
|
}, "strip", zod.ZodTypeAny, {
|
|
203
210
|
readme: {
|
|
204
211
|
usage: string;
|
|
205
212
|
additional?: string | undefined;
|
|
213
|
+
explainer?: string | undefined;
|
|
206
214
|
};
|
|
207
215
|
development?: string | undefined;
|
|
208
216
|
}, {
|
|
209
217
|
readme: {
|
|
210
218
|
usage: string;
|
|
211
219
|
additional?: string | undefined;
|
|
220
|
+
explainer?: string | undefined;
|
|
212
221
|
};
|
|
213
222
|
development?: string | undefined;
|
|
214
223
|
}>;
|
|
@@ -242,7 +251,6 @@ declare const presets: {
|
|
|
242
251
|
description: string;
|
|
243
252
|
color: string;
|
|
244
253
|
}>, "many">>;
|
|
245
|
-
explainer: zod.ZodOptional<zod.ZodArray<zod.ZodString, "many">>;
|
|
246
254
|
funding: zod.ZodOptional<zod.ZodString>;
|
|
247
255
|
guide: zod.ZodOptional<zod.ZodObject<{
|
|
248
256
|
href: zod.ZodString;
|
|
@@ -348,24 +356,29 @@ declare const presets: {
|
|
|
348
356
|
development: zod.ZodOptional<zod.ZodString>;
|
|
349
357
|
readme: zod.ZodObject<{
|
|
350
358
|
additional: zod.ZodOptional<zod.ZodString>;
|
|
359
|
+
explainer: zod.ZodOptional<zod.ZodString>;
|
|
351
360
|
usage: zod.ZodString;
|
|
352
361
|
}, "strip", zod.ZodTypeAny, {
|
|
353
362
|
usage: string;
|
|
354
363
|
additional?: string | undefined;
|
|
364
|
+
explainer?: string | undefined;
|
|
355
365
|
}, {
|
|
356
366
|
usage: string;
|
|
357
367
|
additional?: string | undefined;
|
|
368
|
+
explainer?: string | undefined;
|
|
358
369
|
}>;
|
|
359
370
|
}, "strip", zod.ZodTypeAny, {
|
|
360
371
|
readme: {
|
|
361
372
|
usage: string;
|
|
362
373
|
additional?: string | undefined;
|
|
374
|
+
explainer?: string | undefined;
|
|
363
375
|
};
|
|
364
376
|
development?: string | undefined;
|
|
365
377
|
}, {
|
|
366
378
|
readme: {
|
|
367
379
|
usage: string;
|
|
368
380
|
additional?: string | undefined;
|
|
381
|
+
explainer?: string | undefined;
|
|
369
382
|
};
|
|
370
383
|
development?: string | undefined;
|
|
371
384
|
}>;
|
|
@@ -399,7 +412,6 @@ declare const presets: {
|
|
|
399
412
|
description: string;
|
|
400
413
|
color: string;
|
|
401
414
|
}>, "many">>;
|
|
402
|
-
explainer: zod.ZodOptional<zod.ZodArray<zod.ZodString, "many">>;
|
|
403
415
|
funding: zod.ZodOptional<zod.ZodString>;
|
|
404
416
|
guide: zod.ZodOptional<zod.ZodObject<{
|
|
405
417
|
href: zod.ZodString;
|
package/lib/presets/minimal.d.ts
CHANGED
|
@@ -30,24 +30,29 @@ declare const presetMinimal: bingo_stratum.Preset<{
|
|
|
30
30
|
development: zod.ZodOptional<zod.ZodString>;
|
|
31
31
|
readme: zod.ZodObject<{
|
|
32
32
|
additional: zod.ZodOptional<zod.ZodString>;
|
|
33
|
+
explainer: zod.ZodOptional<zod.ZodString>;
|
|
33
34
|
usage: zod.ZodString;
|
|
34
35
|
}, "strip", zod.ZodTypeAny, {
|
|
35
36
|
usage: string;
|
|
36
37
|
additional?: string | undefined;
|
|
38
|
+
explainer?: string | undefined;
|
|
37
39
|
}, {
|
|
38
40
|
usage: string;
|
|
39
41
|
additional?: string | undefined;
|
|
42
|
+
explainer?: string | undefined;
|
|
40
43
|
}>;
|
|
41
44
|
}, "strip", zod.ZodTypeAny, {
|
|
42
45
|
readme: {
|
|
43
46
|
usage: string;
|
|
44
47
|
additional?: string | undefined;
|
|
48
|
+
explainer?: string | undefined;
|
|
45
49
|
};
|
|
46
50
|
development?: string | undefined;
|
|
47
51
|
}, {
|
|
48
52
|
readme: {
|
|
49
53
|
usage: string;
|
|
50
54
|
additional?: string | undefined;
|
|
55
|
+
explainer?: string | undefined;
|
|
51
56
|
};
|
|
52
57
|
development?: string | undefined;
|
|
53
58
|
}>;
|
|
@@ -81,7 +86,6 @@ declare const presetMinimal: bingo_stratum.Preset<{
|
|
|
81
86
|
description: string;
|
|
82
87
|
color: string;
|
|
83
88
|
}>, "many">>;
|
|
84
|
-
explainer: zod.ZodOptional<zod.ZodArray<zod.ZodString, "many">>;
|
|
85
89
|
funding: zod.ZodOptional<zod.ZodString>;
|
|
86
90
|
guide: zod.ZodOptional<zod.ZodObject<{
|
|
87
91
|
href: zod.ZodString;
|
package/lib/schemas.d.ts
CHANGED
|
@@ -22,37 +22,45 @@ declare const zContributor: z.ZodObject<{
|
|
|
22
22
|
type Contributor = z.infer<typeof zContributor>;
|
|
23
23
|
declare const zReadme: z.ZodObject<{
|
|
24
24
|
additional: z.ZodOptional<z.ZodString>;
|
|
25
|
+
explainer: z.ZodOptional<z.ZodString>;
|
|
25
26
|
usage: z.ZodString;
|
|
26
27
|
}, "strip", z.ZodTypeAny, {
|
|
27
28
|
usage: string;
|
|
28
29
|
additional?: string | undefined;
|
|
30
|
+
explainer?: string | undefined;
|
|
29
31
|
}, {
|
|
30
32
|
usage: string;
|
|
31
33
|
additional?: string | undefined;
|
|
34
|
+
explainer?: string | undefined;
|
|
32
35
|
}>;
|
|
33
36
|
type Readme = z.infer<typeof zReadme>;
|
|
34
37
|
declare const zDocumentation: z.ZodObject<{
|
|
35
38
|
development: z.ZodOptional<z.ZodString>;
|
|
36
39
|
readme: z.ZodObject<{
|
|
37
40
|
additional: z.ZodOptional<z.ZodString>;
|
|
41
|
+
explainer: z.ZodOptional<z.ZodString>;
|
|
38
42
|
usage: z.ZodString;
|
|
39
43
|
}, "strip", z.ZodTypeAny, {
|
|
40
44
|
usage: string;
|
|
41
45
|
additional?: string | undefined;
|
|
46
|
+
explainer?: string | undefined;
|
|
42
47
|
}, {
|
|
43
48
|
usage: string;
|
|
44
49
|
additional?: string | undefined;
|
|
50
|
+
explainer?: string | undefined;
|
|
45
51
|
}>;
|
|
46
52
|
}, "strip", z.ZodTypeAny, {
|
|
47
53
|
readme: {
|
|
48
54
|
usage: string;
|
|
49
55
|
additional?: string | undefined;
|
|
56
|
+
explainer?: string | undefined;
|
|
50
57
|
};
|
|
51
58
|
development?: string | undefined;
|
|
52
59
|
}, {
|
|
53
60
|
readme: {
|
|
54
61
|
usage: string;
|
|
55
62
|
additional?: string | undefined;
|
|
63
|
+
explainer?: string | undefined;
|
|
56
64
|
};
|
|
57
65
|
development?: string | undefined;
|
|
58
66
|
}>;
|
package/lib/schemas.js
CHANGED
package/lib/template.d.ts
CHANGED
|
@@ -30,24 +30,29 @@ declare const template: bingo_stratum_lib_types_templates_js.StratumTemplate<{
|
|
|
30
30
|
development: zod.ZodOptional<zod.ZodString>;
|
|
31
31
|
readme: zod.ZodObject<{
|
|
32
32
|
additional: zod.ZodOptional<zod.ZodString>;
|
|
33
|
+
explainer: zod.ZodOptional<zod.ZodString>;
|
|
33
34
|
usage: zod.ZodString;
|
|
34
35
|
}, "strip", zod.ZodTypeAny, {
|
|
35
36
|
usage: string;
|
|
36
37
|
additional?: string | undefined;
|
|
38
|
+
explainer?: string | undefined;
|
|
37
39
|
}, {
|
|
38
40
|
usage: string;
|
|
39
41
|
additional?: string | undefined;
|
|
42
|
+
explainer?: string | undefined;
|
|
40
43
|
}>;
|
|
41
44
|
}, "strip", zod.ZodTypeAny, {
|
|
42
45
|
readme: {
|
|
43
46
|
usage: string;
|
|
44
47
|
additional?: string | undefined;
|
|
48
|
+
explainer?: string | undefined;
|
|
45
49
|
};
|
|
46
50
|
development?: string | undefined;
|
|
47
51
|
}, {
|
|
48
52
|
readme: {
|
|
49
53
|
usage: string;
|
|
50
54
|
additional?: string | undefined;
|
|
55
|
+
explainer?: string | undefined;
|
|
51
56
|
};
|
|
52
57
|
development?: string | undefined;
|
|
53
58
|
}>;
|
|
@@ -81,7 +86,6 @@ declare const template: bingo_stratum_lib_types_templates_js.StratumTemplate<{
|
|
|
81
86
|
description: string;
|
|
82
87
|
color: string;
|
|
83
88
|
}>, "many">>;
|
|
84
|
-
explainer: zod.ZodOptional<zod.ZodArray<zod.ZodString, "many">>;
|
|
85
89
|
funding: zod.ZodOptional<zod.ZodString>;
|
|
86
90
|
guide: zod.ZodOptional<zod.ZodObject<{
|
|
87
91
|
href: zod.ZodString;
|
package/package.json
CHANGED
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
async function readExplainer(getReadme) {
|
|
2
|
-
const readme = await getReadme();
|
|
3
|
-
const indexOfH2 = readme.indexOf("##");
|
|
4
|
-
if (indexOfH2 === -1) {
|
|
5
|
-
return void 0;
|
|
6
|
-
}
|
|
7
|
-
const lastTag = readme.slice(0, indexOfH2).lastIndexOf(">");
|
|
8
|
-
return readme.slice(lastTag + 1, indexOfH2).split("\n").map((line) => line.trim()).filter(Boolean);
|
|
9
|
-
}
|
|
10
|
-
export {
|
|
11
|
-
readExplainer
|
|
12
|
-
};
|