Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-09 16:13:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: guide setup (#10862)

Browse Source
This commit is contained in:
Noel
2025-04-28 02:23:27 +02:00
committed by GitHub
parent 291012c18a
commit 2184085fda
58 changed files with 4996 additions and 3361 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
packages/actions/package.json
View File

@@ -55,17 +55,17 @@
"undici": "7.8.0"
},
"devDependencies": {
"@types/node": "^22.14.0",
"@types/node": "^22.15.2",
"@vitest/coverage-v8": "^3.1.1",
"cross-env": "^7.0.3",
"eslint": "^9.24.0",
"eslint": "^9.25.1",
"eslint-config-neon": "^0.2.7",
"eslint-formatter-compact": "^8.40.0",
"eslint-formatter-pretty": "^6.0.1",
"prettier": "^3.5.3",
"terser": "^5.37.0",
"terser": "^5.39.0",
"tsup": "^8.4.0",
"turbo": "^2.5.0",
"turbo": "^2.5.2",
"typescript": "~5.8.3",
"vitest": "^3.1.1"
},

8
packages/api-extractor-model/package.json
View File

@@ -37,17 +37,17 @@
},
"devDependencies": {
"@types/jest": "^29.5.14",
"@types/node": "^22.14.0",
"@types/node": "^22.15.2",
"cross-env": "^7.0.3",
"eslint": "^9.24.0",
"eslint": "^9.25.1",
"eslint-config-neon": "^0.2.7",
"eslint-formatter-compact": "^8.40.0",
"eslint-formatter-pretty": "^6.0.1",
"jest": "^29.7.0",
"prettier": "^3.5.3",
"terser": "^5.37.0",
"terser": "^5.39.0",
"tsup": "^8.4.0",
"turbo": "^2.5.0",
"turbo": "^2.5.2",
"typescript": "~5.8.3"
}
}

8
packages/api-extractor-utils/package.json
View File

@@ -50,16 +50,16 @@
"@microsoft/tsdoc": "0.14.2"
},
"devDependencies": {
"@types/node": "^22.14.0",
"@types/node": "^22.15.2",
"cross-env": "^7.0.3",
"eslint": "^9.24.0",
"eslint": "^9.25.1",
"eslint-config-neon": "^0.2.7",
"eslint-formatter-compact": "^8.40.0",
"eslint-formatter-pretty": "^6.0.1",
"prettier": "^3.5.3",
"terser": "^5.37.0",
"terser": "^5.39.0",
"tsup": "^8.4.0",
"turbo": "^2.5.0",
"turbo": "^2.5.2",
"typescript": "~5.8.3"
},
"engines": {

12
packages/api-extractor/package.json
View File

@@ -65,20 +65,20 @@
},
"devDependencies": {
"@types/jest": "^29.5.14",
"@types/lodash": "^4.17.13",
"@types/node": "^22.14.0",
"@types/lodash": "^4.17.16",
"@types/node": "^22.15.2",
"@types/resolve": "^1.20.6",
"@types/semver": "^7.5.8",
"@types/semver": "^7.7.0",
"cpy-cli": "^5.0.0",
"cross-env": "^7.0.3",
"eslint": "^9.24.0",
"eslint": "^9.25.1",
"eslint-config-neon": "^0.2.7",
"eslint-formatter-compact": "^8.40.0",
"eslint-formatter-pretty": "^6.0.1",
"jest": "^29.7.0",
"prettier": "^3.5.3",
"terser": "^5.37.0",
"terser": "^5.39.0",
"tsup": "^8.4.0",
"turbo": "^2.5.0"
"turbo": "^2.5.2"
}
}

6
packages/brokers/package.json
View File

@@ -75,17 +75,17 @@
"@discordjs/api-extractor": "workspace:^",
"@discordjs/scripts": "workspace:^",
"@favware/cliff-jumper": "^4.1.0",
"@types/node": "^22.14.0",
"@types/node": "^22.15.2",
"@vitest/coverage-v8": "^3.1.1",
"cross-env": "^7.0.3",
"esbuild-plugin-version-injector": "^1.2.1",
"eslint": "^9.24.0",
"eslint": "^9.25.1",
"eslint-config-neon": "^0.2.7",
"eslint-formatter-compact": "^8.40.0",
"eslint-formatter-pretty": "^6.0.1",
"prettier": "^3.5.3",
"tsup": "^8.4.0",
"turbo": "^2.5.0",
"turbo": "^2.5.2",
"typescript": "~5.8.3",
"vitest": "^3.1.1"
},

