TitleCaser

!GitHub

A powerful utility for converting text to title case with support for multiple style guides and extensive customization options.

- TitleCaser
* Demo
* CodePen Demo 1
* CodePen Demo 2
* Table of Contents
* Introduction
* Key Features:
* Installation
* Usage
* Usage in the Browser
* Options
* Methods
* Examples
+ Basic Usage
+ Customizing Word Replacements Method
+ Customizing TitleCaser
+ TitleCaser with Default Word Replacement
+ TitleCaser with Possessive Noun and a Colon
* Build Process
* Test
* Resources
* Report Bugs
* Contributing
* Changelog

Overview

TitleCaser is a comprehensive solution for converting text to title case according to various style guides (AP, APA, Chicago, NYT, Wikipedia, British). It handles special cases like hyphens, apostrophes, Roman numerals, and acronyms, and provides extensive customization options.

Language Conventions and Style Library

The comprehensive Language Conventions and Style Library (LCSL) 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 2025.

$3

To streamline workflow, modules are available in both browser and node environment versions and include a command-line interface for building, testing, and minimizing the module. Additionally, it features a filter ability that allows users to ignore certain phrases containing short words, preventing the module from mistakenly flagging instances where short words are used as part of a larger term or phrase.

$3

The module has been designed to handle various capitalization scenarios, including:
- Hyphenated words
- Prefixes and suffixes
- Reserved words
- Roman numerals
- Proper nouns that contain lowercase letters
- Words that require capitalization in specific contexts

This ensures that your content meets the appropriate style and formatting guidelines, regardless of the context. It also offers word replacement capabilities, as well as ignored phrases to create consistency in cases where certain terms may be capitalized differently depending on the context.

$3

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.

$3

- Support for popular style guides and customizable preferences
- Advanced capitalization handling for suffixes, prefixes, hyphenated words, and reserved words
- Support for proper capitalization of Roman numerals and exclusion of specific words and phrases from title capitalization
- Word replacement capabilities for consistency in capitalization
- 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

Features

- Multiple Style Support: AP, APA, Chicago, NYT, Wikipedia, and British title case styles
- Special Case Handling: Hyphens, apostrophes, Roman numerals, acronyms, and more
- Word Replacement: Replace specific words with their correct forms
- Exact Phrase Replacement: Replace exact phrases with their correct forms
- Smart Quotes: Optional conversion to smart quotes
- Extensive Term Lists: Includes extensive lists of correctly cased terms
- Customizable Options: Customize word lists, replacements, and other options

Installation

``bash
npm install @danielhaim/titlecaser
`

Usage

The package can be imported and used in both Node.js and browser environments:

`javascript
import { TitleCaser } from '@danielhaim/titlecaser';

// Basic usage with Chicago style
const titleCaser = new TitleCaser({
style: 'chicago'
});
const result = titleCaser.toTitleCase('the book of life');
console.log(result); // "The Book of Life"

// With custom options
const customTitleCaser = new TitleCaser({
style: 'ap',
smartQuotes: true,
ignoredWords: ['a', 'an', 'the'],
acronyms: ['API', 'JSON', 'XML']
});

const customResult = customTitleCaser.toTitleCase('the api and json data');
console.log(customResult); // "The API and JSON Data"

// Add custom word replacements
titleCaser.addReplaceTerm('js', 'JavaScript');
const jsResult = titleCaser.toTitleCase('js development');
console.log(jsResult); // "JavaScript Development"

// Add exact phrase replacements
titleCaser.addExactPhraseReplacements([
{ 'the correct phrase': 'The Correct Phrase' }
]);
const phraseResult = titleCaser.toTitleCase('this is the correct phrase');
console.log(phraseResult); // "This Is The Correct Phrase"
`

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:

`html

`

After that, the toTitleCase() function can be accessed in your JavaScript code like this:

`javascript
const options = {
style: 'apa'
};
const input = 'the future of devops: the next era';
const output = input.toTitleCase(options);

