From 1605b62bd03fa215145c822e85423166890e8ccd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Antonio=20Rom=C3=A1n?= Date: Wed, 30 Jun 2021 08:49:26 +0200 Subject: [PATCH 1/2] feat(Util): added formatters --- package-lock.json | 36 ++++++++++++++++++++++++++++++++++++ package.json | 1 + src/index.js | 1 + src/util/Formatters.js | 25 +++++++++++++++++++++++++ typings/index.d.ts | 33 +++++++++++++++++++++++++++++++-- 5 files changed, 94 insertions(+), 2 deletions(-) create mode 100644 src/util/Formatters.js diff --git a/package-lock.json b/package-lock.json index d09d95dbf5dc..dbd802de967a 100644 --- a/package-lock.json +++ b/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", diff --git a/package.json b/package.json index 5110ac06a9b1..2489d341453c 100644 --- a/package.json +++ b/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", diff --git a/src/index.js b/src/index.js index e41887e5761d..4734ea1b50ac 100644 --- a/src/index.js +++ b/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'), diff --git a/src/util/Formatters.js b/src/util/Formatters.js new file mode 100644 index 000000000000..10eacfa3417a --- /dev/null +++ b/src/util/Formatters.js @@ -0,0 +1,25 @@ +'use strict'; + +const { + TimestampStyles, + blockQuote, + bold, + codeBlock, + inlineCode, + italic, + quote, + strikethrough, + time, + underscore, +} = require('@discordjs/builders'); + +exports.TimestampStyles = TimestampStyles; +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.underscore = underscore; diff --git a/typings/index.d.ts b/typings/index.d.ts index f552a55ff3e7..01b8d62d7581 100644 --- a/typings/index.d.ts +++ b/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 { DiscordGatewayAdapterCreator, DiscordGatewayAdapterLibraryMethods } from '@discordjs/voice'; + import { Stream } from 'stream'; 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 { + TimestampStyles, + TimestampStylesString, + blockQuote, + bold, + codeBlock, + inlineCode, + italic, + quote, + strikethrough, + time, + underscore, + }; + } + export class VoiceChannel extends BaseGuildVoiceChannel { public readonly editable: boolean; public readonly speakable: boolean; From f976a524fcf4ff13b0d6376be4bc52fb19797697 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Antonio=20Rom=C3=A1n?= Date: Wed, 30 Jun 2021 09:01:31 +0200 Subject: [PATCH 2/2] refactor: sort formatter imports and exports --- src/util/Formatters.js | 4 ++-- typings/index.d.ts | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/util/Formatters.js b/src/util/Formatters.js index 10eacfa3417a..b65114f5709a 100644 --- a/src/util/Formatters.js +++ b/src/util/Formatters.js @@ -1,7 +1,6 @@ 'use strict'; const { - TimestampStyles, blockQuote, bold, codeBlock, @@ -10,10 +9,10 @@ const { quote, strikethrough, time, + TimestampStyles, underscore, } = require('@discordjs/builders'); -exports.TimestampStyles = TimestampStyles; exports.blockQuote = blockQuote; exports.bold = bold; exports.codeBlock = codeBlock; @@ -22,4 +21,5 @@ exports.italic = italic; exports.quote = quote; exports.strikethrough = strikethrough; exports.time = time; +exports.TimestampStyles = TimestampStyles; exports.underscore = underscore; diff --git a/typings/index.d.ts b/typings/index.d.ts index 01b8d62d7581..1d756d828f1f 100644 --- a/typings/index.d.ts +++ b/typings/index.d.ts @@ -2110,8 +2110,6 @@ declare module 'discord.js' { export namespace Formatters { export { - TimestampStyles, - TimestampStylesString, blockQuote, bold, codeBlock, @@ -2120,6 +2118,8 @@ declare module 'discord.js' { quote, strikethrough, time, + TimestampStyles, + TimestampStylesString, underscore, }; }