chore(ws): release @discordjs/ws@0.4.1

chore: make 'Note to developers' a regular comment

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>

.github/labeler.yml

@@ -1,3 +1,10 @@
+apps:guide:
+  - apps/guide/*
+  - apps/guide/**/*
+apps:website:
+  - apps/website/*
+  - apps/website/**/*
+
 packages:builders:
   - packages/builders/*
   - packages/builders/**/*
@@ -10,9 +17,6 @@ packages:discord.js:
 packages:docgen:
   - packages/docgen/*
   - packages/docgen/**/*
-packages:guide:
-  - packages/guide/*
-  - packages/guide/**/*
 packages:proxy:
   - packages/proxy/*
   - packages/proxy/**/*
@@ -22,18 +26,15 @@ packages:proxy-container:
 packages:rest:
   - packages/rest/*
   - packages/rest/**/*
+packages/ui:
+  - packages:ui/*
+  - packages:ui/**/*
 packages:util:
   - packages/util/*
   - packages/util/**/*
 packages:voice:
   - packages/voice/*
   - packages/voice/**/*
-packages:website:
-  - packages/website/*
-  - packages/website/**/*
-packages/web-components:
-  - packages:web-components/*
-  - packages:web-components/**/*
 packages:ws:
   - packages/ws/*
   - packages/ws/**/*

.github/labels.yml

@@ -2,6 +2,10 @@
   color: '5663e9'
 - name: api support
   color: '5663e9'
+- name: apps:guide
+  color: fbca04
+- name: apps:website
+  color: fbca04
 - name: backlog
   color: 7ef7ef
 - name: blocked
@@ -54,22 +58,18 @@
   color: fbca04
 - name: packages:docgen
   color: fbca04
-- name: packages:guide
-  color: fbca04
 - name: packages:proxy
   color: fbca04
 - name: packages:proxy-container
   color: fbca04
 - name: packages:rest
   color: fbca04
+- name: packages:ui
+  color: fbca04
 - name: packages:util
   color: fbca04
 - name: packages:voice
   color: fbca04
-- name: packages:website
-  color: fbca04
-- name: packages:web-components
-  color: fbca04
 - name: packages:ws
   color: fbca04
 - name: performance

.github/workflows/npm-auto-deprecate.yml

@@ -22,6 +22,6 @@ jobs:
         run: yarn --immutable
 
       - name: Deprecate versions
-        run: 'yarn npm-deprecate --name "*dev*" --package @discordjs/builders @discordjs/collection discord.js @discordjs/proxy @discordjs/rest @discordjs/util @discordjs/voice'
+        run: 'yarn npm-deprecate --name "*dev*" --package @discordjs/builders @discordjs/collection discord.js @discordjs/proxy @discordjs/rest @discordjs/util @discordjs/voice @discordjs/ws'
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}

.github/workflows/pr-triage.yml

@@ -14,4 +14,4 @@ jobs:
 
       - name: Automatically assign reviewers
         if: github.event.action == 'opened'
-        uses: kentaro-m/auto-assign-action@v1.2.1
+        uses: kentaro-m/auto-assign-action@v1.2.3

.github/workflows/tests.yml

@@ -12,7 +12,6 @@ jobs:
     env:
       TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
       TURBO_TEAM: ${{ secrets.TURBO_TEAM }}
-      NEXT_PUBLIC_LOCAL_DEV: true
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
@@ -35,6 +34,9 @@ jobs:
       - name: Tests
         run: yarn test
 
+      - name: Docs
+        run: yarn docs
+
       - name: Upload Coverage
         if: github.repository_owner == 'discordjs'
         uses: ./packages/actions/src/uploadCoverage

.lintstagedrc.json

@@ -1,5 +1,5 @@
 {
 	"*": "prettier --ignore-unknown --write",
 	"{src/**,__tests__/**}.{mjs,js,cjs,ts,tsx,astro}": "eslint --ext .mjs,.js,.cjs,.ts,.tsx,.astro --fix",
-	"src/**.ts": "vitest related --run --config ./vitest.config.ts"
+	"src/**.ts": "vitest related --run --config ../../vitest.config.ts"
 }

.vscode/settings.json

