fix: remove peer deps, update dev deps, update READMEs (#210)

Author: favna

README.md

@@ -21,15 +21,27 @@
 
 Sapphire is a Discord bot framework built on top of [discord.js] for advanced and amazing bots.
 
-**Much of the code in this repository is inspired and based on the ideas from [klasa].**
-
 ## Features
 
 -   Written in TypeScript
 -   Command Handler, Arguments, Pre-conditions and Events Store
 -   Completely Modular and Extendable
 -   Advanced Plugins Support
--   Complete i18n Integration
+-   Supports many [plugins](https://github.com/sapphiredev/plugins)
+
+## Installation
+
+`@sapphire/framework` depends on the following packages. Be sure to install these along with this package!
+
+-   [`discord.js`](https://www.npmjs.com/package/discord.js)
+
+You can use the following command to install this package, or replace `npm install` with your package manager of choice.
+
+```sh
+npm install @sapphire/framework discord.js
+```
+
+---
 
 ## API Documentation
 
@@ -87,4 +99,3 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
 
 [discord.js]: https://github.com/discordjs/discord.js
-[klasa]: https://github.com/dirigeants/klasa

package.json

@@ -29,44 +29,41 @@
 		"prepare": "husky install .github/husky"
 	},
 	"dependencies": {
-		"@sapphire/discord-utilities": "^2.1.1",
-		"@sapphire/discord.js-utilities": "^1.5.7",
+		"@sapphire/discord-utilities": "^2.1.3",
+		"@sapphire/discord.js-utilities": "^1.5.9",
 		"@sapphire/pieces": "^2.0.0",
-		"@sapphire/ratelimits": "^1.2.1",
-		"@sapphire/utilities": "^1.5.1",
+		"@sapphire/ratelimits": "^1.2.3",
+		"@sapphire/utilities": "^1.5.3",
 		"lexure": "^0.17.0",
 		"tslib": "^2.2.0"
 	},
-	"peerDependencies": {
-		"discord.js": "12.x"
-	},
 	"devDependencies": {
 		"@commitlint/cli": "^12.1.4",
 		"@commitlint/config-conventional": "^12.1.4",
 		"@mdx-js/mdx": "^1.6.22",
-		"@sapphire/eslint-config": "^3.1.2",
-		"@sapphire/prettier-config": "^1.1.1",
-		"@sapphire/ts-config": "^2.2.1",
+		"@sapphire/eslint-config": "^3.1.4",
+		"@sapphire/prettier-config": "^1.1.3",
+		"@sapphire/ts-config": "^2.2.3",
 		"@types/jest": "^26.0.23",
-		"@types/node": "^15.6.1",
+		"@types/node": "^15.12.1",
 		"@types/ws": "^7.4.4",
 		"cz-conventional-changelog": "^3.3.0",
 		"discord.js": "^12.5.3",
 		"husky": "^6.0.0",
-		"jest": "^26.6.3",
-		"jest-circus": "^26.6.3",
+		"jest": "^27.0.4",
+		"jest-circus": "^27.0.4",
 		"lint-staged": "^11.0.0",
 		"npm-run-all": "^4.1.5",
 		"pretty-quick": "^3.1.0",
-		"rollup": "^2.47.0",
+		"rollup": "^2.51.0",
 		"rollup-plugin-dts": "^3.0.2",
 		"rollup-plugin-version-injector": "^1.3.3",
 		"standard-version": "^9.3.0",
-		"ts-jest": "^26.5.6",
+		"ts-jest": "^27.0.2",
 		"ts-node": "^10.0.0",
-		"typedoc": "^0.20.36",
+		"typedoc": "^0.21.0-beta.1",
 		"typedoc-plugin-nojekyll": "^1.0.1",
-		"typescript": "^4.2.4"
+		"typescript": "^4.3.2"
 	},
 	"repository": {
 		"type": "git",

src/lib/SapphireClient.ts

@@ -111,6 +111,8 @@ export interface SapphireClientOptions {
  * [[SapphireClient.registerUserDirectories]] for reference. This method is called at the start of the
  * [[SapphireClient.login]] method.
  *
+ * @see {@link SapphireClientOptions} for all options available to the Sapphire Client. You can also provide all of discord.js' [ClientOptions](https://discord.js.org/#/docs/main/stable/typedef/ClientOptions)
+ *
  * @since 1.0.0
  * @example
  * ```typescript

src/lib/structures/Event.ts

@@ -83,7 +83,6 @@ export abstract class Event<E extends keyof ClientEvents | symbol = ''> extends
 
 	private async _run(...args: unknown[]) {
 		try {
-			// @ts-expect-error Argument of type 'unknown[]' is not assignable to parameter of type 'E extends string | number ? ClientEvents[E] : unknown[]'. (2345)
 			await this.run(...args);
 		} catch (error) {
 			this.container.client.emit(Events.EventError, error, { piece: this });