punctilio 1.7.7 → 1.7.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
Pretty good at making your text pretty. The most feature-complete and reliable English typography package—transforms plain ASCII punctuation into typographically correct Unicode, even across HTML element boundaries.
|
|
8
8
|
|
|
9
|
-
**Smart quotes** · **Em/en dashes** · **Ellipses** · **Math symbols** · **Legal symbols** · **Arrows** · **Primes** · **Fractions** · **Superscripts** · **Ligatures** · **Non-breaking spaces** · **HTML-aware**
|
|
9
|
+
**Smart quotes** · **Em/en dashes** · **Ellipses** · **Math symbols** · **Legal symbols** · **Arrows** · **Primes** · **Fractions** · **Superscripts** · **Ligatures** · **Non-breaking spaces** · **HTML-aware** · **Bri'ish localisation support**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
12
|
import { transform } from 'punctilio'
|
|
@@ -31,7 +31,6 @@ I tested `punctilio` 1.2.9 against [`smartypants`](https://www.npmjs.com/package
|
|
|
31
31
|
|
|
32
32
|
| Input | `smartypants` | `punctilio` |
|
|
33
33
|
|:-----:|:-----------------:|:-------:|
|
|
34
|
-
| She said—"Hi!" | She said—”Hi!” (✗) | She said—“Hi!” (✓) |
|
|
35
34
|
| 5x5 | 5x5 (✗) | 5×5 (✓) |
|
|
36
35
|
|
|
37
36
|
My [`benchmark.mjs`](https://github.com/alexander-turner/punctilio/blob/main/benchmark.mjs) measures how well libraries handle a [wide range of scenarios](https://github.com/alexander-turner/punctilio/blob/main/benchmark_cases.json). The benchmark normalizes stylistic differences (e.g. non-breaking vs regular space, British vs American dash spacing) for fair comparison.
|
|
@@ -75,7 +74,7 @@ My [`benchmark.mjs`](https://github.com/alexander-turner/punctilio/blob/main/ben
|
|
|
75
74
|
|
|
76
75
|
## Test suite
|
|
77
76
|
|
|
78
|
-
Setting aside the benchmark, `punctilio`’s test suite includes
|
|
77
|
+
Setting aside the benchmark, `punctilio`’s test suite includes 1,100+ tests at 100% branch coverage, including edge cases derived from competitor libraries ([`smartquotes`](https://github.com/kellym/smartquotes.js), [`retext-smartypants`](https://github.com/retextjs/retext-smartypants), [`typograf`](https://github.com/typograf/typograf)), and the [Standard Ebooks typography manual](https://standardebooks.org/manual/). Key test categories:
|
|
79
78
|
|
|
80
79
|
- _Quote handling_: Unicode text, nested quotes, contractions, Irish names (O’Brien), leading apostrophes (’99, ’twas)
|
|
81
80
|
- _Dash transformations_: Year/page/score ranges, model name preservation (Llama-2-7B, GPT-4), phone numbers, ISBNs
|