diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 87f9b99..0a36595 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -2,7 +2,7 @@ name: Deploy Docs to Pages
on:
push:
- branches: ['main']
+ branches: ['main', 'next']
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 30d11d9..6dd0456 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -20,7 +20,6 @@ jobs:
- uses: EndBug/add-and-commit@v4
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- - run: standard-version
- - run: git push --follow-tags origin main && npm publish
+ - run: yarn release
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
index bea8ff1..f88775c 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,122 +2,119 @@
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
-### [3.0.4](https://github.com/web-mech/badwords/compare/v3.0.3...v3.0.4) (2020-11-16)
-
-
-## [3.0.3](https://github.com/web-mech/badwords/compare/v3.0.2...v3.0.3) (2019-07-25)
+## [4.0.0-0](https://github.com/web-mech/badwords/compare/v3.0.4...v4.0.0-0) (2024-08-18)
+### ⚠ BREAKING CHANGES
+- this release moving forward is only intended for v4 onward. please upgrade and test with caution before using in production.
-
-## [3.0.2](https://github.com/web-mech/badwords/compare/v3.0.1...v3.0.2) (2019-03-14)
+### Features
+- add one more test case in filter ([2ab9783](https://github.com/web-mech/badwords/commit/2ab978315beb0a347f4af1f5ee33bd95d7d3e020))
+- split string with backspace or underscore ([465d625](https://github.com/web-mech/badwords/commit/465d625debd165617cc446377de71c22515cbbd4))
### Bug Fixes
-* **lang.json:** remove gay from badwords ([88d1aed](https://github.com/web-mech/badwords/commit/88d1aed))
+- **action:** install NPM dependencies ([b29c6c8](https://github.com/web-mech/badwords/commit/b29c6c82fbedcaf43548749c457a56407dbe0bc5))
+- append single word filter test case ([43c8530](https://github.com/web-mech/badwords/commit/43c85301e644bbd4de5d587526ba0a9fa4cfed64))
+- change filter title to not multilingual word ([cf8e4bc](https://github.com/web-mech/badwords/commit/cf8e4bc5996fb595a113c8c114886cec61715b68))
+- v4 ([30d5d9f](https://github.com/web-mech/badwords/commit/30d5d9f014854fef4586a73e15a14d43832fe78e))
+### [3.0.4](https://github.com/web-mech/badwords/compare/v3.0.3...v3.0.4) (2020-11-16)
-
-## [3.0.1](https://github.com/web-mech/badwords/compare/v3.0.0...v3.0.1) (2019-02-19)
+
+
+## [3.0.3](https://github.com/web-mech/badwords/compare/v3.0.2...v3.0.3) (2019-07-25)
+
+
+## [3.0.2](https://github.com/web-mech/badwords/compare/v3.0.1...v3.0.2) (2019-03-14)
### Bug Fixes
-* update removeWords functionality to be case-insensitive ([235121d](https://github.com/web-mech/badwords/commit/235121d))
+- **lang.json:** remove gay from badwords ([88d1aed](https://github.com/web-mech/badwords/commit/88d1aed))
+
+
+## [3.0.1](https://github.com/web-mech/badwords/compare/v3.0.0...v3.0.1) (2019-02-19)
+
+### Bug Fixes
+- update removeWords functionality to be case-insensitive ([235121d](https://github.com/web-mech/badwords/commit/235121d))
-# [3.0.0](https://github.com/web-mech/badwords/compare/v2.0.0...v3.0.0) (2018-10-23)
+# [3.0.0](https://github.com/web-mech/badwords/compare/v2.0.0...v3.0.0) (2018-10-23)
### Code Refactoring
-* utilize es6 spread in addWords/removeWords ([656b87c](https://github.com/web-mech/badwords/commit/656b87c))
-
+- utilize es6 spread in addWords/removeWords ([656b87c](https://github.com/web-mech/badwords/commit/656b87c))
### BREAKING CHANGES
-* changes the way addWords is used, no longer accepts a single array as a parameter unless used with the spread operator
-
-
+- changes the way addWords is used, no longer accepts a single array as a parameter unless used with the spread operator
-# [2.0.0](https://github.com/web-mech/badwords/compare/v1.6.5...v2.0.0) (2018-10-23)
+# [2.0.0](https://github.com/web-mech/badwords/compare/v1.6.5...v2.0.0) (2018-10-23)
### Documentation
-* update documentation. add requirements for using lib moving forward ([9b2831d](https://github.com/web-mech/badwords/commit/9b2831d))
-
+- update documentation. add requirements for using lib moving forward ([9b2831d](https://github.com/web-mech/badwords/commit/9b2831d))
### Features
-* **profane:** support profane phrases and well as words ([995ea1e](https://github.com/web-mech/badwords/commit/995ea1e))
-
+- **profane:** support profane phrases and well as words ([995ea1e](https://github.com/web-mech/badwords/commit/995ea1e))
### BREAKING CHANGES
-* moving into es2016+ language features
-
-
+- moving into es2016+ language features
-## [1.6.5](https://github.com/web-mech/badwords/compare/v1.6.4...v1.6.5) (2018-10-23)
-
+## [1.6.5](https://github.com/web-mech/badwords/compare/v1.6.4...v1.6.5) (2018-10-23)
-## [1.6.4](https://github.com/web-mech/badwords/compare/v1.6.3...v1.6.4) (2018-09-21)
+## [1.6.4](https://github.com/web-mech/badwords/compare/v1.6.3...v1.6.4) (2018-09-21)
### Bug Fixes
-* **isProfane:** Adding regex word boundary for isProfane ([3908f3c](https://github.com/web-mech/badwords/commit/3908f3c))
-
-
+- **isProfane:** Adding regex word boundary for isProfane ([3908f3c](https://github.com/web-mech/badwords/commit/3908f3c))
-## [1.6.3](https://github.com/web-mech/badwords/compare/v1.6.2...v1.6.3) (2018-08-02)
-
+## [1.6.3](https://github.com/web-mech/badwords/compare/v1.6.2...v1.6.3) (2018-08-02)
-## [1.6.2](https://github.com/web-mech/badwords/compare/v1.6.1...v1.6.2) (2018-08-02)
+## [1.6.2](https://github.com/web-mech/badwords/compare/v1.6.1...v1.6.2) (2018-08-02)
### Bug Fixes
-* **isProfaneLike:** abort trying to match every instance of profane words. ([31126d6](https://github.com/web-mech/badwords/commit/31126d6))
-
-
+- **isProfaneLike:** abort trying to match every instance of profane words. ([31126d6](https://github.com/web-mech/badwords/commit/31126d6))
-## [1.6.1](https://github.com/web-mech/badwords/compare/v1.6.0...v1.6.1) (2017-10-25)
+## [1.6.1](https://github.com/web-mech/badwords/compare/v1.6.0...v1.6.1) (2017-10-25)
### Bug Fixes
-* **isProfaneLike:** fix case sensitive checks within list ([bfa05ce](https://github.com/web-mech/badwords/commit/bfa05ce))
-
-
+- **isProfaneLike:** fix case sensitive checks within list ([bfa05ce](https://github.com/web-mech/badwords/commit/bfa05ce))
-# [1.6.0](https://github.com/web-mech/badwords/compare/v1.5.2...v1.6.0) (2017-10-16)
+# [1.6.0](https://github.com/web-mech/badwords/compare/v1.5.2...v1.6.0) (2017-10-16)
### Features
-* fixes and updates ([8049222](https://github.com/web-mech/badwords/commit/8049222))
-
-
+- fixes and updates ([8049222](https://github.com/web-mech/badwords/commit/8049222))
-## [1.5.2](https://github.com/web-mech/badwords/compare/v1.5.1...v1.5.2) (2017-10-16)
+## [1.5.2](https://github.com/web-mech/badwords/compare/v1.5.1...v1.5.2) (2017-10-16)
### Bug Fixes
-* support for better filtering ([7c8d0e2](https://github.com/web-mech/badwords/commit/7c8d0e2))
+- support for better filtering ([7c8d0e2](https://github.com/web-mech/badwords/commit/7c8d0e2))
diff --git a/Makefile b/Makefile
index 51bfb43..e08a185 100644
--- a/Makefile
+++ b/Makefile
@@ -7,4 +7,4 @@ build:
@yarn build
docs:
- @yarn docs && yarn typedoc
+ @yarn typedoc
diff --git a/README.md b/README.md
index a3e0335..e4df8e3 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,10 @@
A javascript filter for badwords
+[](https://github.com/web-mech/badwords/actions/workflows/test.yml)
[](http://commitizen.github.io/cz-cli/)
[](https://github.com/semantic-release/semantic-release)
+[](https://web-mech.github.io/badwords/)
## Requirements
@@ -89,17 +91,13 @@ filter.removeWords(...removeWords)
filter.clean('some sadist hells word!') //some sadist hells word!
```
-#### Table of Contents
+## API Reference
-## API
-
-
-
-### Table of Contents
+Check out [TypeDoc Documentation](https://web-mech.github.io/badwords/)
## Testing
- npm test
+ yarn test
## License
diff --git a/package.json b/package.json
index 7435cf3..34087be 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "bad-words",
- "version": "3.0.4",
+ "version": "4.0.0-0",
"description": "A javascript filter for bad words",
"main": "dist/index.js",
"type": "module",
@@ -23,7 +23,7 @@
"build": "tsc --project tsconfig.cjs.json && tsc --project tsconfig.esm.json",
"prepublishOnly": "tsc",
"prepare": "husky && tsc",
- "rc": "npm version prerelease && git push --follow-tags && npm publish",
+ "rc": "standard-version --prerelease && git push --follow-tags && npm publish",
"release": "standard-version && git push --follow-tags && npm publish",
"test": "ava",
"typedoc": "typedoc --out docs ./src/badwords.ts"
@@ -39,7 +39,7 @@
"filter"
],
"dependencies": {
- "badwords-list": "^2.0.1-3"
+ "badwords-list": "^2.0.1-4"
},
"devDependencies": {
"@ava/typescript": "^5.0.0",
diff --git a/yarn.lock b/yarn.lock
index 42a9c27..aea16b0 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -1933,10 +1933,10 @@ babylon@^6.18.0:
resolved "https://registry.yarnpkg.com/babylon/-/babylon-6.18.0.tgz#af2f3b88fa6f5c1e4c634d1a0f8eac4f55b395e3"
integrity sha512-q/UEjfGJ2Cm3oKV71DJz9d25TPnq5rhBVL2Q4fA5wcC3jcrdn7+SssEybFIxwAvvP+YCsCYNKughoF33GxgycQ==
-badwords-list@^2.0.1-3:
- version "2.0.1-3"
- resolved "https://registry.yarnpkg.com/badwords-list/-/badwords-list-2.0.1-3.tgz#8eaaa6e9df7676027224fb91616a7de6d9e4d4d6"
- integrity sha512-nhL0LTLFeiCVGc0W8vM5/A5SOkuNsC+HCbt9dMoZh+Dyn0Rb++mllinmCnliWUZWqg7R0pzTNjX3I+RiPcvKHQ==
+badwords-list@^2.0.1-4:
+ version "2.0.1-4"
+ resolved "https://registry.yarnpkg.com/badwords-list/-/badwords-list-2.0.1-4.tgz#a6705b6f1c775f795bce1f34b854e44b44bf64a0"
+ integrity sha512-FxfZUp7B9yCnesNtFQS9v6PvZdxTYa14Q60JR6vhjdQdWI4naTjJIyx22JzoER8ooeT8SAAKoHLjKfCV7XgYUQ==
bail@^1.0.0:
version "1.0.5"