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

package/.prettierrc.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "https://json.schemastore.org/prettierrc",
+	"printWidth": 300,
+	"proseWrap": "never",
+	"semi": true,
+	"singleAttributePerLine": true,
+	"singleQuote": true,
+	"tabWidth": 2,
+	"trailingComma": "all",
+	"useTabs": true
+}

package/README.md

@@ -116,5 +116,22 @@ This behaviour helps when an open-ended / ongoing interval needs be displayed:
 
 This renders "2011 – 2021" (with en dash in the middle) when the `intlUtilConfig.locale` is `en` and the current year is 2021.
 
+### `year_open_interval`
+Transforms a date string into an _open_ year range where the end date is absent. Useful when a ongoing interval is presented.
+
+- **Used Internationalization API**: `Intl.DateTimeFormat.prototype.formatRange()` with _numeric_ year ([MDN article](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/formatRange))
+
+#### LiquidJS Example
+
+```
+{% assign startDate = "2011-05-16 11:00 +0200" %}
+{% year_interval startDate %}
+```
+
+This renders "2011 – " (with en dash in the middle) when the `intlUtilConfig.locale` is `en`.
+
+#### Difference from `year_interval`
+While the [`year_interval`](#year_interval) shortcode always created a _closed_ year range (by applying the current year as default), the `year_open_interval` only displays the start date.
+
 ## License
 Available under the [MIT license](LICENSE.md).

package/package.json

@@ -1,17 +1,23 @@
 {
   "name": "@pcdevil/eleventy-plugin-intl-utils",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "private": false,
   "publishConfig": {
     "access": "public"
   },
   "description": "A set of internationalization utils for Eleventy.",
   "engines": {
-    "node": ">= 16.0.0"
+    "node": ">= 18.0.0"
   },
-  "main": ".eleventy.js",
+  "main": "./src/eleventy.js",
   "scripts": {
-    "lint": "npx eslint ."
+    "format": "prettier --check src/",
+    "format:fix": "npm run format -- --write",
+    "lint": "npx eslint --ignore-path .gitignore .",
+    "lint:fix": "npm run lint -- --fix",
+    "release:major": "npm version major",
+    "release:minor": "npm version minor",
+    "release:patch": "npm version patch"
   },
   "repository": {
     "type": "git",
@@ -36,10 +42,7 @@
   },
   "homepage": "https://github.com/pcdevil/eleventy-plugin-intl-utils#readme",
   "devDependencies": {
-    "eslint": "^7.32.0",
-    "eslint-config-standard": "^16.0.3",
-    "eslint-plugin-import": "^2.25.3",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^5.2.0"
+    "eslint": "^8.36.0",
+    "prettier": "^2.8.6"
   }
 }

package/src/eleventy.js

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

package/src/filters/country_name.js

@@ -1,6 +1,6 @@
 'use strict';
 
-function countryNameFactory (locale) {
+function countryNameFactory(locale) {
 	const displayName = new Intl.DisplayNames([locale], { type: 'region' });
 
 	return (countryCode) => displayName.of(countryCode);

package/src/filters/language_name.js

@@ -1,6 +1,6 @@
 'use strict';
 
-function languageNameFactory (locale) {
+function languageNameFactory(locale) {
 	const displayName = new Intl.DisplayNames([locale], { type: 'language' });
 
 	return (language) => displayName.of(language);

package/src/filters/short_datetime_format.js

@@ -1,6 +1,6 @@
 'use strict';
 
-function shortDateTimeFormatFactory (locale) {
+function shortDateTimeFormatFactory(locale) {
 	const dateTimeFormat = new Intl.DateTimeFormat(locale, {
 		dateStyle: 'short',
 		timeStyle: 'short',

package/src/shortcodes/year_interval.js

@@ -1,6 +1,6 @@
 'use strict';
 
-function yearIntervalFactory (locale) {
+function yearIntervalFactory(locale) {
 	const dateTimeFormat = new Intl.DateTimeFormat(locale, {
 		year: 'numeric',
 	});

package/src/shortcodes/year_open_interval.js

@@ -0,0 +1,16 @@
+'use strict';
+
+function yearOpenIntervalFactory(locale) {
+	const dateTimeFormat = new Intl.DateTimeFormat(locale, {
+		year: 'numeric',
+	});
+
+	return (startDate) =>
+		dateTimeFormat
+			.formatRangeToParts(new Date(startDate), new Date())
+			.filter(({ source }) => source !== 'endRange')
+			.map(({ value }) => value)
+			.join('');
+}
+
+module.exports = yearOpenIntervalFactory;

package/.eleventy.js

@@ -1,16 +0,0 @@
-'use strict';
-
-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;
-
-	eleventyConfig.addFilter('country_name', countryNameFactory(locale));
-	eleventyConfig.addFilter('language_name', languageNameFactory(locale));
-	eleventyConfig.addFilter('short_datetime_format', shortDateTimeFormatFactory(locale));
-
-	eleventyConfig.addShortcode('year_interval', yearIntervalFactory(locale));
-};