create-typescript-app 2.63.2 → 2.65.0

package/dist/blocks/blockPrettier.mjs

@@ -0,0 +1,97 @@
+import { getPackageDependencies } from "../data/packageData.mjs";
+import { base } from "../base.mjs";
+import { CommandPhase } from "./phases.mjs";
+import { blockRemoveFiles } from "./blockRemoveFiles.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 { blockCSpell } from "./blockCSpell.mjs";
+import { blockRemoveDependencies } from "./blockRemoveDependencies.mjs";
+import { formatIgnoreFile } from "./files/formatIgnoreFile.mjs";
+import { z } from "zod";
+//#region src/blocks/blockPrettier.ts
+const blockPrettier = base.createBlock({
+	about: { name: "Prettier" },
+	addons: {
+		ignores: z.array(z.string()).default([]),
+		overrides: z.array(z.object({
+			files: z.string(),
+			options: z.object({ parser: z.string() })
+		})).default([]),
+		plugins: z.array(z.string()).default([]),
+		runBefore: z.array(z.string()).default([])
+	},
+	produce({ addons }) {
+		const { ignores, overrides, plugins, runBefore } = addons;
+		return {
+			addons: [
+				blockCSpell({ ignorePaths: [".all-contributorsrc"] }),
+				blockDevelopmentDocs({ sections: { Formatting: { contents: `
+[Prettier](https://prettier.io) is used to format code.
+It should be applied automatically when you save files in VS Code or make a Git commit.
+
+To manually reformat all files, you can run:
+
+\`\`\`shell
+pnpm format --write
+\`\`\`
+` } } }),
+				blockGitHubActionsCI({ jobs: [{
+					name: "Format Check",
+					steps: [...runBefore.map((run) => ({ run })), { run: "pnpm format --list-different" }]
+				}] }),
+				blockPackageJson({ properties: {
+					devDependencies: getPackageDependencies(...plugins.filter((plugin) => !plugin.startsWith(".")), "husky", "lint-staged", "prettier"),
+					"lint-staged": { "*": "prettier --ignore-unknown --write" },
+					scripts: {
+						format: "prettier .",
+						prepare: "husky"
+					}
+				} }),
+				blockVSCode({
+					extensions: ["esbenp.prettier-vscode"],
+					settings: { "editor.defaultFormatter": "esbenp.prettier-vscode" }
+				})
+			],
+			files: {
+				".husky": {
+					".gitignore": "_\n",
+					"pre-commit": ["npx lint-staged\n", { executable: true }]
+				},
+				".prettierignore": formatIgnoreFile([
+					"/.husky",
+					"/dist",
+					"/pnpm-lock.yaml",
+					...ignores
+				].sort()),
+				"prettier.config.ts": `import type { Config } from "prettier";
+
+export default ${JSON.stringify({
+					...overrides.length && { overrides: overrides.sort() },
+					...plugins.length && { plugins: plugins.sort() },
+					useTabs: true
+				})} satisfies Config;
+`
+			},
+			scripts: [{
+				commands: [...runBefore, "pnpm format --write"],
+				phase: CommandPhase.Format
+			}]
+		};
+	},
+	transition() {
+		return { addons: [
+			blockRemoveDependencies({ dependencies: ["eslint-config-prettier", "eslint-plugin-prettier"] }),
+			blockRemoveFiles({ files: [
+				".prettierrc",
+				".prettierrc.{c*,js,m*,t*}",
+				"prettier.config*"
+			] }),
+			blockRemoveWorkflows({ workflows: ["format", "prettier"] })
+		] };
+	}
+});
+//#endregion
+export { blockPrettier };

package/dist/blocks/blockPrettierPluginCurly.d.mts

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

package/dist/blocks/blockPrettierPluginCurly.mjs

@@ -0,0 +1,11 @@
+import { base } from "../base.mjs";
+import { blockPrettier } from "./blockPrettier.mjs";
+//#region src/blocks/blockPrettierPluginCurly.ts
+const blockPrettierPluginCurly = base.createBlock({
+	about: { name: "Prettier Plugin Curly" },
+	produce() {
+		return { addons: [blockPrettier({ plugins: ["prettier-plugin-curly"] })] };
+	}
+});
+//#endregion
+export { blockPrettierPluginCurly };

package/dist/blocks/blockPrettierPluginPackageJson.d.mts

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

package/dist/blocks/blockPrettierPluginPackageJson.mjs

@@ -0,0 +1,11 @@
+import { base } from "../base.mjs";
+import { blockPrettier } from "./blockPrettier.mjs";
+//#region src/blocks/blockPrettierPluginPackageJson.ts
+const blockPrettierPluginPackageJson = base.createBlock({
+	about: { name: "Prettier Plugin Package JSON" },
+	produce() {
+		return { addons: [blockPrettier({ plugins: ["prettier-plugin-packagejson"] })] };
+	}
+});
+//#endregion
+export { blockPrettierPluginPackageJson };

package/dist/blocks/blockPrettierPluginPaddingLines.d.mts

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

package/dist/blocks/blockPrettierPluginPaddingLines.mjs

@@ -0,0 +1,11 @@
+import { base } from "../base.mjs";
+import { blockPrettier } from "./blockPrettier.mjs";
+//#region src/blocks/blockPrettierPluginPaddingLines.ts
+const blockPrettierPluginPaddingLines = base.createBlock({
+	about: { name: "Prettier Plugin Padding Lines" },
+	produce() {
+		return { addons: [blockPrettier({ plugins: ["prettier-plugin-padding-lines"] })] };
+	}
+});
+//#endregion
+export { blockPrettierPluginPaddingLines };

