string-apostrophes

Comprehensive, HTML-entities-aware tool to typographically-correct the apostrophes and single/double quotes

Usage no npm install needed!

<script type="module">
  import stringApostrophes from 'https://cdn.skypack.dev/string-apostrophes';
</script>

README

string-apostrophes

Comprehensive, HTML-entities-aware tool to typographically-correct the apostrophes and single/double quotes

Install

The latest version is ESM only: Node 12+ is needed to use it and it must be imported instead of required. If your project is not on ESM yet and you want to use require, use an older version of this program, 1.5.0.

npm i string-apostrophes

Quick Take

import { strict as assert } from "assert";

import { convertOne, convertAll } from "string-apostrophes";

assert.deepEqual(
  convertAll(`In the '60s, rock 'n' roll`, {
    convertApostrophes: true,
    convertEntities: false,
  }),
  {
    result: "In the ’60s, rock ’n’ roll",
    ranges: [
      [7, 8, "’"],
      [18, 21, "’n’"],
    ],
  }
);

assert.deepEqual(
  convertOne(`test's`, {
    from: 4,
    to: 5,
    convertApostrophes: true,
    convertEntities: true,
  }),
  [[4, 5, "&rsquo;"]]
);

Documentation

Please visit codsen.com for a full description of the API and even a test playground.

Contributing

To report bugs or request features or assistance, raise an issue on GitHub.

Licence

MIT License

Copyright (c) 2010-2022 Roy Revelt and other contributors

ok codsen star