@danielhaim/titlecaser 1.2.49 → 1.2.54

package/README.md

@@ -13,7 +13,9 @@ Transform any text to proper title case format using popular style guides such a
 ## Table of Contents
 
 - [TitleCaser](#titlecaser)
-  * [Demo](#demo)
+  * [Demo](https://danielhaim1.github.io/TitleCaser/)
+  * [CodePen Demo 1](https://codepen.io/danielhaim/pen/oNQgjBv)
+  * [CodePen Demo 2](https://codepen.io/danielhaim/pen/oNPGzKw)
   * [Table of Contents](#table-of-contents)
   * [Introduction](#introduction)
   * [Key Features:](#key-features)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@danielhaim/titlecaser",
-  "version": "1.2.49",
+  "version": "1.2.54",
   "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

@@ -28,15 +28,19 @@ export class TitleCaser {
 			const {
 				style = "ap",
 				neverCapitalize = [],
-				replaceTermList = wordReplacementsList
+				replaceTermList = wordReplacementsList,
+			    smartQuotes = false  // Set to false by default
 			} = this.options;
+
+
 			const ignoreList = [ "nl2br", ...neverCapitalize ];
 			const {
 				articlesList,
 				shortConjunctionsList,
 				shortPrepositionsList,
 				neverCapitalizedList,
-				replaceTerms
+				replaceTerms,
+	            smartQuotes: mergedSmartQuotes  // Rename for clarity
 			} = TitleCaserUtils.getTitleCaseOptions ( this.options, commonAbbreviationList, wordReplacementsList );
 			
 			// Prerocess the replaceTerms array to make it easier to search for.
@@ -50,21 +54,20 @@ export class TitleCaser {
 				'&': '&',
 				'<': '&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 ();
-			
+
 			// 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);
 
 
 			// Split the string into an array of words.
@@ -122,7 +125,7 @@ export class TitleCaser {
 					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 )
@@ -143,6 +146,12 @@ export class TitleCaser {
 			
 			// Replace the nl2br placeholder with <br> tags.
 			inputString = inputString.replace(/nl2br/gi, "<br />");
+
+			// 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;

package/src/TitleCaserConsts.js

@@ -9,7 +9,40 @@ export const correctTitleCasingList = [
 	'MobX', 'SCSS', 'TypeScript', 'Vue.js', '.NET', 'ASP', 'ASPX',
 	'MySQL', 'PHP', 'PostgresQL', 'Python', 'SQL', 'GraphQL',
 	'HTML5',
-	
+
+    // Countries
+    'Afghanistan', 'Albania', 'Algeria', 'Andorra', 'Angola', 'Antigua and Barbuda',
+    'Argentina', 'Armenia', 'Australia', 'Austria', 'Azerbaijan', 'Bahamas',
+    'Bahrain', 'Bangladesh', 'Barbados', 'Belarus', 'Belgium', 'Belize', 'Benin',
+    'Bhutan', 'Bolivia', 'Bosnia and Herzegovina', 'Botswana', 'Brazil', 'Brunei',
+    'Bulgaria', 'Burkina Faso', 'Burundi', 'Cabo Verde', 'Cambodia', 'Cameroon',
+    'Canada', 'Central African Republic', 'Chad', 'Chile', 'China', 'Colombia',
+    'Comoros', 'Congo', 'Costa Rica', 'Cote d\'Ivoire', 'Croatia', 'Cuba',
+    'Cyprus', 'Czech Republic', 'Denmark', 'Djibouti', 'Dominica',
+    'Dominican Republic', 'Ecuador', 'Egypt', 'El Salvador', 'Equatorial Guinea',
+    'Eritrea', 'Estonia', 'Eswatini', 'Ethiopia', 'Fiji', 'Finland', 'France',
+    'Gabon', 'Gambia', 'Georgia', 'Germany', 'Ghana', 'Greece', 'Grenada',
+    'Guatemala', 'Guinea', 'Guinea-Bissau', 'Guyana', 'Haiti', 'Honduras', 'Hungary',
+    'Iceland', 'India', 'Indonesia', 'Iran', 'Iraq', 'Ireland', 'Israel', 'Italy',
+    'Jamaica', 'Japan', 'Jordan', 'Kazakhstan', 'Kenya', 'Kiribati', 'Korea',
+    'Kosovo', 'Kuwait', 'Kyrgyzstan', 'Laos', 'Latvia', 'Lebanon', 'Lesotho',
+    'Liberia', 'Libya', 'Liechtenstein', 'Lithuania', 'Luxembourg', 'Madagascar',
+    'Malawi', 'Malaysia', 'Maldives', 'Mali', 'Malta', 'Marshall Islands',
+    'Mauritania', 'Mauritius', 'Mexico', 'Micronesia', 'Moldova', 'Monaco',
+    'Mongolia', 'Montenegro', 'Morocco', 'Mozambique', 'Myanmar', 'Namibia',
+    'Nauru', 'Nepal', 'Netherlands', 'New Zealand', 'Nicaragua', 'Niger', 'Nigeria',
+    'North Macedonia', 'Norway', 'Oman', 'Pakistan', 'Palau', 'Panama', 'Papua New Guinea',
+    'Paraguay', 'Peru', 'Philippines', 'Poland', 'Portugal', 'Qatar', 'Romania',
+    'Russia', 'Rwanda', 'Saint Kitts and Nevis', 'Saint Lucia', 'Saint Vincent and the Grenadines',
+    'Samoa', 'San Marino', 'Sao Tome and Principe', 'Saudi Arabia', 'Senegal', 'Serbia',
+    'Seychelles', 'Sierra Leone', 'Singapore', 'Slovakia', 'Slovenia', 'Solomon Islands',
+    'Somalia', 'South Africa', 'South Korea', 'South Sudan', 'Spain', 'Sri Lanka', 'Sudan',
+    'Suriname', 'Sweden', 'Switzerland', 'Syria', 'Taiwan', 'Tajikistan', 'Tanzania',
+    'Thailand', 'Timor-Leste', 'Togo', 'Tonga', 'Trinidad and Tobago', 'Tunisia',
+    'Turkey', 'Turkmenistan', 'Tuvalu', 'Uganda', 'Ukraine', 'United Arab Emirates',
+    'United Kingdom', 'United States', 'Uruguay', 'Uzbekistan', 'Vanuatu', 'Vatican City',
+    'Venezuela', 'Vietnam', 'Yemen', 'Zambia', 'Zimbabwe',
+
 	// Acronyms/Abbreviations
 	'API', 'APIs', 'ASCII', 'CI', 'CircleCI', 'CLI', 'DLL', 'DNS',
 	'EC2', 'FTP', 'HTTP', 'HTTPs', 'ICMP', 'IDE', 'IP', 'ISP',
@@ -78,7 +111,7 @@ export const correctTitleCasingList = [
 	'ProTools', 'QuickTime', 'AdWords', 'AdSense', 'TikTok', 'Slack', 'Trello',
 	'Zoom', 'Twitch', 'Snapchat', 'WhatsApp', 'Telegram', 'Discord', 'Reddit',
 	'Quora', 'StackOverflow', 'StackExchange', 'Coca-Cola',
-	'AWS', 'GCP', 'VMware', 'CVS', 'ESL', 'EE', 'CW', 'EE',
+	'AWS', 'GCP', 'VMware', 'CVS', 'ESL', 'EE', 'CW', 'EE', 'ITV',
 	
 	// Sports
 	'NBA', 'NCAA', 'NFL', 'WWE', 'WWF', 'FIFA',
@@ -100,6 +133,9 @@ export const correctTitleCasingList = [
 	
 	// Commercial
 	'Ltd.', 'Co.', 'Inc.', 'St.', 'Ave.', 'Bldg.', 'No.',
+
+	// Other
+	'×', 'x', 'TV', 'IRL', 'UK'
 ];
 
 export const wordReplacementsList = [
@@ -126,6 +162,7 @@ export const wordReplacementsList = [
 	{ 't.b.d': 'TBD' },
 	{ 'vuejs': 'Vue.js' },
 	{ 'phd': 'ph.d.' },
+	{ 'x': '×' },
 ];
 
 // ! TODO

package/src/TitleCaserUtils.js

@@ -71,12 +71,12 @@ export class TitleCaserUtils {
 			return TitleCaserUtils.titleCaseOptionsCache.get ( cacheKey );
 		}
 		
-		// Merge the default options with the user-provided options
 		const mergedOptions = {
-			...titleCaseDefaultOptionsList[options.style || "ap"],
-			...options
+		    ...titleCaseDefaultOptionsList[options.style || "ap"],
+		    ...options,
+		    smartQuotes: options.hasOwnProperty('smartQuotes') ? options.smartQuotes : false
 		};
-		
+
 		// Merge the default articles with user-provided articles and lowercase words
 		const mergedArticles = mergedOptions.articlesList.concat ( lowercaseWords )
 			.filter ( ( word, index, array ) => array.indexOf ( word ) === index );
@@ -97,14 +97,15 @@ export class TitleCaserUtils {
 		];
 		
 		// Return the merged options
-		const result = {
+	    const result = {
 			articlesList: mergedArticles,
 			shortConjunctionsList: mergedShortConjunctions,
 			shortPrepositionsList: mergedShortPrepositions,
-			neverCapitalizedList: [ ...mergedOptions.neverCapitalizedList ],
+			neverCapitalizedList: [...mergedOptions.neverCapitalizedList],
 			replaceTerms: mergedReplaceTerms,
+			smartQuotes: mergedOptions.smartQuotes  // Add smartQuotes option to result
 		};
-		
+
 		// Add the merged options to the cache and return them
 		TitleCaserUtils.titleCaseOptionsCache.set ( cacheKey, result );
 		return result;
@@ -387,7 +388,42 @@ export class TitleCaserUtils {
 		// Check if the targetWord is in the wordList
 		return wordList.some ( ( word ) => word.toLowerCase () === targetWord.toLowerCase () );
 	}
-	
+
+	static convertQuotesToCurly(input) {
+	    const curlyQuotes = {
+	        "'": ['\u2018', '\u2019'],
+	        '"': ['\u201C', '\u201D'],
+	    };
+
+	    let replacedText = '';
+
+	    for (let i = 0; i < input.length; i++) {
+	        const char = input[i];
+	        const curlyQuotePair = curlyQuotes[char];
+
+	        if (curlyQuotePair) {
+	            const prevChar = input[i - 1];
+	            const nextChar = input[i + 1];
+	            
+	            // Determine whether to use left or right curly quote
+	            const isLeftAligned = (!prevChar || prevChar === ' ' || prevChar === '\n');
+	            const curlyQuote = isLeftAligned ? curlyQuotePair[0] : curlyQuotePair[1];
+	            replacedText += curlyQuote;
+
+	            // Handle cases where right curly quote is followed by punctuation or space
+	            if (curlyQuote === curlyQuotePair[1] && /[.,;!?()\[\]{}:]/.test(nextChar)) {
+	                replacedText += nextChar;
+	                i++; // Skip the next character
+	            }
+	        } else {
+	            replacedText += char;
+	        }
+	    }
+
+	    return replacedText;
+	}
+
+
 	// This function is used to replace a word with a term in the replaceTerms object
 	static replaceTerm ( word, replaceTermObj ) {
 		// Validate input