package/dist/blocks/blockPrettierPluginSentencesPerLine.d.mts

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

package/dist/blocks/blockPrettierPluginSentencesPerLine.mjs

@@ -0,0 +1,11 @@
+import { base } from "../base.mjs";
+import { blockPrettier } from "./blockPrettier.mjs";
+//#region src/blocks/blockPrettierPluginSentencesPerLine.ts
+const blockPrettierPluginSentencesPerLine = base.createBlock({
+	about: { name: "Prettier Plugin Sentences Per Line" },
+	produce() {
+		return { addons: [blockPrettier({ plugins: ["prettier-plugin-sentences-per-line"] })] };
+	}
+});
+//#endregion
+export { blockPrettierPluginSentencesPerLine };

package/dist/blocks/blockPrettierPluginSh.d.mts

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

package/dist/blocks/blockPrettierPluginSh.mjs

@@ -0,0 +1,11 @@
+import { base } from "../base.mjs";
+import { blockPrettier } from "./blockPrettier.mjs";
+//#region src/blocks/blockPrettierPluginSh.ts
+const blockPrettierPluginSh = base.createBlock({
+	about: { name: "Prettier Plugin Sh" },
+	produce() {
+		return { addons: [blockPrettier({ plugins: ["prettier-plugin-sh"] })] };
+	}
+});
+//#endregion
+export { blockPrettierPluginSh };

package/dist/blocks/blockREADME.d.mts

@@ -0,0 +1,86 @@
+//#region src/blocks/blockREADME.d.ts
+declare const blockREADME: import("bingo-stratum").BlockWithAddons<{
+  sections: string[];
+  badges: {
+    alt: string;
+    src: string;
+    href?: string | undefined;
+    comments?: {
+      after: string;
+      before: string;
+    } | undefined;
+  }[];
+  defaultUsage: string[];
+  notices: 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 { blockREADME };

package/dist/blocks/blockREADME.mjs

@@ -0,0 +1,74 @@
+import { base } from "../base.mjs";
+import { z } from "zod";
+//#region src/blocks/blockREADME.ts
+function printAttributes(attributes) {
+	return Object.entries(attributes).map(([key, value]) => `${key}="${value}"`).sort().join(" ");
+}
+const zBadge = z.object({
+	alt: z.string(),
+	comments: z.object({
+		after: z.string(),
+		before: z.string()
+	}).optional(),
+	href: z.string().optional(),
+	src: z.string()
+});
+const blockREADME = base.createBlock({
+	about: { name: "README.md" },
+	addons: {
+		badges: z.array(zBadge).default([]),
+		defaultUsage: z.array(z.string()).default([]),
+		notices: z.array(z.string()).default([]),
+		sections: z.array(z.string()).default([])
+	},
+	produce({ addons, options }) {
+		const { badges, defaultUsage, notices, sections } = addons;
+		const explainer = options.documentation.readme.explainer && `\n${options.documentation.readme.explainer}\n`;
+		const logo = options.logo && `\n<img ${printAttributes({
+			align: "right",
+			...options.logo
+		})}>\n`;
+		const suffixes = [...notices, options.documentation.readme.footnotes].filter((suffix) => typeof suffix === "string");
+		return { files: { "README.md": `<h1 align="center">${options.title}</h1>
+
+<p align="center">${formatDescription(options.description)}</p>
+
+<p align="center">
+${formatBadges(badges)}
+</p>
+${[logo, explainer].filter(Boolean).join("")}
+## Usage
+
+${options.documentation.readme.usage ?? defaultUsage.join("\n\n")}
+
+## Development
+
+See [\`.github/CONTRIBUTING.md\`](./.github/CONTRIBUTING.md), then [\`.github/DEVELOPMENT.md\`](./.github/DEVELOPMENT.md).
+Thanks! ${options.emoji}
+${[...sections, options.documentation.readme.additional].filter(Boolean).map((section) => `\n${section}`).join("")}
+${suffixes.length ? `\n${suffixes.map((suffix) => suffix.trim()).join("\n\n")}` : ""}` } };
+	}
+});
+function badgeSorter(a, b) {
+	return removeEmojis(a.alt).localeCompare(removeEmojis(b.alt));
+}
+function formatBadge(badge) {
+	const image = `<img alt="${badge.alt}" src="${badge.src}" />`;
+	const tagged = badge.href ? `<a href="${badge.href}" target="_blank">${image}</a>` : image;
+	return `\t${badge.comments ? `${badge.comments.before}${tagged}${badge.comments.after}` : tagged}`;
+}
+function formatBadges(badges) {
+	return [...badges, {
+		alt: "💪 TypeScript: Strict",
+		src: "https://img.shields.io/badge/%F0%9F%92%AA_typescript-strict-21bb42.svg"
+	}].sort(badgeSorter).map(formatBadge).join("\n");
+}
+function formatDescription(description) {
+	if (!description.includes(". ")) return description;
+	return "\n	" + description.replaceAll(". ", ".\n	") + "\n";
+}
+function removeEmojis(text) {
+	return text.replaceAll(/\p{Emoji}/gu, "").trim();
+}
+//#endregion
+export { blockREADME };