Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gautamkrishnar/naughtychecker.js
NodeJS module to check Naughty Strings, it is a set of strings which have a high probability of causing issues when used as user-input data.
https://github.com/gautamkrishnar/naughtychecker.js
blns filter naughty-strings nodejs npm validation
Last synced: 19 days ago
JSON representation
NodeJS module to check Naughty Strings, it is a set of strings which have a high probability of causing issues when used as user-input data.
- Host: GitHub
- URL: https://github.com/gautamkrishnar/naughtychecker.js
- Owner: gautamkrishnar
- License: gpl-3.0
- Created: 2017-01-21T20:15:11.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-04-19T06:21:25.000Z (over 5 years ago)
- Last Synced: 2024-10-03T05:41:46.822Z (about 1 month ago)
- Topics: blns, filter, naughty-strings, nodejs, npm, validation
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/naughtychecker
- Size: 71.3 KB
- Stars: 9
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# naughtychecker.js
[](http://www.gnu.org/licenses/gpl-3.0)
[](https://david-dm.org/gautamkrishnar/naughtychecker.js.svg)
[](https://david-dm.org/gautamkrishnar/naughtychecker.js#info=devDependencies)
[](https://travis-ci.org/gautamkrishnar/naughtychecker.js)
[](https://badge.fury.io/js/naughtychecker)
A Node.js module to check for Naughty Strings - strings that have a high probability of causing issues when used as user-input data.
### Why Test Naughty Strings?
Even multi-billion dollar companies like Twitter use automated tests to validate the input. You can't tweet a zero-width space (U+200B) on Twitter:
It's required to prevent serious errors like "Internal Server Error" for unexpected user inputs during validation.
### Installation
Yarn:
```shell
yarn add naughtychecker
```
npm:
```shell
npm install naughtychecker --save
```
### Usage
Use an offline database of naughty strings ([blns.json](src/vendor/blns.json)) to validate the input word:
```js
import NaughtyChecker from 'naughtychecker'
const nc = new NaughtyChecker()
const fromLocal = async () => {
try {
const result = await nc.validate('naughty string', {useLocal: true})
// looks good
} catch (e) {
// found naughty string
}
}
```
Use an online database of naughty strings from [Big List of Naughty Strings](https://github.com/minimaxir/big-list-of-naughty-strings) to validate the input word:
```js
import NaughtyChecker from 'naughtychecker'
const nc = new NaughtyChecker()
const fromOnline = async () => {
try {
const result = await nc.validate('naughty string')
// looks good
} catch (e) {
// found naughty string
}
}
```
### Inspiration
This project is inspired from [Big List of Naughty Strings](https://github.com/minimaxir/big-list-of-naughty-strings) and uses the naughty strings list from that project.
### Contributing
Read the [CONTRIBUTING.md](CONTRIBUTING.md) to get started. Feel free to Clone the project and submit your improvements via pull requests. Always submit pull requests to the [develop](https://github.com/gautamkrishnar/naughtychecker.js/tree/develop) branch.
#### Maintainers
* [Gautam krishna R](https://github.com/gautamkrishnar)
* [Simon Li](https://github.com/siutsin)
#### Contributors
* [Rohit Jha](https://github.com/rohitjha)
#### Release History
* 1.0.0 Initial Release
* 1.0.1 Made a little more efficient
* 1.0.2 Minor performance improvements
* 2.0.0 Promisify NaughtyChecker
* 2.0.1 Minor changes
#### Stats
[](https://nodei.co/npm/naughtychecker/)
#### Liked it?
Hope you liked this module, don't forget to give it a star :star: