create-seedcord 0.3.1 → 0.3.3

package/README.md

@@ -6,7 +6,7 @@
 </div>
 
 <div align="center">
-  <h3>The whole Discord bot, wired and typed</h3>
+  <h3>The whole Discord bot, typed end to end</h3>
   <a href="https://seedcord.org">Website</a> ·
   <a href="https://guide.seedcord.org">Guide</a> ·
   <a href="https://docs.seedcord.org">Reference</a> ·
@@ -35,7 +35,7 @@ npm create seedcord my-bot
 yarn create seedcord my-bot
 ```
 
-It asks where the project goes, how Discord reaches your bot, what the bot should react to, your bot token, and an accent color. Then it writes the project, installs, formats, generates your command types, and makes the first commit.
+It asks where the project goes, how Discord reaches your bot, what the bot should react to, your bot token, and an accent color. Then it writes the project, installs, formats, generates your command types, and makes the first commit. A step that fails after the write becomes a warning. The summary still prints.
 
 On Windows, run it from Windows Terminal. The prompts fall back to ASCII in `cmd.exe` making the boxes draw as `T`, `|`, and `o`.
 
@@ -50,9 +50,9 @@ npm create seedcord my-bot -- --transport gateway --capabilities reactions
 pnpm create seedcord my-bot --transport gateway --capabilities reactions
 ```
 
-`--no-install` and `--no-git` turn off those two steps.
+`--no-install` and `--no-git` turn off those two steps. `-v` prints the version and `-h` prints the flag list.
 
-With no terminal to ask on, it reads the flags alone. It names the flag that would supply any answer you left out.
+With no terminal to ask on, it reads the flags alone. It prints the flag that would supply any answer you left out.
 
 ## What you get
 

package/dist/index.mjs

@@ -1922,7 +1922,7 @@ const chalk = createChalk();
 const chalkStderr = createChalk({ level: stderrColor ? stderrColor.level : 0 });
 
 //#endregion
-//#region ../../packages/errors/dist/SeedcordError-C3HkJAhQ.mjs
+//#region ../../packages/errors/dist/SeedcordError-BfC-202u.mjs
 /**
 * All Seedcord error codes.
 */
