chore: repo cleanup

.github/CODE_OF_CONDUCT.md

@@ -3,7 +3,7 @@
 ## Our Pledge
 
 In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
+contributors and maintainers pledge to make participation in our project and
 our community a harassment-free experience for everyone, regardless of age, body
 size, disability, ethnicity, sex characteristics, gender identity and expression,
 level of experience, education, socio-economic status, nationality, personal
@@ -14,21 +14,21 @@ appearance, race, religion, or sexual identity and orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
+- Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
+- Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
+- Gracefully accepting constructive criticism
-* Focusing on what is best for the community
+- Focusing on what is best for the community
-* Showing empathy towards other community members
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
+- The use of sexualized language or imagery and unwelcome sexual attention or
   advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
+- Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
+- Public or private harassment
-* Publishing others' private information, such as a physical or electronic
+- Publishing others' private information, such as a physical or electronic
   address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Our Responsibilities
@@ -45,12 +45,12 @@ threatening, offensive, or harmful.
 
 ## Scope
 
-This Code of Conduct applies both within project spaces and in public spaces
+This Code of Conduct applies within all project spaces, and it also applies when
-when an individual is representing the project or its community. Examples of
+an individual is representing the project or its community in public spaces.
-representing a project or community include using an official project e-mail
+Examples of representing a project or community include using an official
-address, posting via an official social media account, or acting as an appointed
+project e-mail address, posting via an official social media account, or acting
-representative at an online or offline event. Representation of a project may be
+as an appointed representative at an online or offline event. Representation of
-further defined and clarified by project maintainers.
+a project may be further defined and clarified by project maintainers.
 
 ## Enforcement
 

.github/COMMIT_CONVENTION.md

@@ -0,0 +1,91 @@
+## Git Commit Message Convention
+
+> This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular).
+
+#### TL;DR:
+
+Messages must be matched by the following regex:
+
+```js
+/^(revert: )?(feat|fix|docs|style|refactor|perf|test|workflow|build|ci|chore|types|wip)(\(.+\))?: .{1,72}/;
+```
+
+#### Examples
+
+Appears under "Features" header, `GuildMember` subheader:
+
+```
+feat(GuildMember): add 'tag' method
+```
+
+Appears under "Bug Fixes" header, `Guild` subheader, with a link to issue #28:
+
+```
+fix(Guild): handle events correctly
+
+close #28
+```
+
+Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:
+
+```
+perf(core): improve patching by removing 'bar' option
+
+BREAKING CHANGE: The 'bar' option has been removed.
+```
+
+The following commit and commit `667ecc1` do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header.
+
+```
+revert: feat(Managers): add Managers
+
+This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
+```
+
+### Full Message Format
+
+A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**:
+
+```
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+The **header** is mandatory and the **scope** of the header is optional.
+
+### Revert
+
+If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. In the body, it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
+
+### Type
+
+If the prefix is `feat`, `fix` or `perf`, it will appear in the changelog. However, if there is any [BREAKING CHANGE](#footer), the commit will always appear in the changelog.
+
+Other prefixes are up to your discretion. Suggested prefixes are `docs`, `chore`, `style`, `refactor`, and `test` for non-changelog related tasks.
+
+### Scope
+
+The scope could be anything specifying the place of the commit change. For example `GuildMember`, `Guild`, `Message`, `MessageEmbed` etc...
+
+### Subject
+
+The subject contains a succinct description of the change:
+
+- use the imperative, present tense: "change" not "changed" nor "changes"
+- don't capitalize the first letter
+- no dot (.) at the end
+
+### Body
+
+Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
+The body should include the motivation for the change and contrast this with previous behavior.
+
+### Footer
+
+The footer should contain any information about **Breaking Changes** and is also the place to
+reference GitHub issues that this commit **Closes**.
+
+**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.

.github/CONTRIBUTING.md

@@ -14,4 +14,4 @@ To get ready to work on the codebase, please do the following:
 2. Run `npm ci`
 3. Code your heart out!
 4. Run `npm test` to run ESLint and ensure any JSDoc changes are valid
-5. [Submit a pull request](https://github.com/discordjs/discord.js/compare) (Make sure you follow the [conventional commit format](https://github.com/discordjs/discord.js-modules/blob/main/.github/COMMIT_CONVENTION.md))
+5. [Submit a pull request](https://github.com/discordjs/discord.js/compare) (Make sure you follow the [conventional commit format](https://github.com/discordjs/discord.js/blob/main/.github/COMMIT_CONVENTION.md))

.github/FUNDING.yml

@@ -1,2 +1,2 @@
-github: [amishshah, iCrawl, vladfrangu, kyranet]
+github: [iCrawl, amishshah, vladfrangu, kyranet]
 patreon: discordjs

.github/workflows/test-cron.yml

@@ -1,83 +0,0 @@
-name: Testing Cron
-on:
-  schedule:
-    - cron: '0 */12 * * *'
-jobs:
-  lint:
-    name: ESLint
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v2
-
-      - name: Install Node v16
-        uses: actions/setup-node@v2
-        with:
-          node-version: 16
-          cache: npm
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Run ESLint
-        run: npm run lint
-
-  typings:
-    name: TSLint
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v2
-
-      - name: Install Node v16
-        uses: actions/setup-node@v2
-        with:
-          node-version: 16
-          cache: npm
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Run TSLint
-        run: npm run lint:typings
-
-  typescript:
-    name: TypeScript
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v2
-
-      - name: Install Node v16
-        uses: actions/setup-node@v2
-        with:
-          node-version: 16
-          cache: npm
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Register Problem Matcher
-        run: echo "##[add-matcher].github/tsc.json"
-
-      - name: Run TypeScript compiler
-        run: npm run test:typescript
-
-  docs:
-    name: Documentation
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v2
-
-      - name: Install Node v16
-        uses: actions/setup-node@v2
-        with:
-          node-version: 16
-          cache: npm
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Test documentation
-        run: npm run docs:test

.gitignore

@@ -1,12 +1,18 @@
 # Packages
 node_modules/
-yarn.lock
 
 # Log files
 logs/
 *.log
+npm-debug.log*
 
-# Authentication
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Env
+.env
 test/auth.json
 test/auth.js
 docs/deploy/deploy_key
@@ -14,10 +20,11 @@ docs/deploy/deploy_key.pub
 deploy/deploy_key
 deploy/deploy_key.pub
 
+# Dist
+dist/
+docs/docs.json
+
 # Miscellaneous
 .tmp/
-.vscode/
 .idea/
-docs/docs.json
-typings/index.js
 .DS_Store

package.json

@@ -2,29 +2,36 @@
   "name": "discord.js",
   "version": "13.3.0-dev",
   "description": "A powerful library for interacting with the Discord API",
+  "scripts": {
+    "test": "npm run lint && npm run docs:test && npm run lint:typings && npm run test:typescript",
+    "test:typescript": "tsc --noEmit",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix",
+    "lint:typings": "tslint typings/index.d.ts",
+    "format": "prettier --write src/**/*.js typings/**/*.ts",
+    "prepare": "is-ci || husky install",
+    "docs": "docgen --source src --custom docs/index.yml --output docs/docs.json",
+    "docs:test": "docgen --source src --custom docs/index.yml",
+    "prepublishOnly": "npm run test",
+    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s"
+  },
   "main": "./src/index.js",
   "types": "./typings/index.d.ts",
   "files": [
     "src",
     "typings"
   ],
-  "scripts": {
+  "directories": {
-    "test": "npm run lint && npm run docs:test && npm run lint:typings",
+    "lib": "src",
-    "test:typescript": "tsc",
+    "test": "test"
-    "docs": "docgen --source src --custom docs/index.yml --output docs/docs.json",
-    "docs:test": "docgen --source src --custom docs/index.yml",
-    "lint": "eslint src",
-    "lint:fix": "eslint src --fix",
-    "lint:typings": "tslint typings/index.d.ts",
-    "prettier": "prettier --write src/**/*.js typings/**/*.ts",
-    "prepublishOnly": "npm run test",
-    "prepare": "is-ci || husky install",
-    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/discordjs/discord.js.git"
   },
+  "contributors": [
+    "Crawl <icrawltogo@gmail.com>",
+    "Amish Shah <amishshah.2k@gmail.com>",
+    "Vlad Frangu <kingdgrizzle@gmail.com>",
+    "SpaceEEC <spaceeec@yahoo.com>"
+  ],
+  "license": "Apache-2.0",
   "keywords": [
     "discord",
     "api",
@@ -33,17 +40,19 @@
     "node",
     "discordapp"
   ],
-  "author": "Amish Shah <amish@shah.gg>",
+  "repository": {
-  "license": "Apache-2.0",
+    "type": "git",
+    "url": "https://github.com/discordjs/discord.js.git"
+  },
   "bugs": {
     "url": "https://github.com/discordjs/discord.js/issues"
   },
   "homepage": "https://discord.js.org",
   "dependencies": {
     "@discordjs/builders": "^0.7.0",
-    "@discordjs/collection": "^0.2.1",
+    "@discordjs/collection": "^0.2.4",
     "@discordjs/form-data": "^3.0.1",
-    "@sapphire/async-queue": "^1.1.5",
+    "@sapphire/async-queue": "^1.1.8",
     "@types/node-fetch": "^2.5.12",
     "@types/ws": "^8.2.0",
     "discord-api-types": "^0.24.0",
@@ -51,25 +60,25 @@
     "ws": "^8.2.3"
   },
   "devDependencies": {
-    "@commitlint/cli": "^13.2.0",
+    "@commitlint/cli": "^13.2.1",
     "@commitlint/config-angular": "^13.2.0",
     "@discordjs/docgen": "^0.10.0",
     "@favware/npm-deprecate": "^1.0.4",
-    "@types/node": "^16.10.2",
+    "@types/node": "^16.11.6",
     "conventional-changelog-cli": "^2.1.1",
     "cross-env": "^7.0.3",
-    "dtslint": "^4.1.6",
+    "dtslint": "^4.2.0",
-    "eslint": "^7.32.0",
+    "eslint": "^8.1.0",
     "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-import": "^2.24.2",
+    "eslint-plugin-import": "^2.25.2",
     "eslint-plugin-prettier": "^4.0.0",
-    "husky": "^7.0.2",
+    "husky": "^7.0.4",
-    "is-ci": "^3.0.0",
+    "is-ci": "^3.0.1",
-    "jest": "^27.2.4",
+    "jest": "^27.3.1",
-    "lint-staged": "^11.2.0",
+    "lint-staged": "^11.2.6",
     "prettier": "^2.4.1",
     "tslint": "^6.1.3",
-    "typescript": "^4.4.3"
+    "typescript": "^4.4.4"
   },
   "engines": {
     "node": ">=16.6.0",

tsconfig.json

@@ -1,15 +1,50 @@
 {
+  // Mapped from https://www.typescriptlang.org/tsconfig
   "compilerOptions": {
+    // Type Checking
+    "allowUnreachableCode": false,
+    "allowUnusedLabels": false,
+    // if true: conflicts with discord-api-types
+    "exactOptionalPropertyTypes": false,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
     "strict": true,
+    "useUnknownInCatchVariables": true,
+
+    // Modules
+    "module": "CommonJS",
     "moduleResolution": "node",
+    "resolveJsonModule": true,
+
+    // Emit
     "declaration": false,
+    "importHelpers": true,
+    "importsNotUsedAsValues": "error",
+    "inlineSources": false,
+    "newLine": "lf",
+    "noEmitHelpers": true,
+    "outDir": "dist",
+    "preserveConstEnums": true,
     "removeComments": false,
-    "alwaysStrict": true,
-    "pretty": false,
-    "module": "commonjs",
-    "target": "es2019",
-    "lib": ["esnext", "esnext.array", "esnext.asynciterable", "esnext.intl", "esnext.symbol"],
     "sourceMap": false,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+
+    // Language and Environment
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "lib": ["ESNext"],
+    "target": "ES2020",
+    "useDefineForClassFields": true,
+
+    // Output Formatting
+    "pretty": false,
+
+    // Completeness
+    "skipLibCheck": true,
     "skipDefaultLibCheck": true
   }
 }

typings/tests.ts

@@ -1,4 +1,4 @@
-import {
+import type {
   APIGuildMember,
   APIInteractionGuildMember,
   APIMessage,
@@ -42,7 +42,6 @@ import {
   GuildMember,
   GuildResolvable,
   GuildTextBasedChannel,
-  GuildTextChannelResolvable,
   Intents,
   Interaction,
   InteractionCollector,
@@ -78,7 +77,7 @@ import {
   User,
   VoiceChannel,
 } from '.';
-import { ApplicationCommandOptionTypes } from './enums';
+import type { ApplicationCommandOptionTypes } from './enums';
 
 const client: Client = new Client({
   intents: Intents.FLAGS.GUILDS,