sitemapper - npm Package Compare versions

Comparing version 2.0.0 to 2.1.0

lib/sitemapper.js

@@ -65,2 +65,10 @@ /* global require,module */
   /**
+   * Callback for the getSites method
+   *
+   * @callback getSitesCallback
+   * @param {Object} error - error from callback
+   * @param {Array} sites - an Array of sitemaps
+   */
+
+  /**
    * Timeout in milliseconds
@@ -277,12 +285,23 @@ *
     /**
+     * /**
      * Gets the sites from a sitemap.xml with a given URL
      * @deprecated
+     * @param {string} url - url to query
+     * @param {getSitesCallback} callback - callback for sites and error
+     * @callback
      */
   }, {
     key: 'getSites',
-    value: function getSites() {
-      var url = arguments.length <= 0 || arguments[0] === undefined ? this.url : arguments[0];
+    value: function getSites(url, callback) {
+      if (url === undefined) url = this.url;
 
       (0, _deprecate2['default'])('Please upgrade to sitemapper@2.0.0 to use promises instead of callbacks.' + 'Use `.fetch()` instead of .getSites(). see http://github.com/hawaiianchimp/sitemapper ' + 'for more info.');
-      return this.fetch(url);
+      var err = {};
+      var sites = [];
+      this.fetch(url).then(function (response) {
+        sites = response.sites;
+      })['catch'](function (error) {
+        err = error;
+      });
+      return callback(err, sites);
     }
@@ -289,0 +308,0 @@ }], [{

lib/test.js

@@ -132,2 +132,14 @@ /* global describe,it */
   });
+
+  describe('getSites method', function () {
+    it('getSites should be backwards compatible', function (done) {
+      this.timeout(30000);
+      var url = 'http://wp.seantburke.com/sitemap.xml';
+      sitemapper.getSites(url, function (err, sites) {
+        sites.should.be.Array;
+        (0, _isUrl2['default'])(sites[0]).should.be['true'];
+        done();
+      });
+    });
+  });
 });//# sourceMappingURL=test.map

package.json

 {
   "name": "sitemapper",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Parser for XML Sitemaps to be used with Robots.txt and web crawlers",
@@ -35,2 +35,3 @@ "keywords": [
     "build": "npm run clean && broccoli build lib",
+    "preinstall": "rm -rf node_modules",
     "postinstall": "npm run build",
@@ -78,3 +79,2 @@ "prestart": "npm run build",
   "dependencies": {
-    "deprecate": "^0.1.0",
     "es6-promise": "^3.2.1",
@@ -81,0 +81,0 @@ "request-promise": "^4.1.0",

README.md

@@ -1,2 +0,2 @@
-## Sitemap-parser 
+## Sitemap-parser
 [![Build Status](https://travis-ci.org/hawaiianchimp/sitemapper.svg?branch=master)](https://travis-ci.org/hawaiianchimp/sitemapper) [![Monthly Downloads](https://img.shields.io/npm/dm/sitemapper.svg)](https://www.npmjs.com/package/sitemapper)
@@ -7,8 +7,26 @@ [![npm version](https://badge.fury.io/js/sitemapper.svg)](https://badge.fury.io/js/sitemapper)
 
-Parse through sitemaps to get all the urls for your crawler.
+Parse through a sitemaps xml to get all the urls for your crawler.
+##Version 2
 
-#### Simple Implementation in ES5
+### Installation
+```bash
+npm install sitemapper --save
+```
+
+### Simple Example
 ```javascript
 var Sitemapper = require('sitemapper');
 
+var sitemap = new Sitemapper();
+
+sitemap.fetch('http://wp.seantburke.com/sitemap.xml').then(function(sites) {
+  console.log(sites);
+});
+
+```
+
+### Examples in ES5
+```javascript
+var Sitemapper = require('sitemapper');
+
 var Google = new Sitemapper({
@@ -32,2 +50,3 @@ url: 'https://www.google.com/work/sitemap.xml',
 var sitemap = new Sitemapper();
+
 sitemapper.timeout = 5000;
@@ -44,4 +63,4 @@ sitemapper.fetch('http://wp.seantburke.com/sitemap.xml')
 
-#### Simple Implementation in ES6
-```
+### Examples in ES6
+```javascript
 import Sitemapper from 'sitemapper';
@@ -68,3 +87,22 @@
   .catch(error => console.log(error));
+```
 
+##Version 1
+
+```bash
+npm install sitemapper@1.1.1 --save
+```
+
+###Simple Example
+
+```javascript
+var Sitemapper = require('sitemapper');
+
+var sitemapper = new Sitemapper();
+
+sitemapper.getSites('http://wp.seantburke.com/sitemap.xml', function(err, sites) {
+    if (!err) {
+     console.log(sites);
+    }
+});
 ```

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

Install scripts

Supply chain risk

Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts.

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

39819

increased by6.78%

Dependency count

3

decreased by-25%

Lines of code

445

increased by6.97%

Number of lines in readme file

104

increased by57.58%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Number of high supply chain risk alerts

2

increased by100%

Dependency changes

• - Removeddeprecate@^0.1.0

• - Removeddeprecate@0.1.0(transitive)