feat!: UNIX standard alignments #667

sheerlox · 2023-05-21T16:17:18Z

Closes #666.
Closes #475.

TODO

update month indexing from 0-11 (Jan-Dec) to 1-12 (Jan-Dec)
update day-of-week indexing from 0-6 (Sun-Sat) to 0-7 (Sun-Sun)
update "Cron Ranges" section of README
add a migration section to README

update month indexing from 0-11 (Jan-Dec) to 1-12 (Jan-Dec)

support day-of-week indexing 0-7 (Sun-Sun) this only affects cron string parsing, not the way the library works under the hood

sheerlox · 2023-05-21T19:20:45Z

lib/time.js

@@ -671,8 +671,10 @@ function CronTime(luxon) {

 		_hasAll: function (type) {
 			const constraints = CONSTRAINTS[TIME_UNITS.indexOf(type)];
+			const low = constraints[0];
+			const high = type === 'dayOfWeek' ? constraints[1] - 1 : constraints[1];


It bothers me that 'dayOfWeek' is the only time unit being referenced as a plain string in the code, which was until now perfectly generic. But since we support it as an upper bound for cron string parsing, it still needs its constraints to be different than before.

if you want you can do something like

const dayOfWeekType = TIME_UNITS[5]; const high = type === dayOfWeekType ? constraints[1] - 1 : constraints[1];

to keep it generic

@intcreator I expanded on that idea and found something that should be better, please let me know what you think: 09e5d7c

sheerlox · 2023-05-21T19:27:48Z

Hey @intcreator 👋

So the changes for the month indexing were pretty straightforward as it was a simple shift.

The more complicated part was for day-of-week since I needed to add a second Sunday value. I thought about how that would impact the various functions for a while, then decided to go for a simple solution: to support 7 as a valid value when creating a cron, but then change it to a 0 so we don't need to modify the whole code to adapt for that change.

Please let me know your thoughts on this 😉

intcreator · 2023-05-22T22:58:41Z

looking good so far, thanks for your work on this! we'll probably want to put this and potentially other breaking changes on a v3 branch that people can test on/we can release as a preview before the official v3 release

sheerlox · 2023-05-25T08:36:08Z

rebased against master to keep the commit history linear

sheerlox · 2023-05-25T09:20:55Z

We might want to notify the folks at NestJS of this change once we release v3 (after the Typescript migration).

See:

## [3.0.0-beta.1](v2.3.1...v3.0.0-beta.1) (2023-07-20) ### ⚠ Breaking changes * UNIX standard alignments (#667) ### ✨ Features * UNIX standard alignments ([#667](#667)) ([96ef954](96ef954)) ### ⚙️ Continuous Integrations * add support for beta & maintenance releases ([#677](#677)) ([c6fc842](c6fc842)) * setup conventional commits & release automation ([#673](#673)) ([c6f39ff](c6f39ff)) ### ♻️ Chores * update default branch name ([#678](#678)) ([7471e95](7471e95))

## [3.0.0-beta.1](v2.3.1...v3.0.0-beta.1) (2023-07-23) ### ⚠ Breaking changes * UNIX standard alignments (#667) ### ✨ Features * UNIX standard alignments ([#667](#667)) ([96ef954](96ef954)) ### ⚙️ Continuous Integrations * add support for beta & maintenance releases ([#677](#677)) ([c6fc842](c6fc842)) * setup conventional commits & release automation ([#673](#673)) ([c6f39ff](c6f39ff)) ### ♻️ Chores * update default branch name ([#678](#678)) ([7471e95](7471e95))

ncb000gt · 2023-07-23T10:23:46Z

🎉 This PR is included in version 3.0.0-beta.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

## [3.0.0](v2.4.4...v3.0.0) (2023-09-30) ### ⚠ Breaking changes * `utcOffset` parameter no longer accepts a string * `utcOffset` values between -60 and 60 are no longer treated as hours * providing both `timeZone` and `utcOffset` parameters now throws an error * removed `cron.job()` method in favor of `new CronJob(...args)` / `CronJob.from(argsObject)` * removed `cron.time()` method in favor of `new CronTime()` * `CronJob`: constructor no longer accepts an object as its first and only params. Use `CronJob.from(argsObject)` instead. * `CronJob`: callbacks are now called in the order they were registered * return empty array from nextDates when called without argument (#519) * UNIX standard alignments (#667) ### ✨ Features * expose useful types ([737b344](737b344)) * rework utcOffset parameter ([#699](#699)) ([671e933](671e933)) * UNIX standard alignments ([#667](#667)) ([ff615f1](ff615f1)) ### 🐛 Bug Fixes * return empty array from nextDates when called without argument ([#519](#519)) ([c2891ba](c2891ba)) ### 📦 Code Refactoring * migrate to TypeScript ([#694](#694)) ([2d77894](2d77894)) ### 📚 Documentation * **readme:** remove outdated informations ([#695](#695)) ([b5ceaf1](b5ceaf1)) ### 🚨 Tests * update new test for cron standard alignments ([4a406c1](4a406c1)) ### ♻️ Chores * improve GitHub community standards ([#698](#698)) ([6bdef77](6bdef77)) * update contributors list ([dab3d69](dab3d69)) ### 💎 Styles * fix linting issues ([47e665f](47e665f))

sheerlox added 3 commits May 21, 2023 17:46

test: update tests for UNIX month indexing

780d982

feat: use UNIX month indexing

a9f6790

update month indexing from 0-11 (Jan-Dec) to 1-12 (Jan-Dec)

test: update tests for UNIX day-of-week indexing

8149308

sheerlox force-pushed the feat-666/unix-standard-alignments branch from 46c2ddf to f64a47a Compare May 21, 2023 19:05

feat: support UNIX day-of-week indexing

9ebd465

support day-of-week indexing 0-7 (Sun-Sun) this only affects cron string parsing, not the way the library works under the hood

sheerlox commented May 21, 2023

View reviewed changes

sheerlox added 4 commits May 24, 2023 22:28

refactor: improve time units referencing

b84aae9

test: add test for aliases case-insensitivity

be8ce95

docs(readme): update "Cron Ranges" section

f1f403a

docs(readme): add a migration section

614a3de

sheerlox marked this pull request as ready for review May 24, 2023 21:06

sheerlox force-pushed the feat-666/unix-standard-alignments branch from 0cd7f87 to 7dfd34b Compare May 25, 2023 08:36

sheerlox mentioned this pull request May 25, 2023

node-cron's month does not follow normal cron spec #475

Closed

sheerlox changed the title ~~feat: UNIX standard alignments~~ feat!: UNIX standard alignments Jun 26, 2023

sheerlox mentioned this pull request Jun 26, 2023

State of the library & moving forward #674

Open

34 tasks

sheerlox changed the base branch from master to beta July 20, 2023 17:21

sheerlox deleted the branch kelektiv:beta July 20, 2023 17:32

sheerlox closed this Jul 20, 2023

sheerlox reopened this Jul 20, 2023

sheerlox force-pushed the feat-666/unix-standard-alignments branch from 7dfd34b to 614a3de Compare July 20, 2023 18:55

sheerlox merged commit 96ef954 into kelektiv:beta Jul 20, 2023
10 checks passed

ncb000gt added the released on @beta label Jul 23, 2023

sheerlox added a commit that referenced this pull request Sep 27, 2023

feat!: UNIX standard alignments (#667)

a70252d

sheerlox added a commit that referenced this pull request Sep 27, 2023

feat!: UNIX standard alignments (#667)

d9a2b2d

sheerlox added a commit to sheerlox/node-cron that referenced this pull request Sep 27, 2023

feat!: UNIX standard alignments (kelektiv#667)

4e70cd6

sheerlox added a commit to sheerlox/node-cron that referenced this pull request Sep 27, 2023

feat!: UNIX standard alignments (kelektiv#667)

9bc7fb3

sheerlox added a commit to sheerlox/node-cron that referenced this pull request Sep 29, 2023

feat!: UNIX standard alignments (kelektiv#667)

d9d04a9

sheerlox added a commit to sheerlox/node-cron that referenced this pull request Sep 29, 2023

feat!: UNIX standard alignments (kelektiv#667)

47e64e6

sheerlox added a commit to sheerlox/node-cron that referenced this pull request Sep 29, 2023

feat!: UNIX standard alignments (kelektiv#667)

e5c0a4c

sheerlox added a commit to sheerlox/node-cron that referenced this pull request Sep 29, 2023

feat!: UNIX standard alignments (kelektiv#667)

2551004

sheerlox mentioned this pull request Sep 29, 2023

chore: release v3.0.0 #701

Merged

sheerlox added a commit that referenced this pull request Sep 30, 2023

feat!: UNIX standard alignments (#667)

ff615f1

sheerlox added released type:feature New feature or feature improvement & requests and removed released on @beta labels Sep 30, 2023

sheerlox mentioned this pull request Jul 17, 2024

Incorrect Behavior in Setting Up a Cron Job for First Monday of the Month #890

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat!: UNIX standard alignments #667

feat!: UNIX standard alignments #667

sheerlox commented May 21, 2023 •

edited

Loading

sheerlox May 21, 2023

intcreator May 22, 2023

sheerlox May 24, 2023 •

edited

Loading

sheerlox commented May 21, 2023

intcreator commented May 22, 2023 •

edited

Loading

sheerlox commented May 25, 2023 •

edited

Loading

sheerlox commented May 25, 2023

ncb000gt commented Jul 23, 2023

feat!: UNIX standard alignments #667

feat!: UNIX standard alignments #667

Conversation

sheerlox commented May 21, 2023 • edited Loading

TODO

sheerlox May 21, 2023

Choose a reason for hiding this comment

intcreator May 22, 2023

Choose a reason for hiding this comment

sheerlox May 24, 2023 • edited Loading

Choose a reason for hiding this comment

sheerlox commented May 21, 2023

intcreator commented May 22, 2023 • edited Loading

sheerlox commented May 25, 2023 • edited Loading

sheerlox commented May 25, 2023

ncb000gt commented Jul 23, 2023

sheerlox commented May 21, 2023 •

edited

Loading

sheerlox May 24, 2023 •

edited

Loading

intcreator commented May 22, 2023 •

edited

Loading

sheerlox commented May 25, 2023 •

edited

Loading