Fixes #669: use the language-tags package to check the lang rule

The `language-tags` package provides language tag validation functionality based on the latest IANA language subtag registry. This PR makes use of this package instead of manually parsing tags like before. File `src/util/attributes/ISO.json` is removed then. Signed-off-by: imtsuki <me@qjx.app>
jsx-eslint · Mar 13, 2020 · 42a2016 · 42a2016
1 parent 7bcea20
commit 42a2016
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 401 deletions.
diff --git a/__tests__/src/rules/lang-test.js b/__tests__/src/rules/lang-test.js
@@ -30,6 +30,10 @@ ruleTester.run('lang', rule, {
     { code: '<div lang="foo" />;' },
     { code: '<html lang="en" />' },
     { code: '<html lang="en-US" />' },
+    { code: '<html lang="zh-Hans" />' },
+    { code: '<html lang="zh-Hant-HK" />' },
+    { code: '<html lang="zh-yue-Hant" />' },
+    { code: '<html lang="ja-Latn" />' },
     { code: '<html lang={foo} />' },
     { code: '<HTML lang="foo" />' },
     { code: '<Foo lang="bar" />' },

diff --git a/docs/rules/lang.md b/docs/rules/lang.md
@@ -1,17 +1,19 @@
 # lang
 
-The `lang` prop on the `<html>` element must have a valid value based on ISO country and language codes.
+The `lang` prop on the `<html>` element must be a valid IETF's BCP 47 language tag.
 
 #### References
+
 1. [axe-core, valid-lang](https://dequeuniversity.com/rules/axe/3.2/valid-lang)
-2. [ISO Language Codes](http://www.w3schools.com/tags/ref_language_codes.asp)
-3. [ISO Country Codes](http://www.w3schools.com/tags/ref_country_codes.asp)
+2. [Language tags in HTML and XML](https://www.w3.org/International/articles/language-tags/)
+3. [IANA Language Subtag Registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry)
 
 ## Rule details
 
 This rule takes no arguments.
 
 ### Succeed
+
 ```jsx
 <html lang="en">
 <html lang="en-US">

diff --git a/package.json b/package.json
@@ -67,7 +67,8 @@
     "damerau-levenshtein": "^1.0.4",
     "emoji-regex": "^7.0.2",
     "has": "^1.0.3",
-    "jsx-ast-utils": "^2.2.1"
+    "jsx-ast-utils": "^2.2.1",
+    "language-tags": "^1.0.5"
   },
   "peerDependencies": {
     "eslint": "^3 || ^4 || ^5 || ^6"

diff --git a/src/rules/lang.js b/src/rules/lang.js
@@ -8,8 +8,8 @@
 // ----------------------------------------------------------------------------
 
 import { propName, elementType, getLiteralPropValue } from 'jsx-ast-utils';
+import tags from 'language-tags';
 import { generateObjSchema } from '../util/schemas';
-import ISO_CODES from '../util/attributes/ISO.json';
 
 const errorMessage = 'lang attribute must have a valid value.';
 
@@ -51,12 +51,7 @@ module.exports = {
         return;
       }
 
-      const hyphen = value.indexOf('-');
-      const lang = hyphen > -1 ? value.substring(0, hyphen) : value;
-      const country = hyphen > -1 ? value.substring(3) : undefined;
-
-      if (ISO_CODES.languages.indexOf(lang) > -1
-        && (country === undefined || ISO_CODES.countries.indexOf(country) > -1)) {
+      if (tags.check(value)) {
         return;
       }