Add footer to comment/ban content

Closes #5

Author: FoxxMD

src/Action/BanAction.ts

@@ -3,6 +3,7 @@ import Action from "./index";
 import Snoowrap, {Comment, Submission} from "snoowrap";
 import {RuleResult} from "../Rule";
 import {renderContent} from "../Utils/SnoowrapUtils";
+import {generateFooter} from "../util";
 
 export class BanAction extends Action {
 
@@ -32,6 +33,9 @@ export class BanAction extends Action {
     async process(item: Comment | Submission, ruleResults: RuleResult[]): Promise<void> {
         const content = this.message === undefined ? undefined : await this.resources.getContent(this.message, item.subreddit);
         const renderedContent = content === undefined ? undefined : await renderContent(content, item, ruleResults);
+
+        const footer = await generateFooter(item);
+
         let banPieces = [];
         banPieces.push(`Message: ${renderedContent === undefined ? 'None' : `${renderedContent.length > 100 ? `\r\n${renderedContent}` : renderedContent}`}`);
         banPieces.push(`Reason:  ${this.reason || 'None'}`);
@@ -42,7 +46,7 @@ export class BanAction extends Action {
             // @ts-ignore
             await item.subreddit.banUser({
                 name: item.author.id,
-                banMessage: renderedContent,
+                banMessage: renderedContent === undefined ? undefined : `${renderedContent}${footer}`,
                 banReason: this.reason,
                 banNote: this.note,
                 duration: this.duration

src/Action/CommentAction.ts

@@ -4,6 +4,7 @@ import Submission from "snoowrap/dist/objects/Submission";
 import {renderContent} from "../Utils/SnoowrapUtils";
 import {RequiredRichContent, RichContent} from "../Common/interfaces";
 import {RuleResult} from "../Rule";
+import {generateFooter} from "../util";
 
 export class CommentAction extends Action {
     content: string;
@@ -39,8 +40,10 @@ export class CommentAction extends Action {
             return;
         }
 
+        const footer = await generateFooter(item);
+
         // @ts-ignore
-        const reply: Comment = await item.reply(renderedContent);
+        const reply: Comment = await item.reply(`${renderedContent}${footer}`);
         if (this.lock) {
             if (!this.dryRun) {
                 // snoopwrap typing issue, thinks comments can't be locked

src/util.ts

@@ -388,3 +388,11 @@ export const parseFromJsonOrYamlToObject = (content: string): [object?, Error?,
     }
     return [obj, jsonErr, yamlErr];
 }
+
+export const generateFooter = async (item: Submission | Comment) => {
+    const subName = await item.subreddit.display_name;
+    // TODO customize modmail message based on action being peformed
+    const modmailLink = `https://www.reddit.com/message/compose?to=%2Fr%2F${subName}&message=Reminder:%20If+you+are+messaging+about+a+post+removal+,+please+include+the%20post%20URL%20somewhere%20in%20the%20message.`
+
+    return `\r\n*****\r\nThis action was performed by [a bot.](https://www.reddit.com/r/ContextModBot/comments/o1dugk/introduction_to_contextmodbot_and_rcb/) Mention a moderator or [send a modmail](${modmailLink}) if you any ideas, questions , or concerns about this action.`
+}