console.log(output); // The Future of DevOps: The Next Era
`

$3

`html


nodejs development on aws: an in-depth tutorial on server-side javascript deployment

the iphone's impact on modern communication: a sociolinguistic analysis

back-end and front-end

`

`javascript
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.

- style: determines the specific title case style to be applied. Permissible values include: ['ap', 'apa', 'british', 'chicago', 'nyt', 'wikipedia']
- articlesList refers to the words that should be treated as articles in title case.
- shortConjunctionsList pertains to the words that should be treated as short conjunctions in title case.
- 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

- 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.
- addReplaceTerm(term, replacement): Adds a single term-replacement pair to the wordReplacementsList. If the term already exists, it updates the replacement value.
- addExactPhraseReplacements(newPhrases) - This method allows adding an array of exact phrase replacements to the TitleCaser class. Each item in the array should be an object with a single key-value pair, where the key is the phrase to be replaced and the value is the desired replacement.
- 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

$3

`javascript
import { TitleCaser } from '@danielhaim/titlecaser';

const titleCaser = new TitleCaser();
const result = titleCaser.toTitleCase('hello world');
console.log(result); // "Hello World"
`

$3

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.

`javascript
import { TitleCaser } from '@danielhaim/titlecaser';

const titleCaser = new TitleCaser({
style: 'apa'
});

// Set multiple replacement terms using two separate calls to setReplaceTerms()
titleCaser.setReplaceTerms({
'hello world': 'Hello World',
'replace me': 'Replace Me'
});
titleCaser.setReplaceTerms({
'apa': 'APA'
});

// Use descriptive variable names for the input and expected output
const inputString = "hello world, replace me!";
const expectedOutput = "Hello World, Replace Me!";

// Call toTitleCase() to convert the input string to title case
const outputString = titleCaser.toTitleCase(inputString);
`

$3

The example below demonstrates how to use the TitleCaser class to convert a string to a title case with specific settings.

`javascript
import { TitleCaser } from '@danielhaim/titlecaser';

// Set the options object
const options = {
style: "nyt",
wordReplacementsList: {
"nodejs": "Node.js",
"javascript": "JavaScript",
"mongodb": "MongoDB"
}
};

// Instantiate a new TitleCaser object with the options
const titleCaser = new TitleCaser(options);

// Set the input string to be tested
const input = "the basics of nodejs development with mongodb";

// Set the expected output
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);
`

$3

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.

`javascript
import { TitleCaser } from '@danielhaim/titlecaser';

// Instantiate a new TitleCaser object with AP style formatting
const titleCaser = new TitleCaser({ style: 'ap' });

// 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
const expectedOutput = 'Node.js Development on AWS: An In-depth Tutorial on Server-side JavaScript Deployment';

// Call the toTitleCase method and store the result in actualOutput
const actualOutput = titleCaser.toTitleCase(input);
`

$3

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.

`javascript
import { TitleCaser } from '@danielhaim/titlecaser';

// Instantiate a new TitleCaser object with AP style formatting
const titleCaser = new TitleCaser({ style: "ap" });

// Set the input string to be tested
const input = "the iphone's impact on modern communication: a sociolinguistic analysis";

// Set the expected output
const expectedOutput = "The iPhone's Impact on Modern Communication: A Sociolinguistic Analysis";

// Call the toTitleCase method and store the result in actualOutput
const actualOutput = titleCaser.toTitleCase(input);
`

$3

The example below demonstrates how to use the TitleCaser with smart quotes.

`javascript
import { TitleCaser } from '@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);
`

Architecture

TitleCaser is structured into three main components:

1. TitleCaser.js - The main class that provides the public API
2. TitleCaserConsts.js - Contains constants, configuration, and data structures
3. TitleCaserUtils.js - Contains utility functions for text processing

$3

The package uses several JSON files to store specialized terms:

- brandList.json: Brand names and trademarks
- businessFinanceLegalTerms.json: Business and legal terminology
- eCommerceDigitalTerms.json: E-commerce and digital terms
- globalGeography.json: Geographic terms
- marketingMediaTerms.json: Marketing and media terms
- miscSpecializedTerms.json: Miscellaneous specialized terms
- techComputingConcepts.json: Technology and computing terms
- timeAcademicTerms.json: Time and academic terms

API Reference

$3

`javascript
new TitleCaser(options)
`

#### Options

- style (string): Title case style ('ap', 'apa', 'chicago', 'nyt', 'wikipedia', 'british')
- smartQuotes (boolean): Convert straight quotes to curly quotes
- ignoredWords (array): Words to ignore in title casing
- acronyms (array): Words to treat as acronyms

$3

#### toTitleCase(text)

Converts text to title case according to the selected style.

`javascript
const result = titleCaser.toTitleCase('hello world');
`

#### setReplaceTerms(replaceTerms)

Sets the word replacement list.

`javascript
titleCaser.setReplaceTerms([
{ 'js': 'JavaScript' },
{ 'api': 'API' }
]);
`

#### addReplaceTerm(term, replacement)

Adds a single term replacement.

`javascript
titleCaser.addReplaceTerm('js', 'JavaScript');
`

#### removeReplaceTerm(term)

Removes a term from the replacement list.

`javascript
titleCaser.removeReplaceTerm('js');
`

#### addExactPhraseReplacements(phrases)

Adds exact phrase replacements.

`javascript
titleCaser.addExactPhraseReplacements([
{ 'the correct phrase': 'The Correct Phrase' }
]);
`

#### setStyle(style)

Sets the title case style.

`javascript
titleCaser.setStyle('chicago');
`

Build Process

`bash
npm run build-package
npm run build-docs
npm run copy-package-to-docs
npm run test
`

Test

`bash
npm run test
`

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.

- AP Stylebook, 56th Edition
- Publication Manual of the American Psychological Association, Seventh Edition (2020)
- Chicago Manual of Style: Capitalization
- The Bluebook: A Uniform System of Citation. 21st ed. Cambridge: Harvard Law Review Association, 2020
- The Chicago Manual of Style, 17th Edition
- The New York Times Manual of Style and Usage
- Wikipedia: Letter case
- Wikipedia:Manual of Style/Titles of works

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.

When reporting a bug, please provide as much detail as possible, including the steps to reproduce the issue and any error messages that you see. I appreciate any contribution to improving this library.

Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Changelog

See CHANGELOG.md for a list of changes and version history.

Tests

