@pcdevil/eleventy-plugin-intl-utils 1.0.2 → 2.0.0

package/LICENSE.md

@@ -1,20 +1,36 @@
-# The MIT License
+# 3-Clause BSD NON-AI License
 
-Copyright 2021 Attila Gonda https://attilagonda.com
+Copyright 2023-, Attila Gonda https://attilagonda.com
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+   may be used to endorse or promote products derived from this software without
+   specific prior written permission.
+
+4. The source code and the binary form, and any modifications made to them may
+   not be used for the purpose of training or improving machine learning
+   algorithms, including but not limited to artificial intelligence, natural
+   language processing, or data mining. This condition applies to any
+   derivatives, modifications, or updates based on the Software code. Any usage
+   of the source code or the binary form in an AI-training dataset is considered
+   a breach of this License.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -1,7 +1,11 @@
-# eleventy-plugin-intl-utils
+# eleventy-plugin-intl-utils <a href="https://ko-fi.com/s/4662b19f61"><img src="assets/made-by-a-human_badge.png"></a>
+
 A set of internationalization utils for [Eleventy](https://www.11ty.dev/).
 
+💙 This project is made by humans for humans - using it with LLM models is strongly discouraged: the [AGENTS.md](AGENTS.md) and [CLAUDE.md](CLAUDE.md) files only exist to instruct such tools to halt any action.
+
 ## 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/) and [shortcodes](https://www.11ty.dev/docs/shortcodes/).
@@ -9,32 +13,34 @@ However it only gives solution for static data and dynamic data still needs trea
 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_.
 
 ## Usage
+
 This guide corresponds to [Eleventy documentation](https://www.11ty.dev/docs/plugins/#add-the-plugin-to-eleventy-in-your-config-file):
 
 1. Install the package
-    ```bash
-    npm install --save @pcdevil/eleventy-plugin-intl-utils
-    ```
+   ```bash
+   npm install --save @pcdevil/eleventy-plugin-intl-utils
+   ```
 
 2. Add to your config file
-    ```javascript
-    // file: .eleventy.js
-    const intlUtils = require('@pcdevil/eleventy-plugin-intl-utils');
+   ```javascript
+   // file: eleventy.config.js
+   import intlUtils from '@pcdevil/eleventy-plugin-intl-utils';
 
-    module.exports = function (eleventyConfig) {
-        // ...
+   export default async function (eleventyConfig) {
+   	// ...
 
-        const intlUtilConfig = {
-            locale: 'en-GB',
-        };
-        eleventyConfig.addPlugin(intlUtils, intlUtilConfig);
-    };
-    ```
+   	eleventyConfig.addPlugin(intlUtils, {
+   		locale: 'en-GB',
+   	});
+   }
+   ```
 
 ## Configuration object
+
 A general configuration object can be passed optionally via Eleventy config when the plugin is initiated. This sections lists the available configuration properties.
 
 ### `locale`
+
 This property affects the output language of the filters. See [`locales` argument section on Intl page](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locales_argument) for more info.
 
 - **Type**: String
@@ -44,6 +50,7 @@ This property affects the output language of the filters. See [`locales` argumen
 ## Filters
 
 ### `country_name`
+
 Transforms a country code into a country name. Useful to display author's location.
 
 - **Used Internationalization API**: `Intl.DisplayNames()` with _region_ type ([MDN article](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DisplayNames/DisplayNames))
@@ -58,6 +65,7 @@ Transforms a country code into a country name. Useful to display author's locati
 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.
 
 - **Used Internationalization API**: `Intl.DisplayNames()` with _language_ type ([MDN article](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DisplayNames/DisplayNames#using_type_language_with_languagedisplay))
@@ -72,6 +80,7 @@ Transforms a language code to a renderable text. Useful for language selectors o
 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.
 
 - **Used Internationalization API**: `Intl.DateTimeFormat()` with _short_ date and time style ([MDN article](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat))
@@ -88,6 +97,7 @@ 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.
 
 The input should be an array with two date string and the first one should precede before the second one.
@@ -105,6 +115,7 @@ The input should be an array with two date string and the first one should prece
 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:
@@ -116,5 +127,31 @@ 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.
 
-## License
-Available under the [MIT license](LICENSE.md).
+### `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 and acknowledgments
+
+The project is available under the **3-Clause BSD** license with an extension of prohibiting to use it with Gen-AI and LLMs tools, see the [LICENSE.md](LICENSE.md) file.
+
+"Human made content badge" badge created by **Andy Carolan**: <https://www.andycarolan.com/>
+
+License based on **Aleksandar Prokopec**'s Non-AI Licenses: <https://github.com/non-ai-licenses/non-ai-licenses>
+
+`AGENTS.md` is created by **Alice D.**: <https://codeberg.org/queer-computer-club/doorbot/src/branch/doorbot-pro-max-ultra-deluxe-se/AGENTS.md>

package/package.json

@@ -1,21 +1,34 @@
 {
   "name": "@pcdevil/eleventy-plugin-intl-utils",
-  "version": "1.0.2",
+  "version": "2.0.0",
   "private": false,
   "publishConfig": {
     "access": "public"
   },
   "description": "A set of internationalization utils for Eleventy.",
   "engines": {
-    "node": ">= 16.0.0"
+    "node": "^22.23.1",
+    "npm": "^10.9.8"
   },
-  "main": ".eleventy.js",
+  "packageManager": "npm@10.9.8",
+  "main": "./src/eleventy-plugin-intl-utils.mjs",
+  "type": "module",
+  "files": [
+    "src"
+  ],
   "scripts": {
-    "lint": "npx eslint ."
+    "format": "dprint fmt",
+    "format:check-only": "dprint check",
+    "lint": "eslint --fix",
+    "lint:check-only": "eslint",
+    "release:major": "npm version major",
+    "release:minor": "npm version minor",
+    "release:patch": "npm version patch",
+    "update:dprint-plugins": "dprint config update"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/pcdevil/eleventy-plugin-intl-utils.git"
+    "url": "https://codeberg.org/pcdevil/eleventy-plugin-intl-utils.git"
   },
   "keywords": [
     "11ty",
@@ -30,16 +43,16 @@
     "name": "Attila Gonda",
     "url": "https://attilagonda.com"
   },
-  "license": "MIT",
+  "license": "BSD-3-Clause-NO-AI",
   "bugs": {
-    "url": "https://github.com/pcdevil/eleventy-plugin-intl-utils/issues"
+    "url": "https://codeberg.org/pcdevil/eleventy-plugin-intl-utils/issues"
   },
-  "homepage": "https://github.com/pcdevil/eleventy-plugin-intl-utils#readme",
+  "homepage": "https://codeberg.org/pcdevil/eleventy-plugin-intl-utils",
   "devDependencies": {
-    "eslint": "^8.14.0",
-    "eslint-config-standard": "^17.0.0",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-n": "^15.2.0",
-    "eslint-plugin-promise": "^6.0.0"
+    "@eslint/config-helpers": "~0.6.0",
+    "@eslint/js": "^10.0.1",
+    "dprint": "~0.55.1",
+    "eslint": "^10.6.0",
+    "globals": "^17.7.0"
   }
 }

package/src/eleventy-plugin-intl-utils.mjs

@@ -0,0 +1,16 @@
+import { countryNameFactory } from './filters/country_name.mjs';
+import { languageNameFactory } from './filters/language_name.mjs';
+import { shortDateTimeFormatFactory } from './filters/short_datetime_format.mjs';
+import { yearIntervalFactory } from './shortcodes/year_interval.mjs';
+import { yearOpenIntervalFactory } from './shortcodes/year_open_interval.mjs';
+
+export default function eleventyPluginIntlUtils (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 → country_name.mjs}

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

package/src/filters/{language_name.js → language_name.mjs}

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

package/src/filters/{short_datetime_format.js → short_datetime_format.mjs}

@@ -1,6 +1,4 @@
-'use strict';
-
-function shortDateTimeFormatFactory (locale) {
+export function shortDateTimeFormatFactory (locale) {
 	const dateTimeFormat = new Intl.DateTimeFormat(locale, {
 		dateStyle: 'short',
 		timeStyle: 'short',
@@ -8,5 +6,3 @@ function shortDateTimeFormatFactory (locale) {
 
 	return (date) => dateTimeFormat.format(new Date(date));
 }
-
-module.exports = shortDateTimeFormatFactory;

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

@@ -1,11 +1,7 @@
-'use strict';
-
-function yearIntervalFactory (locale) {
+export function yearIntervalFactory (locale) {
 	const dateTimeFormat = new Intl.DateTimeFormat(locale, {
 		year: 'numeric',
 	});
 
 	return (startDate, endDate = new Date()) => dateTimeFormat.formatRange(new Date(startDate), new Date(endDate));
 }
-
-module.exports = yearIntervalFactory;

package/src/shortcodes/year_open_interval.mjs

@@ -0,0 +1,12 @@
+export 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('');
+}

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));
-};