create-chapter 0.2.3 → 0.3.0

package/templates/default/.env.example

@@ -1,4 +0,0 @@
-# Your bot token: https://discord.com/developers/applications → your app → Bot → Reset Token
-BOT_TOKEN=
-# The ID of the server used by `chapterjs dev` (right-click the server → Copy Server ID)
-DEV_GUILD_ID=

package/templates/default/_gitignore

@@ -1,5 +0,0 @@
-node_modules
-dist
-.env
-.chapterjs
-data

package/templates/default/package.json

@@ -1,23 +0,0 @@
-{
-  "name": "chapter-bot",
-  "description": "A bot that starts: one event, ready to grow",
-  "private": true,
-  "type": "module",
-  "scripts": {
-    "dev": "chapterjs dev",
-    "start": "chapterjs start",
-    "build": "chapterjs build",
-    "typecheck": "tsc -b",
-    "postinstall": "chapterjs sync"
-  },
-  "dependencies": {
-    "chapterjs": "latest"
-  },
-  "devDependencies": {
-    "@types/node": "^24.0.0",
-    "typescript": "^7.0.2"
-  },
-  "engines": {
-    "node": ">=24"
-  }
-}

package/templates/default/src/events/ready.ts

@@ -1,28 +0,0 @@
-import { event } from 'chapterjs';
-
-// Your bot is made of the files of src/: each one exports what it declares
-// with a function of 'chapterjs' (event, command, button, task...), and
-// chapterjs dev runs it. This one is an event: `name` says which, and types
-// what `run` receives. `ready` runs once, when the bot is connected.
-export default event({
-  name: 'ready',
-  run({ user, guilds }) {
-    console.log(`${user.username} is online in ${guilds.size} server(s)`);
-  },
-});
-
-// A command is a file like this one, anywhere in src/, with command():
-//
-// import { command } from 'chapterjs';
-//
-// export default command({
-//   name: 'ping',
-//   description: 'Replies with Pong!',
-//   async run({ interaction }) {
-//     await interaction.reply('Pong!');
-//   },
-// });
-//
-// Save it, and /ping shows up in your test server. The other templates of
-// `pnpm create chapter` show tickets, music, moderation and a community
-// bot; the docs at https://www.chapterjs.org walk through everything.

package/templates/default/tsconfig.json

@@ -1,20 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ESNext",
-    "module": "Preserve",
-    "moduleResolution": "Bundler",
-    "allowImportingTsExtensions": true,
-    "erasableSyntaxOnly": true,
-    "verbatimModuleSyntax": true,
-    "noEmit": true,
-    "strict": true,
-    "skipLibCheck": true,
-    "types": ["node"]
-  },
-  "files": [],
-  "references": [
-    {
-      "path": "./.chapterjs"
-    }
-  ]
-}

package/templates/moderation/.env.example

@@ -1,4 +0,0 @@
-# Your bot token: https://discord.com/developers/applications → your app → Bot → Reset Token
-BOT_TOKEN=
-# The ID of the server used by `chapterjs dev` (right-click the server → Copy Server ID)
-DEV_GUILD_ID=

package/templates/moderation/_gitignore

@@ -1,5 +0,0 @@
-node_modules
-dist
-.env
-.chapterjs
-data

package/templates/moderation/package.json

@@ -1,23 +0,0 @@
-{
-  "name": "moderation-bot",
-  "description": "Timeouts, purge, slowmode, lock, and a log of every moderation action",
-  "private": true,
-  "type": "module",
-  "scripts": {
-    "dev": "chapterjs dev",
-    "start": "chapterjs start",
-    "build": "chapterjs build",
-    "typecheck": "tsc -b",
-    "postinstall": "chapterjs sync"
-  },
-  "dependencies": {
-    "chapterjs": "latest"
-  },
-  "devDependencies": {
-    "@types/node": "^24.0.0",
-    "typescript": "^7.0.2"
-  },
-  "engines": {
-    "node": ">=24"
-  }
-}

package/templates/moderation/src/moderation/channel.ts

@@ -1,67 +0,0 @@
-import { command } from 'chapterjs';
-
-// /slowmode sets how long people wait between two messages in the channel.
-// 0 removes it.
-export const slowmode = command({
-  name: 'slowmode',
-  permissions: ['ManageChannels'],
-  options: {
-    seconds: { type: 'integer', min: 0, max: 21600, required: true },
-  },
-  async run({ interaction, options, channel, member, t }) {
-    if (!channel.isText()) {
-      await interaction.reply({ content: t('notHere'), ephemeral: true });
-      return;
-    }
-    await channel.edit(
-      { rateLimitPerUser: options.seconds },
-      `By ${member.user.username}`
-    );
-    await interaction.reply(
-      options.seconds === 0
-        ? t('slowmodeOff')
-        : t('slowmodeOn', { count: options.seconds })
-    );
-  },
-});
-
-// /lock keeps everyone from writing in the channel, /unlock gives it back.
-// Both change the permissions of @everyone on the channel only.
-export const lock = command({
-  name: 'lock',
-  permissions: ['ManageChannels'],
-  options: {
-    reason: { type: 'string', maxLength: 200 },
-  },
-  async run({ interaction, options, channel, guild, member, t }) {
-    if (!channel.isText()) {
-      await interaction.reply({ content: t('notHere'), ephemeral: true });
-      return;
-    }
-    await channel.setPermissions(
-      guild.everyoneRole,
-      { deny: ['SendMessages', 'CreatePublicThreads', 'CreatePrivateThreads'] },
-      options.reason ?? `Locked by ${member.user.username}`
-    );
-    await interaction.reply(
-      t('locked', { reason: options.reason ?? t('noReason') })
-    );
-  },
-});
-
-export const unlock = command({
-  name: 'unlock',
-  permissions: ['ManageChannels'],
-  async run({ interaction, channel, guild, member, t }) {
-    if (!channel.isText()) {
-      await interaction.reply({ content: t('notHere'), ephemeral: true });
-      return;
-    }
-    // Deleting the overwrite gives @everyone back what the server says.
-    await channel.deletePermissions(
-      guild.everyoneRole,
-      `Unlocked by ${member.user.username}`
-    );
-    await interaction.reply(t('unlocked'));
-  },
-});

package/templates/moderation/src/moderation/log.ts

@@ -1,37 +0,0 @@
-import { AuditLogEvent, event } from 'chapterjs';
-
-// Every moderation action, whoever did it and however (a command of this
-// bot, another bot, the Discord app), reaches the audit log of the server.
-// This posts the ones below in the channel named mod-log. Discord only
-// sends the audit log to a bot with the View Audit Log permission.
-const ACTIONS: Partial<Record<number, string>> = {
-  [AuditLogEvent.MemberKick]: 'kicked',
-  [AuditLogEvent.MemberBanAdd]: 'banned',
-  [AuditLogEvent.MemberBanRemove]: 'unbanned',
-  [AuditLogEvent.MemberUpdate]: 'updated (timeout, nickname...)',
-  [AuditLogEvent.MessageBulkDelete]: 'purged messages in',
-  [AuditLogEvent.ChannelOverwriteUpdate]: 'changed the permissions of',
-  [AuditLogEvent.ChannelOverwriteCreate]: 'changed the permissions of',
-  [AuditLogEvent.ChannelOverwriteDelete]: 'changed the permissions of',
-};
-
-export default event({
-  name: 'auditLogEntryCreate',
-  async run({ entry, guild }) {
-    const action = ACTIONS[entry.actionType];
-    if (!action || !entry.userId) return;
-    const log = [...guild.channels.values()].find(
-      channel => channel.isText() && channel.name === 'mod-log'
-    );
-    if (!log?.isText()) return;
-    const who = `<@${entry.userId}>`;
-    const target = entry.targetId
-      ? guild.channels.has(entry.targetId)
-        ? `<#${entry.targetId}>`
-        : `<@${entry.targetId}>`
-      : 'something';
-    await log.send(
-      `🛡️ ${who} ${action} ${target}${entry.reason ? `: ${entry.reason}` : ''}`
-    );
-  },
-});

package/templates/moderation/src/moderation/messages.ts

