@sapphire/plugin-subcommands NPM

@sapphire/plugin-subcommands

Plugin for @sapphire/framework so your commands can have subcommands.

Description

Subcommands are a way to split 1 command into multiple. This can in particular be very useful for configuration commands with subcommands such as set, reset and remove.

Features

Fully ready for TypeScript!
Includes ESM ready entrypoint
Type generics for easy extension in TypeScript
Input/Output mapping

Installation

yarn add @sapphire/plugin-subcommands

Usage

With TypeScript:

import { SubCommandPluginCommand } from '@sapphire/plugin-subcommands';
import { ApplyOptions } from '@sapphire/decorators';
import type { Args } from '@sapphire/framework';
import type { Message } from 'discord.js';

// Using ApplyOptions decorator makes it easy to configure
@ApplyOptions<SubCommandPluginCommand.Options>({
	subCommands: ['add', 'remove', 'list', 'reset', { input: 'show', default: true }]
})
// Extend `SubCommandPluginCommand` instead of `Command`
export class UserCommand extends SubCommandPluginCommand {
	// Do not include a `run` method, each method name should match with the subcommand names
	public async add(message: Message, args: Args) {}

	public async remove(message: Message, args: Args) {}

	public async list(message: Message, args: Args) {}

	public async reset(message: Message, args: Args) {}

	public async show(message: Message, args: Args) {}
}

With JavaScript:

const { SubCommandPluginCommand } = require('@sapphire/plugin-subcommands');

// Extend `SubCommandPluginCommand` instead of `Command`
export class UserCommand extends SubCommandPluginCommand {

	constructor(context, options) {
		super(context, {
				...options,
				subCommands: ['add', 'remove', 'list', 'reset', { input: 'show', default: true }]
			}
		)
	}

	// Do not include a `run` method, each method name should match with the subcommand names
	public async add(message, args) {}

	public async remove(message, args) {}

	public async list(message, args) {}

	public async reset(message, args) {}

	public async show(message, args) {}
}

SubCommands Documentation

For the full @sapphire/plugin-subcommands 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 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):

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

sapphiredev plugin bot typescript ts yarn discord sapphire subcommands

@sapphire/utilities

@infinitebrahmanuniverse/nolb-_sapp @everything-registry/sub-chunk-807 @kbotdev/plugin-modules @zalastax/nolb-_sapp cardinal-bot

2 days ago

5 days ago

7 days ago

11 days ago

12 days ago

19 days ago

26 days ago

28 days ago

1 month ago

1 month ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

6.0.3-pr-534.00b527b.0

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

6.0.2-pr-531.68fab22.0

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

6.0.0-pr-513.cc0467d.0

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

6.0.0-pr-513.f0e9a18.0

5 months ago

6.0.0-next.37591c8.0

5 months ago

6.0.1-next.c8ee3e4.0

5 months ago

6.0.0-pr-513.97f3b7c.0

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

6.0.0-pr-512.86f3d06.0

5 months ago

8 months ago

8 months ago

8 months ago

10 months ago

7 months ago

10 months ago

7 months ago

7 months ago

6 months ago

9 months ago

8 months ago

4.2.2-pr-475.db0d5cc.0

8 months ago

6 months ago

6 months ago

10 months ago

6 months ago

9 months ago

6 months ago

9 months ago

10 months ago

7 months ago

10 months ago

8 months ago

8 months ago

6 months ago

6 months ago

6 months ago

10 months ago

6 months ago

7 months ago

8 months ago

8 months ago

10 months ago

4.1.0-pr-465.0a92431.0

9 months ago

6 months ago

7 months ago

6 months ago

8 months ago

7 months ago

8 months ago

7 months ago

10 months ago

6 months ago

8 months ago

8 months ago

9 months ago

10 months ago

6 months ago

7 months ago

8 months ago

9 months ago

8 months ago

10 months ago

7 months ago

7 months ago

9 months ago

9 months ago

4.2.2-pr-475.0a017c0.0

8 months ago

9 months ago

9 months ago

6 months ago

6 months ago

7 months ago

7 months ago

8 months ago

7 months ago

6 months ago

7 months ago

7 months ago

10 months ago

7 months ago

8 months ago

9 months ago

7 months ago

6 months ago

10 months ago

6 months ago

6 months ago

7 months ago

6 months ago

4.1.1-pr-469.d3a0e5e.0

9 months ago

9 months ago

8 months ago

8 months ago

6 months ago

