Merge branch '2Toad:master' into patch-1

Author: G-Bro

.eslintrc.json

@@ -6,7 +6,7 @@
   "extends": ["airbnb-base", "airbnb-typescript/base", "plugin:security/recommended", "plugin:prettier/recommended"],
   "plugins": ["security", "prettier"],
   "parserOptions": {
-    "ecmaVersion": 2018,
+    "ecmaVersion": 2019,
     "project": "./tsconfig.json"
   },
   "rules": {

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/workflows/cdp.yml

@@ -0,0 +1,32 @@
+# This Continuous Deployment (CDP) workflow publishes a package to NPM when a release is created
+
+name: CDP
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  continuous-deployment:
+    name: Continuous Deployment
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Get Node Version
+        run: echo "NODE_VERSION=$(cat .nvmrc)" >> $GITHUB_ENV
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          registry-url: https://registry.npmjs.org/
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - name: Publish Package
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+# This Continuous Integration (CI) pipeline lints, builds, and tests the code when a Pull Request is
+# created or a commit is pushed to a Prod branch
+
+name: CI
+on:
+  push:
+    branches: [ "master", "1.x.x" ]
+  pull_request:
+    branches: [ "master", "1.x.x" ]
+
+jobs:
+  continuous-integration:
+    name: Continuous Integration
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Get Node Version
+        run: echo "NODE_VERSION=$(cat .nvmrc)" >> $GITHUB_ENV
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - name: Lint
+        run: npm run lint
+
+      - name: Build
+        run: npm run build
+
+      - name: Unit Tests
+        run: npm test

.github/workflows/nodejs.yml

@@ -1,4 +1 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
 npx lint-staged

.husky/pre-commit

@@ -6,6 +6,7 @@ tests/
 .eslintcache
 .eslintignore
 .eslintrc.json
+.gitattributes
 .gitignore
 .nvmrc
 .prettierignore

.npmignore

@@ -1 +1 @@
-16.17.0
+20.17.0

.nvmrc

@@ -1,22 +1,22 @@
-# Profanity
+# Profanity 🧼
 
-[![GitHub version](https://badge.fury.io/gh/2Toad%2FProfanity.svg)](https://github.com/2Toad/Profanity/releases)
+![GitHub Release](https://img.shields.io/github/v/release/2Toad/Profanity)
 [![Downloads](https://img.shields.io/npm/dm/@2toad/profanity.svg)](https://www.npmjs.com/package/@2toad/profanity)
-[![Build status](https://github.com/2toad/profanity/actions/workflows/nodejs.yml/badge.svg)](https://github.com/2Toad/Profanity/actions/workflows/nodejs.yml)
+[![Build status](https://github.com/2toad/profanity/actions/workflows/ci.yml/badge.svg)](https://github.com/2Toad/Profanity/actions/workflows/nodejs.yml)
 
 A JavaScript profanity filter (with TypeScript support)
 
-## Getting Started
+## Getting Started 🚀
 
-Install package
+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.0`)
+>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.0`)
 
-## Usage
+## Usage 📚
 
 ```JavaScript
 import { profanity } from '@2toad/profanity';
@@ -37,7 +37,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,9 +51,9 @@ options.grawlixChar = '$';
 const profanity = new Profanity(options);
 ```
 
-### wholeWord
+### wholeWord 🔤
 
-By default this is set to `true`, so profanity only matches on whole words:
+By default, this is set to `true` so profanity only matches on whole words:
 ```JavaScript
 profanity.exists('Arsenic is poisonous but not profane');
 // false
@@ -65,7 +65,7 @@ profanity.exists('Arsenic is poisonous but not profane');
 // true (matched on arse)
 ```
 
-### grawlix
+### grawlix 💥
 
 By default this is set to `@#$%&!`:
 ```JavaScript
@@ -79,7 +79,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.
 
@@ -96,7 +96,7 @@ profanity.censor('I like big butts and I cannot lie', CensorType.AllVowels);
 ```
 
 
-## Customize the word list
+## Customize the word list 📝
 
 Add words:
 ```JavaScript
@@ -108,10 +108,10 @@ 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 turn partial word matching on (`wholeWord = false`), so combined words are caught (e.g., arselicker), while specific words you add to the whitelist are ignored (e.g., arsenic).
+>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).
 
 Add words to the whitelist:
 ```JavaScript
@@ -123,6 +123,6 @@ Remove words from the whitelist:
 profanity.whitelist.removeWords(['arsenic', 'buttress']);
 ```
 
-## Contributing
+## Contributing 🤝
 
-So you want to contribute to the Profanikty project? Fantastic! Please read the [Contribute](https://github.com/2Toad/Profanity/blob/master/contribute.md) doc to get started.
+So you want to contribute to the Profanity project? Fantastic! Please read the [Contribute](./contribute.md) doc to get started.

README.md

@@ -1,8 +1,8 @@
-# Contribute to the Profanity project
+# Contribute to the Profanity project 🤝
 
 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).
@@ -14,41 +14,40 @@ Thank you for wanting to contribute to the Profanity project. With your contribu
    1. Make sure you run the following scripts in local, and that all of them pass, before submitting a PR:
       1. `npm run lint`
       2. `npm run prettier`
-      3. `npm test`
-      4. `npm run build`
+      3. `npm run build`
+      4. `npm test`
    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 12+](https://nodejs.org)
+- `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`
 
-### Development
+### Workflow 🔁
 
 Start app in watch mode: `npm run local`
 
->When file changes are detected, the app will automatically rebuild/restart
+> 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.
 
@@ -68,7 +67,38 @@ 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
 
-##### Setup
-
-1. Install husky: `npx husky install`
-2. Give Husky permission: `sudo chmod -R +x .husky`
+### Dependencies 📦
+
+- `chai`: we must use v4.x because v5.x is pure ESM, and we require CommonJS modules
+
+### Deployments 🚀
+
+Deployments to Prod consist of building and publishing the Profanity lib to NPM, and are automated through our Continous 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:
+   ```
+   git add .
+   git commmit -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
+
+#### 3. Publish GitHub 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"
+   - [x] **Set as the latest 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