Plugin Editable Commands

Introduction

@sapphire/plugin-editable-commands is a tiny wrapper on top of @skyra/editable-commands that re-exports everything and registers a listener to make commands also run on message edit.

Installation

npm

npm install @sapphire/plugin-editable-commands @sapphire/framework

yarn

yarn add @sapphire/plugin-editable-commands @sapphire/framework

pnpm

pnpm add @sapphire/plugin-editable-commands @sapphire/framework

Usage

In your main or setup file, register the plugin:

JavaScript

require('@sapphire/plugin-editable-commands/register');

ESM

import '@sapphire/plugin-editable-commands/register';

TypeScript

import '@sapphire/plugin-editable-commands/register';

Then use send or reply from the package, as shown below:

JavaScript

const { Command } = require('@sapphire/framework');
const { MessageEmbed } = require('discord.js');
const { send } = require('@sapphire/plugin-editable-commands');

module.exports = class UserCommand extends Command {
  constructor(context, options) {
    super(context, {
      ...options,
      description: 'A very cool command',
      requiredClientPermissions: ['EMBED_LINKS']
    });
  }

  messageRun(message) {
    const embed = new MessageEmbed()
      .setURL('https://github.com/skyra-project/editable-commands')
      .setColor('#7586D8')
      .setDescription('Example description')
      .setTimestamp();

    return send(message, { embeds: [embed] });
  }
};

ESM

import { Command } from '@sapphire/framework';
import { MessageEmbed } from 'discord.js';
import { send } from '@sapphire/plugin-editable-commands';

export class UserCommand extends Command {
  constructor(context, options) {
    super(context, {
      ...options,
      description: 'A very cool command',
      requiredClientPermissions: ['EMBED_LINKS']
    });
  }

  messageRun(message) {
    const embed = new MessageEmbed()
      .setURL('https://github.com/skyra-project/editable-commands')
      .setColor('#7586D8')
      .setDescription('Example description')
      .setTimestamp();

    return send(message, { embeds: [embed] });
  }
}

TypeScript

import { ApplyOptions } from '@sapphire/decorators';
import { Command, CommandOptions } from '@sapphire/framework';
import { Message, MessageEmbed } from 'discord.js';
import { send } from '@sapphire/plugin-editable-commands';

@ApplyOptions<CommandOptions>({
  description: 'A very cool command',
  requiredClientPermissions: ['EMBED_LINKS']
})
export class UserCommand extends Command {
  public messageRun(message: Message) {
    const embed = new MessageEmbed()
      .setURL('https://github.com/sapphiredev/plugins')
      .setColor('#7586D8')
      .setDescription('Example description')
      .setTimestamp();

    return send(message, { embeds: [embed] });
  }
}