seedcord 0.17.4 → 0.18.0

package/README.md

@@ -1,18 +1,67 @@
-<p align="center">
+<div align="center">
   <picture>
     <source media="(prefers-color-scheme: dark)" srcset="https://cdn.seedcord.org/assets/wordmark-dark.webp" />
     <img src="https://cdn.seedcord.org/assets/wordmark-light.webp" alt="seedcord" width="440" />
   </picture>
-</p>
+</div>
 
----
+<div align="center">
+  <h3>The whole Discord bot, wired and typed</h3>
+  <a href="https://seedcord.org">Website</a> ·
+  <a href="https://guide.seedcord.org">Guide</a> ·
+  <a href="https://docs.seedcord.org">Reference</a> ·
+  <a href="https://discord.gg/DzFxY58WXf">Discord</a>
+</div>
 
-The seedcord CLI and dev tooling.
+<br />
 
-_This repository is a work in progress._
+<div align="center">
 
-- There are no stable releases yet but changes are being made actively.
-- Until a major v1.0.0 release for seedcord, expect breaking changes in minor versions.
-- Documentation will come soon as well!
+[![npm](https://img.shields.io/npm/v/seedcord?style=flat-square&logo=npm&logoColor=c8341f&label=&labelColor=1f1f1f&color=c8341f)](https://www.npmjs.com/package/seedcord) [![node](https://img.shields.io/node/v/seedcord?style=flat-square&label=node&labelColor=1f1f1f&color=4d7d33)](https://nodejs.org) [![license](https://img.shields.io/npm/l/seedcord?style=flat-square&label=license&labelColor=1f1f1f&color=f8f6e8)](LICENSE)
 
-If you'd like to try it out, you can check out the code in `mock`
+</div>
+
+## About
+
+`seedcord` is the CLI a bot project runs during development and at build time. It reads `seedcord.config.ts` and gives you a dev server with hot reload, a production build, the codegen that types your commands, and a cleanup tool for stale guild commands.
+
+Until v1.0.0, minor versions can break.
+
+## Installation
+
+`pnpm create seedcord` adds it to a new project. To add it to an existing one:
+
+```sh
+pnpm add -D seedcord
+```
+
+## Commands
+
+<!-- prettier-ignore-start -->
+
+| command | what it does |
+| --- | --- |
+| `seedcord dev` | runs the bot from the config file, reloading changed modules in place |
+| `seedcord build` | compiles the project from the config file |
+| `seedcord codegen` | writes the typed augmentations for your commands and config |
+| `seedcord commands` | inspects and cleans commands already deployed to Discord |
+
+<!-- prettier-ignore-end -->
+
+`codegen --check` verifies the committed augmentations match your source. Run it in CI.
+
+`commands --clean` reports guild commands that duplicate a global one. It runs as a dry run until you pass `--apply`.
+
+On the http transport, `dev` also opens a cloudflared tunnel and points Discord's interactions URL at it.
+
+## Config
+
+`defineConfig` types `seedcord.config.ts`:
+
+```ts
+import { defineConfig } from 'seedcord';
+
+export default defineConfig({
+    // ...
+});
+```

package/dist/cli.mjs

@@ -1,10 +1,10 @@
-import { n as SEEDCORD_CONFIG_FILENAMES, t as version } from "./src-i-qherg7.mjs";
+import { n as SEEDCORD_CONFIG_FILENAMES, t as version } from "./src-duSEbkfe.mjs";
 import { createRequire } from "node:module";
 import { Command } from "@commander-js/extra-typings";
-import { LEVEL_COLOR, Logger, LoggerChannelRegistry, paint } from "@seedcord/logger";
+import { LEVEL_COLOR, Logger, LoggerChannelRegistry } from "@seedcord/logger";
 import { formatBody, installNodeDefaults } from "@seedcord/logger/node";
 import { Envapter, Environment } from "envapt";
-import { SeedcordErrorCode, isSeedcordError } from "@seedcord/errors";
+import { SeedcordErrorCode, isSeedcordError, paint } from "@seedcord/errors";
 import { existsSync, realpathSync } from "node:fs";
 import { BRAND, SeedcordError, validateDiscordToken } from "@seedcord/errors/internal";
 import { delimiter, dirname, extname, isAbsolute, join, relative, resolve, sep } from "node:path";
@@ -18,7 +18,6 @@ import { isTsOrJsFile } from "@seedcord/utils/node";
 import { ApplicationCommandOptionType, ApplicationCommandType, RESTJSONErrorCodes, Routes } from "discord-api-types/v10";
 import { routeLeavesOf } from "@seedcord/utils/internal";
 import { DiscordAPIError, REST } from "@discordjs/rest";
-import chalk from "chalk";
 import { autocompleteMultiselect, cancel, confirm, intro, isCancel, log, multiselect, note, outro, select, spinner } from "@clack/prompts";
 import { createInterface } from "node:readline";
 import { Box, Text, measureElement, render, useAnimation, useInput, useWindowSize } from "ink";
@@ -32,6 +31,7 @@ import { assertNever } from "@seedcord/utils";
 import { settleWithin } from "@seedcord/core/node/internal";
 import { createServer, createServerModuleRunner, defineConfig, mergeConfig } from "vite";
 import { EvaluatedModules } from "vite/module-runner";
+import tsconfigPaths from "vite-tsconfig-paths";
 import { wrapHot } from "@seedcord/core/internal";
 import { minimatch } from "minimatch";
 import { createServer as createServer$1 } from "node:net";
@@ -74,28 +74,31 @@ function isOptionalString(value) {
 function isStringArray(value) {
 	return Array.isArray(value) && value.every((item) => typeof item === "string");
 }
+function invalidField(field, expected) {
+	return new SeedcordError(SeedcordErrorCode.CliConfigInvalidField, [field, expected]);
+}
 function validateBuild(value) {
 	if (value === void 0) return;
-	if (!isPlainObject(value)) throw new SeedcordError(SeedcordErrorCode.CliConfigInvalidBuild);
-	if (!isOptionalString(value.outDir)) throw new SeedcordError(SeedcordErrorCode.CliConfigInvalidBuildOutDir);
-	if (!isOptionalString(value.tsconfig)) throw new SeedcordError(SeedcordErrorCode.CliConfigInvalidBuildTsconfig);
-	if (!isOptionalString(value.bootstrap)) throw new SeedcordError(SeedcordErrorCode.CliConfigInvalidBuildBootstrap);
+	if (!isPlainObject(value)) throw invalidField("build", "an object");
+	if (!isOptionalString(value.outDir)) throw invalidField("build.outDir", "a string");
+	if (!isOptionalString(value.tsconfig)) throw invalidField("build.tsconfig", "a string");
+	if (!isOptionalString(value.bootstrap)) throw invalidField("build.bootstrap", "a string");
 }
 function validateTypecheck(value) {
 	if (value === void 0 || typeof value === "boolean") return;
-	if (!isPlainObject(value)) throw new SeedcordError(SeedcordErrorCode.CliConfigInvalidHmrTypecheck);
-	if (!isOptionalString(value.tsconfig)) throw new SeedcordError(SeedcordErrorCode.CliConfigInvalidTsconfig);
+	if (!isPlainObject(value)) throw invalidField("hmr.typecheck", "a boolean or an object");
+	if (!isOptionalString(value.tsconfig)) throw invalidField("hmr.typecheck.tsconfig", "a string");
 }
 function validateHmr(value) {
 	if (value === void 0) return;
-	if (!isPlainObject(value)) throw new SeedcordError(SeedcordErrorCode.CliConfigInvalidHmr);
-	if (value.restart !== void 0 && !isStringArray(value.restart)) throw new SeedcordError(SeedcordErrorCode.CliConfigInvalidHmrRestart);
-	if (value.rollback !== void 0 && typeof value.rollback !== "boolean") throw new SeedcordError(SeedcordErrorCode.CliConfigInvalidHmrRollback);
+	if (!isPlainObject(value)) throw invalidField("hmr", "an object");
+	if (value.restart !== void 0 && !isStringArray(value.restart)) throw invalidField("hmr.restart", "an array of strings");
+	if (value.rollback !== void 0 && typeof value.rollback !== "boolean") throw invalidField("hmr.rollback", "a boolean");
 	validateTypecheck(value.typecheck);
 }
 function validateTunnel(value) {
 	if (value === void 0 || typeof value === "boolean") return;
-	if (typeof value !== "string" || URL.parse(value)?.protocol !== "https:") throw new SeedcordError(SeedcordErrorCode.CliConfigInvalidTunnel);
+	if (typeof value !== "string" || URL.parse(value)?.protocol !== "https:") throw invalidField("tunnel", "a boolean or an https URL");
 }
 function resolveTunnel(value) {
 	if (value === false) return { mode: "off" };
@@ -117,8 +120,8 @@ function validateConfig(raw) {
 	if (!isPlainObject(raw)) throw new SeedcordError(SeedcordErrorCode.CliConfigInvalidExport);
 	if (typeof raw.instance !== "string" || raw.instance.length === 0) throw new SeedcordError(SeedcordErrorCode.CliConfigMissingInstance);
 	if (typeof raw.entry !== "string" || raw.entry.length === 0) throw new SeedcordError(SeedcordErrorCode.CliConfigMissingEntry);
-	if (!isOptionalString(raw.root)) throw new SeedcordError(SeedcordErrorCode.CliConfigInvalidRoot);
-	if (raw.idleAnimation !== void 0 && typeof raw.idleAnimation !== "boolean") throw new SeedcordError(SeedcordErrorCode.CliConfigInvalidIdleAnimation);
+	if (!isOptionalString(raw.root)) throw invalidField("root", "a string");
+	if (raw.idleAnimation !== void 0 && typeof raw.idleAnimation !== "boolean") throw invalidField("idleAnimation", "a boolean");
 	validateTunnel(raw.tunnel);
 	validateBuild(raw.build);
 	validateHmr(raw.hmr);
@@ -328,7 +331,7 @@ var TypeScriptProjectBuilder = class {
 		this.logger.info(`Building Seedcord project via tsc using ${tsconfigPath}`);
 		try {
 			await this.runTsc(projectDir, tsconfigPath);
-			await this.fixRelativeSpecifiers(config.build.outDir);
+			await this.rewriteSpecifiers(projectDir, tsconfigPath);
 		} catch (error) {
 			if (isSeedcordError(error)) throw error;
 			const reason = Error.isError(error) ? error.message : "Unknown build error";
@@ -367,11 +370,17 @@ var TypeScriptProjectBuilder = class {
 			return false;
 		}
 	}
-	async fixRelativeSpecifiers(outDir) {
-		const fixPath = this.resolveFixEsmImportPath();
-		const result = await this.runNodeScript(process.cwd(), fixPath, [outDir]);
+	async rewriteSpecifiers(projectDir, tsconfigPath) {
+		const binPath = this.resolveTscAlias();
+		const result = await this.runNodeScript(projectDir, binPath, [
+			"-p",
+			tsconfigPath,
+			"--resolve-full-paths",
+			"--resolve-full-extension",
+			".js"
+		]);
 		if (result.exitCode === 0) return;
-		throw new SeedcordError(SeedcordErrorCode.CliBuildFailed, [`Failed to fix relative import specifiers:\n${this.truncateOutput(result.output)}`]);
+		throw new SeedcordError(SeedcordErrorCode.CliBuildFailed, [`Failed to rewrite import specifiers:\n${this.truncateOutput(result.output)}`]);
 	}
 	resolveProjectTsc(projectDir) {
 		const projectRequire = this.createProjectRequire(projectDir);
@@ -382,13 +391,8 @@ var TypeScriptProjectBuilder = class {
 			throw new SeedcordError(SeedcordErrorCode.CliBuildFailed, [`Unable to resolve typescript. Ensure it is installed in this project.\n${reason}`]);
 		}
 	}
-	resolveFixEsmImportPath() {
-		const selfRequire = createRequire(import.meta.url);
-		try {
-			return selfRequire.resolve("fix-esm-import-path/fix-esm-import-path.js");
-		} catch {
-			return selfRequire.resolve("fix-esm-import-path");
-		}
+	resolveTscAlias() {
+		return createRequire(import.meta.url).resolve("tsc-alias/dist/bin/index.js");
 	}
 	createProjectRequire(projectDir) {
 		const candidate = resolve(projectDir, "package.json");
@@ -1165,7 +1169,7 @@ var InteractivePresenter = class {
 		}
 	}
 	preview(scan) {
-		const body = groupByGuild(scan.flagged).map((group) => `${chalk.bold(group.guildName)}\n${group.commands.map((c) => `  ${c.name}`).join("\n")}`).join("\n\n");
+		const body = groupByGuild(scan.flagged).map((group) => `${paint.bold(group.guildName)}\n${group.commands.map((c) => `  ${c.name}`).join("\n")}`).join("\n\n");
 		note(body, `Will delete ${plural(scan.flagged.length, "guild command")} (nothing deleted yet)`);
 		if (scan.skipped.length > 0) log.warn(skippedSummary(scan.skipped));
 	}
@@ -1209,9 +1213,9 @@ var FlagPresenter = class {
 		return task();
 	}
 	preview(scan) {
-		this.logger.info(chalk.bold(`${plural(scan.flagged.length, "guild command")} selected for deletion`));
+		this.logger.info(paint.bold(`${plural(scan.flagged.length, "guild command")} selected for deletion`));
 		for (const group of groupByGuild(scan.flagged)) {
-			this.logger.info(chalk.cyan(group.guildName));
+			this.logger.info(paint.sky(group.guildName));
 			for (const command of group.commands) this.logger.info(`  ${command.name}`);
 		}
 		for (const skip of scan.skipped) this.logger.warn(`Skipped ${skip.guildName} (${skip.reason}).`);
@@ -1229,15 +1233,15 @@ var FlagPresenter = class {
 	result(deletion, skipped) {
 		for (const failure of deletion.failed) this.logger.warn(`Could not delete ${failure.command.name} in ${failure.command.guildName} (${failure.reason}).`);
 		if (skipped.length > 0) this.logger.warn(skippedSummary(skipped));
-		this.logger.info(chalk.green(`Deleted ${plural(deletion.deleted, "guild command")}. Global commands untouched.`));
+		this.logger.info(paint.mint(`Deleted ${plural(deletion.deleted, "guild command")}. Global commands untouched.`));
 	}
 	nothingToClean(scan, outcome) {
 		const lines = emptyLines(scan, outcome);
 		for (const line of lines.info) this.logger.info(line);
-		this.logger.info(chalk.green(lines.outro));
+		this.logger.info(paint.mint(lines.outro));
 	}
 	dryRunHint() {
-		this.logger.info(chalk.italic("Dry run. Re-run with --apply to delete the above."));
+		this.logger.info(paint.italic("Dry run. Re-run with --apply to delete the above."));
 	}
 };
 
@@ -2298,7 +2302,7 @@ function FilterKeys() {
 //#endregion
 //#region src/ui/components/primitives/Sidebar.tsx
 const MAX_RAIL = 40;
-const META_LABEL_WIDTH = 7;
+const META_LABEL_WIDTH = 8;
 const LOG_DIR = "logs/";
 function Meta({ label, value }) {
 	return /* @__PURE__ */ React.createElement(Text, null, /* @__PURE__ */ React.createElement(Text, { dimColor: true }, label.padEnd(META_LABEL_WIDTH)), value);
@@ -2306,11 +2310,17 @@ function Meta({ label, value }) {
 function tunnelValue(status) {
 	return status === "live" || status === "lost" ? status : `${status}…`;
 }
+function transportLabel({ name }) {
+	return name.replace("@seedcord/", "");
+}
 function StatusBlock({ state, uptimeMs }) {
 	return /* @__PURE__ */ React.createElement(Box, { flexDirection: "column" }, /* @__PURE__ */ React.createElement(StatusBadge, {
 		phase: state.phase,
 		animate: state.idleAnimation
-	}), state.status ? /* @__PURE__ */ React.createElement(Text, null, state.status) : null, uptimeMs === null ? null : /* @__PURE__ */ React.createElement(Meta, {
+	}), state.status ? /* @__PURE__ */ React.createElement(Text, null, state.status) : null, state.transport === null ? null : /* @__PURE__ */ React.createElement(Meta, {
+		label: transportLabel(state.transport),
+		value: `v${state.transport.version}`
+	}), uptimeMs === null ? null : /* @__PURE__ */ React.createElement(Meta, {
 		label: "up",
 		value: formatUptime(uptimeMs)
 	}), state.port === null ? null : /* @__PURE__ */ React.createElement(Meta, {
@@ -2333,7 +2343,7 @@ function Sidebar({ state, enabled, enabledLevels, uptimeMs, following, interacti
 		flexShrink: 0,
 		paddingX: 1,
 		overflow: "hidden"
-	}, /* @__PURE__ */ React.createElement(Box, { flexShrink: 0 }, /* @__PURE__ */ React.createElement(Banner, { version: state.frameworkVersion })), /* @__PURE__ */ React.createElement(Box, {
+	}, /* @__PURE__ */ React.createElement(Box, { flexShrink: 0 }, /* @__PURE__ */ React.createElement(Banner, { version })), /* @__PURE__ */ React.createElement(Box, {
 		flexShrink: 0,
 		marginTop: 1
 	}, /* @__PURE__ */ React.createElement(StatusBlock, {
@@ -2702,13 +2712,13 @@ function profileReport() {
 
 //#endregion
 //#region src/ui/tier.ts
-const FULL_ROWS = 29;
-const COMPACT_ROWS = 20;
+const FULL_ROWS = 30;
+const COMPACT_ROWS = 21;
 const RAIL_COLUMNS = 80;
 function tierFor(rows, columns) {
 	if (columns < 80) return "logs";
-	if (rows >= 29) return "full";
-	if (rows >= 20) return "compact";
+	if (rows >= 30) return "full";
+	if (rows >= 21) return "compact";
 	return "logs";
 }
 
@@ -2796,7 +2806,7 @@ const INITIAL = {
 	status: "Initializing…",
 	error: null,
 	isBusy: true,
-	frameworkVersion: null,
+	transport: null,
 	restartRequired: false,
 	commandUpdatePrompt: null,
 	port: null,
@@ -2821,8 +2831,8 @@ var DevStore = class extends TypedEventEmitter {
 	setError(error) {
 		this.patch({ error });
 	}
-	setFrameworkVersion(frameworkVersion) {
-		this.patch({ frameworkVersion });
+	setTransport(transport) {
+		this.patch({ transport });
 	}
 	setTunnel(tunnel) {
 		this.patch({ tunnel });
@@ -3025,7 +3035,10 @@ var DevSession = class {
 		const instance = await Promise.resolve(exported);
 		if (!isSeedcordInstance(instance)) throw new SeedcordError(SeedcordErrorCode.CliInstanceInvalid);
 		this.instance = instance;
-		this.store.setFrameworkVersion(instance.version);
+		this.store.setTransport({
+			name: instance.augmentTarget,
+			version: instance.version
+		});
 		try {
 			this.store.setPhase("starting");
 			this.store.setStatus("Starting Seedcord instance…");
@@ -3033,7 +3046,7 @@ var DevSession = class {
 			await this.startupPromise;
 			if (this.isStopped) return;
 			this.store.setPhase("running");
-			this.store.setStatus(`${chalk.bold(instance.username ?? "Bot")} is ready!`);
+			this.store.setStatus(`${paint.bold(instance.username ?? "Bot")} is ready!`);
 			profileMark("ready");
 			onReady?.();
 			this.startTypecheck();
@@ -3294,8 +3307,9 @@ var ViteDevRuntime = class {
 		this.hmrPlugin = hmrPlugin;
 		const config = mergeConfig(vite_config_default, {
 			root: projectRoot,
+			configFile: false,
 			server: { watch: { ignored: [logsIgnore(projectRoot)] } },
-			plugins: [hmrPlugin.plugin]
+			plugins: [tsconfigPaths({ root: dirname(this.context.config.configFile) }), hmrPlugin.plugin]
 		});
 		this.viteServer = await createServer(config);
 		this.evaluatedModules = new EvaluatedModules();
@@ -3585,10 +3599,10 @@ var TunnelCoordinator = class {
 		let patched = false;
 		try {
 			this.deps.onStatus("opening");
-			this.deps.logger.info(`${opening(this.deps.kind)} ${paint.iris(String(port))}`);
+			this.deps.logger.info(`${opening(this.deps.kind)} ${paint.sky.bold(String(port))}`);
 			const url = await tunnel.open(attempt.signal, port, () => this.deps.onStatus("resolving"));
 			if (superseded(attempt)) return;
-			this.deps.logger.info(`Reachable at ${paint.sky.italic(url)} ${since()}`);
+			this.deps.logger.info(`Reachable at ${paint.sky.bold(url)} ${since()}`);
 			this.deps.onStatus("registering");
 			patched = true;
 			await this.deps.endpoint.set(url, attempt.signal);