Normalize, canonicalize, and format BCP 47 tags
MIT License
Normalize, canonicalize, and format BCP 47 tags.
This package takes BCP 47 tags and makes them uniform.
It removes unneeded info (en-us
-> en
) and replaces deprecated,
overlong, and otherwise unpreferred values with preferred values
(en-bu
-> en-MM
).
It works by applying Unicode CLDR suggestions.
You can use this package when dealing with user-provided language tags and want to normalize and clean them.
This package is ESM only. In Node.js (version 14.14+, 16.0+), install with npm:
npm install bcp-47-normalize
In Deno with esm.sh
:
import {bcp47Normalize} from 'https://esm.sh/bcp-47-normalize@2'
In browsers with esm.sh
:
<script type="module">
import {bcp47Normalize} from 'https://esm.sh/bcp-47-normalize@2?bundle'
</script>
import {bcp47Normalize} from 'bcp-47-normalize'
const tags = [
'de-de-1901',
'en-gb',
'en-us',
'en-bu',
'hy-arevmda',
'nld-nl',
'no-nyn',
'pt-br',
'pt-pt',
'zh-hans-cn'
]
tags.forEach((tag) => console.log('%s -> %s', tag, bcp47Normalize(tag)))
Yields:
de-de-1901 -> de-1901
en-gb -> en-GB
en-us -> en
en-bu -> en-MM
hy-arevmda -> hyw
nld-nl -> nl
no-nyn -> nn
pt-br -> pt
pt-pt -> pt-PT
zh-hans-cn -> zh
This package exports the identifier bcp47Normalize
.
There is no default export.
bcp47Normalize(tag[, options])
Normalize the given BCP 47 tag according to Unicode CLDR suggestions.
tag
(string
)
— BCP 47 tag
options.forgiving
(boolean
, default: false
)
— passed to bcp-47
as options.forgiving
options.warning
(Function?
, default: undefined
)
— passed to bcp-47
as options.warning
One additional warning is given:
code | reason |
---|---|
7 | Deprecated region CURRENT , expected one of SUGGESTIONS
|
This warning is only given if the region cannot be automatically fixed (when regions split into multiple regions).
Normal, canonical, and pretty BCP 47 tag (string
).
This package is fully typed with TypeScript.
It exports the additional types Options
and Warning
.
This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. It also works in Deno and modern browsers.
This package is safe.
wooorm/bcp-47
wooorm/bcp-47-match
wooorm/iso-3166
wooorm/iso-639-2
wooorm/iso-639-3
wooorm/iso-15924
wooorm/un-m49
Yes please! See How to Contribute to Open Source.