7.0.1 β€’ Published 12 months ago

@sapphire/plugin-subcommands v7.0.1

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

Sapphire Logo

@sapphire/plugin-subcommands

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

GitHub codecov npm bundle size npm Depfu

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 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!

7.0.1-next.d512e6d

12 months ago

7.0.2-next.a0edebf

12 months ago

7.0.1-next.b4f1701

12 months ago

7.0.1-next.b2086e1

12 months ago

7.0.1-next.80d26ac

12 months ago

7.0.2-next.21d90cf

12 months ago

7.0.2-next.c75b7c2

12 months ago

7.0.1-next.e0e4d74

12 months ago

7.0.1

12 months ago

7.0.1-next.6b9d139

12 months ago

7.0.1-next.5395ccc

12 months ago

7.0.2-next.0782cfd

12 months ago

7.0.1-next.d9dd30c

12 months ago

7.0.1-next.12ccd3c

12 months ago

7.0.1-next.6a148bb

12 months ago

7.0.1-next.d2c9aaa

12 months ago

7.0.1-next.ccf3dc1

12 months ago

7.0.1-next.5aa5898

12 months ago

7.0.1-next.518ac87

12 months ago

7.0.1-next.9e3ae6f

12 months ago

7.0.1-next.8128717

12 months ago

7.0.0

1 year ago

6.0.3

2 years ago

6.0.2

2 years ago

6.0.1

2 years ago

6.0.0

2 years ago

4.0.2

2 years ago

5.0.0

2 years ago

5.1.0

2 years ago

4.3.0

2 years ago

4.2.2

2 years ago

4.2.1

2 years ago

4.2.0

2 years ago

4.1.0

2 years ago

4.1.1

2 years ago

4.0.1

3 years ago

3.2.4

3 years ago

4.0.0

3 years ago

3.2.2

3 years ago

3.2.3

3 years ago

3.2.1

3 years ago

3.2.0

3 years ago

3.1.1

3 years ago

3.1.0

3 years ago

2.2.1

3 years ago

2.2.2

3 years ago

3.0.0

3 years ago

2.2.0

4 years ago

2.1.2

4 years ago

2.1.1

4 years ago

2.1.3

4 years ago

2.1.0

4 years ago

2.0.2

4 years ago

2.0.1

4 years ago

2.0.0

4 years ago

1.0.6

4 years ago

1.0.5

4 years ago

1.0.4

4 years ago

1.0.3

5 years ago

1.0.2

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago