Merge pull request #72 from 2Toad/jp-issue-71

Add benchmarking

Author: JasonPierce

README.md

@@ -6,17 +6,17 @@
 
 A JavaScript profanity filter (with TypeScript support)
 
-## Getting Started 🚀
+## Getting Started
 
 Install the package
 
 ```Shell
 npm i @2toad/profanity
 ```
 
->If you're using Node 11.x or older, you'll need to install [Profanity 1.x](https://github.com/2Toad/Profanity/releases) (e.g., `npm i @2toad/profanity@1.4.1`)
+>If you're using Node 11.x or older, you'll need to install [Profanity 1.x](https://github.com/2Toad/Profanity/releases)
 
-## Usage 📚
+## Usage
 
 ```JavaScript
 import { profanity, CensorType } from '@2toad/profanity';
@@ -38,7 +38,7 @@ profanity.censor('I like big butts (aka arses) and I cannot lie', CensorType.Fir
 // I like big *utts (aka *rses) and I cannot lie
 ```
 
-## Options ⚙️
+## Options
 Create an instance of the Profanity class to change the default options:
 
 ```JavaScript
@@ -51,7 +51,7 @@ const profanity = new Profanity({
 });
 ```
 
-### wholeWord 🔤
+### wholeWord
 
 By default, this is set to `true` so profanity only matches on whole words:
 ```JavaScript
@@ -82,7 +82,7 @@ profanity.exists("Don't be an arsenic-monster");
 // true (matched on arse)
 ```
 
-### grawlix 💥
+### grawlix
 
 By default this is set to `@#$%&!`:
 ```JavaScript
@@ -96,7 +96,7 @@ profanity.censor('I like big butts and I cannot lie');
 // I like big **** and I cannot lie
 ```
 
-### grawlixChar 💲
+### grawlixChar
 
 When specifying a `CensorType` other than `CensorType.Word`, this is the character used by the `censor` function.
 
@@ -113,7 +113,7 @@ profanity.censor('I like big butts and I cannot lie', CensorType.AllVowels);
 ```
 
 
-## Customize the word list 📝
+## Customize the word list
 
 Add words:
 ```JavaScript
@@ -125,7 +125,7 @@ Remove words:
 profanity.removeWords(['butt', 'arse']);
 ```
 
-## Whitelist ✅
+## Whitelist
 The whitelist allows you to specify words that are always ignored by the profanity filter.
 
 >This can be useful if you want to enable partial word matching (`wholeWord = false`), so combined words are caught (e.g., arselicker), while specific words you add to the whitelist are ignored (e.g., arsenic).
@@ -140,6 +140,10 @@ Remove words from the whitelist:
 profanity.whitelist.removeWords(['arsenic', 'buttress']);
 ```
 
+## Benchmarking ⏱️
+
+To see how Profanity performs, check out our [benchmark results](./src/benchmark/results.md).
+
 ## Contributing 🤝
 
 So you want to contribute to the Profanity project? Fantastic! Please read the [Contribute](./contribute.md) doc to get started.

contribute.md

@@ -2,7 +2,7 @@
 
 Thank you for wanting to contribute to the Profanity project. With your contributions we can ensure Profanity remains a leading solution for filtering profanity within JavaScript projects
 
-## Steps for success ✅
+## Steps for success
 
 1. [Issues](https://github.com/2Toad/Profanity/issues):
    1. Always work off of an Issue. Please do not submit a Pull Request that is not associated with an Issue (create the Issue if necessary).
@@ -19,35 +19,35 @@ Thank you for wanting to contribute to the Profanity project. With your contribu
    2. Make sure your PR is targeting the correct branch (see Step 2.ii)
    3. At the top of your PR description write: "Fixes #_n_". Where _n_ is the number of the Issue your PR is fixing (e.g., `Fixes #33`). This will tell GitHub to associate your PR with the Issue.
 
-## Development 💻
+## Development
 
-### Prerequisites 📝
+### Prerequisites
 
 - `master` branch: [Node 20+](https://nodejs.org)
 - `1.x.x` branch: [Node 10.23.0](https://nodejs.org)
 
-### Source Code 🔠
+### Source Code
 
 1. Clone the repo
 2. Change directories: `cd Profanity`
 3. Install dependencies: `npm i`
 
-### Workflow 🔁
+### Workflow
 
 Start app in watch mode: `npm run local`
 
 > When file changes are detected, the app will automatically rebuild/restart
 
-#### Linting 🧹
+#### Linting
 
 - Check lint rules: `npm run lint`
 - Fix lint errors: `npm run lint:fix`
 - Check formatting rules: `npm run prettier`
 - Fix formatting errors: `npm run prettier:fix`
 
-## Appendix 📚
+## Appendix
 
-### Dev Tools 🛠️
+### Dev Tools
 
 The following section includes optional dev tools that enhance the Profanity development experience, but are not necessary.
 
@@ -67,38 +67,41 @@ The Profanity project includes an .nvmrc file, so you can run `nvm use` to switc
 
 The Profanity project includes Husky for running Git Hooks. Running `git commit` will trigger `lint-staged` which will lint all files currently staged in Git. If linting fails, the commit will be cancelled
 
-### Dependencies 📦
+### Dependencies
 
 - `chai`: we must use v4.x because v5.x is pure ESM, and we require CommonJS modules
 
-### Deployments 🚀
+### Deployment
 
-Deployments to Prod consist of building and publishing the Profanity lib to NPM, and are automated through our Continous Deployment workflow.
+Deploying to Prod consist of building and publishing the Profanity lib to NPM, and are automated through our Continuous Deployment workflow.
 
-#### 1. Change Version
-1. Checkout `master`
-2. Increment version (semantic) in package.json (e.g., 1.1.0)
-3. Rebuild package-lock (to pick up new version ): `npm i --package-lock-only`
-4. Push changes:
+#### 1. Create New Version
+1. Checkout `master`.
+2. Increment the version in package.json, using semantic versioning (e.g., `1.1.0`).
+3. Perform benchmarking:
+   1. Run the script: `npm run benchmark`.
+   2. Record the results in [benchmark/results.md](./src/benchmark/results.md), for the new version.
+4. Rebuild package-lock, to pick up the new version number: `npm i --package-lock-only`.
+5. Push changes:
    ```
    git add .
-   git commmit -m "Bump version to 1.1.0"
+   git commit -m "Bump version to 1.1.0"
    git push
    ```
 
 #### 2. Verify Checks
-1. Navigate to the [CI](https://github.com/2Toad/Profanity/actions/workflows/ci.yml) workflow
-2. Ensure the run for the above "Bump version" commit succeeds
+1. Navigate to the [CI](https://github.com/2Toad/Profanity/actions/workflows/ci.yml) workflow.
+2. Ensure the build checks for this push succeed.
 
 #### 3. Publish GitHub Release
-1. Navigate to [Profanity's releases](https://github.com/2Toad/Profanity/releases)
-2. Click "Draft a new release"
+1. Navigate to [Profanity's releases](https://github.com/2Toad/Profanity/releases).
+2. Click "Draft a new release":
    - **Choose a tag**: enter version (e.g., `v1.1.0`) and click "Create new tag"
    - **Target**: `master`
    - **Previous tag**: `auto`
    - **Release title**: (e.g., `1.1.0`)
-   - **Description**: click the "Genereate release notes"
+   - **Description**: click the "Generate release notes"
    - [x] **Set as the latest release**
-3. Click "Publish release"
+3. Click "Publish release".
 
 > This will trigger the [CDP](https://github.com/2Toad/Profanity/actions/workflows/cdp.yml) workflow, which will build and deploy the package to NPM: https://www.npmjs.com/package/@2toad/profanity

package-lock.json

@@ -17,6 +17,7 @@
     "pretest": "npm run build",
     "test": "mocha -r ts-node/register tests/**/*.spec.ts",
     "test:watch": "npm run test -- --watch",
+    "benchmark": "ts-node src/benchmark/benchmark.ts",
     "lint": "eslint . --cache",
     "lint:fix": "eslint . --cache --fix",
     "prettier": "prettier --check **/*.ts",
@@ -50,11 +51,13 @@
     "filter"
   ],
   "devDependencies": {
+    "@types/benchmark": "^2.1.5",
     "@types/chai": "^4.3.19",
     "@types/mocha": "^10.0.7",
     "@types/node": "^22.5.2",
     "@typescript-eslint/eslint-plugin": "^8.3.0",
     "@typescript-eslint/parser": "^8.3.0",
+    "benchmark": "^2.1.4",
     "chai": "^4.5.0",
     "concurrently": "^8.2.2",
     "eslint": "^8.57.0",

package.json

@@ -0,0 +1,13 @@
+export interface VersionData {
+  version: number;
+  smallCleanText: string;
+  smallProfaneText: string;
+  largeCleanText: string;
+  largeProfaneText: string;
+}
+
+export interface TestData {
+  comment1: string;
+  comment2: string;
+  versions: VersionData[];
+}