From 617918d32d2a4551a6e2874b867e86455827466e Mon Sep 17 00:00:00 2001 From: Ean Milligan Date: Thu, 24 Jul 2025 03:22:09 -0400 Subject: [PATCH] v2.0.1 minor update to fix deno.json --- README.md | 2 +- config.example.ts | 76 ++++++++++++++++++++++++++--------------------- deno.json | 37 +++++------------------ 3 files changed, 50 insertions(+), 65 deletions(-) diff --git a/README.md b/README.md index 042470b..f8aeba1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Group Up - An Event Scheduling Discord Bot | V2.0.0 - 2024/12/24 +# Group Up - An Event Scheduling Discord Bot | V2.0.1 - 2024/12/24 [![SonarCloud](https://sonarcloud.io/images/project_badges/sonarcloud-orange.svg)](https://sonarcloud.io/summary/new_code?id=GroupUp) [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=GroupUp&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=GroupUp) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=GroupUp&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=GroupUp) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=GroupUp&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=GroupUp) [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=GroupUp&metric=bugs)](https://sonarcloud.io/summary/new_code?id=GroupUp) [![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=GroupUp&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=GroupUp) [![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=GroupUp&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=GroupUp) diff --git a/config.example.ts b/config.example.ts index 6456182..232de3b 100644 --- a/config.example.ts +++ b/config.example.ts @@ -1,41 +1,49 @@ -export const config = { // !! NOTICE !! All fields below are required unless they are explicitly noted as OPTIONAL. If a field is OPTIONAL, do not remove it from this file, just leave it at the default value - 'name': 'Group Up', // Name of the bot - 'version': '2.0.0', // Version of the bot - 'token': 'the_bot_token', // Discord API Token for this bot - 'localToken': 'local_testing_token', // Discord API Token for a secondary OPTIONAL testing bot, THIS SHOULD BE DIFFERENT FROM "token" - 'prefix': '/', // Prefix for all commands, as this bot uses slash commands, this needs to be '/' - 'db': { // Settings for the MySQL database, this is required to keep track of the currently active events. - 'host': '', // IP address for the db, usually localhost - 'localhost': '', // IP address for a secondary OPTIONAL local testing DB, usually also is localhost, but depends on your dev environment - 'port': 3306, // Port for the db - 'username': '', // Username for the account that will access your DB, this account will need "DB Manager" admin rights and "REFERENCES" Global Privileges - 'password': '', // Password for the account, user account may need to be authenticated with the "Standard" Authentication Type if this does not work out of the box - 'name': '', // Name of the database Schema to use for the bot +export const config = { + // !! NOTICE !! All fields below are required unless they are explicitly noted as OPTIONAL. If a field is OPTIONAL, do not remove it from this file, just leave it at the default value + name: 'Group Up', // Name of the bot + version: '2.0.1', // Version of the bot + token: 'the_bot_token', // Discord API Token for this bot + localToken: 'local_testing_token', // Discord API Token for a secondary OPTIONAL testing bot, THIS SHOULD BE DIFFERENT FROM "token" + prefix: '/', // Prefix for all commands, as this bot uses slash commands, this needs to be '/' + db: { + // Settings for the MySQL database, this is required to keep track of the currently active events. + host: '', // IP address for the db, usually localhost + localhost: '', // IP address for a secondary OPTIONAL local testing DB, usually also is localhost, but depends on your dev environment + port: 3306, // Port for the db + username: '', // Username for the account that will access your DB, this account will need "DB Manager" admin rights and "REFERENCES" Global Privileges + password: '', // Password for the account, user account may need to be authenticated with the "Standard" Authentication Type if this does not work out of the box + name: '', // Name of the database Schema to use for the bot }, - 'links': { // Links to various sites - 'sourceCode': 'https://github.com/Burn-E99/GroupUp', // Link to the repository, OPTIONAL - 'supportServer': '', // Invite link to the Discord support server, OPTIONAL - 'addToCalendar': '', // Link to where the icsGenerator is hosted, OPTIONAL - 'creatorIcon': '', // Link to where the GroupUpSinglePerson.png (or similar image) is hosted + links: { + // Links to various sites + sourceCode: 'https://github.com/Burn-E99/GroupUp', // Link to the repository, OPTIONAL + supportServer: '', // Invite link to the Discord support server, OPTIONAL + addToCalendar: '', // Link to where the icsGenerator is hosted, OPTIONAL + creatorIcon: '', // Link to where the GroupUpSinglePerson.png (or similar image) is hosted }, - 'defaultDateFormat': 'MONTH/DAY/YEAR', // Default format that Group Up will suggest to the user. Must match one of the options in the 'DateTimeFormats' enum inside 'src/buttons/event-creation/dateTimeUtils.ts' - 'logChannel': 0n, // Discord channel ID where the bot should put startup messages and other error messages needed. This value is a bigint, so please ensure you have a `n` after the ID you get from Discord. OPTIONAL - 'reportChannel': 0n, // Discord channel ID where reports will be sent when using the built-in report command. This value is a bigint, so please ensure you have a `n` after the ID you get from Discord. OPTIONAL - 'devServer': 0n, // Discord guild ID where testing of indev features/commands will be handled, used in conjunction with the DEVMODE bool in mod.ts. This value is a bigint, so please ensure you have a `n` after the ID you get from Discord. OPTIONAL - 'owner': 0n, // Discord user ID of the bot admin. This value is a bigint, so please ensure you have a `n` after the ID you get from Discord. - 'botLists': [ // Array of objects containing all bot lists that stats should be posted to, OPTIONAL - { // Bot List object, duplicate for each bot list - 'name': 'Bot List Name', // Name of bot list, not used - 'enabled': false, // Should statistics be posted to this list? - 'apiUrl': 'https://example.com/api/bots/?{bot_id}/stats', // API URL, use ?{bot_id} in place of the bot id so that it can be dynamically replaced - 'headers': [ // Array of headers that need to be added to the request - { // Header Object, duplicate for every header needed - 'header': 'header_name', // Name of header needed, usually Authorization is needed - 'value': 'header_value', // Value for the header + defaultDateFormat: 'MONTH/DAY/YEAR', // Default format that Group Up will suggest to the user. Must match one of the options in the 'DateTimeFormats' enum inside 'src/buttons/event-creation/dateTimeUtils.ts' + logChannel: 0n, // Discord channel ID where the bot should put startup messages and other error messages needed. This value is a bigint, so please ensure you have a `n` after the ID you get from Discord. OPTIONAL + reportChannel: 0n, // Discord channel ID where reports will be sent when using the built-in report command. This value is a bigint, so please ensure you have a `n` after the ID you get from Discord. OPTIONAL + devServer: 0n, // Discord guild ID where testing of indev features/commands will be handled, used in conjunction with the DEVMODE bool in mod.ts. This value is a bigint, so please ensure you have a `n` after the ID you get from Discord. OPTIONAL + owner: 0n, // Discord user ID of the bot admin. This value is a bigint, so please ensure you have a `n` after the ID you get from Discord. + botLists: [ + // Array of objects containing all bot lists that stats should be posted to, OPTIONAL + { + // Bot List object, duplicate for each bot list + name: 'Bot List Name', // Name of bot list, not used + enabled: false, // Should statistics be posted to this list? + apiUrl: 'https://example.com/api/bots/?{bot_id}/stats', // API URL, use ?{bot_id} in place of the bot id so that it can be dynamically replaced + headers: [ + // Array of headers that need to be added to the request + { + // Header Object, duplicate for every header needed + header: 'header_name', // Name of header needed, usually Authorization is needed + value: 'header_value', // Value for the header }, ], - 'body': { // Data payload to send to the bot list, will be turned into a string and any ?{} will be replaced with the required value, currently only has ?{server_count} - 'param_name': '?{param_value}', // Add more params as needed + body: { + // Data payload to send to the bot list, will be turned into a string and any ?{} will be replaced with the required value, currently only has ?{server_count} + param_name: '?{param_value}', // Add more params as needed }, }, ], diff --git a/deno.json b/deno.json index ce9e5f1..ecb8a72 100644 --- a/deno.json +++ b/deno.json @@ -1,42 +1,19 @@ { "compilerOptions": { - "allowJs": true, - "lib": [ - "deno.window" - ], + "lib": ["deno.window"], "strict": true }, "lint": { - "files": { - "include": [ - "src/", - "db/", - "mod.ts", - "deps.ts", - "config.ts", - "config.example.ts" - ], - "exclude": [] - }, + "include": ["src/", "db/", "mod.ts", "deps.ts", "config.ts", "config.example.ts"], + "exclude": [], "rules": { - "tags": [ - "recommended" - ], - "include": [ - "ban-untagged-todo" - ], + "tags": ["recommended"], + "include": ["ban-untagged-todo"], "exclude": [] } }, "fmt": { - "include": [ - "src/", - "db/", - "mod.ts", - "deps.ts", - "config.ts", - "config.example.ts" - ], + "include": ["src/", "db/", "mod.ts", "deps.ts", "config.ts", "config.example.ts"], "exclude": [], "useTabs": true, "lineWidth": 200, @@ -44,4 +21,4 @@ "singleQuote": true, "proseWrap": "preserve" } -} \ No newline at end of file +}