@@ -1995,6 +1995,8 @@ let SeedcordErrorCode = /* @__PURE__ */ function(SeedcordErrorCode) {
 	SeedcordErrorCode[SeedcordErrorCode["CorePluginKeyHoldsGroup"] = 1216] = "CorePluginKeyHoldsGroup";
 	/** A plugin key is empty, has an empty part, or carries more than one dot. */
 	SeedcordErrorCode[SeedcordErrorCode["CorePluginKeyMalformed"] = 1217] = "CorePluginKeyMalformed";
+	/** An attached plugin doesn't extend the `Plugin` class of the bot's `@seedcord/core`. */
+	SeedcordErrorCode[SeedcordErrorCode["CorePluginFromOtherCore"] = 1218] = "CorePluginFromOtherCore";
 	/** A command decorator attempted to re-register an existing command scope. */
 	SeedcordErrorCode[SeedcordErrorCode["DecoratorCommandAlreadyRegistered"] = 1301] = "DecoratorCommandAlreadyRegistered";
 	/** A global command decorator specified guild IDs, which is not allowed. */
@@ -2135,8 +2137,8 @@ let SeedcordErrorCode = /* @__PURE__ */ function(SeedcordErrorCode) {
 	SeedcordErrorCode[SeedcordErrorCode["CliConfigNotFound"] = 3103] = "CliConfigNotFound";
 	/** CLI entry file does not exist. */
 	SeedcordErrorCode[SeedcordErrorCode["CliEntryNotFound"] = 3104] = "CliEntryNotFound";
-	/** tsx failed to import the provided entry file. */
-	SeedcordErrorCode[SeedcordErrorCode["CliTsxImportFailed"] = 3105] = "CliTsxImportFailed";
+	/** Failed to import a TypeScript entry file. */
+	SeedcordErrorCode[SeedcordErrorCode["CliTsImportFailed"] = 3105] = "CliTsImportFailed";
 	/** Native import and jiti fallback both failed. */
 	SeedcordErrorCode[SeedcordErrorCode["CliImportFailed"] = 3106] = "CliImportFailed";
 	/** Seedcord instance export is missing a start() method. */
@@ -2242,6 +2244,7 @@ const messages = {
 	[1207]: (dir) => `${dir} could not be read.`,
 	[1215]: (head, key) => `${paint.sky(head)} is already taken on this bot, so ${paint.sky(key)} cannot nest under it. Pick another group name.`,
 	[1217]: (key, reason) => `${paint.sky(key)} ${reason} Write a group and a plugin name around one dot, like 'services.users'.`,
+	[1218]: (plugin) => `${paint.sky(plugin)} doesn't extend the ${paint.bold("Plugin")} class your bot uses. That usually means two copies of ${paint.bold("@seedcord/core")} are installed. Update the plugin and your ${paint.bold("@seedcord")} packages to versions that need the same ${paint.bold("@seedcord/core")}. Your package manager can list each installed copy and the package that pulled it in.`,
 	[1216]: (key) => `${paint.sky(key)} already holds a group of plugins. Attach this one under a name of its own.`,
 	[1208]: (key) => `Plugin key "${key}" is a channel the framework logs on. Pick another key.`,
 	[1209]: () => "The bot's application id resolves during startup. You read it before that. Read it inside a handler, inside a plugin's ready(), or after start() resolves.",
@@ -2322,7 +2325,7 @@ const messages = {
 	[3109]: () => "Config must include an `entry` string that points to your startup script.",
 	[3110]: (entryPath, root) => `Entry file ${entryPath} must reside inside configured root ${root}.`,
 	[3104]: (entryPath) => `Cannot find entry file at ${entryPath}.`,
-	[3105]: (entryPath, reason) => `Failed to import ${entryPath} via tsx: ${reason}`,
+	[3105]: (entryPath, reason) => `Failed to import TypeScript file ${entryPath}: ${reason}`,
 	[3106]: (entryPath, nativeReason, fallbackReason) => `Failed to import ${entryPath}: ${nativeReason} (the jiti fallback also failed: ${fallbackReason})`,
 	[3107]: () => "Seedcord instance must default export an object with a start() method.",
 	[3108]: (instancePath, reason) => `Failed to start Seedcord from ${instancePath}: ${reason}`,
@@ -2465,7 +2468,7 @@ function isSeedcordError(error, type, code) {
 
 //#endregion
 //#region src/cli/banner.ts
-function banner(version = "0.3.1") {
+function banner(version = "0.3.3") {
 	const wordmark = `${paint.flesh.bold("seed")}${paint.rind.bold("cord")}${paint.mute(" create")}`;
 	if (version === void 0) return wordmark;
 	return `${wordmark}${paint.pith(` • v${version}`)}`;
@@ -2897,20 +2900,29 @@ const EXTRA = [
 		name: "no-git",
 		description: "skip git init and the first commit"
 	},
+	{
+		name: "version",
+		short: "v",
+		description: "print the version"
+	},
 	{
 		name: "help",
+		short: "h",
 		description: "print this"
 	}
 ];
+function spelling(flag) {
+	return flag.short === void 0 ? `--${flag.name}` : `-${flag.short}, --${flag.name}`;
+}
 function helpText() {
 	const flags = [...STEPS.map((step) => step.flag), ...EXTRA];
-	const width = Math.max(...flags.map((flag) => flag.name.length));
+	const width = Math.max(...flags.map((flag) => spelling(flag).length));
 	return [
 		"Usage: create-seedcord [directory] [flags]",
 		"",
 		"Every question the interview asks has a flag. Pass them all to skip the interview.",
 		"",
-		...flags.map((flag) => `  --${flag.name.padEnd(width)}  ${flag.description}`),
+		...flags.map((flag) => `  ${spelling(flag).padEnd(width)}  ${flag.description}`),
 		"",
 		"npm needs a -- before the flags: npm create seedcord my-bot -- --transport gateway"
 	].join("\n");
@@ -3550,9 +3562,13 @@ const OPTIONS = {
 	"no-git": { type: "boolean" }
 };
 const HELP_FLAGS = /* @__PURE__ */ new Set(["--help", "-h"]);
+const VERSION_FLAGS = /* @__PURE__ */ new Set(["--version", "-v"]);
 function wantsHelp(argv) {
 	return argv.some((argument) => HELP_FLAGS.has(argument));
 }
+function wantsVersion(argv) {
+	return argv.some((argument) => VERSION_FLAGS.has(argument));
+}
 function readArgv(argv) {
 	try {
 		return parseArgs({
@@ -3594,11 +3610,10 @@ const CANCELLED = {
 };
 function reportFailure(error) {
 	if (isSeedcordError(error, void 0, SeedcordErrorCode.CreateCancelled)) return CANCELLED;
-	const kept = isSeedcordError(error, void 0, SeedcordErrorCode.CreateStepFailed);
 	return {
 		code: 1,
 		message: isSeedcordError(error) || Error.isError(error) ? error.message : String(error),
-		closing: kept ? "Project kept. Run the command manually." : "Nothing was created."
+		closing: "Nothing was created."
 	};
 }
 
@@ -3630,6 +3645,10 @@ function silentSteps() {
 	};
 }
 
+//#endregion
+//#region src/cli/version.ts
+const version = "0.3.3";
+
 //#endregion
 //#region src/cli/summary.ts
 const PORTAL = "https://discord.com/developers/applications";
@@ -3667,7 +3686,7 @@ function reproducingCommand(answers, agent) {
 		`--color ${answers.botColor}`
 	];
 	const separator = agent === "npm" ? "-- " : "";
-	return `${agent} create seedcord ${answers.directory} ${separator}${flags.join(" ")}`;
+	return `${agent} create seedcord@${version} ${answers.directory} ${separator}${flags.join(" ")}`;
 }
 
 //#endregion
@@ -3705,17 +3724,33 @@ async function probeCloudflared(binary = "cloudflared", timeout = PROBE_TIMEOUT_
 
 //#endregion
 //#region src/scaffold/exec.ts
-const KEPT_LINES = 12;
-const NAMES_THE_CAUSE = /error|ERR!/i;
+const NAMES_THE_CAUSE = /error|ERR[_!]/i;
+const BLOCKED_BUILD = /ERR_PNPM_IGNORED_BUILDS/;
+const INDENTED = /^\s/;
 const LINE_BREAK = /[\r\n]+/;
 const PIPED_COLUMNS = 100;
 const GUTTER = 3;
 function lineWidth() {
 	return (process$1.stdout.columns > 0 ? process$1.stdout.columns : PIPED_COLUMNS) - GUTTER;
 }
+function blockFrom(header, rest) {
+	const detail = [];
+	for (const line of rest) {
+		if (!INDENTED.test(line)) break;
+		detail.push(line);
+	}
+	return [header, ...detail];
+}
 function failureLines(captured) {
-	const named = captured.filter((line) => NAMES_THE_CAUSE.test(line));
-	return named.length > 0 ? named.slice(0, KEPT_LINES) : captured.slice(-12);
+	const blocks = [];
+	let consumedThrough = -1;
+	for (const [index, line] of captured.entries()) {
+		if (index <= consumedThrough || !NAMES_THE_CAUSE.test(line)) continue;
+		const block = blockFrom(line, captured.slice(index + 1));
+		blocks.push(...block);
+		consumedThrough = index + block.length - 1;
+	}
+	return (blocks.length > 0 ? blocks : captured).slice(-12);
 }
 const SHIMS = /* @__PURE__ */ new Set([
 	"npm",
@@ -3750,8 +3785,8 @@ async function execRunner(...[command, args, cwd]) {
 		const captured = [];
 		const take = (chunk) => {
 			for (const line of chunk.toString("utf8").split(LINE_BREAK)) {
-				const text = line.trim().slice(0, width);
-				if (text === "") continue;
+				const text = line.trimEnd().slice(0, width);
+				if (text.trim() === "") continue;
 				captured.push(text);
 			}
 		};
@@ -3762,10 +3797,14 @@ async function execRunner(...[command, args, cwd]) {
 		});
 		child.on("close", (code) => {
 			if (code === 0) {
-				resolve();
+				resolve(null);
 				return;
 			}
 			const shown = failureLines(captured).join("\n");
+			if (captured.some((line) => BLOCKED_BUILD.test(line))) {
+				resolve(shown);
+				return;
+			}
 			reject(new SeedcordError(SeedcordErrorCode.CreateStepFailed, [spoken, shown || `exited with ${code}`]));
 		});
 	});
@@ -11117,10 +11156,25 @@ async function renderTemplates(templatesRoot, context) {
 
 //#endregion
 //#region src/scaffold/scaffold.ts
+const INSTALL_STEPS = {
+	install: {
+		running: "Installing dependencies",
+		done: "Dependencies installed"
+	},
+	format: {
+		running: "Formatting",
+		done: "Code formatted"
+	},
+	codegen: {
+		running: "Generating types",
+		done: "Types generated"
+	}
+};
 const DEV_PACKAGES = [
 	"@seedcord/eslint-config",
 	"@seedcord/tsconfig",
 	"@types/node",
+	"eslint",
 	"jiti",
 	"prettier",
 	"seedcord",
@@ -11137,25 +11191,42 @@ async function writeTree(target, files) {
 		await writeFile(destination, file.contents, "utf8");
 	}
 }
-async function runGitSteps(input, run) {
+async function runStep(steps, labels, work) {
 	try {
-		await input.steps.run({
-			running: "Setting up git",
-			done: "Committed"
-		}, async () => {
-			await run("git", ["init"], input.target);
-			await run("git", ["add", "."], input.target);
-			await run("git", [
-				"commit",
-				"-m",
-				"chore: create seedcord bot"
-			], input.target);
-		});
+		await steps.run(labels, work);
 		return null;
 	} catch (error) {
-		return `${Error.isError(error) ? error.message : String(error)} The project is complete and uncommitted.`;
+		return Error.isError(error) ? error.message : String(error);
 	}
 }
+async function gitNoticeFor(input, run, plan) {
+	if (!plan.init) {
+		input.steps.skip("Committed");
+		return plan.notice;
+	}
+	const reason = await runStep(input.steps, {
+		running: "Setting up git",
+		done: "Committed"
+	}, async () => {
+		await run("git", ["init"], input.target);
+		await run("git", ["add", "."], input.target);
+		await run("git", [
+			"commit",
+			"-m",
+			"chore: create seedcord bot"
+		], input.target);
+	});
+	if (reason === null) return plan.notice;
+	return `${reason} The project is complete and uncommitted.`;
+}
+function skipInstallSteps(steps) {
+	for (const labels of Object.values(INSTALL_STEPS)) steps.skip(labels.done);
+	return {
+		installed: false,
+		notices: [],
+		failed: false
+	};
+}
 async function runInstallSteps(input, run, isGateway) {
 	const { agent, steps, target } = input;
 	const deps = addCommand(agent, runtimePackages(isGateway), false);
@@ -11166,66 +11237,67 @@ async function runInstallSteps(input, run, isGateway) {
 		"."
 	]);
 	const codegen = execCommand(agent, ["seedcord", "codegen"]);
-	await steps.run({
-		running: "Installing dependencies",
-		done: "Dependencies installed"
-	}, async () => {
-		await run(deps.command, deps.args, target);
-		await run(dev.command, dev.args, target);
+	const warnings = [];
+	const collect = (warning) => {
+		if (warning !== null) warnings.push(warning);
+	};
+	const install = await runStep(steps, INSTALL_STEPS.install, async () => {
+		collect(await run(deps.command, deps.args, target));
+		collect(await run(dev.command, dev.args, target));
 	});
-	await steps.run({
-		running: "Formatting",
-		done: "Code formatted"
-	}, () => run(format.command, format.args, target));
-	await steps.run({
-		running: "Generating types",
-		done: "Types generated"
-	}, () => run(codegen.command, codegen.args, target));
+	if (install !== null) {
+		steps.skip(INSTALL_STEPS.format.done);
+		steps.skip(INSTALL_STEPS.codegen.done);
+		return {
+			installed: false,
+			notices: [install, ...warnings],
+			failed: true
+		};
+	}
+	const failures = [await runStep(steps, INSTALL_STEPS.format, () => run(format.command, format.args, target)), await runStep(steps, INSTALL_STEPS.codegen, () => run(codegen.command, codegen.args, target))].filter((reason) => reason !== null);
+	return {
+		installed: true,
+		notices: [...warnings, ...failures],
+		failed: failures.length > 0
+	};
 }
-async function scaffold(input, run) {
-	const { existed } = await claimTarget(input.target);
-	const parent = dirname(input.target);
-	await mkdir(parent, { recursive: true });
-	const plan = gitPlanFrom(await probeGit(parent), input.git);
-	let written = false;
+async function writeProject(input, plan, existed) {
+	const context = buildContext(input.answers, {
+		developerUsername: plan.developerUsername,
+		runCommand: runPrefix(input.agent)
+	});
 	try {
-		const context = buildContext(input.answers, {
-			developerUsername: plan.developerUsername,
-			runCommand: runPrefix(input.agent)
-		});
-		const { steps } = input;
-		await steps.run({
+		await input.steps.run({
 			running: "Writing files",
 			done: "Files written"
 		}, async () => {
 			await mkdir(input.target, { recursive: true });
 			await writeTree(input.target, await renderTemplates(input.templatesRoot, context));
 		});
-		written = true;
-		if (input.install) await runInstallSteps(input, run, context.isGateway);
-		else {
-			steps.skip("Dependencies installed");
-			steps.skip("Code formatted");
-			steps.skip("Types generated");
-		}
-		let gitNotice = plan.notice;
-		if (plan.init) gitNotice = await runGitSteps(input, run) ?? gitNotice;
-		else steps.skip("Committed");
-		return {
-			installed: input.install,
-			gitNotice
-		};
+		return context;
 	} catch (error) {
-		if (!written) {
-			await rm(input.target, {
-				recursive: true,
-				force: true
-			});
-			if (existed) await mkdir(input.target, { recursive: true });
-		}
+		await rm(input.target, {
+			recursive: true,
+			force: true
+		});
+		if (existed) await mkdir(input.target, { recursive: true });
 		throw error;
 	}
 }
+async function scaffold(input, run) {
+	const { existed } = await claimTarget(input.target);
+	const parent = dirname(input.target);
+	await mkdir(parent, { recursive: true });
+	const plan = gitPlanFrom(await probeGit(parent), input.git);
+	const context = await writeProject(input, plan, existed);
+	const outcome = input.install ? await runInstallSteps(input, run, context.isGateway) : skipInstallSteps(input.steps);
+	const gitNotice = await gitNoticeFor(input, run, plan);
+	return {
+		installed: outcome.installed,
+		notices: gitNotice === null ? outcome.notices : [...outcome.notices, gitNotice],
+		failed: outcome.failed
+	};
+}
 
 //#endregion
 //#region src/index.ts
@@ -11242,6 +11314,10 @@ async function main() {
 		process$1.stdout.write(`${helpText()}\n`);
 		return;
 	}
+	if (wantsVersion(argv)) {
+		process$1.stdout.write(`${version}\n`);
+		return;
+	}
 	const interactive = isInteractive();
 	if (interactive) intro(banner());
 	const input = parseInput(argv);
@@ -11257,8 +11333,9 @@ async function main() {
 		git: input.git,
 		steps: interactive ? clackSteps() : silentSteps()
 	}, execRunner);
-	if (result.gitNotice !== null) log.warn(result.gitNotice);
+	for (const notice of result.notices) log.warn(notice);
 	await reportOutcome(answers, agent, result.installed, interactive);
+	if (result.failed) process$1.exitCode = 1;
 }
 function copyable(label, value) {
 	log.message(paint.mute(label));