@@ -1,5 +1,5 @@
 {
-	"eslint.workingDirectories": [{ "pattern": "./packages/*" }],
+	"eslint.workingDirectories": [{ "pattern": "./apps/*" }, { "pattern": "./packages/*" }],
 	"eslint.validate": ["javascript", "javascriptreact", "astro", "typescript", "typescriptreact"],
 	"prettier.documentSelectors": ["**/*.astro"],
 	"editor.defaultFormatter": "esbenp.prettier-vscode",
@@ -11,6 +11,6 @@
 	"files.associations": {
 		"*.mdx": "markdown"
 	},
-	"unocss.root": "./packages/web-components",
+	"unocss.root": "./packages/ui",
 	"typescript.tsdk": "node_modules/typescript/lib"
 }

README.md

@@ -66,7 +66,7 @@ const commands = [
 	},
 ];
 
-const rest = new REST({ version: '10' }).setToken('token');
+const rest = new REST({ version: '10' }).setToken(TOKEN);
 
 (async () => {
 	try {
@@ -99,32 +99,47 @@ client.on('interactionCreate', async (interaction) => {
 	}
 });
 
-client.login('token');
+client.login(TOKEN);
 ```
 
 ## Links
 
-- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/discord.js/tree/main/packages/website))
-- [Documentation](https://discord.js.org/#/docs)
-- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide))
-  See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v14.html), including updated and removed items in the library.
-- [discord.js Discord server](https://discord.gg/djs)
-- [Discord API Discord server](https://discord.gg/discord-api)
-- [GitHub](https://github.com/discordjs/discord.js)
-- [npm](https://www.npmjs.com/package/discord.js)
-- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries)
+- [Website][website] ([source][website-source])
+- [Documentation][documentation]
+- [Guide][guide] ([source][guide-source])
+  See also the [Update Guide][guide-update], including updated and removed items in the library.
+- [discord.js Discord server][discord]
+- [Discord API Discord server][discord-api]
+- [GitHub][source]
+- [npm][npm]
+- [Related libraries][related-libs]
 
 ### Extensions
 
-- [RPC](https://www.npmjs.com/package/discord-rpc) ([source](https://github.com/discordjs/RPC))
+- [RPC][rpc] ([source][rpc-source])
 
 ## Contributing
 
 Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the
-[documentation](https://discord.js.org/#/docs).  
-See [the contribution guide](https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md) if you'd like to submit a PR.
+[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](https://discord.gg/djs).
+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
+[guide]: https://discordjs.guide/
+[guide-source]: https://github.com/discordjs/guide
+[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html
+[discord]: https://discord.gg/djs
+[discord-api]: https://discord.gg/discord-api
+[source]: https://github.com/discordjs/discord.js/tree/main/packages/discord.js
+[npm]: https://www.npmjs.com/package/discord.js
+[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries
+[rpc]: https://www.npmjs.com/package/discord-rpc
+[rpc-source]: https://github.com/discordjs/RPC
+[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md

apps/guide/README.md

@@ -0,0 +1,46 @@
+<div align="center">
+	<br />
+	<p>
+		<a href="https://discord.js.org"><img src="https://discord.js.org/static/logo.svg" width="546" alt="discord.js" /></a>
+	</p>
+	<br />
+	<p>
+		<a href="https://discord.gg/djs"><img src="https://img.shields.io/discord/222078108977594368?color=5865F2&logo=discord&logoColor=white" alt="Discord server" /></a>
+		<a href="https://github.com/discordjs/discord.js/actions"><img src="https://github.com/discordjs/discord.js/actions/workflows/test.yml/badge.svg" alt="Build status" /></a>
+	</p>
+	<p>
+		<a href="https://vercel.com/?utm_source=discordjs&utm_campaign=oss"><img src="https://raw.githubusercontent.com/discordjs/discord.js/main/.github/powered-by-vercel.svg" alt="Vercel" /></a>
+	</p>
+</div>
+
+## Links
+
+- [Website][website] ([source][website-source])
+- [Documentation][documentation]
+- [Guide][guide] ([source][guide-source])
+  See also the [Update Guide][guide-update], including updated and removed items in the library.
+- [discord.js Discord server][discord]
+- [Discord API Discord server][discord-api]
+- [GitHub][source]
+- [Related libraries][related-libs]
+
+## Contributing
+
+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/
+[guide]: https://discordjs.guide/
+[guide-source]: https://github.com/discordjs/guide
+[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html
+[discord]: https://discord.gg/djs
+[discord-api]: https://discord.gg/discord-api
+[source]: https://github.com/discordjs/discord.js/tree/main/apps/guide
+[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries
+[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md

apps/guide/astro.config.ts

@@ -1,9 +1,12 @@
 import { fileURLToPath, URL } from 'node:url';
 import image from '@astrojs/image';
 import mdx from '@astrojs/mdx';
+import prefetch from '@astrojs/prefetch';
 import react from '@astrojs/react';
 import { remarkCodeHike } from '@code-hike/mdx';
 import { defineConfig } from 'astro/config';
+import compress from 'astro-compress';
+import critters from 'astro-critters';
 import { toString } from 'hast-util-to-string';
 import { h } from 'hastscript';
 import { escape } from 'html-escaper';
@@ -47,9 +50,14 @@ export default defineConfig({
 		image({
 			serviceEntryPoint: '@astrojs/image/sharp',
 		}),
-		Unocss({
-			configFile: fileURLToPath(new URL('../ui/unocss.config.ts', import.meta.url)),
+		prefetch({
+			throttle: 3,
 		}),
+		Unocss({
+			configFile: fileURLToPath(new URL('../../packages/ui/unocss.config.ts', import.meta.url)),
+		}),
+		critters(),
+		compress(),
 	],
 	markdown: {
 		remarkPlugins: [[remarkCodeHike, { autoImport: false, theme: shikiThemeDarkPlus, lineNumbers: true }]],
@@ -89,6 +97,7 @@ export default defineConfig({
 			alias: {
 				'ariakit/button': fileURLToPath(new URL('node_modules/ariakit/esm/button/index.js', import.meta.url)),
 				'ariakit/disclosure': fileURLToPath(new URL('node_modules/ariakit/esm/disclosure/index.js', import.meta.url)),
+				'ariakit/separator': fileURLToPath(new URL('node_modules/ariakit/esm/separator/index.js', import.meta.url)),
 				'ariakit-utils/dom': fileURLToPath(new URL('node_modules/ariakit-utils/esm/dom.js', import.meta.url)),
 				'ariakit-utils/events': fileURLToPath(new URL('node_modules/ariakit-utils/esm/events.js', import.meta.url)),
 				'ariakit-utils/focus': fileURLToPath(new URL('node_modules/ariakit-utils/esm/focus.js', import.meta.url)),

apps/guide/package.json

@@ -39,38 +39,35 @@
 		"@astrojs/react": "^1.1.4",
 		"@code-hike/mdx": "^0.7.4",
 		"@discordjs/ui": "workspace:^",
-		"@vscode/codicons": "^0.0.32",
 		"ariakit": "^2.0.0-next.41",
-		"astro": "^1.4.6",
 		"cmdk": "^0.1.20",
 		"meilisearch": "^0.28.0",
 		"react": "^17.0.2",
 		"react-custom-scrollbars-2": "^4.5.0",
 		"react-dom": "^17.0.2",
 		"react-icons": "^4.4.0",
-		"react-syntax-highlighter": "^15.5.0",
 		"react-use": "^17.4.0",
-		"rehype-ignore": "^1.0.1",
-		"rehype-pretty-code": "^0.3.2",
-		"rehype-raw": "^6.1.1",
 		"sharp": "^0.31.1",
 		"shiki": "^0.11.1"
 	},
 	"devDependencies": {
+		"@astrojs/prefetch": "^0.0.8",
 		"@testing-library/react": "^13.4.0",
 		"@testing-library/user-event": "^14.4.3",
 		"@types/node": "^16.11.64",
 		"@types/react": "^17.0.50",
 		"@types/react-dom": "^17.0.17",
 		"@types/react-syntax-highlighter": "^15.5.5",
-		"@unocss/cli": "^0.45.26",
-		"@unocss/reset": "^0.45.26",
+		"@unocss/cli": "^0.45.29",
+		"@unocss/reset": "^0.45.29",
 		"@vitejs/plugin-react": "^2.1.0",
 		"@vitest/coverage-c8": "^0.24.0",
-		"concurrently": "^7.4.0",
+		"astro": "^1.4.6",
+		"astro-compress": "^1.0.11",
+		"astro-critters": "^1.0.5",
 		"cross-env": "^7.0.3",
-		"eslint": "^8.24.0",
-		"eslint-config-neon": "^0.1.35",
+		"eslint": "^8.25.0",
+		"eslint-config-neon": "^0.1.37",
 		"happy-dom": "^7.4.0",
 		"hast-util-to-string": "^2.0.0",
 		"hastscript": "^7.0.2",
@@ -81,7 +78,7 @@
 		"rehype-autolink-headings": "^6.1.1",
 		"rehype-slug": "^5.0.1",
 		"typescript": "^4.8.4",
-		"unocss": "^0.45.26",
+		"unocss": "^0.45.29",
 		"vercel": "^28.4.8",
 		"vitest": "^0.24.0"
 	},

apps/guide/src/components/ExternalLink.tsx

@@ -0,0 +1,10 @@
+import { FiExternalLink } from 'react-icons/fi';
+
+export function ExternalLink({ href, title }: { href: string; title: string }) {
+	return (
+		<a className="text-blurple inline-flex place-items-center gap-2 text-sm font-semibold" href={href}>
+			<p>{title}</p>
+			<FiExternalLink size={18} />
+		</a>
+	);
+}

apps/guide/src/components/SidebarLayout.astro

@@ -1,27 +1,30 @@
 ---
+import { Separator } from 'ariakit/separator';
 import type { MarkdownLayoutProps } from 'astro';
+import { ExternalLink } from './ExternalLink.jsx';
 import { Navbar } from './Navbar.jsx';
 import { Outline } from './Outline.jsx';
 import { SidebarItems } from './SidebarItems.jsx';
+import { generateGithubURL } from '~/util/url.js';
 
 const pages = await Astro.glob<{ category: string; title: string }>('../pages/**/*.mdx');
 
 type Props = MarkdownLayoutProps<{}>;
-const { headings } = Astro.props;
+const { headings, url } = Astro.props;
 ---
 
-<script is:inline>
+<script>
 	window.addEventListener('load', () => {
 		const headings = document.querySelectorAll(
 			'div.level-h1 > h1, div.level-h2 > h2, div.level-h3 > h3, div.level-h4 > h4',
 		);
 
 		const headingsObserver = new IntersectionObserver(
-			(entries, observer) => {
+			(entries) => {
 				entries.forEach((entry) => {
 					if (entry.isIntersecting) {
 						const location = window.location.toString().split('#')[0];
-						history.replaceState(null, null, location + '#' + entry.target.id);
+						history.replaceState(null, '', location + '#' + entry.target.id);
 					}
 				});
 			},
@@ -47,11 +50,16 @@ const { headings } = Astro.props;
 			<div class="prose max-w-full">
 				<slot />
 			</div>
+
 			<div
 				class="h-[calc(100vh - 72px)] dark:bg-dark-600 dark:border-dark-100 border-light-800 fixed top-[72px] right-0 bottom-0 z-20 hidden w-64 border-l bg-white pr-2 xl:block"
 			>
 				<Outline client:load headings={headings} />
 			</div>
+			<Separator className="my-5" />
+			<div class="flex place-content-end">
+				<ExternalLink client:load href={generateGithubURL(url!)} title="Edit this page on github" />
+			</div>
 		</div>
 
 		<div class="h-76 md:h-52"></div>

apps/guide/src/layouts/SidebarLayout.astro

@@ -1,4 +1,5 @@
 ---
+import '../styles/main.css';
 import '@code-hike/mdx/styles.css';
 import '../styles/ch.css';
 import type { MarkdownLayoutProps } from 'astro';

apps/guide/src/styles/main.css

@@ -0,0 +1,16 @@
+@import url('https://rsms.me/inter/inter.css');
+
+:root {
+	font-family: 'Inter', ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto,
+		'Helvetica Neue', Arial, 'Noto Sans', sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol',
+		'Noto Color Emoji';
+	font-feature-settings: 'cv02', 'cv03', 'cv04', 'cv11';
+}
+
+@supports (font-variation-settings: normal) {
+	:root {
+		font-family: 'Inter var', ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto,
+			'Helvetica Neue', Arial, 'Noto Sans', sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol',
+			'Noto Color Emoji';
+	}
+}

apps/guide/src/util/constants.ts

@@ -0,0 +1,3 @@
+export const DESCRIPTION = 'Imagine a guide... that explores the many possibilities for your discord.js bot.';
+
+export const GITHUB_BASE_PAGES_PATH = 'https://github.com/discordjs/discord.js/tree/main/apps/guide/src/pages';

apps/guide/src/util/url.ts

@@ -0,0 +1,5 @@
+import { GITHUB_BASE_PAGES_PATH } from './constants.js';
+
+export function generateGithubURL(pageURL: string) {
+	return `${GITHUB_BASE_PAGES_PATH}${pageURL}.mdx`;
+}

apps/guide/vercel.json

@@ -0,0 +1,3 @@
+{
+	"cleanUrls": true
+}

apps/website/README.md

@@ -0,0 +1,46 @@
+<div align="center">
+	<br />
+	<p>
+		<a href="https://discord.js.org"><img src="https://discord.js.org/static/logo.svg" width="546" alt="discord.js" /></a>
+	</p>
+	<br />
+	<p>
+		<a href="https://discord.gg/djs"><img src="https://img.shields.io/discord/222078108977594368?color=5865F2&logo=discord&logoColor=white" alt="Discord server" /></a>
+		<a href="https://github.com/discordjs/discord.js/actions"><img src="https://github.com/discordjs/discord.js/actions/workflows/test.yml/badge.svg" alt="Build status" /></a>
+	</p>
+	<p>
+		<a href="https://vercel.com/?utm_source=discordjs&utm_campaign=oss"><img src="https://raw.githubusercontent.com/discordjs/discord.js/main/.github/powered-by-vercel.svg" alt="Vercel" /></a>
+	</p>
+</div>
+
+## Links
+
+- [Website][website] ([source][website-source])
+- [Documentation][documentation]
+- [Guide][guide] ([source][guide-source])
+  See also the [Update Guide][guide-update], including updated and removed items in the library.
+- [discord.js Discord server][discord]
+- [Discord API Discord server][discord-api]
+- [GitHub][source]
+- [Related libraries][related-libs]
+
+## Contributing
+
+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/
+[guide]: https://discordjs.guide/
+[guide-source]: https://github.com/discordjs/guide
+[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html
+[discord]: https://discord.gg/djs
+[discord-api]: https://discord.gg/discord-api
+[source]: https://github.com/discordjs/discord.js/tree/main/apps/website
+[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries
+[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md

apps/website/package.json

@@ -13,7 +13,7 @@
 		"dev": "yarn run --top-level docs && concurrently 'yarn dev:css' 'yarn dev:next'",
 		"dev:next": "next dev",
 		"dev:css": "yarn generate:css --watch",
-		"generate:css": "unocss 'src/**/*.tsx' '../ui/src/**/*.tsx' --out-file ./src/styles/unocss.css --config ../ui/unocss.config.ts",
+		"generate:css": "unocss 'src/**/*.tsx' '../../packages/ui/src/lib/components/**/*.tsx' --out-file ./src/styles/unocss.css --config ../../packages/ui/unocss.config.ts",
 		"lint": "prettier --check . && cross-env TIMING=1 eslint src --ext .mjs,.js,.cjs,.ts,.tsx",
 		"format": "prettier --write . && cross-env TIMING=1 eslint src --ext .mjs,.js,.cjs,.ts,.tsx --fix"
 	},
@@ -75,19 +75,19 @@
 		"@types/react": "^18.0.21",
 		"@types/react-dom": "^18.0.6",
 		"@types/react-syntax-highlighter": "^15.5.5",
-		"@unocss/cli": "^0.45.26",
-		"@unocss/reset": "^0.45.26",
+		"@unocss/cli": "^0.45.29",
+		"@unocss/reset": "^0.45.29",
 		"@vitejs/plugin-react": "^2.1.0",
 		"@vitest/coverage-c8": "^0.24.0",
 		"concurrently": "^7.4.0",
 		"cross-env": "^7.0.3",
-		"eslint": "^8.24.0",
-		"eslint-config-neon": "^0.1.35",
+		"eslint": "^8.25.0",
+		"eslint-config-neon": "^0.1.37",
 		"happy-dom": "^7.4.0",
 		"prettier": "^2.7.1",
 		"prettier-plugin-tailwindcss": "^0.1.13",
 		"typescript": "^4.8.4",
-		"unocss": "^0.45.26",
+		"unocss": "^0.45.29",
 		"vercel": "^28.4.8",
 		"vitest": "^0.24.0"
 	},