docs: improve jsdocs (#413)

docs: improve jsdocs

Author: xhyrom

.eslintrc.json

@@ -1,55 +1,44 @@
 {
-  "extends": [
-    "eslint:recommended",
-    "prettier",
-    "plugin:@typescript-eslint/recommended"
-  ],
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "ecmaVersion": 12
-  },
-  "plugins": [
-    "@typescript-eslint",
-    "prettier"
-  ],
-  "rules": {
-    "strict": ["error", "global"],
-    "linebreak-style": [
-      "error",
-      "unix"
-    ],
-    "quotes": [
-      "error",
-      "single"
-    ],
-    "semi": [
-      "error",
-      "always"
-    ],
-    "prefer-const": "error",
-    "@typescript-eslint/no-explicit-any": "off",
-    "no-restricted-globals": [
-      "error",
-      {
-        "name": "Buffer",
-        "message": "Import Buffer from `node:buffer` instead"
-      },
-      {
-        "name": "process",
-        "message": "Import process from `node:process` instead"
-      },
-      {
-        "name": "setTimeout",
-        "message": "Import setTimeout from `node:timers` instead"
-      },
-      {
-        "name": "setInterval",
-        "message": "Import setInterval from `node:timers` instead"
-      },
-      {
-        "name": "setImmediate",
-        "message": "Import setImmediate from `node:timers` instead"
-      }
-    ]
-  }
+	"extends": [
+		"eslint:recommended",
+		"prettier",
+		"plugin:@typescript-eslint/recommended"
+	],
+	"parser": "@typescript-eslint/parser",
+	"parserOptions": {
+		"ecmaVersion": 12
+	},
+	"plugins": ["@typescript-eslint", "prettier"],
+	"rules": {
+		"strict": ["error", "global"],
+		"max-len": ["error", 120, 2],
+		"linebreak-style": ["error", "unix"],
+		"quotes": ["error", "single"],
+		"semi": ["error", "always"],
+		"prefer-const": "error",
+		"@typescript-eslint/no-explicit-any": "off",
+		"no-restricted-globals": [
+			"error",
+			{
+				"name": "Buffer",
+				"message": "Import Buffer from `node:buffer` instead"
+			},
+			{
+				"name": "process",
+				"message": "Import process from `node:process` instead"
+			},
+			{
+				"name": "setTimeout",
+				"message": "Import setTimeout from `node:timers` instead"
+			},
+			{
+				"name": "setInterval",
+				"message": "Import setInterval from `node:timers` instead"
+			},
+			{
+				"name": "setImmediate",
+				"message": "Import setImmediate from `node:timers` instead"
+			}
+		]
+	}
 }

src/index.ts

@@ -33,8 +33,9 @@ export * from './lib/util/logger/Logger';
 // Inhibitors
 export * as Inhibitor from './inhibitors';
 
-/* Providers
- * Providers will not be exported due to additional modules. To import, just use the path gcommands/dist/providers/{name}
+/**
+ * Providers are not exported
+ * To import, just use the path gcommands/dist/providers/{name}
  */
 export * from './lib/structures/Provider';
 

src/lib/GClient.ts

@@ -1,14 +1,34 @@
 import { setImmediate } from 'node:timers';
-import { Awaitable, Client, ClientOptions, Message } from 'discord.js';
+import {
+	Awaitable,
+	Client,
+	ClientOptions,
+	Message,
+	Snowflake,
+} from 'discord.js';
 import { Commands } from './managers/CommandManager';
 import { Components } from './managers/ComponentManager';
 import { Listeners } from './managers/ListenerManager';
 import { Plugins } from './managers/PluginManager';
 import { registerDirectories } from './util/registerDirectories';
 import Responses from '../responses.json';
 
+/**
+ * A valid prefix for GCommands.
+ * * `string`: for single prefix, like `'?'`.
+ * * `string[]`: an array of prefixes, like `['?', '!']`.
+ * * `null`: disabled prefix, only mention works.
+ */
 export type GClientMessagePrefix = string | string[] | null;
 
