vercel/title

A service for capitalizing your title properly

Title

This package correctly capitalizes your titles as per The Chicago Manual of Style. Furthermore, all of Vercel's product names are capitalized properly as well.

Usage

Firstly, install the package:

yarn add title

Then load it and convert any input:

const title = require('title')

title('tHe cHicaGo maNual oF StyLe')

// Will result in:
// "The Chicago Manual of Style"

You can even pass words that should be capitalized as specified:

title('FaCEbook is great', {
  special: [ 'facebook' ]
})

// Will result in:
// "facebook is great"

That's it!

Command Line

You can also convert titles in the command line, if you want. Install the package globally:

yarn global add title

Next, run it:

title "tHe cHicaGo maNual oF StyLe"

# Will result in:
# "The Chicago Manual of Style"

To see all available options, run:

title -h

Contributing

1. Fork this repository to your own GitHub account and then clone it to your local device
2. Uninstall title if it's already installed: yarn global remove title
3. Link it to the global module directory: yarn link

After that, you can use the title command everywhere.

Authors

• Leo Lamprecht (@notquiteleo)
• Josh Junon (@Qix-)

title's Issues

per-Part should be Per-part

Currently the tool gives this title:

Healthcare Systems Manufacturer Reduces per-Part Cost 10x by Harnessing New Open Additive Ecosystem

However, I think it should be

Healthcare Systems Manufacturer Reduces Per-part Cost 10x by Harnessing New Open Additive Ecosystem

based on https://alcts.ala.org/ccdablog/?tag=chicago-manual-of-style.

Please correct me if I am wrong. Thanks

By the way, a very useful tool!

Update all dependencies to latest and support ESM

It'd be great to support both ESM and CJS here.

https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

'ñ' causes a capitalization bug

Hi,

I noticed this while using this module today:

title('diseño') // 'DiseñO'

Using 'ñ' results in the next letter being capitalized. I haven't dug to figure out what's causing this, but I just wanted to surface the problem. Thanks for all the hard work.

Update all dependencies to latest

I noticed that its dependencies are too old, so you have better update them, and it's recommended to use @^x.x.x or @>=x.x.x to assign versions instead of an exact version code.

It's important to keep the dependencies fresh, and if not, it may cause security problems.

ES2015 features break IE11

In https://github.com/zeit/title/blob/master/lib/index.js#L26, a default parameter is used:

  str = str.toLowerCase().replace(regex, (m, lead = '', forced, lower, rest) => {
                                                  ^^^^

A couple other ES2015 features, such as the spread syntax, are used as well.

These choices break in IE11. Including an ES5 build, or refactoring the code to avoid ES2015, would fix the issue.

This is so delightfully geeky

Just a quick thanks for this :) Nice work!

capitalize on type anyway for it to capitalize automatically when typing?

Last word of title should always be capitalized

I don't have direct access to the relevant Chicago Manual of Style section, but indirectly, everywhere I look online from Grammar Girl to Capitalize My Title tells me that the last word of the title should always be capitalized regardless of whether or not it's a conjunction, article, or preposition.

This tool currently does not capitalize the last word of the title if it is one of the words in lower-case.js. For example,

title "what on earth is going on"
# What on Earth Is Going on [copied]

It should return What on Earth Is Going On.

Global command line title collides with oh-my-zsh

After installing the package globally and trying to use it via command line, the title shell command collides with an oh-my-zsh title function.

Any suggestions how can I avoid that?

Special words containing “.” cause a bug

title('Package JSON')
// => 'package.json'

Using a library such as escape-string-regexp should fix the issue.

Don't require quotes on the CLI

title noW deSktop and now cLI are prODUCts of zeIt

...should just work.

Issue with 3.5.0 C++ Regular Expression

Getting an issue with the title() function Invalid regular expression: /\bC++\b/: Nothing to repeat. Probably related to the symbols.js update 8879445

First letter after a period, question mark or exclamation point must always be capitalized

Split the CLI into a separate package

I don't want all the CLI-related dependencies when using the programmatic API.

Don't capitalise within parenthesis next to a word without a space

Words following a closing parentheses are always lowercased

I'm noticing that the word following closing parentheses is always lowercased. For instance, "Walter (Walt) Thompson" is switched to "Walter (Walt) thompson".

Incorrect result for Vietnamese

Hi, thanks for making this package. I found the result for Vietnamese is incorrect, please see examples below.

console.log(title("đội")); // output "độI", but expect "Đội"
console.log(title("tuyển")); // output "TuyểN", but expect "Tuyển"

Allow passing additional special words

Instead of me submitting pull requests with lots of different special words (brands, acronyms, etc.), it would probably be easier if special words could be passed to the title() function / CLI command. When no words are passed, it could default to the ones in title/lib/specials.js.