npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@coffeeandfun/google-profanity-words

v2.1.0

Published

Full list of bad words and top swear words banned by Google.

Downloads

4,232

Readme

alt text

Description

Full list of bad words and top swear words banned by Google. The list is updated monthly. Pull requests are welcome!

The @coffeeandfun/google-profanity-words is a Node.js module created by Robert James Gabriel from Coffee & Fun LLC. It is designed to help you identify and manage profanity words in a given text. The module provides functions to retrieve a list of all known profanity words, check if a specific word is considered profane, and handle empty strings appropriately.

Installation

You can install the @coffeeandfun/google-profanity-words module using npm:

npm install @coffeeandfun/google-profanity-words

Usage

To use the @coffeeandfun/google-profanity-words, first, import the module and create an instance:

import { ProfanityEngine } from '@coffeeandfun/google-profanity-words';

// Pass the 'language' parameter to specify the language (optional).
// Defaults to 'en' if no valid language code is provided.
const profanity = new ProfanityEngine({ language: 'es' });

The language parameter is optional and can be used to specify the language for the profanity list. It defaults to 'en' if no valid language code is provided. If the specified language file is not found, it will fall back to the 'en' language file and display a console warning.

API Functions

1. all()

Retrieves all the profanity words as an array.

const allWords = profanity.all();

2. search(word)

Checks if a given word is considered profane.

const searchWord = profanity.search('shit');
// Returns true if the word is profane, otherwise false.

3. hasCurseWords(sentence)

Checks if a given sentence contains any profanity words.

const sentence = 'Do not use bad words like mierda or idiota.';
const hasCurseWords = profanity.hasCurseWords(sentence);
// Returns true if the sentence contains profanity words, otherwise false.

4. Handling Empty Strings

The search and hasCurseWords functions will return false for any empty string.

const searchWord = profanity.search('');
const hasCurseWords = profanity.hasCurseWords('');
// Returns false for an empty string.

Testing

The @coffeeandfun/google-profanity-words comes with a test suite using the Jest framework. To run the tests, use the following command:

npm test

Contributing

Contributions to this module are welcome! If you find any issues or have suggestions for improvements, feel free to open an issue or create a pull request on the GitHub repository.

License

This project is licensed under the MIT License.

Acknowledgments

Special thanks to Robert James Gabriel and Coffee & Fun LLC for creating and maintaining this module, as well as the Jest team for the testing framework. Your efforts make this module more reliable and robust.