handlebars-i18n 1.6.0 → 1.6.2

package/.github/workflows/node.js.yml

@@ -0,0 +1,30 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14.x, 16.x, 18.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm run build --if-present

package/dist/handlebars-i18n.d.ts

@@ -1,5 +1,5 @@
 import * as handlebars from "handlebars";
-import type { i18n } from "i18next";
+import * as i18n from "i18next";
 
 type Handlebars = typeof handlebars;
 
@@ -38,7 +38,7 @@ export type DateTimeFormatConfiguration = [
 
 type Configuration = NumberFormatConfiguration | PriceFormatConfiguration | DateTimeFormatConfiguration;
 
-export function init(overrideHndlbrs?: Handlebars, overrideI18n?: i18n): Handlebars;
+export function init(overrideHndlbrs?: Handlebars, overrideI18n?: i18n.i18n): Handlebars;
 export function reset(): true;
 export function configure(configArray: Configuration[]): boolean;
 export function configure(

package/examples/typescript/index.ts

@@ -16,7 +16,8 @@ import { readFileSync } from "fs";
 
 
 // -- The translation phrases for i18next
-i18next
+const myI18nInstance = i18next.createInstance();
+myI18nInstance
 	.init({
 		resources: {
 			"en-GB": {
@@ -55,8 +56,11 @@ const data = {
 	myDate: "2020-03-11T03:24:00"
 };
 
+
+const myHandlebarsInstance = handlebars.create();
+
 // -- Init and configure handlebars-i18n
-HandlebarsI18n.init();
+HandlebarsI18n.init(myHandlebarsInstance, myI18nInstance);
 
 HandlebarsI18n.configure([
 	// generic configuration for all languages for number representation:
@@ -80,7 +84,7 @@ HandlebarsI18n.configure([
 ]);
 
 const template = readFileSync(__dirname + "/test.hbs", { encoding: "utf-8" });
-const compiled = handlebars.compile(template);
-i18next.changeLanguage("de-DE"); // --> Test the changes by replacing "de-DE" with "en-GB"
+const compiled = myHandlebarsInstance.compile(template);
+myI18nInstance.changeLanguage("de-DE"); // --> Test the changes by replacing "de-DE" with "en-GB"
 
 console.log("\x1b[36m%s\x1b[0m", compiled(data));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "handlebars-i18n",
-  "version": "1.6.0",
+  "version": "1.6.2",
   "description": "handlebars-i18n adds internationlization to handlebars.js using i18next and Intl",
   "main": "dist/handlebars-i18n.js",
   "scripts": {
@@ -14,7 +14,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/fwalzel/handlebars-i18n.git"
+    "url": "https://github.com/aller-couleur/handlebars-i18n.git"
   },
   "keywords": [
     "handlebars-i18n",
@@ -31,18 +31,19 @@
     "i18n",
     "Intl",
     "Helper",
+    "Typescript",
     "handlebars-i18next"
   ],
   "author": "Florian Walzel",
   "license": "MIT",
-  "homepage": "https://github.com/fwalzel/handlebars-i18n.git#readme",
+  "homepage": "https://github.com/aller-couleur/handlebars-i18n.git#readme",
   "peerDependencies": {
     "handlebars": "^4.7.7",
     "i18next": "^21.6.14",
     "intl": "^1.2.5"
   },
   "devDependencies": {
-    "@commitlint/cli": "16.2.3",
+    "@commitlint/cli": "17.6.1",
     "@commitlint/config-conventional": "16.2.1",
     "@types/intl": "^1.2.0",
     "@types/node": "^18.13.0",

package/readme.md

@@ -2,12 +2,13 @@
 
 `handlebars-i18n` adds the internationalization features of [i18next](https://www.i18next.com/) to [handlebars.js](https://handlebarsjs.com/). It also provides **date**, **number**, and **currency formatting** via [Intl](https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Intl). Use as node module or in the web browser.
 
-Handlebars-i18n is listed amongst i18next’s [framework helpers](https://www.i18next.com/overview/supported-frameworks). Now supports Typescript thanks to [@DiefBell](DiefBell).
+Handlebars-i18n is listed amongst i18next’s [framework helpers](https://www.i18next.com/overview/supported-frameworks). Now supports Typescript thanks to [@DiefBell](https://github.com/DiefBell).
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
-[![Build Status](https://travis-ci.org/fwalzel/handlebars-i18n.svg?branch=master)](https://travis-ci.org/fwalzel/handlebars-i18n)
+![Node.js Version](https://img.shields.io/badge/Node.js-14.x-green)
+[![Build](https://github.com/fwalzel/handlebars-i18n/actions/workflows/node.js.yml/badge.svg)](https://github.com/fwalzel/handlebars-i18n/actions/workflows/node.js.yml/badge.svg)
 [![Coverage Status](https://coveralls.io/repos/github/fwalzel/handlebars-i18next/badge.svg?branch=master)](https://coveralls.io/github/fwalzel/handlebars-i18next?branch=master)
-[![Code Quality](https://api.codiga.io/project/29087/score/svg)](https://api.codiga.io/project/29087/score/svg)
+[![Code Climate](https://codeclimate.com/github/Aller-Couleur/handlebars-i18n/badges/gpa.svg)](https://codeclimate.com/github/Aller-Couleur/handlebars-i18n)
 [![Known Vulnerabilities](https://snyk.io/test/github/Aller-Couleur/handlebars-i18n/badge.svg)](https://snyk.io/test/github/Aller-Couleur/handlebars-i18n/badge.svg)
 ![npm](https://img.shields.io/npm/dm/handlebars-i18n)
 
@@ -52,6 +53,13 @@ Usage in web browser:
 </script>
 ```
 
+With ES6 import syntax:
+
+```typescript
+import * as HandlebarsI18n from "handlebars-i18n";
+HandlebarsI18n.init();
+```
+
 ## Quick example
 
 Initialize i18next with your language strings and default settings: