GitXplorerGitXplorer
n

headline-quotes

public
5 stars
0 forks
1 issues

Commits

List of commits on branch master.
Verified
4b4250d22ea22c35139dd76b260a9f994027c13a

chore(package): update mkdirp to version 1.0.0 (#12)

ggreenkeeper[bot] committed 5 years ago
Unverified
d1d2979e5bdfe822b71d25a119c7f83f6b56e5dc

chore(package): update mocha to version 7.0.1 (#13)

ggreenkeeper[bot] committed 5 years ago
Unverified
3c33d1cf872b1284495b2b647265587c5b0d47fe

chore(package): update rimraf to version 3.0.0 (#11)

ggreenkeeper[bot] committed 5 years ago
Unverified
0abaa61b660144bdfe47a5c89aa783fcf2ff151f

chore(package): update babel-plugin-add-module-exports to version 1.0.2 (#10)

ggreenkeeper[bot] committed 6 years ago
Unverified
64a70d01b6343937116773f3b7770153f700deeb

chore(package): update mocha to version 6.1.0 (#9)

ggreenkeeper[bot] committed 6 years ago
Unverified
d7998d08e1dec23367891de8daf7d2ae2fec9d0b

chore(package): update mocha to version 5.0.0 (#6)

ggreenkeeper[bot] committed 7 years ago

README

The README file for this repository.

headline-quotes

Greenkeeper badge

Circle CI

🗒 Smart quotes for headlines! Follows the AP Style Guide

Per the AP Style Guide, headline quotes work differently than normal English. Where US and UK English specify using double quotes (with single quotes for inner quotations), AP suggests that headlines always use single quotes. This convention is followed by most publications, including The Guardian and Reuters.

Most smart quote libraries follow the rules for body text and thus will assume single quotes in headlines are likely to be apostrophes. This library aims to solve the smart quote issue for this specific use case.

What's Covered

  • prepended apostrophes (e.g. 'tis and the '60s)
  • apostrophes inside words (e.g. I'll or the dog's bone)
  • special cases (e.g. In 'n' Out)
  • quotes (double quotes get converted to single quotes)
  • plural posessives (e.g. the lawyers' cars)
  • appended apostrophes (e.g. Ol' Mizzou)
  • quotes around apostrophes are handled correctly (e.g. "'60s era childrens' toys")
  • quotes interspersed with apostrophes are handled correctly (e.g. "'60s era" childrens' toys)

What Isn't Covered

  • quotes inside quotes (e.g. "Someone said, 'Something else'")
  • unclosed quotes (e.g. multi-paragraph quotes, which in English may have unclosed quotation marks)
  • certain prepended apostrophes (e.g. 'cause I said so)
  • certain appended apostrophes (I'm only catching o', ol', and s')
  • other special cases besides 'n'
  • grammatical rules that aren't US/Canadian English (e.g. UK rules, other languages' quotation marks)
  • Hawaiian Ê»Okina and similar glottal stops
  • foot and inch marks

Install

npm install --save headline-quotes

Usage

This library exports both es2015-style modules and regular old commonjs modules, so you can use browserify, rollup, or webpack to include it client-side.

import quote from 'headline-quotes';

quote('"Make Me Smart"'); // ‘Make Me Smart’
var quote = require('headline-quotes');

quote('"Make Me Smart"'); // ‘Make Me Smart’

Contributing

English is a mishmash of conflicting grammatical rules, so I've probably missed something! Create a pull request with a failing unit test, and I'll gladly help fix it.