From c2f316b305f0dcc3a486c8a6d98c33050d6c1bdd Mon Sep 17 00:00:00 2001 From: twlite <46562212+twlite@users.noreply.github.com> Date: Sun, 15 Dec 2024 00:14:24 +0545 Subject: [PATCH] chore: docgen --- apps/docs/content/docs/classes/ButtonKit.mdx | 28 +++++++++---------- apps/docs/content/docs/classes/CommandKit.mdx | 28 +++++++++---------- apps/docs/content/docs/enums/ReloadType.mdx | 2 +- .../content/docs/functions/defineConfig.mdx | 2 +- .../docs/content/docs/functions/getConfig.mdx | 2 +- .../content/docs/types/AutocompleteProps.mdx | 2 +- .../content/docs/types/CommandContext.mdx | 12 ++++---- apps/docs/content/docs/types/CommandData.mdx | 4 +-- .../content/docs/types/CommandFileObject.mdx | 18 ++++++------ ...tonBuilderInteractionCollectorDispatch.mdx | 2 +- ...nteractionCollectorDispatchContextData.mdx | 2 +- .../types/CommandKitButtonBuilderOnEnd.mdx | 2 +- .../content/docs/types/CommandKitConfig.mdx | 2 +- .../content/docs/types/CommandKitData.mdx | 2 +- .../content/docs/types/CommandKitOptions.mdx | 2 +- .../docs/content/docs/types/CommandObject.mdx | 2 +- .../content/docs/types/CommandOptions.mdx | 2 +- apps/docs/content/docs/types/CommandProps.mdx | 2 +- .../docs/types/ContextMenuCommandProps.mdx | 2 +- .../types/MessageContextMenuCommandProps.mdx | 2 +- .../docs/content/docs/types/ReloadOptions.mdx | 2 +- .../content/docs/types/SlashCommandProps.mdx | 2 +- .../types/UserContextMenuCommandProps.mdx | 2 +- .../content/docs/types/ValidationProps.mdx | 2 +- apps/docs/content/docs/variables/version.mdx | 2 +- package.json | 2 +- pnpm-lock.yaml | 10 +++---- scripts/links.ts | 28 +++++++++++++++++++ 28 files changed, 99 insertions(+), 71 deletions(-) diff --git a/apps/docs/content/docs/classes/ButtonKit.mdx b/apps/docs/content/docs/classes/ButtonKit.mdx index ae50306..9eac56a 100644 --- a/apps/docs/content/docs/classes/ButtonKit.mdx +++ b/apps/docs/content/docs/classes/ButtonKit.mdx @@ -6,7 +6,7 @@ description: No description provided ## ButtonKit extends ButtonBuilder ```typescript -ButtonKit(data); +new ButtonKit(data); ``` | Parameter | Type | Optional | @@ -23,7 +23,7 @@ The API data associated with this component. ### public dispose(): ButtonKit -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/components/ButtonKit.ts#L165) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/components/ButtonKit.ts#L165) ### public onClick(handler, data?): this @@ -59,7 +59,7 @@ button.onClick(null); | handler | CommandKitButtonBuilderInteractionCollectorDispatch | ❌ | The handler to run when the button is clicked | | data | CommandKitButtonBuilderInteractionCollectorDispatchContextData | ✅ | The context data to use for the interaction collector | -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/components/ButtonKit.ts#L74) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/components/ButtonKit.ts#L74) ### public onEnd(handler): this @@ -67,7 +67,7 @@ button.onClick(null); | --------- | ---------------------------- | -------- | | handler | CommandKitButtonBuilderOnEnd | ❌ | -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/components/ButtonKit.ts#L98) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/components/ButtonKit.ts#L98) ### public setCustomId(customId): this @@ -89,9 +89,9 @@ Sets whether this button is disabled. Sets the emoji to display on this button. -| Parameter | Type | Optional | Description | -| --------- | ------------------------ | -------- | ---------------- | -| emoji | ComponentEmojiResolvable | ❌ | The emoji to use | +| Parameter | Type | Optional | Description | +| --------- | ------------------------------------------------------------------------------------------------------------------- | -------- | ---------------- | +| emoji | [ComponentEmojiResolvable](https://discord.js.org/docs/packages/discord.js/main/ComponentEmojiResolvable:TypeAlias) | ❌ | The emoji to use | ### public setLabel(label): this @@ -113,9 +113,9 @@ Sets the SKU id that represents a purchasable SKU for this button. Sets the style of this button. -| Parameter | Type | Optional | Description | -| --------- | ----------- | -------- | ---------------- | -| style | ButtonStyle | ❌ | The style to use | +| Parameter | Type | Optional | Description | +| --------- | --------------------------------------------------------------------------------------- | -------- | ---------------- | +| style | [ButtonStyle](https://discord-api-types.dev/api/discord-api-types-v10/enum/ButtonStyle) | ❌ | The style to use | ### public setURL(url): this @@ -125,12 +125,12 @@ Sets the URL for this button. | --------- | ------------------------------------------------------------------------------------------------- | -------- | -------------- | | url | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | ❌ | The URL to use | -### public toJSON(): APIButtonComponent +### public toJSON(): [APIButtonComponent](https://discord-api-types.dev/api/discord-api-types-v10#APIButtonComponent) ComponentBuilder.toJSON ### public static from(other): ButtonBuilder -| Parameter | Type | Optional | -| --------- | ------------------ | ---------------------------------- | --- | -| other | APIButtonComponent | JSONEncodable\ | ❌ | +| Parameter | Type | Optional | +| --------- | ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------- | --- | +| other | [APIButtonComponent](https://discord-api-types.dev/api/discord-api-types-v10#APIButtonComponent) | JSONEncodable\<[APIButtonComponent](https://discord-api-types.dev/api/discord-api-types-v10#APIButtonComponent)> | ❌ | diff --git a/apps/docs/content/docs/classes/CommandKit.mdx b/apps/docs/content/docs/classes/CommandKit.mdx index 15e1b2b..681b622 100644 --- a/apps/docs/content/docs/classes/CommandKit.mdx +++ b/apps/docs/content/docs/classes/CommandKit.mdx @@ -6,7 +6,7 @@ description: No description provided ## CommandKit ```typescript -CommandKit(options); +new CommandKit(options); ``` | Parameter | Type | Optional | Description | @@ -17,47 +17,47 @@ CommandKit(options); ### public static \_instance: any -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L12) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L12) ### public client: any Get the client attached to this CommandKit instance. -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L42) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L42) ### public commandHandler: any Get command handler instance. -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L49) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L49) ### public commands: any -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L128) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L128) ### public commandsPath: any -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L144) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L144) ### public devGuildIds: any -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L172) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L172) ### public devRoleIds: any -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L179) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L179) ### public devUserIds: any -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L165) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L165) ### public eventsPath: any -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L151) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L151) ### public validationsPath: any -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L158) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L158) ## Methods @@ -69,16 +69,16 @@ Updates application commands with the latest from "commandsPath". | --------- | ------------- | -------- | | type | ReloadOptions | ✅ | -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L104) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L104) ### public reloadEvents(): [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[void](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined)> Updates application events with the latest from "eventsPath". -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L112) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L112) ### public reloadValidations(): [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[void](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined)> Updates application command validations with the latest from "validationsPath". -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/CommandKit.ts#L120) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/CommandKit.ts#L120) diff --git a/apps/docs/content/docs/enums/ReloadType.mdx b/apps/docs/content/docs/enums/ReloadType.mdx index 5f70a62..3040bcf 100644 --- a/apps/docs/content/docs/enums/ReloadType.mdx +++ b/apps/docs/content/docs/enums/ReloadType.mdx @@ -10,4 +10,4 @@ description: No description provided | Developer | 'dev' | N/A | Reload developer/guild commands. | | Global | 'global' | N/A | Reload global commands. | -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/types.ts#L275) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/types.ts#L275) diff --git a/apps/docs/content/docs/functions/defineConfig.mdx b/apps/docs/content/docs/functions/defineConfig.mdx index 328ed47..75a779c 100644 --- a/apps/docs/content/docs/functions/defineConfig.mdx +++ b/apps/docs/content/docs/functions/defineConfig.mdx @@ -9,4 +9,4 @@ description: No description provided | --------- | ---------------------------------------------------------------- | -------- | | config | PartialConfig\<[CommandKitConfig](/docs/types/CommandKitConfig)> | ❌ | -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/config.ts#L71) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/config.ts#L71) diff --git a/apps/docs/content/docs/functions/getConfig.mdx b/apps/docs/content/docs/functions/getConfig.mdx index 414e5a8..15e82cc 100644 --- a/apps/docs/content/docs/functions/getConfig.mdx +++ b/apps/docs/content/docs/functions/getConfig.mdx @@ -5,4 +5,4 @@ description: No description provided ### getConfig(): [CommandKitConfig](/docs/types/CommandKitConfig) -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/config.ts#L60) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/config.ts#L60) diff --git a/apps/docs/content/docs/types/AutocompleteProps.mdx b/apps/docs/content/docs/types/AutocompleteProps.mdx index ec481fb..6a84df9 100644 --- a/apps/docs/content/docs/types/AutocompleteProps.mdx +++ b/apps/docs/content/docs/types/AutocompleteProps.mdx @@ -13,4 +13,4 @@ Props for autocomplete command run functions. | handler | [CommandKit](/docs/classes/CommandKit) | N/A | The current CommandKit handler instance. | | interaction | [AutocompleteInteraction\](https://discord.js.org/docs/packages/discord.js/main/AutocompleteInteraction:Class) | N/A | The current autocomplete command interaction object. | -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/types.ts#L137) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/types.ts#L137) diff --git a/apps/docs/content/docs/types/CommandContext.mdx b/apps/docs/content/docs/types/CommandContext.mdx index 7cb255a..6318b5c 100644 --- a/apps/docs/content/docs/types/CommandContext.mdx +++ b/apps/docs/content/docs/types/CommandContext.mdx @@ -7,10 +7,10 @@ description: Represents a command context. Represents a command context. -| Property | Type | Value | Description | -| ----------- | ------------------------------------------------------------------------------------- | ----- | -------------------------------------------- | -| client | [Client\](https://discord.js.org/docs/packages/discord.js/main/Client:Class) | N/A | The client that instantiated this command. | -| handler | [CommandKit](/docs/classes/CommandKit) | N/A | The command data. | -| interaction | Interaction\ | N/A | The interaction that triggered this command. | +| Property | Type | Value | Description | +| ----------- | ------------------------------------------------------------------------------------------------- | ----- | -------------------------------------------- | +| client | [Client\](https://discord.js.org/docs/packages/discord.js/main/Client:Class) | N/A | The client that instantiated this command. | +| handler | [CommandKit](/docs/classes/CommandKit) | N/A | The command data. | +| interaction | [Interaction\](https://discord.js.org/docs/packages/discord.js/main/Interaction:Class) | N/A | The interaction that triggered this command. | -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/types.ts#L71) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/types.ts#L71) diff --git a/apps/docs/content/docs/types/CommandData.mdx b/apps/docs/content/docs/types/CommandData.mdx index 8be6499..3e9e949 100644 --- a/apps/docs/content/docs/types/CommandData.mdx +++ b/apps/docs/content/docs/types/CommandData.mdx @@ -5,6 +5,6 @@ description: No description provided ## CommandData -- Type: RESTPostAPIApplicationCommandsJSONBody +- Type: [RESTPostAPIApplicationCommandsJSONBody](https://discord-api-types.dev/api/discord-api-types-v10#RESTPostAPIApplicationCommandsJSONBody) -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/types.ts#L247) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/types.ts#L247) diff --git a/apps/docs/content/docs/types/CommandFileObject.mdx b/apps/docs/content/docs/types/CommandFileObject.mdx index 376c99b..d67f855 100644 --- a/apps/docs/content/docs/types/CommandFileObject.mdx +++ b/apps/docs/content/docs/types/CommandFileObject.mdx @@ -7,13 +7,13 @@ description: Represents a command file. Represents a command file. -| Property | Type | Value | -| ------------ | ------------------------------------------------------------------------------------------------- | ----- | -| autocomplete | ( ctx: CommandContext\ ) => void | N/A | -| category | null \| string | N/A | -| data | RESTPostAPIApplicationCommandsJSONBody | N/A | -| filePath | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | N/A | -| options | CommandOptions | N/A | -| run | ( ctx: CommandContext\ ) => void | N/A | +| Property | Type | Value | +| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------- | ----- | +| autocomplete | ( ctx: CommandContext\ ) => void | N/A | +| category | null \| string | N/A | +| data | [RESTPostAPIApplicationCommandsJSONBody](https://discord-api-types.dev/api/discord-api-types-v10#RESTPostAPIApplicationCommandsJSONBody) | N/A | +| filePath | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | N/A | +| options | CommandOptions | N/A | +| run | ( ctx: CommandContext\ ) => void | N/A | -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/types.ts#L92) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/types.ts#L92) diff --git a/apps/docs/content/docs/types/CommandKitButtonBuilderInteractionCollectorDispatch.mdx b/apps/docs/content/docs/types/CommandKitButtonBuilderInteractionCollectorDispatch.mdx index cf2b6dc..cd68e6f 100644 --- a/apps/docs/content/docs/types/CommandKitButtonBuilderInteractionCollectorDispatch.mdx +++ b/apps/docs/content/docs/types/CommandKitButtonBuilderInteractionCollectorDispatch.mdx @@ -12,4 +12,4 @@ If the first argument is null, it means that the interaction collector has been interaction: ButtonInteraction ) => Awaitable\ -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/components/ButtonKit.ts#L17) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/components/ButtonKit.ts#L17) diff --git a/apps/docs/content/docs/types/CommandKitButtonBuilderInteractionCollectorDispatchContextData.mdx b/apps/docs/content/docs/types/CommandKitButtonBuilderInteractionCollectorDispatchContextData.mdx index 754b045..0bd191c 100644 --- a/apps/docs/content/docs/types/CommandKitButtonBuilderInteractionCollectorDispatchContextData.mdx +++ b/apps/docs/content/docs/types/CommandKitButtonBuilderInteractionCollectorDispatchContextData.mdx @@ -11,4 +11,4 @@ description: No description provided time: number } & Omit\, 'filter' \| 'componentType'> -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/components/ButtonKit.ts#L23) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/components/ButtonKit.ts#L23) diff --git a/apps/docs/content/docs/types/CommandKitButtonBuilderOnEnd.mdx b/apps/docs/content/docs/types/CommandKitButtonBuilderOnEnd.mdx index 9c75eca..dbb6bd7 100644 --- a/apps/docs/content/docs/types/CommandKitButtonBuilderOnEnd.mdx +++ b/apps/docs/content/docs/types/CommandKitButtonBuilderOnEnd.mdx @@ -9,4 +9,4 @@ description: No description provided ...args: unknown\[] ) => Awaitable\ -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/components/ButtonKit.ts#L21) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/components/ButtonKit.ts#L21) diff --git a/apps/docs/content/docs/types/CommandKitConfig.mdx b/apps/docs/content/docs/types/CommandKitConfig.mdx index 5d23827..122009c 100644 --- a/apps/docs/content/docs/types/CommandKitConfig.mdx +++ b/apps/docs/content/docs/types/CommandKitConfig.mdx @@ -19,4 +19,4 @@ description: No description provided | src | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | N/A | The source directory of the project. | | watch | [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) | N/A | Whether or not to use the watch mode. Defaults to `true`. | -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/config.ts#L1) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/config.ts#L1) diff --git a/apps/docs/content/docs/types/CommandKitData.mdx b/apps/docs/content/docs/types/CommandKitData.mdx index b621c55..321e351 100644 --- a/apps/docs/content/docs/types/CommandKitData.mdx +++ b/apps/docs/content/docs/types/CommandKitData.mdx @@ -22,4 +22,4 @@ Private data for the CommandKit class. | validationHandler | ValidationHandler | N/A | N/A | | validationsPath | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | N/A | The path to the validations directory. | -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/types.ts#L62) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/types.ts#L62) diff --git a/apps/docs/content/docs/types/CommandKitOptions.mdx b/apps/docs/content/docs/types/CommandKitOptions.mdx index 93f5ff6..ebb8206 100644 --- a/apps/docs/content/docs/types/CommandKitOptions.mdx +++ b/apps/docs/content/docs/types/CommandKitOptions.mdx @@ -19,4 +19,4 @@ Options for instantiating a CommandKit handler. | skipBuiltInValidations | [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) | N/A | Skip CommandKit's built-in validations (for devOnly commands). | | validationsPath | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | N/A | The path to the validations directory. | -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/types.ts#L20) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/types.ts#L20) diff --git a/apps/docs/content/docs/types/CommandObject.mdx b/apps/docs/content/docs/types/CommandObject.mdx index 544af2c..f7957ee 100644 --- a/apps/docs/content/docs/types/CommandObject.mdx +++ b/apps/docs/content/docs/types/CommandObject.mdx @@ -12,4 +12,4 @@ description: No description provided options: CommandOptions } -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/types.ts#L249) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/types.ts#L249) diff --git a/apps/docs/content/docs/types/CommandOptions.mdx b/apps/docs/content/docs/types/CommandOptions.mdx index 0fb0096..5632b93 100644 --- a/apps/docs/content/docs/types/CommandOptions.mdx +++ b/apps/docs/content/docs/types/CommandOptions.mdx @@ -15,4 +15,4 @@ Additional command configuration options. | guildOnly | [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) | N/A | A boolean indicating whether the command is guild-only. Used for built-in validation. | | userPermissions | 'CreateInstantInvite' \| 'KickMembers' \| 'BanMembers' \| 'Administrator' \| 'ManageChannels' \| 'ManageGuild' \| 'AddReactions' \| 'ViewAuditLog' \| 'PrioritySpeaker' \| 'Stream' \| 'ViewChannel' \| 'SendMessages' \| 'SendTTSMessages' \| 'ManageMessages' \| 'EmbedLinks' \| 'AttachFiles' \| 'ReadMessageHistory' \| 'MentionEveryone' \| 'UseExternalEmojis' \| 'ViewGuildInsights' \| 'Connect' \| 'Speak' \| 'MuteMembers' \| 'DeafenMembers' \| 'MoveMembers' \| 'UseVAD' \| 'ChangeNickname' \| 'ManageNicknames' \| 'ManageRoles' \| 'ManageWebhooks' \| 'ManageEmojisAndStickers' \| 'ManageGuildExpressions' \| 'UseApplicationCommands' \| 'RequestToSpeak' \| 'ManageEvents' \| 'ManageThreads' \| 'CreatePublicThreads' \| 'CreatePrivateThreads' \| 'UseExternalStickers' \| 'SendMessagesInThreads' \| 'UseEmbeddedActivities' \| 'ModerateMembers' \| 'ViewCreatorMonetizationAnalytics' \| 'UseSoundboard' \| 'CreateGuildExpressions' \| 'CreateEvents' \| 'UseExternalSounds' \| 'SendVoiceMessages' \| 'SendPolls' \| 'UseExternalApps' \| Array\<'CreateInstantInvite' \| 'KickMembers' \| 'BanMembers' \| 'Administrator' \| 'ManageChannels' \| 'ManageGuild' \| 'AddReactions' \| 'ViewAuditLog' \| 'PrioritySpeaker' \| 'Stream' \| 'ViewChannel' \| 'SendMessages' \| 'SendTTSMessages' \| 'ManageMessages' \| 'EmbedLinks' \| 'AttachFiles' \| 'ReadMessageHistory' \| 'MentionEveryone' \| 'UseExternalEmojis' \| 'ViewGuildInsights' \| 'Connect' \| 'Speak' \| 'MuteMembers' \| 'DeafenMembers' \| 'MoveMembers' \| 'UseVAD' \| 'ChangeNickname' \| 'ManageNicknames' \| 'ManageRoles' \| 'ManageWebhooks' \| 'ManageEmojisAndStickers' \| 'ManageGuildExpressions' \| 'UseApplicationCommands' \| 'RequestToSpeak' \| 'ManageEvents' \| 'ManageThreads' \| 'CreatePublicThreads' \| 'CreatePrivateThreads' \| 'UseExternalStickers' \| 'SendMessagesInThreads' \| 'UseEmbeddedActivities' \| 'ModerateMembers' \| 'ViewCreatorMonetizationAnalytics' \| 'UseSoundboard' \| 'CreateGuildExpressions' \| 'CreateEvents' \| 'UseExternalSounds' \| 'SendVoiceMessages' \| 'SendPolls' \| 'UseExternalApps'> | N/A | A string or array of permissions that a user needs for the current command to be executed. Used for built-in validation. | -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/types.ts#L206) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/types.ts#L206) diff --git a/apps/docs/content/docs/types/CommandProps.mdx b/apps/docs/content/docs/types/CommandProps.mdx index d5169eb..b660bf4 100644 --- a/apps/docs/content/docs/types/CommandProps.mdx +++ b/apps/docs/content/docs/types/CommandProps.mdx @@ -13,4 +13,4 @@ Props for command run functions. | handler | [CommandKit](/docs/classes/CommandKit) | N/A | The current CommandKit handler instance. | | interaction | ChatInputCommandInteraction\ \| MessageContextMenuCommandInteraction\ \| UserContextMenuCommandInteraction\ \| AutocompleteInteraction\ \| ContextMenuCommandInteraction\ | N/A | The current command interaction object. | -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/types.ts#L114) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/types.ts#L114) diff --git a/apps/docs/content/docs/types/ContextMenuCommandProps.mdx b/apps/docs/content/docs/types/ContextMenuCommandProps.mdx index a93f612..683ea8f 100644 --- a/apps/docs/content/docs/types/ContextMenuCommandProps.mdx +++ b/apps/docs/content/docs/types/ContextMenuCommandProps.mdx @@ -13,4 +13,4 @@ Props for context menu command run functions. | handler | [CommandKit](/docs/classes/CommandKit) | N/A | The current CommandKit handler instance. | | interaction | [ContextMenuCommandInteraction\](https://discord.js.org/docs/packages/discord.js/main/ContextMenuCommandInteraction:Class) | N/A | The current context menu command interaction object. | -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/types.ts#L157) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/types.ts#L157) diff --git a/apps/docs/content/docs/types/MessageContextMenuCommandProps.mdx b/apps/docs/content/docs/types/MessageContextMenuCommandProps.mdx index b6fabdf..6d35a9d 100644 --- a/apps/docs/content/docs/types/MessageContextMenuCommandProps.mdx +++ b/apps/docs/content/docs/types/MessageContextMenuCommandProps.mdx @@ -13,4 +13,4 @@ Props for message context menu command run functions. | handler | [CommandKit](/docs/classes/CommandKit) | N/A | The current CommandKit handler instance. | | interaction | [MessageContextMenuCommandInteraction\](https://discord.js.org/docs/packages/discord.js/main/MessageContextMenuCommandInteraction:Class) | N/A | The current command interaction object. | -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/types.ts#L174) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/types.ts#L174) diff --git a/apps/docs/content/docs/types/ReloadOptions.mdx b/apps/docs/content/docs/types/ReloadOptions.mdx index d8cdb78..be3536e 100644 --- a/apps/docs/content/docs/types/ReloadOptions.mdx +++ b/apps/docs/content/docs/types/ReloadOptions.mdx @@ -9,4 +9,4 @@ A reload type for commands. - Type: 'dev' \| 'global' \| ReloadType -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/types.ts#L109) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/types.ts#L109) diff --git a/apps/docs/content/docs/types/SlashCommandProps.mdx b/apps/docs/content/docs/types/SlashCommandProps.mdx index 5d61fd4..8e9ca72 100644 --- a/apps/docs/content/docs/types/SlashCommandProps.mdx +++ b/apps/docs/content/docs/types/SlashCommandProps.mdx @@ -13,4 +13,4 @@ Props for slash (chat input) command run functions. | handler | [CommandKit](/docs/classes/CommandKit) | N/A | The current CommandKit handler instance. | | interaction | [ChatInputCommandInteraction\](https://discord.js.org/docs/packages/discord.js/main/ChatInputCommandInteraction:Class) | N/A | The current slash (chat input) command interaction object. | -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/types.ts#L147) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/types.ts#L147) diff --git a/apps/docs/content/docs/types/UserContextMenuCommandProps.mdx b/apps/docs/content/docs/types/UserContextMenuCommandProps.mdx index b1010e1..d2506a2 100644 --- a/apps/docs/content/docs/types/UserContextMenuCommandProps.mdx +++ b/apps/docs/content/docs/types/UserContextMenuCommandProps.mdx @@ -13,4 +13,4 @@ Props for user context menu command run functions. | handler | [CommandKit](/docs/classes/CommandKit) | N/A | The current CommandKit handler instance. | | interaction | [UserContextMenuCommandInteraction\](https://discord.js.org/docs/packages/discord.js/main/UserContextMenuCommandInteraction:Class) | N/A | The current command interaction object. | -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/types.ts#L167) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/types.ts#L167) diff --git a/apps/docs/content/docs/types/ValidationProps.mdx b/apps/docs/content/docs/types/ValidationProps.mdx index 46e9425..2de3b53 100644 --- a/apps/docs/content/docs/types/ValidationProps.mdx +++ b/apps/docs/content/docs/types/ValidationProps.mdx @@ -14,4 +14,4 @@ Props for command validation functions. | handler | [CommandKit](/docs/classes/CommandKit) | N/A | The current CommandKit handler instance. | | interaction | ChatInputCommandInteraction\ \| AutocompleteInteraction\ \| ContextMenuCommandInteraction\ | N/A | The current command interaction object. | -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/types.ts#L181) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/types.ts#L181) diff --git a/apps/docs/content/docs/variables/version.mdx b/apps/docs/content/docs/variables/version.mdx index ad8090b..d7241e2 100644 --- a/apps/docs/content/docs/variables/version.mdx +++ b/apps/docs/content/docs/variables/version.mdx @@ -9,4 +9,4 @@ The current version of CommandKit. - Type: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) -- [Source](https://github.com/underctrl-io/commandkit/blob/6165e6a1296074517b13a566a6b705fa6b059dbc/packages/commandkit/src/index.ts#L11) +- [Source](https://github.com/underctrl-io/commandkit/blob/7e608cc8c859522925eced5a54de0a18e9cbc1e9/packages/commandkit/src/index.ts#L11) diff --git a/package.json b/package.json index 65ed523..af504e4 100644 --- a/package.json +++ b/package.json @@ -13,7 +13,7 @@ }, "devDependencies": { "@types/node": "^22.10.2", - "micro-docgen": "^0.3.4", + "micro-docgen": "^0.3.5", "prettier": "^3.0.3", "tsx": "^4.7.0", "turbo": "^2.3.3" diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 0209a2e..1fbd3cb 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -12,8 +12,8 @@ importers: specifier: ^22.10.2 version: 22.10.2 micro-docgen: - specifier: ^0.3.4 - version: 0.3.4 + specifier: ^0.3.5 + version: 0.3.5 prettier: specifier: ^3.0.3 version: 3.0.3 @@ -2894,8 +2894,8 @@ packages: resolution: {integrity: sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==} engines: {node: '>= 8'} - micro-docgen@0.3.4: - resolution: {integrity: sha512-PH4LL7wPc1n80FUhrRsYxYH9tF6od3ofnruiWbFl1yRfTUKggSpcbeEyOF6O5SAfjriQdoDNY0y4ENlM/SZ4Rg==} + micro-docgen@0.3.5: + resolution: {integrity: sha512-BTKTwlDkOHpnRFebLLkEKPYmif1ieoPAFay34ZsgRDW9EMLv0Gx53+oBmQzfyv6uA+P8nwz4+f50v+/x1RD0bg==} hasBin: true micromark-core-commonmark@2.0.2: @@ -7197,7 +7197,7 @@ snapshots: merge2@1.4.1: {} - micro-docgen@0.3.4: + micro-docgen@0.3.5: dependencies: commander: 12.1.0 common-tags: 1.8.2 diff --git a/scripts/links.ts b/scripts/links.ts index b74c2ca..6ab6ff3 100644 --- a/scripts/links.ts +++ b/scripts/links.ts @@ -41,6 +41,34 @@ const links = [ 'UserContextMenuCommandInteraction', ], }, + { + link: 'https://discord.js.org/docs/packages/discord.js/main/Interaction:Class', + patterns: ['Interaction', 'Interaction'], + }, + { + link: 'https://discord.js.org/docs/packages/discord.js/main/ButtonComponentData:TypeAlias', + patterns: ['ButtonComponentData'], + }, + { + link: 'https://discord.js.org/docs/packages/discord.js/main/ComponentEmojiResolvable:TypeAlias', + patterns: ['ComponentEmojiResolvable'], + }, + { + link: 'https://discord-api-types.dev/api/discord-api-types-v10#RESTPostAPIApplicationCommandsJSONBody', + patterns: ['RESTPostAPIApplicationCommandsJSONBody'], + }, + { + link: 'https://discord-api-types.dev/api/discord-api-types-v10#RESTPutAPIApplicationCommandsJSONBody', + patterns: ['RESTPutAPIApplicationCommandsJSONBody'], + }, + { + link: 'https://discord-api-types.dev/api/discord-api-types-v10#APIButtonComponent', + patterns: ['APIButtonComponent'], + }, + { + link: 'https://discord-api-types.dev/api/discord-api-types-v10/enum/ButtonStyle', + patterns: ['ButtonStyle'], + }, ]; const DiscordLinks: MicroDocgenLink = {};