create-typescript-app 2.64.0 → 2.65.0

package/dist/blocks/blockRepositoryBranchRuleset.d.mts

@@ -0,0 +1,75 @@
+//#region src/blocks/blockRepositoryBranchRuleset.d.ts
+declare const blockRepositoryBranchRuleset: import("bingo-stratum").BlockWithAddons<{
+  requiredStatusChecks?: string[] | 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 { blockRepositoryBranchRuleset };

package/dist/blocks/blockRepositoryBranchRuleset.mjs

@@ -0,0 +1,79 @@
+import { base } from "../base.mjs";
+import { z } from "zod";
+//#region src/blocks/blockRepositoryBranchRuleset.ts
+const blockRepositoryBranchRuleset = base.createBlock({
+	about: { name: "Repository Branch Ruleset" },
+	addons: { requiredStatusChecks: z.array(z.string()).optional() },
+	setup({ addons, options }) {
+		return { requests: [{
+			endpoint: "POST /repos/{owner}/{repo}/rulesets",
+			parameters: createRulesetParameters(addons.requiredStatusChecks, options),
+			type: "octokit"
+		}] };
+	},
+	transition({ addons, options }) {
+		return { requests: [{
+			endpoint: "DELETE /repos/{owner}/{repo}/branches/{branch}/protection",
+			parameters: {
+				branch: "main",
+				owner: options.owner,
+				repo: options.repository
+			},
+			silent: true,
+			type: "octokit"
+		}, options.rulesetId ? {
+			endpoint: "PUT /repos/{owner}/{repo}/rulesets/{ruleset_id}",
+			parameters: createRulesetParameters(addons.requiredStatusChecks, options, options.rulesetId),
+			type: "octokit"
+		} : {
+			endpoint: "POST /repos/{owner}/{repo}/rulesets",
+			parameters: createRulesetParameters(addons.requiredStatusChecks, options),
+			type: "octokit"
+		}] };
+	},
+	produce() {
+		return {};
+	}
+});
+function createRulesetParameters(contexts, options, rulesetId) {
+	return {
+		bypass_actors: [{
+			actor_id: 5,
+			actor_type: "RepositoryRole",
+			bypass_mode: "always"
+		}],
+		conditions: { ref_name: {
+			exclude: [],
+			include: ["refs/heads/main"]
+		} },
+		enforcement: "active",
+		name: "Branch protection for main",
+		owner: options.owner,
+		repo: options.repository,
+		rules: [
+			{ type: "deletion" },
+			{
+				parameters: {
+					allowed_merge_methods: ["squash"],
+					dismiss_stale_reviews_on_push: false,
+					require_code_owner_review: false,
+					require_last_push_approval: false,
+					required_approving_review_count: 0,
+					required_review_thread_resolution: false
+				},
+				type: "pull_request"
+			},
+			{
+				parameters: {
+					required_status_checks: contexts?.map((context) => ({ context })) ?? [],
+					strict_required_status_checks_policy: false
+				},
+				type: "required_status_checks"
+			}
+		],
+		ruleset_id: rulesetId === void 0 ? rulesetId : Number(rulesetId),
+		target: "branch"
+	};
+}
+//#endregion
+export { blockRepositoryBranchRuleset };

package/dist/blocks/blockRepositoryLabels.d.mts

@@ -0,0 +1,73 @@
+//#region src/blocks/blockRepositoryLabels.d.ts
+declare const blockRepositoryLabels: 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 { blockRepositoryLabels };

package/dist/blocks/blockRepositoryLabels.mjs

@@ -0,0 +1,52 @@
+import { base } from "../base.mjs";
+import { outcomeLabels } from "./outcomeLabels.mjs";
+import { determineLabelChanges } from "set-github-repository-labels";
+//#region src/blocks/blockRepositoryLabels.ts
+const blockRepositoryLabels = base.createBlock({
+	about: { name: "Repository Labels" },
+	produce({ options }) {
+		const changes = determineLabelChanges(options.existingLabels ?? [], outcomeLabels);
+		const requestData = {
+			owner: options.owner,
+			repo: options.repository
+		};
+		return { requests: changes.map((change) => {
+			switch (change.type) {
+				case "delete": return {
+					endpoint: "DELETE /repos/{owner}/{repo}/labels/{name}",
+					id: `delete label '${change.name}'`,
+					parameters: {
+						...requestData,
+						name: change.name
+					},
+					type: "octokit"
+				};
+				case "patch": return {
+					endpoint: "PATCH /repos/{owner}/{repo}/labels/{name}",
+					id: `patch label '${change.originalName}'`,
+					parameters: {
+						...requestData,
+						color: change.color,
+						description: change.description,
+						name: change.originalName,
+						new_name: change.newName
+					},
+					type: "octokit"
+				};
+				case "post": return {
+					endpoint: "POST /repos/{owner}/{repo}/labels",
+					id: `post label '${change.name}'`,
+					parameters: {
+						...requestData,
+						color: change.color,
+						description: change.description,
+						name: change.name
+					},
+					type: "octokit"
+				};
+			}
+		}) };
+	}
+});
+//#endregion
+export { blockRepositoryLabels };

package/dist/blocks/blockRepositorySecrets.d.mts

@@ -0,0 +1,78 @@
+//#region src/blocks/blockRepositorySecrets.d.ts
+declare const blockRepositorySecrets: import("bingo-stratum").BlockWithAddons<{
+  secrets: {
+    name: string;
+    description: 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 { blockRepositorySecrets };

package/dist/blocks/blockRepositorySecrets.mjs

@@ -0,0 +1,16 @@
+import { base } from "../base.mjs";
+import { getInstallationSuggestions } from "./getInstallationSuggestions.mjs";
+import { z } from "zod";
+//#region src/blocks/blockRepositorySecrets.ts
+const blockRepositorySecrets = base.createBlock({
+	about: { name: "Repository Secrets" },
+	addons: { secrets: z.array(z.object({
+		description: z.string(),
+		name: z.string()
+	})).default([]) },
+	produce({ addons, options }) {
+		return { suggestions: getInstallationSuggestions("populate the secret", addons.secrets.map((secret) => `${secret.name} (${secret.description})`), `https://github.com/${options.owner}/${options.repository}/settings/secrets/actions`) };
+	}
+});
+//#endregion
+export { blockRepositorySecrets };

package/dist/blocks/blockRepositorySettings.d.mts

@@ -0,0 +1,73 @@
+//#region src/blocks/blockRepositorySettings.d.ts
+declare const blockRepositorySettings: 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 { blockRepositorySettings };

package/dist/blocks/blockRepositorySettings.mjs

@@ -0,0 +1,32 @@
+import { htmlToTextSafe } from "../utils/htmlToTextSafe.mjs";
+import { base } from "../base.mjs";
+//#region src/blocks/blockRepositorySettings.ts
+const blockRepositorySettings = base.createBlock({
+	about: { name: "Repository Settings" },
+	produce({ options }) {
+		return { requests: [{
+			endpoint: "PATCH /repos/{owner}/{repo}",
+			parameters: {
+				allow_auto_merge: true,
+				allow_merge_commit: false,
+				allow_rebase_merge: false,
+				allow_squash_merge: true,
+				delete_branch_on_merge: true,
+				description: htmlToTextSafe(options.description),
+				has_projects: false,
+				has_wiki: false,
+				owner: options.owner,
+				repo: options.repository,
+				security_and_analysis: {
+					secret_scanning: { status: "enabled" },
+					secret_scanning_push_protection: { status: "enabled" }
+				},
+				squash_merge_commit_message: "PR_BODY",
+				squash_merge_commit_title: "PR_TITLE"
+			},
+			type: "octokit"
+		}] };
+	}
+});
+//#endregion
+export { blockRepositorySettings };

package/dist/blocks/blockSecurityDocs.d.mts

@@ -0,0 +1,73 @@
+//#region src/blocks/blockSecurityDocs.d.ts
+declare const blockSecurityDocs: 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 { blockSecurityDocs };

package/dist/blocks/blockSecurityDocs.mjs

@@ -0,0 +1,20 @@
+import { base } from "../base.mjs";
+import { resolveEmails } from "../utils/resolveEmails.mjs";
+//#region src/blocks/blockSecurityDocs.ts
+const blockSecurityDocs = base.createBlock({
+	about: { name: "Security Docs" },
+	produce({ options }) {
+		return { files: { ".github": { "SECURITY.md": `# Security Policy
+
+We take all security vulnerabilities seriously.
+If you have a vulnerability or other security issues to disclose:
+
+- Thank you very much, please do!
+- Please send them to us by emailing \`${resolveEmails(options.email).github}\`
+
+We appreciate your efforts and responsible disclosure and will make every effort to acknowledge your contributions.
+` } } };
+	}
+});
+//#endregion
+export { blockSecurityDocs };

package/dist/blocks/blockSideEffects.d.mts

@@ -0,0 +1,75 @@
+//#region src/blocks/blockSideEffects.d.ts
+declare const blockSideEffects: import("bingo-stratum").BlockWithAddons<{
+  sideEffects?: boolean | string[] | 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 { blockSideEffects };

package/dist/blocks/blockSideEffects.mjs

@@ -0,0 +1,14 @@
+import { base } from "../base.mjs";
+import { blockPackageJson } from "./blockPackageJson.mjs";
+import { z } from "zod";
+//#region src/blocks/blockSideEffects.ts
+const blockSideEffects = base.createBlock({
+	about: { name: "Side Effects" },
+	addons: { sideEffects: z.union([z.boolean(), z.array(z.string())]).optional() },
+	produce({ addons }) {
+		const { sideEffects = false } = addons;
+		return { addons: [blockPackageJson({ properties: { sideEffects } })] };
+	}
+});
+//#endregion
+export { blockSideEffects };