create-typescript-app 2.64.0 → 2.65.1

package/dist/blocks/blockGitHubPRTemplate.d.mts

@@ -0,0 +1,73 @@
+//#region src/blocks/blockGitHubPRTemplate.d.ts
+declare const blockGitHubPRTemplate: 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;
+  };
+  node: {
+    minimum: string;
+    pinned?: string | undefined;
+  };
+  owner: string;
+  repository: string;
+  title: string;
+  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?: {
+    color: string;
+    description: string;
+    name: 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;
+  type?: "commonjs" | "module" | undefined;
+  version?: string | undefined;
+  words?: string[] | undefined;
+  workflowsVersions?: Record<string, Record<string, {
+    hash?: string | undefined;
+    pinned?: boolean | undefined;
+  }>> | undefined;
+}>;
+//#endregion
+export { blockGitHubPRTemplate };

package/dist/blocks/blockGitHubPRTemplate.mjs

@@ -0,0 +1,23 @@
+import { base } from "../base.mjs";
+//#region src/blocks/blockGitHubPRTemplate.ts
+const blockGitHubPRTemplate = base.createBlock({
+	about: { name: "GitHub Issue Templates" },
+	produce({ options }) {
+		return { files: { ".github": { "PULL_REQUEST_TEMPLATE.md": `<!-- 👋 Hi, thanks for sending a PR to ${options.repository}! ${options.emoji}
+Please fill out all fields below and make sure each item is true and [x] checked.
+Otherwise we may not be able to review your PR. -->
+
+## PR Checklist
+
+- [ ] Addresses an existing open issue: fixes #000
+- [ ] That issue was marked as [\`status: accepting prs\`](https://github.com/${options.owner}/${options.repository}/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
+- [ ] Steps in [CONTRIBUTING.md](https://github.com/${options.owner}/${options.repository}/blob/main/.github/CONTRIBUTING.md) were taken
+
+## Overview
+
+<!-- Description of what is changed and how the code change does that. -->
+` } } };
+	}
+});
+//#endregion
+export { blockGitHubPRTemplate };

package/dist/blocks/blockGitignore.d.mts

@@ -0,0 +1,75 @@
+//#region src/blocks/blockGitignore.d.ts
+declare const blockGitignore: import("bingo-stratum").BlockWithAddons<{
+  ignores: 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;
+  };
+  node: {
+    minimum: string;
+    pinned?: string | undefined;
+  };
+  owner: string;
+  repository: string;
+  title: string;
+  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?: {
+    color: string;
+    description: string;
+    name: 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;
+  type?: "commonjs" | "module" | undefined;
+  version?: string | undefined;
+  words?: string[] | undefined;
+  workflowsVersions?: Record<string, Record<string, {
+    hash?: string | undefined;
+    pinned?: boolean | undefined;
+  }>> | undefined;
+}>;
+//#endregion
+export { blockGitignore };

package/dist/blocks/blockGitignore.mjs

@@ -0,0 +1,14 @@
+import { base } from "../base.mjs";
+import { formatIgnoreFile } from "./files/formatIgnoreFile.mjs";
+import { z } from "zod";
+//#region src/blocks/blockGitignore.ts
+const blockGitignore = base.createBlock({
+	about: { name: "Gitignore" },
+	addons: { ignores: z.array(z.string()).default([]) },
+	produce({ addons }) {
+		const { ignores } = addons;
+		return { files: { ".gitignore": formatIgnoreFile(["/node_modules", ...ignores].sort()) } };
+	}
+});
+//#endregion
+export { blockGitignore };

package/dist/blocks/blockKnip.d.mts

@@ -0,0 +1,77 @@
+//#region src/blocks/blockKnip.d.ts
+declare const blockKnip: import("bingo-stratum").BlockWithAddons<{
+  entry?: string[] | undefined;
+  ignoreDependencies?: string[] | undefined;
+  project?: 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;
+  };
+  node: {
+    minimum: string;
+    pinned?: string | undefined;
+  };
+  owner: string;
+  repository: string;
+  title: string;
+  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?: {
+    color: string;
+    description: string;
+    name: 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;
+  type?: "commonjs" | "module" | undefined;
+  version?: string | undefined;
+  words?: string[] | undefined;
+  workflowsVersions?: Record<string, Record<string, {
+    hash?: string | undefined;
+    pinned?: boolean | undefined;
+  }>> | undefined;
+}>;
+//#endregion
+export { blockKnip };

package/dist/blocks/blockKnip.mjs

@@ -0,0 +1,70 @@
+import { getPackageDependencies } from "../data/packageData.mjs";
+import { base } from "../base.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 { intakeFileAsJson } from "./intake/intakeFileAsJson.mjs";
+import { intakeFileExportObject } from "./intake/intakeFileExportObject.mjs";
+import { z } from "zod";
+import removeUndefinedObjects from "remove-undefined-objects";
+//#region src/blocks/blockKnip.ts
+const zStringArray = z.array(z.string());
+const blockKnip = base.createBlock({
+	about: { name: "Knip" },
+	addons: {
+		entry: zStringArray.optional(),
+		ignoreDependencies: zStringArray.optional(),
+		project: zStringArray.optional()
+	},
+	intake({ files }) {
+		const knipJson = intakeFileExportObject(files, ["knip.config.ts"]) ?? intakeFileAsJson(files, ["knip.json"]);
+		if (!knipJson) return;
+		return removeUndefinedObjects({
+			entry: zStringArray.safeParse(knipJson.entry).data,
+			ignoreDependencies: zStringArray.safeParse(knipJson.ignoreDependencies).data,
+			project: zStringArray.safeParse(knipJson.project).data
+		});
+	},
+	produce({ addons }) {
+		const { entry, ignoreDependencies, project } = addons;
+		return {
+			addons: [
+				blockDevelopmentDocs({ sections: { Linting: { contents: { items: [`- \`pnpm lint:knip\` ([knip](https://github.com/webpro/knip)): Detects unused files, dependencies, and code exports`] } } } }),
+				blockGitHubActionsCI({ jobs: [{
+					name: "Lint Knip",
+					steps: [{ run: "pnpm lint:knip" }]
+				}] }),
+				blockPackageJson({ properties: {
+					devDependencies: getPackageDependencies("knip"),
+					scripts: { "lint:knip": "knip" }
+				} }),
+				blockRemoveFiles({ files: [".ts-prunerc*"] }),
+				blockVSCode({ extensions: ["webpro.vscode-knip"] })
+			],
+			files: { "knip.config.ts": `import type { KnipConfig } from "knip";
+
+export default ${JSON.stringify({
+				entry: entry?.sort(),
+				ignoreDependencies,
+				ignoreExportsUsedInFile: {
+					interface: true,
+					type: true
+				},
+				project: project?.sort(),
+				treatConfigHintsAsErrors: true
+			})} satisfies KnipConfig;` }
+		};
+	},
+	transition() {
+		return { addons: [blockRemoveFiles({ files: [
+			".knip*",
+			"knip.{c,j,m}*",
+			"knip.json*"
+		] }), blockRemoveWorkflows({ workflows: ["knip", "lint-knip"] })] };
+	}
+});
+//#endregion
+export { blockKnip };

package/dist/blocks/blockMITLicense.d.mts

@@ -0,0 +1,73 @@
+//#region src/blocks/blockMITLicense.d.ts
+declare const blockMITLicense: 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;
+  };
+  node: {
+    minimum: string;
+    pinned?: string | undefined;
+  };
+  owner: string;
+  repository: string;
+  title: string;
+  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?: {
+    color: string;
+    description: string;
+    name: 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;
+  type?: "commonjs" | "module" | undefined;
+  version?: string | undefined;
+  words?: string[] | undefined;
+  workflowsVersions?: Record<string, Record<string, {
+    hash?: string | undefined;
+    pinned?: boolean | undefined;
+  }>> | undefined;
+}>;
+//#endregion
+export { blockMITLicense };

package/dist/blocks/blockMITLicense.mjs

@@ -0,0 +1,39 @@
+import { base } from "../base.mjs";
+import { blockPackageJson } from "./blockPackageJson.mjs";
+import { blockREADME } from "./blockREADME.mjs";
+//#region src/blocks/blockMITLicense.ts
+const blockMITLicense = base.createBlock({
+	about: { name: "MIT License" },
+	produce({ options }) {
+		return {
+			addons: [blockREADME({ badges: [{
+				alt: "📝 License: MIT",
+				href: `https://github.com/${options.owner}/${options.repository}/blob/main/LICENSE.md`,
+				src: "https://img.shields.io/badge/%F0%9F%93%9D_license-MIT-21bb42.svg"
+			}] }), blockPackageJson({ properties: { license: "MIT" } })],
+			files: { "LICENSE.md": `# MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+` }
+		};
+	}
+});
+//#endregion
+export { blockMITLicense };

package/dist/blocks/blockNcc.d.mts