@@ -1,158 +0,0 @@
-import { language } from 'chapterjs';
-
-// The texts of the bot, one language() per language. `t` picks the one of
-// who will read the message. A text with {count} can have one form per
-// quantity: Discord's language rules pick the form.
-export const en = language({
-  locale: 'en-US',
-  default: true,
-  texts: {
-    cantModerate:
-      'You can not moderate {user}: their highest role is above yours.',
-    timedOut: '{user} is timed out until {until}. Reason: {reason}',
-    noReason: 'none given',
-    notTimedOut: '{user} is not timed out.',
-    timeoutRemoved: '{user} can speak again.',
-    purged: {
-      one: '{count} message deleted.',
-      other: '{count} messages deleted.',
-    },
-    notHere: 'This only works in a text channel of the server.',
-    slowmodeOff: 'Slowmode is off.',
-    slowmodeOn: {
-      one: 'Slowmode: one message every {count} second.',
-      other: 'Slowmode: one message every {count} seconds.',
-    },
-    locked: '🔒 This channel is locked. Reason: {reason}',
-    unlocked: '🔓 This channel is open again.',
-    warned: {
-      one: '{user} was warned. They have {count} warning.',
-      other: '{user} was warned. They have {count} warnings.',
-    },
-    noWarnings: '{user} has no warning.',
-    warningsOf: {
-      one: '{user} has {count} warning:',
-      other: '{user} has {count} warnings:',
-    },
-  },
-  commands: {
-    timeout: {
-      description: 'Keeps someone from writing and speaking for a while',
-      options: {
-        user: { description: 'Who' },
-        duration: { description: 'For how long' },
-        reason: { description: 'Why' },
-      },
-    },
-    untimeout: {
-      description: 'Ends the timeout of someone',
-      options: { user: { description: 'Who' } },
-    },
-    purge: {
-      description: 'Deletes the last messages of this channel',
-      options: {
-        count: { description: 'How many, 100 at most' },
-        user: { description: 'Only the messages of this person' },
-      },
-    },
-    slowmode: {
-      description: 'Sets how long people wait between two messages here',
-      options: {
-        seconds: { description: 'Seconds between two messages, 0 for none' },
-      },
-    },
-    lock: {
-      description: 'Keeps everyone from writing in this channel',
-      options: { reason: { description: 'Why' } },
-    },
-    unlock: { description: 'Lets everyone write in this channel again' },
-    'warn add': {
-      description: 'Warns someone; warnings are forgotten after 30 days',
-      options: { user: { description: 'Who' }, reason: { description: 'Why' } },
-    },
-    'warn list': {
-      description: 'Lists the warnings of someone',
-      options: { user: { description: 'Who' } },
-    },
-  },
-});
-
-export const fr = language({
-  locale: 'fr',
-  texts: {
-    cantModerate:
-      'Vous ne pouvez pas modérer {user} : son rôle le plus haut est au-dessus du vôtre.',
-    timedOut:
-      '{user} est exclu temporairement jusqu’à {until}. Raison : {reason}',
-    noReason: 'aucune',
-    notTimedOut: '{user} n’est pas exclu.',
-    timeoutRemoved: '{user} peut de nouveau parler.',
-    purged: {
-      one: '{count} message supprimé.',
-      other: '{count} messages supprimés.',
-    },
-    notHere: 'Ceci ne fonctionne que dans un salon textuel du serveur.',
-    slowmodeOff: 'Le mode lent est désactivé.',
-    slowmodeOn: {
-      one: 'Mode lent : un message toutes les {count} seconde.',
-      other: 'Mode lent : un message toutes les {count} secondes.',
-    },
-    locked: '🔒 Ce salon est verrouillé. Raison : {reason}',
-    unlocked: '🔓 Ce salon est de nouveau ouvert.',
-    warned: {
-      one: '{user} a été averti. Il a {count} avertissement.',
-      other: '{user} a été averti. Il a {count} avertissements.',
-    },
-    noWarnings: '{user} n’a aucun avertissement.',
-    warningsOf: {
-      one: '{user} a {count} avertissement :',
-      other: '{user} a {count} avertissements :',
-    },
-  },
-  commands: {
-    timeout: {
-      description: 'Empêche quelqu’un d’écrire et de parler pendant un moment',
-      options: {
-        user: { description: 'Qui' },
-        duration: { description: 'Pendant combien de temps' },
-        reason: { description: 'Pourquoi' },
-      },
-    },
-    untimeout: {
-      description: 'Met fin à l’exclusion temporaire de quelqu’un',
-      options: { user: { description: 'Qui' } },
-    },
-    purge: {
-      description: 'Supprime les derniers messages de ce salon',
-      options: {
-        count: { description: 'Combien, 100 au plus' },
-        user: { description: 'Seulement les messages de cette personne' },
-      },
-    },
-    slowmode: {
-      description: 'Règle l’attente entre deux messages ici',
-      options: {
-        seconds: { description: 'Secondes entre deux messages, 0 pour aucune' },
-      },
-    },
-    lock: {
-      description: 'Empêche tout le monde d’écrire dans ce salon',
-      options: { reason: { description: 'Pourquoi' } },
-    },
-    unlock: {
-      description: 'Laisse de nouveau tout le monde écrire dans ce salon',
-    },
-    'warn add': {
-      description:
-        'Avertit quelqu’un ; un avertissement est oublié après 30 jours',
-      options: {
-        user: { description: 'Qui' },
-        reason: { description: 'Pourquoi' },
-      },
-    },
-    'warn list': {
-      description: 'Liste les avertissements de quelqu’un',
-      options: { user: { description: 'Qui' } },
-    },
-  },
-});

