https://github.com/stultuss/sensitive-words-filter
文字过滤，支持敏感词匹配，由DFA算法实现
https://github.com/stultuss/sensitive-words-filter
dfa-regex sensitive-word sensitive-word-filter trie-tree
Last synced: 2 months ago
JSON representation
文字过滤，支持敏感词匹配，由DFA算法实现
- Host: GitHub
- URL: https://github.com/stultuss/sensitive-words-filter
- Owner: stultuss
- License: other
- Created: 2019-11-12T06:06:58.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T00:54:17.000Z (almost 3 years ago)
- Last Synced: 2024-11-12T21:02:11.652Z (about 1 year ago)
- Topics: dfa-regex, sensitive-word, sensitive-word-filter, trie-tree
- Language: JavaScript
- Size: 600 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
sensitive-words-filter
=========================
[![NPM Version][npm-image]][npm-url]
[![NPM Downloads][downloads-image]][downloads-url]
[![Build][travis-image]][travis-url]
[![Linux Build][travis-linux-image]][travis-linux-url]
[![Windows Build][travis-windows-image]][travis-windows-url]
[![Test Coverage][coveralls-image]][coveralls-url]
> 文字过滤，支持敏感词匹配，由DFA算法实现
## ChangeLog
### 20250110
1. 优化代码结构。
2. 增加识别敏感词中间填充了特殊字符的情况。
3. replace 接口增加自定义特殊字符过滤字段。
## Install
```bash
npm install sensitive-words-dfa-filter --save
```
## How to use
```javascript
let Filter = require('sensitive-words-dfa-filter');
// 设定需要搜索的敏感字
let search = [
'f',
'filter'
];
// 初始化文字过滤器，将敏感字做成字典
Filter.instance().init(search);
// 运行
console.log(Filter.instance().replace('This is "fuck" filter word!')); // This is "****" filter word!
console.log(Filter.instance().replace('This is "f u c k" filter word!')); // This is "*******" filter word!
console.log(Filter.instance().replace('This is "f@u@c@k" filter word!')); // This is "*******" filter word!
console.log(Filter.instance().replace('This is "fAuBcCk" filter word!', '?', 'ABC')); // This is "???????" filter word!
```
[npm-image]: https://img.shields.io/npm/v/sensitive-words-dfa-filter.svg
[npm-url]: https://npmjs.org/package/sensitive-words-dfa-filter
[downloads-image]: https://img.shields.io/npm/dm/word-filter-dfa.svg
[downloads-url]: https://npmjs.org/package/word-filter-dfa
[travis-image]: https://travis-ci.org/stultuss/sensitive-words-filter.svg?branch=master
[travis-url]: https://travis-ci.org/stultuss/sensitive-words-filter
[travis-linux-image]: https://img.shields.io/travis/stultuss/sensitive-words-filter/master.svg?label=linux
[travis-linux-url]: https://travis-ci.org/stultuss/sensitive-words-filter
[travis-windows-image]: https://img.shields.io/travis/stultuss/sensitive-words-filter/master.svg?label=windows
[travis-windows-url]: https://travis-ci.org/stultuss/sensitive-words-filter
[coveralls-image]: https://img.shields.io/coveralls/stultuss/sensitive-words-filter/master.svg
[coveralls-url]: https://coveralls.io/r/stultuss/sensitive-words-filter?branch=master