7.0.1 β€’ Published 5 months ago

@sapphire/plugin-subcommands v7.0.1

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

8 months ago

7.0.2-next.aa2ed66

10 months ago

7.0.2-next.8bd5242

9 months ago

7.0.2-next.c74b327

10 months ago

7.0.2-next.d0e50be

11 months ago

7.0.2-next.3d9ff24

6 months ago

7.0.2-next.caa2477

11 months ago

7.0.2-next.19c2b86

10 months ago

7.0.2-next.fe87827

10 months ago

7.0.2-next.b5bb6ef

6 months ago

7.0.2-next.97d2052

11 months ago

7.0.2-next.5106865

5 months ago

7.0.2-next.e191096

7 months ago

7.0.2-next.7ee1582

9 months ago

7.0.2-next.cf3af1b

11 months ago

7.0.2-next.9c20163

5 months ago

7.0.2-next.cf109b1

7 months ago

7.0.2-next.d2ba80e

7 months ago

7.0.2-next.b4041d6

6 months ago

7.0.2-next.c1fcec2

7 months ago

7.0.2-next.b302651

6 months ago

7.0.2-next.b77af3f

12 months ago

7.0.2-next.3b38d76

7 months ago

7.0.2-next.2f82767

11 months ago

7.0.2-next.a1b506a

9 months ago

7.0.2-next.1fa448c

10 months ago

7.0.2-next.1ba68f6

5 months ago

7.0.2-next.c02e438

8 months ago

7.0.2-next.fb563e8

8 months ago

7.0.2-next.ae90958

5 months ago

7.0.2-next.147893c

6 months ago

7.0.2-next.b2f016e

7 months ago

7.0.2-next.f7c0c49

11 months ago

7.0.2-next.28de397

10 months ago

7.0.2-next.0d9024f

5 months ago

7.0.2-next.5c7dd0a

12 months ago

7.0.2-next.119ad9c

9 months ago

7.0.2-next.adf9c85

10 months ago

7.0.2-next.93b1905

11 months ago

7.0.2-next.4407e6d

6 months ago

7.0.2-next.3c60b44

6 months ago

7.0.2-next.ebf804c

9 months ago

7.0.2-next.3068466

11 months ago

7.0.2-next.2f6302d

10 months ago

7.0.2-next.413f547

10 months ago

7.0.2-next.c49da29

12 months ago

7.0.2-next.c246384

7 months ago

7.0.2-next.e879702

8 months ago

7.0.2-next.abbe598

6 months ago

7.0.2-next.214f8ce

8 months ago

7.0.2-next.73fd2f1

7 months ago

7.0.2-next.48a1e26

9 months ago

7.0.2-next.30c654b

7 months ago

7.0.2-next.8508a07

5 months ago

7.0.2-next.689cfd8

9 months ago

7.0.2-next.3e51fea

12 months ago

7.0.2-next.9d424f1

5 months ago

7.0.2-next.9f69aae

6 months ago

7.0.2-next.cb6bf89

6 months ago

7.0.2-next.d74a1ba

10 months ago

7.0.2-next.a7d24b1

9 months ago

7.0.2-next.954d495

12 months ago

7.0.2-next.cc47e19

8 months ago

7.0.2-next.db7c810

6 months ago

7.0.2-next.0260b3d

9 months ago

7.0.2-next.b8eca5f

6 months ago

7.0.2-next.79a4381

6 months ago

7.0.2-next.80816ca

12 months ago

7.0.2-next.4ce2946

6 months ago

7.0.2-next.7a67b07

7 months ago

7.0.2-next.e18dc27

5 months ago

7.0.2-next.865f053

11 months ago

7.0.2-next.c7aaadd

5 months ago

7.0.2-next.81c1ccb

7 months ago

7.0.2-next.aa45009

10 months ago

7.0.2-next.ea411df

12 months ago

7.0.2-next.6bd83f1

5 months ago

7.0.2-next.1ba8a04

7 months ago

7.0.2-next.d37e114

9 months ago

7.0.2-next.1c08cbe

12 months ago

7.0.2-next.63e9df0

12 months ago

7.0.2-next.7c80885

10 months ago

7.0.2-next.fe39124

9 months ago

7.0.2-next.10ed525

6 months ago

7.0.2-next.d6aaa3c

11 months ago

7.0.2-next.f34b540

11 months ago

7.0.2-next.1fc0c36

7 months ago

7.0.2-next.b368392

9 months ago

7.0.2-next.a24f9ec

6 months ago

7.0.2-next.93565ea

10 months ago

7.0.2-next.2e0d7f5

10 months ago

7.0.2-next.6664087

5 months ago

7.0.2-next.5854fd3

7 months ago

7.0.2-next.4b27ae4

8 months ago

7.0.2-next.ef59b2e

9 months ago

7.0.2-next.e1295d1

5 months ago

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.ccf3dc1

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

5 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