@danielhaim/titlecaser 1.2.53 → 1.2.56

package/README.md

@@ -28,8 +28,8 @@ Transform any text to proper title case format using popular style guides such a
     + [Basic Usage](#basic-usage)
     + [Customizing Word Replacements Method](#customizing-word-replacements-method)
     + [Customizing TitleCaser](#customizing-titlecaser)
-    + [TitleCaser With Default Word Replacement](#titlecaser-with-default-word-replacement)
-    + [TitleCaser With Possessive Noun and a Colon](#titlecaser-with-possessive-noun-and-a-colon)
+    + [TitleCaser with Default Word Replacement](#titlecaser-with-default-word-replacement)
+    + [TitleCaser with Possessive Noun and a Colon](#titlecaser-with-possessive-noun-and-a-colon)
   * [Build Process](#build-process)
   * [Test](#test)
   * [Resources](#resources)
@@ -130,6 +130,7 @@ function applyTitleCaseToH2Elements(options = { style: "apa" }) {
 
 applyTitleCaseToH2Elements();
 ```
+
 ## Options
 
 The `{options}` parameter is an object that contains the settings for the conversion process.
@@ -140,6 +141,7 @@ The `{options}` parameter is an object that contains the settings for the conver
 - `shortPrepositionsList` relates to the words that should be treated as short prepositions in title case.
 - `neverCapitalizedList` contains the words that should never be capitalized in title case.
 - `wordReplacementsList` is a map of terms that will be replaced during the title case conversion process.
+- `smartQuotes` boolean value that determines whether quotes should be replaced with smart quotes.
 
 ## Methods
 
@@ -147,6 +149,7 @@ The `{options}` parameter is an object that contains the settings for the conver
 - `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.
 - `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.
 
 ## Examples
 
@@ -200,7 +203,7 @@ const options = {
 // Instantiate a new TitleCaser object with the options
 const titleCaser = new TitleCaser(options);
 
-// Set the input string to test
+// Set the input string to be tested
 const input = "the basics of nodejs development with mongodb";
 
 // Set the expected output
@@ -210,7 +213,7 @@ const expectedOutput = "The Basics of Node.js Development with MongoDB";
 const actualOutput = titleCaser.toTitleCase(input);
 ```
 
-### TitleCaser With Default Word Replacement  
+### TitleCaser with Default Word Replacement  
 
 The example below demonstrates how to use the TitleCaser class to convert a string to a title case with AP style formatting, including hyphenated words and word/brand replacement.
 
@@ -220,7 +223,7 @@ import "./path/to/@danielhaim/titlecaser";
 // Instantiate a new TitleCaser object with AP style formatting
 const titleCaser = new TitleCaser({ style: 'ap' });
 
-// Set the input string to test
+// Set the input string to be tested
 const input = 'nodejs development on aws: an in-depth tutorial on server-side javascript deployment';
 
 // Set the expected output
@@ -230,7 +233,7 @@ const expectedOutput = 'Node.js Development on AWS: An In-depth Tutorial on Serv
 const actualOutput = titleCaser.toTitleCase(input);
 ```
 
-### TitleCaser With Possessive Noun and a Colon 
+### TitleCaser with Possessive Noun and a Colon 
 
 The example below demonstrates how to use the TitleCaser class to convert a string to title case with AP style formatting, including a possessive noun and a colon.
 
@@ -240,7 +243,7 @@ import "./path/to/@danielhaim/titlecaser";
 // Instantiate a new TitleCaser object with AP style formatting
 const titleCaser = new TitleCaser({ style: "ap" });
 
-// Set the input string to test
+// Set the input string to be tested
 const input = "the iphone's impact on modern communication: a sociolinguistic analysis";
 
 // Set the expected output
@@ -250,6 +253,29 @@ const expectedOutput = "The iPhone's Impact on Modern Communication: A Socioling
 const actualOutput = titleCaser.toTitleCase(input);
 ```
 
+### TitleCaser with Smart Quotes  
+
+The example below demonstrates how to use the TitleCaser with smart quotes.
+
+```js
+import "./path/to/@danielhaim/titlecaser";
+
+// Instantiate a new TitleCaser object with AP style formatting and smart quotes enabled
+const titleCaser = new TitleCaser({ 
+  style: 'ap',
+  smartQuotes: true
+});
+
+// Set the input string to be tested
+const input = '"Never underestimate the power O\' persistence,"';
+
+// Set the expected output
+const expectedOutput = '“Never Underestimate the Power O’ Persistence,”';
+
+// Call the toTitleCase method and store the result in actualOutput
+const actualOutput = titleCaser.toTitleCase(input);
+```
+
 ## Build Process
 
 ```bash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@danielhaim/titlecaser",
-  "version": "1.2.53",
+  "version": "1.2.56",
   "description": "Converts a string to title case with multiple style options, ability to ignore certain words, and handle acronyms",
   "keywords": [
     "title case",

package/src/TitleCaser.js

@@ -9,222 +9,228 @@ import {
 import { TitleCaserUtils } from "./TitleCaserUtils.js";
 
 export class TitleCaser {
-	constructor ( options = {} ) {
+	constructor(options = {}) {
 		this.options = options;
 		this.wordReplacementsList = wordReplacementsList;
 	}
-	
-	toTitleCase ( str ) {
+
+	toTitleCase(str) {
 		try {
 			// If input is empty, throw an error.
-			if ( str.trim ().length === 0 ) throw new TypeError ( "Invalid input: input must not be empty." );
-			
+			if (str.trim().length === 0) throw new TypeError("Invalid input: input must not be empty.");
+
 			// If input is not a string, throw an error.
-			if ( typeof str !== 'string' ) throw new TypeError ( "Invalid input: input must be a string." );
-			
+			if (typeof str !== 'string') throw new TypeError("Invalid input: input must be a string.");
+
 			// If options is not an object, throw an error.
-			if ( typeof this.options !== "undefined" && typeof this.options !== "object" ) throw new TypeError ( "Invalid options: options must be an object." );
-			
+			if (typeof this.options !== "undefined" && typeof this.options !== "object") throw new TypeError("Invalid options: options must be an object.");
+
 			const {
 				style = "ap",
 				neverCapitalize = [],
-				replaceTermList = wordReplacementsList
+				replaceTermList = wordReplacementsList,
+				smartQuotes = false  // Set to false by default
 			} = this.options;
-			const ignoreList = [ "nl2br", ...neverCapitalize ];
+
+
+			const ignoreList = ["nl2br", ...neverCapitalize];
 			const {
 				articlesList,
 				shortConjunctionsList,
 				shortPrepositionsList,
 				neverCapitalizedList,
-				replaceTerms
-			} = TitleCaserUtils.getTitleCaseOptions ( this.options, commonAbbreviationList, wordReplacementsList );
-			
+				replaceTerms,
+				smartQuotes: mergedSmartQuotes  // Rename for clarity
+			} = TitleCaserUtils.getTitleCaseOptions(this.options, commonAbbreviationList, wordReplacementsList);
+
 			// Prerocess the replaceTerms array to make it easier to search for.
-			const replaceTermsArray = replaceTermList.map ( term => Object.keys ( term )[0].toLowerCase () );
+			const replaceTermsArray = replaceTermList.map(term => Object.keys(term)[0].toLowerCase());
 			// Create an object from the replaceTerms array to make it easier to search for.
-			const replaceTermObj = Object.fromEntries ( replaceTermList.map (
-				term => [ Object.keys ( term )[0].toLowerCase (), Object.values ( term )[0] ]
-			) );
-			
+			const replaceTermObj = Object.fromEntries(replaceTermList.map(
+				term => [Object.keys(term)[0].toLowerCase(), Object.values(term)[0]]
+			));
+
 			const map = {
 				'&': '&',
 				'<': '&lt;',
 				'>': '&gt;',
+				// '\u2018': '\u2019', // Smart single quote
+				// '\u201C': '\u201D', // Smart double quote
 				'"': '&quot;',
 				"'": '&#039;'
 			};
-			
+
 			// Remove extra spaces and replace <br> tags with a placeholder.
-			let inputString = str.trim ();
-			
+			let inputString = str.trim();
+
 			// Replace <br> and <br /> tags with a placeholder.
 			inputString = inputString.replace(/<\s*br\s*\/?\s*>/gi, " nl2br ");
 
 			// Remove extra spaces and replace <br> tags with a placeholder.
-			inputString = inputString.replace ( / {2,}/g, ( match ) => match.slice ( 0, 1 ) );
-			
-
-			// console.log(inputString);
+			inputString = inputString.replace(/ {2,}/g, (match) => match.slice(0, 1));
 
 
 			// Split the string into an array of words.
-			const words = inputString.split ( " " );
-			
-			const wordsInTitleCase = words.map ( ( word, i ) => {
+			const words = inputString.split(" ");
+
+			const wordsInTitleCase = words.map((word, i) => {
 				switch (true) {
-					case TitleCaserUtils.isWordAmpersand ( word ):
+					case TitleCaserUtils.isWordAmpersand(word):
 						// if the word is an ampersand, return it as is.
 						return word;
-					case TitleCaserUtils.hasHtmlBreak ( word ):
+					case TitleCaserUtils.hasHtmlBreak(word):
 						// If the word is a <br> tag, return it as is.
 						return word;
-					case TitleCaserUtils.isWordIgnored ( word, ignoreList ):
+					case TitleCaserUtils.isWordIgnored(word, ignoreList):
 						// If the word is in the ignore list, return it as is.
 						return word;
-					case replaceTermsArray.includes ( word.toLowerCase () ):
+					case replaceTermsArray.includes(word.toLowerCase()):
 						// If the word is in the replaceTerms array, return the replacement.
-						return replaceTermObj[word.toLowerCase ()];
-					case TitleCaserUtils.isWordInArray ( word, correctTitleCasingList ):
+						return replaceTermObj[word.toLowerCase()];
+					case TitleCaserUtils.isWordInArray(word, correctTitleCasingList):
 						// If the word is in the correctTitleCasingList array, return the correct casing.
-						return TitleCaserUtils.correctTerm ( word, correctTitleCasingList );
-					case TitleCaserUtils.hasSuffix ( word, style ):
+						return TitleCaserUtils.correctTerm(word, correctTitleCasingList);
+					case TitleCaserUtils.hasSuffix(word, style):
 						// If the word has a suffix, return the correct casing.
-						return TitleCaserUtils.correctSuffix ( word, correctTitleCasingList );
-					case TitleCaserUtils.hasHyphen ( word ):
+						return TitleCaserUtils.correctSuffix(word, correctTitleCasingList);
+					case TitleCaserUtils.hasHyphen(word):
 						// If the word has a hyphen, return the correct casing.
-						return TitleCaserUtils.correctTermHyphenated ( word, style );
-					case TitleCaserUtils.hasUppercaseIntentional ( word ):
+						return TitleCaserUtils.correctTermHyphenated(word, style);
+					case TitleCaserUtils.hasUppercaseIntentional(word):
 						// If the word has an intentional uppercase letter, return the correct casing.
 						return word;
-					case TitleCaserUtils.isShortWord ( word, style ) && i !== 0:
+					case TitleCaserUtils.isShortWord(word, style) && i !== 0:
 						// If the word is a short word, return the correct casing.
-						return (i > 0 && TitleCaserUtils.endsWithSymbol ( words[i - 1],
-							[ ':', '?', '!', '.' ] )) ? word.charAt ( 0 ).toUpperCase () + word.slice ( 1 ) : word.toLowerCase ();
-					case TitleCaserUtils.endsWithSymbol ( word ):
+						return (i > 0 && TitleCaserUtils.endsWithSymbol(words[i - 1],
+							[':', '?', '!', '.'])) ? word.charAt(0).toUpperCase() + word.slice(1) : word.toLowerCase();
+					case TitleCaserUtils.endsWithSymbol(word):
 						// If the word ends with a symbol, return the correct casing.
-						const splitWord = word.split ( /([.,\/#!$%\^&\*;:{}=\-_`~()])/g );
-						const processedWords = splitWord.map ( ( splitWord, j ) => {
+						const splitWord = word.split(/([.,\/#!$%\^&\*;:{}=\-_`~()])/g);
+						const processedWords = splitWord.map((splitWord, j) => {
 							// If the word is in the correctTitleCasingList array, return the correct casing.
-							if ( TitleCaserUtils.isWordInArray ( splitWord, correctTitleCasingList ) ) return TitleCaserUtils.correctTerm ( splitWord, correctTitleCasingList );
+							if (TitleCaserUtils.isWordInArray(splitWord, correctTitleCasingList)) return TitleCaserUtils.correctTerm(splitWord, correctTitleCasingList);
 							// Else return the word with the correct casing.
-							else return (j > 0 && TitleCaserUtils.endsWithSymbol ( splitWord )) ? splitWord.charAt ( 0 )
-								.toUpperCase () + splitWord.slice ( 1 ) : splitWord.charAt ( 0 )
-								.toUpperCase () + splitWord.slice ( 1 );
-						} );
+							else return (j > 0 && TitleCaserUtils.endsWithSymbol(splitWord)) ? splitWord.charAt(0)
+								.toUpperCase() + splitWord.slice(1) : splitWord.charAt(0)
+									.toUpperCase() + splitWord.slice(1);
+						});
 						// Join the processed words and return them.
-						return processedWords.join ( "" );
-					case TitleCaserUtils.startsWithSymbol ( word ):
+						return processedWords.join("");
+					case TitleCaserUtils.startsWithSymbol(word):
 						// If the word starts with a symbol, return the correct casing.
-						return !TitleCaserUtils.isWordInArray ( word, correctTitleCasingList ) ? word : TitleCaserUtils.correctTerm ( word );
-					case TitleCaserUtils.hasRomanNumeral ( word ):
+						return !TitleCaserUtils.isWordInArray(word, correctTitleCasingList) ? word : TitleCaserUtils.correctTerm(word);
+					case TitleCaserUtils.hasRomanNumeral(word):
 						// If the word has a roman numeral, return the correct casing.
-						return word.toUpperCase ();
-					case TitleCaserUtils.hasNumbers ( word ):
+						return word.toUpperCase();
+					case TitleCaserUtils.hasNumbers(word):
 						// If the word has numbers, return the correct casing.
 						return word;
-								default:
+					default:
 						// Default to returning the word with the correct casing.
-						return word.charAt ( 0 )
-							.toUpperCase () + word.slice ( 1 )
-							.toLowerCase ();
+						return word.charAt(0)
+							.toUpperCase() + word.slice(1)
+								.toLowerCase();
 				}
-			} );
-			
+			});
+
 			// Join the words in the array into a string.
-			inputString = wordsInTitleCase.join ( " " );
-			
-			for ( const phrase of correctPhraseCasingList ) {
+			inputString = wordsInTitleCase.join(" ");
+
+			for (const phrase of correctPhraseCasingList) {
 				// If the phrase is in the input string, replace it with the correct casing.
-				if ( inputString.toLowerCase ()
-					.includes ( phrase.toLowerCase () ) ) {
-					inputString = inputString.replace ( new RegExp ( phrase, 'gi' ), phrase );
+				if (inputString.toLowerCase()
+					.includes(phrase.toLowerCase())) {
+					inputString = inputString.replace(new RegExp(phrase, 'gi'), phrase);
 				}
 			}
-			
+
 			// Replace the nl2br placeholder with <br> tags.
 			inputString = inputString.replace(/nl2br/gi, "<br />");
-			
-			// BEFORE WE RETURN THE STRING
-			// CHECK THE LAST WORD AND IF IT IS INTENTIONALLY UPPERCASED, IF IT IS, RETURN THE STRING.
+
+			// Convert quotation marks to smart quotes if enabled
+			// Refer to: https://github.com/danielhaim1/TitleCaser/issues/4
+			if (smartQuotes) {
+				inputString = TitleCaserUtils.convertQuotesToCurly(inputString);
+			}
 
 			// Return the string.
 			return inputString;
-		} catch ( error ) {
-			throw new Error ( error );
+		} catch (error) {
+			throw new Error(error);
 		}
 	}
-	
-	setReplaceTerms ( terms ) {
-		if ( typeof terms !== 'object' ) {
-			throw new TypeError ( 'Invalid argument: replace terms must be an object.' );
+
+	setReplaceTerms(terms) {
+		if (typeof terms !== 'object') {
+			throw new TypeError('Invalid argument: replace terms must be an object.');
 		}
-		
+
 		// Add the new replace terms to the wordReplacementsList array
-		Object.entries ( terms ).forEach ( ( [ term, replacement ] ) => {
-			const index = wordReplacementsList.findIndex ( obj => obj[term] );
-			if ( index !== -1 ) {
+		Object.entries(terms).forEach(([term, replacement]) => {
+			const index = wordReplacementsList.findIndex(obj => obj[term]);
+			if (index !== -1) {
 				// If the term already exists in the array, update the replacement value
 				wordReplacementsList[index][term] = replacement;
 			} else {
 				// If the term doesn't exist in the array, add a new object with the term and replacement
-				wordReplacementsList.push ( { [term]: replacement } );
+				wordReplacementsList.push({ [term]: replacement });
 			}
-		} );
-		
+		});
+
 		// Log the updated wordReplacementsList array
 		// console.log(wordReplacementsList);
-		
+
 		// Update the replace terms option
 		this.options.wordReplacementsList = wordReplacementsList;
 	}
-	
-	addReplaceTerm ( term, replacement ) {
-		if ( typeof term !== 'string' || typeof replacement !== 'string' ) {
-			throw new TypeError ( 'Invalid argument: term and replacement must be strings.' );
+
+	addReplaceTerm(term, replacement) {
+		if (typeof term !== 'string' || typeof replacement !== 'string') {
+			throw new TypeError('Invalid argument: term and replacement must be strings.');
 		}
-		
-		const index = this.wordReplacementsList.findIndex ( obj => obj[term] );
-		
-		if ( index !== -1 ) {
+
+		const index = this.wordReplacementsList.findIndex(obj => obj[term]);
+
+		if (index !== -1) {
 			// If the term already exists in the array, update the replacement value
 			this.wordReplacementsList[index][term] = replacement;
 		} else {
 			// If the term doesn't exist in the array, add a new object with the term and replacement
-			this.wordReplacementsList.push ( { [term]: replacement } );
+			this.wordReplacementsList.push({ [term]: replacement });
 		}
-		
+
 		// Update the replace terms option
 		this.options.wordReplacementsList = this.wordReplacementsList;
 	}
-	
-	removeReplaceTerm ( term ) {
-		if ( typeof term !== 'string' ) {
-			throw new TypeError ( 'Invalid argument: term must be a string.' );
+
+	removeReplaceTerm(term) {
+		if (typeof term !== 'string') {
+			throw new TypeError('Invalid argument: term must be a string.');
 		}
-		
+
 		// Find the index of the term in the wordReplacementsList array
-		const index = this.wordReplacementsList.findIndex ( obj => Object.keys ( obj )[0] === term );
-		
+		const index = this.wordReplacementsList.findIndex(obj => Object.keys(obj)[0] === term);
+
 		// If the term is not found in the array, throw an error
-		if ( index === -1 ) {
-			throw new Error ( `Term '${ term }' not found in word replacements list.` );
+		if (index === -1) {
+			throw new Error(`Term '${term}' not found in word replacements list.`);
 		}
-		
+
 		// Remove the term from the array
-		this.wordReplacementsList.splice ( index, 1 );
-		
+		this.wordReplacementsList.splice(index, 1);
+
 		// Log the updated wordReplacementsList array
 		// console.log(this.wordReplacementsList);
-		
+
 		// Update the replace terms option
 		this.options.wordReplacementsList = this.wordReplacementsList;
 	}
-	
-	setStyle ( style ) {
-		if ( typeof style !== 'string' ) {
-			throw new TypeError ( 'Invalid argument: style must be a string.' );
+
+	setStyle(style) {
+		if (typeof style !== 'string') {
+			throw new TypeError('Invalid argument: style must be a string.');
 		}
-		
+
 		this.options.style = style;
 	}
 }