Nail Polishing Minions

    @sapphire/plugin-editable-commands
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.1 • Public • Published

    Sapphire Logo

    @sapphire/plugin-editable-commands

    Plugin for @sapphire/framework to have editable commands.

    GitHub codecov npm bundle size npm

    Description

    A lightweight wrapper on top of @skyra/editable-commands that re-exports everything and registers an event to make commands also run on message edit.

    Features

    • Fully ready for TypeScript!
    • Includes ESM ready entrypoint
    • Full editable commands, attachments included!

    Installation

    @sapphire/plugin-editable-commands depends on the following packages. Be sure to install these along with this package!

    You can use the following command to install this package, or replace npm install with your package manager of choice.

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

    Usage

    JavaScript

    In your main or setup file, register the plugin:

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

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

    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] });
    	}
    };

    TypeScript

    In your main or setup file, register the plugin:

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

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

    import { ApplyOptions } from '@sapphire/decorators';
    import { Command } from '@sapphire/framework';
    import { Message, MessageEmbed } from 'discord.js';
    import { send } from '@sapphire/plugin-editable-commands';
    
    @ApplyOptions<Command.Options>({
    	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] });
    	}
    }

    Buy us some doughnuts

    Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!

    We accept donations through Open Collective, Ko-fi, Paypal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.

    Donate With Address
    Open Collective Click Here
    Ko-fi Click Here
    Patreon Click Here
    PayPal Click Here

    Contributors

    Thanks goes to these wonderful people (emoji key):


    Jeroen Claassens

    💻 🚇 📆

    Nejc Drobnic

    💻 📖

    Antonio Román

    💻

    Vlad Frangu

    👀

    depfu[bot]

    🚧

    dependabot[bot]

    🚧

    allcontributors[bot]

    📖

    Tyler J Russell

    💻 📖

    Stitch07

    💻 🐛

    PlatinBae

    📖

    Kaname

    💻 📖

    Elliot

    💻

    Lioness100

    💻 📖

    UndiedGamer

    💻

    Feralheart

    💻

    Jurien Hamaker

    💻

    renovate[bot]

    🚧

    WhiteSource Renovate

    🚧

    c43721

    💻

    megatank58

    💻

    FC

    💻

    Just a Badly Drawn TABS Dude

    💻

    newt :D

    💻

    Mzato

    💻

    Harry Allen

    💻

    Julian

    💻

    Krish

    💻

    Parbez

    💻

    ricardooow

    💻

    This project follows the all-contributors specification. Contributions of any kind welcome!

    Install

    npm i @sapphire/plugin-editable-commands

    DownloadsWeekly Downloads

    908

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    27.1 kB

    Total Files

    20

    Last publish

    Collaborators

    • favna
    • kyranet
    • vladfrangu