9 months ago

9 months ago

5 months ago

9 months ago

6 months ago

7 months ago

8 months ago

8 months ago

9 months ago

7 months ago

6 months ago

8 months ago

7 months ago

7 months ago

6 months ago

7 months ago

9 months ago

9 months ago

6 months ago

10 months ago

7 months ago

9 months ago

7 months ago

6 months ago

8 months ago

9 months ago

6 months ago

6 months ago

9 months ago

1 year ago

12 months ago

1 year ago

12 months ago

12 months ago

11 months ago

1 year ago

1 year ago

11 months ago

12 months ago

1 year ago

11 months ago

11 months ago

1 year ago

4.0.2-pr-437.cfcbc0f.0

1 year ago

1 year ago

12 months ago

11 months ago

12 months ago

12 months ago

12 months ago

1 year ago

11 months ago

11 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

3.3.0-pr-403.fc7bac3.0

1 year ago

3.2.5-next.a5c93ef.0

1 year ago

4.0.0-next.7674782.0

1 year ago

4.0.1-next.20f53b2.0

1 year ago

3.3.0-pr-403.8a883d6.0

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

3.3.0-pr-403.05623a4.0

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

1 year ago

2 years ago

2 years ago

1 year ago

2 years ago

2 years ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

1 year ago

2 years ago

2 years ago

1 year ago

2 years ago

2 years ago

2 years ago

1 year ago

2 years ago

2 years ago

2 years ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3.2.2-pr-363.e4e2a04.0

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2.2.3-pr-334.52c8c14.0

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3.0.0-pr-271.fde7e776.0

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3.0.0-pr-271.8a04ac90.0

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3.0.0-pr-271.0258c7b7.0

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3.0.0-pr-271.36d909f3.0

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3.0.0-pr-271.3e0f2c71.0

2 years ago

2.2.1-next.660b231.0

2 years ago

2.2.1-next.cef882e.0

2 years ago

2.2.1-next.ffb97f6.0

2 years ago

3.0.0-pr-271.50e50e04.0

2 years ago

2.2.1-next.dbb84b1.0

2 years ago

2.2.1-next.741bf92.0

2 years ago

2.2.1-next.866735d.0

2 years ago

3.0.0-pr-271.38beab4b.0

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3.0.0-pr-271.cde343c3.0

2 years ago

2.2.1-next.971054c.0

2 years ago

2.2.1-pr-285.d64fcad.0

2 years ago

3.0.0-pr-271.67d865d1.0

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

2.0.2-next.4d25c235.0

3 years ago

2.0.2-next.f5501cdd.0

3 years ago

2.0.2-next.67705756.0

3 years ago

2.0.1

3 years ago

2.0.0

3 years ago

2.0.1-next.fe5c2253.0

3 years ago

2.0.2-next.e9f0692c.0

3 years ago

2.0.2-next.58cff52c.0

3 years ago

2.0.0-next.29607111.0

3 years ago

2.0.2-next.2cbddfcd.0

3 years ago

2.0.0-next.e5359d2a.0

3 years ago

2.0.1-next.a7a81905.0

3 years ago

2.0.0-next.3d0e484e.0

3 years ago

2.0.2-next.9bff8fe3.0

3 years ago

2.0.0-next.f8621b08.0

3 years ago

2.0.0-next.71b4ea5d.0

3 years ago

2.0.2-next.9703ddf7.0

3 years ago

2.0.2-next.8663c865.0

3 years ago

2.0.0-next.799ac045.0

3 years ago

2.0.0-next.1f577088.0

3 years ago

2.0.0-next.d75ed7fd.0

3 years ago

2.0.0-next.1fe55980.0

3 years ago

2.0.0-next.462c2687.0

3 years ago

2.0.0-next.1b34c1ec.0

3 years ago

2.0.0-next.2509ee4c.0

3 years ago

2.0.0-pr-145.4dbd0994.0

3 years ago

2.0.0-next.5ee876b3.0

3 years ago

2.0.0-next.96519de.0

3 years ago

2.0.0-next.1fbe876.0

3 years ago

2.0.0-next.9f83c09.0

3 years ago

2.0.0-next.d378aead.0

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

2.0.0-pr-97.11c4df4.0

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

1.0.6-next.73a35e98da56a27a05b2179188599fcaf1d87ff0.0

3 years ago

1.0.6-next.6094c1eac7f5af4dc8cd23601ec9a1a9c57c6142.0

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago