create-typescript-app 2.5.0 → 2.6.1

package/lib/options/readEmailFromGit.d.ts

@@ -0,0 +1,5 @@
+import { TakeInput } from 'bingo';
+
+declare function readEmailFromGit(take: TakeInput): Promise<string | undefined>;
+
+export { readEmailFromGit };

package/lib/options/readEmailFromGit.js

@@ -0,0 +1,7 @@
+import { inputFromScript } from "input-from-script";
+async function readEmailFromGit(take) {
+  return (await take(inputFromScript, { command: "git config --get user.email" })).stdout?.toString();
+}
+export {
+  readEmailFromGit
+};

package/lib/options/readEmailFromNpm.d.ts

@@ -0,0 +1,7 @@
+import { UserInfo } from 'npm-user';
+
+declare function readEmailFromNpm(getNpmDefaults: () => Promise<undefined | UserInfo>, getPackageAuthor: () => Promise<{
+    email: string | undefined;
+}>): Promise<string | undefined>;
+
+export { readEmailFromNpm };

package/lib/options/readEmailFromNpm.js

@@ -0,0 +1,6 @@
+async function readEmailFromNpm(getNpmDefaults, getPackageAuthor) {
+  return (await getNpmDefaults())?.email ?? (await getPackageAuthor()).email;
+}
+export {
+  readEmailFromNpm
+};

package/lib/options/readEmails.d.ts

