forzagreen / n2words / 33686688348

99%

push

github

docs(core)!: add a v6 migration guide (#439)

Documents the three breaking changes in one place, verified against main:
bare tags requiring an explicit currency, the currency option becoming
validated in 41 languages, and unsupported codes changing from TypeError
to RangeError (with pt-BR's three specific cases).

This commit also restores the BREAKING CHANGE footer below. It was carried
by an intentionally empty commit on #438, and GitHub's rebase-merge drops
empty commits — so the currency-option half of the major's release notes
would otherwise have been missing while #436's half survived. Carrying it
on a commit with real content makes it immune to that.

BREAKING CHANGE: `toCurrency`'s `currency` option changes in three ways. Whole
amounts in a language's own currency are unaffected everywhere, and `toCardinal`
and `toOrdinal` are untouched. The zero-subunit guard that an earlier revision of
this footer declared here shipped separately as a fix and is not re-declared.

1. The `currency` option is now validated in the 41 languages that previously
declared `toCurrency(value)` with no options parameter and so discarded it
silently. Passing `{ currency: 'USD' }` to hi-IN returned `पाँच रुपये` ("five
rupees") on 5.1.2 and now throws RangeError naming the accepted set. Affected
languages — am-ET, am-Latn-ET, ar-SA, az-AZ, bn-BD, cs-CZ, da-DK, el-GR,
fa-IR, fi-FI, fil-PH, gu-IN, ha-NG, hbo-IL, he-IL, hi-IN, hr-HR, hu-HU, id-ID,
ja-JP, ka-GE, kn-IN, ko-KR, lt-LT, lv-LV, mr-IN, ms-MY, nb-NO, pa-IN, pl-PL,
ro-RO, sv-SE, sw-KE, ta-IN, te-IN, th-TH, tr-TR, uk-UA, ur-PK, vi-VN, yo-NG.

2. In the 30 languages that already took an options object, an unsupported
`currency` value changes error type from TypeError to RangeError, because
`currency` is now a known key and an out-of-set value is a range problem
rather than a type problem. Callers matching on `instanceof TypeError` must
catch RangeError too. Affected languages — de-DE, en-AU, en-BD, en-CA, en-GB,
en-G... (continued)

5414 of 5649 branches covered (95.84%)

Branch coverage included in aggregate %.

30933 of 31128 relevant lines covered (99.37%)

1297.92 hits per line