create-typescript-app 2.63.2 → 2.65.0

package/dist/blocks/blockAreTheTypesWrong.d.mts

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

package/dist/blocks/blockAreTheTypesWrong.mjs

@@ -0,0 +1,14 @@
+import { base } from "../base.mjs";
+import { blockGitHubActionsCI } from "./blockGitHubActionsCI.mjs";
+//#region src/blocks/blockAreTheTypesWrong.ts
+const blockAreTheTypesWrong = base.createBlock({
+	about: { name: "Are The Types Wrong" },
+	produce() {
+		return { addons: [blockGitHubActionsCI({ jobs: [{
+			name: "Are The Types Wrong?",
+			steps: [{ run: "pnpm build" }, { run: "npx --yes @arethetypeswrong/cli --pack . --ignore-rules cjs-resolves-to-esm --profile esm-only" }]
+		}] })] };
+	}
+});
+//#endregion
+export { blockAreTheTypesWrong };

package/dist/blocks/blockBin.d.mts

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

package/dist/blocks/blockBin.mjs

@@ -0,0 +1,27 @@
+import { intakeFile } from "./intake/intakeFile.mjs";
+import { base } from "../base.mjs";
+import { getPrimaryBin } from "./bin/getPrimaryBin.mjs";
+import { z } from "zod";
+//#region src/blocks/blockBin.ts
+const blockBin = base.createBlock({
+	about: { name: "Bin" },
+	addons: { contents: z.string().optional() },
+	intake({ files, options }) {
+		const primaryBin = getPrimaryBin(options.bin, options.repository);
+		if (!primaryBin) return;
+		const existing = intakeFile(files, primaryBin.split("/"));
+		return existing ? { contents: existing[0] } : void 0;
+	},
+	produce({ addons, options }) {
+		const primaryBin = getPrimaryBin(options.bin, options.repository);
+		if (!primaryBin || primaryBin.startsWith("dist/")) return {};
+		const segments = primaryBin.split("/");
+		const toRoot = "../".repeat(segments.length - 1);
+		const contents = (addons.contents ?? `#!/usr/bin/env node
+import "${toRoot}dist/index.mjs";
+`).replaceAll(/((?:\.\.\/)+)lib\//gu, "$1dist/");
+		return { files: segments.reduceRight((nested, segment) => ({ [segment]: nested }), [contents, { executable: true }]) };
+	}
+});
+//#endregion
+export { blockBin };

package/dist/blocks/blockCSpell.d.mts

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

package/dist/blocks/blockCSpell.mjs

@@ -0,0 +1,77 @@
+import { intakeFile } from "./intake/intakeFile.mjs";
+import { getPackageDependencies } from "../data/packageData.mjs";
+import { base } from "../base.mjs";
+import { resolveBin } from "../utils/resolveBin.mjs";
+import { CommandPhase } from "./phases.mjs";
+import { blockGitHubActionsCI } from "./blockGitHubActionsCI.mjs";
+import { blockPackageJson } from "./blockPackageJson.mjs";
+import { blockDevelopmentDocs } from "./blockDevelopmentDocs.mjs";
+import { blockRemoveWorkflows } from "./blockRemoveWorkflows.mjs";
+import { blockVSCode } from "./blockVSCode.mjs";
+import { z } from "zod";
+import JSON5 from "json5";
+import { getObjectStringsDeep } from "object-strings-deep";
+//#region src/blocks/blockCSpell.ts
+const filesGlob = `"**" ".github/**/*"`;
+const addons = {
+	ignorePaths: z.array(z.string()).default([]),
+	words: z.array(z.string()).default([])
+};
+const zAddons = z.object(addons);
+const blockCSpell = base.createBlock({
+	about: { name: "CSpell" },
+	addons,
+	intake({ files }) {
+		const cspellJson = intakeFile(files, ["cspell.json"]);
+		if (!cspellJson) return;
+		const { data } = zAddons.safeParse(JSON5.parse(cspellJson[0]));
+		if (!data) return;
+		return data;
+	},
+	produce({ addons, options }) {
+		const { ignorePaths, words } = addons;
+		const allWords = Array.from(/* @__PURE__ */ new Set([...options.words ?? [], ...words])).sort();
+		return {
+			addons: [
+				blockDevelopmentDocs({ sections: { Linting: { contents: { items: [`- \`pnpm lint:spelling\` ([cspell](https://cspell.org)): Spell checks across all source files`] } } } }),
+				blockVSCode({ extensions: ["streetsidesoftware.code-spell-checker"] }),
+				blockGitHubActionsCI({ jobs: [{
+					name: "Lint Spelling",
+					steps: [{ run: "pnpm lint:spelling" }]
+				}] }),
+				blockPackageJson({ properties: {
+					devDependencies: getPackageDependencies("cspell"),
+					scripts: { "lint:spelling": `cspell ${filesGlob}` }
+				} })
+			],
+			files: { "cspell.json": JSON.stringify({
+				dictionaries: [
+					"npm",
+					"node",
+					"typescript"
+				],
+				ignorePaths: Array.from(/* @__PURE__ */ new Set([
+					".github",
+					"CHANGELOG.md",
+					"dist",
+					"node_modules",
+					"pnpm-lock.yaml",
+					...ignorePaths
+				])).sort(),
+				...allWords.length && { words: allWords }
+			}) }
+		};
+	},
+	setup({ options }) {
+		const wordArgs = getObjectStringsDeep(options).map((word) => `--words "${word.replaceAll(`"`, " ")}"`).join(" ");
+		return { scripts: [{
+			commands: [`node ${resolveBin("cspell-populate-words/bin/index.mjs")} ${wordArgs}`],
+			phase: CommandPhase.Process
+		}] };
+	},
+	transition() {
+		return { addons: [blockRemoveWorkflows({ workflows: ["lint-spelling", "spelling"] })] };
+	}
+});
+//#endregion
+export { blockCSpell };

package/dist/blocks/blockCTATransitions.d.mts

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

package/dist/blocks/blockCTATransitions.mjs

@@ -0,0 +1,115 @@
+import { packageData } from "../data/packageData.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 { createSoloWorkflowFile } from "./files/createSoloWorkflowFile.mjs";
+import { blockPackageJson } from "./blockPackageJson.mjs";
+//#region src/blocks/blockCTATransitions.ts
+const blockCTATransitions = base.createBlock({
+	about: { name: "CTA Transitions" },
+	produce({ options }) {
+		return {
+			addons: [blockPackageJson({ properties: { devDependencies: { "create-typescript-app": packageData.version } } }), blockRepositoryBranchRuleset({ requiredStatusChecks: ["Transition"] })],
+			files: { ".github": {
+				actions: { transition: { "action.yaml": formatYaml({
+					description: "Runs create-typescript-app in transition mode",
+					inputs: { token: {
+						description: "GitHub personal access token with repo, workflow, and read:org permissions.",
+						required: true
+					} },
+					name: "Transition",
+					runs: {
+						steps: [
+							{ uses: "./.github/actions/prepare" },
+							{
+								run: "npx create-typescript-app",
+								shell: "bash"
+							},
+							{
+								id: "auto-commit-action",
+								uses: resolveUses("stefanzweifel/git-auto-commit-action", "v5", options.workflowsVersions),
+								with: {
+									commit_author: "The Friendly Bingo Bot <bot@create.bingo>",
+									commit_message: "Check in changes from re-running npx create-typescript-app",
+									commit_user_email: "bot@create.bingo",
+									commit_user_name: "The Friendly Bingo Bot"
+								}
+							},
+							{
+								if: "steps.auto-commit-action.outputs.changes_detected == 'true'",
+								uses: resolveUses("mshick/add-pr-comment", "v2", options.workflowsVersions),
+								with: {
+									issue: "${{ github.event.pull_request.number }}",
+									message: [
+										"🤖 Beep boop! I ran `npx create-typescript-app` and it updated some files.",
+										"",
+										"I went ahead and checked those changes into this PR for you. Please review the latest commit to see if you want to merge it.",
+										"",
+										"Cheers!",
+										" — _The Friendly Bingo Bot_ 💝",
+										"",
+										"> ℹ️ These automatic commits keep your repository up-to-date with new versions of [create-typescript-app](https://github.com/JoshuaKGoldberg/create-typescript-app). If you want to opt out, delete your `.github/workflows/cta-transitions.yaml` file."
+									].join("\n")
+								}
+							},
+							{
+								id: "package-change",
+								uses: resolveUses("JoshuaKGoldberg/package-change-detector-action", "0.1.0", options.workflowsVersions),
+								with: { properties: "engines" }
+							},
+							{
+								if: `steps.package-change.outputs.changed == 'true'`,
+								uses: resolveUses("JoshuaKGoldberg/draft-pull-request-once-action", "0.0.1", options.workflowsVersions),
+								with: {
+									"github-token": "${{ inputs.token }}",
+									message: [
+										"🤖 Beep boop! This PR changes the `engines` field in `package.json`. That might be a breaking change. It's been set to a draft so that it doesn't automatically merge. Go ahead and un-draft the PR if the change is ready for release.",
+										"",
+										"Cheers!",
+										" — _The Friendly Bingo Bot_ 💝"
+									].join("\n")
+								}
+							}
+						],
+						using: "composite"
+					}
+				}) } },
+				workflows: { "cta.yaml": createSoloWorkflowFile({
+					jobName: "Transition",
+					name: "CTA",
+					on: { pull_request: { branches: ["main"] } },
+					permissions: { "pull-requests": "write" },
+					steps: [
+						{
+							id: "checkout",
+							if: `(github.actor == '${options.owner}' || github.actor == 'renovate[bot]') && startsWith(github.head_ref, 'renovate/') && contains(github.event.pull_request.title, 'create-typescript-app')`,
+							uses: resolveUses("actions/checkout", "v4", options.workflowsVersions),
+							with: {
+								"fetch-depth": 0,
+								ref: "${{github.event.pull_request.head.ref}}",
+								repository: "${{github.event.pull_request.head.repo.full_name}}",
+								token: "${{ secrets.ACCESS_TOKEN }}"
+							}
+						},
+						{
+							if: "steps.checkout.outcome != 'skipped'",
+							uses: "./.github/actions/transition",
+							with: { token: "${{ secrets.ACCESS_TOKEN }}" }
+						},
+						{
+							if: "steps.checkout.outcome == 'skipped'",
+							run: "echo 'Skipping transition mode because the PR does not appear to be an automated or owner-created update to create-typescript-app.'"
+						}
+					]
+				}) }
+			} }
+		};
+	},
+	transition() {
+		return { addons: [blockRemoveFiles({ files: [".github/actions/transition/action.yml", ".github/workflows/cta.yml"] })] };
+	}
+});
+//#endregion
+export { blockCTATransitions };

package/dist/blocks/blockCodecov.d.mts

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

package/dist/blocks/blockCodecov.mjs

@@ -0,0 +1,58 @@
+import { intakeFileYamlSteps } from "./actions/steps.mjs";
+import { codecovTokenSecret, findCodecovStep } from "./codecov/findCodecovStep.mjs";
+import { base } from "../base.mjs";
+import { resolveUses } from "./actions/resolveUses.mjs";
+import { blockRemoveFiles } from "./blockRemoveFiles.mjs";
+import { blockREADME } from "./blockREADME.mjs";
+import { blockVitest } from "./blockVitest.mjs";
+import { blockGitHubApps } from "./blockGitHubApps.mjs";
+import { z } from "zod";
+//#region src/blocks/blockCodecov.ts
+const blockCodecov = base.createBlock({
+	about: { name: "Codecov" },
+	addons: { env: z.record(z.string(), z.string()).optional() },
+	intake({ files }) {
+		const steps = intakeFileYamlSteps(files, [
+			".github",
+			"workflows",
+			"ci.yaml"
+		], [
+			"jobs",
+			"test",
+			"steps"
+		]);
+		if (!steps) return;
+		const step = findCodecovStep(steps);
+		if (!step) return;
+		const { CODECOV_TOKEN, ...env } = step.env ?? {};
+		if (CODECOV_TOKEN && CODECOV_TOKEN !== "${{ secrets.CODECOV_TOKEN }}") env.CODECOV_TOKEN = CODECOV_TOKEN;
+		return { env: Object.keys(env).length ? env : void 0 };
+	},
+	produce({ addons, options }) {
+		const env = options.codecovToken ? {
+			CODECOV_TOKEN: codecovTokenSecret,
+			...addons.env
+		} : addons.env;
+		return { addons: [
+			blockGitHubApps({ apps: [{
+				name: "Codecov",
+				url: "https://github.com/apps/codecov"
+			}] }),
+			blockREADME({ badges: [{
+				alt: "🧪 Coverage",
+				href: `https://codecov.io/gh/${options.owner}/${options.repository}`,
+				src: `https://img.shields.io/codecov/c/github/${options.owner}/${options.repository}?label=%F0%9F%A7%AA%20coverage`
+			}] }),
+			blockVitest({ actionSteps: [{
+				...env && { env },
+				if: "always()",
+				uses: resolveUses("codecov/codecov-action", "v3", options.workflowsVersions)
+			}] })
+		] };
+	},
+	transition() {
+		return { addons: [blockRemoveFiles({ files: [".github/codecov.{yaml,yml}", "codecov.{yaml,yml}"] })] };
+	}
+});
+//#endregion
+export { blockCodecov };