refactor: sub command => subcommand (#18)

DaStormer · web-flow · commit 95599c5b5366 · 2021-08-05T20:18:40.000+01:00
diff --git a/docs/examples/Slash Command Builders.md b/docs/examples/Slash Command Builders.md
@@ -48,20 +48,20 @@ boopCommand.addIntegerOption((option) =>
 const rawData = boopCommand.toJSON();
 ```
 
-## Sub commands and sub command groups
+## Subcommands and subcommand groups
 
 ```ts
 import { SlashCommandBuilder } from '@discordjs/builders';
 
 const pointsCommand = new SlashCommandBuilder().setName('points').setDescription('Lists or manages user points');
 
 // Add a manage group
-pointsCommand.addSubCommandGroup((group) =>
+pointsCommand.addSubcommandGroup((group) =>
 	group
 		.setName('manage')
 		.setDescription('Shows or manages points in the server')
-		.addSubCommand((subCommand) =>
-			subCommand
+		.addSubcommand((subcommand) =>
+			subcommand
 				.setName('user_points')
 				.setDescription("Alters a user's points")
 				.addUserOption((option) =>
@@ -83,15 +83,15 @@ pointsCommand.addSubCommandGroup((group) =>
 );
 
 // Add an information group
-pointsCommand.addSubCommandGroup((group) =>
+pointsCommand.addSubcommandGroup((group) =>
 	group
 		.setName('info')
 		.setDescription('Shows information about points in the guild')
-		.addSubCommand((subCommand) =>
-			subCommand.setName('total').setDescription('Tells you the total amount of points given in the guild'),
+		.addSubcommand((subcommand) =>
+			subcommand.setName('total').setDescription('Tells you the total amount of points given in the guild'),
 		)
-		.addSubCommand((subCommand) =>
-			subCommand
+		.addSubcommand((subcommand) =>
+			subcommand
 				.setName('user')
 				.setDescription("Lists a user's points")
 				.addUserOption((option) =>
diff --git a/src/index.ts b/src/index.ts
@@ -2,7 +2,7 @@ export * from './messages/formatters';
 
 export * as SlashCommandAssertions from './interactions/slashCommands/Assertions';
 export * from './interactions/slashCommands/SlashCommandBuilder';
-export * from './interactions/slashCommands/SlashCommandSubCommands';
+export * from './interactions/slashCommands/SlashCommandSubcommands';
 export * from './interactions/slashCommands/options/boolean';
 export * from './interactions/slashCommands/options/channel';
 export * from './interactions/slashCommands/options/integer';
diff --git a/src/interactions/slashCommands/Assertions.ts b/src/interactions/slashCommands/Assertions.ts
@@ -3,7 +3,7 @@ import type { APIApplicationCommandOptionChoice } from 'discord-api-types/v9';
 import ow from 'ow';
 import type { SlashCommandOptionBase } from './mixins/CommandOptionBase';
 import type { ToAPIApplicationCommandOptions } from './SlashCommandBuilder';
-import type { SlashCommandSubCommandBuilder, SlashCommandSubCommandGroupBuilder } from './SlashCommandSubCommands';
+import type { SlashCommandSubcommandBuilder, SlashCommandSubcommandGroupBuilder } from './SlashCommandSubcommands';
 
 export function validateRequiredParameters(
 	name: string,
@@ -49,7 +49,7 @@ export function validateMaxChoicesLength(choices: APIApplicationCommandOptionCho
 }
 
 export function assertReturnOfBuilder<
-	T extends SlashCommandOptionBase | SlashCommandSubCommandBuilder | SlashCommandSubCommandGroupBuilder,
+	T extends SlashCommandOptionBase | SlashCommandSubcommandBuilder | SlashCommandSubcommandGroupBuilder,
 >(input: unknown, ExpectedInstanceOf: new () => T): asserts input is T {
 	const instanceName = ExpectedInstanceOf.name;
 
diff --git a/src/interactions/slashCommands/SlashCommandBuilder.ts b/src/interactions/slashCommands/SlashCommandBuilder.ts
@@ -3,7 +3,7 @@ import { mix } from 'ts-mixer';
 import { assertReturnOfBuilder, validateMaxOptionsLength, validateRequiredParameters } from './Assertions';
 import { SharedNameAndDescription } from './mixins/NameAndDescription';
 import { SharedSlashCommandOptions } from './mixins/CommandOptions';
-import { SlashCommandSubCommandBuilder, SlashCommandSubCommandGroupBuilder } from './SlashCommandSubCommands';
+import { SlashCommandSubcommandBuilder, SlashCommandSubcommandGroupBuilder } from './SlashCommandSubcommands';
 
 @mix(SharedSlashCommandOptions, SharedNameAndDescription)
 export class SlashCommandBuilder {
@@ -37,27 +37,27 @@ export class SlashCommandBuilder {
 	}
 
 	/**
-	 * Adds a new sub command group to this command
-	 * @param input A function that returns a sub command group builder, or an already built builder
+	 * Adds a new subcommand group to this command
+	 * @param input A function that returns a subcommand group builder, or an already built builder
 	 */
-	public addSubCommandGroup(
+	public addSubcommandGroup(
 		input:
-			| SlashCommandSubCommandGroupBuilder
-			| ((subCommandGroup: SlashCommandSubCommandGroupBuilder) => SlashCommandSubCommandGroupBuilder),
-	): SlashCommandSubCommandGroupsOnlyBuilder {
+			| SlashCommandSubcommandGroupBuilder
+			| ((subcommandGroup: SlashCommandSubcommandGroupBuilder) => SlashCommandSubcommandGroupBuilder),
+	): SlashCommandSubcommandGroupsOnlyBuilder {
 		const { options } = this;
 
 		// First, assert options conditions - we cannot have more than 25 options
 		validateMaxOptionsLength(options);
 
-		// Make sure there is no sub command at the root level - if there is, throw
-		const hasSubCommands = options.some((item) => item instanceof SlashCommandSubCommandBuilder);
-		if (hasSubCommands) throw new RangeError(`You cannot mix sub commands and sub command groups at the root level.`);
+		// Make sure there is no subcommand at the root level - if there is, throw
+		const hasSubcommands = options.some((item) => item instanceof SlashCommandSubcommandBuilder);
+		if (hasSubcommands) throw new RangeError(`You cannot mix subcommands and subcommand groups at the root level.`);
 
 		// Get the final result
-		const result = typeof input === 'function' ? input(new SlashCommandSubCommandGroupBuilder()) : input;
+		const result = typeof input === 'function' ? input(new SlashCommandSubcommandGroupBuilder()) : input;
 
-		assertReturnOfBuilder(result, SlashCommandSubCommandGroupBuilder);
+		assertReturnOfBuilder(result, SlashCommandSubcommandGroupBuilder);
 
 		// Push it
 		options.push(result);
@@ -66,28 +66,28 @@ export class SlashCommandBuilder {
 	}
 
 	/**
-	 * Adds a new sub command to this command
-	 * @param input A function that returns a sub command builder, or an already built builder
+	 * Adds a new subcommand to this command
+	 * @param input A function that returns a subcommand builder, or an already built builder
 	 */
-	public addSubCommand(
+	public addSubcommand(
 		input:
-			| SlashCommandSubCommandBuilder
-			| ((subCommandGroup: SlashCommandSubCommandBuilder) => SlashCommandSubCommandBuilder),
-	): SlashCommandSubCommandsOnlyBuilder {
+			| SlashCommandSubcommandBuilder
+			| ((subcommandGroup: SlashCommandSubcommandBuilder) => SlashCommandSubcommandBuilder),
+	): SlashCommandSubcommandsOnlyBuilder {
 		const { options } = this;
 
 		// First, assert options conditions - we cannot have more than 25 options
 		validateMaxOptionsLength(options);
 
-		// Make sure there is no sub command at the root level - if there is, throw
-		const hasSubCommandGroups = options.some((item) => item instanceof SlashCommandSubCommandGroupBuilder);
-		if (hasSubCommandGroups)
-			throw new RangeError(`You cannot mix sub commands and sub command groups at the root level.`);
+		// Make sure there is no subcommand at the root level - if there is, throw
+		const hasSubcommandGroups = options.some((item) => item instanceof SlashCommandSubcommandGroupBuilder);
+		if (hasSubcommandGroups)
+			throw new RangeError(`You cannot mix subcommands and subcommand groups at the root level.`);
 
 		// Get the final result
-		const result = typeof input === 'function' ? input(new SlashCommandSubCommandBuilder()) : input;
+		const result = typeof input === 'function' ? input(new SlashCommandSubcommandBuilder()) : input;
 
-		assertReturnOfBuilder(result, SlashCommandSubCommandBuilder);
+		assertReturnOfBuilder(result, SlashCommandSubcommandBuilder);
 
 		// Push it
 		options.push(result);
@@ -98,13 +98,13 @@ export class SlashCommandBuilder {
 
 export interface SlashCommandBuilder extends SharedNameAndDescription, SharedSlashCommandOptions {}
 
-export interface SlashCommandSubCommandsOnlyBuilder
+export interface SlashCommandSubcommandsOnlyBuilder
 	extends SharedNameAndDescription,
-		Pick<SlashCommandBuilder, 'toJSON' | 'addSubCommand'> {}
+		Pick<SlashCommandBuilder, 'toJSON' | 'addSubcommand'> {}
 
-export interface SlashCommandSubCommandGroupsOnlyBuilder
+export interface SlashCommandSubcommandGroupsOnlyBuilder
 	extends SharedNameAndDescription,
-		Pick<SlashCommandBuilder, 'toJSON' | 'addSubCommandGroup'> {}
+		Pick<SlashCommandBuilder, 'toJSON' | 'addSubcommandGroup'> {}
 
 export interface SlashCommandOptionsOnlyBuilder
 	extends SharedNameAndDescription,
diff --git a/src/interactions/slashCommands/SlashCommandSubcommands.ts b/src/interactions/slashCommands/SlashCommandSubcommands.ts
@@ -6,45 +6,45 @@ import { SharedNameAndDescription } from './mixins/NameAndDescription';
 import type { ToAPIApplicationCommandOptions } from './SlashCommandBuilder';
 
 /**
- * Represents a folder for sub commands
+ * Represents a folder for subcommands
  *
  * For more information, go to https://discord.com/developers/docs/interactions/slash-commands#subcommands-and-subcommand-groups
  */
 @mix(SharedNameAndDescription)
-export class SlashCommandSubCommandGroupBuilder implements ToAPIApplicationCommandOptions {
+export class SlashCommandSubcommandGroupBuilder implements ToAPIApplicationCommandOptions {
 	/**
-	 * The name of this sub command group
+	 * The name of this subcommand group
 	 */
 	public readonly name: string = undefined!;
 
 	/**
-	 * The description of this sub command group
+	 * The description of this subcommand group
 	 */
 	public readonly description: string = undefined!;
 
 	/**
-	 * The sub commands part of this sub command group
+	 * The subcommands part of this subcommand group
 	 */
 	public readonly options: ToAPIApplicationCommandOptions[] = [];
 
 	/**
-	 * Adds a new sub command to this group
-	 * @param input A function that returns a sub command builder, or an already built builder
+	 * Adds a new subcommand to this group
+	 * @param input A function that returns a subcommand builder, or an already built builder
 	 */
-	public addSubCommand(
+	public addSubcommand(
 		input:
-			| SlashCommandSubCommandBuilder
-			| ((subCommandGroup: SlashCommandSubCommandBuilder) => SlashCommandSubCommandBuilder),
+			| SlashCommandSubcommandBuilder
+			| ((subcommandGroup: SlashCommandSubcommandBuilder) => SlashCommandSubcommandBuilder),
 	) {
 		const { options } = this;
 
 		// First, assert options conditions - we cannot have more than 25 options
 		validateMaxOptionsLength(options);
 
 		// Get the final result
-		const result = typeof input === 'function' ? input(new SlashCommandSubCommandBuilder()) : input;
+		const result = typeof input === 'function' ? input(new SlashCommandSubcommandBuilder()) : input;
 
-		assertReturnOfBuilder(result, SlashCommandSubCommandBuilder);
+		assertReturnOfBuilder(result, SlashCommandSubcommandBuilder);
 
 		// Push it
 		options.push(result);
@@ -63,27 +63,27 @@ export class SlashCommandSubCommandGroupBuilder implements ToAPIApplicationComma
 	}
 }
 
-export interface SlashCommandSubCommandGroupBuilder extends SharedNameAndDescription {}
+export interface SlashCommandSubcommandGroupBuilder extends SharedNameAndDescription {}
 
 /**
- * Represents a sub command
+ * Represents a subcommand
  *
  * For more information, go to https://discord.com/developers/docs/interactions/slash-commands#subcommands-and-subcommand-groups
  */
 @mix(SharedNameAndDescription, SharedSlashCommandOptions)
-export class SlashCommandSubCommandBuilder implements ToAPIApplicationCommandOptions {
+export class SlashCommandSubcommandBuilder implements ToAPIApplicationCommandOptions {
 	/**
-	 * The name of this sub command
+	 * The name of this subcommand
 	 */
 	public readonly name: string = undefined!;
 
 	/**
-	 * The description of this sub command
+	 * The description of this subcommand
 	 */
 	public readonly description: string = undefined!;
 
 	/**
-	 * The options of this sub command
+	 * The options of this subcommand
 	 */
 	public readonly options: ToAPIApplicationCommandOptions[] = [];
 
@@ -98,4 +98,4 @@ export class SlashCommandSubCommandBuilder implements ToAPIApplicationCommandOpt
 	}
 }
 
-export interface SlashCommandSubCommandBuilder extends SharedNameAndDescription, SharedSlashCommandOptions<false> {}
+export interface SlashCommandSubcommandBuilder extends SharedNameAndDescription, SharedSlashCommandOptions<false> {}
diff --git a/src/interactions/slashCommands/mixins/CommandOptions.ts b/src/interactions/slashCommands/mixins/CommandOptions.ts
@@ -9,7 +9,7 @@ import { SlashCommandStringOption } from '../options/string';
 import { SlashCommandUserOption } from '../options/user';
 import type { ToAPIApplicationCommandOptions } from '../SlashCommandBuilder';
 
-export class SharedSlashCommandOptions<ShouldOmitSubCommandFunctions = true> {
+export class SharedSlashCommandOptions<ShouldOmitSubcommandFunctions = true> {
 	public readonly options!: ToAPIApplicationCommandOptions[];
 
 	/**
@@ -81,7 +81,7 @@ export class SharedSlashCommandOptions<ShouldOmitSubCommandFunctions = true> {
 	private _sharedAddOptionMethod<T extends SlashCommandOptionBase>(
 		input: T | ((builder: T) => T),
 		Instance: new () => T,
-	): ShouldOmitSubCommandFunctions extends true ? Omit<this, 'addSubCommand' | 'addSubCommandGroup'> : this {
+	): ShouldOmitSubcommandFunctions extends true ? Omit<this, 'addSubcommand' | 'addSubcommandGroup'> : this {
 		const { options } = this;
 
 		// First, assert options conditions - we cannot have more than 25 options
diff --git a/tests/SlashCommands.test.ts b/tests/SlashCommands.test.ts
