i18nizeelement 0.4.0 → 0.5.1

package/package.json

@@ -1,12 +1,24 @@
 {
   "name": "i18nizeelement",
-  "version": "0.4.0",
+  "version": "0.5.1",
   "author": "Brett Zamir",
   "contributors": [],
   "license": "MIT",
   "description": "Internationalize an element with `lang`, `dir`, and `style.writingMode` as indicated by the supplied language and settings",
+  "type": "module",
   "main": "dist/i18nizeelement.umd.js",
-  "module": "dist/i18nizeelement.es6.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/i18nizeelement.es6.js",
+      "require": "./dist/i18nizeelement.umd.js"
+    },
+    "./jamilih-plugin.js": {
+      "types": "./dist/i18nizeelement-jamilih-plugin.d.ts",
+      "import": "./dist/i18nizeelement-jamilih-plugin.es6.js",
+      "require": "./dist/i18nizeelement-jamilih-plugin.umd.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/brettz9/i18nizeElement"
@@ -19,55 +31,60 @@
     "rtl"
   ],
   "scripts": {
+    "copy": "cp i18nizeelement-jamilih-plugin.es6.d.ts dist/i18nizeelement-jamilih-plugin.es6.d.ts",
+    "lint": "npm run eslint",
     "eslint": "eslint --ext=js,md,html .",
+    "tsc": "tsc",
+    "build": "npm run rollup && npm run copy && tsc -p tsconfig-prod.json",
     "rollup": "rollup -c rollup.config.umd.js && rollup -c rollup.config.es6.js",
     "start": "npm run test:watch",
-    "mocha": "_mocha --require chai/register-expect --require esm --require test/bootstrap/node.js test/*.js --exit",
+    "mocha": "_mocha --require chai/register-expect.js --require test/bootstrap/node.js test/*.js --exit",
     "test:watch": "nodemon --watch src --watch test --exec 'npm test'",
-    "nyc": "echo 'Deleting esm cache for coverage' && rm -Rf node_modules/.cache && nyc npm run mocha",
-    "test": "npm run eslint && npm run rollup && npm run nyc",
-    "browser-test": "npm run rollup && open-cli http://127.0.0.1:8080/test/ && static -p 8080",
-    "prepublishOnly": "npm run rollup && npm test"
+    "c8": "echo 'Deleting esm cache for coverage' && rm -Rf node_modules/.cache && c8 npm run mocha",
+    "test": "npm run eslint && npm run build && npm run c8",
+    "browser-test": "npm run build && open-cli http://127.0.0.1:8080/test/ && static -p 8080",
+    "prepublishOnly": "npm run build && npm test"
   },
   "engines": {
-    "node": ">=6.0.0"
+    "node": ">=16.0.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.11.1",
-    "@mysticatea/eslint-plugin": "^13.0.0",
-    "@rollup/plugin-babel": "^5.2.0",
-    "@rollup/plugin-commonjs": "^15.0.0",
-    "@rollup/plugin-node-resolve": "^9.0.0",
-    "chai": "^4.2.0",
-    "eslint": "^7.7.0",
-    "eslint-config-ash-nazg": "^22.7.0",
-    "eslint-config-standard": "^14.1.1",
-    "eslint-plugin-array-func": "^3.1.7",
-    "eslint-plugin-compat": "^3.8.0",
+    "@babel/core": "^7.21.8",
+    "@brettz9/eslint-plugin": "^1.0.4",
+    "@rollup/plugin-babel": "^6.0.3",
+    "@rollup/plugin-node-resolve": "^15.0.2",
+    "@types/chai": "^4.3.5",
+    "@types/jsdom": "^21.1.1",
+    "@types/mocha": "^10.0.1",
+    "c8": "^7.13.0",
+    "chai": "^4.3.7",
+    "eslint": "^8.40.0",
+    "eslint-config-ash-nazg": "^34.12.0",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-plugin-array-func": "^3.1.8",
+    "eslint-plugin-compat": "^4.1.4",
     "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-html": "^6.0.3",
-    "eslint-plugin-import": "^2.22.0",
-    "eslint-plugin-jsdoc": "^30.2.2",
-    "eslint-plugin-markdown": "^1.0.2",
-    "eslint-plugin-no-unsanitized": "^3.1.2",
+    "eslint-plugin-html": "^7.1.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jsdoc": "^44.2.1",
+    "eslint-plugin-markdown": "^3.0.0",
+    "eslint-plugin-no-unsanitized": "^4.0.2",
     "eslint-plugin-no-use-extend-native": "^0.5.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^4.2.1",
-    "eslint-plugin-sonarjs": "^0.5.0",
-    "eslint-plugin-standard": "^4.0.1",
-    "eslint-plugin-unicorn": "^21.0.0",
+    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-sonarjs": "^0.19.0",
+    "eslint-plugin-standard": "^4.1.0",
+    "eslint-plugin-unicorn": "^47.0.0",
     "esm": "^3.2.25",
-    "jamilih": "^0.53.2",
-    "jsdom": "^16.4.0",
-    "mocha": "^8.1.1",
+    "intl-locale-textinfo-polyfill": "^1.0.1",
+    "jamilih": "^0.57.1",
+    "jsdom": "^22.0.0",
+    "mocha": "^10.2.0",
     "node-static": "0.7.11",
-    "nodemon": "^2.0.4",
-    "nyc": "^15.1.0",
-    "open-cli": "^6.0.1",
-    "rollup": "^2.26.0",
-    "rtl-detect": "^1.0.2",
-    "source-map-support": "^0.5.19",
-    "typescript": "^3.9.7"
-  },
-  "dependencies": {}
+    "nodemon": "^2.0.22",
+    "open-cli": "^7.2.0",
+    "rollup": "^3.21.6",
+    "source-map-support": "^0.5.21",
+    "typescript": "^5.0.4"
+  }
 }

package/src/i18nizeelement-jamilih-plugin.js

@@ -1,8 +1,12 @@
 import i18nizeElement from './index.js';
 
+/** @type {import('jamilih').JamilihPlugin} */
 const plugin = {
   name: '$_language',
-  async set ({element, attribute: {value: options}}) {
+  async set ({element, attribute: {value}}) {
+    let options = /** @type {import('jamilih').PluginValue} */ (
+      value
+    );
     if (typeof options === 'string') {
       options = {language: options};
     } else if (Array.isArray(options)) {
@@ -16,8 +20,15 @@ const plugin = {
     //   the child element into the ancestors
     //   it is being built with
     await Promise.resolve();
-    i18nizeElement(element, {
-      ...options
+    i18nizeElement(/** @type {HTMLElement} */ (element), {
+      ...(
+        /**
+         * @type {{
+         *   [key: string]: any;
+         * }}
+         */
+        (options)
+      )
     });
   }
 };

package/src/index.js

@@ -1,6 +1,16 @@
-import rtlDetect from 'rtl-detect';
-// https://github.com/shadiabuhilal/rtl-detect/issues/3
+import 'intl-locale-textinfo-polyfill/lib/polyfill.js';
+
 // e.g., `i18nizeElement(document.title, {language: 'ar-AR'});`
+
+/**
+ * @param {HTMLElement} element
+ * @param {{
+ *   language?: string,
+ *   avoidLangIfSet?: boolean,
+ *   avoidDirIfSet?: boolean,
+ *   avoidLTRByDefault?: boolean
+ * }} cfg
+ */
 const i18nizeElement = (element, {
   language,
   // These avoid setting if found to be already set with the same value
@@ -22,7 +32,9 @@ const i18nizeElement = (element, {
   //   3. The closest ancestor with `lang` has a different language from
   //       the supplied
   if (avoidLangIfSet) {
-    presetLangElement = element.closest('[lang]');
+    presetLangElement = /** @type {HTMLElement} */ (
+      element.closest('[lang]')
+    );
   }
   if (!presetLangElement || presetLangElement.lang !== language) {
     element.lang = language;
@@ -37,14 +49,25 @@ const i18nizeElement = (element, {
   //        direction or the user isn't avoiding (the default) LTR)
   //    3. The closest ancestor with `dir` has a different `dir` from the
   //        direction of the supplied language
-  const dir = rtlDetect.getLangDir(language);
+  const {direction: dir} =
+    /**
+     * @type {Intl.Locale & {
+     *   textInfo: {direction: "ltr"|"rtl"|"ttb"}
+     * }}
+     */ (
+      new Intl.Locale(language)
+    ).textInfo;
+
+  /** @type {HTMLElement|undefined} */
   let presetDirElement;
   if (avoidDirIfSet ||
     // If avoiding the default LTR except when different (even if not
     //   avoiding an (RTL) already-set dir), we need to know if different
     (avoidLTRByDefault && dir === 'ltr')
   ) {
-    presetDirElement = element.closest('[dir]');
+    presetDirElement = /** @type {HTMLElement} */ (
+      element.closest('[dir]')
+    );
   }
   if (
     // If the closest ancestor with `dir` is different, we need to
@@ -63,8 +86,8 @@ const i18nizeElement = (element, {
   ) {
     element.dir = dir;
 
-    /* istanbul ignore next */
-    if (dir === 'ttb') { // Assumes https://github.com/shadiabuhilal/rtl-detect/issues/2
+    /* c8 ignore next 3 */
+    if (dir === 'ttb') {
       element.style.writingMode = 'vertical-lr';
     }
   }

package/CHANGES.md

@@ -1,45 +0,0 @@
-# CHANGES for i18nizeelement
-
-## 0.4.0
-
-- Docs: Update Jamilih API; document additional Jamilih plugin APIs
-- Linting (ESLint): As per latest ash-nazg
-- Testing: Use `chai/register-expect`
-- Testing: Fix paths to allow avoiding a global; drop now unneeded `closest`
-    polyfill
-- npm: Add eslint to test script
-- npm: Script from `prepare` to `prepublishOnly`
-- npm: Update `rollup-plugin-babel` to `@rollup/plugin-babel`
-    and make explicit `babelHelpers` value of `bundled`
-- npm: Switch to non-deprecated `@rollup/plugin-node-resolve`
-- npm: Switch to non-deprecated `@rollup/plugin-commonjs`
-- npm: Remove `test-cov` script in favor of letting `test` run coverage
-- npm: Delete full cache (ESM and nyc) in testing coverage
-- npm: Update devDeps. and package-lock
-
-## 0.3.0
-
-- Breaking change: Insist on Node >= 6
-- Linting (ESLint): Apply ash-nazg; use a recommended extension ("js")
-- Testing: Move `tests` to `test`
-- Testing: Switch to `esm`
-- Testing: Add `nyc` for coverage and bring to 100%
-- Build: Switch to Babel; update Rollup API usage
-- Maintenance: Add `.editorconfig`
-- Docs: Add badges
-- npm: Update devDeps; avoid `build` script; `opn-cli`->`open-cli`
-- npm: Remove `rollup-watch` and `rollup-plugin-multi-entry`
-
-## 0.2.1
-
-- Exclude items from `.npmignore`
-
-## 0.2.0
-
-- Build: Add i18nizeElement Jamilih plugin builds, ensuring buble runs
-    before other Rollup plugins
-- Refactoring: Rename plugin file
-
-## 0.1.0
-
-- Initial release