create-typescript-app 2.63.2 → 2.65.0

package/dist/blocks/blockOctoGuide.d.mts

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

package/dist/blocks/blockOctoGuide.mjs

@@ -0,0 +1,73 @@
+import { intakeFileYamlSteps } from "./actions/steps.mjs";
+import { base } from "../base.mjs";
+import { resolveUses } from "./actions/resolveUses.mjs";
+import { blockRemoveFiles } from "./blockRemoveFiles.mjs";
+import { createSoloWorkflowFile } from "./files/createSoloWorkflowFile.mjs";
+import { z } from "zod";
+//#region src/blocks/blockOctoGuide.ts
+const blockOctoGuide = base.createBlock({
+	about: { name: "OctoGuide" },
+	addons: { config: z.union([z.literal("recommended"), z.literal("strict")]).optional() },
+	intake({ files }) {
+		const steps = intakeFileYamlSteps(files, [
+			".github",
+			"workflows",
+			"octoguide.yaml"
+		], [
+			"jobs",
+			"octoguide",
+			"steps"
+		]);
+		if (!steps) return;
+		const runOctoGuideStep = steps.find((step) => typeof step.uses === "string" && step.uses.startsWith("JoshuaKGoldberg/octoguide"));
+		if (!runOctoGuideStep) return;
+		return { config: runOctoGuideStep.with?.config };
+	},
+	produce({ addons, options }) {
+		return { files: { ".github": { workflows: { "octoguide.yaml": createSoloWorkflowFile({
+			if: "${{ !endsWith(github.actor, '[bot]') }}",
+			name: "OctoGuide",
+			on: {
+				discussion: { types: ["created", "edited"] },
+				discussion_comment: { types: [
+					"created",
+					"deleted",
+					"edited"
+				] },
+				issue_comment: { types: [
+					"created",
+					"deleted",
+					"edited"
+				] },
+				issues: { types: ["edited", "opened"] },
+				pull_request_review_comment: { types: [
+					"created",
+					"deleted",
+					"edited"
+				] },
+				pull_request_target: { types: ["edited", "opened"] }
+			},
+			permissions: {
+				discussions: "write",
+				issues: "write",
+				"pull-requests": "write"
+			},
+			steps: [{
+				uses: resolveUses("JoshuaKGoldberg/octoguide", "0.11.1", options.workflowsVersions),
+				with: {
+					config: addons.config ?? "recommended",
+					"github-token": "${{ secrets.GITHUB_TOKEN }}"
+				}
+			}]
+		}) } } } };
+	},
+	transition() {
+		return { addons: [blockRemoveFiles({ files: [
+			".github/workflows/accessibility-alt-text-bot.{yaml,yml}",
+			".github/workflows/compliance.{yaml,yml}",
+			".github/workflows/octoguide.yml"
+		] })] };
+	}
+});
+//#endregion
+export { blockOctoGuide };

package/dist/blocks/blockOctoGuideStrict.d.mts

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

package/dist/blocks/blockOctoGuideStrict.mjs

@@ -0,0 +1,11 @@
+import { base } from "../base.mjs";
+import { blockOctoGuide } from "./blockOctoGuide.mjs";
+//#region src/blocks/blockOctoGuideStrict.ts
+const blockOctoGuideStrict = base.createBlock({
+	about: { name: "OctoGuide Strict" },
+	produce() {
+		return { addons: [blockOctoGuide({ config: "strict" })] };
+	}
+});
+//#endregion
+export { blockOctoGuideStrict };

package/dist/blocks/blockPackageJson.d.mts

@@ -0,0 +1,150 @@
+//#region src/blocks/blockPackageJson.d.ts
+declare const blockPackageJson: import("bingo-stratum").BlockWithAddons<{
+  properties: {
+    type?: "commonjs" | "module" | undefined;
+    author?: string | {
+      name: string;
+      url?: string | undefined;
+      email?: string | undefined;
+    } | undefined;
+    bin?: string | Record<string, string> | undefined;
+    name?: string | undefined;
+    contributors?: (string | {
+      name: string;
+      url?: string | undefined;
+      email?: string | undefined;
+    })[] | undefined;
+    description?: string | undefined;
+    funding?: string | {
+      url: string;
+      type?: string | undefined;
+    } | (string | {
+      url: string;
+      type?: string | undefined;
+    })[] | undefined;
+    keywords?: string[] | undefined;
+    dependencies?: Record<string, string> | undefined;
+    devDependencies?: Record<string, string> | undefined;
+    peerDependencies?: Record<string, string> | undefined;
+    peerDependenciesMeta?: Record<string, {
+      optional: boolean;
+    }> | undefined;
+    scripts?: Record<string, string | undefined> | undefined;
+    repository?: string | {
+      type: string;
+      url: string;
+      directory?: string | undefined;
+    } | undefined;
+    module?: string | undefined;
+    version?: string | undefined;
+    engines?: Record<string, string> | undefined;
+    packageManager?: string | undefined;
+    files?: string[] | undefined;
+    types?: string | undefined;
+    imports?: Record<string, unknown> | undefined;
+    license?: string | undefined;
+    config?: Record<string, unknown> | undefined;
+    private?: boolean | undefined;
+    homepage?: string | undefined;
+    maintainers?: (string | {
+      name: string;
+      url?: string | undefined;
+      email?: string | undefined;
+    })[] | undefined;
+    main?: string | undefined;
+    bugs?: string | {
+      url?: string | undefined;
+      email?: string | undefined;
+    } | undefined;
+    browser?: string | Record<string, string | boolean> | undefined;
+    man?: string | string[] | undefined;
+    directories?: Record<string, string> | undefined;
+    bundleDependencies?: boolean | string[] | undefined;
+    bundledDependencies?: boolean | string[] | undefined;
+    optionalDependencies?: Record<string, string> | undefined;
+    overrides?: Record<string, unknown> | undefined;
+    os?: string[] | undefined;
+    cpu?: string[] | undefined;
+    publishConfig?: Record<string, unknown> | undefined;
+    workspaces?: string[] | undefined;
+    deprecated?: string | undefined;
+    typings?: string | undefined;
+    typesVersions?: Record<string, Record<string, string[]>> | undefined;
+    sideEffects?: boolean | string[] | undefined;
+    exports?: string | string[] | Record<string, unknown> | null | undefined;
+  } & {
+    [k: string]: unknown;
+  };
+  cleanupCommands: 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 { blockPackageJson };

package/dist/blocks/blockPackageJson.mjs

@@ -0,0 +1,86 @@
+import { htmlToTextSafe } from "../utils/htmlToTextSafe.mjs";
+import { base } from "../base.mjs";
+import { CommandPhase } from "./phases.mjs";
+import { blockRemoveFiles } from "./blockRemoveFiles.mjs";
+import { resolveEmails } from "../utils/resolveEmails.mjs";
+import { z } from "zod";
+import semver from "semver";
+import removeUndefinedObjects from "remove-undefined-objects";
+import sortPackageJson from "sort-package-json";
+import { PackageJson } from "zod-package-json";
+//#region src/blocks/blockPackageJson.ts
+const PackageJsonWithNullableScripts = PackageJson.partial().extend({ scripts: z.record(z.string(), z.union([z.string(), z.undefined()])).optional() });
+const blockPackageJson = base.createBlock({
+	about: { name: "Package JSON" },
+	addons: {
+		cleanupCommands: z.array(z.string()).default([]),
+		properties: PackageJsonWithNullableScripts.default({})
+	},
+	produce({ addons, offline, options }) {
+		const dependencies = useLargerVersions(options.packageData?.dependencies, {
+			...options.packageData?.dependencies,
+			...addons.properties.dependencies
+		});
+		const devDependencies = useLargerVersions(options.packageData?.devDependencies, {
+			...options.packageData?.devDependencies,
+			...addons.properties.devDependencies
+		});
+		const description = htmlToTextSafe(options.description);
+		return {
+			files: { "package.json": sortPackageJson(JSON.stringify(removeUndefinedObjects({
+				...options.packageData,
+				...addons.properties,
+				author: {
+					email: resolveEmails(options.email).npm,
+					name: options.author
+				},
+				bin: options.bin,
+				dependencies: Object.keys(dependencies).length ? dependencies : void 0,
+				description,
+				devDependencies: Object.keys(devDependencies).length ? devDependencies : void 0,
+				engines: { node: /^\d/u.test(options.node.minimum) ? `>=${options.node.minimum}` : options.node.minimum },
+				...options.pnpm && { packageManager: `pnpm@${options.pnpm}` },
+				files: processFiles(addons.properties.files),
+				keywords: options.keywords,
+				name: options.repository,
+				repository: {
+					type: "git",
+					url: `git+https://github.com/${options.owner}/${options.repository}.git`
+				},
+				scripts: {
+					...options.packageData?.scripts,
+					...addons.properties.scripts
+				},
+				type: options.type ?? "module",
+				version: options.version ?? "0.0.0"
+			}))) },
+			scripts: [{
+				commands: [`pnpm install ${offline ? "--offline " : ""}--no-frozen-lockfile`, ...addons.cleanupCommands],
+				phase: CommandPhase.Install
+			}]
+		};
+	},
+	transition() {
+		return { addons: [blockRemoveFiles({ files: ["package-lock.json yarn.lock"] })] };
+	}
+});
+function processFiles(files) {
+	if (!files?.length) return;
+	const sortedByLength = files.filter(Boolean).sort((a, b) => a.length - b.length);
+	return sortedByLength.filter((file, i) => !sortedByLength.slice(0, i).some((earlier) => earlier.endsWith("/") && file.startsWith(earlier))).sort();
+}
+function removeRangePrefix(version) {
+	const raw = version.replaceAll(/[\^~><=]/gu, "").split(" ")[0];
+	return semver.coerce(raw) ?? raw;
+}
+function useLargerVersion(existing, replacement) {
+	if (!existing || existing === replacement) return replacement;
+	const existingCoerced = semver.coerce(removeRangePrefix(existing));
+	return existingCoerced && semver.gt(existingCoerced, removeRangePrefix(replacement)) ? existing : replacement;
+}
+function useLargerVersions(existing, replacements) {
+	if (!existing) return replacements;
+	return Object.fromEntries(Object.entries(replacements).map(([key, replacement]) => [key, useLargerVersion(existing[key], replacement)]));
+}
+//#endregion
+export { blockPackageJson };

package/dist/blocks/blockPnpmDedupe.d.mts

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

package/dist/blocks/blockPnpmDedupe.mjs

@@ -0,0 +1,19 @@
+import { base } from "../base.mjs";
+import { blockGitHubActionsCI } from "./blockGitHubActionsCI.mjs";
+import { blockPackageJson } from "./blockPackageJson.mjs";
+import { blockRemoveWorkflows } from "./blockRemoveWorkflows.mjs";
+//#region src/blocks/blockPnpmDedupe.ts
+const blockPnpmDedupe = base.createBlock({
+	about: { name: "pnpm Dedupe" },
+	produce() {
+		return { addons: [blockGitHubActionsCI({ jobs: [{
+			name: "Dedupe Check",
+			steps: [{ run: "pnpm dedupe --check" }]
+		}] }), blockPackageJson({ cleanupCommands: ["pnpm dedupe"] })] };
+	},
+	transition() {
+		return { addons: [blockRemoveWorkflows({ workflows: ["lint-packages"] })] };
+	}
+});
+//#endregion
+export { blockPnpmDedupe };

package/dist/blocks/blockPrettier.d.mts

@@ -0,0 +1,83 @@
+//#region src/blocks/blockPrettier.d.ts
+declare const blockPrettier: import("bingo-stratum").BlockWithAddons<{
+  plugins: string[];
+  ignores: string[];
+  overrides: {
+    options: {
+      parser: string;
+    };
+    files: string;
+  }[];
+  runBefore: 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 { blockPrettier };