4.0.4 β€’ Published 7 months ago

@sapphire/plugin-editable-commands v4.0.4

Weekly downloads
-
License
MIT
Repository
github
Last release
7 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.5-next.c02e438

11 months ago

4.0.5-next.fb563e8

11 months ago

4.0.5-next.0260b3d

11 months ago

4.0.5-next.1ba68f6

8 months ago

4.0.5-next.c1fcec2

10 months ago

4.0.5-next.a24f9ec

9 months ago

4.0.5-next.db7c810

8 months ago

4.0.5-next.fe39124

12 months ago

4.0.5-next.79a4381

9 months ago

4.0.5-next.c7aaadd

7 months ago

4.0.5-next.6664087

8 months ago

4.0.5-next.0d9024f

8 months ago

4.0.5-next.7ee1582

12 months ago

4.0.5-next.ef59b2e

11 months ago

4.0.5-next.d37e114

12 months ago

4.0.5-next.b302651

9 months ago

4.0.5-next.b4041d6

8 months ago

4.0.5-next.8bd5242

12 months ago

4.0.5-next.9c20163

8 months ago

4.0.5-next.4407e6d

8 months ago

4.0.5-next.147893c

9 months ago

4.0.5-next.3f6fd7c

8 months ago

4.0.5-next.9d424f1

7 months ago

4.0.5-next.3d9ff24

8 months ago

4.0.5-next.73fd2f1

9 months ago

4.0.5-next.3c60b44

8 months ago

4.0.5-next.30c654b

10 months ago

4.0.5-next.b5bb6ef

8 months ago

4.0.5-next.e18dc27

7 months ago

4.0.5-next.e1295d1

8 months ago

4.0.4

1 year ago

4.0.5-next.9f69aae

9 months ago

4.0.5-next.1ba8a04

10 months ago

4.0.5-next.abbe598

8 months ago

4.0.5-next.a1b506a

12 months ago

4.0.5-next.ae90958

8 months ago

4.0.5-next.b8eca5f

9 months ago

4.0.5-next.48a1e26

12 months ago

4.0.5-next.b2f016e

9 months ago

4.0.5-next.4b27ae4

11 months ago

4.0.5-next.c246384

10 months ago

4.0.5-next.214f8ce

10 months ago

4.0.5-next.119ad9c

11 months ago

4.0.5-next.e879702

10 months ago

4.0.5-next.3b38d76

10 months ago

4.0.5-next.b368392

11 months ago

4.0.5-next.7a67b07

10 months ago

4.0.5-next.5106865

8 months ago

4.0.5-next.e191096

10 months ago

4.0.5-next.cb6bf89

8 months ago

4.0.5-next.5854fd3

10 months ago

4.0.5-next.1fc0c36

9 months ago

4.0.5-next.10ed525

8 months ago

4.0.5-next.d2ba80e

10 months ago

4.0.5-next.6bd83f1

8 months ago

4.0.5-next.cf109b1

10 months ago

4.0.5-next.a7d24b1

11 months ago

4.0.5-next.81c1ccb

10 months ago

4.0.5-next.4ce2946

9 months ago

4.0.5-next.87ed879

11 months ago

4.0.5-next.cc47e19

11 months ago

4.0.5-next.8508a07

7 months ago

4.0.5-next.ebf804c

12 months ago

4.0.5-next.689cfd8

12 months ago

4.0.3

1 year 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

3 years ago

3.0.1

3 years ago

3.0.0

3 years ago

2.0.1

3 years ago

1.2.2

4 years ago

1.2.1

4 years ago

2.0.0

3 years ago

1.2.0

4 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