`bash
TitleCaser – Combined Words Ending with Symbol
✓ should preserve punctuation in "Championing Self-Acceptance: Landmark Initiative" (4 ms)
TitleCaser – Disambiguation of Acronym vs. Pronoun (AP Style)
✓ should capitalize "US" when preceded by "the" (1 ms)
✓ should capitalize "US" in geopolitical context (with comma) (1 ms)
✓ should capitalize "US" and "UK" together
✓ should capitalize "US" after "from the" (1 ms)
✓ should capitalize "US" after "via" (1 ms)
✓ should capitalize "US" before "Military"
✓ should capitalize "US" in geopolitical context (repeated case) (1 ms)
✓ should capitalize pronoun "us" (case #1) (1 ms)
✓ should capitalize pronoun "us" (case #2)
✓ should capitalize pronoun "us" (case #3) (1 ms)
✓ should capitalize "UK" in geopolitical context (with comma)
✓ should handle multiple country codes in same sentence (1 ms)
✓ should capitalize pronoun "us" in a parenthetical phrase (1 ms)
✓ should capitalize "USA" in formal context
✓ should capitalize "US" before "government" (AP style) (1 ms)
✓ should capitalize "US" before "military" (AP style)
✓ should capitalize "US" in geopolitical context (policy mention)
✓ should capitalize "US" before "Military" (repeat case) (1 ms)
✓ should capitalize "US" at the end of a sentence
✓ should capitalize pronoun "us" in casual speech
✓ should capitalize pronoun "us" in emotional context (1 ms)
✓ should capitalize pronoun "us" in passive voice
✓ should capitalize pronoun "us" with a compound verb
✓ should capitalize pronoun "us" in an inverted clause (1 ms)
✓ should capitalize pronoun "us" (repeat case #1)
✓ should capitalize pronoun "us" (repeat case #2) (1 ms)
✓ should capitalize pronoun "us" before "US Military"
✓ should capitalize pronoun "us" before "military" (1 ms)
✓ should capitalize pronoun "us" in a comma-separated clause
✓ should capitalize "UK" at end of sentence (1 ms)
✓ should capitalize "UK" in geopolitical context (repeat with comma)
✓ should capitalize "UK" before government mention (1 ms)
✓ should capitalize "UK" before territory mention
✓ should handle multiple country codes and pronouns in one sentence (2 ms)
✓ should handle multiple codes and pronouns with mention of military
✓ should handle multiple codes and pronouns with mention of talks (1 ms)
✓ should handle multiple codes and pronouns with mention of a bill (1 ms)
✓ should capitalize "USA" in formal context (repeat case)
✓ should capitalize "USA" before a bill mention (1 ms)
✓ should handle AP-style acronym "U.S." in uppercase context
✓ should handle "On & Off" phrases #1 (1 ms)
✓ should handle "On & Off" phrases #2
TitleCaser – Hyphenated & Apostrophized Words
✓ should capitalize both parts of "t-mobile"
✓ should capitalize "coca-cola"
✓ should capitalize general hyphenated term "e-commerce" (1 ms)
✓ should capitalize apostrophe word "o'connor"
TitleCaser – Basic Title Casing Options (Default Style)
✓ should convert a basic lowercase phrase to title case
✓ should handle excessive spacing and lowercase articles
✓ should handle brand casing with AP-style logic (1 ms)
✓ should preserve correct casing in hyphenated names like "louis-iv"
✓ should properly capitalize prepositions beyond 3 letters (1 ms)
TitleCaser – Class Methods (setReplaceTerms, addExactPhraseReplacements, etc.)
✓ should apply Wikipedia style to an entire sentence (1 ms)
✓ should apply multiple term replacements via setReplaceTerms()
✓ should apply exact phrase replacements (1 ms)
✓ should remove a single replacement rule via removeReplaceTerm()
TitleCaser – Variation Stability Tests (AP, Chicago, APA, NYT, Wikipedia)
✓ should correctly handle brand names with "ap" style
✓ should handle brand name "NERDs Candy" with AP style
✓ should handle possessives and colons (AP style)
✓ should handle hyphenated "BACK-end" with AP style
✓ should handle acronym with colon (AP style) (1 ms)
✓ should handle colon + comparison phrase (Chicago)
✓ should capitalize hyphenated terms (Chicago) (1 ms)
✓ should apply custom replacements for brand names (Chicago) (1 ms)
✓ Smart quotes enabled
✓ should keep acronyms in uppercase (Chicago)
✓ should capitalize after colon (APA) (1 ms)
✓ should handle colon and apostrophes (APA)
✓ should handle short conjunctions and brand normalization (APA) (1 ms)
✓ should handle acronym + colon usage (NYT) (1 ms)
✓ should preserve sentence case for Wikipedia style (DevOps example) (1 ms)
✓ should handle Wikipedia style with colon usage (1 ms)
TitleCaser – Reserved Words & Special Handling
✓ should transform a single reserved word correctly
✓ should transform sentence with reserved word + colon
✓ should handle possessive form of reserved word
✓ should apply brand replacements (e.g., "mcdonalds" → "McDonald's") (1 ms)
✓ should handle HTML
with colon (spaced)
✓ should handle HTML
with full sentence split (1 ms)
✓ should handle
with no space after colon
✓ should handle ampersand "&" symbol (1 ms)
✓ should handle excessive whitespace
TitleCaser – addReplaceTerm Method
✓ should add a new replacement term
✓ should update an existing replacement term
``