Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wooorm/bcp-47
Parse and stringify BCP 47 language tags
https://github.com/wooorm/bcp-47
47 bcp bcp47 code i18n iana language language-tags subtags tag
Last synced: about 1 month ago
JSON representation
Parse and stringify BCP 47 language tags
- Host: GitHub
- URL: https://github.com/wooorm/bcp-47
- Owner: wooorm
- License: mit
- Created: 2016-02-21T17:42:55.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2023-11-01T11:28:42.000Z (10 months ago)
- Last Synced: 2024-07-18T16:32:16.375Z (about 2 months ago)
- Topics: 47, bcp, bcp47, code, i18n, iana, language, language-tags, subtags, tag
- Language: JavaScript
- Homepage:
- Size: 140 KB
- Stars: 61
- Watchers: 3
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- Funding: funding.yml
- License: license
Awesome Lists containing this project
- awesome-list - bcp-47
README
# bcp-47
[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
Parse and stringify [BCP 47][spec] language tags.
## Contents
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`parse(tag[, options])`](#parsetag-options)
* [`stringify(schema)`](#stringifyschema)
* [`Schema`](#schema)
* [`function warning(reason, code, offset)`](#function-warningreason-code-offset)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Related](#related)
* [Contribute](#contribute)
* [License](#license)
## What is this?
This is a package that can parse BCP 47 language tags to an object representing
them, and serialize those objects back into language tags.
It supports a forgiving mode to handle incorrect BCP 47 tags and can emit
warnings about problems in incorrect tags.
## When should I use this?
You can use this package if you need to access the data stored in BCP 47
language tags.
You can also use this package if you want to check (lint) or manipulate tags.
## Install
This package is [ESM only][esm].
In Node.js (version 14.14+, 16.0+), install with [npm][]:
```sh
npm install bcp-47
```
In Deno with [`esm.sh`][esmsh]:
```js
import * as bcp47 from 'https://esm.sh/bcp-47@2'
```
In browsers with [`esm.sh`][esmsh]:
```html
import * as bcp47 from 'https://esm.sh/bcp-47@2?bundle'
```
## Use
```js
import {parse, stringify} from 'bcp-47'
const schema = parse('hy-Latn-IT-arevela')
console.log(schema)
console.log(stringify(schema))
```
Yields:
```js
{ language: 'hy',
extendedLanguageSubtags: [],
script: 'Latn',
region: 'IT',
variants: ['arevela'],
extensions: [],
privateuse: [],
irregular: null,
regular: null }
'hy-Latn-IT-arevela'
```
## API
This package exports the identifiers `parse` and `stringify`.
There is no default export.
### `parse(tag[, options])`
Parse a BCP 47 tag into a language schema.
> 👉 **Note**: the algorithm is case insensitive.
###### `options.normalize`
Whether to normalize legacy tags when possible (`boolean`, default:
`true`).
For example, `i-klingon` does not match the BCP 47 language algorithm but is
considered valid by BCP 47 nonetheless.
It is suggested to use `tlh` instead (the ISO 639-3 code for Klingon).
When `normalize` is `true`, passing `i-klingon` or other deprecated tags, is
handled as if their suggested valid tag was given instead.
###### `options.forgiving`
By default, when an error is encountered, an empty object is returned.
When in forgiving mode, all found values up to the point of the error
are included (`boolean`, default: `false`).
So, for example, where by default `en-GB-abcdefghi` an empty object is returned
(as the language variant is too long), in `forgiving` mode the `language` of
`schema` is populated with `en` and the `region` is populated with `GB`.
###### `options.warning`
When given, `warning` is called when an error is encountered
([`Function`][warning]).
###### Returns
Parsed BCP 47 language tag ([`Schema`][schema]).
###### Throws
When `tag` is `null` or `undefined`.
### `stringify(schema)`
Compile a [`schema`][schema] to a BCP 47 language tag.
###### Returns
BCP 47 language tag (`string`).
### `Schema`
A schema represents a language tag.
A schema is deemed empty when it has neither `language`, `irregular`, `regular`,
nor `privateuse` (where an empty `privateuse` array is handled as no
`privateuse` as well).
###### `schema.language`
Two or three character [ISO 639][iso-639] language code, four character reserved
language code, or 5 to 8 (inclusive) characters registered language subtag
(`string`).
For example, `en` (English) or `cmn` (Mandarin Chinese).
###### `schema.extendedLanguageSubtags`
Selected three-character [ISO 639][iso-639] codes (`Array`), such as
`yue` in `zh-yue-HK` (Chinese, Cantonese, as used in Hong Kong SAR).
###### `schema.script`
Four character [ISO 15924][iso-15924] script code (`string`), such as `Latn` in
`hy-Latn-IT-arevela` (Eastern Armenian written in Latin script, as used in
Italy).
###### `schema.region`
Two alphabetical character [ISO 3166-1][iso-3166-1] code or three digit
[UN M49][un-m49] code (`string`).
For example, `CN` in `cmn-Hans-CN` (Mandarin Chinese, Simplified script, as used
in China) or `419` in `es-419` (Spanish as used in Latin America and the
Caribbean).
###### `schema.variants`
5 to 8 (inclusive) character language variants (`Array`), such as
`rozaj` and `biske` in `sl-rozaj-biske` (San Giorgio dialect of Resian dialect
of Slovenian).
###### `schema.extensions`
List of extensions (`Array`), each an object containing a one character
`singleton`, and a list of `extensions` (`string`).
`singleton` cannot be `x` (case insensitive) and `extensions` must be between
two and eight (inclusive) characters.
For example, an extension would be `u-co-phonebk` in `de-DE-u-co-phonebk`
(German, as used in Germany, using German phonebook sort order), where `u` is
the `singleton` and `co` and `phonebk` are its extensions.
###### `schema.privateuse`
List of private-use subtags (`Array`), where each subtag must be between
one and eight (inclusive) characters.
###### `schema.regular`
One of the `regular` tags (`string`): tags that are seen as something different
by the algorithm.
Valid values are:
* `art-lojban`
* `cel-gaulish`
* `no-bok`
* `no-nyn`
* `zh-guoyu`
* `zh-hakka`
* `zh-min`
* `zh-min-nan`
* `zh-xiang`
###### `schema.irregular`
One of the `irregular` tags (`string`): tags that are seen as invalid by the
algorithm).
Valid values are:
* `en-GB-oed`
* `i-ami`
* `i-bnn`
* `i-default`
* `i-enochian`
* `i-hak`
* `i-klingon`
* `i-lux`
* `i-mingo`
* `i-navajo`
* `i-pwn`
* `i-tao`
* `i-tay`
* `i-tsu`
* `sgn-BE-FR`
* `sgn-BE-NL`
* `sgn-CH-DE`
### `function warning(reason, code, offset)`
Called when an error occurs.
###### Parameters
* `reason` (`string`)
— reason for failure in English
* `code` (`number`)
— code for failure
* `offset` (`number`)
— index of place where the error occurred in the tag
###### Warnings
| code | reason |
| :--- | :--------------------------------------------------------------------- |
| 1 | Too long variant, expected at most 8 characters |
| 2 | Too long extension, expected at most 8 characters |
| 3 | Too many extended language subtags, expected at most 3 subtags |
| 4 | Empty extension, extensions must have at least 2 characters of content |
| 5 | Too long private-use area, expected at most 8 characters |
| 6 | Found superfluous content after tag |
## Types
This package is fully typed with [TypeScript][].
It exports the additional types `Schema`, `Extension`, `Warning`, and
`Options`.
## Compatibility
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.
## Security
This package is safe.
## Related
* [`wooorm/bcp-47-match`](https://github.com/wooorm/bcp-47-match)
— match BCP 47 language tags with language ranges per RFC 4647
* [`wooorm/bcp-47-normalize`](https://github.com/wooorm/bcp-47-normalize)
— normalize, canonicalize, and format BCP 47 tags
* [`wooorm/iso-3166`](https://github.com/wooorm/iso-3166)
— ISO 3166 codes
* [`wooorm/iso-639-2`](https://github.com/wooorm/iso-639-2)
— ISO 639-2 codes
* [`wooorm/iso-639-3`](https://github.com/wooorm/iso-639-3)
— ISO 639-3 codes
* [`wooorm/iso-15924`](https://github.com/wooorm/iso-15924)
— ISO 15924 codes
* [`wooorm/un-m49`](https://github.com/wooorm/un-m49)
— UN M49 codes
## Contribute
Yes please!
See [How to Contribute to Open Source][contribute].
## License
[MIT][license] © [Titus Wormer][author]
[build-badge]: https://github.com/wooorm/bcp-47/workflows/main/badge.svg
[build]: https://github.com/wooorm/bcp-47/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/bcp-47.svg
[coverage]: https://codecov.io/github/wooorm/bcp-47
[downloads-badge]: https://img.shields.io/npm/dm/bcp-47.svg
[downloads]: https://www.npmjs.com/package/bcp-47
[size-badge]: https://img.shields.io/bundlephobia/minzip/bcp-47.svg
[size]: https://bundlephobia.com/result?p=bcp-47
[npm]: https://docs.npmjs.com/cli/install
[esmsh]: https://esm.sh
[license]: license
[author]: https://wooorm.com
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[typescript]: https://www.typescriptlang.org
[contribute]: https://opensource.guide/how-to-contribute/
[spec]: https://tools.ietf.org/rfc/bcp/bcp47.html
[warning]: #function-warningreason-code-offset
[schema]: #schema
[iso-639]: https://en.wikipedia.org/wiki/ISO_639
[iso-15924]: https://en.wikipedia.org/wiki/ISO_15924
[iso-3166-1]: https://en.wikipedia.org/wiki/ISO_3166-1
[un-m49]: https://en.wikipedia.org/wiki/UN_M.49