@danielhaim/titlecaser 1.2.48 → 1.2.53

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)
@@ -65,7 +67,7 @@ $ npm i @danielhaim/titlecaser
 The package can be imported and used in both Node.js and browser environments using the following syntax:
 
 ```js
-import { TitleCaser } from './path/to/@danielhaim/titlecaser';
+import "./path/to/@danielhaim/titlecaser";
 
 const options = {
   style: 'chicago'
@@ -101,6 +103,33 @@ const output = input.toTitleCase(options);
 console.log(output); // The Future of DevOps: The Next Era
 ```
 
+### Example 2
+
+```html
+<h2>nodejs development on aws: an in-depth tutorial on server-side javascript deployment</h2>
+<h2>the iphone's impact on modern communication: a sociolinguistic analysis</h2>
+<h2>back-end and front-end</h2>
+```
+
+```js
+function applyTitleCaseToH2Elements(options = { style: "apa" }) {
+  try {
+    const h2Elements = document.querySelectorAll("h2");
+    h2Elements.forEach((h2) => {
+      const innerHTML = h2.innerHTML;
+      const modifiedContent = innerHTML.toTitleCase(options);
+      h2.innerHTML = modifiedContent;
+    });
+  } catch (error) {
+    console.error(
+      "An error occurred while applying title case transformation:",
+      error
+    );
+  }
+}
+
+applyTitleCaseToH2Elements();
+```
 ## Options
 
 The `{options}` parameter is an object that contains the settings for the conversion process.
@@ -128,7 +157,7 @@ The example below demonstrates how to use the TitleCaser class to convert a stri
 In the example below, we create a new instance of the `TitleCaser` class with the `APA` style option. We then set multiple replacement terms using two separate calls to the `setReplaceTerms()` method. Descriptive variable names are used for the input string and expected output. We call `toTitleCase()` to convert the input string to a title case.
 
 ```js
-import { TitleCaser } from './path/to/@danielhaim/titlecaser';
+import "./path/to/@danielhaim/titlecaser";
 
 const titleCaser = new TitleCaser({
   style: 'apa'
@@ -156,7 +185,7 @@ const outputString = titleCaser.toTitleCase(inputString);
 The example below demonstrates how to use the TitleCaser class to convert a string to a title case with specific settings.
 
 ```js
-import { TitleCaser } from './path/to/@danielhaim/titlecaser';
+import "./path/to/@danielhaim/titlecaser";
 
 // Set the options object
 const options = {
@@ -186,7 +215,7 @@ const actualOutput = titleCaser.toTitleCase(input);
 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.
 
 ```js
-import { TitleCaser } from './path/to/@danielhaim/titlecaser';
+import "./path/to/@danielhaim/titlecaser";
 
 // Instantiate a new TitleCaser object with AP style formatting
 const titleCaser = new TitleCaser({ style: 'ap' });
@@ -206,7 +235,7 @@ const actualOutput = titleCaser.toTitleCase(input);
 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.
 
 ```js
-import { TitleCaser } from './path/to/@danielhaim/titlecaser';
+import "./path/to/@danielhaim/titlecaser";
 
 // Instantiate a new TitleCaser object with AP style formatting
 const titleCaser = new TitleCaser({ style: "ap" });

package/package.json

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

@@ -122,7 +122,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 )
@@ -144,6 +144,9 @@ export class TitleCaser {
 			// 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.
+
 			// Return the string.
 			return inputString;
 		} catch ( error ) {

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