bad-words-next - npm Package Compare versions

Comparing version 2.1.0 to 2.2.0

CHANGELOG.md

 # Changelog
 
+## [2.2.0](https://github.com/alexzel/bad-words-next/compare/v2.1.0...v2.2.0) (2023-06-21)
+
+
+### Features
+
+* implement placeholderMode to address the feature request ([5aa1b76](https://github.com/alexzel/bad-words-next/commit/5aa1b763a0940383c3fa8676d5250050b13812d4))
+
 ## [2.1.0](https://github.com/alexzel/bad-words-next/compare/v2.0.1...v2.1.0) (2023-06-04)
@@ -4,0 +11,0 @@

lib/index.d.ts

@@ -6,2 +6,7 @@ /**
 /**
+ * Placeholder mode to either replace with or repeat the placeholder
+ * @type {String}
+ */
+type PlaceholderMode = 'repeat' | 'replace';
+/**
  * Dictionary data format
@@ -42,2 +47,8 @@ */
     /**
+     * Placeholder mode to either replace with or repeat the placeholder
+     * @defaultValue <code>'replace'</code>
+     * @type {[type]}
+     */
+    placeholderMode?: PlaceholderMode;
+    /**
      * Special chars to allow on start and/or end of a word
@@ -71,2 +82,3 @@ * @defaultValue <code>/\d|[!@#$%^&*()[\\];:'",.?\\-_=+~`|]|a|(?:the)|(?:el)|(?:la)/</code>
     placeholder: string;
+    placeholderMode: PlaceholderMode;
     specialChars: RegExp;
@@ -176,2 +188,2 @@ spaceChars: string[];
 
-export { Data, Lookalike, Options, BadWordsNext as default };
+export { Data, Lookalike, Options, PlaceholderMode, BadWordsNext as default };

lib/index.js

@@ -154,2 +154,3 @@ import { remove } from 'confusables';
   placeholder: '***',
+  placeholderMode: 'replace',
   specialChars: /\d|[!@#$%^&*()[\];:'",.?\-_=+~`|]|a|(?:the)|(?:el)|(?:la)/,
@@ -287,2 +288,5 @@ spaceChars: ['', '.', '-', ';', '|'],
           }
+          if (_this2.opts.placeholderMode === 'repeat') {
+            return _this2.opts.placeholder.repeat(word.length);
+          }
           return _this2.opts.placeholder;
@@ -289,0 +293,0 @@ }

package.json

 {
   "name": "bad-words-next",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "JavaScript/TypeScript filter and checker for bad words aka profanity",
@@ -5,0 +5,0 @@ "keywords": [

README.md

@@ -84,5 +84,3 @@ # bad-words-next
 
-interface Lookalike {
-  [key: string | number]: string // Simple key-value object
-}
+type Lookalike = Record<string | number, string> // Simple key-value object
 ```
@@ -102,2 +100,3 @@
   placeholder?: string // Filter placeholder - default '***'
+  placeholderMode?: 'repeat' | 'replace' // Placeholder mode to either replace with or repeat the placeholder - default 'replace'
   specialChars?: RegExp // Special chars to allow on start and/or end of a word - default /\d|[!@#$%^&*()[\];:'",.?\-_=+~`|]|a|(?:the)|(?:el)|(?:la)/
@@ -104,0 +103,0 @@ spaceChars?: string[] // Pseudo space chars, a list of values for `_` symbol in a dictionary word string - default ['', '.', '-', ';', '|']

test/index.test.ts

@@ -62,2 +62,7 @@ import BadWordsNext from '../src'
       })
+
+      it('filters and replaces with repeated placeholder', () => {
+        const badwords = new BadWordsNext({ data: en, placeholder: '#', placeholderMode: 'repeat' })
+        expect(badwords.filter('$h1ttt')).toBe('######')
+      })
     })
@@ -64,0 +69,0 @@ })

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

59289

increased by2.32%

Lines of code

1974

increased by1.23%

Worsened metrics

Number of lines in readme file

114

decreased by-0.87%

No dependency changes