@danielhaim/titlecaser 1.2.57 → 1.2.59

package/README.md

@@ -145,9 +145,10 @@ The `{options}` parameter is an object that contains the settings for the conver
 
 ## Methods
 
-- `setReplaceTerms(terms: object)`: Sets word replacement terms to be used during title casing. Multiple calls can be made to add or update multiple word replacements.
-- `removeReplaceTerm(term: string)`: Removes a replaced term from the `wordReplacementsList` array in the option object of the `TitleCaser` instance. Throws an error if the term is not found in the array, otherwise removes it from the array and updates the option object.
-- `addReplaceTerm(term: string, replacement: string)`: Adds a new term to the `wordReplacementsList` array in the options object of the TitleCaser instance. The method takes two string arguments: term specifies the word to be replaced, and replacement specifies the replacement for the word. If the term already exists in the array, the method updates its replacement value. Otherwise, it adds a new object with the term and replacement to the array. The method then updates the wordReplacementsList property in the object.
+- `setReplaceTerms(terms)`: Updates the `wordReplacementsList` with new term-replacement pairs. It accepts an array of objects, each containing a single key-value pair representing the term and its replacement.
+- `removeReplaceTerm(term)`: Removes a replaced term from the `wordReplacementsList` array in the option object of the `TitleCaser` instance. Throws an error if the term is not found in the array, otherwise removes it from the array and updates the option object.
+- `addReplaceTerm(term, replacement)`: Adds a single term-replacement pair to the `wordReplacementsList`. If the term already exists, it updates the replacement value.
+- `addExactPhraseReplacements(newPhrases)` - This method allows adding an array of exact phrase replacements to the `TitleCaser` class. Each item in the array should be an object with a single key-value pair, where the key is the phrase to be replaced and the value is the desired replacement.
 - `setStyle(style: string)`: Sets the style option in the object of the TitleCaser instance. The method takes a string argument style that specifies the style to use for the title casing. If the argument is not a string, the method throws a TypeError. Otherwise, it updates the style option in the object.
 - `smartQuotes(smartQuotes: boolean)`: Specifies whether to replace straight quotes with smart quotes during title casing. Provide a boolean argument smartQuotes to enable or disable this feature.
 
@@ -292,43 +293,65 @@ $ npm run test
 ```
 
 ```bash  
+Testing Acronym/Pronoun of Alpha2/3 Country Codes
+✓ Capitalizes country code "US" correctly in a geopolitical context (4 ms)
+✓ Does not capitalize "us" when used as a pronoun (2 ms)
+✓ Capitalizes country code "UK" with preceding indicator and trailing comma (2 ms)
+✓ Handles multiple instances of country codes and pronouns (2 ms)
+✓ Does not capitalize "us" when used in common phrases (2 ms)
+✓ Capitalizes "USA" in a formal context (1 ms)
+✓ Capitalizes "US" before a government-related word (1 ms)
+✓ Does not capitalize "us" before a government-related word (1 ms)
+✓ Capitalizes "UK" with preceding indicator before a government-related word (2 ms)
+✓ Handles multiple instances of country codes and pronouns before government-related words (1 ms)
+✓ Capitalizes "US" before a military-related word (1 ms)
+✓ Does not capitalize "us" before a military-related word (1 ms)
+✓ Capitalizes "UK" with preceding indicator before a territory-related word (2 ms)
+✓ Handles multiple instances of country codes and pronouns before talks-related words (3 ms)
+✓ Does not capitalize "us" before a talks-related word (1 ms)
+✓ Capitalizes "USA" in a formal context before a bill-related word (1 ms)
+✓ Handles multiple instances of country codes and pronouns before a bill-related word (2 ms)
+
 Test Basic Options
 ✓ Default title case conversion
