@danielhaim/titlecaser 1.2.45 → 1.2.48

package/README.md

@@ -8,7 +8,7 @@ Transform any text to proper title case format using popular style guides such a
 
 ## Demo
 
-<a target="_blank" href="https://danielhaim1.github.io/TitleCaser/"><img src="https://raw.githubusercontent.com/danielhaim1/TitleCaser/main/docs/assets/demo.png" width="100%" height="auto"></a>
+<a target="_blank" href="https://danielhaim1.github.io/TitleCaser/"><img src="https://raw.githubusercontent.com/danielhaim1/TitleCaser/main/docs/assets/demo.png" width="100%" height="auto" alt="TitleCaser Demo"></a>
 
 ## Table of Contents
 
@@ -65,15 +65,11 @@ $ 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';
-```
-
-Here's an example of how to use the modulate function:
+import { TitleCaser } from './path/to/@danielhaim/titlecaser';
 
-```js
 const options = {
-        style: 'chicago'
-      };
+  style: 'chicago'
+};
 
 const titleCaser = new TitleCaser(options);
 
@@ -127,24 +123,13 @@ The `{options}` parameter is an object that contains the settings for the conver
 
 The example below demonstrates how to use the TitleCaser class to convert a string to title case with custom options.
 
-### Basic Usage
-
-```js
-// Instantiate a new TitleCaser object with the options
-const titleCaser = new TitleCaser();
-
-const input = 'the    Book  of  lIfe';
-const output = titleCaser.toTitleCase(input);
-
-console.log(output); // The Book of Life
-```
-
 ### Customizing Word Replacements Method
 
 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
-// CommonJS
+import { TitleCaser } from './path/to/@danielhaim/titlecaser';
+
 const titleCaser = new TitleCaser({
   style: 'apa'
 });
@@ -171,6 +156,8 @@ 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';
+
 // Set the options object
 const options = {
   style: "nyt",
@@ -192,9 +179,6 @@ const expectedOutput = "The Basics of Node.js Development with MongoDB";
 
 // Call the toTitleCase method and store the result in actualOutput
 const actualOutput = titleCaser.toTitleCase(input);
-
-// Log the actual output
-console.log(actualOutput);
 ```
 
 ### TitleCaser With Default Word Replacement  
@@ -202,6 +186,8 @@ console.log(actualOutput);
 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';
+
 // Instantiate a new TitleCaser object with AP style formatting
 const titleCaser = new TitleCaser({ style: 'ap' });
 
@@ -213,9 +199,6 @@ const expectedOutput = 'Node.js Development on AWS: An In-depth Tutorial on Serv
 
 // Call the toTitleCase method and store the result in actualOutput
 const actualOutput = titleCaser.toTitleCase(input);
-
-// Log the actual output
-console.log(actualOutput);
 ```
 
 ### TitleCaser With Possessive Noun and a Colon 
@@ -223,6 +206,8 @@ console.log(actualOutput);
 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';
+
 // Instantiate a new TitleCaser object with AP style formatting
 const titleCaser = new TitleCaser({ style: "ap" });
 
@@ -234,9 +219,6 @@ const expectedOutput = "The iPhone's Impact on Modern Communication: A Socioling
 
 // Call the toTitleCase method and store the result in actualOutput
 const actualOutput = titleCaser.toTitleCase(input);
-
-// Log the actual output
-console.log(actualOutput);
 ```
 
 ## Build Process
@@ -254,43 +236,45 @@ $ npm run test
 $ npm run test
 ```
 
-```bash
+```bash  
 Test Basic Options
-✓ Default title case conversion (2 ms)
-✓ Customized title case conversion (1 ms)
-✓ AP-style title case conversion with replacements (1 ms)
+✓ Default title case conversion
+✓ Customized title case conversion
 ✓ AP-style title case conversion with replacements
-✓ Capitalize suffix word in sentence (1 ms)
+✓ AP-style title case conversion with replacements
+✓ Capitalize suffix word in sentence
 
 Test Methods
 ✓ removeReplaceTerm
 ✓ setReplaceTerms
 
 Test Variation Stability
-✓ Hyphenated, colon, and short word replacements (1 ms)
+✓ Hyphenated, colon, and short word replacements
 ✓ Capitalization and word replacements
 ✓ AP-style title case with possessive and colon
 ✓ AP-style title case with lowercase back/front-end terms
 ✓ Chicago style title case with comparison and colon
-✓ APA style title case with colon (3 ms)
-✓ Wikipedia style title case with acronym and hyphen (1 ms)
+✓ 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 custom term replacements
-✓ AP-style capitalization test with special terms and colon (1 ms)
+✓ 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 (1 ms)
+✓ APA style capitalization test with short conjunction terms and colon
 ✓ Correct phrase casing list testing
-✓ Wikipedia style capitalization test with special term and colon (1 ms)
+✓ Wikipedia style capitalization test with special term and colon
 
 Test Reserved Words
 ✓ Reserved word
 ✓ Reserved word with colon
 ✓ Reserved word, posessive
-✓ Hyphenated reserved word (1 ms)
+✓ 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;
-✓ Untrimmed white spaces (1 ms)
+✓ Untrimmed white spaces
 ```
 
 ## Resources

package/index.js

@@ -6,20 +6,19 @@ import { TitleCaser } from './src/TitleCaser.js';
 // Add a new method to the String prototype. This method will be available
 // to all string objects. This is the method that will be used to convert
 // a string to title case.
-if (String.prototype.toTitleCase === undefined) {
-  String.prototype.toTitleCase = function (options) {
-    const titleCaser = new TitleCaser(options);
-    return titleCaser.toTitleCase(this);
-  };
+if ( String.prototype.toTitleCase === undefined ) {
+	String.prototype.toTitleCase = function ( options ) {
+		const titleCaser = new TitleCaser ( options );
+		return titleCaser.toTitleCase ( this );
+	};
 }
 
-// If the module is being used in a Node environment, export the module.
-if (typeof module === 'object' && module.exports) {
-  module.exports = { TitleCaser };
+// If the module is being used in a Node environment
+if ( typeof module === 'object' && module.exports ) {
+	module.exports = { TitleCaser };
 }
 
-// If the module is being used in a web environment, make the TitleCaser
-// class available in the window object.
-if (typeof window !== 'undefined' && window.document) {
-  window.TitleCaser = TitleCaser;
+// If the module is being used in a web environment
+if ( typeof window !== 'undefined' && window.document ) {
+	window.TitleCaser = TitleCaser;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@danielhaim/titlecaser",
-  "version": "1.2.45",
+  "version": "1.2.48",
   "description": "Converts a string to title case with multiple style options, ability to ignore certain words, and handle acronyms",
   "keywords": [
     "title case",
@@ -34,7 +34,7 @@
     "name": "Daniel Haim",
     "url": "https://github.com/danielhaim1"
   },
-  "main": "./src/TitleCaser.js",
+  "main": "./index.js",
   "files": [
     "LICENSE",
     "README.md",
@@ -51,11 +51,13 @@
     "tree": "tree -I 'node_modules'"
   },
   "devDependencies": {
-    "@babel/cli": "^7.21.0",
-    "@babel/core": "^7.21.4",
-    "@babel/plugin-transform-modules-commonjs": "^7.21.2",
-    "@babel/preset-env": "^7.21.4",
-    "@babel/runtime-corejs3": "^7.21.0",
+    "@babel/cli": "^7.21.5",
+    "@babel/core": "^7.22.1",
+    "@babel/plugin-proposal-class-properties": "^7.18.6",
+    "@babel/plugin-proposal-object-rest-spread": "^7.20.7",
+    "@babel/plugin-transform-modules-commonjs": "^7.21.5",
+    "@babel/preset-env": "^7.22.4",
+    "@babel/runtime-corejs3": "^7.22.3",
     "@jest/expect": "^29.5.0",
     "babel-jest": "^29.5.0",
     "babel-loader": "^9.1.2",
@@ -63,13 +65,13 @@
     "exports-loader": "^4.0.0",
     "jest": "^29.5.0",
     "jest-environment-jsdom": "^29.5.0",
-    "jest-environment-puppeteer": "^8.0.6",
-    "jest-puppeteer": "^8.0.6",
-    "puppeteer": "^19.8.5",
-    "puppeteer-core": "^19.8.5",
-    "terser-webpack-plugin": "^5.3.7",
-    "webpack": "^5.78.0",
-    "webpack-cli": "^5.0.1",
+    "jest-environment-puppeteer": "^9.0.0",
+    "jest-puppeteer": "^9.0.0",
+    "puppeteer": "^20.5.0",
+    "puppeteer-core": "^20.5.0",
+    "terser-webpack-plugin": "^5.3.9",
+    "webpack": "^5.86.0",
+    "webpack-cli": "^5.1.4",
     "webpack-node-externals": "^3.0.0"
   },
   "publishConfig": {