package/templates/moderation/src/moderation/purge.ts

@@ -1,30 +0,0 @@
-import { command } from 'chapterjs';
-
-// /purge deletes the last messages of the channel, all of them or only
-// the ones of a person. Discord only deletes in bulk what is less than two
-// weeks old: older messages are left out, and the answer says how many
-// really went.
-export default command({
-  name: 'purge',
-  permissions: ['ManageMessages'],
-  // The answer only the person sees, so the channel is not filled again.
-  ephemeral: true,
-  cooldown: { channel: '5s' },
-  options: {
-    count: { type: 'integer', min: 1, max: 100, required: true },
-    user: { type: 'user' },
-  },
-  async run({ interaction, options, channel, member, t }) {
-    // Deleting takes a moment: tell Discord the answer is coming.
-    await interaction.defer();
-    const messages = await channel.fetchMessages({ limit: options.count });
-    const chosen = options.user
-      ? messages.filter(message => message.author.id === options.user!.id)
-      : messages;
-    const deleted = await channel.bulkDelete(
-      chosen,
-      `Purge by ${member.user.username}`
-    );
-    await interaction.reply(t('purged', { count: deleted }));
-  },
-});

package/templates/moderation/src/moderation/timeout.ts

@@ -1,82 +0,0 @@
-import { command, timestamp, type GuildMember } from 'chapterjs';
-
-// Someone can only act on people below them, and never on the owner.
-function canModerate(target: GuildMember, by: GuildMember): boolean {
-  return (
-    target.id !== target.guild.ownerId &&
-    target.highestRole.position < by.highestRole.position
-  );
-}
-
-// /timeout keeps someone from writing, reacting and speaking for a while.
-// `permissions` is what a member needs to see and use the command; the bot
-// itself needs Moderate Members. The choices of `duration` are what the
-// person picks from, in minutes.
-export default command({
-  name: 'timeout',
-  permissions: ['ModerateMembers'],
-  options: {
-    user: { type: 'user', required: true },
-    duration: {
-      type: 'integer',
-      required: true,
-      choices: {
-        '5 minutes': 5,
-        '1 hour': 60,
-        '1 day': 60 * 24,
-        '1 week': 60 * 24 * 7,
-      },
-    },
-    reason: { type: 'string', maxLength: 200 },
-  },
-  async run({ interaction, options, guild, member, t }) {
-    const target = await guild.fetchMember(options.user);
-    if (!canModerate(target, member)) {
-      await interaction.reply({
-        content: t('cantModerate', { user: target.toString() }),
-        ephemeral: true,
-      });
-      return;
-    }
-    const until = Date.now() + options.duration * 60 * 1000;
-    await target.timeout(
-      options.duration * 60 * 1000,
-      options.reason ?? `By ${member.user.username}`
-    );
-    await interaction.reply(
-      t('timedOut', {
-        user: target.toString(),
-        until: timestamp(until, 'R'),
-        reason: options.reason ?? t('noReason'),
-      })
-    );
-  },
-});
-
-export const untimeout = command({
-  name: 'untimeout',
-  permissions: ['ModerateMembers'],
-  options: {
-    user: { type: 'user', required: true },
-  },
-  async run({ interaction, options, guild, member, t }) {
-    const target = await guild.fetchMember(options.user);
-    // The same rule as /timeout: nobody lifts what someone above them set.
-    if (!canModerate(target, member)) {
-      await interaction.reply({
-        content: t('cantModerate', { user: target.toString() }),
-        ephemeral: true,
-      });
-      return;
-    }
-    if (!target.isTimedOut) {
-      await interaction.reply({
-        content: t('notTimedOut', { user: target.toString() }),
-        ephemeral: true,
-      });
-      return;
-    }
-    await target.removeTimeout(`By ${member.user.username}`);
-    await interaction.reply(t('timeoutRemoved', { user: target.toString() }));
-  },
-});

package/templates/moderation/src/moderation/warn.ts

@@ -1,61 +0,0 @@
-import { command, store, timestamp } from 'chapterjs';
-
-interface Warning {
-  reason: string;
-  /** Who gave it: a user id. */
-  by: string;
-  /** When, in ms since the epoch: a Date would not survive the file. */
-  at: number;
-}
-
-// The warnings of each member, kept from one restart to the next, per
-// server: `warnings.get(member.id)` in a command is the warnings of that
-// member in the server the command was used in. A warning is forgotten
-// thirty days after the last one was added.
-export const warnings = store<Warning[]>({ expires: '30d' });
-
-export default command({
-  name: 'warn add',
-  permissions: ['ModerateMembers'],
-  options: {
-    user: { type: 'user', required: true },
-    reason: { type: 'string', required: true, maxLength: 200 },
-  },
-  async run({ interaction, options, member, t }) {
-    // Reads, adds and keeps in one go; `list` is undefined the first time.
-    const list = await warnings.update(options.user.id, (list = []) => [
-      ...list,
-      { reason: options.reason, by: member.id, at: Date.now() },
-    ]);
-    await interaction.reply(
-      t('warned', { user: options.user.toString(), count: list.length })
-    );
-  },
-});
-
-export const list = command({
-  name: 'warn list',
-  permissions: ['ModerateMembers'],
-  ephemeral: true,
-  options: {
-    user: { type: 'user', required: true },
-  },
-  async run({ interaction, options, t }) {
-    const list = (await warnings.get(options.user.id)) ?? [];
-    if (list.length === 0) {
-      await interaction.reply(
-        t('noWarnings', { user: options.user.toString() })
-      );
-      return;
-    }
-    await interaction.reply(
-      [
-        t('warningsOf', { user: options.user.toString(), count: list.length }),
-        ...list.map(
-          warning =>
-            `• ${timestamp(warning.at, 'R')} <@${warning.by}>: ${warning.reason}`
-        ),
-      ].join('\n')
-    );
-  },
-});

package/templates/moderation/src/presence.ts

@@ -1,6 +0,0 @@
-import { presence } from 'chapterjs';
-
-// What the bot shows under its name.
-export default presence({
-  activity: { type: 'watching', name: 'the server' },
-});

package/templates/moderation/tsconfig.json

@@ -1,20 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ESNext",
-    "module": "Preserve",
-    "moduleResolution": "Bundler",
-    "allowImportingTsExtensions": true,
-    "erasableSyntaxOnly": true,
-    "verbatimModuleSyntax": true,
-    "noEmit": true,
-    "strict": true,
-    "skipLibCheck": true,
-    "types": ["node"]
-  },
-  "files": [],
-  "references": [
-    {
-      "path": "./.chapterjs"
-    }
-  ]
-}

package/templates/music/.env.example

@@ -1,4 +0,0 @@
-# Your bot token: https://discord.com/developers/applications → your app → Bot → Reset Token
-BOT_TOKEN=
-# The ID of the server used by `chapterjs dev` (right-click the server → Copy Server ID)
-DEV_GUILD_ID=

package/templates/music/_gitignore

@@ -1,5 +0,0 @@
-node_modules
-dist
-.env
-.chapterjs
-data

package/templates/music/package.json

@@ -1,23 +0,0 @@
-{
-  "name": "music-bot",
-  "description": "A music player in voice: a queue, buttons, pause, skip and stop",
-  "private": true,
-  "type": "module",
-  "scripts": {
-    "dev": "chapterjs dev",
-    "start": "chapterjs start",
-    "build": "chapterjs build",
-    "typecheck": "tsc -b",
-    "postinstall": "chapterjs sync"
-  },
-  "dependencies": {
-    "chapterjs": "latest"
-  },
-  "devDependencies": {
-    "@types/node": "^24.0.0",
-    "typescript": "^7.0.2"
-  },
-  "engines": {
-    "node": ">=24"
-  }
-}

package/templates/music/src/music/leave.ts

@@ -1,18 +0,0 @@
-import { command } from 'chapterjs';
-import { clearQueue } from './queue';
-
-// /leave makes the bot leave the voice channel and forget the queue.
-export default command({
-  name: 'leave',
-  async run({ interaction, guild, t }) {
-    const voice = guild.voice;
-    if (!voice) {
-      await interaction.reply({ content: t('notInVoice'), ephemeral: true });
-      return;
-    }
-    clearQueue(guild);
-    // leave() ends what plays: the loop of play.ts stops too.
-    await voice.leave();
-    await interaction.reply(t('left'));
-  },
-});