@@ -1,9 +1,4 @@
-import { UserInfo } from 'npm-user';
-
-declare function readEmails(npmDefaults: () => Promise<undefined | UserInfo>, packageAuthor: () => Promise<{
-    author: string | undefined;
-    email: string | undefined;
-}>): Promise<{
+declare function readEmails(getEmailFromCodeOfConduct: () => Promise<string | undefined>, getEmailFromGit: () => Promise<string | undefined>, getEmailFromNpm: () => Promise<string | undefined>): Promise<{
     github: string;
     npm: string;
 } | undefined>;

package/lib/options/readEmails.js

@@ -1,11 +1,6 @@
-import { $ } from "execa";
-import { tryCatchAsync } from "../utils/tryCatchAsync.js";
-import { readGitHubEmail } from "./readGitHubEmail.js";
-async function readEmails(npmDefaults, packageAuthor) {
-  const github = await readGitHubEmail() ?? await tryCatchAsync(
-    async () => (await $`git config --get user.email`).stdout
-  );
-  const npm = ((await npmDefaults())?.email ?? (await packageAuthor()).email) || github;
+async function readEmails(getEmailFromCodeOfConduct, getEmailFromGit, getEmailFromNpm) {
+  const github = await getEmailFromCodeOfConduct() ?? await getEmailFromGit();
+  const npm = await getEmailFromNpm() ?? github;
   return npm ? { github: github || npm, npm } : void 0;
 }
 export {

package/lib/options/readEmoji.d.ts

@@ -0,0 +1,3 @@
+declare function readEmoji(getDescription: () => Promise<string | undefined>): Promise<string>;
+
+export { readEmoji };

package/lib/options/readEmoji.js

@@ -0,0 +1,6 @@
+async function readEmoji(getDescription) {
+  return (await getDescription())?.match(/\p{Extended_Pictographic}/gu)?.at(-1) ?? "\u{1F496}";
+}
+export {
+  readEmoji
+};

package/lib/options/readExistingLabels.d.ts

@@ -0,0 +1,9 @@
+import { TakeInput } from 'bingo';
+
+declare function readExistingLabels(take: TakeInput, getOwner: () => Promise<string | undefined>, getRepository: () => Promise<string | undefined>): Promise<{
+    color: string;
+    description: string;
+    name: string;
+}[]>;
+
+export { readExistingLabels };

package/lib/options/{getExistingLabels.js → readExistingLabels.js}

@@ -1,6 +1,7 @@
 import { githubDefaultLabels } from "github-default-labels";
 import { inputFromOctokit } from "../inputs/inputFromOctokit.js";
-async function getExistingLabels(take, owner, repository) {
+async function readExistingLabels(take, getOwner, getRepository) {
+  const [owner, repository] = await Promise.all([getOwner(), getRepository()]);
   const existingLabelsActual = owner && repository && await take(inputFromOctokit, {
     endpoint: "GET /repos/{owner}/{repo}/labels",
     options: {
@@ -18,5 +19,5 @@ async function getExistingLabels(take, owner, repository) {
   return githubDefaultLabels;
 }
 export {
-  getExistingLabels
+  readExistingLabels
 };

package/lib/options/readExplainer.d.ts

@@ -0,0 +1,3 @@
+declare function readExplainer(getReadme: () => Promise<string>): Promise<string[] | undefined>;
+
+export { readExplainer };

package/lib/options/readExplainer.js

@@ -0,0 +1,12 @@
+async function readExplainer(getReadme) {
+  const readme = await getReadme();
+  const indexOfH2 = readme.indexOf("##");
+  if (indexOfH2 === -1) {
+    return void 0;
+  }
+  const lastTag = readme.slice(0, indexOfH2).lastIndexOf(">");
+  return readme.slice(lastTag + 1, indexOfH2).split("\n").map((line) => line.trim()).filter(Boolean);
+}
+export {
+  readExplainer
+};

package/lib/options/readFunding.d.ts

@@ -1,3 +1,5 @@
-declare function readFunding(): Promise<string | undefined>;
+import { TakeInput } from 'bingo';
+
+declare function readFunding(take: TakeInput): Promise<string | undefined>;
 
 export { readFunding };

package/lib/options/readFunding.js

@@ -1,9 +1,9 @@
-import fs from "node:fs/promises";
-import { tryCatchAsync } from "../utils/tryCatchAsync.js";
-async function readFunding() {
-  return await tryCatchAsync(
-    async () => (await fs.readFile(".github/FUNDING.yml")).toString().split(":")[1]?.trim()
-  );
+import { inputFromFile } from "input-from-file";
+import { swallowError } from "../utils/swallowError.js";
+async function readFunding(take) {
+  return swallowError(
+    await take(inputFromFile, { filePath: ".github/FUNDING.yml" })
+  )?.split(":")[1]?.trim();
 }
 export {
   readFunding

package/lib/options/readGitDefaults.d.ts

@@ -0,0 +1,5 @@
+import gitUrlParse from 'git-url-parse';
+
+declare function readGitDefaults(): Promise<gitUrlParse.GitUrl | undefined>;
+
+export { readGitDefaults };

package/lib/options/readGitDefaults.js

@@ -0,0 +1,12 @@
+import gitRemoteOriginUrl from "git-remote-origin-url";
+import gitUrlParse from "git-url-parse";
+async function readGitDefaults() {
+  try {
+    return gitUrlParse(await gitRemoteOriginUrl());
+  } catch {
+    return void 0;
+  }
+}
+export {
+  readGitDefaults
+};

package/lib/options/readGuide.d.ts

@@ -1,4 +1,6 @@
-declare function readGuide(): Promise<{
+import { TakeInput } from 'bingo';
+
+declare function readGuide(take: TakeInput): Promise<{
     href: string;
     title: string;
 } | undefined>;

package/lib/options/readGuide.js

@@ -1,6 +1,11 @@
-import { readFileSafe } from "./readFileSafe.js";
-async function readGuide() {
-  const development = await readFileSafe(".github/DEVELOPMENT.md", "");
+import { inputFromFile } from "input-from-file";
+async function readGuide(take) {
+  const development = await take(inputFromFile, {
+    filePath: ".github/DEVELOPMENT.md"
+  });
+  if (development instanceof Error) {
+    return void 0;
+  }
   const tag = /> .*guided walkthrough, see \[((?!\[).+)\]\((.+)\)/i.exec(
     development
   );

package/lib/options/readLogo.d.ts

@@ -0,0 +1,8 @@
+declare function readLogo(getReadme: () => Promise<string>): Promise<{
+    height?: number;
+    width?: number;
+    alt: string;
+    src: string;
+} | undefined>;
+
+export { readLogo };

package/lib/options/readLogo.js

@@ -0,0 +1,19 @@
+import { readLogoSizing } from "./readLogoSizing.js";
+async function readLogo(getReadme) {
+  const tag = /\n<img.+src=.+>/.exec(await getReadme())?.[0];
+  if (!tag) {
+    return void 0;
+  }
+  const src = /src\s*=(.+)['"/]>/.exec(tag)?.[1]?.split(/\s*\w+=/)[0].replaceAll(/^['"]|['"]$/g, "");
+  if (!src) {
+    return void 0;
+  }
+  return {
+    alt: /alt=['"](.+)['"]\s*src=/.exec(tag)?.[1].split(/['"]?\s*\w+=/)[0] ?? "Project logo",
+    src,
+    ...readLogoSizing(src)
+  };
+}
+export {
+  readLogo
+};

package/lib/options/readNode.d.ts

@@ -0,0 +1,8 @@
+import { PartialPackageData } from '../types.js';
+
+declare function readNode(getNvmrc: () => Promise<Error | string>, getPackageDataFull: () => Promise<PartialPackageData>): Promise<{
+    minimum: string;
+    pinned: string;
+}>;
+
+export { readNode };

package/lib/options/readNode.js

@@ -0,0 +1,12 @@
+import { defaults } from "../constants.js";
+import { swallowError } from "../utils/swallowError.js";
+async function readNode(getNvmrc, getPackageDataFull) {
+  const { engines } = await getPackageDataFull();
+  return {
+    minimum: (engines?.node && /[\d+.]+/.exec(engines.node))?.[0] ?? defaults.node.minimum,
+    pinned: swallowError(await getNvmrc())?.trim() || defaults.node.pinned
+  };
+}
+export {
+  readNode
+};

package/lib/options/readNpmDefaults.d.ts

@@ -0,0 +1,6 @@
+import * as npm_user from 'npm-user';
+import { ExecaError, Result } from 'execa';
+
+declare function readNpmDefaults(getNpmWhoami: () => Promise<ExecaError | Result | undefined>): Promise<npm_user.UserInfo | undefined>;
+
+export { readNpmDefaults };

package/lib/options/readNpmDefaults.js

@@ -0,0 +1,9 @@
+import npmUser from "npm-user";
+import { swallowErrorAsync } from "../utils/swallowErrorAsync.js";
+async function readNpmDefaults(getNpmWhoami) {
+  const whoami = await getNpmWhoami();
+  return typeof whoami?.stdout === "string" ? await swallowErrorAsync(npmUser(whoami.stdout)) : void 0;
+}
+export {
+  readNpmDefaults
+};

package/lib/options/readOwner.d.ts

@@ -0,0 +1,8 @@
+import { TakeInput } from 'bingo';
+import { GitUrl } from 'git-url-parse';
+
+declare function readOwner(take: TakeInput, getGitDefaults: () => Promise<GitUrl | undefined>, getPackageAuthor: () => Promise<{
+    author?: string;
+}>): Promise<string | undefined>;
+
+export { readOwner };

package/lib/options/readOwner.js

@@ -0,0 +1,9 @@
+import { inputFromScript } from "input-from-script";
+async function readOwner(take, getGitDefaults, getPackageAuthor) {
+  return (await getGitDefaults())?.organization ?? (await getPackageAuthor()).author ?? (await take(inputFromScript, {
+    command: "gh config get user -h github.com"
+  })).stdout?.toString();
+}
+export {
+  readOwner
+};

package/lib/options/readPackageAuthor.d.ts

@@ -0,0 +1,8 @@
+import { PartialPackageData } from '../types.js';
+
+declare function readPackageAuthor(getPackageDataFull: () => Promise<PartialPackageData>): Promise<{
+    author: string | undefined;
+    email: string | undefined;
+}>;
+
+export { readPackageAuthor };

package/lib/options/{parsePackageAuthor.js → readPackageAuthor.js}

@@ -1,5 +1,6 @@
 import parse from "parse-author";
-function parsePackageAuthor(packageData) {
+async function readPackageAuthor(getPackageDataFull) {
+  const packageData = await getPackageDataFull();
   let packageAuthor;
   let packageEmail;
   if (typeof packageData.author === "string") {
@@ -16,5 +17,5 @@ function parsePackageAuthor(packageData) {
   };
 }
 export {
-  parsePackageAuthor
+  readPackageAuthor
 };

package/lib/options/readPackageData.d.ts

@@ -1,5 +1,9 @@
 import { PartialPackageData } from '../types.js';
 
-declare function readPackageData(): Promise<PartialPackageData>;
+declare function readPackageData(getPackageDataFull: () => Promise<PartialPackageData>): Promise<{
+    dependencies: Record<string, string> | undefined;
+    devDependencies: Record<string, string> | undefined;
+    scripts: Record<string, string> | undefined;
+}>;
 
 export { readPackageData };

package/lib/options/readPackageData.js

@@ -1,6 +1,10 @@
-import { readFileSafe } from "./readFileSafe.js";
-async function readPackageData() {
-  return JSON.parse(await readFileSafe("./package.json", "{}")) ?? {};
+async function readPackageData(getPackageDataFull) {
+  const original = await getPackageDataFull();
+  return {
+    dependencies: original.dependencies,
+    devDependencies: original.devDependencies,
+    scripts: original.scripts
+  };
 }
 export {
   readPackageData

package/lib/options/readPackageDataFull.d.ts

@@ -0,0 +1,6 @@
+import { TakeInput } from 'bingo';
+import { PartialPackageData } from '../types.js';
+
+declare function readPackageDataFull(take: TakeInput): Promise<PartialPackageData>;
+
+export { readPackageDataFull };

package/lib/options/readPackageDataFull.js

@@ -0,0 +1,9 @@
+import { inputFromFileJSON } from "input-from-file-json";
+async function readPackageDataFull(take) {
+  return await take(inputFromFileJSON, {
+    filePath: "./package.json"
+  }) ?? {};
+}
+export {
+  readPackageDataFull
+};

package/lib/options/readRepository.d.ts

@@ -0,0 +1,9 @@
+import { GitUrl } from 'git-url-parse';
+import { PartialPackageData } from '../types.js';
+
+declare function readRepository(getGitDefaults: () => Promise<GitUrl | undefined>, getPackageDataFull: () => Promise<PartialPackageData>, options: {
+    directory?: string;
+    repository?: string;
+}): Promise<string | undefined>;
+
+export { readRepository };

package/lib/options/readRepository.js

@@ -0,0 +1,6 @@
+async function readRepository(getGitDefaults, getPackageDataFull, options) {
+  return options.repository ?? (await getGitDefaults())?.name ?? (await getPackageDataFull()).name ?? options.directory;
+}
+export {
+  readRepository
+};

package/lib/options/readRulesetId.d.ts

@@ -0,0 +1,5 @@
+import { TakeInput } from 'bingo';
+
+declare function readRulesetId(take: TakeInput, getOwner: () => Promise<string | undefined>, getRepository: () => Promise<string | undefined>): Promise<string | undefined>;
+
+export { readRulesetId };

package/lib/options/readRulesetId.js

@@ -0,0 +1,16 @@
+import { inputFromOctokit } from "../inputs/inputFromOctokit.js";
+async function readRulesetId(take, getOwner, getRepository) {
+  const rulesets = await take(inputFromOctokit, {
+    endpoint: "GET /repos/{owner}/{repo}/rulesets",
+    options: {
+      owner: await getOwner(),
+      repo: await getRepository()
+    }
+  });
+  return rulesets?.find(
+    (ruleset) => ruleset.name === "Branch protection for main"
+  )?.id;
+}
+export {
+  readRulesetId
+};

package/lib/options/readTitle.d.ts

@@ -0,0 +1,3 @@
+declare function readTitle(getReadme: () => Promise<string>, getRepository: () => Promise<string | undefined>): Promise<string | undefined>;
+
+export { readTitle };

package/lib/options/readTitle.js

@@ -0,0 +1,13 @@
+import { titleCase } from "title-case";
+async function readTitle(getReadme, getRepository) {
+  const text = await getReadme();
+  const fromText = (/^<h1\s+align="center">(.+)<\/h1>/.exec(text) ?? /^# (.+)/.exec(text))?.[1];
+  if (fromText) {
+    return fromText;
+  }
+  const repositoryValue = await getRepository();
+  return repositoryValue && titleCase(repositoryValue).replaceAll("Eslint", "ESLint").replaceAll("Typescript", "TypeScript").replaceAll("-", " ");
+}
+export {
+  readTitle
+};

package/lib/options/readUsage.d.ts

@@ -0,0 +1,3 @@
+declare function readUsage(getEmoji: () => Promise<string>, getReadme: () => Promise<string>, getRepository: () => Promise<string | undefined>): Promise<string>;
+
+export { readUsage };

package/lib/options/readUsage.js

@@ -0,0 +1,14 @@
+import { readUsageFromReadme } from "./readUsageFromReadme.js";
+async function readUsage(getEmoji, getReadme, getRepository) {
+  return readUsageFromReadme(await getReadme()) ?? `\`\`\`shell
+npm i ${await getRepository()}
+\`\`\`
+\`\`\`ts
+import { greet } from "${await getRepository()}";
+
+greet("Hello, world! ${await getEmoji()}");
+\`\`\``;
+}
+export {
+  readUsage
+};

package/lib/options/readUsageFromReadme.d.ts

@@ -0,0 +1,3 @@
+declare function readUsageFromReadme(readme: string): string | undefined;
+
+export { readUsageFromReadme };

package/lib/options/{getUsageFromReadme.js → readUsageFromReadme.js}

@@ -1,6 +1,6 @@
 const startDevelopment = "## Development";
 const startUsage = "## Usage";
-function getUsageFromReadme(readme) {
+function readUsageFromReadme(readme) {
   const indexOfUsage = readme.indexOf(startUsage);
   if (indexOfUsage === -1) {
     return void 0;
@@ -16,5 +16,5 @@ function getUsageFromReadme(readme) {
   return usage ? usage : void 0;
 }
 export {
-  getUsageFromReadme
+  readUsageFromReadme
 };

package/lib/presets/common.d.ts

@@ -43,6 +43,7 @@ declare const presetCommon: bingo_stratum.Preset<{
         github: string;
         npm: string;
     }>;
+    emoji: zod.ZodOptional<zod.ZodString>;
     existingLabels: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
         color: zod.ZodString;
         description: zod.ZodString;

package/lib/presets/everything.d.ts

@@ -43,6 +43,7 @@ declare const presetEverything: bingo_stratum.Preset<{
         github: string;
         npm: string;
     }>;
+    emoji: zod.ZodOptional<zod.ZodString>;
     existingLabels: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
         color: zod.ZodString;
         description: zod.ZodString;

package/lib/presets/index.d.ts

@@ -47,6 +47,7 @@ declare const presets: {
             github: string;
             npm: string;
         }>;
+        emoji: zod.ZodOptional<zod.ZodString>;
         existingLabels: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
             color: zod.ZodString;
             description: zod.ZodString;
@@ -162,6 +163,7 @@ declare const presets: {
             github: string;
             npm: string;
         }>;
+        emoji: zod.ZodOptional<zod.ZodString>;
         existingLabels: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
             color: zod.ZodString;
             description: zod.ZodString;
@@ -277,6 +279,7 @@ declare const presets: {
             github: string;
             npm: string;
         }>;
+        emoji: zod.ZodOptional<zod.ZodString>;
         existingLabels: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
             color: zod.ZodString;
             description: zod.ZodString;

package/lib/presets/minimal.d.ts

@@ -43,6 +43,7 @@ declare const presetMinimal: bingo_stratum.Preset<{
         github: string;
         npm: string;
     }>;
+    emoji: zod.ZodOptional<zod.ZodString>;
     existingLabels: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
         color: zod.ZodString;
         description: zod.ZodString;

package/lib/template.d.ts

@@ -43,6 +43,7 @@ declare const template: bingo_stratum_lib_types_templates_js.StratumTemplate<{
         github: string;
         npm: string;
     }>;
+    emoji: zod.ZodOptional<zod.ZodString>;
     existingLabels: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
         color: zod.ZodString;
         description: zod.ZodString;

package/lib/utils/swallowErrorAsync.d.ts

@@ -0,0 +1,3 @@
+declare function swallowErrorAsync<T>(task: Promise<T>): Promise<T | undefined>;
+
+export { swallowErrorAsync };

package/lib/utils/swallowErrorAsync.js

@@ -0,0 +1,10 @@
+async function swallowErrorAsync(task) {
+  try {
+    return await task;
+  } catch {
+    return void 0;
+  }
+}
+export {
+  swallowErrorAsync
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "create-typescript-app",
-	"version": "2.5.0",
+	"version": "2.6.1",
 	"description": "Quickstart-friendly TypeScript template with comprehensive, configurable, opinionated tooling. 🎁",
 	"repository": {
 		"type": "git",
@@ -90,7 +90,7 @@
 		"eslint-plugin-markdown": "5.1.0",
 		"eslint-plugin-n": "17.16.2",
 		"eslint-plugin-package-json": "0.26.2",
-		"eslint-plugin-perfectionist": "4.9.0",
+		"eslint-plugin-perfectionist": "4.10.0",
 		"eslint-plugin-regexp": "2.7.0",
 		"eslint-plugin-yml": "1.17.0",
 		"husky": "9.1.7",
@@ -110,7 +110,7 @@
 		"typescript-eslint": "8.26.0",
 		"vitest": "3.0.7"
 	},
-	"packageManager": "pnpm@10.5.2",
+	"packageManager": "pnpm@10.6.0",
 	"engines": {
 		"node": ">=18.3.0"
 	},

package/lib/options/getExistingLabels.d.ts

@@ -1,9 +0,0 @@
-import { TakeInput } from 'bingo';
-
-declare function getExistingLabels(take: TakeInput, owner: string | undefined, repository: string | undefined): Promise<{
-    color: string;
-    description: string;
-    name: string;
-}[]>;
-
-export { getExistingLabels };

package/lib/options/getUsageFromReadme.d.ts

@@ -1,3 +0,0 @@
-declare function getUsageFromReadme(readme: string): string | undefined;
-
-export { getUsageFromReadme };

package/lib/options/parsePackageAuthor.d.ts

@@ -1,8 +0,0 @@
-import { PartialPackageData } from '../types.js';
-
-declare function parsePackageAuthor(packageData: PartialPackageData): {
-    author: string | undefined;
-    email: string | undefined;
-};
-
-export { parsePackageAuthor };

package/lib/options/readDefaultsFromReadme.d.ts

@@ -1,13 +0,0 @@
-declare function readDefaultsFromReadme(readme: () => Promise<string>, repository: () => Promise<string | undefined>): {
-    explainer: () => Promise<string[] | undefined>;
-    logo: () => Promise<{
-        height?: number;
-        width?: number;
-        alt: string;
-        src: string;
-    } | undefined>;
-    title: () => Promise<string | undefined>;
-    usage: () => Promise<string>;
-};
-
-export { readDefaultsFromReadme };