create-seedcord 0.5.0 → 0.6.0-next.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-seedcord",
   "type": "module",
-  "version": "0.5.0",
+  "version": "0.6.0-next.0",
   "description": "Scaffold a new seedcord bot",
   "keywords": [
     "discord",
@@ -34,18 +34,22 @@
   "files": [
     "bin",
     "dist",
+    "starters",
     "templates",
     "package.json",
     "README.md",
     "LICENSE"
   ],
   "devDependencies": {
-    "@seedcord/cli-prompts": "^0.0.2",
-    "@seedcord/errors": "^0.14.0",
-    "@seedcord/eslint-config": "^3.0.0",
+    "@seedcord/brand": "^0.0.0",
+    "@seedcord/cli-prompts": "^0.0.3-next.0",
+    "@seedcord/cli-templates": "^0.0.1-next.0",
+    "@seedcord/core": "^0.12.0-next.0",
+    "@seedcord/errors": "^0.15.0-next.0",
+    "@seedcord/eslint-config": "^3.0.1-next.0",
     "@seedcord/tsconfig": "^3.0.0",
     "@seedcord/tsdown-config": "^2.0.1",
-    "@seedcord/types": "^0.15.0",
+    "@seedcord/types": "^0.16.0-next.0",
     "@seedcord/vitest-config": "^0.0.1",
     "discord.js": "^14.27.0",
     "handlebars": "^4.7.10",

package/starters/gateway/Event/events/{{pascal name}}.ts.hbs

@@ -0,0 +1,9 @@
+import { EventHandler, RegisterEvent } from '{{ transport }}';
+import { Events } from 'discord.js';
+
+@RegisterEvent([Events.{{ event }}])
+export class {{ pascal name }} extends EventHandler<Events.{{ event }}> {
+    public async execute(): Promise<void> {
+        this.logger.info('{{ pascal name }} ran');
+    }
+}

package/starters/shared/Button/components/{{pascal name}}.ts.hbs

@@ -0,0 +1,18 @@
+import { ButtonBuilder } from '@discordjs/builders';
+import { CustomId, RowComponent } from '{{ transport }}';
+import { ButtonStyle } from 'discord-api-types/v10';
+
+export const {{ pascal name }}Id = new CustomId('{{ kebab name }}');
+
+export class {{ pascal name }}Row extends RowComponent<'button'> {
+    constructor() {
+        super('button');
+
+        this.instance.addComponents(
+            new ButtonBuilder()
+                .setCustomId({{ pascal name }}Id.encode({}))
+                .setLabel({{ quote label }})
+                .setStyle(ButtonStyle.Primary)
+        );
+    }
+}

package/starters/shared/Button/handlers/{{pascal name}}.ts.hbs

@@ -0,0 +1,10 @@
+import { ButtonHandler, ButtonRoute } from '{{ transport }}';
+
+import { {{ pascal name }}Id } from '{{ importOf "components" }}';
+
+@ButtonRoute({{ pascal name }}Id)
+export class {{ pascal name }}Button extends ButtonHandler<[typeof {{ pascal name }}Id]> {
+    public async execute(): Promise<void> {
+        await this.reply({{ quote reply }});
+    }
+}

package/starters/shared/Modal/components/{{pascal name}}.ts.hbs

@@ -0,0 +1,19 @@
+import { BuilderComponent, CustomId } from '{{ transport }}';
+import { TextInputStyle } from 'discord-api-types/v10';
+
+export const {{ pascal name }}Id = new CustomId('{{ kebab name }}');
+
+export class {{ pascal name }}Modal extends BuilderComponent<'modal'> {
+    constructor() {
+        super('modal');
+
+        this.instance
+            .setCustomId({{ pascal name }}Id.encode({}))
+            .setTitle({{ quote title }})
+            .addLabelComponents((label) =>
+                label
+                    .setLabel({{ quote question }})
+                    .setTextInputComponent((input) => input.setCustomId('answer').setStyle(TextInputStyle.Short))
+            );
+    }
+}

package/starters/shared/Modal/handlers/{{pascal name}}.ts.hbs

@@ -0,0 +1,10 @@
+import { ModalHandler, ModalRoute } from '{{ transport }}';
+
+import { {{ pascal name }}Id } from '{{ importOf "components" }}';
+
+@ModalRoute({{ pascal name }}Id)
+export class {{ pascal name }}Submit extends ModalHandler<[typeof {{ pascal name }}Id]> {
+    public async execute(): Promise<void> {
+        await this.reply(this.fields.getTextInputValue('answer'));
+    }
+}

package/starters/shared/Select/components/{{pascal name}}.ts.hbs

@@ -0,0 +1,16 @@
+import { StringSelectMenuBuilder } from '@discordjs/builders';
+import { CustomId, RowComponent } from '{{ transport }}';
+
+export const {{ pascal name }}Id = new CustomId('{{ kebab name }}');
+
+export class {{ pascal name }}Menu extends RowComponent<'menu_string'> {
+    constructor() {
+        super('menu_string');
+
+        this.instance.addComponents(
+            new StringSelectMenuBuilder()
+                .setCustomId({{ pascal name }}Id.encode({}))
+                .addOptions({{#each choices}}{ label: {{ quote this }}, value: '{{ kebab this }}' }{{#unless @last}}, {{/unless}}{{/each}})
+        );
+    }
+}

package/starters/shared/Select/handlers/{{pascal name}}.ts.hbs

@@ -0,0 +1,10 @@
+import { StringMenuHandler, StringMenuRoute } from '{{ transport }}';
+
+import { {{ pascal name }}Id } from '{{ importOf "components" }}';
+
+@StringMenuRoute({{ pascal name }}Id)
+export class {{ pascal name }}Select extends StringMenuHandler<[typeof {{ pascal name }}Id]> {
+    public async execute(): Promise<void> {
+        await this.reply(this.values.join(', '));
+    }
+}

package/starters/shared/Slash/commands/{{pascal name}}.ts.hbs

@@ -0,0 +1,10 @@
+import { BuilderComponent, RegisterCommand } from '{{ transport }}';
+
+@RegisterCommand()
+export class {{ pascal name }} extends BuilderComponent<'command'> {
+    constructor() {
+        super('command');
+
+        this.instance.setName('{{ kebab name }}').setDescription({{ quote description }});
+    }
+}

package/starters/shared/Slash/handlers/{{pascal name}}.ts.hbs

@@ -0,0 +1,8 @@
+import { SlashHandler, SlashRoute } from '{{ transport }}';
+
+@SlashRoute('{{ kebab name }}')
+export class {{ pascal name }} extends SlashHandler<'{{ kebab name }}'> {
+    public async execute(): Promise<void> {
+        await this.reply({{ quote reply }});
+    }
+}

package/templates/.vscode/settings.json.hbs

@@ -1,13 +1,13 @@
 {
   "files.watcherExclude": {
-    "**/seedcord-gen.d.ts": true,
+    "**/seedcord-gen.ts": true,
     "**/.seedcord/**": true
   },
   "search.exclude": {
-    "**/seedcord-gen.d.ts": true
+    "**/seedcord-gen.ts": true
   },
   "files.readonlyInclude": {
-    "**/seedcord-gen.d.ts": true,
+    "**/seedcord-gen.ts": true,
     "**/.seedcord/**": true
   }
 }

package/templates/AGENTS.md.hbs

@@ -10,13 +10,13 @@ Rules for an AI coding agent working in this repo.
 
 The API reference is at <https://seedcord.org/docs>, one page per symbol.
 
-This project runs on the {{#if isGateway}}gateway{{else}}http{{/if}} transport{{#if isEdge}} on Cloudflare Workers{{/if}} and imports everything from `{{ transportPackage }}`. A page marks anything that differs between the two transports.
+This project runs on the {{#if isGateway}}gateway{{else}}http{{/if}} transport{{#if isEdge}} on Cloudflare Workers{{/if}} and imports everything from `{{ transport }}`. A page marks anything that differs between the two transports.
 
 ## How a command works here
 
 A command takes two files. One declares what Discord shows people. The other answers it, as a handler class carrying a route decorator. seedcord reads those decorators at startup and dispatches every interaction itself.
 
-Run `{{ pm.run }} codegen` after you add a command or change its options. It writes `src/seedcord-gen.d.ts`, which types `this.options`. That file is committed.
+Run `{{ pm.run }} codegen` after you add a command or change its options. It writes `src/seedcord-gen.ts`, which types `this.options`. That file is committed.
 
 ## Where things go
 
@@ -30,6 +30,7 @@ Run `{{ pm.run }} codegen` after you add a command or change its options. It wri
 | `src/events/` | handlers for things happening in a server |
 {{/if}}
 | `src/bot.ts` | the config |
+| `templates/` | a template for each kind of file, like a command or a button. Copy its shape when you add one |
 
 <!-- prettier-ignore-end -->
 
@@ -41,6 +42,10 @@ Anything that holds a connection, keeps state between interactions, or runs in t
 
 Never import from a seedcord path ending in `/internal`, like `@seedcord/core/internal`. Those paths wire seedcord's own packages together and change without notice. If the only way to do something is through one of those imports, tell the user so they can open an issue at <https://github.com/seedcord/seedcord/issues>.
 
+## Trying a change
+
+`{{ pm.run }} dev` runs the bot against Discord and swaps in a handler when you save it. When you start it without a terminal, it prints each log line as JSON and takes commands on stdin, like `{"do":"restart"}`. Run it in the background, ask the user to run the command in Discord, then read the lines it logged. <https://seedcord.org/guide/tooling/dev.md> lists the commands.
+
 ## Before you call it done
 
-Run `{{ pm.run }} tc` and `{{ pm.run }} lint`. A wrong route or a wrong option name is a compile error, so a green type-check catches most of what an invented API gets wrong.
+Run `{{ pm.run }} tc` and `{{ pm.run }} lint`. A wrong route or a wrong option name is a compile error, so a green type-check catches most of what an invented API gets wrong. If the change alters what the bot sends or keeps, try it under `{{ pm.run }} dev` too.

package/templates/README.md.hbs

@@ -24,7 +24,8 @@ That starts the dev server with hot reload{{#unless isGateway}} and opens a tunn
 | `{{ pm.run }} build` | compile to `dist/` |
 | `{{ pm.run }} start` | run the compiled build |
 {{/if}}
-| `{{ pm.run }} codegen` | regenerate `src/seedcord-gen.d.ts` |
+| `{{ pm.run }} codegen` | regenerate `src/seedcord-gen.ts` |
+| `{{ pm.run }} make` | write a new command, button, select menu{{#if isGateway}}, modal, or event{{else}}, or modal{{/if}} from `templates/` |
 {{#if isEdge}}
 | `{{ pm.run }} types` | regenerate the binding types in `.cloudflare/types/` |
 {{/if}}
@@ -78,6 +79,7 @@ After that, `{{ pm.run }} deploy` is enough. `TESTING_GUILD_IDS` can stay empty
 - `src/events/` holds event handlers for the things happening in a server.
 {{/if}}
 - `src/bot.ts` is the config.
+- `templates/` holds the templates `{{ pm.run }} make` writes new files from. [Templates](https://seedcord.org/guide/tooling/make) shows how to change them or add your own.
 
 ## Docs
 

package/templates/eslint.config.ts.hbs

@@ -4,5 +4,5 @@ export default createConfig({
     tsconfigRootDir: import.meta.dirname,
     registerDiscordjsPlugin: true,
     registerSeedcordPlugin: true,
-    generalIgnores: ['**/seedcord-gen.d.ts']
+    generalIgnores: ['**/seedcord-gen.ts']
 });

package/templates/gitattributes.hbs

@@ -1,3 +1,3 @@
 * text=auto eol=lf
 
-seedcord-gen.d.ts linguist-generated
+seedcord-gen.ts linguist-generated

package/templates/package.json.hbs

@@ -15,6 +15,7 @@
         "start": "node --enable-source-maps dist/index.mjs",
 {{/if}}
         "codegen": "seedcord codegen",
+        "make": "seedcord make",
 {{#if isEdge}}
         "types": "cf workers types",
 {{/if}}

package/templates/prettierignore.hbs

@@ -1 +1,2 @@
-seedcord-gen.d.ts
+seedcord-gen.ts
+templates/

package/templates/src/commands/Ping.ts.hbs

@@ -1,4 +1,4 @@
-import { BuilderComponent, RegisterCommand } from '{{ transportPackage }}';
+import { BuilderComponent, RegisterCommand } from '{{ transport }}';
 
 @RegisterCommand()
 export class Ping extends BuilderComponent<'command'> {

package/templates/src/events/Mentioned.ts.hbs

@@ -1,5 +1,5 @@
 {{#if hasMessages}}
-import { EventHandler, Gated, IgnoreBots, RegisterEvent } from '{{ transportPackage }}';
+import { EventHandler, Gated, IgnoreBots, RegisterEvent } from '{{ transport }}';
 import { Events } from 'discord.js';
 
 @Gated(IgnoreBots)

package/templates/src/events/Ready.ts.hbs

@@ -1,6 +1,6 @@
 {{#if isGateway}}
 {{#unless hasMessages}}
-import { EventHandler, RegisterEvent } from '{{ transportPackage }}';
+import { EventHandler, RegisterEvent } from '{{ transport }}';
 import { Events } from 'discord.js';
 
 @RegisterEvent([Events.ClientReady, { frequency: 'once' }])

package/templates/src/handlers/Ping.ts.hbs

@@ -1,4 +1,4 @@
-import { SlashHandler, SlashRoute, timestampFromSnowflake, toEpochSeconds } from '{{ transportPackage }}';
+import { SlashHandler, SlashRoute, timestampFromSnowflake, toEpochSeconds } from '{{ transport }}';
 
 @SlashRoute('ping')
 export class Ping extends SlashHandler<'ping'> {

package/templates/src/plugins/Uptime.ts.hbs

@@ -1,6 +1,6 @@
-import { Plugin } from '{{ transportPackage }}';
+import { Plugin } from '{{ transport }}';
 
-import type { EpochMs } from '{{ transportPackage }}';
+import type { EpochMs } from '{{ transport }}';
 
 export class Uptime extends Plugin {
     public startedAt = 0 as EpochMs;