Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/darwiin/french-badwords-list
A highly consumable list of bad (profanity) french words
https://github.com/darwiin/french-badwords-list
badwords francais french french-speaking javascript list node-module npm-module profanity
Last synced: about 1 month ago
JSON representation
A highly consumable list of bad (profanity) french words
- Host: GitHub
- URL: https://github.com/darwiin/french-badwords-list
- Owner: darwiin
- License: mit
- Fork: true (web-mech/badwords-list)
- Created: 2017-09-06T04:57:09.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-05-24T22:29:39.000Z (over 1 year ago)
- Last Synced: 2024-06-22T16:57:45.833Z (3 months ago)
- Topics: badwords, francais, french, french-speaking, javascript, list, node-module, npm-module, profanity
- Language: JavaScript
- Homepage:
- Size: 254 KB
- Stars: 23
- Watchers: 4
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# French Bad Words List (french-badwords-list)
[](https://opensource.org/licenses/MIT) [](https://coveralls.io/github/darwiin/french-badwords-list?branch=master)
## Synopsis
A highly consumable list of bad (profanity) french words based on the list found in [Wiktionary.org](https://fr.wiktionary.org/w/index.php?title=Cat%C3%A9gorie:Insultes_en_fran%C3%A7ais&pageuntil=mongol+a+batteries%0Amongol+%C3%A0+batteries#mw-pages) and test with [bad-words](https://www.npmjs.com/package/bad-words) and [leo-profanity](https://www.npmjs.com/package/leo-profanity)
Inspired by [badwords-list](https://github.com/MauriceButler/badwords)
[](https://nodei.co/npm/french-badwords-list/)
## Code Example
This bad (profanity) french words list can be used with [bad-words](https://www.npmjs.com/package/bad-words) or [leo-profanity](https://www.npmjs.com/package/leo-profanity) for example. (If you want to add your filter module don't hesitate to create a pull request on the readme).
```javascript
var list = require('french-badwords-list'),
array = list.array,
object = list.object,
regex = list.regex;
```
### Code Example with **leo-profanity**
**french-badwords-list** has been succesfully tested with [leo-profanity](https://www.npmjs.com/package/leo-profanity)
```javascript
// Usage example with leo-profanity
var leoProfanity = require('leo-profanity');
var frenchBadwordsList = require('french-badwords-list');
// Only keep french badwords
leoProfanity.clearList();
leoProfanity.add(frenchBadwordsList.array);
// output: true
console.log(leoProfanity.check('Bordel de merde'));
// output: ****** de *****
console.log(leoProfanity.clean('Bordel de merde'));
// output: ****** de *****
console.log(leoProfanity.clean('B0rdel de m3rd3'));
```
### Code Example with **bad-words**
**french-badwords-list** has been succesfully tested with [bad-words](https://www.npmjs.com/package/bad-words)
```javascript
// Usage example with leo-profanity
var BadWords = require('bad-words');
const frenchBadwords = require('french-badwords-list');
// Only keep french badwords
var badwords = new BadWords({ placeHolder: 'x', emptyList: true});
badwords.addWords(...frenchBadwordsList.array);
// output: xxxxxx de xxxxx
console.log(badwords.clean('B0rdel de m3rd3'));
// output: true
console.log(badwords.isProfane('B0rdel de m3rd3'));
```
## Motivation
This project was created to be used with badwords or leo-profanity nodes modules as a source for french bad words to filter.
## Installation
```
npm install french-badwords-list
```
## Tests
#### Requires
- [Mocha](https://www.npmjs.com/package/mocha)
- [Chai](https://www.npmjs.com/package/chai)
- [leo-profanity](https://www.npmjs.com/package/leo-profanity) for integration testing
- [bad-words](https://www.npmjs.com/package/bad-words) for integration testing
- [uglify-js](https://www.npmjs.com/package/uglify-js) to minify source files
#### Run
```
npm test
```
## Release Notes
- v1.0.0 / Sep 07 2017: Initial publish
- v1.0.1 / Sep 13 2017: Updated french bad words list
- v1.0.2 / Sep 13 2017: Updated french bad words list
- v1.0.3 / Sep 18 2017:
- Updated french bad words list
- Tests rewritten with chai
- v1.0.4 / 0ct 02 2017: Add french bad words to the list
- v1.0.5 / 0ct 27 2017:
- Add new words to the list
- Use uglify-js to minify source files
- v1.0.6 / Aug 02 2022:
- Migrate to Github actions
- Update all dependencies
- v1.0.7 / May 25 2023: Security update
## License
The MIT License (MIT)
Copyright (c) 2013 Maurice Butler
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.