chore: update jsdoc comments

.changeset/lemon-eggs-grow.md

@@ -0,0 +1,6 @@
+---
+"create-jellycommands": patch
+"jellycommands": patch
+---
+
+chore: update jsdoc comments

packages/create-jellycommands/src/js/src/app.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="jellycommands/ambient" />
 
-// See https://jellycommands.dev/guide/props
+// See https://jellycommands.dev/components/props
 interface Props {}

packages/create-jellycommands/src/js/src/index.js

@@ -3,7 +3,7 @@ import { JellyCommands } from 'jellycommands';
 import { IntentsBitField } from 'discord.js';
 
 const client = new JellyCommands({
-	// https://jellycommands.dev/guide/overview#components
+	// https://jellycommands.dev/components
 	components: 'src/components',
 
 	clientOptions: {
@@ -12,11 +12,11 @@ const client = new JellyCommands({
 
 	dev: {
 		// In testing we should enable this, it will make all our commands register in our testing guild
-		// https://jellycommands.dev/guide/commands/dev#global-dev-mode
+		// https://jellycommands.dev/components/commands/dev
 		global: true,
 
 		// Put your testing guild id here
-		// https://jellycommands.dev/guide/commands/dev#setup
+		// https://jellycommands.dev/components/commands/dev
 		guilds: [''],
 	},
 });

packages/create-jellycommands/src/ts/src/app.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="jellycommands/ambient" />
 
-// See https://jellycommands.dev/guide/props
+// See https://jellycommands.dev/components/props
 interface Props {}

packages/create-jellycommands/src/ts/src/index.ts

@@ -3,7 +3,7 @@ import { JellyCommands } from 'jellycommands';
 import { IntentsBitField } from 'discord.js';
 
 const client = new JellyCommands({
-	// https://jellycommands.dev/guide/overview#components
+	// https://jellycommands.dev/components
 	components: 'src/components',
 
 	clientOptions: {
@@ -12,11 +12,11 @@ const client = new JellyCommands({
 
 	dev: {
 		// In testing we should enable this, it will make all our commands register in our testing guild
-		// https://jellycommands.dev/guide/commands/dev#global-dev-mode
+		// https://jellycommands.dev/components/commands/dev
 		global: true,
 
 		// Put your testing guild id here
-		// https://jellycommands.dev/guide/commands/dev#setup
+		// https://jellycommands.dev/components/commands/dev
 		guilds: [''],
 	},
 });

packages/jellycommands/src/JellyCommands.ts

@@ -29,7 +29,7 @@ import {
  * client.login();
  * ```
  *
- * @see https://jellycommands.dev/guide/overview/#the-client
+ * @see https://jellycommands.dev/getting-started#the-client
  */
 export class JellyCommands extends Client {
 	// todo these options include data that isn't relevant (like given components) so mayb shouldn't be here
@@ -45,7 +45,7 @@ export class JellyCommands extends Client {
 
 	/**
 	 * Props are used to pass data around your client.
-	 * @see https://jellycommands.dev/guide/props/
+	 * @see https://jellycommands.dev/components/props/
 	 */
 	public readonly props: Props;
 
@@ -75,17 +75,17 @@ export class JellyCommands extends Client {
 		this.props = {
 			get() {
 				throw new Error(
-					'props.get has been removed, SEE: https://jellycommands.dev/guide/migrate/props',
+					'props.get has been removed, SEE: https://jellycommands.dev/migrate/props',
 				);
 			},
 			set() {
 				throw new Error(
-					'props.set has been removed, SEE: https://jellycommands.dev/guide/migrate/props',
+					'props.set has been removed, SEE: https://jellycommands.dev/migrate/props',
 				);
 			},
 			has() {
 				throw new Error(
-					'props.has has been removed, SEE: https://jellycommands.dev/guide/migrate/props',
+					'props.has has been removed, SEE: https://jellycommands.dev/migrate/props',
 				);
 			},
 			...this.props,

packages/jellycommands/src/components/buttons/buttons.ts

@@ -14,7 +14,7 @@ export type ButtonCallback = (context: {
 
 /**
  * Represents a button.
- * @see https://jellycommands.dev/guide/buttons/files/
+ * @see https://jellycommands.dev/components/buttons
  */
 export class Button extends Component<ButtonOptions> {
 	public readonly options: ButtonOptions;
@@ -34,7 +34,7 @@ export class Button extends Component<ButtonOptions> {
 
 /**
  * Creates a button.
- * @see https://jellycommands.dev/guide/buttons/files/
+ * @see https://jellycommands.dev/components/buttons
  */
 export const button = (options: ButtonOptions & { run: ButtonCallback }) => {
 	const { run, ...rest } = options;

packages/jellycommands/src/components/buttons/plugin.ts

@@ -17,6 +17,7 @@ async function findButton(
 				break;
 
 			case 'function':
+				// todo should this be sync only? might cause issues when not deffered
 				if (await id(incomingId)) return button;
 				break;
 

packages/jellycommands/src/components/commands/types/commands/Command.ts

@@ -22,14 +22,20 @@ export type AutocompleteHandler = (options: {
 
 /**
  * Represents a slash command.
- * @see https://jellycommands.dev/guide/commands/files/#slash-commands
+ * @see https://jellycommands.dev/components/commands
  */
 export class Command extends BaseCommand<
 	CommandOptions,
 	ChatInputCommandInteraction
 > {
 	public readonly type = ApplicationCommandType.ChatInput;
 
+	/**
+	 * On some options you can enable autocomplete, which allows you to
+	 * provide suggestions as a user types your command option.
+	 *
+	 * @see https://jellycommands.dev/components/commands/slash#autocomplete
+	 */
 	public readonly autocomplete?: AutocompleteHandler;
 
 	constructor({
@@ -108,14 +114,22 @@ export class Command extends BaseCommand<
 
 /**
  * Creates a slash command.
- * @see https://jellycommands.dev/guide/commands/files/#slash-commands
+ * @see https://jellycommands.dev/components/commands
  */
 export const command = (
 	options: CommandOptions & {
 		/**
 		 * The callback function to call when your command is executed.
+		 * @see http://localhost:4321/components/commands#handling-commands
 		 */
 		run: CommandCallback<ChatInputCommandInteraction>;
+
+		/**
+		 * On some options you can enable autocomplete, which allows you to
+		 * provide suggestions as a user types your command option.
+		 *
+		 * @see https://jellycommands.dev/components/commands/slash#autocomplete
+		 */
 		autocomplete?: AutocompleteHandler;
 	},
 ) => {

packages/jellycommands/src/components/commands/types/messageCommands/MessageCommand.ts

@@ -7,7 +7,7 @@ import { BaseCommand } from '../BaseCommand';
 
 /**
  * Represents a Message Context Menu command.
- * @see https://jellycommands.dev/guide/commands/files/#message-commands
+ * @see https://jellycommands.dev/components/commands/context-menu#message-commands
  */
 export class MessageCommand extends BaseCommand<
 	MessageCommandOptions,
@@ -25,12 +25,13 @@ export class MessageCommand extends BaseCommand<
 
 /**
  * Creates a Message Context Menu command.
- * @see https://jellycommands.dev/guide/commands/files/#message-commands
+ * @see https://jellycommands.dev/components/commands/context-menu#message-commands
  */
 export const messageCommand = (
 	options: MessageCommandOptions & {
 		/**
 		 * The callback function to call when your command is executed.
+		 * @see http://localhost:4321/components/commands#handling-commands
 		 */
 		run: CommandCallback<MessageContextMenuCommandInteraction>;
 	},

packages/jellycommands/src/components/commands/types/userCommands/UserCommand.ts

@@ -7,7 +7,7 @@ import { BaseCommand } from '../BaseCommand';
 
 /**
  * Represents a User Context Menu command.
- * @see https://jellycommands.dev/guide/commands/files/#user-commands
+ * @see https://jellycommands.dev/components/commands/context-menu#user-commands
  */
 export class UserCommand extends BaseCommand<
 	UserCommandOptions,
@@ -25,12 +25,13 @@ export class UserCommand extends BaseCommand<
 
 /**
  * Creates a User Context Menu command.
- * @see https://jellycommands.dev/guide/commands/files/#user-commands
+ * @see https://jellycommands.dev/components/commands/context-menu#user-commands
  */
 export const userCommand = (
 	options: UserCommandOptions & {
 		/**
 		 * The callback function to call when your command is executed.
+		 * @see http://localhost:4321/components/commands#handling-commands
 		 */
 		run: CommandCallback<UserContextMenuCommandInteraction>;
 	},

packages/jellycommands/src/components/events/Event.ts

@@ -8,6 +8,8 @@ import { parseSchema } from '../../utils/zod';
 
 /**
  * The Discord event name
+ *
+ * @see https://jellycommands.dev/components/events
  * @see https://discord.js.org/docs/packages/discord.js/14.16.3/ClientEvents:Interface
  */
 export type EventName = keyof ClientEvents | (string & {});
@@ -17,13 +19,17 @@ export type EventName = keyof ClientEvents | (string & {});
  * It takes in a base JellyCommands context as it's first param,
  * followed by all the arguments your event provides.
  *
- * @see https://jellycommands.dev/guide/events/files/
+ * @see https://jellycommands.dev/components/events#handling-events
  */
 export type EventCallback<E extends EventName> = (
 	ctx: { client: JellyCommands; props: Props },
 	...args: E extends keyof ClientEvents ? ClientEvents[E] : any[]
 ) => MaybePromise<any>;
 
+/**
+ * A component for handling Discord.js events.
+ * @see https://jellycommands.dev/components/events
+ */
 export class Event<T extends EventName = EventName> extends Component {
 	/**
 	 * The options you pass to when creating this event.
@@ -65,7 +71,7 @@ export class Event<T extends EventName = EventName> extends Component {
  * This creates an event component for your bot. Events can be used
  * to respond to actions such as a new user joining a guild.
  *
- * @see https://jellycommands.dev/guide/events/files/
+ * @see https://jellycommands.dev/components/events
  */
 export const event = <K extends EventName>(
 	options: EventOptions<K> & {
@@ -74,7 +80,7 @@ export const event = <K extends EventName>(
 		 * It takes in a base JellyCommands context as it's first param,
 		 * followed by all the arguments your event provides.
 		 *
-		 * @see https://jellycommands.dev/guide/events/files/
+		 * @see https://jellycommands.dev/components/events#handling-events
 		 */
 		run: EventCallback<K>;
 	},

packages/jellycommands/src/components/loader.ts

@@ -70,7 +70,7 @@ async function read(client: JellyCommands, path: string): Promise<File[]> {
  * The components of your bot. For any strings that are passed they
  * will be loaded recursively from that path.
  *
- * @see https://jellycommands.dev/guide/components
+ * @see https://jellycommands.dev/components
  */
 export type LoadableComponents = string | (string | Component)[];
 

packages/jellycommands/src/options.ts

@@ -60,7 +60,7 @@ export interface JellyCommandsOptions {
 	 * The components of your bot. For any strings that are passed they
 	 * will be loaded recursively from that path.
 	 *
-	 * @see https://jellycommands.dev/guide/components
+	 * @see https://jellycommands.dev/components
 	 */
 	components?: LoadableComponents;
 
@@ -80,7 +80,7 @@ export interface JellyCommandsOptions {
 
 	/**
 	 * Props are used to pass data around your client.
-	 * @see https://jellycommands.dev/guide/props/
+	 * @see https://jellycommands.dev/components/props/
 	 */
 	props?: Props;
 
@@ -89,15 +89,15 @@ export interface JellyCommandsOptions {
 	 * when your code is unable to handle them. Currently only handles
 	 * an unknownCommand state.
 	 *
-	 * @see https://jellycommands.dev/guide/messages/
+	 * @see https://jellycommands.dev/guides/messages/
 	 */
 	messages?: {
 		/**
 		 * This is sent when your bot recieves an unknown command. This only
 		 * happens if your user sends a command just as you re-register them
 		 * as we respond to commands based on id rather than name currently.
 		 *
-		 * @see https://jellycommands.dev/guide/messages/#unknown-command
+		 * @see https://jellycommands.dev/guides/messages#unknown-command
 		 */
 		unknownCommand?: string | MessagePayload | InteractionReplyOptions;
 	};
@@ -109,7 +109,7 @@ export interface JellyCommandsOptions {
 	 * commands are only checked periodically. You should enable this
 	 * when developing, and disable this in production.
 	 *
-	 * @see https://jellycommands.dev/guide/commands/dev/
+	 * @see https://jellycommands.dev/components/commands/dev
 	 */
 	dev?: {
 		/**
@@ -134,6 +134,8 @@ export interface JellyCommandsOptions {
 	 * We recommend you leave this on, at least when developing.
 	 *
 	 * @default true
+	 *
+	 * @see https://jellycommands.dev/components/commands/caching
 	 */
 	cache?: boolean;
 
@@ -146,11 +148,15 @@ export interface JellyCommandsOptions {
 	/**
 	 * Options to control how JellyCommands reads from the
 	 * filesystem when loading components.
+	 *
+	 * @see https://jellycommands.dev/guides/fs
 	 */
 	fs?: {
 		/**
 		 * Only files that end in these extensions are loaded.
 		 * @default ['.js', '.ts']
+		 *
+		 * @see https://jellycommands.dev/guides/fs#file-extensions
 		 */
 		extensions?: string[];
 	};