4.0.3 β€’ Published 9 months ago

@sapphire/plugin-editable-commands v4.0.3

Weekly downloads
-
License
MIT
Repository
github
Last release
9 months ago

Sapphire Logo

@sapphire/plugin-editable-commands

Plugin for @sapphire/framework to have editable commands.

GitHub codecov npm bundle size npm Depfu

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

	run(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, 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 run(message: Message) {
		const embed = new MessageEmbed()
			.setURL('https://github.com/sapphiredev/plugins')
			.setColor('#7586D8')
			.setDescription('Example description')
			.setTimestamp();

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

Editable Commands Documentation

For the full @sapphire/plugin-editable-commands documentation please refer to the TypeDoc generated documentation.

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 WithAddress
Open CollectiveClick Here
Ko-fiClick Here
PatreonClick Here
PayPalClick Here

Contributors ✨

Thanks goes to these wonderful people (emoji key):

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

4.0.3

9 months ago

4.0.4-next.21d90cf

9 months ago

4.0.3-next.d9dd30c

9 months ago

4.0.4-next.e0e4d74

9 months ago

4.0.4-next.a0edebf

9 months ago

4.0.4-next.b4f1701

9 months ago

4.0.4-next.6b9d139

9 months ago

4.0.4-next.0782cfd

9 months ago

4.0.3-next.d512e6d

9 months ago

4.0.4-next.5395ccc

9 months ago

4.0.4-next.dd4b95f

9 months ago

4.0.4-next.b2086e1

9 months ago

4.0.4-next.c75b7c2

9 months ago

4.0.3-next.80d26ac

9 months ago

4.0.3-next.12ccd3c

9 months ago

4.0.3-next.ccf3dc1

9 months ago

4.0.3-next.6a148bb

9 months ago

4.0.3-next.d2c9aaa

9 months ago

4.0.3-next.518ac87

9 months ago

4.0.3-next.5aa5898

9 months ago

4.0.3-next.9e3ae6f

9 months ago

4.0.3-next.8128717

9 months ago

4.0.3-next.a1d7d5e

10 months ago

4.0.3-next.fa73a83

10 months ago

4.0.3-next.352f2cd

10 months ago

4.0.3-next.5ea63b2

10 months ago

4.0.3-next.22ae85d

10 months ago

4.0.3-next.51af5e9

10 months ago

4.0.3-next.96ac961

10 months ago

4.0.3-next.f177359

10 months ago

4.0.3-next.f8b2f60

10 months ago

4.0.3-next.f61b06f

10 months ago

4.0.3-next.9b36bae

10 months ago

4.0.3-next.8de2057

10 months ago

4.0.3-next.e6fdc84

10 months ago

4.0.3-next.1c40781

11 months ago

4.0.3-next.f730be1

10 months ago

4.0.3-next.821ff70

11 months ago

4.0.3-next.30e71f4

11 months ago

4.0.3-next.fb8af18

11 months ago

4.0.3-next.56b0ad1

11 months ago

4.0.3-next.8b575e9

11 months ago

4.0.3-next.7ba75bc

11 months ago

4.0.3-next.e37f2d0

11 months ago

4.0.3-next.18d56e9

11 months ago

4.0.3-next.3b2c2df

12 months ago

4.0.3-next.f5fa1f7

12 months ago

4.0.3-next.5193167

12 months ago

4.0.3-next.834b446

12 months ago

4.0.3-next.677d87e

11 months ago

4.0.3-next.73cea33

11 months ago

4.0.3-next.e30dbc1

11 months ago

4.0.3-next.c2464a5

11 months ago

4.0.3-next.1054b61

12 months ago

4.0.3-next.1299f99

12 months ago

4.0.3-next.9f1cef4

12 months ago

4.0.3-next.fc8c5ba

12 months ago

4.0.3-next.280d498

12 months ago

4.0.3-next.73121df

12 months ago

4.0.3-next.49b6ce2

12 months ago

4.0.3-next.6e7a5bf

12 months ago

4.0.2

2 years ago

4.0.1

2 years ago

4.0.0

2 years ago

3.1.0

2 years ago

3.0.3

2 years ago

3.0.2

2 years ago

3.0.1

2 years ago

3.0.0

3 years ago

2.0.1

3 years ago

1.2.2

3 years ago

1.2.1

3 years ago

2.0.0

3 years ago

1.2.0

3 years ago

1.1.1

4 years ago

1.1.0

4 years ago

1.1.3

4 years ago

1.1.2

4 years ago

1.0.2

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago