Implement app example using webpack

README.md

@@ -22,6 +22,7 @@ Node.js module.
   - [Usage](#usage)
   - [Performance](#performance)
   - [Compilation and the Runtime modules](#compilation-and-the-runtime-modules)
+  - [Examples](#examples)
 - [API](#api)
   - [Core](#core-module)
   - [Date module](#date-module)
@@ -248,12 +249,8 @@ can cherry-pick the pieces you need, eg. load `dist/globalize.js` to get
 Globalize core, load `dist/globalize/date.js` to extend Globalize with Date
 functionalities, etc.
 
-An example is worth a thousand words. Check out our Hello World demo (available
-to you in different flavors):
-- [Hello World (AMD + bower)](examples/amd-bower/).
-- [Hello World (Node.js + npm)](examples/node-npm/).
-- [Hello World (plain JavaScript)](examples/plain-javascript/).
-
+An example is worth a thousand words. Check out our [Examples](#examples)
+section below.
 
 ### Performance
 
@@ -290,7 +287,6 @@ created (see [Performance](#performance) above for more information).
 
 To illustrate, see our [Basic Globalize Compiler example][].
 
-[Basic Globalize Compiler example]: examples/globalize-compiler/
 
 #### Globalize Compiler
 
@@ -299,6 +295,36 @@ For information about the Globalize Compiler CLI or its JavaScript API, see the
 
 [Globalize Compiler documentation]: https://github.com/jquery-support/globalize-compiler#README
 
+### Examples
+
+The fastest and easiest way to use Globalize is by integrating it into your
+existing tools.
+
+- [Application example using webpack and npm](examples/app-npm-webpack/): easy to
+  get started, automated CLDR loading and precompilation for production, but
+  requires npm and webpack knowledge.
+
+If you're using a different tool than the one above, but you're comfortable
+using JavaScript modules (such as ES6 modules, CommonJS, or AMD) and package
+managers like npm or bower, you may want to check out the following examples.
+Note you'll need to compile your code for production yourself.
+
+- [Basic example using AMD and bower](examples/amd-bower/): feeding Globalize on
+  CLDR is not completely transparent.
+- [Basic example using Node.js and npm](examples/node-npm/): feeding Globalize
+  on CLDR is not completely transparent.
+- [Basic Globalize Compiler example][]: shows how to use Globalize Compiler CLI.
+
+[Basic Globalize Compiler example]: examples/globalize-compiler/
+
+If you're using none of the tools above, but instead you're using the plain and
+old script tags only, the following example may interest you. Note Globalize
+allows you to go low level like this. But, acknowledge that you'll need to
+handle dependencies and CLDR loading manually yourself.
+
+- [Basic example using plain JavaScript](examples/plain-javascript/): requires
+  loading CLDR and handling dependencies manually.
+
 ## API
 
 ### Core module

examples/app-npm-webpack/.gitignore

@@ -0,0 +1,2 @@
+dist/
+.tmp-globalize-webpack/

examples/app-npm-webpack/README.md

@@ -0,0 +1,74 @@
+# Globalize App example using webpack
+
+This example demonstrates how to integrate Globalize with Webpack in your
+Application. If you already have an existing Application using Webpack stack,
+this example should as well provide you guidance on how to integrate Globalize.
+It focuses on the [Globalize Webpack Plugin][], which automates data loading
+(CLDR and app messages) during development and automates Globalize compilation
+and the usage of Globalize runtime modules for production. It assumes knowledge
+of Globalize, npm, and Webpack usage basics.
+
+## Requirements
+
+**1. Install app development dependencies**
+
+This example uses `npm` to download the app development dependencies (i.e.,
+Globalize, CLDR data, Cldrjs, Webpack, [Globalize Webpack Plugin][], and
+others).
+
+```
+npm install
+```
+
+## Running the example
+
+### Development mode
+
+```
+npm start
+```
+
+1. Start a server by running `npm start`, which uses webpack's live reload HMR
+(Hot Module Replacement). See `package.json` to understand the actual shell
+command that is used.
+1. Point your browser at `http://localhost:8080`. Note that your browser will
+automatically reload on any changes made to the application code (`app/*.js`
+files). Also note that for faster page reload, formatters are created
+dynamically and automatically by the [Globalize Webpack Plugin][].
+1. Note you can specify the development locale of your choice by setting the
+`developmentLocale` property of the Globalize Webpack Plugin on the Webpack
+config file.
+1. Note that CLDR data and your messages data are automatically loaded by the
+[Globalize Webpack Plugin][].
+1. Understand the demo by reading the source code. We have comments there for
+you.
+
+### Production mode
+
+```
+npm run build
+```
+
+1. Generate the compiled bundles by running `npm run build`, which will be
+created at `./dist`. Note the production bundles are split into three chunks:
+(a) vendor, which holds third-party libraries, which in this case means
+Globalize Runtime modules, (b) i18n precompiled data, which means the minimum
+yet sufficient set of precompiled i18n data that your application needs (one
+file for each supported locale), and (c) app, which means your application code.
+Also note that all the production code is already minified using UglifyJS. See
+`package.json` to understand the actual shell command that is used.
+1. Note that your formatters are already precompiled. This is
+obvious, but worth emphasizing. It means your formatters are prebuilt, so no client
+CPU clock is wasted to generate them and no CLDR or messages data needs to be
+dynamically loaded. It means fast to load code (small code) and fast to run
+code.
+1. Point your browser at `./dist/index.html` to run the application using the
+generated production files. Edit this file to display the application using a
+different locale (source code has instructions).
+1. Understand the demo by reading the source code. We have comments there for
+you.
+
+For more information about the plugin, see the [Globalize Webpack Plugin][]
+documentation.
+
+[Globalize Webpack Plugin]: https://github.com/rxaviers/globalize-webpack-plugin

examples/app-npm-webpack/app/index.js

@@ -0,0 +1,55 @@
+var currencyFormatter, dateFormatter, numberFormatter, relativeTimeFormatter, startTime,
+	Globalize = require( "globalize" );
+
+startTime = new Date();
+
+currencyFormatter = Globalize.currencyFormatter( "USD" );
+dateFormatter = Globalize.dateFormatter({ datetime: "medium" });
+numberFormatter = Globalize.numberFormatter({ maximumFractionDigits: 2 });
+relativeTimeFormatter = Globalize.relativeTimeFormatter( "second" );
+
+document.getElementById( "intro-1" ).innerHTML = Globalize.formatMessage( "intro-1" );
+
+// Standalone table.
+document.getElementById( "currency-label" ).innerHTML = Globalize.formatMessage( "currency-label" );
+document.getElementById( "currency" ).innerHTML = currencyFormatter( 69900 );
+
+document.getElementById( "date-label" ).innerHTML = Globalize.formatMessage( "date-label" );
+document.getElementById( "date" ).innerHTML = dateFormatter( new Date() );
+
+document.getElementById( "number-label" ).innerHTML = Globalize.formatMessage( "number-label" );
+document.getElementById( "number" ).innerHTML = numberFormatter( 12345.6789 );
+
+document.getElementById( "relative-time-label" ).innerHTML = Globalize.formatMessage( "relative-time-label" );
+document.getElementById( "relative-time" ).innerHTML = relativeTimeFormatter( 0 );
+
+// Messages.
+document.getElementById( "message-1" ).innerHTML = Globalize.formatMessage( "message-1", {
+	currency: currencyFormatter( 69900 ),
+	date: dateFormatter( new Date() ),
+	number: numberFormatter( 12345.6789 ),
+	relativeTime: relativeTimeFormatter( 0 )
+});
+
+document.getElementById( "message-2" ).innerHTML = Globalize.formatMessage( "message-2", {
+	count: 3
+});
+
+// Display demo.
+document.getElementById( "requirements" ).style.display = "none";
+document.getElementById( "demo" ).style.display = "block";
+
+// Refresh elapsed time
+setInterval(function() {
+	var elapsedTime = +( ( startTime - new Date() ) / 1000 ).toFixed( 0 );
+	document.getElementById( "date" ).innerHTML = dateFormatter( new Date() );
+	document.getElementById( "relative-time" ).innerHTML = relativeTimeFormatter( elapsedTime );
+	document.getElementById( "message-1" ).innerHTML = Globalize.formatMessage( "message-1", {
+		currency: currencyFormatter( 69900 ),
+		date: dateFormatter( new Date() ),
+		number: numberFormatter( 12345.6789 ),
+		relativeTime: relativeTimeFormatter( elapsedTime )
+	});
+
+}, 1000);
+

examples/app-npm-webpack/index-template.html

@@ -0,0 +1,82 @@
+<!doctype html>
+<html>
+<head>
+	<meta charset="utf-8">
+	<meta http-equiv="X-UA-Compatible" content="IE=edge">
+	<title>Globalize App example using Webpack</title>
+</head>
+<body>
+
+<h1>Globalize App example using Webpack</h1>
+
+<div id="requirements">
+	<h2>Requirements</h2>
+	<ul>
+		<li>Read README.md for instructions on how to run the demo.
+		</li>
+	</ul>
+</div>
+
+<div id="demo" style="display: none">
+	<p id="intro-1">Use Globalize to internationalize your application.</p>
+	<table border="1" style="marginBottom: 1em;">
+		<tbody>
+			<tr>
+				<td><span id="number-label">Standalone Number</span></td>
+				<td>"<span id="number"></span>"</td>
+			</tr>
+			<tr>
+				<td><span id="currency-label">Standalone Currency</span></td>
+				<td>"<span id="currency"></span>"</td>
+			</tr>
+			<tr>
+				<td><span id="date-label">Standalone Date</span></td>
+				<td>"<span id="date"></span>"</td>
+			</tr>
+			<tr>
+				<td><span id="relative-time-label">Standalone Relative Time</span></td>
+				<td>"<span id="relative-time"></span>"</td>
+			</tr>
+		</tbody>
+	</table>
+	<p id="message-1">
+		An example of a message using mixed numbers "{number}", currencies "{currency}", dates "{date}", and relative time "{relativeTime}".
+	</p>
+	<p id="message-2">
+		An example of a message with pluralization support: 
+		{count, plural,
+			one {You have one remaining task}
+			other {You have # remaining tasks}
+		}.
+	</p>
+</div>
+
+{%
+var hasShownLocaleHelp;
+for ( var chunk in o.htmlWebpackPlugin.files.chunks ) {
+	if ( /globalize-compiled-data-/.test( chunk ) && chunk !== "globalize-compiled-data-en" ) {
+		if ( !hasShownLocaleHelp ) {
+			hasShownLocaleHelp = true;
+%}
+<!--
+Load support for the `en` (English) locale.
+
+For displaying the application in a different locale, replace `en` with
+whatever other supported locale you want, e.g., `pt` (Portuguese).
+
+For supporting additional locales simultaneously and then having your
+application to change it dynamically, load the multiple files here. Then,
+use `Globalize.locale( <locale> )` in your application to dynamically set
+it.
+-->
+{%		} %}
+<!-- <script src="{%=o.htmlWebpackPlugin.files.chunks[chunk].entry %}"></script> -->
+{%	} else { %}
+<script src="{%=o.htmlWebpackPlugin.files.chunks[chunk].entry %}"></script>
+{%
+	}
+}
+%}
+
+</body>
+</html>

examples/app-npm-webpack/messages/ar.json

@@ -0,0 +1,21 @@
+{
+	"ar": {
+		"intro-1": "استخدام عولمة لتدويل طلبك.",
+		"number-label": "عدد",
+		"currency-label": "عملة",
+		"date-label": "تاريخ",
+		"relative-time-label": "الوقت النسبي",
+		"message-1": "مثال على رسالة باستخدام أرقام مختلطة \"{number}\"، \"{currency}\" العملات، يعود \"{date}\"، ووقت النسبي \"{relativeTime}\".",
+		"message-2": [
+			"مثال على رسالة بدعم صيغة الجمع:",
+			"{count, plural,",
+			"   zero {لا يوجد لديك المهام المتبقية}",
+			"    one {لديك واحد المتبقية المهام}",
+			"    two {لديك اثنين من المهام المتبقية}",
+			"    few {لديك # المهام المتبقية}",
+			"   many {لديك # المهام المتبقية}",
+			"  other {لديك # المهام المتبقية}",
+			"}."
+		]
+	}
+}

examples/app-npm-webpack/messages/de.json

@@ -0,0 +1,17 @@
+{
+	"de": {
+		"intro-1": "Verwenden Sie Globalize um Ihre Anwendung zu internationalisieren.",
+		"number-label": "Zahl",
+		"currency-label": "Währung",
+		"date-label": "Datum",
+		"relative-time-label": "Relative Zeit",
+		"message-1": "Ein Beispieltext der eine Mischung aus Zahl \"{number}\", Währung \"{currency}\", Datum \"{date}\", und relativer Zeit \"{relativeTime}\" verwendet.",
+		"message-2": [
+			"Ein Beispieltext mit Unterstützung von Plural Formen: ",
+			"{count, plural,",
+			"    one {Sie haben noch eine Aufgabe}",
+			"  other {Sie haben noch # verbliebende Aufgaben}",
+			"}."
+		]
+	}
+}

examples/app-npm-webpack/messages/en.json

@@ -0,0 +1,17 @@
+{
+	"en": {
+		"intro-1": "Use Globalize to internationalize your application.",
+		"number-label": "Number",
+		"currency-label": "Currency",
+		"date-label": "Date",
+		"relative-time-label": "Relative Time",
+		"message-1": "An example of a message using mixed numbers \"{number}\", currencies \"{currency}\", dates \"{date}\", and relative time \"{relativeTime}\".",
+		"message-2": [
+			"An example of a message with pluralization support:",
+			"{count, plural,",
+			"    one {You have one remaining task}",
+			"  other {You have # remaining tasks}",
+			"}."
+		]
+	}
+}

examples/app-npm-webpack/messages/es.json

@@ -0,0 +1,17 @@
+{
+	"es": {
+		"intro-1": "Usa Globalize para internacionalizar tu aplicación.",
+		"number-label": "Número",
+		"currency-label": "Moneda",
+		"date-label": "Fecha",
+		"relative-time-label": "Tiempo Relativo",
+		"message-1": "Un ejemplo de mensaje usando números mixtos \"{number}\", monedas \"{currency}\", fechas \"{date}\", y tiempo relativo \"{relativeTime}\".",
+		"message-2": [
+			"Un ejemplo de mensaje con soporte de pluralizaciónt:",
+			"{count, plural,",
+			"    one {Tienes una tarea restante}",
+			"  other {Tienes # tareas restantes}",
+			"}."
+		]
+	}
+}

examples/app-npm-webpack/messages/pt.json

@@ -0,0 +1,17 @@
+{
+	"pt": {
+		"intro-1": "Use o Globalize para internacionalizar sua aplicação.",
+		"number-label": "Número",
+		"currency-label": "Moeda",
+		"date-label": "Data",
+		"relative-time-label": "Tempo relativo",
+		"message-1": "Um exemplo de mensagem com mistura de números \"{number}\", moedas \"{currency}\", datas \"{date}\", e tempo relativo \"{relativeTime}\".",
+		"message-2": [
+			"Um exemplo de message com suporte a pluralização:",
+			"{count, plural,",
+			"    one {Você tem uma tarefa restante}",
+			"  other {Você tem # tarefas restantes}",
+			"}."
+		]
+	}
+}

examples/app-npm-webpack/messages/ru.json

@@ -0,0 +1,19 @@
+{
+	"ru": {
+		"intro-1": "Используйте Globalize для интернационализиции вашего приложения.",
+		"number-label": "Число",
+		"currency-label": "Валюта",
+		"date-label": "Дата",
+		"relative-time-label": "Относительное время",
+		"message-1": "Пример сообщения со смешанными числами \"{number}\", валютой \"{currency}\", датами \"{date}\" и относительным временем \"{relativeTime}\".",
+		"message-2": [
+			"Пример сообщения с поддержкой множественного числа:",
+			"{count, plural,",
+			"   one {У вас осталась одна задача}",
+			"   many {У вас осталось # задач}",
+			"   few {У вас осталось # задачи}",
+			"   other {У вас осталось # задачи}",
+			"}."
+		]
+	}
+}