@danielhaim/titlecaser 1.2.62 → 1.2.64

package/README.md

@@ -83,12 +83,12 @@ console.log(output); // 'The Book of Life'
 
 ## Usage in the Browser
 
-The function can also be used in a browser environment by including the `titlecaser.amd.js` script in your HTML file:
+The function can also be used in a browser environment by including the `TitleCaser.amd.js` script in your HTML file:
 
 Here's an example of how to use the modulate function:
 
 ```html
-<script src="./path/to/titlecaser.amd.js"></script>
+<script src="./path/to/TitleCaser.amd.js"></script>
 ```
 
 After that, the `toTitleCase()` function can be accessed in your JavaScript code like this:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@danielhaim/titlecaser",
-  "version": "1.2.62",
+  "version": "1.2.64",
   "description": "Converts a string to title case with multiple style options, ability to ignore certain words, and handle acronyms",
   "keywords": [
     "title case",
@@ -44,11 +44,11 @@
   ],
   "scripts": {
     "build-docs": "cd docs && bundle install && bundle exec jekyll build",
-    "build-package": "webpack --mode production && terser dist/titlecaser.js -o dist/titlecaser.min.js",
+    "build": "npx webpack --mode production",
     "copy-package-to-docs": "cp -R dist/ docs/assets/js",
-    "release": "npm version patch && npm run build-package && npm run copy-package-to-docs && git add package.json package-lock.json dist/ docs/assets/js && git commit -m 'Bump version and build package for release' && git push",
+    "release": "npm version patch && npm run build && git add -A && git commit -m 'Release: v$(node -p \"require('./package.json').version\")' && git push && npm publish",
     "test": "jest",
-    "tree": "tree -I 'node_modules'"
+    "tree": "tree -a -I 'node_modules|.git'"
   },
   "devDependencies": {
     "@babel/cli": "^7.21.5",

package/src/TitleCaser.js

@@ -10,10 +10,18 @@ import { TitleCaserUtils } from "./TitleCaserUtils.js";
 export class TitleCaser {
   constructor(options = {}) {
     this.options = options;
+    this.debug = options.debug || false;
     this.wordReplacementsList = wordReplacementsList;
     this.correctPhraseCasingList = correctPhraseCasingList;
   }
 
+  log_warning(message) {
+    if (this.debug) {
+      console.warn(`Warning: ${message}`);
+    }
+  }
+
+
   toTitleCase(str) {
     try {
       // If input is empty, throw an error.
@@ -50,8 +58,8 @@ export class TitleCaser {
         replaceTermList.map((term) => [Object.keys(term)[0].toLowerCase(), Object.values(term)[0]]),
       );
 
-      // console.log(replaceTermsArray);
-      // console.log(this.wordReplacementsList);
+      this.log_warning(`replaceTermsArray: ${replaceTermsArray}`);
+      this.log_warning(`this.wordReplacementsList: ${this.wordReplacementsList}`);
 
       const map = {
         "&": "&",
@@ -125,25 +133,32 @@ export class TitleCaser {
               ? word.charAt(0).toUpperCase() + word.slice(1)
               : word.toLowerCase();
           case TitleCaserUtils.endsWithSymbol(word):
-            // console.log("ends with symbol: ", word);
+            this.log_warning(`Check if the word ends with a symbol: ${word}`);
             // If the word ends with a symbol, return the correct casing.
             const splitWord = word.split(/([.,\/#!$%\^&\*;:{}=\-_`~()?])/g);
-            // console.log(splitWord);
+            this.log_warning(`Splitting word at symbols, result: ${splitWord}`);
             // Process each part for correct casing
             const processedWords = splitWord.map((part) => {
+              this.log_warning(`Processing part: ${part}`);
               // Check if part is a symbol
               if (TitleCaserUtils.endsWithSymbol(part)) {
-                // console.log(part);
+                this.log_warning(`Part is a symbol: ${part}`);
                 return part;
               } else {
+                this.log_warning(`Part is a word: ${part}`);
                 // If it's a word, process it for correct casing
                 if (TitleCaserUtils.isWordInArray(part, correctTitleCasingList)) {
-                  return TitleCaserUtils.correctTerm(part, correctTitleCasingList);
+                  const correctedTerm = TitleCaserUtils.correctTerm(part, correctTitleCasingList);
+                  this.log_warning(`Word is in correctTitleCasingList, corrected term: ${correctedTerm}`);
+                  return correctedTerm;
                 } else if (replaceTermsArray.includes(part)) {
-                  return replaceTermObj[part];
+                  const replacement = replaceTermObj[part];
+                  this.log_warning(`Word is in replaceTermsArray, replacement: ${replacement}`);
+                  return replacement;
                 } else {
-                  // Apply the correct casing for words not in the list
-                  return part.charAt(0).toUpperCase() + part.slice(1).toLowerCase();
+                  const titledWord = part.charAt(0).toUpperCase() + part.slice(1).toLowerCase();
+                  this.log_warning(`Applying title casing to word: ${titledWord}`);
+                  return titledWord;
                 }
               }
             });
@@ -213,7 +228,7 @@ export class TitleCaser {
             } else {
               newWords[i] = "US" + punctuation;
             }
-          } else {
+        } else {
             if (punctuation === "") {
               newWords[i] = "Us";
             } else {
@@ -255,8 +270,7 @@ export class TitleCaser {
 
     this.options.wordReplacementsList = this.wordReplacementsList;
 
-    // Log the updated wordReplacementsList array
-    // console.log(this.wordReplacementsList);
+    this.log_warning(`Log the updated this.wordReplacementsList: ${this.wordReplacementsList}`);
   }
 
   addReplaceTerm(term, replacement) {
@@ -295,8 +309,7 @@ export class TitleCaser {
     // Update the replace terms option
     this.options.wordReplacementsList = this.wordReplacementsList;
 
-    // Log the updated wordReplacementsList array
-    // console.log(this.wordReplacementsList);
+    this.log_warning(`Log the updated this.wordReplacementsList: ${this.wordReplacementsList}`);
   }
 
   addExactPhraseReplacements(newPhrases) {
@@ -331,7 +344,7 @@ export class TitleCaser {
       }
     });
 
-    // console.log(this.correctPhraseCasingList);
+    this.log_warning(`Log the this.correctPhraseCasingList: ${this.correctPhraseCasingList}`);
   }
 
   setStyle(style) {

package/src/TitleCaserUtils.js

@@ -233,9 +233,6 @@ export class TitleCaserUtils {
         "the",
         "in",
         "to",
-        "from",
-        "against",
-        "with",
         "within",
         "towards",
         "into",