Move benchmark and translate into tools folder

Author: JasonPierce

.npmignore

@@ -4,12 +4,10 @@ src/
 tests/
 .editorconfig
 .eslintcache
-.eslintignore
-.eslintrc.json
 .gitattributes
 .gitignore
 .nvmrc
 .prettierignore
 .prettierrc.json
-docker-compose.yml
+eslint.config.mjs
 tsconfig.json

README.md

@@ -164,7 +164,7 @@ profanity.whitelist.removeWords(['arsenic', 'buttress']);
 
 ## Benchmarking ⏱️
 
-To see how Profanity performs, check out our [benchmark results](./src/benchmark/results.md).
+To see how Profanity performs, check out our [benchmark results](./src/tools/benchmark/results.md).
 
 ## Contributing 🤝
 

contribute.md

@@ -76,8 +76,7 @@ We utilize a self-hosted instance of the Open Source [LibreTranslate](https://gi
 #### Steps to Run Translations
 
 1. Open a terminal.
-2. Start Docker: `docker-compose up`.
-3. Run the translation script: `npm run translate`.
+2. Generate translations: `npm run translate`.
 
 #### Available Languages
 
@@ -90,7 +89,7 @@ By default, the LibreTranslate service is configured to include all available ta
 To optimize performance, we limit the target languages by configuring the `LT_LOAD_ONLY` environment variable:
 
 ##### Configure Target Languages
-1. Open the `./docker-compose.yml` file.
+1. Open the [docker-compose.yml](./src/tools/translate/docker-compose.yml) file.
 2. Add a comma-separated list of the [supported language codes](https://github.com/argosopentech/argos-translate/blob/master/argostranslate/languages.csv) you wish to include. Ensure English (`en`) is included, as it serves as the source language.
 
 **Example Configuration:**
@@ -112,9 +111,11 @@ Deployments to Prod consist of building and publishing the Profanity lib to NPM,
 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.
+   2. Record the results in [benchmark/results.md](./src/tools/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:
+5. Create local NPM package: `npm pack`
+   - Examine generated tar file to ensure it looks healthy
+6. Push changes:
    ```
    git add .
    git commit -m "Bump version to 1.1.0"

package.json

@@ -17,13 +17,13 @@
     "pretest": "npm run build",
     "test": "mocha -r ts-node/register tests/**/*.spec.ts",
     "test:watch": "npm run test -- --watch",
-    "benchmark": "docker-compose -f ./src/benchmark/docker-compose.yml up --build",
     "lint": "eslint . --cache",
     "lint:fix": "eslint . --fix",
     "format": "prettier . --write",
     "prepublishOnly": "npm run lint && npm test",
     "prepare": "husky",
-    "translate": "ts-node src/scripts/translate.ts"
+    "translate": "docker-compose -f ./src/tools/translate/docker-compose.yml up -d && ts-node ./src/tools/translate/translate.ts && docker-compose -f ./src/tools/translate/docker-compose.yml down",
+    "benchmark": "docker-compose -f ./src/tools/benchmark/docker-compose.yml up --build"
   },
   "repository": {
     "type": "git",

src/benchmark/Dockerfile

@@ -0,0 +1,11 @@
+FROM node:20.17-alpine3.19
+
+WORKDIR /app
+
+COPY ../../../package*.json ./
+
+RUN npm install
+
+COPY ../../../ ./
+
+CMD ["npx", "ts-node", "src/tools/benchmark/benchmark.ts"]

src/tools/benchmark/Dockerfile

@@ -15,7 +15,7 @@ import * as path from "path";
 import { Suite, Event } from "benchmark";
 
 import { VersionData, TestData } from "./benchmark-interfaces";
-import { Profanity, CensorType } from "..";
+import { Profanity, CensorType } from "../../";
 
 const TEST_VERSION: number = 1;
 

src/benchmark/benchmark-interfaces.ts …/tools/benchmark/benchmark-interfaces.tssrc/benchmark/benchmark-interfaces.ts renamed to src/tools/benchmark/benchmark-interfaces.ts src/benchmark/benchmark-interfaces.ts renamed to src/tools/benchmark/benchmark-interfaces.ts

@@ -1,8 +1,8 @@
 services:
   benchmark:
     build:
-      context: ../..
-      dockerfile: ./src/benchmark/Dockerfile
+      context: ../../../
+      dockerfile: ./src/tools/benchmark/Dockerfile
     deploy:
       resources:
         limits:

src/benchmark/benchmark.ts src/tools/benchmark/benchmark.tssrc/benchmark/benchmark.ts renamed to src/tools/benchmark/benchmark.ts

@@ -8,6 +8,23 @@
 
 ### Benchmarks
 
+#### v3.1.1
+```
+benchmark-1  | Using test data: v1
+benchmark-1  | exists() - small clean text x 2,559,368 ops/sec ±2.95% (92 runs sampled)
+benchmark-1  | exists() - small profane text x 1,941,051 ops/sec ±5.64% (79 runs sampled)
+benchmark-1  | exists() - large clean text x 44,904 ops/sec ±5.60% (90 runs sampled)
+benchmark-1  | exists() - large profane text x 816,615 ops/sec ±0.74% (96 runs sampled)
+benchmark-1  | exists() - partial match, small profane text x 1,853,445 ops/sec ±28.20% (92 runs sampled)
+benchmark-1  | censor() - Word, small profane text x 1,559,873 ops/sec ±2.07% (94 runs sampled)
+benchmark-1  | censor() - FirstChar, small profane text x 1,548,998 ops/sec ±6.01% (96 runs sampled)
+benchmark-1  | censor() - FirstVowel, small profane text x 1,093,426 ops/sec ±5.54% (89 runs sampled)
+benchmark-1  | censor() - AllVowels, small profane text x 1,098,984 ops/sec ±0.64% (91 runs sampled)
+benchmark-1  | censor() - Word, large profane text x 1,633 ops/sec ±6.12% (91 runs sampled)
+benchmark-1  | censor() - partial match, Word, small profane text x 1,334,764 ops/sec ±5.43% (91 runs sampled)
+benchmark-1  | Fastest: exists() - small clean text
+```
+
 #### v3.0.1
 ```
 benchmark-1  | Using test data: v1