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.
Files changed (75) hide show
  1. package/lib/base.d.ts +5 -1
  2. package/lib/base.js +5 -4
  3. package/lib/blocks/blockAllContributors.d.ts +1 -1
  4. package/lib/blocks/blockAreTheTypesWrong.d.ts +1 -1
  5. package/lib/blocks/blockCSpell.d.ts +1 -1
  6. package/lib/blocks/blockCTATransitions.d.ts +1 -1
  7. package/lib/blocks/blockCodecov.d.ts +1 -1
  8. package/lib/blocks/blockContributingDocs.d.ts +1 -1
  9. package/lib/blocks/blockContributorCovenant.d.ts +1 -1
  10. package/lib/blocks/blockDevelopmentDocs.d.ts +1 -1
  11. package/lib/blocks/blockESLint.d.ts +1 -1
  12. package/lib/blocks/blockESLintComments.d.ts +1 -1
  13. package/lib/blocks/blockESLintJSDoc.d.ts +1 -1
  14. package/lib/blocks/blockESLintJSONC.d.ts +1 -1
  15. package/lib/blocks/blockESLintMarkdown.d.ts +1 -1
  16. package/lib/blocks/blockESLintMoreStyling.d.ts +1 -1
  17. package/lib/blocks/blockESLintNode.d.ts +1 -1
  18. package/lib/blocks/blockESLintPackageJson.d.ts +1 -1
  19. package/lib/blocks/blockESLintPerfectionist.d.ts +1 -1
  20. package/lib/blocks/blockESLintRegexp.d.ts +1 -1
  21. package/lib/blocks/blockESLintYML.d.ts +1 -1
  22. package/lib/blocks/blockExampleFiles.d.ts +1 -1
  23. package/lib/blocks/blockFunding.d.ts +1 -1
  24. package/lib/blocks/blockGitHubActionsCI.d.ts +1 -1
  25. package/lib/blocks/blockGitHubApps.d.ts +1 -1
  26. package/lib/blocks/blockGitHubIssueTemplates.d.ts +1 -1
  27. package/lib/blocks/blockGitHubPRTemplate.d.ts +1 -1
  28. package/lib/blocks/blockGitignore.d.ts +1 -1
  29. package/lib/blocks/blockKnip.d.ts +1 -1
  30. package/lib/blocks/blockMITLicense.d.ts +1 -1
  31. package/lib/blocks/blockMain.d.ts +1 -1
  32. package/lib/blocks/blockMarkdownlint.d.ts +1 -1
  33. package/lib/blocks/blockNcc.d.ts +1 -1
  34. package/lib/blocks/blockNvmrc.d.ts +1 -1
  35. package/lib/blocks/blockPRCompliance.d.ts +1 -1
  36. package/lib/blocks/blockPackageJson.d.ts +1 -1
  37. package/lib/blocks/blockPnpmDedupe.d.ts +1 -1
  38. package/lib/blocks/blockPrettier.d.ts +1 -1
  39. package/lib/blocks/blockPrettierPluginCurly.d.ts +1 -1
  40. package/lib/blocks/blockPrettierPluginPackageJson.d.ts +1 -1
  41. package/lib/blocks/blockPrettierPluginSh.d.ts +1 -1
  42. package/lib/blocks/blockREADME.d.ts +1 -1
  43. package/lib/blocks/blockREADME.js +2 -2
  44. package/lib/blocks/blockReleaseIt.d.ts +1 -1
  45. package/lib/blocks/blockRemoveDependencies.d.ts +1 -1
  46. package/lib/blocks/blockRemoveFiles.d.ts +1 -1
  47. package/lib/blocks/blockRemoveWorkflows.d.ts +1 -1
  48. package/lib/blocks/blockRenovate.d.ts +1 -1
  49. package/lib/blocks/blockRepositoryBranchRuleset.d.ts +1 -1
  50. package/lib/blocks/blockRepositoryLabels.d.ts +1 -1
  51. package/lib/blocks/blockRepositorySecrets.d.ts +1 -1
  52. package/lib/blocks/blockRepositorySettings.d.ts +1 -1
  53. package/lib/blocks/blockSecurityDocs.d.ts +1 -1
  54. package/lib/blocks/blockTSup.d.ts +1 -1
  55. package/lib/blocks/blockTemplatedWith.d.ts +1 -1
  56. package/lib/blocks/blockTypeScript.d.ts +1 -1
  57. package/lib/blocks/blockVSCode.d.ts +1 -1
  58. package/lib/blocks/blockVitest.d.ts +1 -1
  59. package/lib/blocks/index.d.ts +45 -45
  60. package/lib/data/packageData.d.ts +1 -1
  61. package/lib/index.d.ts +6 -2
  62. package/lib/options/readDocumentation.d.ts +1 -1
  63. package/lib/options/readDocumentation.js +4 -2
  64. package/lib/options/readReadmeExplainer.d.ts +3 -0
  65. package/lib/options/readReadmeExplainer.js +30 -0
  66. package/lib/presets/common.d.ts +5 -1
  67. package/lib/presets/everything.d.ts +5 -1
  68. package/lib/presets/index.d.ts +15 -3
  69. package/lib/presets/minimal.d.ts +5 -1
  70. package/lib/schemas.d.ts +8 -0
  71. package/lib/schemas.js +1 -0
  72. package/lib/template.d.ts +5 -1
  73. package/package.json +1 -1
  74. package/lib/options/readExplainer.d.ts +0 -3
  75. package/lib/options/readExplainer.js +0 -12
