GithubHelp home page GithubHelp logo

ap-style-titles's Introduction

AP Style Title Casing

This is a simple module that applies Associated Press style guidelines to strings that are intended to be used as titles. An explanation of the AP guidelines is here. This is useful when you are working with data that has titles with different casing (or no casing) rules applied and you'd like them to conform to a well-known standard.

The Rules

  • First and last word of the string are always capitalized
  • There is a list of articles, prepositions or conjunctions that have fewer than four letters on the link listed above. Words on that list are not capitalized when they are not the first or last word of the title.
  • Some special abbreviations (vs, for example) are not capitalized.

What This Doesn't Do

There are some grammar rules this doesn't cover. For example, "yet" should be capitalized when used as an adverb. This module won't catch that. It simply uses the rules above to add some consistency to title casing.

Usage

First install the package: npm install ap-style-titles --save

Then add it to the file where you want to transform the casing of a string:

// ES5 require
const capitalize = require('ap-style-titles').default;
// ES6 import
import capitalize from 'ap-style-titles';

const capString = capitalize('the dangers of hiking without proper shoes');
console.log(capString);
// The Dangers of Hiking Without Proper Shoes

If you have suggestions for improving how this works, let me know.

ap-style-titles's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.