From 22cd3ec6d019f26a021c3d4f3da452cd2a02c2b9 Mon Sep 17 00:00:00 2001 From: web-mech Date: Sat, 17 Aug 2024 19:20:22 -0400 Subject: [PATCH] docs(readme): update readme update usage examples --- README.md | 106 +++++++++++++++--------------------------------------- 1 file changed, 28 insertions(+), 78 deletions(-) diff --git a/README.md b/README.md index 13a0a1e..a3e0335 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,6 @@ A javascript filter for badwords -[![Build Status](https://travis-ci.org/web-mech/badwords.svg?branch=master)](https://travis-ci.org/web-mech/badwords) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release) @@ -12,13 +11,14 @@ As of version 2, requires you either have an environment that understands ES2016 ## Installation - npm install bad-words --save + yarn add bad-words ## Usage ```js -var Filter = require('bad-words'), - filter = new Filter(); +import { Filter } from 'bad-words' +... +const filter = new Filter(); console.log(filter.clean("Don't be an ash0le")); //Don't be an ****** ``` @@ -26,126 +26,76 @@ console.log(filter.clean("Don't be an ash0le")); //Don't be an ****** ### Placeholder Overrides ```js -var Filter = require('bad-words'); -var customFilter = new Filter({ placeHolder: 'x'}); +const customFilter = new Filter({ placeHolder: 'x' }) -customFilter.clean("Don't be an ash0le"); //Don't be an xxxxxx +customFilter.clean("Don't be an ash0le") //Don't be an xxxxxx ``` ### Regex Overrides ```js -var filter = new Filter({ regex: /\*|\.|$/gi }); +const filter = new Filter({ regex: /\*|\.|$/gi }) -var filter = new Filter({ replaceRegex: /[A-Za-z0-9가-힣_]/g }); +const filter = new Filter({ replaceRegex: /[A-Za-z0-9가-힣_]/g }) //multilingual support for word filtering ``` ### Add words to the blacklist ```js -var filter = new Filter(); +const filter = new Filter() -filter.addWords('some', 'bad', 'word'); +filter.addWords('some', 'bad', 'word') -filter.clean("some bad word!") //**** *** ****! +filter.clean('some bad word!') //**** *** ****! //or use an array using the spread operator -var newBadWords = ['some', 'bad', 'word']; +const newBadWords = ['some', 'bad', 'word'] -filter.addWords(...newBadWords); +filter.addWords(...newBadWords) -filter.clean("some bad word!") //**** *** ****! +filter.clean('some bad word!') //**** *** ****! //or -var filter = new Filter({ list: ['some', 'bad', 'word'] }); +const filter = new Filter({ list: ['some', 'bad', 'word'] }) -filter.clean("some bad word!") //**** *** ****! +filter.clean('some bad word!') //**** *** ****! ``` ### Instantiate with an empty list ```js -var filter = new Filter({ emptyList: true }); -filter.clean('hell this wont clean anything'); //hell this wont clean anything +const filter = new Filter({ emptyList: true }) +filter.clean('hell this wont clean anything') //hell this wont clean anything ``` ### Remove words from the blacklist ```js -let filter = new Filter(); +const filter = new Filter() -filter.removeWords('hells', 'sadist'); +filter.removeWords('hells', 'sadist') -filter.clean("some hells word!"); //some hells word! +filter.clean('some hells word!') //some hells word! //or use an array using the spread operator -let removeWords = ['hells', 'sadist']; +const removeWords = ['hells', 'sadist'] -filter.removeWords(...removeWords); +filter.removeWords(...removeWords) -filter.clean("some sadist hells word!"); //some sadist hells word! +filter.clean('some sadist hells word!') //some sadist hells word! ``` -### API +#### Table of Contents - - -#### constructor - -Filter constructor. - -**Parameters** - -- `options` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Filter instance options (optional, default `{}`) - - `options.emptyList` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Instantiate filter with no blacklist - - `options.list` **[array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** Instantiate filter with custom list - - `options.placeHolder` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Character used to replace profane words. - - `options.regex` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Regular expression used to sanitize words before comparing them to blacklist. - - `options.replaceRegex` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Regular expression used to replace profane words with placeHolder. - -#### isProfane - -Determine if a string contains profane language. - -**Parameters** - -- `string` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** String to evaluate for profanity. - -#### replaceWord - -Replace a word with placeHolder characters; - -**Parameters** +## API -- `string` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** String to replace. - -#### clean - -Evaluate a string for profanity and return an edited version. - -**Parameters** - -- `string` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Sentence to filter. - -#### addWords - -Add word(s) to blacklist filter / remove words from whitelist filter - -**Parameters** - -- `word` **...[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Word(s) to add to blacklist - -#### removeWords - -Add words to whitelist filter - -**Parameters** + -- `word` **...[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Word(s) to add to whitelist. +### Table of Contents ## Testing