add README for locale specific packages, bump version, update README

phueper · phueper · commit 695a50daea14 · 2018-10-29T15:03:39.000+01:00
diff --git a/README.md b/README.md
@@ -26,16 +26,16 @@ Since the process described [below](#without-prebuilt-locale-packages) requires
 we provide prebuilt sets of locales as separate npm packages. 
 So for ease of use you may want to install the corresponding `@js-joda/locale_<locale>` package.
 The current list of available prebuilt locales is:
-- de (i.e. de-*)
-- de-DE
-- en (i.e. en-*)
-- en-US
-- es (i.e. es-*)
-- fr (i.e. fr-*)
-- hi (i.e. hi-*)
-- it (i.e. it-*)
-- it-IT
-- zh (i.e. zh-*)
+- [de (i.e. de-*)](https://www.npmjs.com/package/@js-joda/locale_de)
+- [de-DE](https://www.npmjs.com/package/@js-joda/locale_de-de)
+- [en (i.e. en-*)](https://www.npmjs.com/package/@js-joda/locale_en)
+- [en-US](https://www.npmjs.com/package/@js-joda/locale_en-us)
+- [es (i.e. es-*)](https://www.npmjs.com/package/@js-joda/locale_es)
+- [fr (i.e. fr-*)](https://www.npmjs.com/package/@js-joda/locale_fr)
+- [hi (i.e. hi-*)](https://www.npmjs.com/package/@js-joda/locale_hi)
+- [it (i.e. it-*)](https://www.npmjs.com/package/@js-joda/locale_it)
+- [it-IT](https://www.npmjs.com/package/@js-joda/locale_it-it)
+- [zh (i.e. zh-*)](https://www.npmjs.com/package/@js-joda/locale_zh)
 
 this list could be extended relatively easily if needed, as long as data is available in cldr-data
 
diff --git a/dist/js-joda-locale.js b/dist/js-joda-locale.js
@@ -1,4 +1,4 @@
-//! @version @js-joda/locale - 2.0.0-pre6+34.0.0
+//! @version @js-joda/locale - 2.0.0-pre7+34.0.0
 //! @copyright (c) 2015-2016, Philipp Thürwächter, Pattrick Hüper & js-joda contributors
 //! @copyright (c) 2007-present, Stephen Colebourne & Michael Nascimento Santos
 //! @license BSD-3-Clause (see LICENSE in the root directory of this source tree)
diff --git a/dist/js-joda-locale.min.js b/dist/js-joda-locale.min.js
diff --git a/dist/prebuilt/de-de/index.js b/dist/prebuilt/de-de/index.js
@@ -1,4 +1,4 @@
-//! @version @js-joda/locale - 2.0.0-pre6+34.0.0
+//! @version @js-joda/locale - 2.0.0-pre7+34.0.0
 //! @copyright (c) 2015-2016, Philipp Thürwächter, Pattrick Hüper & js-joda contributors
 //! @copyright (c) 2007-present, Stephen Colebourne & Michael Nascimento Santos
 //! @license BSD-3-Clause (see LICENSE in the root directory of this source tree)
diff --git a/dist/prebuilt/de/index.js b/dist/prebuilt/de/index.js
diff --git a/dist/prebuilt/en-us/index.js b/dist/prebuilt/en-us/index.js
@@ -1,4 +1,4 @@
-//! @version @js-joda/locale - 2.0.0-pre6+34.0.0
+//! @version @js-joda/locale - 2.0.0-pre7+34.0.0
 //! @copyright (c) 2015-2016, Philipp Thürwächter, Pattrick Hüper & js-joda contributors
 //! @copyright (c) 2007-present, Stephen Colebourne & Michael Nascimento Santos
 //! @license BSD-3-Clause (see LICENSE in the root directory of this source tree)
diff --git a/dist/prebuilt/en/index.js b/dist/prebuilt/en/index.js
diff --git a/dist/prebuilt/es/index.js b/dist/prebuilt/es/index.js
diff --git a/dist/prebuilt/fr/index.js b/dist/prebuilt/fr/index.js
diff --git a/dist/prebuilt/hi/index.js b/dist/prebuilt/hi/index.js
@@ -1,4 +1,4 @@
-//! @version @js-joda/locale - 2.0.0-pre6+34.0.0
+//! @version @js-joda/locale - 2.0.0-pre7+34.0.0
 //! @copyright (c) 2015-2016, Philipp Thürwächter, Pattrick Hüper & js-joda contributors
 //! @copyright (c) 2007-present, Stephen Colebourne & Michael Nascimento Santos
 //! @license BSD-3-Clause (see LICENSE in the root directory of this source tree)
diff --git a/dist/prebuilt/it-it/index.js b/dist/prebuilt/it-it/index.js
@@ -1,4 +1,4 @@
-//! @version @js-joda/locale - 2.0.0-pre6+34.0.0
+//! @version @js-joda/locale - 2.0.0-pre7+34.0.0
 //! @copyright (c) 2015-2016, Philipp Thürwächter, Pattrick Hüper & js-joda contributors
 //! @copyright (c) 2007-present, Stephen Colebourne & Michael Nascimento Santos
 //! @license BSD-3-Clause (see LICENSE in the root directory of this source tree)
diff --git a/dist/prebuilt/it/index.js b/dist/prebuilt/it/index.js
@@ -1,4 +1,4 @@
-//! @version @js-joda/locale - 2.0.0-pre6+34.0.0
+//! @version @js-joda/locale - 2.0.0-pre7+34.0.0
 //! @copyright (c) 2015-2016, Philipp Thürwächter, Pattrick Hüper & js-joda contributors
 //! @copyright (c) 2007-present, Stephen Colebourne & Michael Nascimento Santos
 //! @license BSD-3-Clause (see LICENSE in the root directory of this source tree)
diff --git a/dist/prebuilt/zh/index.js b/dist/prebuilt/zh/index.js
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@js-joda/locale",
-  "version": "2.0.0-pre6+34.0.0",
+  "version": "2.0.0-pre7+34.0.0",
   "description": "plugin for locale functionality for js-joda",
   "repository": {
     "type": "git",
diff --git a/packages/de-de/README.md b/packages/de-de/README.md
@@ -0,0 +1,13 @@
+# additional date-time classes that complement those in js-joda 
+
+for locale `de,de-DE` 
+
+## Motivation
+
+Implementation of locale specific funtionality for js-joda, providing function not implemented in js-joda core
+
+Especially this implements patterns elements to print and parse locale specific dates
+
+This package can be used for the `de,de-DE` locales
+
+for additional info see the main [@js-joda/locale package](https://www.npmjs.com/package/@js-joda/locale)
diff --git a/packages/de-de/dist/index.js b/packages/de-de/dist/index.js
diff --git a/packages/de-de/dist/index.js.map b/packages/de-de/dist/index.js.map
diff --git a/packages/de/README.md b/packages/de/README.md
@@ -0,0 +1,13 @@
+# additional date-time classes that complement those in js-joda 
+
+for locale `de.*` 
+
+## Motivation
+
+Implementation of locale specific funtionality for js-joda, providing function not implemented in js-joda core
+
+Especially this implements patterns elements to print and parse locale specific dates
+
+This package can be used for the `de.*` locales
+
+for additional info see the main [@js-joda/locale package](https://www.npmjs.com/package/@js-joda/locale)
diff --git a/packages/en-us/README.md b/packages/en-us/README.md
@@ -0,0 +1,13 @@
+# additional date-time classes that complement those in js-joda 
+
+for locale `en,en-US` 
+
+## Motivation
+
+Implementation of locale specific funtionality for js-joda, providing function not implemented in js-joda core
+
+Especially this implements patterns elements to print and parse locale specific dates
+
+This package can be used for the `en,en-US` locales
+
+for additional info see the main [@js-joda/locale package](https://www.npmjs.com/package/@js-joda/locale)
diff --git a/packages/en/README.md b/packages/en/README.md
@@ -0,0 +1,13 @@
+# additional date-time classes that complement those in js-joda 
+
+for locale `en.*` 
+
+## Motivation
+
+Implementation of locale specific funtionality for js-joda, providing function not implemented in js-joda core
+
+Especially this implements patterns elements to print and parse locale specific dates
+
+This package can be used for the `en.*` locales
+
+for additional info see the main [@js-joda/locale package](https://www.npmjs.com/package/@js-joda/locale)
diff --git a/packages/es/README.md b/packages/es/README.md
@@ -0,0 +1,13 @@
+# additional date-time classes that complement those in js-joda 
+
+for locale `es.*` 
+
+## Motivation
+
+Implementation of locale specific funtionality for js-joda, providing function not implemented in js-joda core
+
+Especially this implements patterns elements to print and parse locale specific dates
+
+This package can be used for the `es.*` locales
+
+for additional info see the main [@js-joda/locale package](https://www.npmjs.com/package/@js-joda/locale)
diff --git a/packages/fr/README.md b/packages/fr/README.md
@@ -0,0 +1,13 @@
+# additional date-time classes that complement those in js-joda 
+
+for locale `fr.*` 
+
+## Motivation
+
+Implementation of locale specific funtionality for js-joda, providing function not implemented in js-joda core
+
+Especially this implements patterns elements to print and parse locale specific dates
+
+This package can be used for the `fr.*` locales
+
+for additional info see the main [@js-joda/locale package](https://www.npmjs.com/package/@js-joda/locale)
diff --git a/packages/hi/README.md b/packages/hi/README.md
@@ -0,0 +1,13 @@
+# additional date-time classes that complement those in js-joda 
+
+for locale `hi.*` 
+
+## Motivation
+
+Implementation of locale specific funtionality for js-joda, providing function not implemented in js-joda core
+
+Especially this implements patterns elements to print and parse locale specific dates
+
+This package can be used for the `hi.*` locales
+
+for additional info see the main [@js-joda/locale package](https://www.npmjs.com/package/@js-joda/locale)
diff --git a/packages/it-it/README.md b/packages/it-it/README.md
@@ -0,0 +1,13 @@
+# additional date-time classes that complement those in js-joda 
+
+for locale `it,it-IT` 
+
+## Motivation
+
+Implementation of locale specific funtionality for js-joda, providing function not implemented in js-joda core
+
+Especially this implements patterns elements to print and parse locale specific dates
+
+This package can be used for the `it,it-IT` locales
+
+for additional info see the main [@js-joda/locale package](https://www.npmjs.com/package/@js-joda/locale)
diff --git a/packages/it-it/dist/index.js b/packages/it-it/dist/index.js
diff --git a/packages/it-it/dist/index.js.map b/packages/it-it/dist/index.js.map
diff --git a/packages/it/README.md b/packages/it/README.md
@@ -0,0 +1,13 @@
+# additional date-time classes that complement those in js-joda 
+
+for locale `it.*` 
+
+## Motivation
+
+Implementation of locale specific funtionality for js-joda, providing function not implemented in js-joda core
+
+Especially this implements patterns elements to print and parse locale specific dates
+
+This package can be used for the `it.*` locales
+
+for additional info see the main [@js-joda/locale package](https://www.npmjs.com/package/@js-joda/locale)
diff --git a/packages/zh/README.md b/packages/zh/README.md
@@ -0,0 +1,13 @@
+# additional date-time classes that complement those in js-joda 
+
+for locale `zh.*` 
+
+## Motivation
+
+Implementation of locale specific funtionality for js-joda, providing function not implemented in js-joda core
+
+Especially this implements patterns elements to print and parse locale specific dates
+
+This package can be used for the `zh.*` locales
+
+for additional info see the main [@js-joda/locale package](https://www.npmjs.com/package/@js-joda/locale)
diff --git a/utils/README_package.template.md b/utils/README_package.template.md
@@ -0,0 +1,13 @@
+# additional date-time classes that complement those in js-joda 
+
+for locale `{{locale}}` 
+
+## Motivation
+
+Implementation of locale specific funtionality for js-joda, providing function not implemented in js-joda core
+
+Especially this implements patterns elements to print and parse locale specific dates
+
+This package can be used for the `{{locale}}` locales
+
+for additional info see the main [@js-joda/locale package](https://www.npmjs.com/package/@js-joda/locale)
diff --git a/utils/create_packages.js b/utils/create_packages.js
@@ -76,6 +76,9 @@ const packageTemplate = {
     devDependencies: {}
 };
 
+const readmeTemplate = fs.readFileSync(path.resolve(__dirname, 'README_package.template.md'), 'utf8');
+const readmeLocaleRegex = /{{locale}}/g;
+
 // TODO: build minified (DIST_MIN=1) package?? in dist/index.min.js?
 Object.keys(argv.packages).forEach((packageName) => {
     // eslint-disable-next-line no-console
@@ -90,6 +93,8 @@ Object.keys(argv.packages).forEach((packageName) => {
     packageTemplate.description = `prebuilt js-joda locale package for locales: ${argv.packages[packageName]}`;
     fs.writeFileSync(path.resolve(packageDir, 'package.json'),
         JSON.stringify(packageTemplate, null, 4));
+    fs.writeFileSync(path.resolve(packageDir, 'README.md'),
+        readmeTemplate.replace(readmeLocaleRegex, argv.packages[packageName].join(',')));
     const nodeArgs = [
         './utils/build_package.js',
         '-o', `${path.resolve(packageDir, 'dist')}`,

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-//! @version @js-joda/locale - 2.0.0-pre6+34.0.0`
	`1`	`+//! @version @js-joda/locale - 2.0.0-pre7+34.0.0`
`2`	`2`	`//! @copyright (c) 2015-2016, Philipp Thürwächter, Pattrick Hüper & js-joda contributors`
`3`	`3`	`//! @copyright (c) 2007-present, Stephen Colebourne & Michael Nascimento Santos`
`4`	`4`	`//! @license BSD-3-Clause (see LICENSE in the root directory of this source tree)`