cronstrue 2.2.0 → 2.5.0

package/README.md

@@ -26,10 +26,10 @@ npm install cronstrue
 
 Then, depending upon your usage context, add a reference to it:
 
-### Node
+### Node / CommonJS
 
 ```js
-var cronstrue = require('cronstrue');
+const cronstrue = require('cronstrue');
 ```
 
 ### ESM / webpack / TypeScript
@@ -57,7 +57,7 @@ A simple way to load the library in a browser is by using the [unpkg](https://un
 <script src="https://unpkg.com/cronstrue@latest/dist/cronstrue.min.js" async></script>
 ```
 
-Using the "latest" tag will result in a 302 redirect to the latest version tag so it is highly recommended to use a specific version tag such as https://unpkg.com/cronstrue@1.48.0/dist/cronstrue.min.js to avoid this redirect.
+Using the "latest" tag will result in a 302 redirect to the latest version tag so it is recommended to use a specific version tag such as https://unpkg.com/cronstrue@1.48.0/dist/cronstrue.min.js to avoid this redirect.
 
 ## Usage
 
@@ -99,31 +99,48 @@ An options object can be passed as the second parameter to `cronstrue.toString`.
 
 ## i18n
 
-To use the i18n support cRonstrue provides, you can import a specific locale and then call `toString()`. For example, for the es (Spanish) locale:
+To use the i18n support cRonstrue provides, you can either import all the supported locales at once (using `cronstrue/i18n`) or import individual locales (using `cronstrue/locales/[locale]`).  Then, when calling `toString` you pass in the name of the locale you want to use.  For example, for the es (Spanish) locale, you would use: `cronstrue.toString("* * * * *", { locale: "es" })`.
+
+### All Locales
+
+You can import all locales at once with `cronstrue/i18n`.  This approach has the advantage of only having to load one module and having access to all supported locales.  The tradeoff with this approach is a larger module (~130k, minified) that will take longer to load, particularly when sending down to a browser.
 
 ```js
-import cronstrue from 'cronstrue/locales/es';
-cronstrue.toString("*/5 * * * *");
-```
+// Node / CommonJS
+const cronstrue = require('cronstrue/i18n');
 
-### Browser
+// ESM / webpack / TypeScript
+import cronstrue from 'cronstrue/i18n';
 
-A locale file from the `/locales` folder in the npm package should be served to the browser.
+// Browser
+<script src="https://unpkg.com/cronstrue@latest/cronstrue-i18n.min.js" async></script>
 
-```html
-<script src="https://unpkg.com/cronstrue@latest/locales/es.min.js" async></script>
-<script>
-  cronstrue.toString("*/5 * * * *");
-</script>
+cronstrue.toString("*/5 * * * *", { locale: "fr" }); // => Toutes les 5 minutes
+cronstrue.toString("*/5 * * * *", { locale: "es" }); // => Cada 5 minutos
 ```
 
-### All Locales
+### Individual Locales
 
-Alternatively you can import all locales and then pass in the `locale` option:
+You can also load the main cronstrue module and then load individual locale modules you want to have access to.  This works well when you have one or more locales you know you need access to and want to minimize load time, particularly when sending down to a browser.  The main cronstrue module is about 42k (minified) and each locale is about 4k (minified) in size.
 
 ```js
-import cronstrue from 'cronstrue/i18n';
-cronstrue.toString("*/5 * * * *", { locale: "es" });
+// Node / CommonJS
+const cronstrue = require('cronstrue');
+require('cronstrue/locales/fr');
+require('cronstrue/locales/es');
+
+// ESM / webpack / TypeScript
+import cronstrue from 'cronstrue';
+import 'cronstrue/locales/fr';
+import 'cronstrue/locales/es';
+
+// Browser
+<script src="https://unpkg.com/cronstrue@latest/cronstrue.min.js" async></script>
+<script src="https://unpkg.com/cronstrue@latest/locales/fr.min.js" async></script>
+<script src="https://unpkg.com/cronstrue@latest/locales/es.min.js" async></script>
+
+cronstrue.toString("*/5 * * * *", { locale: "fr" }); // => Toutes les 5 minutes
+cronstrue.toString("*/5 * * * *", { locale: "es" }); // => Cada 5 minutos
 ```
 
 ## Frequently Asked Questions
@@ -134,7 +151,7 @@ This library does not do full validation of cron expressions and assumes the exp
 
 > Can cRonstrue output the next occurrence of the cron expression?
 
-No, cRonstrue does not support this.  It simply describes a cron expression.  You could use another library to get the next occurrence of a cron expression and then pass that expression into cRonstrue, to achieve this.
+No, cRonstrue does not support this.  This library simply describes a cron expression that is passed in.
 
 ### Supported Locales
 

package/dist/cronstrue-i18n.js

@@ -386,6 +386,13 @@ var ExpressionDescriptor = (function () {
         }, function (s) {
             return _this.i18n.atX0();
         });
+        if (description && expression.includes("-") && this.expressionParts[1] != "0") {
+            var atTheHourMatches = Array.from(description.matchAll(/:00/g));
+            if (atTheHourMatches.length > 1) {
+                var lastAtTheHourMatchIndex = atTheHourMatches[atTheHourMatches.length - 1].index;
+                description = description.substring(0, lastAtTheHourMatchIndex) + ":59" + description.substring(lastAtTheHourMatchIndex + 3);
+            }
+        }
         return description;
     };
     ExpressionDescriptor.prototype.getDayOfWeekDescription = function () {
@@ -609,7 +616,6 @@ var ExpressionDescriptor = (function () {
         var rangeSegments = rangeExpression.split("-");
         var rangeSegment1Description = getSingleItemDescription(rangeSegments[0]);
         var rangeSegment2Description = getSingleItemDescription(rangeSegments[1]);
-        rangeSegment2Description = rangeSegment2Description.replace(":00", ":59");
         var rangeDescriptionFormat = getRangeDescriptionFormat(rangeExpression);
         description += stringUtilities_1.StringUtilities.format(rangeDescriptionFormat, rangeSegment1Description, rangeSegment2Description);
         return description;