From 649395ebb2df9fd57a7fdbfa5e49cc109f40f473 Mon Sep 17 00:00:00 2001 From: Almeida Date: Thu, 3 Sep 2026 13:03:13 +0100 Subject: [PATCH] chore(rpc): add missing configs (#11613) --- .github/workflows/remove-tag.yml | 1 + apps/website/package.json | 2 +- .../actions/src/uploadCoverage/action.yml | 2 +- packages/rpc/.cliff-jumperrc.json | 1 + packages/rpc/.gitignore | 1 - packages/rpc/README.md | 70 +++++++++++++++++++ packages/rpc/package.json | 2 +- packages/rpc/tsconfig.test.json | 3 +- 8 files changed, 77 insertions(+), 5 deletions(-) create mode 100644 packages/rpc/README.md diff --git a/.github/workflows/remove-tag.yml b/.github/workflows/remove-tag.yml index 3e6ad6bc6..7c1535150 100644 --- a/.github/workflows/remove-tag.yml +++ b/.github/workflows/remove-tag.yml @@ -28,6 +28,7 @@ jobs: - '@discordjs/next' - '@discordjs/proxy' - '@discordjs/rest' + - '@discordjs/rpc' - '@discordjs/structures' - '@discordjs/util' - '@discordjs/voice' diff --git a/apps/website/package.json b/apps/website/package.json index 9c24c62d6..c885a60fe 100644 --- a/apps/website/package.json +++ b/apps/website/package.json @@ -6,7 +6,7 @@ "private": true, "scripts": { "cf-typegen": "wrangler types --env-interface CloudflareEnv cloudflare-env.d.ts", - "build:copy_readme": "cpy \"../../packages/(discord.js|brokers|builders|collection|core|formatters|next|proxy|rest|structures|util|voice|ws)/README.md\" \"src/assets/readme\" --rename='home-{{basename}}'", + "build:copy_readme": "cpy \"../../packages/(discord.js|brokers|builders|collection|core|formatters|next|proxy|rest|rpc|structures|util|voice|ws)/README.md\" \"src/assets/readme\" --rename='home-{{basename}}'", "build:check": "tsc --noEmit", "build:local": "cross-env NEXT_PUBLIC_LOCAL_DEV=true pnpm run build:prod", "build:prod": "pnpm run build:copy_readme && pnpm run build:next", diff --git a/packages/actions/src/uploadCoverage/action.yml b/packages/actions/src/uploadCoverage/action.yml index 7cca0ee39..983e323fe 100644 --- a/packages/actions/src/uploadCoverage/action.yml +++ b/packages/actions/src/uploadCoverage/action.yml @@ -90,7 +90,7 @@ runs: - name: Upload RPC Coverage if: ${{ hashFiles('packages/rpc/coverage/cobertura-coverage.xml') != '' }} - uses: codecov/codecov-action@v4 + uses: codecov/codecov-action@v7 with: files: ./packages/rpc/coverage/cobertura-coverage.xml disable_search: true diff --git a/packages/rpc/.cliff-jumperrc.json b/packages/rpc/.cliff-jumperrc.json index 6029a27d2..43cfdfcc8 100644 --- a/packages/rpc/.cliff-jumperrc.json +++ b/packages/rpc/.cliff-jumperrc.json @@ -1,4 +1,5 @@ { + "$schema": "./node_modules/@favware/cliff-jumper/assets/cliff-jumper.schema.json", "name": "rpc", "org": "discordjs", "packagePath": "packages/rpc", diff --git a/packages/rpc/.gitignore b/packages/rpc/.gitignore index 8664763c9..90500960f 100644 --- a/packages/rpc/.gitignore +++ b/packages/rpc/.gitignore @@ -21,7 +21,6 @@ dist-docs # Docs docs/**/* !docs/README.md -!docs/examples/**/* # Miscellaneous .turbo diff --git a/packages/rpc/README.md b/packages/rpc/README.md new file mode 100644 index 000000000..5a4966ac1 --- /dev/null +++ b/packages/rpc/README.md @@ -0,0 +1,70 @@ +
+
+

+ discord.js +

+
+

+ Discord server + npm version + npm downloads + Tests status + Last commit. + backers + Code coverage +

+

+ Vercel + Cloudflare Workers +

+
+ +## About + +`@discordjs/rpc` is a simple RPC client for Discord. It connects to the Discord desktop client running on the same machine over IPC, letting your application set a Rich Presence, react to client events, and call any [RPC command](https://docs.discord.com/developers/topics/rpc). + +## Installation + +**Node.js 24.17.0 or newer is required.** + +```sh +npm install @discordjs/rpc +yarn add @discordjs/rpc +pnpm add @discordjs/rpc +bun add @discordjs/rpc +``` + +## Links + +- [Website][website] ([source][website-source]) +- [Documentation][documentation] +- [Guide][guide] ([source][guide-source]) + Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library. +- [discord.js Discord server][discord] +- [Discord Developers Discord server][discord-developers] +- [GitHub][source] +- [npm][npm] +- [Related libraries][related-libs] + +## Contributing + +Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the +[documentation][documentation]. +See [the contribution guide][contributing] 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][discord]. + +[website]: https://discord.js.org +[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website +[documentation]: https://discord.js.org/docs/packages/rpc/stable +[guide]: https://discordjs.guide +[guide-source]: https://github.com/discordjs/discord.js/tree/main/apps/guide +[guide-update]: https://discordjs.guide/legacy/additional-info/changes-in-v14 +[discord]: https://discord.gg/djs +[discord-developers]: https://discord.gg/discord-developers +[source]: https://github.com/discordjs/discord.js/tree/main/packages/rpc +[npm]: https://www.npmjs.com/package/@discordjs/rpc +[related-libs]: https://docs.discord.com/developers/developer-tools/community-resources#libraries +[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md diff --git a/packages/rpc/package.json b/packages/rpc/package.json index 78f6d4bd8..bbc083819 100644 --- a/packages/rpc/package.json +++ b/packages/rpc/package.json @@ -10,7 +10,7 @@ "format": "prettier --write . && cross-env TIMING=1 eslint --fix --format=pretty src", "fmt": "pnpm run format", "docs": "pnpm run build:docs && api-extractor run --local --minify && generate-split-documentation", - "prepack": "pnpm run lint && pnpm run build", + "prepack": "pnpm run build && pnpm run lint", "changelog": "git cliff --prepend ./CHANGELOG.md -u -c ./cliff.toml -r ../../ --include-path 'packages/rpc/*'", "release": "cliff-jumper" }, diff --git a/packages/rpc/tsconfig.test.json b/packages/rpc/tsconfig.test.json index ff6ac30b6..11e8d6d40 100644 --- a/packages/rpc/tsconfig.test.json +++ b/packages/rpc/tsconfig.test.json @@ -2,7 +2,8 @@ "$schema": "https://json.schemastore.org/tsconfig.json", "extends": "./tsconfig.json", "compilerOptions": { - "noEmit": true + "noEmit": true, + "skipLibCheck": true }, "include": ["__tests__/**/*.ts"], "exclude": ["node_modules"]