feat/ Log Profane Enabled

README.md

@@ -84,6 +84,8 @@ new Filter(config?: {
   customWords?: string[];
   replaceWith?: string;
   severityLevels?: boolean;
+  ignoreWords?: string[];
+  logProfanity?: boolean;
 });
 ```
 
@@ -95,6 +97,8 @@ new Filter(config?: {
   - `customWords`: An array of custom words to include in the profanity check.
   - `replaceWith`: A string to replace profane words with.
   - `severityLevels`: A boolean indicating whether to include severity levels for profane words.
+  - `ignoreWords`: An array of words to ignore in the profanity check.
+  - `logProfanity`: A boolean indicating whether to log detected profane words.
 
 #### Methods
 
@@ -138,6 +142,8 @@ A custom React hook for using the profanity checker.
   - `customWords`: An array of custom words to include in the profanity check.
   - `replaceWith`: A string to replace profane words with.
   - `severityLevels`: A boolean indicating whether to include severity levels for profane words.
+  - `ignoreWords`: An array of words to ignore in the profanity check.
+  - `logProfanity`: A boolean indicating whether to log detected profane words.
   - `customActions`: A function to execute custom actions when profanity is detected.
 
 #### Return Value

package.json

@@ -1,6 +1,6 @@
 {
   "name": "glin-profanity",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "Glin-Profanity is a lightweight and efficient npm package designed to detect and filter profane language in text inputs across multiple languages. Whether you’re building a chat application, a comment section, or any platform where user-generated content is involved, Glin-Profanity helps you maintain a clean and respectful environment.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/filters/Filter.ts

@@ -9,6 +9,8 @@ interface FilterConfig {
   customWords?: string[];
   replaceWith?: string;
   severityLevels?: boolean;
+  ignoreWords?: string[];
+  logProfanity?: boolean;
 }
 
 class Filter {
@@ -17,13 +19,17 @@ class Filter {
   private wordBoundaries: boolean;
   private replaceWith?: string;
   private severityLevels: boolean;
+  private ignoreWords: Set<string>;
+  private logProfanity: boolean;
 
   constructor(config?: FilterConfig) {
     let words: string[] = [];
     this.caseSensitive = config?.caseSensitive ?? false;
     this.wordBoundaries = config?.wordBoundaries ?? true;
     this.replaceWith = config?.replaceWith;
     this.severityLevels = config?.severityLevels ?? false;
+    this.ignoreWords = new Set(config?.ignoreWords?.map(word => word.toLowerCase()) || []);
+    this.logProfanity = config?.logProfanity ?? false;
 
     if (config?.allLanguages) {
       for (const lang in dictionary) {
@@ -56,7 +62,7 @@ class Filter {
 
   isProfane(value: string): boolean {
     for (const word of this.words.keys()) {
-      if (this.getRegex(word).test(value)) return true;
+      if (!this.ignoreWords.has(word.toLowerCase()) && this.getRegex(word).test(value)) return true;
     }
     return false;
   }
@@ -67,12 +73,16 @@ class Filter {
     const severityMap: { [word: string]: number } = {};
 
     for (const word of words) {
-      if (this.words.has(word.toLowerCase())) {
+      if (this.words.has(word.toLowerCase()) && !this.ignoreWords.has(word.toLowerCase())) {
         profaneWords.push(word);
         severityMap[word] = this.words.get(word.toLowerCase())!;
       }
     }
 
+    if (this.logProfanity && profaneWords.length > 0) {
+      console.log(`Profane words detected: ${profaneWords.join(', ')}`);
+    }
+
     let processedText = text;
     if (this.replaceWith) {
       for (const word of profaneWords) {