Merge pull request #22 from ElviraBurchik/get-profound-words

Add function to get list of found curse words

Author: RobertJGabriel

__tests__/engine.test.js

@@ -46,4 +46,16 @@ describe('ProfanityEngine Functions tests', () => {
     let terms = await profanity.all();
     expect(terms.length).toEqual(959);
   });
+
+  it('Should return list of found profanity words', async () => {
+    const sentence = 'This is a test sentence with bad words like hell and damn';
+    const badWords = await profanity.getCurseWords(sentence);
+    expect(badWords).toEqual(['hell', 'damn']);
+  });
+
+  it('Should return empty array if no curse words found', async () => {
+    const sentence = 'This is a test sentence with no bad words';
+    const result = await profanity.getCurseWords(sentence);
+    expect(result).toEqual([]);
+  });
 });

index.js

@@ -80,6 +80,26 @@ export class ProfanityEngine {
     return false;
   }
 
+  async getCurseWords(sentence) {
+    if (this.terms.length === 0) {
+      await this.initialize();
+    }
+
+    let foundCurseWords = [];
+
+    const wordsInSentence = sentence.split(/\s+/);
+    const lowerCasedTerms = this.terms.map((term) => term.toLowerCase());
+
+    for (const word of wordsInSentence) {
+      const lowerCasedWord = word.toLowerCase();
+      if (lowerCasedTerms.includes(lowerCasedWord)) {
+        foundCurseWords.push(word);
+      }
+    }
+
+    return foundCurseWords;
+  }
+
   async all() {
     if (this.terms.length === 0) {
       await this.initialize();