https://github.com/jojoee/leo-profanity-typescript

:tiger: Profanity filter, based on "Shutterstock" dictionary
https://github.com/jojoee/leo-profanity-typescript

bad curse dirty obscene profanity swear

Last synced: 8 days ago
JSON representation

:tiger: Profanity filter, based on "Shutterstock" dictionary

• Host: GitHub
• URL: https://github.com/jojoee/leo-profanity-typescript
• Owner: jojoee
• License: mit
• Created: 2017-09-24T15:44:30.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2019-09-15T17:10:04.000Z (about 5 years ago)
• Last Synced: 2024-05-01T14:24:23.871Z (7 months ago)
• Topics: bad, curse, dirty, obscene, profanity, swear
• Language: TypeScript
• Homepage:
• Size: 16.6 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# leo-profanity-typescript

[![Travis](https://img.shields.io/travis/jojoee/leo-profanity-typescript.svg)](https://travis-ci.org/jojoee/leo-profanity-typescript)

[![Coverage Status](https://coveralls.io/repos/github/jojoee/leo-profanity-typescript/badge.svg?branch=master)](https://coveralls.io/github/jojoee/leo-profanity-typescript?branch=master) [![Greenkeeper badge](https://badges.greenkeeper.io/jojoee/leo-profanity-typescript.svg)](https://greenkeeper.io/)

Based on [jojoee/leo-profanity](https://github.com/jojoee/leo-profanity) v1.24, using [Jest](https://github.com/facebook/jest) instead of [Mocha](https://github.com/mochajs/mocha) for test framework

## TODO

- [x] [RollupJS](https://rollupjs.org/): multiple optimized bundles

- [x] [Jest](http://facebook.github.io/jest/): tests and coverage

- [x] [Prettier](https://github.com/prettier/prettier) and [TSLint](https://github.com/palantir/tslint): code formatting

- [x] [TypeDoc](http://typedoc.org/): docs automatic generation and deployment to `gh-pages`

- [ ] `*.d.ts`: automatic types file generation

- [x] [Travis](https://travis-ci.org/): build CI

- [x] [Coveralls](https://coveralls.io/): test coverage report

- [ ] Increase `coverageThreshold`

- [ ] `semantic-release`

- [ ] Support string for `add` and `remove` methods

- [ ] Deploy docs after commit

- [ ] Make it `static`

- [ ] Remove `require` syntax

- [ ] Test build files `.es5.js` and `.umd.js`

- [ ] Commit via `npm run commit` only

- [x] Publish to npm

## NPM scripts

```

npm test

npm start: npm run build in watch mode

npm run test:watch: test in watch mode

npm run test:prod: linting + coverage

npm run build: generate bundles and typings, create docs

npm run lint: lints

npm run commit

```

## Reference

- [jojoee/leo-profanity](https://github.com/jojoee/leo-profanity)

- Start at commit f0bc9aa (264commits) of starter [alexjoverm/typescript-library-starter](https://github.com/alexjoverm/typescript-library-starter)

- Alternative starter [bitjson/typescript-starter](https://github.com/bitjson/typescript-starter)