@pcdevil/eleventy-plugin-intl-utils 0.2.0 → 0.3.0

package/.eleventy.js

@@ -1,9 +1,9 @@
 'use strict';
 
-const countryNameFactory = require('./src/country_name');
-const languageNameFactory = require('./src/language_name');
-const shortDateTimeFormatFactory = require('./src/short_datetime_format');
-const yearIntervalFactory = require('./src/year_interval');
+const countryNameFactory = require('./src/filters/country_name');
+const languageNameFactory = require('./src/filters/language_name');
+const shortDateTimeFormatFactory = require('./src/filters/short_datetime_format');
+const yearIntervalFactory = require('./src/shortcodes/year_interval');
 
 module.exports = (eleventyConfig, pluginConfig = {}) => {
 	const { locale } = pluginConfig;
@@ -11,5 +11,6 @@ module.exports = (eleventyConfig, pluginConfig = {}) => {
 	eleventyConfig.addFilter('country_name', countryNameFactory(locale));
 	eleventyConfig.addFilter('language_name', languageNameFactory(locale));
 	eleventyConfig.addFilter('short_datetime_format', shortDateTimeFormatFactory(locale));
-	eleventyConfig.addFilter('year_interval', yearIntervalFactory(locale));
+
+	eleventyConfig.addShortcode('year_interval', yearIntervalFactory(locale));
 };

package/README.md

@@ -4,10 +4,17 @@ A set of internationalization utils for [Eleventy](https://www.11ty.dev/).
 ## Motivation
 It's super fast to create a static website with **Eleventy** and with the help of [`eleventy-plugin-i18n`](https://www.npmjs.com/package/eleventy-plugin-i18n) localization can be done with ease too.
 
-However it only gives solution for static data and dynamic data still needs treatment during layout rendering. This plugin aims to help with a set of [filters](https://www.11ty.dev/docs/filters/).
+However it only gives solution for static data and dynamic data still needs treatment during layout rendering. This plugin aims to help with a set of [filters](https://www.11ty.dev/docs/filters/) and [shortcodes](https://www.11ty.dev/docs/shortcodes/).
 
 The implementations of the filters are mostly wrappers around the [ECMAScript Internationalization API](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl) with a little _bit of sugar_.
 
+## Current state
+The package uses [Semantic Versioning](https://semver.org/) to signal changes between releases.
+
+Currently is at _major version zero_ and as [the specification states](https://semver.org/#spec-item-4) the current API is not at stable state.
+
+Please always compare versions between updates!
+
 ## Usage
 This guide corresponds to [Eleventy documentation](https://www.11ty.dev/docs/plugins/#add-the-plugin-to-eleventy-in-your-config-file):
 
@@ -82,6 +89,8 @@ Transforms a date string to a short date time text. Useful for blog post dates.
 {% comment %} renders "12/12/21, 5:36 PM" when the `intlUtilConfig.locale` is `en` {% endcomment %}
 ```
 
+## Shortcodes
+
 ### `year_interval`
 Transforms two date strings to a year range. Useful when a larger time interval is presented.
 
@@ -92,10 +101,22 @@ The input should be an array with two date string and the first one should prece
 #### LiquidJS Example
 
 ```
-{% assign dates = "2011-05-16 11:00 +0200, 2020-03-01 00:00 +0100" | split: ", " %}
-{{ dates | year_interval }}
+{% assign startDate = "2011-05-16 11:00 +0200" %}
+{% assign endDate = "2020-03-01 00:00 +0100" %}
+{% year_interval startDate, endDate %}
 {% comment %} renders "2011 – 2020" (with en dash in the middle) when the `intlUtilConfig.locale` is `en` {% endcomment %}
 ```
 
+#### Fallback value
+The second `endDate` argument can be omitted and it has the current date as default value.
+
+This behaviour helps when an open-ended / ongoing interval needs be displayed:
+
+```
+{% assign startDate = "2011-05-16 11:00 +0200" %}
+{% year_interval startDate %}
+{% comment %} renders "2011 – 2021" (with en dash in the middle) when the `intlUtilConfig.locale` is `en` and the current year is 2021 {% endcomment %}
+```
+
 ## License
 Available under the [MIT license](LICENSE.md).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pcdevil/eleventy-plugin-intl-utils",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "private": false,
   "publishConfig": {
     "access": "public"

package/src/{year_interval.js → shortcodes/year_interval.js}

@@ -5,7 +5,7 @@ function yearIntervalFactory (locale) {
 		year: 'numeric',
 	});
 
-	return ([startDate, endDate]) => dateTimeFormat.formatRange(new Date(startDate), new Date(endDate));
+	return (startDate, endDate = new Date()) => dateTimeFormat.formatRange(new Date(startDate), new Date(endDate));
 }
 
 module.exports = yearIntervalFactory;