jojoee/leo-profanity-typescript

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

leo-profanity-typescript

Based on jojoee/leo-profanity v1.24, using Jest instead of Mocha for test framework

TODO

• RollupJS: multiple optimized bundles
• Jest: tests and coverage
• Prettier and TSLint: code formatting
• TypeDoc: docs automatic generation and deployment to gh-pages
• *.d.ts: automatic types file generation
• Travis: build CI
• Coveralls: 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
• 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
• Start at commit f0bc9aa (264commits) of starter alexjoverm/typescript-library-starter
• Alternative starter bitjson/typescript-starter

leo-profanity-typescript's Issues

Why isn't this available in NPM registry?

I really need a profanity filtering library that works in TypeScript. Tried to integrate bad-words, but I couldn't get it to work. Please publish.