create-typescript-app 2.63.2 → 2.65.0

package/dist/blocks/blockFunding.d.mts

@@ -0,0 +1,73 @@
+//#region src/blocks/blockFunding.d.ts
+declare const blockFunding: import("bingo-stratum").BlockWithoutAddons<{
+  access: "public" | "restricted";
+  description: string;
+  directory: string;
+  documentation: {
+    readme: {
+      additional?: string | undefined;
+      explainer?: string | undefined;
+      footnotes?: string | undefined;
+      usage?: string | undefined;
+    };
+    development?: string | undefined;
+  };
+  email: string | {
+    github: string;
+    npm: string;
+  };
+  title: string;
+  node: {
+    minimum: string;
+    pinned?: string | undefined;
+  };
+  owner: string;
+  repository: string;
+  type?: "commonjs" | "module" | undefined;
+  author?: string | undefined;
+  bin?: string | Record<string, string> | undefined;
+  bundle?: boolean | undefined;
+  codecovToken?: boolean | undefined;
+  contributors?: {
+    avatar_url: string;
+    contributions: string[];
+    login: string;
+    name: string;
+    profile: string;
+  }[] | undefined;
+  emoji?: string | undefined;
+  existingLabels?: {
+    name: string;
+    description: string;
+    color: string;
+  }[] | undefined;
+  funding?: string | undefined;
+  guide?: {
+    href: string;
+    title: string;
+  } | undefined;
+  keywords?: string[] | undefined;
+  logo?: {
+    alt: string;
+    src: string;
+    height?: number | undefined;
+    width?: number | undefined;
+  } | undefined;
+  packageData?: {
+    dependencies?: Record<string, string> | undefined;
+    devDependencies?: Record<string, string> | undefined;
+    peerDependencies?: Record<string, string> | undefined;
+    peerDependenciesMeta?: Record<string, unknown> | undefined;
+    scripts?: Record<string, string | undefined> | undefined;
+  } | undefined;
+  pnpm?: string | undefined;
+  rulesetId?: string | undefined;
+  version?: string | undefined;
+  words?: string[] | undefined;
+  workflowsVersions?: Record<string, Record<string, {
+    pinned?: boolean | undefined;
+    hash?: string | undefined;
+  }>> | undefined;
+}>;
+//#endregion
+export { blockFunding };

package/dist/blocks/blockFunding.mjs

@@ -0,0 +1,15 @@
+import { base } from "../base.mjs";
+import { blockRemoveFiles } from "./blockRemoveFiles.mjs";
+import { formatYaml } from "./files/formatYaml.mjs";
+//#region src/blocks/blockFunding.ts
+const blockFunding = base.createBlock({
+	about: { name: "Funding" },
+	produce({ options }) {
+		return { files: { ".github": { "FUNDING.yaml": options.funding && formatYaml({ github: options.funding }) } } };
+	},
+	transition() {
+		return { addons: [blockRemoveFiles({ files: [".github/FUNDING.yml"] })] };
+	}
+});
+//#endregion
+export { blockFunding };

package/dist/blocks/blockGitHubActionsCI.d.mts

@@ -0,0 +1,88 @@
+//#region src/blocks/blockGitHubActionsCI.d.ts
+declare const blockGitHubActionsCI: import("bingo-stratum").BlockWithAddons<{
+  jobs?: {
+    name: string;
+    steps: ({
+      with?: Record<string, string> | undefined;
+      env?: Record<string, string> | undefined;
+      if?: string | undefined;
+    } & ({
+      run: string;
+    } | {
+      uses: string;
+    }))[];
+    checkoutWith?: Record<string, string> | undefined;
+    if?: string | undefined;
+  }[] | undefined;
+}, {
+  access: "public" | "restricted";
+  description: string;
+  directory: string;
+  documentation: {
+    readme: {
+      additional?: string | undefined;
+      explainer?: string | undefined;
+      footnotes?: string | undefined;
+      usage?: string | undefined;
+    };
+    development?: string | undefined;
+  };
+  email: string | {
+    github: string;
+    npm: string;
+  };
+  title: string;
+  node: {
+    minimum: string;
+    pinned?: string | undefined;
+  };
+  owner: string;
+  repository: string;
+  type?: "commonjs" | "module" | undefined;
+  author?: string | undefined;
+  bin?: string | Record<string, string> | undefined;
+  bundle?: boolean | undefined;
+  codecovToken?: boolean | undefined;
+  contributors?: {
+    avatar_url: string;
+    contributions: string[];
+    login: string;
+    name: string;
+    profile: string;
+  }[] | undefined;
+  emoji?: string | undefined;
+  existingLabels?: {
+    name: string;
+    description: string;
+    color: string;
+  }[] | undefined;
+  funding?: string | undefined;
+  guide?: {
+    href: string;
+    title: string;
+  } | undefined;
+  keywords?: string[] | undefined;
+  logo?: {
+    alt: string;
+    src: string;
+    height?: number | undefined;
+    width?: number | undefined;
+  } | undefined;
+  packageData?: {
+    dependencies?: Record<string, string> | undefined;
+    devDependencies?: Record<string, string> | undefined;
+    peerDependencies?: Record<string, string> | undefined;
+    peerDependenciesMeta?: Record<string, unknown> | undefined;
+    scripts?: Record<string, string | undefined> | undefined;
+  } | undefined;
+  pnpm?: string | undefined;
+  rulesetId?: string | undefined;
+  version?: string | undefined;
+  words?: string[] | undefined;
+  workflowsVersions?: Record<string, Record<string, {
+    pinned?: boolean | undefined;
+    hash?: string | undefined;
+  }>> | undefined;
+}>;
+//#endregion
+export { blockGitHubActionsCI };

package/dist/blocks/blockGitHubActionsCI.mjs

@@ -0,0 +1,89 @@
+import { zActionStep } from "./actions/steps.mjs";
+import { base } from "../base.mjs";
+import { resolveUses } from "./actions/resolveUses.mjs";
+import { blockRemoveFiles } from "./blockRemoveFiles.mjs";
+import { blockRepositoryBranchRuleset } from "./blockRepositoryBranchRuleset.mjs";
+import { formatYaml } from "./files/formatYaml.mjs";
+import { createMultiWorkflowFile } from "./files/createMultiWorkflowFile.mjs";
+import { createSoloWorkflowFile } from "./files/createSoloWorkflowFile.mjs";
+import { z } from "zod";
+//#region src/blocks/blockGitHubActionsCI.ts
+const blockGitHubActionsCI = base.createBlock({
+	about: { name: "GitHub Actions CI" },
+	addons: { jobs: z.array(z.object({
+		checkoutWith: z.record(z.string(), z.string()).optional(),
+		if: z.string().optional(),
+		name: z.string(),
+		steps: z.array(zActionStep)
+	})).optional() },
+	produce({ addons, options }) {
+		const { jobs } = addons;
+		const minimumNodeVersion = options.node.minimum.replace(/^\D*/u, "").split(/[^\d.]/u)[0];
+		const jobsWithEnginesCheck = jobs && [...jobs, {
+			name: "Engines Check",
+			steps: [{
+				uses: resolveUses("actions/setup-node", "v4", options.workflowsVersions),
+				with: {
+					cache: "pnpm",
+					"node-version": minimumNodeVersion
+				}
+			}, { run: "pnpm install --prod --engine-strict --ignore-scripts" }]
+		}].toSorted((a, b) => a.name.localeCompare(b.name));
+		return {
+			addons: [blockRepositoryBranchRuleset({ requiredStatusChecks: jobsWithEnginesCheck?.map((job) => job.name) })],
+			files: { ".github": {
+				actions: { prepare: { "action.yaml": formatYaml({
+					description: "Prepares the repo for a typical CI job",
+					name: "Setup",
+					runs: {
+						steps: [
+							{ uses: resolveUses("pnpm/action-setup", "v4", options.workflowsVersions) },
+							{
+								uses: resolveUses("actions/setup-node", "v4", options.workflowsVersions),
+								with: {
+									cache: "pnpm",
+									"node-version": "lts/*"
+								}
+							},
+							{
+								run: "pnpm install --frozen-lockfile",
+								shell: "bash"
+							}
+						],
+						using: "composite"
+					}
+				}) } },
+				workflows: {
+					"ci.yaml": jobsWithEnginesCheck && createMultiWorkflowFile({
+						jobs: jobsWithEnginesCheck,
+						name: "CI",
+						workflowsVersions: options.workflowsVersions
+					}),
+					"pr-review-requested.yaml": createSoloWorkflowFile({
+						name: "PR Review Requested",
+						on: { pull_request_target: { types: ["review_requested"] } },
+						permissions: { "pull-requests": "write" },
+						steps: [{
+							uses: resolveUses("actions-ecosystem/action-remove-labels", "v1", options.workflowsVersions),
+							with: { labels: "status: waiting for author" }
+						}, {
+							if: "failure()",
+							run: "echo \"Don't worry if the previous step failed.\"\necho \"See https://github.com/actions-ecosystem/action-remove-labels/issues/221.\"\n"
+						}]
+					})
+				}
+			} }
+		};
+	},
+	transition() {
+		return { addons: [blockRemoveFiles({ files: [
+			".circleci",
+			".github/actions/prepare/action.yml",
+			".github/workflows/ci.yml",
+			".github/workflows/pr-review-requested.yml",
+			"travis.{yaml,yml}"
+		] })] };
+	}
+});
+//#endregion
+export { blockGitHubActionsCI };

package/dist/blocks/blockGitHubApps.d.mts

@@ -0,0 +1,78 @@
+//#region src/blocks/blockGitHubApps.d.ts
+declare const blockGitHubApps: import("bingo-stratum").BlockWithAddons<{
+  apps: {
+    name: string;
+    url: string;
+  }[];
+}, {
+  access: "public" | "restricted";
+  description: string;
+  directory: string;
+  documentation: {
+    readme: {
+      additional?: string | undefined;
+      explainer?: string | undefined;
+      footnotes?: string | undefined;
+      usage?: string | undefined;
+    };
+    development?: string | undefined;
+  };
+  email: string | {
+    github: string;
+    npm: string;
+  };
+  title: string;
+  node: {
+    minimum: string;
+    pinned?: string | undefined;
+  };
+  owner: string;
+  repository: string;
+  type?: "commonjs" | "module" | undefined;
+  author?: string | undefined;
+  bin?: string | Record<string, string> | undefined;
+  bundle?: boolean | undefined;
+  codecovToken?: boolean | undefined;
+  contributors?: {
+    avatar_url: string;
+    contributions: string[];
+    login: string;
+    name: string;
+    profile: string;
+  }[] | undefined;
+  emoji?: string | undefined;
+  existingLabels?: {
+    name: string;
+    description: string;
+    color: string;
+  }[] | undefined;
+  funding?: string | undefined;
+  guide?: {
+    href: string;
+    title: string;
+  } | undefined;
+  keywords?: string[] | undefined;
+  logo?: {
+    alt: string;
+    src: string;
+    height?: number | undefined;
+    width?: number | undefined;
+  } | undefined;
+  packageData?: {
+    dependencies?: Record<string, string> | undefined;
+    devDependencies?: Record<string, string> | undefined;
+    peerDependencies?: Record<string, string> | undefined;
+    peerDependenciesMeta?: Record<string, unknown> | undefined;
+    scripts?: Record<string, string | undefined> | undefined;
+  } | undefined;
+  pnpm?: string | undefined;
+  rulesetId?: string | undefined;
+  version?: string | undefined;
+  words?: string[] | undefined;
+  workflowsVersions?: Record<string, Record<string, {
+    pinned?: boolean | undefined;
+    hash?: string | undefined;
+  }>> | undefined;
+}>;
+//#endregion
+export { blockGitHubApps };

package/dist/blocks/blockGitHubApps.mjs

@@ -0,0 +1,16 @@
+import { base } from "../base.mjs";
+import { getInstallationSuggestions } from "./getInstallationSuggestions.mjs";
+import { z } from "zod";
+//#region src/blocks/blockGitHubApps.ts
+const blockGitHubApps = base.createBlock({
+	about: { name: "GitHub Apps" },
+	addons: { apps: z.array(z.object({
+		name: z.string(),
+		url: z.string()
+	})).default([]) },
+	produce({ addons, options }) {
+		return { suggestions: getInstallationSuggestions("enable the GitHub app", addons.apps.map((app) => `${app.name} (${app.url})`), `https://github.com/${options.owner}/${options.repository}/settings/installations`) };
+	}
+});
+//#endregion
+export { blockGitHubApps };

package/dist/blocks/blockGitHubIssueTemplates.d.mts

@@ -0,0 +1,73 @@
+//#region src/blocks/blockGitHubIssueTemplates.d.ts
+declare const blockGitHubIssueTemplates: import("bingo-stratum").BlockWithoutAddons<{
+  access: "public" | "restricted";
+  description: string;
+  directory: string;
+  documentation: {
+    readme: {
+      additional?: string | undefined;
+      explainer?: string | undefined;
+      footnotes?: string | undefined;
+      usage?: string | undefined;
+    };
+    development?: string | undefined;
+  };
+  email: string | {
+    github: string;
+    npm: string;
+  };
+  title: string;
+  node: {
+    minimum: string;
+    pinned?: string | undefined;
+  };
+  owner: string;
+  repository: string;
+  type?: "commonjs" | "module" | undefined;
+  author?: string | undefined;
+  bin?: string | Record<string, string> | undefined;
+  bundle?: boolean | undefined;
+  codecovToken?: boolean | undefined;
+  contributors?: {
+    avatar_url: string;
+    contributions: string[];
+    login: string;
+    name: string;
+    profile: string;
+  }[] | undefined;
+  emoji?: string | undefined;
+  existingLabels?: {
+    name: string;
+    description: string;
+    color: string;
+  }[] | undefined;
+  funding?: string | undefined;
+  guide?: {
+    href: string;
+    title: string;
+  } | undefined;
+  keywords?: string[] | undefined;
+  logo?: {
+    alt: string;
+    src: string;
+    height?: number | undefined;
+    width?: number | undefined;
+  } | undefined;
+  packageData?: {
+    dependencies?: Record<string, string> | undefined;
+    devDependencies?: Record<string, string> | undefined;
+    peerDependencies?: Record<string, string> | undefined;
+    peerDependenciesMeta?: Record<string, unknown> | undefined;
+    scripts?: Record<string, string | undefined> | undefined;
+  } | undefined;
+  pnpm?: string | undefined;
+  rulesetId?: string | undefined;
+  version?: string | undefined;
+  words?: string[] | undefined;
+  workflowsVersions?: Record<string, Record<string, {
+    pinned?: boolean | undefined;
+    hash?: string | undefined;
+  }>> | undefined;
+}>;
+//#endregion
+export { blockGitHubIssueTemplates };

package/dist/blocks/blockGitHubIssueTemplates.mjs

@@ -0,0 +1,203 @@
+import { base } from "../base.mjs";
+import { blockRemoveFiles } from "./blockRemoveFiles.mjs";
+import { formatYaml } from "./files/formatYaml.mjs";
+//#region src/blocks/blockGitHubIssueTemplates.ts
+const blockGitHubIssueTemplates = base.createBlock({
+	about: { name: "GitHub Issue Templates" },
+	produce({ options }) {
+		return { files: { ".github": {
+			ISSUE_TEMPLATE: {
+				"01-bug.yaml": formatYaml({
+					body: [
+						{
+							attributes: {
+								description: "If any of these required steps are not taken, we may not be able to review your issue. Help us to help you!",
+								label: "Bug Report Checklist",
+								options: [
+									{
+										label: "I have tried restarting my IDE and the issue persists.",
+										required: true
+									},
+									{
+										label: "I have pulled in the newest version of the project.",
+										required: true
+									},
+									{
+										label: `I have [searched for related issues](https://github.com/${options.owner}/${options.repository}/issues?q=is%3Aissue) and found none that matched my issue.`,
+										required: true
+									}
+								]
+							},
+							type: "checkboxes"
+						},
+						{
+							attributes: {
+								description: "What did you expect to happen?",
+								label: "Expected"
+							},
+							type: "textarea",
+							validations: { required: true }
+						},
+						{
+							attributes: {
+								description: "What happened instead?",
+								label: "Actual"
+							},
+							type: "textarea",
+							validations: { required: true }
+						},
+						{
+							attributes: {
+								description: "Any additional info you'd like to provide.",
+								label: "Additional Info"
+							},
+							type: "textarea"
+						}
+					],
+					description: "Report a bug trying to run the code",
+					labels: ["type: bug"],
+					name: "🐛 Bug",
+					title: "🐛 Bug: <short description of the bug>"
+				}),
+				"02-documentation.yaml": formatYaml({
+					body: [
+						{
+							attributes: {
+								description: "If any of these required steps are not taken, we may not be able to review your issue. Help us to help you!",
+								label: "Documentation Report Checklist",
+								options: [{
+									label: "I have looked at the latest `main` branch of the repository.",
+									required: true
+								}, {
+									label: `I have [searched for related issues](https://github.com/${options.owner}/${options.repository}/issues?q=is%3Aissue) and found none that matched my issue.`,
+									required: true
+								}]
+							},
+							type: "checkboxes"
+						},
+						{
+							attributes: {
+								description: "What would you like to report?",
+								label: "Overview"
+							},
+							type: "textarea",
+							validations: { required: true }
+						},
+						{
+							attributes: {
+								description: "Any additional info you'd like to provide.",
+								label: "Additional Info"
+							},
+							type: "textarea"
+						}
+					],
+					description: "Report a typo or missing area of documentation",
+					labels: ["area: documentation"],
+					name: "📝 Documentation",
+					title: "📝 Documentation: <short description of the request>"
+				}),
+				"03-feature.yaml": formatYaml({
+					body: [
+						{
+							attributes: {
+								description: "If any of these required steps are not taken, we may not be able to review your issue. Help us to help you!",
+								label: "Feature Request Checklist",
+								options: [{
+									label: "I have looked at the latest version of the project.",
+									required: true
+								}, {
+									label: `I have [searched for related issues](https://github.com/${options.owner}/${options.repository}/issues?q=is%3Aissue) and found none that matched my issue.`,
+									required: true
+								}]
+							},
+							type: "checkboxes"
+						},
+						{
+							attributes: {
+								description: "What did you expect to be able to do?",
+								label: "Overview"
+							},
+							type: "textarea",
+							validations: { required: true }
+						},
+						{
+							attributes: {
+								description: "Any additional info you'd like to provide.",
+								label: "Additional Info"
+							},
+							type: "textarea"
+						}
+					],
+					description: "Request that a new feature be added or an existing feature improved",
+					labels: ["type: feature"],
+					name: "🚀 Feature",
+					title: "🚀 Feature: <short description of the feature>"
+				}),
+				"04-tooling.yaml": formatYaml({
+					body: [
+						{
+							attributes: {
+								description: "If any of these required steps are not taken, we may not be able to review your issue. Help us to help you!",
+								label: "Tooling Report Checklist",
+								options: [
+									{
+										label: "I have tried restarting my IDE and the issue persists.",
+										required: true
+									},
+									{
+										label: "I have pulled in the newest version of the project.",
+										required: true
+									},
+									{
+										label: `I have [searched for related issues](https://github.com/${options.owner}/${options.repository}/issues?q=is%3Aissue) and found none that matched my issue.`,
+										required: true
+									}
+								]
+							},
+							type: "checkboxes"
+						},
+						{
+							attributes: {
+								description: "What did you expect to be able to do?",
+								label: "Overview"
+							},
+							type: "textarea",
+							validations: { required: true }
+						},
+						{
+							attributes: {
+								description: "Any additional info you'd like to provide.",
+								label: "Additional Info"
+							},
+							type: "textarea"
+						}
+					],
+					description: "Report a bug or request an enhancement in repository tooling",
+					labels: ["area: tooling"],
+					name: "🛠 Tooling",
+					title: "🛠 Tooling: <short description of the change>"
+				})
+			},
+			"ISSUE_TEMPLATE.md": `<!-- Note: Please must use one of our issue templates to file an issue! 🛑 -->
+<!-- 👉 https://github.com/${options.owner}/${options.repository}/issues/new/choose 👈 -->
+<!-- **Issues that should have been filed with a template will be closed without action, and we will ask you to use a template.** -->
+
+<!-- This blank issue template is only for issues that don't fit any of the templates. -->
+
+## Overview
+
+...
+`
+		} } };
+	},
+	transition() {
+		return { addons: [blockRemoveFiles({ files: [
+			".github/ISSUE_TEMPLATE/01-bug.yml",
+			".github/ISSUE_TEMPLATE/02-documentation.yml",
+			".github/ISSUE_TEMPLATE/03-feature.yml",
+			".github/ISSUE_TEMPLATE/04-tooling.yml"
+		] })] };
+	}
+});
+//#endregion
+export { blockGitHubIssueTemplates };