feat(Util): added formatters (#5976)

package-lock.json

@@ -8,6 +8,7 @@
       "version": "13.0.0-dev",
       "license": "Apache-2.0",
       "dependencies": {
+        "@discordjs/builders": "^0.1.0",
         "@discordjs/collection": "^0.1.6",
         "@discordjs/form-data": "^3.0.1",
         "@sapphire/async-queue": "^1.1.4",
@@ -980,6 +981,26 @@
         "node": ">= 4.0.0"
       }
     },
+    "node_modules/@discordjs/builders": {
+      "version": "0.1.0",
+      "resolved": "https://registry.npmjs.org/@discordjs/builders/-/builders-0.1.0.tgz",
+      "integrity": "sha512-x9wwMeBdgll3zqzG0c1d+z67Fg4Feg222bNAzzzP4o4FUzxhFW5biUIPQP08nEHmXhuwPSiyiknu20zZgr0otg==",
+      "dependencies": {
+        "discord-api-types": "^0.18.1"
+      },
+      "engines": {
+        "node": ">=14.0.0",
+        "npm": ">=7.0.0"
+      }
+    },
+    "node_modules/@discordjs/builders/node_modules/discord-api-types": {
+      "version": "0.18.1",
+      "resolved": "https://registry.npmjs.org/discord-api-types/-/discord-api-types-0.18.1.tgz",
+      "integrity": "sha512-hNC38R9ZF4uaujaZQtQfm5CdQO58uhdkoHQAVvMfIL0LgOSZeW575W8H6upngQOuoxWd8tiRII3LLJm9zuQKYg==",
+      "engines": {
+        "node": ">=12"
+      }
+    },
     "node_modules/@discordjs/collection": {
       "version": "0.1.6",
       "resolved": "https://registry.npmjs.org/@discordjs/collection/-/collection-0.1.6.tgz",
@@ -12182,6 +12203,21 @@
         }
       }
     },
+    "@discordjs/builders": {
+      "version": "0.1.0",
+      "resolved": "https://registry.npmjs.org/@discordjs/builders/-/builders-0.1.0.tgz",
+      "integrity": "sha512-x9wwMeBdgll3zqzG0c1d+z67Fg4Feg222bNAzzzP4o4FUzxhFW5biUIPQP08nEHmXhuwPSiyiknu20zZgr0otg==",
+      "requires": {
+        "discord-api-types": "^0.18.1"
+      },
+      "dependencies": {
+        "discord-api-types": {
+          "version": "0.18.1",
+          "resolved": "https://registry.npmjs.org/discord-api-types/-/discord-api-types-0.18.1.tgz",
+          "integrity": "sha512-hNC38R9ZF4uaujaZQtQfm5CdQO58uhdkoHQAVvMfIL0LgOSZeW575W8H6upngQOuoxWd8tiRII3LLJm9zuQKYg=="
+        }
+      }
+    },
     "@discordjs/collection": {
       "version": "0.1.6",
       "resolved": "https://registry.npmjs.org/@discordjs/collection/-/collection-0.1.6.tgz",

package.json

@@ -45,6 +45,7 @@
   },
   "homepage": "https://github.com/discordjs/discord.js#readme",
   "dependencies": {
+    "@discordjs/builders": "^0.1.0",
     "@discordjs/collection": "^0.1.6",
     "@discordjs/form-data": "^3.0.1",
     "@sapphire/async-queue": "^1.1.4",

src/index.js

@@ -16,6 +16,7 @@ module.exports = {
   Collection: require('./util/Collection'),
   Constants: require('./util/Constants'),
   DataResolver: require('./util/DataResolver'),
+  Formatters: require('./util/Formatters'),
   BaseManager: require('./managers/BaseManager'),
   DiscordAPIError: require('./rest/DiscordAPIError'),
   HTTPError: require('./rest/HTTPError'),

src/util/Formatters.js

@@ -0,0 +1,25 @@
+'use strict';
+
+const {
+  blockQuote,
+  bold,
+  codeBlock,
+  inlineCode,
+  italic,
+  quote,
+  strikethrough,
+  time,
+  TimestampStyles,
+  underscore,
+} = require('@discordjs/builders');
+
+exports.blockQuote = blockQuote;
+exports.bold = bold;
+exports.codeBlock = codeBlock;
+exports.inlineCode = inlineCode;
+exports.italic = italic;
+exports.quote = quote;
+exports.strikethrough = strikethrough;
+exports.time = time;
+exports.TimestampStyles = TimestampStyles;
+exports.underscore = underscore;

typings/index.d.ts

@@ -172,7 +172,21 @@ declare module '@discordjs/voice' {
 }
 
 declare module 'discord.js' {
+  import {
+    blockQuote,
+    bold,
+    codeBlock,
+    inlineCode,
+    italic,
+    quote,
+    strikethrough,
+    time,
+    TimestampStyles,
+    TimestampStylesString,
+    underscore,
+  } from '@discordjs/builders';
   import BaseCollection from '@discordjs/collection';
+  import { DiscordGatewayAdapterCreator, DiscordGatewayAdapterLibraryMethods } from '@discordjs/voice';
   import { ChildProcess } from 'child_process';
   import {
     APIActionRowComponent,
@@ -189,8 +203,7 @@ declare module 'discord.js' {
   } from 'discord-api-types/v8';
   import { EventEmitter } from 'events';
   import { PathLike } from 'fs';
-  import { Readable, Stream, Writable } from 'stream';
+  import { Stream } from 'stream';
-  import { DiscordGatewayAdapterCreator, DiscordGatewayAdapterLibraryMethods } from '@discordjs/voice';
   import * as WebSocket from 'ws';
 
   export const version: string;
@@ -2095,6 +2108,22 @@ declare module 'discord.js' {
     public static splitMessage(text: string, options?: SplitOptions): string[];
   }
 
+  export namespace Formatters {
+    export {
+      blockQuote,
+      bold,
+      codeBlock,
+      inlineCode,
+      italic,
+      quote,
+      strikethrough,
+      time,
+      TimestampStyles,
+      TimestampStylesString,
+      underscore,
+    };
+  }
+
   export class VoiceChannel extends BaseGuildVoiceChannel {
     public readonly editable: boolean;
     public readonly speakable: boolean;