@@ -0,0 +1,75 @@
+//#region src/blocks/blockNcc.d.ts
+declare const blockNcc: import("bingo-stratum").BlockWithAddons<{
+  entry?: 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;
+  };
+  node: {
+    minimum: string;
+    pinned?: string | undefined;
+  };
+  owner: string;
+  repository: string;
+  title: string;
+  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?: {
+    color: string;
+    description: string;
+    name: 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;
+  type?: "commonjs" | "module" | undefined;
+  version?: string | undefined;
+  words?: string[] | undefined;
+  workflowsVersions?: Record<string, Record<string, {
+    hash?: string | undefined;
+    pinned?: boolean | undefined;
+  }>> | undefined;
+}>;
+//#endregion
+export { blockNcc };

package/dist/blocks/blockNcc.mjs

@@ -0,0 +1,65 @@
+import { base } from "../base.mjs";
+import { blockGitHubActionsCI } from "./blockGitHubActionsCI.mjs";
+import { blockPackageJson } from "./blockPackageJson.mjs";
+import { blockDevelopmentDocs } from "./blockDevelopmentDocs.mjs";
+import { blockCSpell } from "./blockCSpell.mjs";
+import { blockESLint } from "./blockESLint.mjs";
+import { blockPrettier } from "./blockPrettier.mjs";
+import { z } from "zod";
+//#region src/blocks/blockNcc.ts
+const blockNcc = base.createBlock({
+	about: { name: "ncc" },
+	addons: { entry: z.string().optional() },
+	intake({ options }) {
+		return { entry: options.packageData?.scripts?.["build:release"]?.match(/ncc build (.+) -o dist/)?.[1] };
+	},
+	produce({ addons }) {
+		const { entry = "src/index.ts" } = addons;
+		return { addons: [
+			blockCSpell({ ignorePaths: ["dist"] }),
+			blockDevelopmentDocs({ sections: { Building: {
+				contents: `
+Run [TypeScript](https://typescriptlang.org) locally to type check and build source files from \`src/\` into output files in \`lib/\`:
+
+\`\`\`shell
+pnpm build
+\`\`\`
+
+Add \`--watch\` to run the builder in a watch mode that continuously cleans and recreates \`lib/\` as you save files:
+
+\`\`\`shell
+pnpm build --watch
+\`\`\`
+`,
+				innerSections: [{
+					contents: `
+Run [\`@vercel/ncc\`](https://github.com/vercel/ncc) to create an output \`dist/\` to be used in production.
+
+\`\`\`shell
+pnpm build:release
+\`\`\`
+		`,
+					heading: "Building for Release"
+				}]
+			} } }),
+			blockESLint({ ignores: ["dist"] }),
+			blockGitHubActionsCI({ jobs: [{
+				name: "Build",
+				steps: [{ run: "pnpm build" }]
+			}, {
+				name: "Build (Release)",
+				steps: [{ run: "pnpm build:release" }]
+			}] }),
+			blockPackageJson({ properties: {
+				devDependencies: { "@vercel/ncc": "^0.38.3" },
+				scripts: {
+					build: "tsc",
+					"build:release": `ncc build ${entry} -o dist`
+				}
+			} }),
+			blockPrettier({ ignores: ["/dist"] })
+		] };
+	}
+});
+//#endregion
+export { blockNcc };

package/dist/blocks/blockNvmrc.d.mts

@@ -0,0 +1,73 @@
+//#region src/blocks/blockNvmrc.d.ts
+declare const blockNvmrc: 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;
+  };
+  node: {
+    minimum: string;
+    pinned?: string | undefined;
+  };
+  owner: string;
+  repository: string;
+  title: string;
+  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?: {
+    color: string;
+    description: string;
+    name: 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;
+  type?: "commonjs" | "module" | undefined;
+  version?: string | undefined;
+  words?: string[] | undefined;
+  workflowsVersions?: Record<string, Record<string, {
+    hash?: string | undefined;
+    pinned?: boolean | undefined;
+  }>> | undefined;
+}>;
+//#endregion
+export { blockNvmrc };

package/dist/blocks/blockNvmrc.mjs

@@ -0,0 +1,17 @@
+import { base } from "../base.mjs";
+import { blockPrettier } from "./blockPrettier.mjs";
+//#region src/blocks/blockNvmrc.ts
+const blockNvmrc = base.createBlock({
+	about: { name: "Nvmrc" },
+	produce({ options }) {
+		return {
+			addons: [blockPrettier({ overrides: [{
+				files: ".nvmrc",
+				options: { parser: "yaml" }
+			}] })],
+			...options.node.pinned && { files: { ".nvmrc": `${options.node.pinned}\n` } }
+		};
+	}
+});
+//#endregion
+export { blockNvmrc };