From 6fb7c5f837de4b7ac6fef4ae3a90d1e96f5428a6 Mon Sep 17 00:00:00 2001 From: creations Date: Sun, 9 Feb 2025 13:36:51 -0500 Subject: [PATCH] first commit --- .editorconfig | 12 +++ .env.example | 6 ++ .gitattributes | 1 + .gitignore | 178 +++++++++++++++++++++++++++++++++ README.md | 1 + config/environment.ts | 12 +++ eslint.config.js | 79 +++++++++++++++ package.json | 31 ++++++ src/commands/ping.ts | 20 ++++ src/helpers/char.ts | 6 ++ src/helpers/logger.ts | 226 ++++++++++++++++++++++++++++++++++++++++++ src/index.ts | 137 +++++++++++++++++++++++++ tsconfig.json | 51 ++++++++++ types/config.d.ts | 10 ++ types/logger.d.ts | 9 ++ types/oceanic.d.ts | 13 +++ 16 files changed, 792 insertions(+) create mode 100644 .editorconfig create mode 100644 .env.example create mode 100644 .gitattributes create mode 100644 .gitignore create mode 100644 README.md create mode 100644 config/environment.ts create mode 100644 eslint.config.js create mode 100644 package.json create mode 100644 src/commands/ping.ts create mode 100644 src/helpers/char.ts create mode 100644 src/helpers/logger.ts create mode 100644 src/index.ts create mode 100644 tsconfig.json create mode 100644 types/config.d.ts create mode 100644 types/logger.d.ts create mode 100644 types/oceanic.d.ts diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..980ef21 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,12 @@ +# EditorConfig is awesome: https://EditorConfig.org + +# top-most EditorConfig file +root = true + +[*] +indent_style = tab +indent_size = 4 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..473051d --- /dev/null +++ b/.env.example @@ -0,0 +1,6 @@ +HOST= 0.0.0.0 +PORT= 6679 +#NODE_ENV= development + +DISCORD_TOKEN= YOUR_DISCORD_BOT_TOKEN +DISCORD_PREFIX= YOUR_DISCORD_BOT_PREFIX diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..6313b56 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +* text=auto eol=lf diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9a30138 --- /dev/null +++ b/.gitignore @@ -0,0 +1,178 @@ +# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore + +# Logs + +logs +_.log +npm-debug.log_ +yarn-debug.log* +yarn-error.log* +lerna-debug.log* +.pnpm-debug.log* +bun.lock + +# Caches + +.cache + +# Diagnostic reports (https://nodejs.org/api/report.html) + +report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json + +# Runtime data + +pids +_.pid +_.seed +*.pid.lock + +# Directory for instrumented libs generated by jscoverage/JSCover + +lib-cov + +# Coverage directory used by tools like istanbul + +coverage +*.lcov + +# nyc test coverage + +.nyc_output + +# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) + +.grunt + +# Bower dependency directory (https://bower.io/) + +bower_components + +# node-waf configuration + +.lock-wscript + +# Compiled binary addons (https://nodejs.org/api/addons.html) + +build/Release + +# Dependency directories + +node_modules/ +jspm_packages/ + +# Snowpack dependency directory (https://snowpack.dev/) + +web_modules/ + +# TypeScript cache + +*.tsbuildinfo + +# Optional npm cache directory + +.npm + +# Optional eslint cache + +.eslintcache + +# Optional stylelint cache + +.stylelintcache + +# Microbundle cache + +.rpt2_cache/ +.rts2_cache_cjs/ +.rts2_cache_es/ +.rts2_cache_umd/ + +# Optional REPL history + +.node_repl_history + +# Output of 'npm pack' + +*.tgz + +# Yarn Integrity file + +.yarn-integrity + +# dotenv environment variable files + +.env +.env.development.local +.env.test.local +.env.production.local +.env.local + +# parcel-bundler cache (https://parceljs.org/) + +.parcel-cache + +# Next.js build output + +.next +out + +# Nuxt.js build / generate output + +.nuxt +dist + +# Gatsby files + +# Comment in the public line in if your project uses Gatsby and not Next.js + +# https://nextjs.org/blog/next-9-1#public-directory-support + +# public + +# vuepress build output + +.vuepress/dist + +# vuepress v2.x temp and cache directory + +.temp + +# Docusaurus cache and generated files + +.docusaurus + +# Serverless directories + +.serverless/ + +# FuseBox cache + +.fusebox/ + +# DynamoDB Local files + +.dynamodb/ + +# TernJS port file + +.tern-port + +# Stores VSCode versions used for testing VSCode extensions + +.vscode-test + +# yarn v2 + +.yarn/cache +.yarn/unplugged +.yarn/build-state.yml +.yarn/install-state.gz +.pnp.* + +# IntelliJ based IDEs +.idea + +# Finder (MacOS) folder config +.DS_Store +/config/database +/config/secrets.ts diff --git a/README.md b/README.md new file mode 100644 index 0000000..78fbb66 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +# atums.world Discord bot \ No newline at end of file diff --git a/config/environment.ts b/config/environment.ts new file mode 100644 index 0000000..d4910d5 --- /dev/null +++ b/config/environment.ts @@ -0,0 +1,12 @@ +export const environment: Environment = { + port: parseInt(process.env.PORT || "3000"), + host: process.env.HOST || "localhost", + development: + process.argv.includes("--dev") || + process.argv.includes("--development"), +}; + +export const discord: Discord = { + token: process.env.DISCORD_TOKEN || "", + prefix: process.env.DISCORD_PREFIX || "!", +}; diff --git a/eslint.config.js b/eslint.config.js new file mode 100644 index 0000000..f221a76 --- /dev/null +++ b/eslint.config.js @@ -0,0 +1,79 @@ +import tseslintPlugin from "@typescript-eslint/eslint-plugin"; +import tsParser from "@typescript-eslint/parser"; +import prettier from "eslint-plugin-prettier"; +import promisePlugin from "eslint-plugin-promise"; +import simpleImportSort from "eslint-plugin-simple-import-sort"; +import unicorn from "eslint-plugin-unicorn"; +import unusedImports from "eslint-plugin-unused-imports"; +import globals from "globals"; + +/** @type {import('eslint').Linter.FlatConfig[]} */ +export default [ + { + files: ["**/*.{ts,tsx}"], + languageOptions: { + parser: tsParser, + globals: globals.node, + }, + plugins: { + "@typescript-eslint": tseslintPlugin, + "simple-import-sort": simpleImportSort, + "unused-imports": unusedImports, + promise: promisePlugin, + prettier: prettier, + unicorn: unicorn, + }, + rules: { + ...tseslintPlugin.configs.recommended.rules, + quotes: ["error", "double"], + "eol-last": ["error", "always"], + "no-multiple-empty-lines": ["error", { max: 1, maxEOF: 1 }], + "no-mixed-spaces-and-tabs": ["error", "smart-tabs"], + "simple-import-sort/imports": "error", + "simple-import-sort/exports": "error", + "unused-imports/no-unused-imports": "error", + "unused-imports/no-unused-vars": [ + "warn", + { + vars: "all", + varsIgnorePattern: "^_", + args: "after-used", + argsIgnorePattern: "^_", + }, + ], + "promise/always-return": "error", + "promise/no-return-wrap": "error", + "promise/param-names": "error", + "promise/catch-or-return": "error", + "promise/no-nesting": "warn", + "promise/no-promise-in-callback": "warn", + "promise/no-callback-in-promise": "warn", + "prettier/prettier": [ + "error", + { + useTabs: true, + tabWidth: 4, + }, + ], + indent: ["error", "tab", { SwitchCase: 1 }], + "unicorn/filename-case": [ + "error", + { + case: "camelCase", + }, + ], + "@typescript-eslint/explicit-function-return-type": ["error"], + "@typescript-eslint/explicit-module-boundary-types": ["error"], + "@typescript-eslint/typedef": [ + "error", + { + arrowParameter: true, + variableDeclaration: true, + propertyDeclaration: true, + memberVariableDeclaration: true, + parameter: true, + }, + ], + }, + }, +]; diff --git a/package.json b/package.json new file mode 100644 index 0000000..727a1da --- /dev/null +++ b/package.json @@ -0,0 +1,31 @@ +{ + "name": "discord-bot", + "module": "src/index.ts", + "devDependencies": { + "@types/bun": "^1.2.2", + "@typescript-eslint/eslint-plugin": "^8.23.0", + "@typescript-eslint/parser": "^8.23.0", + "eslint": "^9.20.0", + "eslint-plugin-prettier": "^5.2.3", + "eslint-plugin-promise": "^7.2.1", + "eslint-plugin-simple-import-sort": "^12.1.1", + "eslint-plugin-unicorn": "^56.0.1", + "eslint-plugin-unused-imports": "^4.1.4", + "globals": "^15.14.0", + "prettier": "^3.5.0" + }, + "peerDependencies": { + "typescript": "^5.7.3" + }, + "scripts": { + "start": "bun run src/index.ts", + "dev": "bun run --watch src/index.ts --dev", + "lint": "eslint", + "lint:fix": "bun lint --fix", + "cleanup": "rm -rf logs node_modules bun.lock" + }, + "type": "module", + "dependencies": { + "oceanic.js": "^1.11.2" + } +} diff --git a/src/commands/ping.ts b/src/commands/ping.ts new file mode 100644 index 0000000..8f80952 --- /dev/null +++ b/src/commands/ping.ts @@ -0,0 +1,20 @@ +import { CommandInteraction, Message } from "oceanic.js"; + +export const interaction: ( + interaction: CommandInteraction, +) => Promise = async (interaction: CommandInteraction): Promise => { + await interaction.reply({ content: "Pong!" }); +}; + +export const legacy: (message: Message) => Promise = async ( + message: Message, +): Promise => { + if (!message.channel) return; + + await message.channel.createMessage({ content: "Pong!" }); +}; + +export default { + name: "ping", + description: "Replies with Pong!", +}; diff --git a/src/helpers/char.ts b/src/helpers/char.ts new file mode 100644 index 0000000..6ecab40 --- /dev/null +++ b/src/helpers/char.ts @@ -0,0 +1,6 @@ +export function timestampToReadable(timestamp?: number): string { + const date: Date = + timestamp && !isNaN(timestamp) ? new Date(timestamp) : new Date(); + if (isNaN(date.getTime())) return "Invalid Date"; + return date.toISOString().replace("T", " ").replace("Z", ""); +} diff --git a/src/helpers/logger.ts b/src/helpers/logger.ts new file mode 100644 index 0000000..53e739d --- /dev/null +++ b/src/helpers/logger.ts @@ -0,0 +1,226 @@ +import type { Stats } from "fs"; +import { + createWriteStream, + existsSync, + mkdirSync, + statSync, + WriteStream, +} from "fs"; +import { EOL } from "os"; +import { basename, join, resolve } from "path"; + +import { timestampToReadable } from "./char"; + +class Logger { + private static instance: Logger; + private static log: string = resolve("logs"); + + public static getInstance(): Logger { + if (!Logger.instance) { + Logger.instance = new Logger(); + } + + return Logger.instance; + } + + private writeToLog(logMessage: string): void { + const date: Date = new Date(); + const logDir: string = Logger.log; + const logFile: string = join( + logDir, + `${date.getFullYear()}-${date.getMonth() + 1}-${date.getDate()}.log`, + ); + + if (!existsSync(logDir)) { + mkdirSync(logDir, { recursive: true }); + } + + let addSeparator: boolean = false; + + if (existsSync(logFile)) { + const fileStats: Stats = statSync(logFile); + if (fileStats.size > 0) { + const lastModified: Date = new Date(fileStats.mtime); + if ( + lastModified.getFullYear() === date.getFullYear() && + lastModified.getMonth() === date.getMonth() && + lastModified.getDate() === date.getDate() && + lastModified.getHours() !== date.getHours() + ) { + addSeparator = true; + } + } + } + + const stream: WriteStream = createWriteStream(logFile, { flags: "a" }); + + if (addSeparator) { + stream.write(`${EOL}${date.toISOString()}${EOL}`); + } + + stream.write(`${logMessage}${EOL}`); + stream.close(); + } + + private extractFileName(stack: string): string { + const stackLines: string[] = stack.split("\n"); + let callerFile: string = ""; + + for (let i: number = 2; i < stackLines.length; i++) { + const line: string = stackLines[i].trim(); + if (line && !line.includes("Logger.") && line.includes("(")) { + callerFile = line.split("(")[1]?.split(")")[0] || ""; + break; + } + } + + return basename(callerFile); + } + + private getCallerInfo(stack: unknown): { + filename: string; + timestamp: string; + } { + const filename: string = + typeof stack === "string" ? this.extractFileName(stack) : "unknown"; + + const readableTimestamp: string = timestampToReadable(); + + return { filename, timestamp: readableTimestamp }; + } + + public debug( + message: string | string[] | Error | Error[] | ErrorEvent, + breakLine: boolean = false, + ): void { + const stack: string = new Error().stack || ""; + const { filename, timestamp } = this.getCallerInfo(stack); + + const messages: (string | Error | ErrorEvent)[] = Array.isArray(message) + ? message + : [message]; + const joinedMessage: string = messages + .map((msg: string | Error | ErrorEvent): string => + typeof msg === "string" ? msg : msg.message, + ) + .join(" "); + + const logMessageParts: ILogMessageParts = { + readableTimestamp: { value: timestamp, color: "90" }, + level: { value: "[DEBUG]", color: "34" }, + filename: { value: `(${filename})`, color: "36" }, + message: { value: joinedMessage, color: "0" }, + }; + + this.writeToLog(`${timestamp} [ERROR] (${filename}) ${joinedMessage}`); + this.writeConsoleMessageColored(logMessageParts, breakLine); + } + + public info(message: string | string[], breakLine: boolean = false): void { + const stack: string = new Error().stack || ""; + const { filename, timestamp } = this.getCallerInfo(stack); + + const joinedMessage: string = Array.isArray(message) + ? message.join(" ") + : message; + + const logMessageParts: ILogMessageParts = { + readableTimestamp: { value: timestamp, color: "90" }, + level: { value: "[INFO]", color: "32" }, + filename: { value: `(${filename})`, color: "36" }, + message: { value: joinedMessage, color: "0" }, + }; + + this.writeToLog(`${timestamp} [INFO] (${filename}) ${joinedMessage}`); + this.writeConsoleMessageColored(logMessageParts, breakLine); + } + + public warn(message: string | string[], breakLine: boolean = false): void { + const stack: string = new Error().stack || ""; + const { filename, timestamp } = this.getCallerInfo(stack); + + const joinedMessage: string = Array.isArray(message) + ? message.join(" ") + : message; + + const logMessageParts: ILogMessageParts = { + readableTimestamp: { value: timestamp, color: "90" }, + level: { value: "[WARN]", color: "33" }, + filename: { value: `(${filename})`, color: "36" }, + message: { value: joinedMessage, color: "0" }, + }; + + this.writeToLog(`${timestamp} [WARN] (${filename}) ${joinedMessage}`); + this.writeConsoleMessageColored(logMessageParts, breakLine); + } + + public error( + message: string | string[] | Error | Error[], + breakLine: boolean = false, + ): void { + const stack: string = new Error().stack || ""; + const { filename, timestamp } = this.getCallerInfo(stack); + + const messages: (string | Error)[] = Array.isArray(message) + ? message + : [message]; + const joinedMessage: string = messages + .map((msg: string | Error): string => + typeof msg === "string" ? msg : msg.message, + ) + .join(" "); + + const logMessageParts: ILogMessageParts = { + readableTimestamp: { value: timestamp, color: "90" }, + level: { value: "[ERROR]", color: "31" }, + filename: { value: `(${filename})`, color: "36" }, + message: { value: joinedMessage, color: "0" }, + }; + + this.writeToLog(`${timestamp} [ERROR] (${filename}) ${joinedMessage}`); + this.writeConsoleMessageColored(logMessageParts, breakLine); + } + + public custom( + bracketMessage: string, + bracketMessage2: string, + message: string | string[], + color: string, + breakLine: boolean = false, + ): void { + const stack: string = new Error().stack || ""; + const { timestamp } = this.getCallerInfo(stack); + + const joinedMessage: string = Array.isArray(message) + ? message.join(" ") + : message; + + const logMessageParts: ILogMessageParts = { + readableTimestamp: { value: timestamp, color: "90" }, + level: { value: bracketMessage, color }, + filename: { value: `${bracketMessage2}`, color: "36" }, + message: { value: joinedMessage, color: "0" }, + }; + + this.writeToLog( + `${timestamp} ${bracketMessage} (${bracketMessage2}) ${joinedMessage}`, + ); + this.writeConsoleMessageColored(logMessageParts, breakLine); + } + + private writeConsoleMessageColored( + logMessageParts: ILogMessageParts, + breakLine: boolean = false, + ): void { + const logMessage: string = Object.keys(logMessageParts) + .map((key: string) => { + const part: ILogMessagePart = logMessageParts[key]; + return `\x1b[${part.color}m${part.value}\x1b[0m`; + }) + .join(" "); + console.log(logMessage + (breakLine ? EOL : "")); + } +} + +const logger: Logger = Logger.getInstance(); +export { logger }; diff --git a/src/index.ts b/src/index.ts new file mode 100644 index 0000000..2a2f03e --- /dev/null +++ b/src/index.ts @@ -0,0 +1,137 @@ +import { readdir } from "node:fs/promises"; +import { resolve } from "node:path"; + +import { discord } from "@config/environment"; +import { logger } from "@helpers/logger"; +import { + type AnyInteractionGateway, + ApplicationCommandTypes, + Client, + CommandInteraction, + Message, +} from "oceanic.js"; + +const client: Client & { commands: Map } = Object.assign( + new Client({ + auth: `Bot ${discord.token}`, + allowedMentions: { + everyone: false, + repliedUser: false, + roles: true, + users: true, + }, + defaultImageFormat: "png", + defaultImageSize: 4096, + disableCache: false, + gateway: { + intents: ["ALL"], + }, + }), + { commands: new Map() }, +); + +const loadCommands: () => Promise = async () => { + const commandsPath: string = resolve("src", "commands"); + const commandFiles: string[] = await readdir(commandsPath); + + for (const file of commandFiles) { + if (!file.endsWith(".ts")) continue; + const commandModule: Import = await import(resolve(commandsPath, file)); + + if (commandModule.default && commandModule.default.name) { + client.commands.set(commandModule.default.name, { + ...commandModule.default, + interaction: commandModule.interaction, + legacy: commandModule.legacy, + }); + + logger.info(`Loaded command: ${commandModule.default.name}`); + } else { + logger.warn(`Command file ${file} is missing a valid export.`); + } + } + + const globalCommands: Array<{ + name: string; + description: string; + options: []; + type: ApplicationCommandTypes; + }> = Array.from(client.commands.values()).map((cmd: Command) => ({ + name: cmd.name, + description: cmd.description, + options: cmd.options || [], + type: ApplicationCommandTypes.CHAT_INPUT, + })); + + await client.application.bulkEditGlobalCommands(globalCommands); +}; + +client.on("ready", async (): Promise => { + logger.info(`Ready as ${client.user.tag}`, true); + logger.info("Loading client.commands..."); + await loadCommands(); +}); + +client.on( + "interactionCreate", + async (interaction: AnyInteractionGateway): Promise => { + if (interaction instanceof CommandInteraction) { + const command: Command | undefined = client.commands.get( + interaction.data.name, + ); + if (command && command.interaction) { + try { + await command.interaction(interaction); + } catch (error) { + logger.error( + `Error executing interaction command ${interaction.data.name}:`, + ); + logger.error(error as Error); + await interaction.createMessage({ + content: "There was an error executing that command.", + }); + } + } else { + logger.warn( + `No interaction handler found for ${interaction.data.name}`, + ); + } + } + }, +); + +client.on("messageCreate", async (message: Message) => { + if (message.author.bot || !message.content.startsWith(discord.prefix)) + return; + + const args: string[] = message.content + .slice(discord.prefix.length) + .trim() + .split(/\s+/); + const commandName: string | undefined = args.shift()?.toLowerCase(); + if (!commandName) return; + + const command: Command | undefined = client.commands.get(commandName); + if (command && command.legacy) { + try { + await command.legacy(message); + } catch (error) { + logger.error(`Error executing legacy command ${commandName}:`); + logger.error(error as Error); + + if (message.channel) + await message.channel.createMessage({ + content: "There was an error executing this command.", + }); + } + } else { + logger.warn(`No legacy handler found for ${commandName}`); + } +}); + +client.on("error", (err: string | Error) => { + logger.error("Client error:"); + logger.error(err); +}); + +client.connect(); diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..ac5f2c7 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,51 @@ +{ + "compilerOptions": { + "baseUrl": "./", + "paths": { + "@/*": [ + "src/*" + ], + "@config/*": [ + "config/*" + ], + "@types/*": [ + "types/*" + ], + "@helpers/*": [ + "src/helpers/*" + ] + }, + "typeRoots": [ + "./src/types", + "./node_modules/@types" + ], + // Enable latest features + "lib": [ + "ESNext", + "DOM" + ], + "target": "ESNext", + "module": "ESNext", + "moduleDetection": "force", + "jsx": "react-jsx", + "allowJs": true, + // Bundler mode + "moduleResolution": "bundler", + "allowImportingTsExtensions": true, + "verbatimModuleSyntax": true, + "noEmit": true, + // Best practices + "strict": true, + "skipLibCheck": true, + "noFallthroughCasesInSwitch": true, + // Some stricter flags (disabled by default) + "noUnusedLocals": false, + "noUnusedParameters": false, + "noPropertyAccessFromIndexSignature": false, + }, + "include": [ + "src", + "types", + "config" + ], +} diff --git a/types/config.d.ts b/types/config.d.ts new file mode 100644 index 0000000..b89945e --- /dev/null +++ b/types/config.d.ts @@ -0,0 +1,10 @@ +type Environment = { + port: number; + host: string; + development: boolean; +}; + +type Discord = { + token: string; + prefix: string; +}; diff --git a/types/logger.d.ts b/types/logger.d.ts new file mode 100644 index 0000000..ff6a601 --- /dev/null +++ b/types/logger.d.ts @@ -0,0 +1,9 @@ +type ILogMessagePart = { value: string; color: string }; + +type ILogMessageParts = { + level: ILogMessagePart; + filename: ILogMessagePart; + readableTimestamp: ILogMessagePart; + message: ILogMessagePart; + [key: string]: ILogMessagePart; +}; diff --git a/types/oceanic.d.ts b/types/oceanic.d.ts new file mode 100644 index 0000000..2e385eb --- /dev/null +++ b/types/oceanic.d.ts @@ -0,0 +1,13 @@ +type Command = { + name: string; + options?: []; + description: string; + interaction?: (interaction: CommandInteraction) => Promise; + legacy?: (message: Message) => Promise; +}; + +type Import = { + default: Omit; + interaction?: (interaction: CommandInteraction) => Promise; + legacy?: (message: Message) => Promise; +};