profanity_filter 1.0.2

Dart native js
Flutter Android iOS web

Simple filter to check and censor strings against profanity, obscene words. A default English words list is provided (LDNOOBW).

profanity_filter #

Simple Dart class to create filters that check and censor strings against profanity. A default English words list is provided.

Usage #

To use this plugin, add profanity_filter as a dependency in your pubspec.yaml file.

Example #

import 'package:profanity_filter/profanity_filter.dart';

void main() {
  final filter = ProfanityFilter(); //Creates filter with default list.
  String myString = 'you are an ass';

  //To check if profanity exists
  bool isProfane = filter.checkStringForProfanity(
      myString); //Returns true since 'ass' is in profanity list.
  if (isProfane) {
    print('Profanity was detected');
  }

  //To censor a string
  String cleanString = filter.censorString(myString);
  print(cleanString); //Prints 'you are an ***'
}

Detect if a string contains profanity #

Use the checkStringForProfanity() method of the filter instance. Pass in the string to be tested.

Example

final filter = ProfanityFilter();
String badString = 'you are an ass';
filter.checkStringForProfanity(badString); //Returns true.

Return the list of profanity used #

If you want to get all the profane words used in the string, use the getAllProfanityInString() method.

Example

final filter = ProfanityFilter();
String badString = 'you are an ass';
filter.getAllProfanityInString(badString); //Returns ['ass'].

Censor a string (replace profanity with something clean) #

Use the censorString() method of the filter instance. Pass in the string to be censored.

Example

final filter = ProfanityFilter();
String badString = 'you are an ass';
String cleanString = filter.censorString('you are an ass'); //cleanString: 'you are an ***'

Optionally, you can provide your own clean replacement word to the replaceWith named parameter. filter.censorString(string, replaceWith:'[censored]') will replace any profanity in string with [censored]

Default Profanity List #

The default profanity list is taken from the LDNOOBW list, licensed under a Creative Commons Attribution 4.0 International License.

To create a filter with the default list, use the default constructor ProfanityFilter()

Variations #

To include custom words alongside default list

Use ProfanityFilter.filterAdditionally() constructor and pass your list of custom words.

To filter only custom words (default list is ignored)

Use ProfanityFilter.filterOnly() constructor and pass your list of custom words.

To filter with a few exclusions from default list

Use ProfanityFilter.ignore() constructor and pass your list of custom words. Those words will be removed from the default list if they exist there.

3
likes
100
pub points
77%
popularity

Simple filter to check and censor strings against profanity, obscene words. A default English words list is provided (LDNOOBW).

Repository (GitHub)
View/report issues

Documentation

API reference

Uploader

roshanrahman6399@gmail.com

License

BSD (LICENSE)

More

Packages that depend on profanity_filter