@@ -8,6 +8,7 @@ declare const blockPnpmDedupe: bingo_stratum.BlockWithoutAddons<{
8
8
  readme: {
9
9
  usage: string;
10
10
  additional?: string | undefined;
11
+ explainer?: string | undefined;
11
12
  };
12
13
  development?: string | undefined;
13
14
  };
@@ -38,7 +39,6 @@ declare const blockPnpmDedupe: bingo_stratum.BlockWithoutAddons<{
38
39
  description: string;
39
40
  color: string;
40
41
  }[] | undefined;
41
- explainer?: string[] | undefined;
42
42
  funding?: string | undefined;
43
43
  guide?: {
44
44
  href: string;
@@ -18,6 +18,7 @@ declare const blockPrettier: bingo_stratum.BlockWithAddons<{
18
18
  readme: {
19
19
  usage: string;
20
20
  additional?: string | undefined;
21
+ explainer?: string | undefined;
21
22
  };
22
23
  development?: string | undefined;
23
24
  };
@@ -48,7 +49,6 @@ declare const blockPrettier: bingo_stratum.BlockWithAddons<{
48
49
  description: string;
49
50
  color: string;
50
51
  }[] | undefined;
51
- explainer?: string[] | undefined;
52
52
  funding?: string | undefined;
53
53
  guide?: {
54
54
  href: string;
@@ -8,6 +8,7 @@ declare const blockPrettierPluginCurly: bingo_stratum.BlockWithoutAddons<{
8
8
  readme: {
9
9
  usage: string;
10
10
  additional?: string | undefined;
11
+ explainer?: string | undefined;
11
12
  };
12
13
  development?: string | undefined;
13
14
  };
@@ -38,7 +39,6 @@ declare const blockPrettierPluginCurly: bingo_stratum.BlockWithoutAddons<{
38
39
  description: string;
39
40
  color: string;
40
41
  }[] | undefined;
41
- explainer?: string[] | undefined;
42
42
  funding?: string | undefined;
43
43
  guide?: {
44
44
  href: string;
@@ -8,6 +8,7 @@ declare const blockPrettierPluginPackageJson: bingo_stratum.BlockWithoutAddons<{
8
8
  readme: {
9
9
  usage: string;
10
10
  additional?: string | undefined;
11
+ explainer?: string | undefined;
11
12
  };
12
13
  development?: string | undefined;
13
14
  };
@@ -38,7 +39,6 @@ declare const blockPrettierPluginPackageJson: bingo_stratum.BlockWithoutAddons<{
38
39
  description: string;
39
40
  color: string;
40
41
  }[] | undefined;
41
- explainer?: string[] | undefined;
42
42
  funding?: string | undefined;
43
43
  guide?: {
44
44
  href: string;
@@ -8,6 +8,7 @@ declare const blockPrettierPluginSh: bingo_stratum.BlockWithoutAddons<{
8
8
  readme: {
9
9
  usage: string;
10
10
  additional?: string | undefined;
11
+ explainer?: string | undefined;
11
12
  };
12
13
  development?: string | undefined;
13
14
  };
@@ -38,7 +39,6 @@ declare const blockPrettierPluginSh: bingo_stratum.BlockWithoutAddons<{
38
39
  description: string;
39
40
  color: string;
40
41
  }[] | undefined;
41
- explainer?: string[] | undefined;
42
42
  funding?: string | undefined;
43
43
  guide?: {
44
44
  href: string;
@@ -20,6 +20,7 @@ declare const blockREADME: bingo_stratum.BlockWithAddons<{
20
20
  readme: {
21
21
  usage: string;
22
22
  additional?: string | undefined;
23
+ explainer?: string | undefined;
23
24
  };
24
25
  development?: string | undefined;
25
26
  };
@@ -50,7 +51,6 @@ declare const blockREADME: bingo_stratum.BlockWithAddons<{
50
51
  description: string;
51
52
  color: string;
52
53
  }[] | undefined;
53
- explainer?: string[] | undefined;
54
54
  funding?: string | undefined;
55
55
  guide?: {
56
56
  href: string;
@@ -23,8 +23,8 @@ const blockREADME = base.createBlock({
23
23
  },
24
24
  produce({ addons, options }) {
25
25
  const { badges, notices, sections } = addons;
26
- const explainer = options.explainer && `
27
- ${options.explainer.join("\n")}
26
+ const explainer = options.documentation.readme.explainer && `
27
+ ${options.documentation.readme.explainer}
28
28
  `;
29
29
  const logo = options.logo && `
30
30
  <img ${printAttributes({ align: "right", ...options.logo })}>
@@ -13,6 +13,7 @@ declare const blockReleaseIt: bingo_stratum.BlockWithAddons<{
13
13
  readme: {
14
14
  usage: string;
15
15
  additional?: string | undefined;
16
+ explainer?: string | undefined;
16
17
  };
17
18
  development?: string | undefined;
18
19
  };
@@ -43,7 +44,6 @@ declare const blockReleaseIt: bingo_stratum.BlockWithAddons<{
43
44
  description: string;
44
45
  color: string;
45
46
  }[] | undefined;
46
- explainer?: string[] | undefined;
47
47
  funding?: string | undefined;
48
48
  guide?: {
49
49
  href: string;
@@ -10,6 +10,7 @@ declare const blockRemoveDependencies: bingo_stratum.BlockWithAddons<{
10
10
  readme: {
11
11
  usage: string;
12
12
  additional?: string | undefined;
13
+ explainer?: string | undefined;
13
14
  };
14
15
  development?: string | undefined;
15
16
  };
@@ -40,7 +41,6 @@ declare const blockRemoveDependencies: bingo_stratum.BlockWithAddons<{
40
41
  description: string;
41
42
  color: string;
42
43
  }[] | undefined;
43
- explainer?: string[] | undefined;
44
44
  funding?: string | undefined;
45
45
  guide?: {
46
46
  href: string;
@@ -10,6 +10,7 @@ declare const blockRemoveFiles: bingo_stratum.BlockWithAddons<{
10
10
  readme: {
11
11
  usage: string;
12
12
  additional?: string | undefined;
13
+ explainer?: string | undefined;
13
14
  };
14
15
  development?: string | undefined;
15
16
  };
@@ -40,7 +41,6 @@ declare const blockRemoveFiles: bingo_stratum.BlockWithAddons<{
40
41
  description: string;
41
42
  color: string;
42
43
  }[] | undefined;
43
- explainer?: string[] | undefined;
44
44
  funding?: string | undefined;
45
45
  guide?: {
46
46
  href: string;
@@ -10,6 +10,7 @@ declare const blockRemoveWorkflows: bingo_stratum.BlockWithAddons<{
10
10
  readme: {
11
11
  usage: string;
12
12
  additional?: string | undefined;
13
+ explainer?: string | undefined;
13
14
  };
14
15
  development?: string | undefined;
15
16
  };
@@ -40,7 +41,6 @@ declare const blockRemoveWorkflows: bingo_stratum.BlockWithAddons<{
40
41
  description: string;
41
42
  color: string;
42
43
  }[] | undefined;
43
- explainer?: string[] | undefined;
44
44
  funding?: string | undefined;
45
45
  guide?: {
46
46
  href: string;
@@ -8,6 +8,7 @@ declare const blockRenovate: bingo_stratum.BlockWithoutAddons<{
8
8
  readme: {
9
9
  usage: string;
10
10
  additional?: string | undefined;
11
+ explainer?: string | undefined;
11
12
  };
12
13
  development?: string | undefined;
13
14
  };
@@ -38,7 +39,6 @@ declare const blockRenovate: bingo_stratum.BlockWithoutAddons<{
38
39
  description: string;
39
40
  color: string;
40
41
  }[] | undefined;
41
- explainer?: string[] | undefined;
42
42
  funding?: string | undefined;
43
43
  guide?: {
44
44
  href: string;
@@ -10,6 +10,7 @@ declare const blockRepositoryBranchRuleset: bingo_stratum.BlockWithAddons<{
10
10
  readme: {
11
11
  usage: string;
12
12
  additional?: string | undefined;
13
+ explainer?: string | undefined;
13
14
  };
14
15
  development?: string | undefined;
15
16
  };
@@ -40,7 +41,6 @@ declare const blockRepositoryBranchRuleset: bingo_stratum.BlockWithAddons<{
40
41
  description: string;
41
42
  color: string;
42
43
  }[] | undefined;
43
- explainer?: string[] | undefined;
44
44
  funding?: string | undefined;
45
45
  guide?: {
46
46
  href: string;
@@ -8,6 +8,7 @@ declare const blockRepositoryLabels: bingo_stratum.BlockWithoutAddons<{
8
8
  readme: {
9
9
  usage: string;
10
10
  additional?: string | undefined;
11
+ explainer?: string | undefined;
11
12
  };
12
13
  development?: string | undefined;
13
14
  };
@@ -38,7 +39,6 @@ declare const blockRepositoryLabels: bingo_stratum.BlockWithoutAddons<{
38
39
  description: string;
39
40
  color: string;
40
41
  }[] | undefined;
41
- explainer?: string[] | undefined;
42
42
  funding?: string | undefined;
43
43
  guide?: {
44
44
  href: string;
@@ -13,6 +13,7 @@ declare const blockRepositorySecrets: bingo_stratum.BlockWithAddons<{
13
13
  readme: {
14
14
  usage: string;
15
15
  additional?: string | undefined;
16
+ explainer?: string | undefined;
16
17
  };
17
18
  development?: string | undefined;
18
19
  };
@@ -43,7 +44,6 @@ declare const blockRepositorySecrets: bingo_stratum.BlockWithAddons<{
43
44
  description: string;
44
45
  color: string;
45
46
  }[] | undefined;
46
- explainer?: string[] | undefined;
47
47
  funding?: string | undefined;
48
48
  guide?: {
49
49
  href: string;
@@ -8,6 +8,7 @@ declare const blockRepositorySettings: bingo_stratum.BlockWithoutAddons<{
8
8
  readme: {
9
9
  usage: string;
10
10
  additional?: string | undefined;
11
+ explainer?: string | undefined;
11
12
  };
12
13
  development?: string | undefined;
13
14
  };
@@ -38,7 +39,6 @@ declare const blockRepositorySettings: bingo_stratum.BlockWithoutAddons<{
38
39
  description: string;
39
40
  color: string;
40
41
  }[] | undefined;
41
- explainer?: string[] | undefined;
42
42
  funding?: string | undefined;
43
43
  guide?: {
44
44
  href: string;
@@ -8,6 +8,7 @@ declare const blockSecurityDocs: bingo_stratum.BlockWithoutAddons<{
8
8
  readme: {
9
9
  usage: string;
10
10
  additional?: string | undefined;
11
+ explainer?: string | undefined;
11
12
  };
12
13
  development?: string | undefined;
13
14
  };
@@ -38,7 +39,6 @@ declare const blockSecurityDocs: bingo_stratum.BlockWithoutAddons<{
38
39
  description: string;
39
40
  color: string;
40
41
  }[] | undefined;
41
- explainer?: string[] | undefined;
42
42
  funding?: string | undefined;
43
43
  guide?: {
44
44
  href: string;
@@ -12,6 +12,7 @@ declare const blockTSup: bingo_stratum.BlockWithAddons<{
12
12
  readme: {
13
13
  usage: string;
14
14
  additional?: string | undefined;
15
+ explainer?: string | undefined;
15
16
  };
16
17
  development?: string | undefined;
17
18
  };
@@ -42,7 +43,6 @@ declare const blockTSup: bingo_stratum.BlockWithAddons<{
42
43
  description: string;
43
44
  color: string;
44
45
  }[] | undefined;
45
- explainer?: string[] | undefined;
46
46
  funding?: string | undefined;
47
47
  guide?: {
48
48
  href: string;
@@ -8,6 +8,7 @@ declare const blockTemplatedWith: bingo_stratum.BlockWithoutAddons<{
8
8
  readme: {
9
9
  usage: string;
10
10
  additional?: string | undefined;
11
+ explainer?: string | undefined;
11
12
  };
12
13
  development?: string | undefined;
13
14
  };
@@ -38,7 +39,6 @@ declare const blockTemplatedWith: bingo_stratum.BlockWithoutAddons<{
38
39
  description: string;
39
40
  color: string;
40
41
  }[] | undefined;
41
- explainer?: string[] | undefined;
42
42
  funding?: string | undefined;
43
43
  guide?: {
44
44
  href: string;
@@ -120,6 +120,7 @@ declare const blockTypeScript: bingo_stratum.BlockWithAddons<{
120
120
  readme: {
121
121
  usage: string;
122
122
  additional?: string | undefined;
123
+ explainer?: string | undefined;
123
124
  };
124
125
  development?: string | undefined;
125
126
  };
@@ -150,7 +151,6 @@ declare const blockTypeScript: bingo_stratum.BlockWithAddons<{
150
151
  description: string;
151
152
  color: string;
152
153
  }[] | undefined;
153
- explainer?: string[] | undefined;
154
154
  funding?: string | undefined;
155
155
  guide?: {
156
156
  href: string;
@@ -17,6 +17,7 @@ declare const blockVSCode: bingo_stratum.BlockWithAddons<{
17
17
  readme: {
18
18
  usage: string;
19
19
  additional?: string | undefined;
20
+ explainer?: string | undefined;
20
21
  };
21
22
  development?: string | undefined;
22
23
  };
@@ -47,7 +48,6 @@ declare const blockVSCode: bingo_stratum.BlockWithAddons<{
47
48
  description: string;
48
49
  color: string;
49
50
  }[] | undefined;
50
- explainer?: string[] | undefined;
51
51
  funding?: string | undefined;
52
52
  guide?: {
53
53
  href: string;
@@ -24,6 +24,7 @@ declare const blockVitest: bingo_stratum.BlockWithAddons<{
24
24
  readme: {
25
25
  usage: string;
26
26
  additional?: string | undefined;
27
+ explainer?: string | undefined;
27
28
  };
28
29
  development?: string | undefined;
29
30
  };
@@ -54,7 +55,6 @@ declare const blockVitest: bingo_stratum.BlockWithAddons<{
54
55
  description: string;
55
56
  color: string;
56
57
  }[] | undefined;
57
- explainer?: string[] | undefined;
58
58
  funding?: string | undefined;
59
59
  guide?: {
60
60
  href: string;