6
packages/builders/package.json
View File

@@ -76,17 +76,17 @@
"@discordjs/api-extractor": "workspace:^",
"@discordjs/scripts": "workspace:^",
"@favware/cliff-jumper": "^4.1.0",
"@types/node": "^22.14.0",
"@types/node": "^22.15.2",
"@vitest/coverage-v8": "^3.1.1",
"cross-env": "^7.0.3",
"esbuild-plugin-version-injector": "^1.2.1",
"eslint": "^9.24.0",
"eslint": "^9.25.1",
"eslint-config-neon": "^0.2.7",
"eslint-formatter-compact": "^8.40.0",
"eslint-formatter-pretty": "^6.0.1",
"prettier": "^3.5.3",
"tsup": "^8.4.0",
"turbo": "^2.5.0",
"turbo": "^2.5.2",
"typescript": "~5.8.3",
"vitest": "^3.1.1"
},

6
packages/collection/package.json
View File

@@ -64,17 +64,17 @@
"@discordjs/api-extractor": "workspace:^",
"@discordjs/scripts": "workspace:^",
"@favware/cliff-jumper": "^4.1.0",
"@types/node": "^22.14.0",
"@types/node": "^22.15.2",
"@vitest/coverage-v8": "^3.1.1",
"cross-env": "^7.0.3",
"esbuild-plugin-version-injector": "^1.2.1",
"eslint": "^9.24.0",
"eslint": "^9.25.1",
"eslint-config-neon": "^0.2.7",
"eslint-formatter-compact": "^8.40.0",
"eslint-formatter-pretty": "^6.0.1",
"prettier": "^3.5.3",
"tsup": "^8.4.0",
"turbo": "^2.5.0",
"turbo": "^2.5.2",
"typescript": "~5.8.3",
"vitest": "^3.1.1"
},

6
packages/core/package.json
View File

@@ -76,17 +76,17 @@
"@discordjs/api-extractor": "workspace:^",
"@discordjs/scripts": "workspace:^",
"@favware/cliff-jumper": "^4.1.0",
"@types/node": "^22.14.0",
"@types/node": "^22.15.2",
"@vitest/coverage-v8": "^3.1.1",
"cross-env": "^7.0.3",
"esbuild-plugin-version-injector": "^1.2.1",
"eslint": "^9.24.0",
"eslint": "^9.25.1",
"eslint-config-neon": "^0.2.7",
"eslint-formatter-compact": "^8.40.0",
"eslint-formatter-pretty": "^6.0.1",
"prettier": "^3.5.3",
"tsup": "^8.4.0",
"turbo": "^2.5.0",
"turbo": "^2.5.2",
"typescript": "~5.8.3",
"vitest": "^3.1.1"
},

6
packages/create-discord-bot/package.json
View File

@@ -58,16 +58,16 @@
"devDependencies": {
"@discordjs/api-extractor": "workspace:^",
"@favware/cliff-jumper": "^4.1.0",
"@types/node": "^22.14.0",
"@types/node": "^22.15.2",
"@types/prompts": "^2.4.9",
"@types/validate-npm-package-name": "^4.0.2",
"cross-env": "^7.0.3",
"eslint": "^9.24.0",
"eslint": "^9.25.1",
"eslint-config-neon": "^0.2.7",
"eslint-formatter-compact": "^8.40.0",
"eslint-formatter-pretty": "^6.0.1",
"prettier": "^3.5.3",
"terser": "^5.37.0",
"terser": "^5.39.0",
"tsup": "^8.4.0",
"typescript": "~5.8.3"
},

52
packages/discord.js/.eslintrc.json
View File

@@ -5,7 +5,7 @@
{
"files": ["src/**/*.js", "test/**/*.js"],
"extends": ["eslint:recommended"],
"plugins": ["import"],
"plugins": ["import", "jsdoc"],
"parserOptions": {
"ecmaVersion": 2022
},
@@ -13,6 +13,29 @@
"es2022": true,
"node": true
},
"settings": {
"jsdoc": {
"tagNamePreference": {
"augments": "extends",
"return": "returns",
"arg": "param",
"fires": "emits",
"function": "method"
},
"preferredTypes": {
"String": "string",
"Number": "number",
"Boolean": "boolean",
"Symbol": "symbol",
"object": "Object",
"function": "Function",
"array": "Array",
"date": "Date",
"error": "Error",
"null": "void"
}
}
},
"rules": {
"import/order": [
"error",
@@ -29,29 +52,10 @@
"no-compare-neg-zero": "error",
"no-template-curly-in-string": "error",
"no-unsafe-negation": "error",
"valid-jsdoc": [
"error",
{
"requireReturn": false,
"requireReturnDescription": false,
"prefer": {
"return": "returns",
"arg": "param"
},
"preferType": {
"String": "string",
"Number": "number",
"Boolean": "boolean",
"Symbol": "symbol",
"object": "Object",
"function": "Function",
"array": "Array",
"date": "Date",
"error": "Error",
"null": "void"
}
}
],
"jsdoc/require-returns": "off",
"jsdoc/require-returns-description": "off",
"jsdoc/check-tag-names": "error",
"jsdoc/check-types": "error",
"accessor-pairs": "warn",
"array-callback-return": "error",

9
packages/discord.js/package.json
View File

@@ -85,20 +85,21 @@
"@discordjs/docgen": "workspace:^",
"@discordjs/scripts": "workspace:^",
"@favware/cliff-jumper": "^4.1.0",
"@types/node": "^22.14.0",
"@typescript-eslint/eslint-plugin": "^8.29.0",
"@types/node": "^22.15.2",
"@typescript-eslint/eslint-plugin": "^8.31.0",
"@typescript-eslint/parser": "^8.29.0",
"cross-env": "^7.0.3",
"dtslint": "4.2.1",
"eslint": "^8.57.1",
"eslint": "^9.25.1",
"eslint-formatter-compact": "^8.40.0",
"eslint-formatter-pretty": "^5.0.0",
"eslint-plugin-import": "^2.31.0",
"eslint-plugin-jsdoc": "^50.6.11",
"jest": "29.7.0",
"prettier": "^3.5.3",
"tsd": "^0.31.2",
"tslint": "6.1.3",
"turbo": "^2.5.0",
"turbo": "^2.5.2",
"typescript": "~5.8.3"
},
"engines": {

2
packages/discord.js/src/client/WebhookClient.js
View File

@@ -65,7 +65,7 @@ class WebhookClient extends BaseClient {
*/
// These are here only for documentation purposes - they are implemented by Webhook
/* eslint-disable no-empty-function, valid-jsdoc */
/* eslint-disable no-empty-function */
/**
* Sends a message with this webhook.
* @param {string|MessagePayload|WebhookMessageCreateOptions} options The content for the reply

2
packages/discord.js/src/util/Components.js
View File

@@ -23,7 +23,7 @@ const { ComponentType } = require('discord-api-types/v10');
*/
/**
* @typedef {object} SelectMenuComponentOptionData
* @typedef {Object} SelectMenuComponentOptionData
* @property {string} label The label of the option
* @property {string} value The value of the option
* @property {?string} description The description of the option

6
packages/docgen/package.json
View File

@@ -68,15 +68,15 @@
"devDependencies": {
"@favware/cliff-jumper": "^4.1.0",
"@types/jsdoc-to-markdown": "^7.0.6",
"@types/node": "^22.14.0",
"@types/node": "^22.15.2",
"cross-env": "^7.0.3",
"eslint": "^9.24.0",
"eslint": "^9.25.1",
"eslint-config-neon": "^0.2.7",
"eslint-formatter-compact": "^8.40.0",
"eslint-formatter-pretty": "^6.0.1",
"prettier": "^3.5.3",
"tsup": "^8.4.0",
"turbo": "^2.5.0",
"turbo": "^2.5.2",
"typescript": "~5.8.3"
},
"engines": {

6
packages/formatters/package.json
View File

@@ -61,17 +61,17 @@
"@discordjs/api-extractor": "workspace:^",
"@discordjs/scripts": "workspace:^",
"@favware/cliff-jumper": "^4.1.0",
"@types/node": "^22.14.0",
"@types/node": "^22.15.2",
"@vitest/coverage-v8": "^3.1.1",
"cross-env": "^7.0.3",
"esbuild-plugin-version-injector": "^1.2.1",
"eslint": "^9.24.0",
"eslint": "^9.25.1",
"eslint-config-neon": "^0.2.7",
"eslint-formatter-compact": "^8.40.0",
"eslint-formatter-pretty": "^6.0.1",
"prettier": "^3.5.3",
"tsup": "^8.4.0",
"turbo": "^2.5.0",
"turbo": "^2.5.2",
"typescript": "~5.8.3",
"vitest": "^3.1.1"
},

6
packages/next/package.json
View File

@@ -78,17 +78,17 @@
"@discordjs/api-extractor": "workspace:^",
"@discordjs/scripts": "workspace:^",
"@favware/cliff-jumper": "^4.1.0",
"@types/node": "^22.14.0",
"@types/node": "^22.15.2",
"@vitest/coverage-v8": "^3.1.1",
"cross-env": "^7.0.3",
"esbuild-plugin-version-injector": "^1.2.1",
"eslint": "^9.24.0",
"eslint": "^9.25.1",
"eslint-config-neon": "^0.2.7",
"eslint-formatter-compact": "^8.40.0",
"eslint-formatter-pretty": "^6.0.1",
"prettier": "^3.5.3",
"tsup": "^8.4.0",
"turbo": "^2.5.0",
"turbo": "^2.5.2",
"typescript": "~5.8.3",
"vitest": "^3.1.1"
},

8
packages/proxy-container/package.json
View File

@@ -50,16 +50,16 @@
"tslib": "^2.8.1"
},
"devDependencies": {
"@types/node": "^22.14.0",
"@types/node": "^22.15.2",
"cross-env": "^7.0.3",
"eslint": "^9.24.0",
"eslint": "^9.25.1",
"eslint-config-neon": "^0.2.7",
"eslint-formatter-compact": "^8.40.0",
"eslint-formatter-pretty": "^6.0.1",
"prettier": "^3.5.3",
"terser": "^5.37.0",
"terser": "^5.39.0",
"tsup": "^8.4.0",
"turbo": "^2.5.0",
"turbo": "^2.5.2",
"typescript": "~5.8.3"
},
"engines": {

6
packages/proxy/package.json
View File

@@ -74,19 +74,19 @@
"@discordjs/api-extractor": "workspace:^",
"@discordjs/scripts": "workspace:^",
"@favware/cliff-jumper": "^4.1.0",
"@types/node": "^22.14.0",
"@types/node": "^22.15.2",
"@types/supertest": "^6.0.3",
"@vitest/coverage-v8": "^3.1.1",
"cross-env": "^7.0.3",
"esbuild-plugin-version-injector": "^1.2.1",
"eslint": "^9.24.0",
"eslint": "^9.25.1",
"eslint-config-neon": "^0.2.7",
"eslint-formatter-compact": "^8.40.0",
"eslint-formatter-pretty": "^6.0.1",
"prettier": "^3.5.3",
"supertest": "^7.0.0",
"tsup": "^8.4.0",
"turbo": "^2.5.0",
"turbo": "^2.5.2",
"typescript": "~5.8.3",
"vitest": "^3.1.1"
},

4
packages/rest/package.json
View File

@@ -102,13 +102,13 @@
"@vitest/coverage-v8": "^3.1.1",
"cross-env": "^7.0.3",
"esbuild-plugin-version-injector": "^1.2.1",
"eslint": "^9.24.0",
"eslint": "^9.25.1",
"eslint-config-neon": "^0.2.7",
"eslint-formatter-compact": "^8.40.0",
"eslint-formatter-pretty": "^6.0.1",
"prettier": "^3.5.3",
"tsup": "^8.4.0",
"turbo": "^2.5.0",
"turbo": "^2.5.2",
"typescript": "~5.5.4",
"vitest": "^3.1.1"
},

8
packages/scripts/package.json
View File

@@ -74,17 +74,17 @@
},
"devDependencies": {
"@turbo/gen": "^2.5.0",
"@types/node": "^22.14.0",
"@types/node": "^22.15.2",
"cross-env": "^7.0.3",
"env-cmd": "^10.1.0",
"eslint": "^9.24.0",
"eslint": "^9.25.1",
"eslint-config-neon": "^0.2.7",
"eslint-formatter-compact": "^8.40.0",
"eslint-formatter-pretty": "^6.0.1",
"prettier": "^3.5.3",
"terser": "^5.37.0",
"terser": "^5.39.0",
"tsup": "^8.4.0",
"turbo": "^2.5.0",
"turbo": "^2.5.2",
"typescript": "~5.8.3"
},
"engines": {

10
packages/ui/package.json
View File

@@ -67,22 +67,22 @@
"@storybook/react": "^8.6.12",
"@storybook/react-vite": "^8.6.12",
"@storybook/testing-library": "^0.2.2",
"@types/node": "^22.14.0",
"@types/react": "^19.1.0",
"@types/react-dom": "^19.1.1",
"@types/node": "^22.15.2",
"@types/react": "^19.1.2",
"@types/react-dom": "^19.1.2",
"@unocss/eslint-plugin": "^0.60.4",
"@unocss/reset": "^0.60.4",
"@vitejs/plugin-react": "^4.3.4",
"chromatic": "^11.28.0",
"cross-env": "^7.0.3",
"eslint": "^9.24.0",
"eslint": "^9.25.1",
"eslint-config-neon": "^0.2.7",
"eslint-formatter-compact": "^8.40.0",
"eslint-formatter-pretty": "^6.0.1",
"prettier": "^3.5.3",
"prop-types": "^15.8.1",
"storybook": "^8.6.12",
"turbo": "^2.5.0",
"turbo": "^2.5.2",
"typescript": "~5.8.3",
"unocss": "^0.60.4",
"vite": "^6.2.5",

6
packages/util/package.json
View File

@@ -65,17 +65,17 @@
"@discordjs/api-extractor": "workspace:^",
"@discordjs/scripts": "workspace:^",
"@favware/cliff-jumper": "^4.1.0",
"@types/node": "^22.14.0",
"@types/node": "^22.15.2",
"@vitest/coverage-v8": "^3.1.1",
"cross-env": "^7.0.3",
"esbuild-plugin-version-injector": "^1.2.1",
"eslint": "^9.24.0",
"eslint": "^9.25.1",
"eslint-config-neon": "^0.2.7",
"eslint-formatter-compact": "^8.40.0",
"eslint-formatter-pretty": "^6.0.1",
"prettier": "^3.5.3",
"tsup": "^8.4.0",
"turbo": "^2.5.0",
"turbo": "^2.5.2",
"typescript": "~5.8.3",
"vitest": "^3.1.1"
},

6
packages/voice/package.json
View File

@@ -75,17 +75,17 @@
"@discordjs/scripts": "workspace:^",
"@favware/cliff-jumper": "^4.1.0",
"@noble/ciphers": "^1.2.1",
"@types/node": "^22.14.0",
"@types/node": "^22.15.2",
"@vitest/coverage-v8": "^3.1.1",
"cross-env": "^7.0.3",
"esbuild-plugin-version-injector": "^1.2.1",
"eslint": "^9.24.0",
"eslint": "^9.25.1",
"eslint-config-neon": "^0.2.7",
"eslint-formatter-compact": "^8.40.0",
"eslint-formatter-pretty": "^6.0.1",
"prettier": "^3.5.3",
"tsup": "^8.4.0",
"turbo": "^2.5.0",
"turbo": "^2.5.2",
"typescript": "~5.5.4",
"vitest": "^3.1.1",
"vitest-websocket-mock": "^0.5.0"

6
packages/ws/package.json
View File

@@ -87,18 +87,18 @@
"@discordjs/api-extractor": "workspace:^",
"@discordjs/scripts": "workspace:^",
"@favware/cliff-jumper": "^4.1.0",
"@types/node": "^22.14.0",
"@types/node": "^22.15.2",
"@vitest/coverage-v8": "^3.1.1",
"cross-env": "^7.0.3",
"esbuild-plugin-version-injector": "^1.2.1",
"eslint": "^9.24.0",
"eslint": "^9.25.1",
"eslint-config-neon": "^0.2.7",
"eslint-formatter-compact": "^8.40.0",
"eslint-formatter-pretty": "^6.0.1",
"mock-socket": "^9.3.1",
"prettier": "^3.5.3",
"tsup": "^8.4.0",
"turbo": "^2.5.0",
"turbo": "^2.5.2",
"typescript": "~5.8.3",
"undici": "7.8.0",
"vitest": "^3.1.1",