chore: consistency/prettier (#3852)

* chore: consistency/prettier * chore: rebase * chore: rebase * chore: include typings * fix: include typings file in prettier lint-staged
2026-03-13 10:03:31 +01:00 · 2020-02-29 14:35:57 +01:00
parent 6650d50a56
commit c065156a88
127 changed files with 5198 additions and 4513 deletions
--- a/docs/general/faq.md
+++ b/docs/general/faq.md
@@ -1,22 +1,26 @@
 # Frequently Asked Questions
+
 These questions are some of the most frequently asked.

-
 ## No matter what, I get `SyntaxError: Block-scoped declarations (let, const, function, class) not yet supported outside strict mode`‽
+
 Update to Node.js 11.0.0 or newer.

 ## How do I get voice working?
+
 - Install FFMPEG.
 - Install either the `@discordjs/opus` package or the `opusscript` package.
  @discordjs/opus is greatly preferred, due to it having significantly better performance.

 ## How do I install FFMPEG?
+
 - **npm:** `npm install ffmpeg-binaries`
 - **Ubuntu 16.04:** `sudo apt install ffmpeg`
 - **Ubuntu 14.04:** `sudo apt-get install libav-tools`
 - **Windows:** `npm install ffmpeg-binaries` or see the [FFMPEG section of AoDude's guide](https://github.com/bdistin/OhGodMusicBot/blob/master/README.md#download-ffmpeg).

 ## How do I set up @discordjs/opus?
+
 - **Ubuntu:** Simply run `npm install @discordjs/opus`, and it's done. Congrats!
 - **Windows:** Run `npm install --global --production windows-build-tools` in an admin command prompt or PowerShell.
  Then, running `npm install @discordjs/opus` in your bot's directory should successfully build it. Woo!
--- a/docs/general/updating.md
+++ b/docs/general/updating.md
@@ -1,72 +1,87 @@
 # Version 11.1.0
+
 v11.1.0 features improved voice and gateway stability, as well as support for new features such as audit logs and searching for messages.
 See [the changelog](https://github.com/discordjs/discord.js/releases/tag/11.1.0) for a full list of changes, including
 information about deprecations.

 # Version 11
+
 Version 11 contains loads of new and improved features, optimisations, and bug fixes.
 See [the changelog](https://github.com/discordjs/discord.js/releases/tag/11.0.0) for a full list of changes.

 ## Significant additions
-* Message Reactions and Embeds (rich text)
-* Support for uws and erlpack for better performance
-* OAuthApplication support
-* Web distributions
+
+- Message Reactions and Embeds (rich text)
+- Support for uws and erlpack for better performance
+- OAuthApplication support
+- Web distributions

 ## Breaking changes
+
 ### Client.login() no longer supports logging in with email + password
+
 Logging in with an email and password has always been heavily discouraged since the advent of proper token support, but in v11 we have made the decision to completely remove the functionality, since Hammer & Chisel have [officially stated](https://github.com/hammerandchisel/discord-api-docs/issues/69#issuecomment-223886862) it simply shouldn't be done.

 User accounts can still log in with tokens just like bot accounts. To obtain the token for a user account, you can log in to Discord with that account, and use Ctrl + Shift + I to open the developer tools. In the console tab, evaluating `localStorage.token` will give you the token for that account.

 ### ClientUser.setEmail()/setPassword() now require the current password, as well as setUsername() on user accounts
+
 Since you can no longer log in with email and password, you must provide the current account password to the `setEmail()`, `setPassword()`, and `setUsername()` methods for user accounts (self-bots).

 ### Removed TextBasedChannel.sendTTSMessage()
+
 This method was deemed to be an entirely pointless shortcut that virtually nobody even used.
 The same results can be achieved by passing options to `send()` or `sendMessage()`.

 Example:
+
 ```js
 channel.send('Hi there', { tts: true });
 ```

 ### Using Collection.find()/exists() with IDs will throw an error
+
 This is simply to help prevent a common mistake that is made frequently.
 To find something or check its existence using an ID, you should use `.get()` and `.has()` which are part of the [ES6 Map class](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Map), which Collection is an extension of.

 # Version 10
+
 Version 10's non-BC changes focus on cleaning up some inconsistencies that exist in previous versions.
 Upgrading from v9 should be quick and painless.

 ## Client options
+
 All client options have been converted to camelCase rather than snake_case, and `max_message_cache` was renamed to `messageCacheMaxSize`.

 v9 code example:
+
 ```js
 const client = new Discord.Client({
  disable_everyone: true,
  max_message_cache: 500,
  message_cache_lifetime: 120,
-  message_sweep_interval: 60
+  message_sweep_interval: 60,
 });
 ```

 v10 code example:
+
 ```js
 const client = new Discord.Client({
  disableEveryone: true,
  messageCacheMaxSize: 500,
  messageCacheLifetime: 120,
-  messageSweepInterval: 60
+  messageSweepInterval: 60,
 });
 ```

 ## Presences
+
 Presences have been completely restructured.
 Previous versions of discord.js assumed that users had the same presence amongst all guilds - with the introduction of sharding, however, this is no longer the case.

 v9 discord.js code may look something like this:
+
 ```js
 User.status; // the status of the user
 User.game; // the game that the user is playing
@@ -81,6 +96,7 @@ Additionally, the introduction of the Presence class keeps all of the presence d
 A user may have an entirely different presence between two different guilds.**

 v10 code:
+
 ```js
 MemberOrUser.presence.status; // the status of the member or user
 MemberOrUser.presence.game; // the game that the member or user is playing
@@ -90,41 +106,46 @@ ClientUser.setPresence(fullPresence); // status and game combined
 ```

 ## Voice
+
 Voice has been rewritten internally, but in a backwards-compatible manner.
 There is only one breaking change here; the `disconnected` event was renamed to `disconnect`.
 Several more events have been made available to a VoiceConnection, so see the documentation.

 ## Events
+
 Many events have been renamed or had their arguments change.

 ### Client events
-|    Version   9                                       |    Version   10                               |
-|------------------------------------------------------|-----------------------------------------------|
-|    guildMemberAdd(guild, member)                     |    guildMemberAdd(member)                     |
-|    guildMemberAvailable(guild, member)               |    guildMemberAvailable(member)               |
-|    guildMemberRemove(guild, member)                  |    guildMemberRemove(member)                  |
-|    guildMembersChunk(guild, members)                 |    guildMembersChunk(members)                 |
-|    guildMemberUpdate(guild, oldMember, newMember)    |    guildMemberUpdate(oldMember, newMember)    |
-|    guildRoleCreate(guild, role)                      |    roleCreate(role)                           |
-|    guildRoleDelete(guild, role)                      |    roleDelete(role)                           |
-|    guildRoleUpdate(guild, oldRole, newRole)          |    roleUpdate(oldRole, newRole)               |
+
+| Version 9                                      | Version 10                              |
+| ---------------------------------------------- | --------------------------------------- |
+| guildMemberAdd(guild, member)                  | guildMemberAdd(member)                  |
+| guildMemberAvailable(guild, member)            | guildMemberAvailable(member)            |
+| guildMemberRemove(guild, member)               | guildMemberRemove(member)               |
+| guildMembersChunk(guild, members)              | guildMembersChunk(members)              |
+| guildMemberUpdate(guild, oldMember, newMember) | guildMemberUpdate(oldMember, newMember) |
+| guildRoleCreate(guild, role)                   | roleCreate(role)                        |
+| guildRoleDelete(guild, role)                   | roleDelete(role)                        |
+| guildRoleUpdate(guild, oldRole, newRole)       | roleUpdate(oldRole, newRole)            |

 The guild parameter that has been dropped from the guild-related events can still be derived using `member.guild` or `role.guild`.

 ### VoiceConnection events
+
 | Version 9    | Version 10 |
-|--------------|------------|
+| ------------ | ---------- |
 | disconnected | disconnect |

 ## Dates and timestamps
+
 All dates/timestamps on the structures have been refactored to have a consistent naming scheme and availability.
 All of them are named similarly to this:  
 **Date:** `Message.createdAt`  
 **Timestamp:** `Message.createdTimestamp`  
 See the docs for each structure to see which date/timestamps are available on them.

-
 # Version 9
+
 The version 9 (v9) rewrite takes a much more object-oriented approach than previous versions,
 which allows your code to be much more readable and manageable.
 It's been rebuilt from the ground up and should be much more stable, fixing caching issues that affected
@@ -137,18 +158,21 @@ into other more relevant classes where they belong.
 Because of this, you will need to convert most of your calls over to the new methods.

 Here are a few examples of methods that have changed:
-* `Client.sendMessage(channel, message)` ==> `TextChannel.sendMessage(message)`
-  * `Client.sendMessage(user, message)` ==> `User.sendMessage(message)`
-* `Client.updateMessage(message, "New content")` ==> `Message.edit("New Content")`
-* `Client.getChannelLogs(channel, limit)` ==> `TextChannel.fetchMessages({options})`
-* `Server.detailsOfUser(User)` ==> `Server.members.get(User).properties` (retrieving a member gives a GuildMember object)
-* `Client.joinVoiceChannel(voicechannel)` => `VoiceChannel.join()`
+
+- `Client.sendMessage(channel, message)` ==> `TextChannel.sendMessage(message)`
+  - `Client.sendMessage(user, message)` ==> `User.sendMessage(message)`
+- `Client.updateMessage(message, "New content")` ==> `Message.edit("New Content")`
+- `Client.getChannelLogs(channel, limit)` ==> `TextChannel.fetchMessages({options})`
+- `Server.detailsOfUser(User)` ==> `Server.members.get(User).properties` (retrieving a member gives a GuildMember object)
+- `Client.joinVoiceChannel(voicechannel)` => `VoiceChannel.join()`

 A couple more important details:
-* `Client.loginWithToken("token")` ==> `client.login("token")`
-* `Client.servers.length` ==> `client.guilds.size` (all instances of `server` are now `guild`)
+
+- `Client.loginWithToken("token")` ==> `client.login("token")`
+- `Client.servers.length` ==> `client.guilds.size` (all instances of `server` are now `guild`)

 ## No more callbacks!
+
 Version 9 eschews callbacks in favour of Promises. This means all code relying on callbacks must be changed.  
 For example, the following code:

@@ -159,7 +183,7 @@ client.getChannelLogs(channel, 100, function(messages) {
 ```

 ```js
-channel.fetchMessages({limit: 100}).then(messages => {
+channel.fetchMessages({ limit: 100 }).then(messages => {
  console.log(`${messages.size} messages found`);
 });
 ```
--- a/docs/general/welcome.md
+++ b/docs/general/welcome.md
@@ -18,12 +18,14 @@
 </div>

 # Welcome!
+
 Welcome to the discord.js v12 documentation.

 v12 is still very much a work-in-progress, as we're aiming to make it the best it can possibly be before releasing.
 Only use it if you are fond of living life on the bleeding edge.

 ## About
+
 discord.js is a powerful [Node.js](https://nodejs.org) module that allows you to easily interact with the
 [Discord API](https://discordapp.com/developers/docs/intro).

@@ -33,6 +35,7 @@ discord.js is a powerful [Node.js](https://nodejs.org) module that allows you to
 - 100% coverage of the Discord API

 ## Installation
+
 **Node.js 11.0.0 or newer is required.**  
 Ignore any warnings about unmet peer dependencies, as they're all optional.

@@ -41,20 +44,23 @@ With voice support ([@discordjs/opus](https://www.npmjs.com/package/@discordjs/o
 With voice support ([opusscript](https://www.npmjs.com/package/opusscript)): `npm install discordjs/discord.js opusscript`

 ### Audio engines
+
 The preferred audio engine is @discordjs/opus, as it performs significantly better than opusscript. When both are available, discord.js will automatically choose @discordjs/opus.
 Using opusscript is only recommended for development environments where @discordjs/opus is tough to get working.
 For production bots, using @discordjs/opus should be considered a necessity, especially if they're going to be running on multiple servers.

 ### Optional packages
+
 - [zlib-sync](https://www.npmjs.com/package/zlib-sync) for WebSocket data compression and inflation (`npm install zlib-sync`)
 - [erlpack](https://github.com/discordapp/erlpack) for significantly faster WebSocket data (de)serialisation (`npm install discordapp/erlpack`)
 - One of the following packages can be installed for faster voice packet encryption and decryption:
-    - [sodium](https://www.npmjs.com/package/sodium) (`npm install sodium`)
-    - [libsodium.js](https://www.npmjs.com/package/libsodium-wrappers) (`npm install libsodium-wrappers`)
+  - [sodium](https://www.npmjs.com/package/sodium) (`npm install sodium`)
+  - [libsodium.js](https://www.npmjs.com/package/libsodium-wrappers) (`npm install libsodium-wrappers`)
 - [bufferutil](https://www.npmjs.com/package/bufferutil) for a much faster WebSocket connection (`npm install bufferutil`)
 - [utf-8-validate](https://www.npmjs.com/package/utf-8-validate) in combination with `bufferutil` for much faster WebSocket processing (`npm install utf-8-validate`)

 ## Example usage
+
 ```js
 const Discord = require('discord.js');
 const client = new Discord.Client();
@@ -73,24 +79,28 @@ client.login('token');
 ```

 ## Links
-* [Website](https://discord.js.org/) ([source](https://github.com/discordjs/website))
-* [Documentation](https://discord.js.org/#/docs/main/master/general/welcome)
-* [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - this is still for stable  
+
+- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/website))
+- [Documentation](https://discord.js.org/#/docs/main/master/general/welcome)
+- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) - this is still for stable  
  See also the WIP [Update Guide](https://discordjs.guide/additional-info/changes-in-v12.html) also including updated and removed items in the library.
-* [Discord.js Discord server](https://discord.gg/bRCvFy9)
-* [Discord API Discord server](https://discord.gg/discord-api)
-* [GitHub](https://github.com/discordjs/discord.js)
-* [NPM](https://www.npmjs.com/package/discord.js)
-* [Related libraries](https://discordapi.com/unofficial/libs.html)
+- [Discord.js Discord server](https://discord.gg/bRCvFy9)
+- [Discord API Discord server](https://discord.gg/discord-api)
+- [GitHub](https://github.com/discordjs/discord.js)
+- [NPM](https://www.npmjs.com/package/discord.js)
+- [Related libraries](https://discordapi.com/unofficial/libs.html)

 ### Extensions
-* [RPC](https://www.npmjs.com/package/discord-rpc) ([source](https://github.com/discordjs/RPC))
+
+- [RPC](https://www.npmjs.com/package/discord-rpc) ([source](https://github.com/discordjs/RPC))

 ## Contributing
+
 Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the
 [documentation](https://discord.js.org/#/docs).  
 See [the contribution guide](https://github.com/discordjs/discord.js/blob/master/.github/CONTRIBUTING.md) if you'd like to submit a PR.

 ## Help
+
 If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle
 nudge in the right direction, please don't hesitate to join our official [Discord.js Server](https://discord.gg/bRCvFy9).