@danielhaim/titlecaser 1.5.0 → 1.6.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@danielhaim/titlecaser",
-  "version": "1.5.0",
+  "version": "1.6.1",
   "description": "Converts a string to title case with multiple style options, ability to ignore certain words, and handle acronyms",
   "keywords": [
     "title case",
@@ -43,8 +43,8 @@
     "package.json"
   ],
   "scripts": {
-    "build-docs": "cd docs && bundle install && bundle exec jekyll build",
     "build": "npx webpack --mode production && cp -R dist/ docs/assets/js",
+    "build-docs": "cd docs && bundle install && bundle exec jekyll build",
     "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",
     "release-major": "npm version major && npm run build && git add -A && git commit -m 'Major Release: v$(node -p \"require('./package.json').version\")' && git push && npm publish",
     "release-minor": "npm version minor && npm run build && git add -A && git commit -m 'Minor Release: v$(node -p \"require('./package.json').version\")' && git push && npm publish",

package/src/TitleCaser.js

@@ -15,13 +15,12 @@ export class TitleCaser {
     this.correctPhraseCasingList = correctPhraseCasingList;
   }
 
-  log_warning(message) {
+  logWarning(message) {
     if (this.debug) {
       console.warn(`Warning: ${message}`);
     }
   }
 
-
   toTitleCase(str) {
     try {
       // If input is empty, throw an error.
@@ -58,8 +57,8 @@ export class TitleCaser {
         replaceTermList.map((term) => [Object.keys(term)[0].toLowerCase(), Object.values(term)[0]]),
       );
 
-      this.log_warning(`replaceTermsArray: ${replaceTermsArray}`);
-      this.log_warning(`this.wordReplacementsList: ${this.wordReplacementsList}`);
+      this.logWarning(`replaceTermsArray: ${replaceTermsArray}`);
+      this.logWarning(`this.wordReplacementsList: ${this.wordReplacementsList}`);
 
       const map = {
         "&": "&",
@@ -133,31 +132,31 @@ export class TitleCaser {
               ? word.charAt(0).toUpperCase() + word.slice(1)
               : word.toLowerCase();
           case TitleCaserUtils.endsWithSymbol(word):
-            this.log_warning(`Check if the word ends with a symbol: ${word}`);
+            this.logWarning(`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);
-            this.log_warning(`Splitting word at symbols, result: ${splitWord}`);
+            this.logWarning(`Splitting word at symbols, result: ${splitWord}`);
             // Process each part for correct casing
             const processedWords = splitWord.map((part) => {
-              this.log_warning(`Processing part: ${part}`);
+              this.logWarning(`Processing part: ${part}`);
               // Check if part is a symbol
               if (TitleCaserUtils.endsWithSymbol(part)) {
-                this.log_warning(`Part is a symbol: ${part}`);
+                this.logWarning(`Part is a symbol: ${part}`);
                 return part;
               } else {
-                this.log_warning(`Part is a word: ${part}`);
+                this.logWarning(`Part is a word: ${part}`);
                 // If it's a word, process it for correct casing
                 if (TitleCaserUtils.isWordInArray(part, correctTitleCasingList)) {
                   const correctedTerm = TitleCaserUtils.correctTerm(part, correctTitleCasingList);
-                  this.log_warning(`Word is in correctTitleCasingList, corrected term: ${correctedTerm}`);
+                  this.logWarning(`Word is in correctTitleCasingList, corrected term: ${correctedTerm}`);
                   return correctedTerm;
                 } else if (replaceTermsArray.includes(part)) {
                   const replacement = replaceTermObj[part];
-                  this.log_warning(`Word is in replaceTermsArray, replacement: ${replacement}`);
+                  this.logWarning(`Word is in replaceTermsArray, replacement: ${replacement}`);
                   return replacement;
                 } else {
                   const titledWord = part.charAt(0).toUpperCase() + part.slice(1).toLowerCase();
-                  this.log_warning(`Applying title casing to word: ${titledWord}`);
+                  this.logWarning(`Applying title casing to word: ${titledWord}`);
                   return titledWord;
                 }
               }
@@ -270,7 +269,7 @@ export class TitleCaser {
 
     this.options.wordReplacementsList = this.wordReplacementsList;
 
-    this.log_warning(`Log the updated this.wordReplacementsList: ${this.wordReplacementsList}`);
+    this.logWarning(`Log the updated this.wordReplacementsList: ${this.wordReplacementsList}`);
   }
 
   addReplaceTerm(term, replacement) {
@@ -308,7 +307,7 @@ export class TitleCaser {
     // Update the replace terms option
     this.options.wordReplacementsList = this.wordReplacementsList;
 
-    this.log_warning(`Log the updated this.wordReplacementsList: ${this.wordReplacementsList}`);
+    this.logWarning(`Log the updated this.wordReplacementsList: ${this.wordReplacementsList}`);
   }
 
   addExactPhraseReplacements(newPhrases) {
@@ -343,7 +342,7 @@ export class TitleCaser {
       }
     });
 
-    this.log_warning(`Log the this.correctPhraseCasingList: ${this.correctPhraseCasingList}`);
+    this.logWarning(`Log the this.correctPhraseCasingList: ${this.correctPhraseCasingList}`);
   }
 
   setStyle(style) {

package/src/TitleCaserConsts.js

@@ -68,6 +68,7 @@ export const wordReplacementsList = [
   { "a.s.a.p": "ASAP" },
   { "f.a.q": "FAQ" },
   { "f.a.q.s": "FAQs" },
+  { "FAQS": "FAQs" },
   { "f.y.i": "FYI" },
   { "d.i.y": "DIY" },
   { "t.b.d": "TBD" },
@@ -80,7 +81,7 @@ export const wordReplacementsList = [
   { "reactjs": "React" },
   { "react.js": "React" },
   { "cyber-security": "Cybersecurity" },
-  // { 'twitter': '𝕏' }
+  // { 'twitter': 'Twitter, formerly known as 𝕏' }
 ];
 
 export const titleCaseStylesList = Object.freeze({

package/src/TitleCaserUtils.js

@@ -219,9 +219,14 @@ export class TitleCaserUtils {
       return /[A-Z]/.test(word.slice(1));
     }
 
-    return /[A-Z]/.test(word.slice(1)) && /[a-z]/.test(word.slice(0, -1));
+    const hasUppercase = /[A-Z]/.test(word.slice(1));
+    const hasLowercase = /[a-z]/.test(word.slice(1));
+
+    return hasUppercase && hasLowercase;
   }
 
+  // Check if a word is an acronym
+  // (i.e. 'the', 'to', 'within')
   static isAcronym(word, prevWord, nextWord) {
     try {
       if (typeof word !== "string") {
@@ -539,6 +544,7 @@ export class TitleCaserUtils {
     });
   }
 
+  // Check if there's an unescaped special character
   static unescapeSpecialCharacters(str) {
     return str.replace(/&|<|>|"|'/g, function (match) {
       switch (match) {