+/**
+ * Enum for the auto defer feature.
+ *
+ * Automatically defers interaction if application doesn't respond in 3s
+ * * EPHEMERAL
+ * * NORMAL
+ * * UPDATE
+ */
 export enum AutoDeferType {
 	/**
 	 * @example interaction.deferReply({ ephemeral: true })
@@ -24,19 +44,91 @@ export enum AutoDeferType {
 	'UPDATE' = 3,
 }
 
+/**
+ * Options for the GClient.
+ * @extends {ClientOptions}
+ */
 export interface GClientOptions extends ClientOptions {
+	/**
+	 * Support for message commands.
+	 * @type {boolean}
+	 */
 	messageSupport?: boolean;
+	/**
+	 * Prefix for message commands
+	 * @requires {@link GClientOptions.messageSupport} to be enabled
+	 */
 	messagePrefix?:
 		| ((message: Message) => Awaitable<GClientMessagePrefix>)
 		| GClientMessagePrefix;
+	/**
+	 * Whether to send a message for an unknown message command.
+	 * @type {boolean}
+	 */
 	unknownCommandMessage?: boolean;
+	/**
+	 * Array of all folders to be loaded by GCommands.
+	 *
+	 * GCommands will check all the files in each folder for these classes:
+	 * * Command
+	 * * Listener
+	 * * Component
+	 *
+	 * @type {string[]}
+	 * @example
+	 * ```typescript
+	 * new GClient({
+	 * 		dirs: [
+	 * 			join(__dirname, 'commands'),
+	 * 			join(__dirname, 'events'),
+	 * 			join(__dirname, 'components'),
+	 * 		]
+	 * })
+	 * ```
+	 */
 	dirs?: Array<string>;
+	/**
+	 * The database to be used in the project.
+	 *
+	 * This option is only for easier access and is not used by GCommands.
+	 *
+	 * @type {any}
+	 */
 	database?: any;
-	devGuildId?: string;
+	/**
+	 * The guild id that will serve as the development server for your application.
+	 *
+	 * If this option is present, all slash commands will be registered only for the specified guild id.
+	 * However, if the command contains the `guildId` option, it is used instead of this option.
+	 *
+	 * @type {Snowflake}
+	 */
+	devGuildId?: Snowflake;
 }
 
+/**
+ * The base {@link Client} that GCommands uses.
+ *
+ * @see {@link GClientOptions} for all available options for GClient.
+ *
+ * @extends {Client}
+ */
 export class GClient<Ready extends boolean = boolean> extends Client<Ready> {
+	/**
+	 * Object of the default responses that GCommands uses for auto responding in the case of something happening.
+	 *
+	 * You can customize these messages using the
+	 * [@gcommands/plugin-language](https://github.com/Garlic-Team/gcommands-addons/tree/master/packages/plugin-language)
+	 * plugin.
+	 *
+	 * @see {@link Responses}
+	 */
 	public responses: Record<string, string> = Responses;
+
+	/**
+	 * Object of all provided options.
+	 * @see {@link GClientOptions}
+	 */
 	public declare options: GClientOptions;
 
 	constructor(options: GClientOptions) {
@@ -48,6 +140,7 @@ export class GClient<Ready extends boolean = boolean> extends Client<Ready> {
 				this.options.database.init();
 		}
 
+		// Load all managers before login.
 		setImmediate(async (): Promise<void> => {
 			await Promise.all([
 				Plugins.initiate(this),
@@ -58,6 +151,35 @@ export class GClient<Ready extends boolean = boolean> extends Client<Ready> {
 		});
 	}
 
+	/**
+	 * The method that returns the database option provided in {@link GClientOptions}
+	 * @param {any} _ Used for typings
+	 * @returns {Database}
+	 * @example TypeScript example
+	 * ```typescript
+	 * import { MongoDBProvider } from 'gcommands/dist/providers/MongoDBProvider';
+	 *
+	 * const client = new GClient({
+	 * 		..settings,
+	 * 		database: new MongoDBProvider('mongodb://localhost:27017/database')
+	 * })
+	 *
+	 * const db = client.getDatabase(MongoDBProvider.prototype);
+	 * // returns <MongoDBProvider>
+	 * ```
+	 * @example JavaScript example
+	 * ```javascript
+	 * const { MongoDBProvider } = require('gcommands/dist/providers/MongoDBProvider');
+	 *
+	 * const client = new GClient({
+	 * 		..settings,
+	 * 		database: new MongoDBProvider('mongodb://localhost:27017/database')
+	 * })
+	 *
+	 * const db = client.getDatabase(MongoDBProvider.prototype);
+	 * // returns <MongoDBProvider>
+	 * ```
+	 */
 	// eslint-disable-next-line @typescript-eslint/no-unused-vars
 	public getDatabase<Database>(_?: Database): Database {
 		return this.options.database;

src/lib/loaders/directoryLoader.ts

@@ -2,7 +2,12 @@ import * as fs from 'fs';
 import * as path from 'path';
 import { Util } from '../util/Util';
 
-export async function directoryLoader(dir: string): Promise<Array<any>> {
+/**
+ * The method that loads all files from a directory
+ * @param {string} dir The directory to load
+ * @returns {Promise<any[]>}
+ */
+export async function directoryLoader(dir: string): Promise<any[]> {
 	let files = [];
 	if (fs.existsSync(dir)) {
 		for await (const fsDirent of fs.readdirSync(dir, { withFileTypes: true })) {

src/lib/loaders/pluginFinder.ts

@@ -1,6 +1,11 @@
 import * as fs from 'node:fs';
 import * as path from 'node:path';
 
+/**
+ * The method that loads plugin files from a directory
+ * @param basedir The base plugin directory
+ * @param folder The plugin folder
+ */
 export async function loadPluginFolder(basedir: string, folder: fs.Dirent) {
 	if (folder.isDirectory()) {
 		if (fs.existsSync(path.join(basedir, folder.name, 'index.js'))) {
@@ -19,6 +24,10 @@ export async function loadPluginFolder(basedir: string, folder: fs.Dirent) {
 	}
 }
 
+/**
+ * The method that find all plugins in a directory
+ * @param {string} basedir The directory to find plugins in
+ */
 export async function pluginFinder(basedir: string) {
 	if (fs.existsSync(basedir)) {
 		if (fs.existsSync(path.join(basedir, 'plugins'))) {