From 24654f7f6ad9e023f24e2eea16e8c3d11ec4affb Mon Sep 17 00:00:00 2001 From: gc Date: Sun, 12 Jan 2020 10:19:06 +1100 Subject: [PATCH] easier error logging, fix happy/sad emojis --- licenses/skyra.txt | 201 +++++++++++++++++++++++++++++++++++ src/commands/Utility/bank.ts | 3 +- src/commands/Utility/cash.ts | 46 ++++---- src/events/commandError.ts | 57 ++++++++++ src/lib/constants.ts | 7 +- src/lib/util.ts | 7 +- 6 files changed, 293 insertions(+), 28 deletions(-) create mode 100644 licenses/skyra.txt create mode 100644 src/events/commandError.ts diff --git a/licenses/skyra.txt b/licenses/skyra.txt new file mode 100644 index 0000000000..5287ea7093 --- /dev/null +++ b/licenses/skyra.txt @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2019 Antonio RomΓ‘n + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/src/commands/Utility/bank.ts b/src/commands/Utility/bank.ts index 6b58354072..fa27435392 100644 --- a/src/commands/Utility/bank.ts +++ b/src/commands/Utility/bank.ts @@ -5,6 +5,7 @@ import * as fs from 'fs'; import { generateHexColorForCashStack, formatItemStackQuantity, chunkObject } from '../../lib/util'; import { Bank } from '../../lib/types'; +import { Emoji } from '../../lib/constants'; const bg = fs.readFileSync('./resources/images/coins.png'); const canvas = createCanvas(50, 50); @@ -63,7 +64,7 @@ export default class extends Command { const hasItemsInBank = bankKeys.length > 0; if (coins === 0 && !hasItemsInBank) { - throw `You have no GP yet <:Sad:421822898316115969> You can get some GP by using the ${msg.cmdPrefix}daily command.`; + throw `You have no GP yet ${Emoji.Sad} You can get some GP by using the ${msg.cmdPrefix}daily command.`; } if (!hasItemsInBank) return msg.send(this.generateImage(coins)); diff --git a/src/commands/Utility/cash.ts b/src/commands/Utility/cash.ts index cf36c6fcc6..40a95b46f2 100644 --- a/src/commands/Utility/cash.ts +++ b/src/commands/Utility/cash.ts @@ -4,27 +4,27 @@ import { BotCommand } from '../../lib/BotCommand'; import { Emoji } from '../../lib/constants'; export default class extends BotCommand { - public constructor( - client: KlasaClient, - store: CommandStore, - file: string[], - directory: string - ) { - super(client, store, file, directory, { - cooldown: 3, - aliases: ['bal', 'gp'], - description: 'Shows how much virtual GP you own.' - }); - } + public constructor( + client: KlasaClient, + store: CommandStore, + file: string[], + directory: string + ) { + super(client, store, file, directory, { + cooldown: 3, + aliases: ['bal', 'gp'], + description: 'Shows how much virtual GP you own.' + }); + } - async run(msg: KlasaMessage) { - await msg.author.settings.sync(true); - const coins: number = msg.author.settings.get('GP'); - - if (coins === 0) { - throw `You have no GP yet <:Sad:421822898316115969> You can get some GP by using the ${msg.cmdPrefix}daily command.`; - } - - return msg.channel.send(`${Emoji.MoneyBag} You have ${coins.toLocaleString()} GP!`); - } -} \ No newline at end of file + async run(msg: KlasaMessage) { + await msg.author.settings.sync(true); + const coins: number = msg.author.settings.get('GP'); + + if (coins === 0) { + throw `You have no GP yet ${Emoji.Sad} You can get some GP by using the ${msg.cmdPrefix}daily command.`; + } + + return msg.channel.send(`${Emoji.MoneyBag} You have ${coins.toLocaleString()} GP!`); + } +} diff --git a/src/events/commandError.ts b/src/events/commandError.ts new file mode 100644 index 0000000000..042c31a236 --- /dev/null +++ b/src/events/commandError.ts @@ -0,0 +1,57 @@ +import { KlasaMessage, Command, Event, util } from 'klasa'; +import { DiscordAPIError, HTTPError, MessageEmbed, TextChannel } from 'discord.js'; + +import { rootFolder, Channel } from '../lib/constants'; +import { inlineCodeblock } from '../lib/util'; + +export default class extends Event { + public async run(msg: KlasaMessage, command: Command, _: string[], error: string | Error) { + if (command.oneAtTime && this.client.oneCommandAtATimeCache.has(msg.author.id)) { + this.client.oneCommandAtATimeCache.delete(msg.author.id); + } + + if (typeof error === 'string') { + return msg.send(error); + } + + await this._sendErrorChannel(msg, command, error); + } + + private async _sendErrorChannel(message: KlasaMessage, command: Command, error: Error) { + this.client.emit('wtf', `[COMMAND] ${command.path}\n${error.stack || error}`); + let output: string; + if (error instanceof DiscordAPIError || error instanceof HTTPError) { + output = [ + `${inlineCodeblock('Command ::')} ${command.path.slice(rootFolder.length)}`, + `${inlineCodeblock('Path ::')} ${error.path}`, + `${inlineCodeblock('Code ::')} ${error.code}`, + `${inlineCodeblock('Arguments ::')} ${ + message.params.length ? `[\`${message.params.join('`, `')}\`]` : 'Not Supplied' + }`, + `${inlineCodeblock('Error ::')} ${util.codeBlock('js', error.stack || error)}` + ].join('\n'); + } else { + output = [ + `${inlineCodeblock('Command ::')} ${command.path.slice(rootFolder.length)}`, + `${inlineCodeblock('Arguments ::')} ${ + message.params.length ? `[\`${message.params.join('`, `')}\`]` : 'Not Supplied' + }`, + `${inlineCodeblock('Error ::')} ${util.codeBlock('js', error.stack || error)}` + ].join('\n'); + } + + const channel = this.client.channels.get(Channel.ErrorLogs); + + (channel as TextChannel).send( + new MessageEmbed() + .setDescription(output) + .setColor(0xfc1020) + .setAuthor( + message.author.tag, + message.author.displayAvatarURL({ size: 64 }), + message.url + ) + .setTimestamp() + ); + } +} diff --git a/src/lib/constants.ts b/src/lib/constants.ts index 18ffe2438c..9b00ab18fb 100644 --- a/src/lib/constants.ts +++ b/src/lib/constants.ts @@ -12,7 +12,8 @@ export const enum Time { } export const enum Channel { - Notifications = '469523207691436042' + Notifications = '469523207691436042', + ErrorLogs = '665678499578904596' } export const enum Emoji { @@ -27,7 +28,9 @@ export const enum Emoji { Tick = 'βœ…', Search = 'πŸ”Ž', FancyLoveheart = 'πŸ’', - Gift = '🎁' + Gift = '🎁', + Sad = '<:RSSad:380915244652036097>', + Happy = '<:RSHappy:380915244760825857>' } export const enum Image { diff --git a/src/lib/util.ts b/src/lib/util.ts index 1eaf12998d..824fb07a33 100644 --- a/src/lib/util.ts +++ b/src/lib/util.ts @@ -86,8 +86,7 @@ export function addArrayOfItemsToBank(bank: Bank, items: number[]) { return newBank; } -// TODO should this use a generic? -export function randomItemFromArray(array: unknown[]) { +export function randomItemFromArray(array: T[]): T { return array[Math.floor(Math.random() * array.length)]; } @@ -149,3 +148,7 @@ export function getMinionName(user: KlasaUser) { ? `${Emoji.Minion} **${Util.escapeMarkdown(name)}**` : `${Emoji.Minion} Your minion`; } + +export function inlineCodeblock(input: string) { + return `\`${input.replace(/ /g, '\u00A0').replace(/`/g, '`\u200B')}\``; +}