@danielhaim/titlecaser 1.2.64 → 1.3.0

package/LICENSE

@@ -1,201 +1,21 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright 2023 Daniel Haim
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+MIT License
+
+Copyright (c) 2024 Daniel Haim [https://danielhaim.com]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,4 +1,5 @@
-# TitleCaser
+TitleCaser
+==========
 
 [![npm version](https://img.shields.io/npm/v/@danielhaim/titlecaser)](https://www.npmjs.com/package/@danielhaim/titlecaser)
 [![Downloads](https://img.shields.io/npm/dt/@danielhaim/titlecaser.svg)](https://www.npmjs.com/package/@danielhaim/titlecaser)
@@ -6,12 +7,8 @@
 
 Transform any text to proper title case format using popular style guides such as APA, AP, Chicago, NYT, Wikipedia, and British. Customize options to achieve greater flexibility and consistency.
 
-## 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" alt="TitleCaser Demo"></a>
 
-## Table of Contents
-
 - [TitleCaser](#titlecaser)
   * [Demo](https://danielhaim1.github.io/TitleCaser/)
   * [CodePen Demo 1](https://codepen.io/danielhaim/pen/oNQgjBv)
@@ -35,7 +32,8 @@ Transform any text to proper title case format using popular style guides such a
   * [Resources](#resources)
   * [Report Bugs](#report-bugs)
 
-## Introduction
+Overview
+--------
 
 The comprehensive Language Conventions and Style Library is specifically designed to assist web content developers in adhering to the latest style guides and English language conventions. This all-inclusive library has various features, including support for numerous style guides such as AP, APA, Chicago, NY Times, Wikipedia, and British styles and customizable preferences to tailor to individual needs. TitleCaser is a component of this library, and LCSL is set to be open-sourced by the end of 2023
 
@@ -45,7 +43,7 @@ The module has been designed to handle various capitalization scenarios, includi
 
 Whether you're developing web content for a major news organization or simply looking to improve your writing skills, this module is an essential tool that can help ensure your work is accurate, consistent, and conforms to the latest style guidelines.
 
-## Key Features:
+### Key Features: ###
 
 - Support for popular style guides and customizable preferences
 - Advanced capitalization handling for suffixes, prefixes, hyphenated words, and reserved words
@@ -55,14 +53,16 @@ Command-line interface for building, testing, and minimizing the module
 - Pre-defined word lists for articles, conjunctions, prepositions, and non-capitalized words in titles
 - Exclusion of common phrases from title capitalization
 
-## Installation
+Get Started
+-----------
+
 You can install this module via npm:
 
 ```bash
-$ npm i @danielhaim/titlecaser
+npm i @danielhaim/titlecaser
 ```
 
-## Usage
+### Usage ###
 
 The package can be imported and used in both Node.js and browser environments using the following syntax:
 
@@ -81,7 +81,7 @@ const output = titleCaser.toTitleCase(input);
 console.log(output); // 'The Book of Life'
 ```
 
-## Usage in the Browser
+### Usage in the Browser ###
 
 The function can also be used in a browser environment by including the `TitleCaser.amd.js` script in your HTML file:
 
@@ -103,7 +103,7 @@ const output = input.toTitleCase(options);
 console.log(output); // The Future of DevOps: The Next Era
 ```
 
-### Example 2
+### Example 2 ###
 
 ```html
 <h2>nodejs development on aws: an in-depth tutorial on server-side javascript deployment</h2>
@@ -131,7 +131,8 @@ function applyTitleCaseToH2Elements(options = { style: "apa" }) {
 applyTitleCaseToH2Elements();
 ```
 
-## Options
+Options
+-------
 
 The `{options}` parameter is an object that contains the settings for the conversion process.
 
@@ -143,7 +144,8 @@ The `{options}` parameter is an object that contains the settings for the conver
 - `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
+Methods
+-------
 
 - `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.
@@ -152,11 +154,12 @@ The `{options}` parameter is an object that contains the settings for the conver
 - `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
+Examples
+--------
 
 The example below demonstrates how to use the TitleCaser class to convert a string to title case with custom options.
 
-### Customizing Word Replacements Method
+### 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.
 
@@ -184,7 +187,7 @@ const expectedOutput = "Hello World, Replace Me!";
 const outputString = titleCaser.toTitleCase(inputString);
 ```
 
-### Customizing TitleCaser
+### Customizing TitleCaser ###
 
 The example below demonstrates how to use the TitleCaser class to convert a string to a title case with specific settings.
 
@@ -214,7 +217,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.
 
@@ -234,7 +237,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.
 
@@ -254,7 +257,7 @@ const expectedOutput = "The iPhone's Impact on Modern Communication: A Socioling
 const actualOutput = titleCaser.toTitleCase(input);
 ```
 
-### TitleCaser with Smart Quotes  
+### TitleCaser with Smart Quotes ### 
 
 The example below demonstrates how to use the TitleCaser with smart quotes.
 
@@ -277,19 +280,21 @@ const expectedOutput = '“Never Underestimate the Power O’ Persistence,”';
 const actualOutput = titleCaser.toTitleCase(input);
 ```
 
-## Build Process
+Build Process
+-------------
 
 ```bash
-$ npm run build-package
-$ npm run build-docs
-$ npm run copy-package-to-docs
-$ npm run test
+npm run build-package
+npm run build-docs
+npm run copy-package-to-docs
+npm run test
 ```
 
-## Test
+Test
+----
 
 ```bash
-$ npm run test
+npm run test
 ```
 
 ```bash  
@@ -355,7 +360,8 @@ Test Reserved Words
 ✓ Untrimmed white spaces
 ```
 
-## Resources
+Resources
+---------
 
 Useful materials for improving your knowledge of writing and language style guides. These resources include various books and manuals, such as the Publication Manual of the American Psychological Association, the Chicago Manual of Style, and the AP Stylebook, which are widely recognized as authoritative sources on grammar, punctuation, and capitalization rules.
 
@@ -368,7 +374,8 @@ Useful materials for improving your knowledge of writing and language style guid
 - [Wikipedia: Letter case](https://chat.openai.com/chat/643828ec-d4b5-4f21-b035-62946dd2cec3#:~:text=Wikipedia%3A%20Letter%20case)
 - [Wikipedia:Manual of Style/Titles of works](https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style/Titles_of_works#Capital_letters)
 
-## Report Bugs
+Report Bugs
+-----------
 
 If you encounter any bugs or issues while using the library or the demo page, please report them by opening a new issue in the repository's issue tracker. 
 

package/index.js

@@ -1,11 +1,5 @@
-// src/index.js
-
-// Import the TitleCaser class from the file src/TitleCaser.js.
 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 );
@@ -13,12 +7,12 @@ if ( String.prototype.toTitleCase === undefined ) {
 	};
 }
 
-// If the module is being used in a Node environment
+// Export for Node.js environment
 if ( typeof module === 'object' && module.exports ) {
 	module.exports = { TitleCaser };
 }
 
-// If the module is being used in a web environment
+// Export for web environment
 if ( typeof window !== 'undefined' && window.document ) {
 	window.TitleCaser = TitleCaser;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@danielhaim/titlecaser",
-  "version": "1.2.64",
+  "version": "1.3.0",
   "description": "Converts a string to title case with multiple style options, ability to ignore certain words, and handle acronyms",
   "keywords": [
     "title case",
@@ -44,11 +44,12 @@
   ],
   "scripts": {
     "build-docs": "cd docs && bundle install && bundle exec jekyll build",
-    "build": "npx webpack --mode production",
-    "copy-package-to-docs": "cp -R dist/ docs/assets/js",
+    "build": "npx webpack --mode production && cp -R dist/ docs/assets/js",
     "release": "npm version patch && npm run build && git add -A && git commit -m 'Release: v$(node -p \"require('./package.json').version\")' && git push && npm publish",
+    "release-major": "npm version major && npm run build && git add -A && git commit -m 'Major Release: v$(node -p \"require('./package.json').version\")' && git push && npm publish",
+    "release-minor": "npm version minor && npm run build && git add -A && git commit -m 'Minor Release: v$(node -p \"require('./package.json').version\")' && git push && npm publish",
     "test": "jest",
-    "tree": "tree -a -I 'node_modules|.git'"
+    "tree": "tree -a -I 'node_modules|.git|.DS_Store'"
   },
   "devDependencies": {
     "@babel/cli": "^7.21.5",
@@ -62,15 +63,15 @@
     "babel-jest": "^29.5.0",
     "babel-loader": "^9.1.2",
     "esbuild-jest": "^0.5.0",
-    "exports-loader": "^4.0.0",
+    "exports-loader": "^5.0.0",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.5.0",
     "jest-environment-puppeteer": "^9.0.0",
     "jest-puppeteer": "^9.0.0",
-    "puppeteer": "^21.5.2",
-    "puppeteer-core": "^21.5.2",
+    "puppeteer": "^21.9.0",
+    "puppeteer-core": "^21.9.0",
     "terser-webpack-plugin": "^5.3.9",
-    "webpack": "^5.86.0",
+    "webpack": "^5.90.0",
     "webpack-cli": "^5.1.4",
     "webpack-node-externals": "^3.0.0"
   },

package/src/TitleCaserConsts.js

@@ -134,6 +134,8 @@ export const titleCaseDefaultOptionsList = Object.freeze({
 export const ignoredWordList = [];
 export const correctPhraseCasingList = {
   'the cybersmile foundation': 'The Cybersmile Foundation',
-  'co. by colgate': 'CO. by Colgate'
+  'co. by colgate': 'CO. by Colgate',
+  "on & off": 'On & Off',
+  "on and off": 'On and Off'
 };