chore: update dependencies, configs, and examples

.commitlintrc.json

@@ -1,10 +1,11 @@
 {
+	"$schema": "https://json.schemastore.org/commitlintrc.json",
 	"extends": ["@commitlint/config-angular"],
 	"rules": {
 		"type-enum": [
 			2,
 			"always",
-			["chore", "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "style", "test", "types", "typings"]
+			["chore", "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "style", "test", "types"]
 		],
 		"scope-case": [0]
 	}

.eslintrc.json

@@ -1,11 +1,8 @@
 {
 	"root": true,
-	"extends": "marine/prettier/node",
+	"extends": ["neon/common", "neon/node", "neon/typescript", "neon/prettier"],
 	"parserOptions": {
 		"project": "./tsconfig.eslint.json"
 	},
-	"ignorePatterns": ["**/dist/*"],
-	"env": {
-		"jest": true
-	}
+	"ignorePatterns": ["**/dist/*"]
 }

.gitattributes

@@ -1 +1,2 @@
 * text=auto eol=lf
+pnpm-lock.yaml linguist-generated=true text=auto eol=lf

.github/COMMIT_CONVENTION.md

@@ -7,7 +7,7 @@
 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}/;
+/^(revert: )?(feat|fix|docs|style|refactor|perf|test|build|ci|chore|types)(\(.+\))?: .{1,72}/;
 ```
 
 #### Examples

.github/CONTRIBUTING.md

@@ -11,7 +11,7 @@ is a great boon to your development process.
 To get ready to work on the codebase, please do the following:
 
 1. Fork & clone the repository, and make sure you're on the **main** branch
-2. Run `npm clean-install` ([install](https://docs.npmjs.com/cli/v10/commands/npm-ci))
+2. Run `pnpm install --frozen-lockfile` ([install](https://pnpm.io/installation))
 3. Code your heart out!
-4. Run `npm run format && npm run lint` to make sure your changes follow our coding style
+4. Run `pnpm run format && pnpm run lint` to make sure your changes follow our coding style
 5. [Submit a pull request](https://github.com/discordjs/voice-examples/compare) (Make sure you follow the [conventional commit format](https://github.com/discordjs/voice-examples/blob/main/.github/COMMIT_CONVENTION.md))

.github/ISSUE_TEMPLATE/bug_report.yml → .github/ISSUE_TEMPLATE/01-bug_report.yml

@@ -46,7 +46,7 @@ body:
   - type: input
     id: djs-voice-version
     attributes:
-      label: "@discordjs/version version"
+      label: '@discordjs/version version'
       description: Which version of @discordjs/voice are you using? Run `npm list <package>` in your project directory and paste the output.
     validations:
       required: true
@@ -57,7 +57,7 @@ body:
       description: |
         Which version of Node.js are you using? Run `node --version` in your project directory and paste the output.
         If you are using TypeScript, please include its version (`npm list typescript`) as well.
-      placeholder: Node.js version 16.9+ is required for version 14.0.0+
+      placeholder: Node.js version 18+ is required
     validations:
       required: true
   - type: input

.github/workflows/test.yml → .github/workflows/tests.yml

@@ -8,12 +8,14 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
 
-      - name: Install node.js v16
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+
+      - name: Install Node.js v20
         uses: actions/setup-node@v4
         with:
-          node-version: 16
-          cache: 'npm'
-          cache-dependency-path: package-lock.json
+          node-version: 20
+          cache: 'pnpm'
 
       - name: Turbo cache
         id: turbo-cache
@@ -25,10 +27,10 @@ jobs:
             turbo-${{ github.job }}-${{ github.ref_name }}-
 
       - name: Install dependencies
-        run: npm ci
+        run: pnpm install --frozen-lockfile
 
       - name: ESLint
-        run: npm run lint -- --cache-dir=".turbo"
+        run: pnpm run lint --concurrency=4 -- --format=compact
 
       - name: Build
-        run: npm run build -- --cache-dir=".turbo"
+        run: pnpm run build --concurrency=4

.gitignore

@@ -1,8 +1,8 @@
 # Packages
-node_modules/
+node_modules
 
 # Log files
-logs/
+logs
 *.log
 npm-debug.log*
 
@@ -15,18 +15,29 @@ pids
 .env
 
 # Dist
-dist/
+dist
+dist-docs
 
 # Miscellaneous
-.tmp/
+.tmp
 .vscode/*
 !.vscode/extensions.json
 !.vscode/settings.json
-.idea/
+.idea
 .DS_Store
 .turbo
 tsconfig.tsbuildinfo
-coverage/
+coverage
+out
+package.tgz
+tsup.config.bundled*
+vitest.config.ts.timestamp*
+
+# Deno
+deno.lock
+
+# Bun
+bun.lockb
 
 # yarn
 .pnp.*
@@ -40,6 +51,4 @@ coverage/
 # Cache
 .prettiercache
 .eslintcache
-
-# Possible config files
-config.json
+.vercel

.husky/commit-msg

@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npx commitlint --edit $1
+pnpm exec commitlint --edit $1

.husky/pre-commit

@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npm run build:check && npm run lint
+pnpm run build:check && pnpm run lint

.prettierrc.json

@@ -1,4 +1,5 @@
 {
+	"$schema": "https://json.schemastore.org/prettierrc.json",
 	"printWidth": 120,
 	"useTabs": true,
 	"singleQuote": true,

README.md

@@ -19,7 +19,7 @@ A list of ready-to-run examples for `@discordjs/voice`.
 
 ## How to try them out
 
-All you have to do is copy the example directory of your choosing, install the dependencies, fill in the `config.json` file, and run `npm run start`.
+All you have to do is copy the example directory of your choosing, install the dependencies, fill in the `.env` file, and run `npm run start`.
 
 ## Links
 

_base/.env.example

@@ -0,0 +1 @@
+TOKEN=

_base/.eslintrc.json

@@ -1,11 +1,8 @@
 {
 	"root": true,
-	"extends": "marine/prettier/node",
+	"extends": ["neon/common", "neon/node", "neon/typescript", "neon/prettier"],
 	"parserOptions": {
 		"project": "./tsconfig.eslint.json"
 	},
-	"ignorePatterns": ["**/dist/*"],
-	"env": {
-		"jest": true
-	}
+	"ignorePatterns": ["**/dist/*"]
 }

_base/.gitignore

@@ -1,3 +1,3 @@
-config.json
+.env
 tsconfig.tsbuildinfo
 dist

_base/.prettierrc.json

@@ -1,4 +1,5 @@
 {
+	"$schema": "https://json.schemastore.org/prettierrc.json",
 	"printWidth": 120,
 	"useTabs": true,
 	"singleQuote": true,

_base/README.md

@@ -14,9 +14,9 @@ The template to use when creating a new example for voice. Steps to follow:
 $ npm install
 $ npm run build
 
-# Set a bot token (see config.example.json)
-$ cp config.example.json config.json
-$ nano config.json
+# Set a bot token (see .env.example)
+$ cp .env.example .env
+$ nano .env
 
 # Start the bot!
 $ npm start

_base/package.json

@@ -2,34 +2,30 @@
 	"name": "@discordjs/voice-examples-base",
 	"version": "0.0.1",
 	"description": "An example receiver bot written using @discordjs/voice",
-	"main": "dist/bot.js",
+	"main": "dist/index.js",
+	"type": "module",
 	"scripts": {
-		"start": "npm run build && node dist/bot",
+		"build": "rimraf dist && tsc",
+		"build:check": "tsc --noEmit --incremental false",
 		"lint": "prettier --cache --check . && eslint src --ext mjs,js,ts --cache",
 		"format": "prettier --cache --write . && eslint src --ext mjs,js,ts --fix --cache",
-		"build": "rimraf dist && tsc",
-		"build:check": "tsc --noEmit --incremental false"
+		"start": "npm run build && node --env-file=.env dist/index.js"
 	},
-	"author": "Amish Shah <[email protected]>",
+	"author": "Amish Shah <[email protected]>",
 	"license": "MIT",
 	"dependencies": {
-		"@discordjs/opus": "^0.8.0",
-		"@discordjs/voice": "^0.11.0",
-		"discord-api-types": "^0.33.5",
-		"discord.js": "^13.10.3",
-		"libsodium-wrappers": "^0.7.10",
+		"@discordjs/opus": "^0.9.0",
+		"@discordjs/voice": "^0.17.0",
+		"discord.js": "^14.15.3",
+		"libsodium-wrappers": "^0.7.13",
 		"prism-media": "^2.0.0-alpha.0"
 	},
 	"devDependencies": {
-		"@typescript-eslint/eslint-plugin": "^5.36.1",
-		"@typescript-eslint/parser": "^5.36.1",
-		"eslint": "^8.23.0",
-		"eslint-config-marine": "^9.4.1",
-		"eslint-config-prettier": "^8.5.0",
-		"eslint-import-resolver-typescript": "^3.5.0",
-		"eslint-plugin-import": "^2.26.0",
-		"prettier": "^2.7.1",
-		"rimraf": "^3.0.2",
-		"typescript": "^4.8.2"
+		"@types/node": "^20.14.7",
+		"eslint": "^8.57.0",
+		"eslint-config-neon": "^0.1.62",
+		"prettier": "^3.3.2",
+		"rimraf": "^5.0.7",
+		"typescript": "5.4.5"
 	}
 }

_base/src/index.ts

@@ -0,0 +1,8 @@
+import process from 'node:process';
+import { Client, GatewayIntentBits } from 'discord.js';
+
+const client = new Client({
+	intents: [GatewayIntentBits.Guilds, GatewayIntentBits.GuildMessages, GatewayIntentBits.GuildVoiceStates],
+});
+
+await client.login(process.env.TOKEN);

_base/tsconfig.json

@@ -1,4 +1,5 @@
 {
+	"$schema": "https://json.schemastore.org/tsconfig.json",
 	// Mapped from https://www.typescriptlang.org/tsconfig
 	"compilerOptions": {
 		// Type Checking
@@ -8,39 +9,46 @@
 		"noFallthroughCasesInSwitch": true,
 		"noImplicitOverride": true,
 		"noImplicitReturns": true,
+		"noPropertyAccessFromIndexSignature": false,
+		"noUncheckedIndexedAccess": true,
 		"noUnusedLocals": true,
 		"noUnusedParameters": true,
 		"strict": true,
-		"useUnknownInCatchVariables": true,
-		"noUncheckedIndexedAccess": true,
-		"skipLibCheck": true,
 
 		// Modules
-		"module": "CommonJS",
-		"moduleResolution": "node",
+		"allowArbitraryExtensions": false,
+		"allowImportingTsExtensions": false,
+		"module": "ESNext",
+		"moduleResolution": "Bundler",
 		"resolveJsonModule": true,
+		"resolvePackageJsonExports": true,
+		"resolvePackageJsonImports": true,
 
 		// Emit
 		"declaration": true,
-		"importHelpers": true,
-		"importsNotUsedAsValues": "error",
-		"inlineSources": true,
+		"declarationMap": true,
+		"importHelpers": false,
 		"newLine": "lf",
 		"noEmitHelpers": true,
 		"outDir": "dist",
-		"preserveConstEnums": true,
 		"removeComments": false,
 		"sourceMap": true,
-		"esModuleInterop": true,
+
+		// Interop Constraints
+		"allowSyntheticDefaultImports": true,
+		"esModuleInterop": false,
 		"forceConsistentCasingInFileNames": true,
+		"isolatedModules": true,
 
 		// Language and Environment
-		"emitDecoratorMetadata": true,
 		"experimentalDecorators": true,
-		"lib": ["ESNext"],
-		"target": "ES2021",
-		"useDefineForClassFields": true
+		"lib": ["ESNext", "esnext.disposable"],
+		"target": "ESNext",
+		"useDefineForClassFields": true,
+
+		// Completeness
+		"skipLibCheck": true
 	},
 	"include": ["src/*.ts"],
-	"exclude": []
+	"exclude": ["node_modules"]
 }

basic/.env.example

@@ -0,0 +1 @@
+TOKEN=

basic/.eslintrc.json

@@ -1,11 +1,8 @@
 {
 	"root": true,
-	"extends": "marine/prettier/node",
+	"extends": ["neon/common", "neon/node", "neon/typescript", "neon/prettier"],
 	"parserOptions": {
 		"project": "./tsconfig.eslint.json"
 	},
-	"ignorePatterns": ["**/dist/*"],
-	"env": {
-		"jest": true
-	}
+	"ignorePatterns": ["**/dist/*"]
 }

basic/.gitignore

@@ -1,3 +1,3 @@
-config.json
+.env
 tsconfig.tsbuildinfo
 dist

basic/.prettierrc.json

@@ -1,4 +1,5 @@
 {
+	"$schema": "https://json.schemastore.org/prettierrc.json",
 	"printWidth": 120,
 	"useTabs": true,
 	"singleQuote": true,