-✓ Customized title case conversion
-✓ AP-style title case conversion with replacements
-✓ AP-style title case conversion with replacements
-✓ Capitalize suffix word in sentence
+✓ Customized title case conversion (1 ms)
+✓ AP-style title case conversion with replacements (3 ms)
+✓ Testing Word Replacement (Kellogs -> Kellogg\'s)
+✓ AP-style title case conversion with replacements (1 ms)
+✓ Capitalize suffix word in sentence (1 ms)
 
 Test Methods
-✓ removeReplaceTerm
-✓ setReplaceTerms
+✓ removeReplaceTerm (1 ms)
+✓ setReplaceTerms (1 ms)
 
 Test Variation Stability
-✓ Hyphenated, colon, and short word replacements
 ✓ Capitalization and word replacements
-✓ AP-style title case with possessive and colon
+✓ AP-style title case with possessive and colon (1 ms)
 ✓ AP-style title case with lowercase back/front-end terms
-✓ Chicago style title case with comparison and colon
-✓ APA style title case with colon
-✓ Wikipedia style title case with acronym and hyphen
-✓ APA style title case with colon and apostrophe
+✓ Chicago style title case with comparison and colon (1 ms)
+✓ APA style title case with colon (2 ms)
+✓ Wikipedia style title case with acronym and hyphen (1 ms)
+✓ Hyphenated, colon, and short word replacements (2 ms)
+✓ I Love Connecting with My Online Friends, but Sometimes I Prefer to Hang Out with My Friends IRL (2 ms)
+✓ Test Smart Quotes (1 ms)
+✓ Wikipedia style capitalization test with special term and colon (1 ms)
+✓ APA style title case with colon and apostrophe (2 ms)
 ✓ Chicago style title case with custom term replacements
-✓ AP-style capitalization test with special terms and colon
-✓ NYT-style capitalization test with special terms and colon
-✓ APA style capitalization test with short conjunction terms and colon
-✓ Correct phrase casing list testing
-✓ Wikipedia style capitalization test with special term and colon
+✓ AP-style capitalization test with special terms and colon (1 ms)
+✓ NYT-style capitalization test with special terms and colon (1 ms)
+✓ APA style capitalization test with short conjunction terms and colon (2 ms)
+✓ Correct phrase casing list testing (1 ms)
 
 Test Reserved Words
-✓ Reserved word
-✓ Reserved word with colon
-✓ Reserved word, posessive
-✓ Hyphenated reserved word
-✓ Hyphenated reserved word, possessive
-✓ HTML line break nl2br, <br /> tag
-✓ HTML line break nl2br, <br /> tag
-✓ HTML line break nl2br, <br /> tag
-✓ Ampersand in a sentence should return & and not &Amp;
+✓ Title case transformation for a single reserved word
+✓ Title case transformation for a sentence with a reserved word and colon (1 ms)
+✓ Title case transformation for a reserved word with a possessive form (1 ms)
+✓ Title case transformation for specific brand names
+✓ Title case transformation for a sentence with HTML line break (nl2br) using <br> tag (1 ms)
+✓ Title case transformation for a sentence with untrimmed white spaces
+✓ Title case transformation for a sentence with HTML line break (nl2br) using <br> tag (1 ms)
+✓ Title case transformation for a sentence with HTML line break (nl2br) without space after colon using <br> tag (1 ms)
+✓ Ampersand in a sentence should return & and not &Amp; (1 ms)
 ✓ Untrimmed white spaces
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@danielhaim/titlecaser",
-  "version": "1.2.57",
+  "version": "1.2.59",
   "description": "Converts a string to title case with multiple style options, ability to ignore certain words, and handle acronyms",
   "keywords": [
     "title case",
@@ -67,8 +67,8 @@
     "jest-environment-jsdom": "^29.5.0",
     "jest-environment-puppeteer": "^9.0.0",
     "jest-puppeteer": "^9.0.0",
-    "puppeteer": "^20.5.0",
-    "puppeteer-core": "^20.5.0",
+    "puppeteer": "^21.5.2",
+    "puppeteer-core": "^21.5.2",
     "terser-webpack-plugin": "^5.3.9",
     "webpack": "^5.86.0",
     "webpack-cli": "^5.1.4",