Merge pull request #311 from HeikoStudt/enable-i18n-tsc

Support for i18n written in typescript.

Author: Chuck Dumont

.eslintignore

@@ -1,4 +1,6 @@
 node/**
 node_modules/**
 test/js/**
+test/TestCases/loaders/i18nTypeScriptModules/nls/**
 coverage/**
+

README.md

@@ -455,8 +455,36 @@ Note that you can also specify the require dependency array as a run-time identi
 
 Dojo's [Auto-Require](https://dojotoolkit.org/documentation/tutorials/1.10/declarative/#auto-require) feature allows the parser to automatically require the modules for widgets that are declared by templates.  This can be problematic with webpack for the reasons discussed [above](#use-of-run-time-identifiers-and-expressions-in-dependency-arrays), if your modules do not explicitly specify dependencies for the widgets that they contain.  Although useful for prototyping and demo purposes, Dojo itself recommends against using Auto-Require for production code because of it's negative performance consequences, and to instead be explicit about your application's dependencies.
 
+# I18n and TypeScript
+dojo-webpack-plugin has support for i18n using typescript. This helps for example Jetbrains IDEA to support syntax completion.
+
+Please refer to [this blog](https://www.sitepen.com/blog/what-typescript-can-offer-to-dojo-1-x) for an introductory example.
+
+The following i18n file format supports dialects as well:
+
+nls/main.ts:
+ 
+```typescript
+export = {
+    'de-de' : true,
+    root : { users: "Users" }
+}
+```
+
+nls/de-de/main.ts:
+```typescript
+export = { users: "Benutzer" }
+```
+
+Note: We need to import our i18n-language files explicitly inside our application, so that it is bundled with webpack.
+```javascript
+import 'nls/de-de/main';
+```
 # Dependency requirements
 
+Note: There is dojo-magic around the file extension .js in the imports. Please do remove the extension as .ts is not treated like that.
+
+
 **dojo-webpack-plugin** has a peer dependency on webpack.  **dojo-webpack-plugin**'s webpack dependencies must resolve to the same modules as your application's webpack dependencies, otherwise you may encounter errors similar to the following when building.
 
 ```

loaders/dojo/i18nEval.js

@@ -15,26 +15,45 @@
  * limitations under the License.
  */
 
- /*
-  * Evaluates a Dojo i18n resource bundle and returns the bundle object
-  */
+/*
+ * Evaluates a Dojo i18n resource bundle and returns the bundle object
+ */
 module.exports = function(bundle) {
 	var result, isAmd;
 	function define(arg1, arg2) {
 		isAmd = true;
+
 		if (!arg2) {
+			// overwriting language files may define an easy object
 			result = arg1;
-		} else {
-			if (arg1.length !== 0) {
-				throw new Error("define dependencies not supported in langauge files!");
-			}
+
+		} else if (arg1.length === 0) {
+
+			// without dependencies we can easily call the empty factory function
 			result = arg2(); // call factory function
+
+		} else if (arg1.length === 2 && arg1[0] === "require" && arg1[1] === "exports") {
+
+			// Special case for typescript generated i18n files
+			// tsc is adding virtual dependencies for require and exports
+			// we need the latter as our result
+			var exp = {};
+			var requireFun = function() { throw new Error("require() is not supported in language files"); };
+			result = arg2(requireFun, exp);
+			if (typeof result === 'undefined') {
+				result = exp;
+			}
+
+		} else {
+			throw new Error("define dependencies not supported in langauge files!");
 		}
 	}
+
 	define.amd = true;
 	eval(bundle);
 	if (!isAmd) {
 		throw new Error("Non-AMD nls bundles are not supported by dojo-webpack-plugin");
 	}
+
 	return result;
-};
+};

test/TestCases/loaders/i18nTypeScriptModules/Readme.md

@@ -0,0 +1,13 @@
+# What is the test about?
+typescript generates with the settings AMD/es2015 module defines having two
+parameters, require and exports. The exports weill be filled with the exported
+data.
+
+This needs to be addressed by dojo-webpack-plugin.
+
+# How to generate out of the *.ts typescript files?
+Install Typescript (>3) and call tsc here.
+
+# EsLintIgnore
+The generated files nls/* are ignored for eslint, because otherwise 
+no-unused-vars will error.

test/TestCases/loaders/i18nTypeScriptModules/index.js

@@ -0,0 +1,5 @@
+define(["dojo/i18n!./nls/strings"], function(strings) {
+	it("should load the strings if generated with typescript (require, exports)", function() {
+		strings.hello.should.be.eql("xyz-de");
+	});
+});

test/TestCases/loaders/i18nTypeScriptModules/nls/de-at/strings.js

@@ -0,0 +1,6 @@
+define(["require", "exports"], function (require, exports) {
+    "use strict";
+    return {
+        hello: 'xyz-de'
+    };
+});

test/TestCases/loaders/i18nTypeScriptModules/nls/strings.js

@@ -0,0 +1,9 @@
+define(["require", "exports"], function (require, exports) {
+    "use strict";
+    return {
+        'de-at': true,
+        root: {
+            hello: 'xyz'
+        }
+    };
+});

test/TestCases/loaders/i18nTypeScriptModules/ts-base/de-at/strings.ts

@@ -0,0 +1,3 @@
+export = {
+	hello : 'xyz-de'
+}

test/TestCases/loaders/i18nTypeScriptModules/ts-base/strings.ts

@@ -0,0 +1,6 @@
+export = {
+	'de-at' : true,
+	root : {
+		hello : 'xyz'
+	}
+}

test/TestCases/loaders/i18nTypeScriptModules/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+	"outDir": "./nls",
+	"rootDir": "./ts-base",
+	"baseUrl": ".",
+	"strict": true,
+	"strictNullChecks" : true,
+
+	"moduleResolution": "node",
+	"module": "AMD",
+	"target": "ES2015"
+  },
+
+  "files": [
+	"ts-base/strings.ts",
+	"ts-base/de-at/strings.ts"
+  ]
+}

test/TestCases/loaders/i18nTypeScriptModules/webpack.config.js

@@ -0,0 +1,16 @@
+var path = require("path");
+var DojoWebpackPlugin = require("../../../../index");
+module.exports = {
+	entry: "test/index",
+	plugins: [
+		new DojoWebpackPlugin({
+			loaderConfig: {
+				paths:{test: "."},
+				locale: "de-at",
+				has: {"host-browser": 0, "dojo-config-api": 0}
+			},
+			locales: ["en", "de-at"],
+			loader: path.join(__dirname, "../../../js/dojo/dojo.js")
+		})
+	]
+};