Merge pull request #52 from greencoast-studios/develop

Version 2.1.1

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@greencoast/discord.js-extended",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "An utility to facilitate the repetitive tasks when creating discord bots. Used by Greencoast Studios.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

src/classes/command/default/index.ts

@@ -19,3 +19,11 @@ export const Slash = {
   HelpSlashCommand,
   SetLocaleSlashCommand
 };
+
+export {
+  HelpRegularCommand,
+  SetLocaleRegularCommand,
+
+  HelpSlashCommand,
+  SetLocaleSlashCommand
+};

src/classes/locale/GuildLocalizer.ts

@@ -9,14 +9,14 @@ class GuildLocalizer {
   /**
    * The main localizer for this guild localizer.
    * @type {Localizer}
-   * @memberof {GuildLocalizer}
+   * @memberof GuildLocalizer
    */
   public readonly localizer: Localizer;
 
   /**
    * The guild that corresponds to this guild localizer.
    * @type {Discord.Guild}
-   * @memberof {GuildLocalizer}
+   * @memberof GuildLocalizer
    */
   public readonly guild: Discord.Guild;
 
@@ -25,15 +25,15 @@ class GuildLocalizer {
    * data provider.
    * @type {string}
    * @default `locale`
-   * @memberof {GuildLocalizer}
+   * @memberof GuildLocalizer
    */
   public readonly dataProviderKey: string;
 
   /**
    * The current locale set for the guild. Do not update this value manually, instead use
    * the `updateLocale()` method.
    * @type {string}
-   * @memberof {GuildLocalizer}
+   * @memberof GuildLocalizer
    */
   public locale: string;
 

src/classes/locale/Localizer.ts

@@ -27,6 +27,7 @@ class Localizer {
    *
    * The following is an example of how to structure this object:
    *
+   * ```js
    * en: {
    *   'message.test.hello': 'Hello',
    *   'message.test.bye': 'Bye',
@@ -42,8 +43,9 @@ class Localizer {
    *   'message.test.bye': 'Au revoir',
    *   'message.test.with_value': 'Bonjour {name}!'
    * }
+   * ```
    * @type {Record<string, Record<string, string>>}
-   * @memberof {Localizer}
+   * @memberof Localizer
    */
   public readonly localeStrings: Record<string, Record<string, string>>;
 
@@ -52,21 +54,21 @@ class Localizer {
    * client's data provider. You should set a data provider before setting this up so
    * the guild's locale can be saved persistently.
    * @type {string}
-   * @memberof {Localizer}
+   * @memberof Localizer
    */
   public readonly defaultLocale: string;
 
   /**
    * The options for this localizer.
    * @type {LocalizerOptions}
-   * @memberof {Localizer}
+   * @memberof Localizer
    */
   public readonly options: LocalizerOptions;
 
   /**
    * The {@link GuildLocalizer}s for each guild.
    * @type {Discord.Collection<Discord.Snowflake, GuildLocalizer>}
-   * @memberof {Localizer}
+   * @memberof Localizer
    */
   public readonly guildLocalizers: Discord.Collection<Discord.Snowflake, GuildLocalizer>;
 

src/interfaces/LocalizerOptions.ts

@@ -10,6 +10,7 @@ interface LocalizerOptions {
    *
    * The following is an example of how to structure this object:
    *
+   * ```js
    * en: {
    *   'message.test.hello': 'Hello',
    *   'message.test.bye': 'Bye',
@@ -25,6 +26,7 @@ interface LocalizerOptions {
    *   'message.test.bye': 'Au revoir',
    *   'message.test.with_value': 'Bonjour {name}!'
    * }
+   * ```
    */
   localeStrings: Record<string, Record<string, string>>,