is-language-code 1.0.10 → 2.0.0

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## 2.0.0 (2020-11-28)
+
+### Features
+
+- init ([00776db](https://git.sr.ht/~royston/codsen/commits/00776db3a81ecd9a683580fd459a756c462338f5))
+
+### BREAKING CHANGES
+
+- init
+
 ## 1.0.0 (2020-01-05)
 
 ### Features

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2015-2020 Roy Revelt and other contributors
+Copyright (c) 2010-2020 Roy Revelt and other contributors
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

package/README.md

@@ -2,7 +2,27 @@
 
 > Is given string a language code (as per IANA)
 
-<img src="https://codsen.com/images/png-codsen-1.png" width="148" alt="codsen" align="center">
+<div class="package-badges">
+  <a href="https://www.npmjs.com/package/is-language-code" rel="nofollow noreferrer noopener">
+    <img src="https://img.shields.io/badge/-npm-blue?style=flat-square" alt="page on npm">
+  </a>
+  <a href="https://codsen.com/os/is-language-code" rel="nofollow noreferrer noopener">
+    <img src="https://img.shields.io/badge/-codsen-blue?style=flat-square" alt="page on codsen.com">
+  </a>
+  <a href="https://git.sr.ht/~royston/codsen/tree/master/packages/is-language-code" rel="nofollow noreferrer noopener">
+    <img src="https://img.shields.io/badge/-sourcehut-blue?style=flat-square" alt="page on sourcehut">
+  </a>
+  <a href="https://npmcharts.com/compare/is-language-code?interval=30" rel="nofollow noreferrer noopener" target="_blank">
+    <img src="https://img.shields.io/npm/dm/is-language-code.svg?style=flat-square" alt="Downloads per month">
+  </a>
+  <a href="https://prettier.io" rel="nofollow noreferrer noopener" target="_blank">
+    <img src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg?style=flat-square" alt="Code style: prettier">
+  </a>
+  <img src="https://img.shields.io/badge/licence-MIT-brightgreen.svg?style=flat-square" alt="MIT License">
+  <a href="https://liberamanifesto.com" rel="nofollow noreferrer noopener" target="_blank">
+    <img src="https://img.shields.io/badge/libera-manifesto-lightgrey.svg?style=flat-square" alt="libera manifesto">
+  </a>
+</div>
 
 ## Install
 
@@ -10,18 +30,31 @@
 npm i is-language-code
 ```
 
-<img src="https://codsen.com/images/png-codsen-ok.png" width="98" alt="ok" align="center">
+## Quick Take
 
-## Documentation
+```js
+import { strict as assert } from "assert";
+import isLangCode from "dist/is-language-code.esm";
+
+assert.deepEqual(isLangCode("de-419-DE"), {
+  res: false,
+  message: 'Two region subtags, "419" and "de".',
+});
 
-Please [visit our documentation](https://codsen.com/os/is-language-code/) for a full description of the API and examples.
+assert.deepEqual(isLangCode("sr-Latn"), {
+  res: true,
+  message: null,
+});
+```
+
+## Documentation
 
-<img src="https://codsen.com/images/png-codsen-star.png" width="42" alt="star" align="center">
+Please [visit codsen.com](https://codsen.com/os/is-language-code/) for a full description of the API and examples.
 
 ## Licence
 
 MIT License
 
-Copyright (c) 2015-2020 Roy Revelt and other contributors
+Copyright (c) 2010-2020 Roy Revelt and other contributors
 
-<img src="https://codsen.com/images/png-codsen-star-small.png" width="32" alt="star" align="center">
+<img src="https://codsen.com/images/png-codsen-ok.png" width="98" alt="ok" align="center"> <img src="https://codsen.com/images/png-codsen-1.png" width="148" alt="codsen" align="center"> <img src="https://codsen.com/images/png-codsen-star-small.png" width="32" alt="star" align="center">

package/dist/is-language-code.cjs.js

@@ -1,7 +1,7 @@
 /**
  * is-language-code
  * Is given string a language code (as per IANA)
- * Version: 1.0.10
+ * Version: 2.0.0
  * Author: Roy Revelt, Codsen Ltd
  * License: MIT
  * Homepage: https://codsen.com/os/is-language-code/

package/dist/is-language-code.dev.umd.js

@@ -1,7 +1,7 @@
 /**
  * is-language-code
  * Is given string a language code (as per IANA)
- * Version: 1.0.10
+ * Version: 2.0.0
  * Author: Roy Revelt, Codsen Ltd
  * License: MIT
  * Homepage: https://codsen.com/os/is-language-code/

package/dist/is-language-code.esm.js

@@ -1,7 +1,7 @@
 /**
  * is-language-code
  * Is given string a language code (as per IANA)
- * Version: 1.0.10
+ * Version: 2.0.0
  * Author: Roy Revelt, Codsen Ltd
  * License: MIT
  * Homepage: https://codsen.com/os/is-language-code/

package/dist/is-language-code.umd.js

@@ -1,7 +1,7 @@
 /**
  * is-language-code
  * Is given string a language code (as per IANA)
- * Version: 1.0.10
+ * Version: 2.0.0
  * Author: Roy Revelt, Codsen Ltd
  * License: MIT
  * Homepage: https://codsen.com/os/is-language-code/

package/examples/_quickTake.js

@@ -0,0 +1,16 @@
+/* eslint import/extensions:0, no-unused-vars:0 */
+
+// Quick Take
+
+import { strict as assert } from "assert";
+import isLangCode from "../dist/is-language-code.esm";
+
+assert.deepEqual(isLangCode("de-419-DE"), {
+  res: false,
+  message: 'Two region subtags, "419" and "de".',
+});
+
+assert.deepEqual(isLangCode("sr-Latn"), {
+  res: true,
+  message: null,
+});

package/examples/api.json

@@ -0,0 +1 @@
+{"_quickTake.js":{"title":"Quick Take","content":"import { strict as assert } from \"assert\";\nimport isLangCode from \"dist/is-language-code.esm\";\n\nassert.deepEqual(isLangCode(\"de-419-DE\"), {\n  res: false,\n  message: 'Two region subtags, \"419\" and \"de\".',\n});\n\nassert.deepEqual(isLangCode(\"sr-Latn\"), {\n  res: true,\n  message: null,\n});"},"various.js":{"title":"Quick Take","content":"import { strict as assert } from \"assert\";\nimport isLangCode from \"dist/is-language-code.esm\";\n\nassert.equal(isLangCode(\"de\").res, true);\n// => true because it's a German language code\n\nassert.equal(isLangCode(\"fr\").res, true);\n// => true because it's a French language code\n\nassert.equal(isLangCode(\"ja\").res, true);\n// => true because it's a Japanese language code\n\nassert.equal(isLangCode(\"zzz\").res, false);\n// => false - unrecognised. npm package \"ietf-language-tag-regex\" would fail this\n\nassert.equal(isLangCode(\"1\").res, false);\n// => false - not recognised language code\n\nassert.equal(isLangCode(\"x-klingon\").res, true);\n// => true - private use\n\nassert.equal(isLangCode(\"x-whatever\").res, true);\n// => true - private use\n\nassert.equal(isLangCode(\"zh-Hant\").res, true);\n// => true - Chinese written using the Traditional Chinese script\n\nassert.equal(isLangCode(\"zh-cmn-Hans-CN\").res, true);\n// => true - Chinese, Mandarin, Simplified script, as used in China\n\nassert.equal(isLangCode(\"zh-Hans-CN\").res, true);\n// => true - Chinese written using the Simplified script as used in mainland China\n\nassert.equal(isLangCode(\"sr-Latn-RS\").res, true);\n// => true - Serbian written using the Latin script as used in Serbia\n\nassert.equal(isLangCode(\"sl-rozaj\").res, true);\n// => true - Resian dialect of Slovenian\n\nassert.equal(isLangCode(\"sl-nedis\").res, true);\n// => true - Nadiza dialect of Slovenian\n\nassert.equal(isLangCode(\"de-CH-1901\").res, true);\n// => true - German as used in Switzerland using the 1901 variant [orthography]\n\nassert.equal(isLangCode(\"sl-IT-nedis\").res, true);\n// => true - Slovenian as used in Italy, Nadiza dialect\n\nassert.equal(isLangCode(\"hy-Latn-IT-arevela\").res, true);\n// => true - Eastern Armenian written in Latin script, as used in Italy\n\nassert.equal(isLangCode(\"en-US\").res, true);\n// => true - English as used in the United States\n\nassert.equal(isLangCode(\"de-CH-x-phonebk\").res, true);\n// => true - private use subtag (x-)\n\nassert.equal(isLangCode(\"az-Arab-x-AZE-derbend\").res, true);\n// => true - private use subtag\n\nassert.equal(isLangCode(\"x-whatever\").res, true);\n// => true - private use subtag using singleton x-\n\nassert.equal(isLangCode(\"qaa-Qaaa-QM-x-southern\").res, true);\n// => true\n\nassert.equal(isLangCode(\"de-Qaaa\").res, true);\n// => true - private use script subtag (Qaaa)\n\nassert.equal(isLangCode(\"sr-Latn-QM\").res, true);\n// => true - Serbian, Latin script, private region QM\n\nassert.equal(isLangCode(\"en-US-u-islamcal\").res, true);\n// => true - tag with extension\n\nassert.equal(isLangCode(\"zh-CN-a-myext-x-private\").res, true);\n// => true - tag with extension\n\nassert.equal(isLangCode(\"en-a-myext-b-another\").res, true);\n// => true - tag with extension\n\nassert.equal(isLangCode(\"de-419-DE\").res, false);\n// => false - two region tags\n\nassert.equal(isLangCode(\"a-DE\").res, false);\n// => false - use of a single-character subtag in primary position\n\nassert.equal(isLangCode(\"ar-a-aaa-b-bbb-a-ccc\").res, false);\n// => false - two extensions with same single-letter prefix"}}

package/examples/various.js

@@ -0,0 +1,93 @@
+/* eslint import/extensions:0, no-unused-vars:0 */
+
+// Quick Take
+
+import { strict as assert } from "assert";
+import isLangCode from "../dist/is-language-code.esm";
+
+assert.equal(isLangCode("de").res, true);
+// => true because it's a German language code
+
+assert.equal(isLangCode("fr").res, true);
+// => true because it's a French language code
+
+assert.equal(isLangCode("ja").res, true);
+// => true because it's a Japanese language code
+
+assert.equal(isLangCode("zzz").res, false);
+// => false - unrecognised. npm package "ietf-language-tag-regex" would fail this
+
+assert.equal(isLangCode("1").res, false);
+// => false - not recognised language code
+
+assert.equal(isLangCode("x-klingon").res, true);
+// => true - private use
+
+assert.equal(isLangCode("x-whatever").res, true);
+// => true - private use
+
+assert.equal(isLangCode("zh-Hant").res, true);
+// => true - Chinese written using the Traditional Chinese script
+
+assert.equal(isLangCode("zh-cmn-Hans-CN").res, true);
+// => true - Chinese, Mandarin, Simplified script, as used in China
+
+assert.equal(isLangCode("zh-Hans-CN").res, true);
+// => true - Chinese written using the Simplified script as used in mainland China
+
+assert.equal(isLangCode("sr-Latn-RS").res, true);
+// => true - Serbian written using the Latin script as used in Serbia
+
+assert.equal(isLangCode("sl-rozaj").res, true);
+// => true - Resian dialect of Slovenian
+
+assert.equal(isLangCode("sl-nedis").res, true);
+// => true - Nadiza dialect of Slovenian
+
+assert.equal(isLangCode("de-CH-1901").res, true);
+// => true - German as used in Switzerland using the 1901 variant [orthography]
+
+assert.equal(isLangCode("sl-IT-nedis").res, true);
+// => true - Slovenian as used in Italy, Nadiza dialect
+
+assert.equal(isLangCode("hy-Latn-IT-arevela").res, true);
+// => true - Eastern Armenian written in Latin script, as used in Italy
+
+assert.equal(isLangCode("en-US").res, true);
+// => true - English as used in the United States
+
+assert.equal(isLangCode("de-CH-x-phonebk").res, true);
+// => true - private use subtag (x-)
+
+assert.equal(isLangCode("az-Arab-x-AZE-derbend").res, true);
+// => true - private use subtag
+
+assert.equal(isLangCode("x-whatever").res, true);
+// => true - private use subtag using singleton x-
+
+assert.equal(isLangCode("qaa-Qaaa-QM-x-southern").res, true);
+// => true
+
+assert.equal(isLangCode("de-Qaaa").res, true);
+// => true - private use script subtag (Qaaa)
+
+assert.equal(isLangCode("sr-Latn-QM").res, true);
+// => true - Serbian, Latin script, private region QM
+
+assert.equal(isLangCode("en-US-u-islamcal").res, true);
+// => true - tag with extension
+
+assert.equal(isLangCode("zh-CN-a-myext-x-private").res, true);
+// => true - tag with extension
+
+assert.equal(isLangCode("en-a-myext-b-another").res, true);
+// => true - tag with extension
+
+assert.equal(isLangCode("de-419-DE").res, false);
+// => false - two region tags
+
+assert.equal(isLangCode("a-DE").res, false);
+// => false - use of a single-character subtag in primary position
+
+assert.equal(isLangCode("ar-a-aaa-b-bbb-a-ccc").res, false);
+// => false - two extensions with same single-letter prefix

package/package.json

@@ -1,15 +1,7 @@
 {
   "name": "is-language-code",
-  "version": "1.0.10",
+  "version": "2.0.0",
   "description": "Is given string a language code (as per IANA)",
-  "license": "MIT",
-  "repository": "https://gitlab.com/codsen/codsen/",
-  "homepage": "https://codsen.com/os/is-language-code/",
-  "author": {
-    "email": "roy@codsen.com",
-    "name": "Roy Revelt",
-    "url": "codsen.com"
-  },
   "keywords": [
     "check",
     "code",
@@ -28,6 +20,14 @@
     "valid",
     "validate"
   ],
+  "homepage": "https://codsen.com/os/is-language-code/",
+  "repository": "https://git.sr.ht/~royston/codsen",
+  "license": "MIT",
+  "author": {
+    "name": "Roy Revelt",
+    "email": "roy@codsen.com",
+    "url": "https://codsen.com"
+  },
   "main": "dist/is-language-code.cjs.js",
   "module": "dist/is-language-code.esm.js",
   "browser": "dist/is-language-code.umd.js",
@@ -46,7 +46,8 @@
     "republish": "npm publish || :",
     "tap": "tap",
     "pretest": "npm run build",
-    "test": "npm run lint && npm run unittest && npm run clean_cov && npm run format",
+    "test": "npm run lint && npm run unittest && npm run test:examples && npm run clean_cov && npm run format",
+    "test:examples": "../../scripts/test-examples.js && npm run lect && npm run prettier",
     "tsd": "tsd",
     "unittest": "./node_modules/.bin/tap --no-only --output-file=testStats.md && npm run clean_cov && npm run perf",
     "version": "npm run build && git add ."
@@ -56,6 +57,17 @@
       "pre-commit": "npm run format && npm test"
     }
   },
+  "tap": {
+    "coverage-report": [
+      "json-summary",
+      "text"
+    ],
+    "nyc-arg": [
+      "--exclude=**/*.cjs.js",
+      "--exclude=**/*.umd.js"
+    ],
+    "timeout": 0
+  },
   "lect": {
     "defaultExported": true,
     "files": {
@@ -85,45 +97,33 @@
       "goodFolders": []
     },
     "req": "isLangCode",
-    "typeSriptDefinitions": false,
     "various": {
       "devDependencies": [
         "@rollup/plugin-json"
       ]
     }
   },
-  "tap": {
-    "coverage-report": [
-      "json-summary",
-      "text"
-    ],
-    "nyc-arg": [
-      "--exclude=**/*.cjs.js",
-      "--exclude=**/*.umd.js"
-    ],
-    "timeout": 0
-  },
   "devDependencies": {
-    "@babel/core": "^7.11.6",
-    "@babel/plugin-proposal-class-properties": "^7.10.4",
-    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.10.4",
-    "@babel/plugin-proposal-object-rest-spread": "^7.11.0",
-    "@babel/plugin-proposal-optional-chaining": "^7.11.0",
-    "@babel/preset-env": "^7.11.5",
-    "@rollup/plugin-babel": "^5.2.0",
-    "@rollup/plugin-commonjs": "^15.0.0",
+    "@babel/core": "^7.12.7",
+    "@babel/plugin-proposal-class-properties": "^7.12.1",
+    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.12.1",
+    "@babel/plugin-proposal-object-rest-spread": "^7.12.1",
+    "@babel/plugin-proposal-optional-chaining": "^7.12.7",
+    "@babel/preset-env": "^7.12.7",
+    "@rollup/plugin-babel": "^5.2.1",
+    "@rollup/plugin-commonjs": "^16.0.0",
     "@rollup/plugin-json": "^4.1.0",
-    "@rollup/plugin-node-resolve": "^9.0.0",
+    "@rollup/plugin-node-resolve": "^10.0.0",
     "@rollup/plugin-strip": "^2.0.0",
     "benchmark": "^2.1.4",
-    "eslint": "^7.8.1",
-    "lect": "^0.13.11",
-    "rollup": "^2.26.10",
+    "eslint": "^7.14.0",
+    "lect": "^0.15.0",
+    "rollup": "^2.33.3",
     "rollup-plugin-ascii": "^0.0.3",
     "rollup-plugin-banner": "^0.2.1",
-    "rollup-plugin-cleanup": "^3.1.1",
+    "rollup-plugin-cleanup": "^3.2.1",
     "rollup-plugin-terser": "^7.0.2",
-    "tap": "^14.10.8",
+    "tap": "^14.11.0",
     "tsd": "^0.13.1"
   }
 }