rrule - npm Package Compare versions

Comparing version 2.2.9 to 2.3.0

package.json

 {
   "name": "rrule",
-  "version": "2.2.9",
+  "version": "2.3.0",
   "description": "JavaScript library for working with recurrence rules for calendar dates.",
   "homepage": "http://jakubroztocil.github.io/rrule/",
+  "license": "SEE LICENSE IN LICENSE",
+  "babel": {
+    "presets": [
+      "babel-preset-env"
+    ]
+  },
   "keywords": [
@@ -14,3 +20,4 @@ "dates",
   "author": "Jakub Roztocil and Lars Schöning",
-  "main": "lib/rrule",
+  "main": "dist/es6",
+  "module": "dist/es6",
   "repository": {
@@ -21,7 +28,30 @@ "type": "git",
   "scripts": {
-    "test": "standard && mocha"
+    "build": "yarn lint && tsc && webpack",
+    "lint": "yarn tslint --project . --fix --config tslint.json",
+    "test": "yarn lint && TS_NODE_PROJECT=tsconfig.test.json mocha --require ts-node/register **/*.test.ts"
   },
   "devDependencies": {
-    "mocha": "^3.2.0",
-    "standard": "^8.6.0"
+    "@types/assert": "^0.0.31",
+    "@types/chai": "^4.1.4",
+    "@types/mocha": "^5.2.5",
+    "@types/node": "^10.5.4",
+    "babel-cli": "^6.26.0",
+    "babel-core": "^6.26.0",
+    "babel-loader": "^7.1.5",
+    "babel-preset-env": "^1.6.1",
+    "chai": "^4.1.2",
+    "coffee-loader": "^0.9.0",
+    "coffeescript": "^2.3.1",
+    "copy-webpack-plugin": "^4.5.2",
+    "html-webpack-plugin": "^3.2.0",
+    "jquery": "^3.3.1",
+    "mocha": "^5.2.0",
+    "source-map-loader": "^0.2.3",
+    "ts-loader": "^4.4.2",
+    "ts-node": "^7.0.0",
+    "tslint": "^5.11.0",
+    "tslint-eslint-rules": "^5.3.1",
+    "typescript": "^3.0.1",
+    "webpack": "^4.16.3",
+    "webpack-cli": "^3.1.0"
   },
@@ -35,5 +65,4 @@ "standard": {
     "lib",
-    "index.d.ts",
     "README.md"
   ]
 }

README.md

@@ -30,15 +30,13 @@ rrule.js
 ```bash
-$ bower install rrule
+$ yarn add rrule
 ```
 
-Alternatively, download
-[rrule.js](https://raw.github.com/jakubroztocil/rrule/master/lib/rrule.js) manually. If
-you intend to use `RRule.prototype.toText()` or `RRule.fromText()`, you'll
-also need [nlp.js](https://raw.github.com/jakubroztocil/rrule/master/lib/nlp.js).
+Alternatively, download manually:
 
+ * [rrule.min.js](https://raw.github.com/jakubroztocil/rrule/master/dist/es5/rrule.min.js) (bundled, minified)
+ * [rrule.js](https://raw.github.com/jakubroztocil/rrule/master/dist/es5/rrule.js) (bundled, not minified)
+ * [rrule.js](https://raw.github.com/jakubroztocil/rrule/master/dist/es6/rrule.js) (es6 source with optional TypeScript types)
+
 ```html
-<script src="rrule/lib/rrule.js"></script>
-
-<!-- Optional -->
-<script src="rrule/lib/nlp.js"></script>
+<script src="rrule/dist/es5/rrule.min.js"></script>
 ```
@@ -49,9 +47,7 @@
 ```bash
-$ npm install rrule
+$ yarn add rrule
 ```
 
-```javascript
-var RRule = require('rrule').RRule
-var RRuleSet = require('rrule').RRuleSet
-var rrulestr = require('rrule').rrulestr
+```es6
+import { RRule, RRuleSet, rrulestr } from 'rrule'
 ```
@@ -64,3 +60,3 @@
 // Create a rule:
-var rule = new RRule({
+const rule = new RRule({
   freq: RRule.WEEKLY,
@@ -99,3 +95,3 @@ interval: 5,
 ```js
-var rruleSet = new RRuleSet()
+const rruleSet = new RRuleSet()
 
@@ -350,3 +346,2 @@ // Add a rrule to rruleSet
     </dd>
-
     <dt><code>rule.origOptions</code></dt>
@@ -488,5 +483,2 @@ <dd>The original <code>options</code> argument passed to
 
-To use these methods in the browser, you need to include the
-`rrule/nlp.js` file as well.
-
 ##### `RRule.prototype.toText([gettext, [language]])`
@@ -616,11 +608,2 @@
 
-`ignoretz`
-If set to True, the date parser will ignore timezone information available in
-the DTSTART property, or the UNTIL attribute.
-
-`tzinfos`
-If set, it will be passed to the datetime string parser to resolve unknown
-timezone settings. For more information about what could be used here, check
-the parser documentation.
-
 * * * * *
@@ -630,2 +613,8 @@
 
+* *Timezones:* `RRule` does not implement the `TZID` keyword in the RFC. It
+only correctly supports "floating" times or UTC timezones. While it will work
+the same regardless of the host system's timezone, for best results, only pass
+in JS `Date` objects that are represented in UTC to avoid unexpected timezone
+offsets being applied.
+
 * `RRule` has no `byday` keyword. The equivalent keyword has been replaced by
@@ -661,15 +650,38 @@ the `byweekday` keyword, to remove the ambiguity present in the original
 
-rrule.js use [JavaScript Standard Style](https://github.com/feross/standard) coding style.
+rrule.js is implemented in Typescript. It uses [JavaScript Standard Style](https://github.com/feross/standard) coding style.
 
+To run the code, checkout this repository and run:
+
+```
+$ yarn
+```
+
+To run the tests, run:
+
+```
+$ yarn test
+```
+
+To build files for distribution, run:
+
+```
+$ yarn build
+```
+
 ### Changelog
 
+* 2.3.0 (2018-08-06)
+    * Converted to [Typescript](https://www.typescriptlang.org/)
+    * Add es5 and es6 distributions
+    * Fixed a bug where recurrences in DST were 1 hour off if the host system used DST
+    * Fixed numeric handling of weekday strings
 * 2.2.8 (2018-02-16)
-    * fix: isLeapYear only accepts integers instead of relying on instanceof to check the parameter type
-    * prevent new RRule from mutating passed-in options
-    * Add 'from text' and 'to text' support for minutes
-    * Add support for VALUE=DATE as a RDATE param
-    * Prevent unexpected results with dates lower than 1970
-    * merge in rrule-alt
-    * fix DAILY frequency when only 1 BYHOUR is provided
-    * added typescript definitions
+    * Added `fromText()` and `toText()` support for rules with `RRule.MINUTELY` frequency.
+    * Added support for `VALUE=DATE` as a `RDATE` param.
+    * Added typescript definitions.
+    * Merged in the now obsolete `arolson101/rrule` fork (many thanks to @arolson101).
+    * Fixed `RRule` mutating passed-in `options` in some cases.
+    * Fixed unexpected results with dates lower than 1970.
+    * Fixed `RRule.DAILY` frequency when only 1 `BYHOUR` is provided.
+    * Fixed the internal `isLeapYear()` to only accept integers instead of relying on `instanceof` to check the parameter type.
 * 2.2.0 (2017-03-11)
@@ -676,0 +688,0 @@ * Added support `RRuleSet`, which allows more complex recurrence setups,

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

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

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

Misc. License Issues

License

(Experimental) A package's licensing information has fine-grained problems.

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

Improved metrics

Number of lines in readme file

747

increased by1.63%

Worsened metrics

Total package byte prevSize

30242

decreased by-76.94%

Dev dependency count

23

increased by1050%

Number of package files

3

decreased by-50%

Number of medium license alerts

1

increased byInfinity%

Lines of code

0

decreased by-100%

Number of medium supply chain risk alerts

2

increased byInfinity%

No dependency changes