feat: add code for bun example

favna · favna · commit bff1d50a7307 · 2024-08-19T22:08:45.000+02:00
diff --git a/.env b/.env
@@ -0,0 +1,2 @@
+# Discord token for the bot application
+DISCORD_TOKEN=
diff --git a/.eslintrc b/.eslintrc
@@ -0,0 +1,3 @@
+{
+	"extends": "@sapphire"
+}
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1 @@
+* @favna
diff --git a/.github/renovate.json b/.github/renovate.json
@@ -0,0 +1,4 @@
+{
+	"$schema": "https://docs.renovatebot.com/renovate-schema.json",
+	"enabled": false
+}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,16 @@
+# Ignore a blackhole and the folder for development
+node_modules/
+.vs/
+.idea/
+*.iml
+
+# Environment variables
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# Ignore heapsnapshot and log files
+*.heapsnapshot
+*.log
diff --git a/.prettierrc.mjs b/.prettierrc.mjs
@@ -0,0 +1,18 @@
+import sapphirePrettierConfig from '@sapphire/prettier-config';
+
+/** @type {import('prettier').Config} */
+export default {
+	...sapphirePrettierConfig,
+	overrides: [
+		...sapphirePrettierConfig.overrides,
+		{
+			files: ['README.md'],
+			options: {
+				tabWidth: 2,
+				useTabs: false,
+				printWidth: 120,
+				proseWrap: 'always'
+			}
+		}
+	]
+};
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,24 @@
+# The MIT License (MIT)
+
+Copyright © `2024` `The Sapphire Community and its contributors`
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the “Software”), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,4 @@
+# Sapphire Bun example
+
+This repository is a simple example of a Sapphire Framework project using Bun as package manager and runtime for both
+development and production.
diff --git a/bun.lockb b/bun.lockb
diff --git a/package.json b/package.json
@@ -0,0 +1,35 @@
+{
+	"name": "@sapphire/bun-template",
+	"version": "1.0.0",
+	"description": "An example of how to setup a Sapphire project with bun",
+	"private": true,
+	"main": "src/main.ts",
+	"type": "module",
+	"scripts": {
+		"lint": "eslint --fix --ext ts src",
+		"format": "prettier --write .",
+		"start": "bun run ."
+	},
+	"dependencies": {
+		"@sapphire/decorators": "^6.1.0",
+		"@sapphire/eslint-config": "^5.0.5",
+		"@sapphire/framework": "^5.2.1",
+		"@sapphire/plugin-logger": "^4.0.2",
+		"@skyra/env-utilities": "^1.3.0",
+		"@skyra/start-banner": "^2.0.1",
+		"colorette": "^2.0.20",
+		"discord.js": "^14.15.3",
+		"eslint": "^8.57.0",
+		"figlet": "^1.7.0",
+		"gradient-string": "^2.0.2"
+	},
+	"devDependencies": {
+		"@sapphire/prettier-config": "^2.0.0",
+		"@sapphire/ts-config": "^5.0.1",
+		"@types/figlet": "^1.5.8",
+		"@types/gradient-string": "^1.1.6",
+		"@types/node": "^20.16.1",
+		"prettier": "^3.3.3",
+		"typescript": "^5.5.4"
+	}
+}
diff --git a/src/commands/ping.ts b/src/commands/ping.ts
@@ -0,0 +1,26 @@
+import { ApplyOptions } from '@sapphire/decorators';
+import { Command } from '@sapphire/framework';
+
+@ApplyOptions<Command.Options>({
+	description: 'ping pong'
+})
+export class UserCommand extends Command {
+	public override registerApplicationCommands(registry: Command.Registry) {
+		registry.registerChatInputCommand({
+			name: this.name,
+			description: this.description
+		});
+	}
+
+	public override async chatInputRun(interaction: Command.ChatInputCommandInteraction) {
+		const pingMessage = await interaction.reply({ content: 'Ping?', fetchReply: true });
+
+		const content = `Pong! Bot Latency ${Math.round(this.container.client.ws.ping)}ms. API Latency ${
+			pingMessage.createdTimestamp - interaction.createdTimestamp
+		}ms.`;
+
+		return interaction.editReply({
+			content
+		});
+	}
+}
diff --git a/src/lib/setup.ts b/src/lib/setup.ts
@@ -0,0 +1,21 @@
+import '@sapphire/plugin-logger/register';
+
+// Unless explicitly defined, set NODE_ENV as development:
+process.env.NODE_ENV ??= 'development';
+
+import { ApplicationCommandRegistries, RegisterBehavior } from '@sapphire/framework';
+import { setup } from '@skyra/env-utilities';
+import * as colorette from 'colorette';
+
+colorette.createColors({ useColor: true });
+
+setup();
+
+ApplicationCommandRegistries.setDefaultBehaviorWhenNotIdentical(RegisterBehavior.BulkOverwrite);
+
+declare module '@skyra/env-utilities' {
+	// Add your environment variables here
+	interface Env {
+		DISCORD_TOKEN: string;
+	}
+}
diff --git a/src/listeners/ready.ts b/src/listeners/ready.ts
@@ -0,0 +1,52 @@
+import { ApplyOptions } from '@sapphire/decorators';
+import { Events, Listener, type Store } from '@sapphire/framework';
+import { envParseString } from '@skyra/env-utilities';
+import { createBanner } from '@skyra/start-banner';
+import { blue, gray, green, magenta, magentaBright, white, yellow } from 'colorette';
+import figlet from 'figlet';
+import gradient from 'gradient-string';
+
+@ApplyOptions<Listener.Options>({ once: true })
+export class UserListener extends Listener<typeof Events.ClientReady> {
+	private readonly style = this.isDev ? yellow : blue;
+
+	public run() {
+		this.printBanner();
+		this.printStoreDebugInformation();
+	}
+
+	private get isDev() {
+		return envParseString('NODE_ENV') === 'development';
+	}
+
+	private printBanner() {
+		const success = green('+');
+
+		const llc = this.isDev ? magentaBright : white;
+		const blc = this.isDev ? magenta : blue;
+
+		console.log(
+			createBanner({
+				name: [gradient.retro.multiline(figlet.textSync('Bun Example'))],
+				extra: [
+					//
+					`[${success}] Gateway`,
+					this.isDev ? ` ${blc('<')}${llc('/')}${blc('>')} ${llc('DEVELOPMENT MODE')}` : ''
+				]
+			})
+		);
+	}
+
+	private printStoreDebugInformation() {
+		const { client } = this.container;
+		const stores = [...client.stores.values()];
+		const last = stores.pop()!;
+
+		for (const store of stores) console.log(this.styleStore(store, false));
+		console.log(this.styleStore(last, true));
+	}
+
+	private styleStore(store: Store<any>, last: boolean) {
+		return gray(`${last ? '└─' : '├─'} Loaded ${this.style(store.size.toString().padEnd(3, ' '))} ${store.name}.`);
+	}
+}
diff --git a/src/main.ts b/src/main.ts
@@ -0,0 +1,10 @@
+import './lib/setup.js';
+
+import { SapphireClient } from '@sapphire/framework';
+import { GatewayIntentBits } from 'discord.js';
+
+const client = new SapphireClient({
+	intents: [GatewayIntentBits.Guilds]
+});
+
+await client.login();
diff --git a/tsconfig.eslint.json b/tsconfig.eslint.json
@@ -0,0 +1,3 @@
+{
+	"extends": "./tsconfig.json"
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,8 @@
+{
+	"extends": ["@sapphire/ts-config", "@sapphire/ts-config/extra-strict", "@sapphire/ts-config/decorators", "@sapphire/ts-config/verbatim"],
+	"compilerOptions": {
+		"rootDir": "./src",
+		"noEmit": true
+	},
+	"include": ["src"]
+}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# Discord token for the bot application`
	`2`	`+DISCORD_TOKEN=`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "extends": "@sapphire"`
	`3`	`+}`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +	"$schema": "https://docs.renovatebot.com/renovate-schema.json",
 +	"enabled": false
 +}