Add initial 11ty website structure

This commit is contained in:
Marc Froehlich
2026-07-06 01:04:06 +02:00
parent 62b6bbdcbc
commit 80214bf42d
1378 changed files with 204162 additions and 0 deletions
+7
View File
@@ -0,0 +1,7 @@
export { parse } from "./lib/parse.js";
export { stringify } from "./lib/stringify.js";
export type Extension = import("./lib/parse.js").Extension;
export type Options = import("./lib/parse.js").Options;
export type Schema = import("./lib/parse.js").Schema;
export type Warning = import("./lib/parse.js").Warning;
//# sourceMappingURL=index.d.ts.map
+1
View File
@@ -0,0 +1 @@
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.js"],"names":[],"mappings":";;wBACa,OAAO,gBAAgB,EAAE,SAAS;sBAClC,OAAO,gBAAgB,EAAE,OAAO;qBAChC,OAAO,gBAAgB,EAAE,MAAM;sBAC/B,OAAO,gBAAgB,EAAE,OAAO"}
+9
View File
@@ -0,0 +1,9 @@
/**
* @typedef {import('./lib/parse.js').Extension} Extension
* @typedef {import('./lib/parse.js').Options} Options
* @typedef {import('./lib/parse.js').Schema} Schema
* @typedef {import('./lib/parse.js').Warning} Warning
*/
export {parse} from './lib/parse.js'
export {stringify} from './lib/stringify.js'
+3
View File
@@ -0,0 +1,3 @@
/** @type {Record<string, string | null>} */
export const normal: Record<string, string | null>;
//# sourceMappingURL=normal.d.ts.map
+1
View File
@@ -0,0 +1 @@
{"version":3,"file":"normal.d.ts","sourceRoot":"","sources":["normal.js"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C,qBADW,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,CA4BvC"}
+29
View File
@@ -0,0 +1,29 @@
/** @type {Record<string, string | null>} */
export const normal = {
'en-gb-oed': 'en-GB-oxendict',
'i-ami': 'ami',
'i-bnn': 'bnn',
'i-default': null,
'i-enochian': null,
'i-hak': 'hak',
'i-klingon': 'tlh',
'i-lux': 'lb',
'i-mingo': null,
'i-navajo': 'nv',
'i-pwn': 'pwn',
'i-tao': 'tao',
'i-tay': 'tay',
'i-tsu': 'tsu',
'sgn-be-fr': 'sfb',
'sgn-be-nl': 'vgt',
'sgn-ch-de': 'sgg',
'art-lojban': 'jbo',
'cel-gaulish': null,
'no-bok': 'nb',
'no-nyn': 'nn',
'zh-guoyu': 'cmn',
'zh-hakka': 'hak',
'zh-min': null,
'zh-min-nan': 'nan',
'zh-xiang': 'hsn'
}
+142
View File
@@ -0,0 +1,142 @@
/**
* Parse a BCP 47 language tag.
*
* > 👉 **Note**: the algorithm is case insensitive.
*
* @param {string} tag
* BCP 47 tag to parse.
* @param {Options | null | undefined} [options]
* Configuration (optional).
* @returns {Schema}
* Parsed BCP 47 language tag.
*/
export function parse(tag: string, options?: Options | null | undefined): Schema;
/**
* Called when an error occurs.
*/
export type Warning = (reason: string, code: number, offset: number) => undefined;
/**
* Configuration.
*/
export type Options = {
/**
* 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`.
*/
forgiving?: boolean | null | undefined;
/**
* 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.
*/
normalize?: boolean | null | undefined;
/**
* When given, `warning` is called when an error is encountered (optional).
*/
warning?: Warning | null | undefined;
};
/**
* Extension.
*/
export type Extension = {
/**
* List of extensions.
*
* Each extension must be between two and eight (inclusive) characters.
*/
extensions: Array<string>;
/**
* One character `singleton`.
*
* `singleton` cannot be `x` (case insensitive).
*/
singleton: string;
};
/**
* Parsed 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).
*/
export type Schema = {
/**
* Selected three-character ISO 639 codes, such as
* `yue` in `zh-yue-HK` (Chinese, Cantonese, as used in Hong Kong SAR).
*/
extendedLanguageSubtags: Array<string>;
/**
* List of extensions, each an object containing a one character `singleton`,
* and a list of `extensions`.
*
* `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.
*/
extensions: Array<Extension>;
/**
* One of the `irregular` tags: 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'`.
*/
irregular: string | null | undefined;
/**
* Two or three character ISO 639 language code, four character reserved
* language code, or 5 to 8 (inclusive) characters registered language subtag.
*
* For example, `en` (English) or `cmn` (Mandarin Chinese).
*/
language: string | null | undefined;
/**
* List of private-use subtags, where each subtag must be between one and
* eight (inclusive) characters.
*/
privateuse: Array<string>;
/**
* Two alphabetical character ISO 3166-1 code or three digit UN M49 code.
*
* 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).
*/
region: string | null | undefined;
/**
* One of the `regular` tags: 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'`, and `'zh-xiang'`.
*/
regular: string | null | undefined;
/**
* Four character ISO 15924 script code, such as `Latn` in
* `hy-Latn-IT-arevela` (Eastern Armenian written in Latin script, as used in
* Italy).
*/
script: string | null | undefined;
/**
* 5 to 8 (inclusive) character language variants, such as `rozaj` and
* `biske` in `sl-rozaj-biske` (San Giorgio dialect of Resian dialect of
* Slovenian).
*/
variants: Array<string>;
};
//# sourceMappingURL=parse.d.ts.map
+1
View File
@@ -0,0 +1 @@
{"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["parse.js"],"names":[],"mappings":"AAoHA;;;;;;;;;;;GAWG;AACH,2BAPW,MAAM,YAEN,OAAO,GAAG,IAAI,GAAG,SAAS,GAExB,MAAM,CA2PlB;;;;+BArXU,MAAM,QAEN,MAAM,UAEN,MAAM,KAEJ,SAAS;;;;;;;;;;;;;;;gBAMR,OAAO,GAAG,IAAI,GAAG,SAAS;;;;;;;;;;;gBAS1B,OAAO,GAAG,IAAI,GAAG,SAAS;;;;cAS1B,OAAO,GAAG,IAAI,GAAG,SAAS;;;;;;;;;;;gBAO1B,KAAK,CAAC,MAAM,CAAC;;;;;;eAIb,MAAM;;;;;;;;;;;;;;6BAaN,KAAK,CAAC,MAAM,CAAC;;;;;;;;;;;;gBAGb,KAAK,CAAC,SAAS,CAAC;;;;;;;;;;eAUhB,MAAM,GAAG,IAAI,GAAG,SAAS;;;;;;;cAQzB,MAAM,GAAG,IAAI,GAAG,SAAS;;;;;gBAKzB,KAAK,CAAC,MAAM,CAAC;;;;;;;;YAGb,MAAM,GAAG,IAAI,GAAG,SAAS;;;;;;;;aAMzB,MAAM,GAAG,IAAI,GAAG,SAAS;;;;;;YAMzB,MAAM,GAAG,IAAI,GAAG,SAAS;;;;;;cAIzB,KAAK,CAAC,MAAM,CAAC"}
+396
View File
@@ -0,0 +1,396 @@
/**
* @callback Warning
* Called when an error occurs.
* @param {string} reason
* Reason for failure in English.
* @param {number} code
* Code for failure.
* @param {number} offset
* index of place where the error occurred in the tag
* @returns {undefined}
*/
/**
* @typedef Options
* Configuration.
* @property {boolean | null | undefined} [forgiving=false]
* 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`.
* @property {boolean | null | undefined} [normalize=true]
* 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.
* @property {Warning | null | undefined} [warning]
* When given, `warning` is called when an error is encountered (optional).
*/
/**
* @typedef Extension
* Extension.
* @property {Array<string>} extensions
* List of extensions.
*
* Each extension must be between two and eight (inclusive) characters.
* @property {string} singleton
* One character `singleton`.
*
* `singleton` cannot be `x` (case insensitive).
*/
/**
* @typedef Schema
* Parsed 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).
* @property {Array<string>} extendedLanguageSubtags
* Selected three-character ISO 639 codes, such as
* `yue` in `zh-yue-HK` (Chinese, Cantonese, as used in Hong Kong SAR).
* @property {Array<Extension>} extensions
* List of extensions, each an object containing a one character `singleton`,
* and a list of `extensions`.
*
* `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.
* @property {string | null | undefined} irregular
* One of the `irregular` tags: 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'`.
* @property {string | null | undefined} language
* Two or three character ISO 639 language code, four character reserved
* language code, or 5 to 8 (inclusive) characters registered language subtag.
*
* For example, `en` (English) or `cmn` (Mandarin Chinese).
* @property {Array<string>} privateuse
* List of private-use subtags, where each subtag must be between one and
* eight (inclusive) characters.
* @property {string | null | undefined} region
* Two alphabetical character ISO 3166-1 code or three digit UN M49 code.
*
* 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).
* @property {string | null | undefined} regular
* One of the `regular` tags: 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'`, and `'zh-xiang'`.
* @property {string | null | undefined} script
* Four character ISO 15924 script code, such as `Latn` in
* `hy-Latn-IT-arevela` (Eastern Armenian written in Latin script, as used in
* Italy).
* @property {Array<string>} variants
* 5 to 8 (inclusive) character language variants, such as `rozaj` and
* `biske` in `sl-rozaj-biske` (San Giorgio dialect of Resian dialect of
* Slovenian).
*/
import {isAlphanumerical} from 'is-alphanumerical'
import {isAlphabetical} from 'is-alphabetical'
import {isDecimal} from 'is-decimal'
import {regular} from './regular.js'
import {normal} from './normal.js'
const own = {}.hasOwnProperty
/**
* Parse a BCP 47 language tag.
*
* > 👉 **Note**: the algorithm is case insensitive.
*
* @param {string} tag
* BCP 47 tag to parse.
* @param {Options | null | undefined} [options]
* Configuration (optional).
* @returns {Schema}
* Parsed BCP 47 language tag.
*/
export function parse(tag, options) {
const settings = options || {}
const result = empty()
const source = String(tag)
const value = source.toLowerCase()
let index = 0
// Check input.
if (tag === null || tag === undefined) {
throw new Error('Expected string, got `' + tag + '`')
}
// Lets start.
// First: the edge cases.
if (own.call(normal, value)) {
const replacement = normal[value]
if (
(settings.normalize === null ||
settings.normalize === undefined ||
settings.normalize) &&
typeof replacement === 'string'
) {
return parse(replacement)
}
result[regular.includes(value) ? 'regular' : 'irregular'] = source
return result
}
// Now, to actually parse, eat what could be a language.
while (isAlphabetical(value.charCodeAt(index)) && index < 9) index++
// A language.
if (index > 1 /* Min 639. */ && index < 9 /* Max subtag. */) {
// 5 and up is a subtag.
// 4 is the size of reserved languages.
// 3 an ISO 639-2 or ISO 639-3.
// 2 is an ISO 639-1.
// <https://github.com/wooorm/iso-639-2>
// <https://github.com/wooorm/iso-639-3>
result.language = source.slice(0, index)
if (index < 4 /* Max 639. */) {
let groups = 0
while (
value.charCodeAt(index) === 45 /* `-` */ &&
isAlphabetical(value.charCodeAt(index + 1)) &&
isAlphabetical(value.charCodeAt(index + 2)) &&
isAlphabetical(value.charCodeAt(index + 3)) &&
!isAlphanumerical(value.charCodeAt(index + 4))
) {
if (groups > 2 /* Max extended language subtag count. */) {
return fail(
index,
3,
'Too many extended language subtags, expected at most 3 subtags'
)
}
// Extended language subtag.
result.extendedLanguageSubtags.push(source.slice(index + 1, index + 4))
index += 4
groups++
}
}
// ISO 15924 script.
// <https://github.com/wooorm/iso-15924>
if (
value.charCodeAt(index) === 45 /* `-` */ &&
isAlphabetical(value.charCodeAt(index + 1)) &&
isAlphabetical(value.charCodeAt(index + 2)) &&
isAlphabetical(value.charCodeAt(index + 3)) &&
isAlphabetical(value.charCodeAt(index + 4)) &&
!isAlphanumerical(value.charCodeAt(index + 5))
) {
result.script = source.slice(index + 1, index + 5)
index += 5
}
if (value.charCodeAt(index) === 45 /* `-` */) {
// ISO 3166-1 region.
// <https://github.com/wooorm/iso-3166>
if (
isAlphabetical(value.charCodeAt(index + 1)) &&
isAlphabetical(value.charCodeAt(index + 2)) &&
!isAlphanumerical(value.charCodeAt(index + 3))
) {
result.region = source.slice(index + 1, index + 3)
index += 3
}
// UN M49 region.
// <https://github.com/wooorm/un-m49>
else if (
isDecimal(value.charCodeAt(index + 1)) &&
isDecimal(value.charCodeAt(index + 2)) &&
isDecimal(value.charCodeAt(index + 3)) &&
!isAlphanumerical(value.charCodeAt(index + 4))
) {
result.region = source.slice(index + 1, index + 4)
index += 4
}
}
while (value.charCodeAt(index) === 45 /* `-` */) {
const start = index + 1
let offset = start
while (isAlphanumerical(value.charCodeAt(offset))) {
if (offset - start > 7 /* Max variant. */) {
return fail(
offset,
1,
'Too long variant, expected at most 8 characters'
)
}
offset++
}
if (
// Long variant.
offset - start > 4 /* Min alpha numeric variant. */ ||
// Short variant.
(offset - start > 3 /* Min variant. */ &&
isDecimal(value.charCodeAt(start)))
) {
result.variants.push(source.slice(start, offset))
index = offset
}
// Something else.
else {
break
}
}
// Extensions.
while (value.charCodeAt(index) === 45 /* `-` */) {
// Exit if this isnt an extension.
if (
value.charCodeAt(index + 1) === 120 /* `x` */ ||
!isAlphanumerical(value.charCodeAt(index + 1)) ||
value.charCodeAt(index + 2) !== 45 /* `-` */ ||
!isAlphanumerical(value.charCodeAt(index + 3))
) {
break
}
let offset = index + 2
let groups = 0
while (
value.charCodeAt(offset) === 45 /* `-` */ &&
isAlphanumerical(value.charCodeAt(offset + 1)) &&
isAlphanumerical(value.charCodeAt(offset + 2))
) {
const start = offset + 1
offset = start + 2
groups++
while (isAlphanumerical(value.charCodeAt(offset))) {
if (offset - start > 7 /* Max extension. */) {
return fail(
offset,
2,
'Too long extension, expected at most 8 characters'
)
}
offset++
}
}
if (!groups) {
return fail(
offset,
4,
'Empty extension, extensions must have at least 2 characters of content'
)
}
result.extensions.push({
extensions: source.slice(index + 3, offset).split('-'),
singleton: source.charAt(index + 1)
})
index = offset
}
}
// Not a language.
else {
index = 0
}
// Private use.
if (
(index === 0 && value.charCodeAt(index) === 120) /* `x` */ ||
(value.charCodeAt(index) === 45 /* `-` */ &&
value.charCodeAt(index + 1) === 120) /* `x` */
) {
index = index ? index + 2 : 1
let offset = index
while (
value.charCodeAt(offset) === 45 /* `-` */ &&
isAlphanumerical(value.charCodeAt(offset + 1))
) {
const start = index + 1
offset = start
while (isAlphanumerical(value.charCodeAt(offset))) {
if (offset - start > 7 /* Max private use. */) {
return fail(
offset,
5,
'Too long private-use area, expected at most 8 characters'
)
}
offset++
}
result.privateuse.push(source.slice(index + 1, offset))
index = offset
}
}
if (index !== source.length) {
return fail(index, 6, 'Found superfluous content after tag')
}
return result
/**
* Stop.
*
* @param {number} offset
* @param {number} code
* @param {string} reason
* @returns {Schema}
*/
function fail(offset, code, reason) {
if (settings.warning) settings.warning(reason, code, offset)
return settings.forgiving ? result : empty()
}
}
/**
* Create an empty results object.
*
* @returns {Schema}
*/
function empty() {
return {
extendedLanguageSubtags: [],
extensions: [],
irregular: null,
language: null,
privateuse: [],
region: null,
regular: null,
script: null,
variants: []
}
}
+3
View File
@@ -0,0 +1,3 @@
/** @type {Array<string>} */
export const regular: Array<string>;
//# sourceMappingURL=regular.d.ts.map
+1
View File
@@ -0,0 +1 @@
{"version":3,"file":"regular.d.ts","sourceRoot":"","sources":["regular.js"],"names":[],"mappings":"AAAA,4BAA4B;AAC5B,sBADW,KAAK,CAAC,MAAM,CAAC,CAWvB"}
+12
View File
@@ -0,0 +1,12 @@
/** @type {Array<string>} */
export const regular = [
'art-lojban',
'cel-gaulish',
'no-bok',
'no-nyn',
'zh-guoyu',
'zh-hakka',
'zh-min',
'zh-min-nan',
'zh-xiang'
]
+14
View File
@@ -0,0 +1,14 @@
/**
* @import {Schema} from './parse.js'
*/
/**
* Compile a language schema to a BCP 47 language tag.
*
* @param {Partial<Schema> | null | undefined} [schema]
* Schema.
* @returns {string}
* BCP 47 tag.
*/
export function stringify(schema?: Partial<Schema> | null | undefined): string;
import type { Schema } from './parse.js';
//# sourceMappingURL=stringify.d.ts.map
+1
View File
@@ -0,0 +1 @@
{"version":3,"file":"stringify.d.ts","sourceRoot":"","sources":["stringify.js"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;;;GAOG;AACH,mCALW,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,SAAS,GAEhC,MAAM,CA2ClB;4BAnDwB,YAAY"}
+53
View File
@@ -0,0 +1,53 @@
/**
* @import {Schema} from './parse.js'
*/
/**
* Compile a language schema to a BCP 47 language tag.
*
* @param {Partial<Schema> | null | undefined} [schema]
* Schema.
* @returns {string}
* BCP 47 tag.
*/
export function stringify(schema) {
const info = schema || {}
/** @type {Array<string>} */
let result = []
if (info.irregular) {
return info.irregular
}
if (info.regular) {
return info.regular
}
if (info.language) {
// eslint-disable-next-line unicorn/prefer-spread
result = result.concat(
info.language,
info.extendedLanguageSubtags || [],
info.script || [],
info.region || [],
info.variants || []
)
const values = info.extensions || []
let index = -1
while (++index < values.length) {
const value = values[index]
if (value.singleton && value.extensions && value.extensions.length > 0) {
result.push(value.singleton, ...value.extensions)
}
}
}
if (info.privateuse && info.privateuse.length > 0) {
result.push('x', ...info.privateuse)
}
return result.join('-')
}
+22
View File
@@ -0,0 +1,22 @@
(The MIT License)
Copyright (c) Titus Wormer <tituswormer@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+76
View File
@@ -0,0 +1,76 @@
{
"author": "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)",
"bugs": "https://github.com/wooorm/bcp-47/issues",
"contributors": [
"Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)"
],
"dependencies": {
"is-alphabetical": "^2.0.0",
"is-alphanumerical": "^2.0.0",
"is-decimal": "^2.0.0"
},
"description": "Parse and stringify BCP 47 language tags",
"devDependencies": {
"@types/node": "^26.0.0",
"c8": "^11.0.0",
"is-hidden": "^2.0.0",
"prettier": "^3.0.0",
"remark-cli": "^12.0.0",
"remark-preset-wooorm": "^11.0.0",
"type-coverage": "^2.0.0",
"typescript": "^6.0.0",
"xo": "^2.0.0"
},
"files": [
"index.d.ts.map",
"index.d.ts",
"index.js",
"lib/"
],
"funding": {
"type": "github",
"url": "https://github.com/sponsors/wooorm"
},
"keywords": [
"bcp",
"47",
"bcp47",
"bcp-47",
"language",
"tag",
"parse"
],
"license": "MIT",
"main": "index.js",
"name": "bcp-47",
"prettier": {
"bracketSpacing": false,
"semi": false,
"singleQuote": true,
"tabWidth": 2,
"trailingComma": "none",
"useTabs": false
},
"remarkConfig": {
"plugins": [
"remark-preset-wooorm"
]
},
"repository": "wooorm/bcp-47",
"scripts": {
"build": "tsc --build --clean && tsc --build && type-coverage",
"format": "remark --frail --output --quiet -- . && prettier --log-level warn --write -- . && xo --fix",
"prepack": "npm run build && npm run format",
"test-api": "node --conditions development test/index.js",
"test-coverage": "c8 --100 --reporter lcov -- npm run test-api",
"test": "npm run build && npm run format && npm run test-coverage"
},
"sideEffects": false,
"typeCoverage": {
"atLeast": 100,
"strict": true
},
"types": "index.d.ts",
"type": "module",
"version": "2.1.1"
}
+345
View File
@@ -0,0 +1,345 @@
# 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
<script type="module">
import * as bcp47 from 'https://esm.sh/bcp-47@2?bundle'
</script>
```
## 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`][api-warning]).
###### Returns
Parsed BCP 47 language tag ([`Schema`][api-schema]).
###### Throws
When `tag` is `null` or `undefined`.
### `stringify(schema)`
Compile a [`schema`][api-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<string>`), 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<string>`), such as
`rozaj` and `biske` in `sl-rozaj-biske` (San Giorgio dialect of Resian dialect
of Slovenian).
###### `schema.extensions`
List of extensions (`Array<Object>`), 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<string>`), 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]
<!-- Definitions -->
[api-schema]: #schema
[api-warning]: #function-warningreason-code-offset
[author]: https://wooorm.com
[build]: https://github.com/wooorm/bcp-47/actions
[build-badge]: https://github.com/wooorm/bcp-47/workflows/main/badge.svg
[contribute]: https://opensource.guide/how-to-contribute/
[coverage]: https://codecov.io/github/wooorm/bcp-47
[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/bcp-47.svg
[downloads]: https://www.npmjs.com/package/bcp-47
[downloads-badge]: https://img.shields.io/npm/dm/bcp-47.svg
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[esmsh]: https://esm.sh
[iso-15924]: https://en.wikipedia.org/wiki/ISO_15924
[iso-3166-1]: https://en.wikipedia.org/wiki/ISO_3166-1
[iso-639]: https://en.wikipedia.org/wiki/ISO_639
[license]: license
[npm]: https://docs.npmjs.com/cli/install
[size]: https://bundlephobia.com/result?p=bcp-47
[size-badge]: https://img.shields.io/bundlephobia/minzip/bcp-47.svg
[spec]: https://www.rfc-editor.org/info/bcp47/
[typescript]: https://www.typescriptlang.org
[un-m49]: https://en.wikipedia.org/wiki/UN_M.49