@inlang/language-tag - npm Package Compare versions

Comparing version 1.1.1 to 1.2.0

dist/interface.d.ts

@@ -5,4 +5,2 @@ import { type Static } from "@sinclair/typebox";
  *
- * // TODO: add (regex) validation
- *
  * @see https://www.ietf.org/rfc/bcp/bcp47.txt
@@ -12,3 +10,7 @@ * @see https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry
 export type LanguageTag = Static<typeof LanguageTag>;
+/**
+ * Follows the IETF BCP 47 language tag schema with modifications.
+ * @see REAMDE.md file for more information on the validation.
+ */
 export declare const LanguageTag: import("@sinclair/typebox").TString;
 //# sourceMappingURL=interface.d.ts.map

dist/interface.js

 import { Type } from "@sinclair/typebox";
-export const LanguageTag = Type.String();
+/**
+ * Follows the IETF BCP 47 language tag schema with modifications.
+ * @see REAMDE.md file for more information on the validation.
+ */
+export const LanguageTag = Type.String({
+    pattern: "^((?<grandfathered>(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)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang))|((?<language>([A-Za-z]{2,3}(-(?<extlang>[A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?))(-(?<script>[A-Za-z]{4}))?(-(?<region>[A-Za-z]{2}|[0-9]{3}))?(-(?<variant>[A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*))$",
+    examples: ["en", "de", "en-US", "zh-Hans", "es-419"],
+});

package.json

 {
 	"name": "@inlang/language-tag",
 	"type": "module",
-	"version": "1.1.1",
+	"version": "1.2.0",
 	"license": "Apache-2.0",
@@ -6,0 +6,0 @@ "publishConfig": {

README.md

@@ -0,1 +1,63 @@
+
 [BCP-47 language tags](https://en.wikipedia.org/wiki/IETF_language_tag) types and validators.
+
+> Always bear in mind that the golden rule is to keep your language tag as short as possible. Only add further subtags to your language tag if they are needed to distinguish the language from something else in the context where your content is used.
+
+## What is a language tag?
+
+A language tag is a code that represents a language. It is used to identify the language of a text or other content. Language tags are defined by the [IETF](https://en.wikipedia.org/wiki/IETF_language_tag) in [BCP-47](https://www.rfc-editor.org/info/bcp47).
+
+## Validation
+
+Further information on choosing the language tag for your content can be found in the [W3C article on choosing language tags](https://www.w3.org/International/questions/qa-choosing-language-tags).
+
+```js
+/^(
+  (?<grandfathered>
+    (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)|
+    (art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)
+  )|
+  (
+    (?<language>
+      ([A-Za-z]{2,3}(-(?<extlang>[A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)
+      ([A-Za-z]{2,3}(-(?<extlang>[A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|
+      [A-Za-z]{4}|[A-Za-z]{5,8}
+    )
+    (-(?<script>[A-Za-z]{4}))?
+    (-(?<region>[A-Za-z]{2}|[0-9]{3}))?
+    (-(?<variant>[A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*
+    (-(?<extension>[0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*
+    (-(?<privateUse>x(-[A-Za-z0-9]{1,8})+))?
+  )
+  |
+  (?<privateUse>x(-[A-Za-z0-9]{1,8})+)
+)$/;
+```
+
+## How to use
+
+Use this library to validate language tags in your application.
+
+You can import the types to validate language tags in your application:
+
+```ts
+import { LanguageTag } from "@inlang/language-tag"
+
+
+myLanguageTag = exampleTag as LanguageTag
+```
+
+## Install
+
+You can install the @inlang/cli with this command:
+
+```sh
+npm install @inlang/language-tag
+```
+
+or
+
+```sh
+yarn add @inlang/language-tag
+```

src/interface.ts

@@ -6,4 +6,2 @@ import { Type, type Static } from "@sinclair/typebox"
  *
- * // TODO: add (regex) validation
- *
  * @see https://www.ietf.org/rfc/bcp/bcp47.txt
@@ -13,2 +11,10 @@ * @see https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry
 export type LanguageTag = Static<typeof LanguageTag>
-export const LanguageTag = Type.String()
+/**
+ * Follows the IETF BCP 47 language tag schema with modifications.
+ * @see REAMDE.md file for more information on the validation.
+ */
+export const LanguageTag = Type.String({
+	pattern:
+		"^((?<grandfathered>(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)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang))|((?<language>([A-Za-z]{2,3}(-(?<extlang>[A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?))(-(?<script>[A-Za-z]{4}))?(-(?<region>[A-Za-z]{2}|[0-9]{3}))?(-(?<variant>[A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*))$",
+	examples: ["en", "de", "en-US", "zh-Hans", "es-419"],
+})

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

8130

increased by266.88%

Number of package files

14

increased by40%

Lines of code

129

increased by377.78%

Number of lines in readme file

63

increased by3050%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes