cron - npm Package Compare versions

Comparing version 2.3.1 to 2.4.0

CHANGELOG.md

@@ -1,22 +0,91 @@
-## [v2.0.0] - 2022-05-03
+## [2.4.0](https://github.com/kelektiv/node-cron/compare/v2.3.0...v2.4.0) (2023-07-24)
+
+
+### ✨ Features
+
+* import type definitions from [@types](https://github.com/types)/cron ([d8a2f14](https://github.com/kelektiv/node-cron/commit/d8a2f140b59f063897dd20b7bb4dc7f599d2435b))
+
+
+### 🐛 Bug Fixes
+
+* don't start job in setTime if it wasn't running ([7e26c23](https://github.com/kelektiv/node-cron/commit/7e26c23e06277bfeb04525c71b67703392dbb8b2))
+
+
+### 🛠 Builds
+
+* **npm:** ship type definitions with releases ([0b663a8](https://github.com/kelektiv/node-cron/commit/0b663a8584f87cbec63042a4c217f43f38869fc4))
+
+
+### 🚨 Tests
+
+* add test case for [#598](https://github.com/kelektiv/node-cron/issues/598) fix ([4322ef2](https://github.com/kelektiv/node-cron/commit/4322ef29fa8af201aed5cdf8b829d411311fe025))
+* don't stop/start job before using setTime ([f0d5d3f](https://github.com/kelektiv/node-cron/commit/f0d5d3f32eddb8fd77b84438fe471fd374b34566))
+
+
+### ⚙️ Continuous Integrations
+
+* add support for beta & maintenance releases ([#677](https://github.com/kelektiv/node-cron/issues/677)) ([c6fc842](https://github.com/kelektiv/node-cron/commit/c6fc8429e905b38b05ba428e0df4a0fea273614a))
+* setup conventional commits & release automation ([#673](https://github.com/kelektiv/node-cron/issues/673)) ([c6f39ff](https://github.com/kelektiv/node-cron/commit/c6f39ff384041b7f91566fc935a9b961d453dd14))
+
+
+### ♻️ Chores
+
+* update default branch name ([#678](https://github.com/kelektiv/node-cron/issues/678)) ([7471e95](https://github.com/kelektiv/node-cron/commit/7471e95cb7433b4f29cfa68da0a652ec8cf630b6))
+* wrap setTime tests in describe and move down ([31989e0](https://github.com/kelektiv/node-cron/commit/31989e06f939bf1e9dbc6c0b6fc62c0a7144b9eb))
+
+## [v2.3.1](https://github.com/kelektiv/node-cron/compare/v2.3.0...v2.3.1) (2023-05-25)
+
+### Added
+
+- Logo!
+- New test cases
+
+### Fixed
+
+- Linting issues
+
+## [v2.3.0](https://github.com/kelektiv/node-cron/compare/v2.2.0...v2.3.0) (2023-03-14)
+
+### Fixed
+
+- Some small bugs
+
+### Changed
+
+- Refactored get next date function
+
+## [v2.2.0](https://github.com/kelektiv/node-cron/compare/v2.1.0...v2.2.0) (2023-01-09)
+
+### Changed
+
+- Updated Luxon dependency
+- Updated unit tests to be compatible with new Luxon version
+
+## [v2.1.0](https://github.com/kelektiv/node-cron/compare/v2.0.0...v2.1.0) (2022-07-14)
+
+### Changed
+
+- "Maximum iterations" will direct the user to refer to a single canonical issue instead of creating a new one
+
+## [v2.0.0](https://github.com/kelektiv/node-cron/compare/v1.8.2...v2.0.0) (2022-05-03)
 - Upgrade vulnerable dependencies
 - Move from moment.js to luxon (breaking change)
 
-## [v1.8.2] - 2020-01-24
+## [v1.8.2](https://github.com/kelektiv/node-cron/compare/v1.8.1...v1.8.2) (2020-01-24)
 - Fix syntax parsing bug
 
-## [v1.8.1] - 2020-01-19
+## [v1.8.1](https://github.com/kelektiv/node-cron/compare/v1.8.0...v1.8.1) (2020-01-19)
 - Revert TS definition defaulting to DefinitelyTyped definitions.
 
-## [v1.8.0] - 2020-01-19
+## [v1.8.0](https://github.com/kelektiv/node-cron/compare/v1.7.1...v1.8.0) (2020-01-19)
 - GH-454 - Range upper limit should default to highest value when step is provided by Noah May <[e-mail]> in d36dc9581f9f68580a2016b368f8002a9f1e357d
 
-## [v1.7.1] - 2019-04-26
+## [v1.7.1](https://github.com/kelektiv/node-cron/compare/v1.7.0...v1.7.1) (2019-04-26)
 - GH-416 - Fix issue where next execution time is incorrect in some cases in Naoya Inada <[e-mail]> in c08522ff80b3987843e9930c307b76d5fe38b5dc
 
-## [v1.7.0] - 2019-03-19
+## [v1.7.0](https://github.com/kelektiv/node-cron/compare/v1.6.0...v1.7.0) (2019-03-19)
 - GH-408 - DST issue by Shua Talansky <[e-mail]> in 1e971fd6dfa6ba4b0469d99dd64e6c31189d17d3 and 849a2467d16216a9dfa818c57cc26be6b6d0899b
 
-## [v1.6.0] - 2018-11-15
+## [v1.6.0](https://github.com/kelektiv/node-cron/compare/v1.5.1...v1.6.0) (2018-11-15)
 - GH-393, GH-394 - Remove hard limit on max iters in favor of a timeout by Nick Campbell <[e-mail]> in 57632b0c06c56e82f40b740b8d7986be43842735
 - GH-390 - better handling of real dates which are in the past by Nick Campbell <[e-mail]> in 7cbcc984aea6ec063e38829f68eb9bc0dfb1c775

package.json

 {
 	"name": "cron",
 	"description": "Cron jobs for your node",
-	"version": "2.3.1",
+	"version": "2.4.0",
 	"author": "Nick Campbell <[e-mail]> (https://github.com/ncb000gt)",
@@ -17,4 +17,7 @@ "bugs": {
 		"test": "jest --coverage",
-		"test:watch": "jest --watch --coverage"
+		"test:watch": "jest --watch --coverage",
+		"prepare": "husky install",
+		"release": "semantic-release"
 	},
+	"types": "types/index.d.ts",
 	"dependencies": {
@@ -24,2 +27,11 @@ "luxon": "^3.2.1"
 	"devDependencies": {
+		"@commitlint/cli": "~17.6.6",
+		"@insurgentlab/commitlint-config": "^18.1.0",
+		"@insurgentlab/conventional-changelog-preset": "~6.0.3",
+		"@semantic-release/changelog": "~6.0.x",
+		"@semantic-release/commit-analyzer": "~9.0.x",
+		"@semantic-release/git": "~10.0.x",
+		"@semantic-release/github": "~8.1.x",
+		"@semantic-release/npm": "~10.0.x",
+		"@semantic-release/release-notes-generator": "~11.0.x",
 		"chai": "~4.2.x",
@@ -34,4 +46,6 @@ "eslint": "~8.36.x",
 		"eslint-plugin-promise": "~6.1.x",
+		"husky": "^8.0.3",
 		"jest": "~29.5.x",
 		"prettier": "~2.8.x",
+		"semantic-release": "~21.0.x",
 		"sinon": "^15.0.x"
@@ -82,2 +96,3 @@ },
 		"lib",
+		"types",
 		"CHANGELOG.md",
@@ -84,0 +99,0 @@ "LICENSE",

README.md

@@ -52,3 +52,3 @@ <p align="center">
 
-There are more examples available in this repository at: [/examples](https://github.com/kelektiv/node-cron/tree/master/examples) 
+There are more examples available in this repository at: [/examples](https://github.com/kelektiv/node-cron/tree/main/examples) 
 
@@ -75,3 +75,3 @@ ## Available Cron patterns
 - Day of Month: 1-31
-- Months: 0-11 (Jan-Dec)
+- Months: 0-11 (Jan-Dec) <-- currently different from Unix `cron`!
 - Day of Week: 0-6 (Sun-Sat) 
@@ -81,2 +81,3 @@
 
+- Months are indexed as 0-11 instead of 1-12. This is different from Unix `cron` and is planned to updated to match Unix `cron` in v3.0.0 of `node-cron`.
 - Millisecond level granularity in JS `Date` or Luxon `DateTime` objects: Because computers take time to do things, there may be some delay in execution. This should be on the order of milliseconds. This module doesn't allow MS level granularity for the regular cron syntax, but _does_ allow you to specify a real date of execution in either a javascript `Date` object or a Luxon `DateTime` object. When this happens you may find that you aren't able to execute a job that _should_ run in the future like with `new Date().setMilliseconds(new Date().getMilliseconds() + 1)`. This is due to those cycles of execution above. This wont be the same for everyone because of compute speed. When we tried it locally we saw that somewhere around the 4-5 ms mark was where we got consistent ticks using real dates, but anything less than that would result in an exception. This could be really confusing. We could restrict the granularity for all dates to seconds, but felt that it wasn't a huge problem so long as you were made aware. If this becomes more of an issue, We can revisit it.
@@ -94,3 +95,3 @@ - Arrow Functions for `onTick`: Arrow functions get their `this` context from their parent scope. Thus, if you use them, you will not get the `this` context of the cronjob. You can read a little more in issue [GH-47](https://github.com/kelektiv/node-cron/issues/47#issuecomment-459762775)
 - `CronJob`
-    - `constructor(cronTime, onTick, onComplete, start, timezone, context, runOnInit, utcOffset, unrefTimeout)` - Of note, the first parameter here can be a JSON object that has the below names and associated types (see examples above).
+    - `constructor(cronTime, onTick, onComplete, start, timeZone, context, runOnInit, utcOffset, unrefTimeout)` - Of note, the first parameter here can be a JSON object that has the below names and associated types (see examples above).
         - `cronTime` - [REQUIRED] - The time to fire off your job. This can be in the form of cron syntax or a JS [Date](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Date) object.
@@ -100,6 +101,6 @@ - `onTick` - [REQUIRED] - The function to fire at the specified time. If an `onComplete` callback was provided, `onTick` will receive it as an argument. `onTick` may call `onComplete` when it has finished its work.
         - `start` - [OPTIONAL] - Specifies whether to start the job just before exiting the constructor. By default this is set to false. If left at default you will need to call `job.start()` in order to start the job (assuming `job` is the variable you set the cronjob to). This does not immediately fire your `onTick` function, it just gives you more control over the behavior of your jobs.
-        - `timeZone` - [OPTIONAL] - Specify the timezone for the execution. This will modify the actual time relative to your timezone. If the timezone is invalid, an error is thrown. You can check all timezones available at [Moment Timezone Website](http://momentjs.com/timezone/). Probably don't use both `timeZone` and `utcOffset` together or weird things may happen.
+        - `timeZone` - [OPTIONAL] - Specify the time zone for the execution. This will modify the actual time relative to your time zone. If the time zone is invalid, an error is thrown. By default (if this is omitted) the local time zone will be used. You can check all time zones available at [Moment Timezone Website](http://momentjs.com/timezone/). Probably don't use both `timeZone` and `utcOffset` together or weird things may happen.
         - `context` - [OPTIONAL] - The context within which to execute the onTick method. This defaults to the cronjob itself allowing you to call `this.stop()`. However, if you change this you'll have access to the functions and values within your context object.
         - `runOnInit` - [OPTIONAL] - This will immediately fire your `onTick` function as soon as the requisite initialization has happened. This option is set to `false` by default for backwards compatibility.
-        - `utcOffset` - [OPTIONAL] - This allows you to specify the offset of your timezone rather than using the `timeZone` param. This should be an integer amount representing the number of minutes offset (like `120` for +2 hours or `-90` for -1.5 hours) Probably don't use both `timeZone` and `utcOffset` together or weird things may happen.
+        - `utcOffset` - [OPTIONAL] - This allows you to specify the offset of your time zone rather than using the `timeZone` param. This should be an integer amount representing the number of minutes offset (like `120` for +2 hours or `-90` for -1.5 hours) Probably don't use both `timeZone` and `utcOffset` together or weird things may happen.
         - `unrefTimeout` - [OPTIONAL] - If you have code that keeps the event loop running and want to stop the node process when that finishes regardless of the state of your cronjob, you can do so making use of this parameter. This is off by default and cron will run as if it needs to control the event loop. For more information take a look at [timers#timers_timeout_unref](https://nodejs.org/api/timers.html#timers_timeout_unref)       from the NodeJS docs.
@@ -106,0 +107,0 @@ - `start` - Runs your job.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

58713

increased by27.18%

Number of package files

8

increased by14.29%

Lines of code

1114

increased by18.89%

Number of lines in readme file

136

increased by0.74%

Number of medium supply chain risk alerts

1

decreased by-50%

Worsened metrics

Dev dependency count

23

increased by91.67%

No dependency changes