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

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,7 +4,7 @@ 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_.
 
@@ -53,9 +53,10 @@ Transforms a country code into a country name. Useful to display author's locati
 ```
 {% assign country = "FR" %}
 {{ country | country_name }}
-{% comment %} renders "France" when the `intlUtilConfig.locale` is `en` {% endcomment %}
 ```
 
+This renders "France" when the `intlUtilConfig.locale` is `en`.
+
 ### `language_name`
 Transforms a language code to a renderable text. Useful for language selectors or when the current language is displayed.
 
@@ -66,9 +67,10 @@ Transforms a language code to a renderable text. Useful for language selectors o
 ```
 {% assign language = "en-GB" %}
 {{ language | language_name }}
-{% comment %} renders "British English" when the `intlUtilConfig.locale` is `en` {% endcomment %}
 ```
 
+This renders "British English" when the `intlUtilConfig.locale` is `en`.
+
 ### `short_datetime_format`
 Transforms a date string to a short date time text. Useful for blog post dates.
 
@@ -79,9 +81,12 @@ Transforms a date string to a short date time text. Useful for blog post dates.
 ```
 {% assign postDate = "2021-12-12 17:36 +0100" %}
 {{ postDate | short_datetime_format }}
-{% comment %} renders "12/12/21, 5:36 PM" when the `intlUtilConfig.locale` is `en` {% endcomment %}
 ```
 
+This renders "12/12/21, 5:36 PM" when the `intlUtilConfig.locale` is `en`.
+
+## Shortcodes
+
 ### `year_interval`
 Transforms two date strings to a year range. Useful when a larger time interval is presented.
 
@@ -92,10 +97,24 @@ 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 }}
-{% comment %} renders "2011 – 2020" (with en dash in the middle) when the `intlUtilConfig.locale` is `en` {% endcomment %}
+{% assign startDate = "2011-05-16 11:00 +0200" %}
+{% assign endDate = "2020-03-01 00:00 +0100" %}
+{% year_interval startDate, endDate %}
 ```
 
+This renders "2011 – 2020" (with en dash in the middle) when the `intlUtilConfig.locale` is `en`.
+
+#### 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 %}
+```
+
+This renders "2011 – 2021" (with en dash in the middle) when the `intlUtilConfig.locale` is `en` and the current year is 2021.
+
 ## 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": "1.0.1",
   "private": false,
   "publishConfig": {
     "access": "public"
@@ -21,6 +21,7 @@
     "11ty",
     "blog",
     "eleventy",
+    "eleventy-plugin",
     "internationalization",
     "static-site",
     "website"

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;

package/.eslintrc.json

@@ -1,36 +0,0 @@
-{
-	"extends": [
-		"eslint:recommended",
-		"standard"
-	],
-
-	"ignorePatterns": [
-		"!.eleventy.js"
-	],
-
-	"parserOptions": {
-		"sourceType": "script"
-	},
-
-	"root": true,
-
-	"rules": {
-		"curly": ["error", "all"],
-		"array-element-newline": ["error", "consistent"],
-		"arrow-parens": ["error", "always"],
-		"comma-dangle": ["error", {
-			"arrays": "always-multiline",
-			"exports": "always-multiline",
-			"functions": "never",
-			"imports": "always-multiline",
-			"objects": "always-multiline"
-		}],
-		"indent": ["error", "tab"],
-		"no-tabs": "off",
-		"object-property-newline": ["error", {
-			"allowAllPropertiesOnSameLine": false
-		}],
-		"semi": ["error", "always"],
-		"valid-jsdoc": "off"
-	}
-}

package/.nvmrc

@@ -1 +0,0 @@
-v16.13.1