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.
Files changed (79) hide show
  1. package/lib/base.d.ts +11 -11
  2. package/lib/base.js +1 -1
  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/blockESLintPlugin.d.ts +1 -1
  21. package/lib/blocks/blockESLintPlugin.js +46 -5
  22. package/lib/blocks/blockESLintRegexp.d.ts +1 -1
  23. package/lib/blocks/blockESLintYML.d.ts +1 -1
  24. package/lib/blocks/blockExampleFiles.d.ts +2 -1
  25. package/lib/blocks/blockExampleFiles.js +9 -1
  26. package/lib/blocks/blockFunding.d.ts +1 -1
  27. package/lib/blocks/blockGitHubActionsCI.d.ts +1 -1
  28. package/lib/blocks/blockGitHubApps.d.ts +1 -1
  29. package/lib/blocks/blockGitHubIssueTemplates.d.ts +1 -1
  30. package/lib/blocks/blockGitHubPRTemplate.d.ts +1 -1
  31. package/lib/blocks/blockGitignore.d.ts +1 -1
  32. package/lib/blocks/blockKnip.d.ts +1 -1
  33. package/lib/blocks/blockMITLicense.d.ts +1 -1
  34. package/lib/blocks/blockMain.d.ts +1 -1
  35. package/lib/blocks/blockMarkdownlint.d.ts +1 -1
  36. package/lib/blocks/blockNcc.d.ts +1 -1
  37. package/lib/blocks/blockNvmrc.d.ts +1 -1
  38. package/lib/blocks/blockPRCompliance.d.ts +1 -1
  39. package/lib/blocks/blockPackageJson.d.ts +1 -1
  40. package/lib/blocks/blockPnpmDedupe.d.ts +1 -1
  41. package/lib/blocks/blockPrettier.d.ts +1 -1
  42. package/lib/blocks/blockPrettierPluginCurly.d.ts +1 -1
  43. package/lib/blocks/blockPrettierPluginPackageJson.d.ts +1 -1
  44. package/lib/blocks/blockPrettierPluginSh.d.ts +1 -1
  45. package/lib/blocks/blockREADME.d.ts +2 -1
  46. package/lib/blocks/blockREADME.js +3 -2
  47. package/lib/blocks/blockReleaseIt.d.ts +1 -1
  48. package/lib/blocks/blockRemoveDependencies.d.ts +1 -1
  49. package/lib/blocks/blockRemoveFiles.d.ts +1 -1
  50. package/lib/blocks/blockRemoveWorkflows.d.ts +1 -1
  51. package/lib/blocks/blockRenovate.d.ts +1 -1
  52. package/lib/blocks/blockRepositoryBranchRuleset.d.ts +1 -1
  53. package/lib/blocks/blockRepositoryLabels.d.ts +1 -1
  54. package/lib/blocks/blockRepositorySecrets.d.ts +1 -1
  55. package/lib/blocks/blockRepositorySettings.d.ts +1 -1
  56. package/lib/blocks/blockSecurityDocs.d.ts +1 -1
  57. package/lib/blocks/blockTSup.d.ts +1 -1
  58. package/lib/blocks/blockTemplatedWith.d.ts +1 -1
  59. package/lib/blocks/blockTypeScript.d.ts +1 -1
  60. package/lib/blocks/blockTypeScript.js +11 -1
  61. package/lib/blocks/blockVSCode.d.ts +1 -1
  62. package/lib/blocks/blockVitest.d.ts +1 -1
  63. package/lib/blocks/blockWebExt.d.ts +1 -1
  64. package/lib/blocks/index.d.ts +48 -47
  65. package/lib/data/packageData.d.ts +1 -1
  66. package/lib/index.d.ts +6 -6
  67. package/lib/options/readDocumentation.d.ts +1 -1
  68. package/lib/options/readReadmeUsage.d.ts +1 -1
  69. package/lib/options/readReadmeUsage.js +14 -10
  70. package/lib/presets/common.d.ts +5 -5
  71. package/lib/presets/everything.d.ts +5 -5
  72. package/lib/presets/index.d.ts +15 -15
  73. package/lib/presets/minimal.d.ts +5 -5
  74. package/lib/schemas.d.ts +10 -10
  75. package/lib/schemas.js +1 -1
  76. package/lib/template.d.ts +5 -5
  77. package/package.json +1 -1
  78. package/lib/options/readUsageFromReadme.d.ts +0 -3
  79. package/lib/options/readUsageFromReadme.js +0 -17
package/lib/blocks/blockNvmrc.d.ts CHANGED
@@ -6,10 +6,10 @@ declare const blockNvmrc: bingo_stratum.BlockWithoutAddons<{
6
6
  directory: string;
7
7
  documentation: {
8
8
  readme: {
9
- usage: string;
10
9
  additional?: string | undefined;
11
10
  explainer?: string | undefined;
12
11
  footnotes?: string | undefined;
12
+ usage?: string | undefined;
13
13
  };
14
14
  development?: string | undefined;
15
15
  };
package/lib/blocks/blockPRCompliance.d.ts CHANGED
@@ -6,10 +6,10 @@ declare const blockPRCompliance: bingo_stratum.BlockWithoutAddons<{
6
6
  directory: string;
7
7
  documentation: {
8
8
  readme: {
9
- usage: string;
10
9
  additional?: string | undefined;
11
10
  explainer?: string | undefined;
12
11
  footnotes?: string | undefined;
12
+ usage?: string | undefined;
13
13
  };
14
14
  development?: string | undefined;
15
15
  };
package/lib/blocks/blockPackageJson.d.ts CHANGED
@@ -83,10 +83,10 @@ declare const blockPackageJson: bingo_stratum.BlockWithAddons<{
83
83
  directory: string;
84
84
  documentation: {
85
85
  readme: {
86
- usage: string;
87
86
  additional?: string | undefined;
88
87
  explainer?: string | undefined;
89
88
  footnotes?: string | undefined;
89
+ usage?: string | undefined;
90
90
  };
91
91
  development?: string | undefined;
92
92
  };
package/lib/blocks/blockPnpmDedupe.d.ts CHANGED
@@ -6,10 +6,10 @@ declare const blockPnpmDedupe: bingo_stratum.BlockWithoutAddons<{
6
6
  directory: string;
7
7
  documentation: {
8
8
  readme: {
9
- usage: string;
10
9
  additional?: string | undefined;
11
10
  explainer?: string | undefined;
12
11
  footnotes?: string | undefined;
12
+ usage?: string | undefined;
13
13
  };
14
14
  development?: string | undefined;
15
15
  };
package/lib/blocks/blockPrettier.d.ts CHANGED
@@ -16,10 +16,10 @@ declare const blockPrettier: bingo_stratum.BlockWithAddons<{
16
16
  directory: string;
17
17
  documentation: {
18
18
  readme: {
19
- usage: string;
20
19
  additional?: string | undefined;
21
20
  explainer?: string | undefined;
22
21
  footnotes?: string | undefined;
22
+ usage?: string | undefined;
23
23
  };
24
24
  development?: string | undefined;
25
25
  };
package/lib/blocks/blockPrettierPluginCurly.d.ts CHANGED
@@ -6,10 +6,10 @@ declare const blockPrettierPluginCurly: bingo_stratum.BlockWithoutAddons<{
6
6
  directory: string;
7
7
  documentation: {
8
8
  readme: {
9
- usage: string;
10
9
  additional?: string | undefined;
11
10
  explainer?: string | undefined;
12
11
  footnotes?: string | undefined;
12
+ usage?: string | undefined;
13
13
  };
14
14
  development?: string | undefined;
15
15
  };
package/lib/blocks/blockPrettierPluginPackageJson.d.ts CHANGED
@@ -6,10 +6,10 @@ declare const blockPrettierPluginPackageJson: bingo_stratum.BlockWithoutAddons<{
6
6
  directory: string;
7
7
  documentation: {
8
8
  readme: {
9
- usage: string;
10
9
  additional?: string | undefined;
11
10
  explainer?: string | undefined;
12
11
  footnotes?: string | undefined;
12
+ usage?: string | undefined;
13
13
  };
14
14
  development?: string | undefined;
15
15
  };
package/lib/blocks/blockPrettierPluginSh.d.ts CHANGED
@@ -6,10 +6,10 @@ declare const blockPrettierPluginSh: bingo_stratum.BlockWithoutAddons<{
6
6
  directory: string;
7
7
  documentation: {
8
8
  readme: {
9
- usage: string;
10
9
  additional?: string | undefined;
11
10
  explainer?: string | undefined;
12
11
  footnotes?: string | undefined;
12
+ usage?: string | undefined;
13
13
  };
14
14
  development?: string | undefined;
15
15
  };
package/lib/blocks/blockREADME.d.ts CHANGED
@@ -11,6 +11,7 @@ declare const blockREADME: bingo_stratum.BlockWithAddons<{
11
11
  after: string;
12
12
  } | undefined;
13
13
  }[];
14
+ defaultUsage: string[];
14
15
  notices: string[];
15
16
  }, {
16
17
  access: "public" | "restricted";
@@ -18,10 +19,10 @@ declare const blockREADME: bingo_stratum.BlockWithAddons<{
18
19
  directory: string;
19
20
  documentation: {
20
21
  readme: {
21
- usage: string;
22
22
  additional?: string | undefined;
23
23
  explainer?: string | undefined;
24
24
  footnotes?: string | undefined;
25
+ usage?: string | undefined;
25
26
  };
26
27
  development?: string | undefined;
27
28
  };
package/lib/blocks/blockREADME.js CHANGED
@@ -18,11 +18,12 @@ const blockREADME = base.createBlock({
18
18
  },
19
19
  addons: {
20
20
  badges: z.array(zBadge).default([]),
21
+ defaultUsage: z.array(z.string()).default([]),
21
22
  notices: z.array(z.string()).default([]),
22
23
  sections: z.array(z.string()).default([])
23
24
  },
24
25
  produce({ addons, options }) {
25
- const { badges, notices, sections } = addons;
26
+ const { badges, defaultUsage, notices, sections } = addons;
26
27
  const explainer = options.documentation.readme.explainer && `
27
28
  ${options.documentation.readme.explainer}
28
29
  `;
@@ -45,7 +46,7 @@ ${formatBadges(badges)}
45
46
  ${[logo, explainer].filter(Boolean).join("")}
46
47
  ## Usage
47
48
 
48
- ${options.documentation.readme.usage}
49
+ ${options.documentation.readme.usage ?? defaultUsage.join("\n\n")}
49
50
 
50
51
  ## Development
51
52
 
package/lib/blocks/blockReleaseIt.d.ts CHANGED
@@ -11,10 +11,10 @@ declare const blockReleaseIt: bingo_stratum.BlockWithAddons<{
11
11
  directory: string;
12
12
  documentation: {
13
13
  readme: {
14
- usage: string;
15
14
  additional?: string | undefined;
16
15
  explainer?: string | undefined;
17
16
  footnotes?: string | undefined;
17
+ usage?: string | undefined;
18
18
  };
19
19
  development?: string | undefined;
20
20
  };
package/lib/blocks/blockRemoveDependencies.d.ts CHANGED
@@ -8,10 +8,10 @@ declare const blockRemoveDependencies: bingo_stratum.BlockWithAddons<{
8
8
  directory: string;
9
9
  documentation: {
10
10
  readme: {
11
- usage: string;
12
11
  additional?: string | undefined;
13
12
  explainer?: string | undefined;
14
13
  footnotes?: string | undefined;
14
+ usage?: string | undefined;
15
15
  };
16
16
  development?: string | undefined;
17
17
  };
package/lib/blocks/blockRemoveFiles.d.ts CHANGED
@@ -8,10 +8,10 @@ declare const blockRemoveFiles: bingo_stratum.BlockWithAddons<{
8
8
  directory: string;
9
9
  documentation: {
10
10
  readme: {
11
- usage: string;
12
11
  additional?: string | undefined;
13
12
  explainer?: string | undefined;
14
13
  footnotes?: string | undefined;
14
+ usage?: string | undefined;
15
15
  };
16
16
  development?: string | undefined;
17
17
  };
package/lib/blocks/blockRemoveWorkflows.d.ts CHANGED
@@ -8,10 +8,10 @@ declare const blockRemoveWorkflows: bingo_stratum.BlockWithAddons<{
8
8
  directory: string;
9
9
  documentation: {
10
10
  readme: {
11
- usage: string;
12
11
  additional?: string | undefined;
13
12
  explainer?: string | undefined;
14
13
  footnotes?: string | undefined;
14
+ usage?: string | undefined;
15
15
  };
16
16
  development?: string | undefined;
17
17
  };
package/lib/blocks/blockRenovate.d.ts CHANGED
@@ -8,10 +8,10 @@ declare const blockRenovate: bingo_stratum.BlockWithAddons<{
8
8
  directory: string;
9
9
  documentation: {
10
10
  readme: {
11
- usage: string;
12
11
  additional?: string | undefined;
13
12
  explainer?: string | undefined;
14
13
  footnotes?: string | undefined;
14
+ usage?: string | undefined;
15
15
  };
16
16
  development?: string | undefined;
17
17
  };
package/lib/blocks/blockRepositoryBranchRuleset.d.ts CHANGED
@@ -8,10 +8,10 @@ declare const blockRepositoryBranchRuleset: bingo_stratum.BlockWithAddons<{
8
8
  directory: string;
9
9
  documentation: {
10
10
  readme: {
11
- usage: string;
12
11
  additional?: string | undefined;
13
12
  explainer?: string | undefined;
14
13
  footnotes?: string | undefined;
14
+ usage?: string | undefined;
15
15
  };
16
16
  development?: string | undefined;
17
17
  };
package/lib/blocks/blockRepositoryLabels.d.ts CHANGED
@@ -6,10 +6,10 @@ declare const blockRepositoryLabels: bingo_stratum.BlockWithoutAddons<{
6
6
  directory: string;
7
7
  documentation: {
8
8
  readme: {
9
- usage: string;
10
9
  additional?: string | undefined;
11
10
  explainer?: string | undefined;
12
11
  footnotes?: string | undefined;
12
+ usage?: string | undefined;
13
13
  };
14
14
  development?: string | undefined;
15
15
  };
package/lib/blocks/blockRepositorySecrets.d.ts CHANGED
@@ -11,10 +11,10 @@ declare const blockRepositorySecrets: bingo_stratum.BlockWithAddons<{
11
11
  directory: string;
12
12
  documentation: {
13
13
  readme: {
14
- usage: string;
15
14
  additional?: string | undefined;
16
15
  explainer?: string | undefined;
17
16
  footnotes?: string | undefined;
17
+ usage?: string | undefined;
18
18
  };
19
19
  development?: string | undefined;
20
20
  };
package/lib/blocks/blockRepositorySettings.d.ts CHANGED
@@ -6,10 +6,10 @@ declare const blockRepositorySettings: bingo_stratum.BlockWithoutAddons<{
6
6
  directory: string;
7
7
  documentation: {
8
8
  readme: {
9
- usage: string;
10
9
  additional?: string | undefined;
11
10
  explainer?: string | undefined;
12
11
  footnotes?: string | undefined;
12
+ usage?: string | undefined;
13
13
  };
14
14
  development?: string | undefined;
15
15
  };
package/lib/blocks/blockSecurityDocs.d.ts CHANGED
@@ -6,10 +6,10 @@ declare const blockSecurityDocs: bingo_stratum.BlockWithoutAddons<{
6
6
  directory: string;
7
7
  documentation: {
8
8
  readme: {
9
- usage: string;
10
9
  additional?: string | undefined;
11
10
  explainer?: string | undefined;
12
11
  footnotes?: string | undefined;
12
+ usage?: string | undefined;
13
13
  };
14
14
  development?: string | undefined;
15
15
  };
package/lib/blocks/blockTSup.d.ts CHANGED
@@ -10,10 +10,10 @@ declare const blockTSup: bingo_stratum.BlockWithAddons<{
10
10
  directory: string;
11
11
  documentation: {
12
12
  readme: {
13
- usage: string;
14
13
  additional?: string | undefined;
15
14
  explainer?: string | undefined;
16
15
  footnotes?: string | undefined;
16
+ usage?: string | undefined;
17
17
  };
18
18
  development?: string | undefined;
19
19
  };
package/lib/blocks/blockTemplatedWith.d.ts CHANGED
@@ -6,10 +6,10 @@ declare const blockTemplatedWith: bingo_stratum.BlockWithoutAddons<{
6
6
  directory: string;
7
7
  documentation: {
8
8
  readme: {
9
- usage: string;
10
9
  additional?: string | undefined;
11
10
  explainer?: string | undefined;
12
11
  footnotes?: string | undefined;
12
+ usage?: string | undefined;
13
13
  };
14
14
  development?: string | undefined;
15
15
  };
package/lib/blocks/blockTypeScript.d.ts CHANGED
@@ -118,10 +118,10 @@ declare const blockTypeScript: bingo_stratum.BlockWithAddons<{
118
118
  directory: string;
119
119
  documentation: {
120
120
  readme: {
121
- usage: string;
122
121
  additional?: string | undefined;
123
122
  explainer?: string | undefined;
124
123
  footnotes?: string | undefined;
124
+ usage?: string | undefined;
125
125
  };
126
126
  development?: string | undefined;
127
127
  };
package/lib/blocks/blockTypeScript.js CHANGED
@@ -82,7 +82,17 @@ export * from "./types.js";
82
82
  times?: number;
83
83
  }
84
84
  `
85
- }
85
+ },
86
+ usage: [
87
+ `\`\`\`shell
88
+ npm i ${options.repository}
89
+ \`\`\`
90
+ \`\`\`ts
91
+ import { greet } from "${options.repository}";
92
+
93
+ greet("Hello, world! ${options.emoji}");
94
+ \`\`\``
95
+ ]
86
96
  }),
87
97
  blockGitignore({
88
98
  ignores: ["/lib"]
package/lib/blocks/blockVSCode.d.ts CHANGED
@@ -15,10 +15,10 @@ declare const blockVSCode: bingo_stratum.BlockWithAddons<{
15
15
  directory: string;
16
16
  documentation: {
17
17
  readme: {
18
- usage: string;
19
18
  additional?: string | undefined;
20
19
  explainer?: string | undefined;
21
20
  footnotes?: string | undefined;
21
+ usage?: string | undefined;
22
22
  };
23
23
  development?: string | undefined;
24
24
  };
package/lib/blocks/blockVitest.d.ts CHANGED
@@ -23,10 +23,10 @@ declare const blockVitest: bingo_stratum.BlockWithAddons<{
23
23
  directory: string;
24
24
  documentation: {
25
25
  readme: {
26
- usage: string;
27
26
  additional?: string | undefined;
28
27
  explainer?: string | undefined;
29
28
  footnotes?: string | undefined;
29
+ usage?: string | undefined;
30
30
  };
31
31
  development?: string | undefined;
32
32
  };
package/lib/blocks/blockWebExt.d.ts CHANGED
@@ -6,10 +6,10 @@ declare const blockWebExt: bingo_stratum.BlockWithoutAddons<{
6
6
  directory: string;
7
7
  documentation: {
8
8
  readme: {
9
- usage: string;
10
9
  additional?: string | undefined;
11
10
  explainer?: string | undefined;
12
11
  footnotes?: string | undefined;
12
+ usage?: string | undefined;
13
13
  };
14
14
  development?: string | undefined;
15
15
  };