Add removeChatPattern (PrismarineJS#1884)

* add removeChatPattern

* (hopefully) add removeChatPattern test

* fix biggest issue ever

* Add API docs for removeChatPattern

* Removed removeChatPatternSet from typings

* remove removeChatPatternSet from API

* Fully remove removeChatPatternSet

docs/api.md

@@ -1418,6 +1418,11 @@ the event will be called `"chat:name"`, with name being the name passed
   * `repeat` - defaults to true, whether to listen for this event after the first match
   * `parse` - instead of returning the actual message that was matched, return the capture groups from the regex
 
+#### bot.removeChatPattern(name)
+
+removes a chat pattern
+* `name` the name of the chat pattern
+
 #### bot.awaitMessage(...args)
 
 promise that is resolved when one of the messages passed as an arg is resolved

index.d.ts

@@ -401,6 +401,8 @@ export interface Bot extends TypedEmitter<BotEvents> {
 
   addChatPatternSet(name: string, patterns: Array<RegExp>, options?: chatPatternOptions): void;
 
+  removeChatPattern(name: string): void;
+
   awaitMessage(...args: string | string[] | RegExp | RegExp[]): Promise<string>;
 }
 

lib/plugins/chat.js

@@ -7,7 +7,7 @@ function inject (bot, options) {
 
   const ChatMessage = require('prismarine-chat')(bot.version)
   // chat.pattern.type will emit an event for bot.on() of the same type, eg chatType = whisper will trigger bot.on('whisper')
-  const _chatRegex = []
+  let _chatRegex = []
   // deprecated
   bot.chatAddPattern = (patternValue, typeValue) => {
     bot.addChatPattern(typeValue, patternValue, { deprecated: true })
@@ -40,6 +40,10 @@ function inject (bot, options) {
     })
   }
 
+  bot.removeChatPattern = (name) => {
+    _chatRegex = _chatRegex.filter(pattern => pattern.name !== name)
+  }
+
   function findMatchingPatterns (msg) {
     const found = []
     for (const [ix, { patterns, position }] of _chatRegex.entries()) {

test/externalTests/chat.js

@@ -60,6 +60,19 @@ module.exports = () => {
     assert.strictEqual(partTwo, '<U9G> World')
   })
 
+  addTest('test removeChatPattern', async (bot) => {
+    await once(bot, 'message') // => starting chat test removeChatPattern
+    bot.addChatPattern('test', /<.+> Hello/)
+    bot.removeChatPattern('test')
+    let triggered = false
+    const listener = () => { triggered = true }
+    bot.once('chat:test', listener)
+    bot.chat('/tellraw @p {"translate":"chat.type.text", "with":["U9G", "Hello"]}')
+    await once(bot, 'message')
+    assert.ok(triggered === false)
+    bot.off('chat:test', listener)
+  })
+
   addTest('test awaitMessage', async (bot) => {
     // let resolves = 0
     const p1 = bot.awaitMessage('<flatbot> hello')