gulp-sitemap - npm Package Compare versions

Comparing version 0.1.6 to 0.2.0

package.json

 {
   "name": "gulp-sitemap",
-  "version": "0.1.6",
+  "version": "0.2.0",
   "description": "Generate a search engine friendly sitemap.xml using a Gulp stream",
@@ -20,2 +20,3 @@ "license": "MIT",
   "scripts": {
+    "watchTest": "mocha -R spec --watch test/test.js",
     "test": "mocha test/test.js"
@@ -22,0 +23,0 @@ },

readme.md

@@ -33,3 +33,5 @@ # [gulp](https://github.com/wearefractal/gulp)-sitemap
         read: false
-    }).pipe(sitemap())
+    }).pipe(sitemap({
+            siteUrl: 'http://www.amazon.com'
+        }))
         .pipe(gulp.dest('build/'));
@@ -39,5 +41,5 @@ });
 
-* File content isn't necessary when reading files - so to speed up building - use the `{read:false}` on `gulp.src`.
-* index.html will be turned into directory path `/`.
-* 404.html will be skipped automatically. No need to unglob it.
+* File content isn't necessary when reading files - so to speed up building - use `{read:false}` on `gulp.src`.
+* *index.html* will be turned into directory path `/`.
+* *404.html* will be skipped automatically. No need to unglob it.
 
@@ -57,3 +59,3 @@ ## Example with all options and their defaults
         priority: '0.5',
-        siteUrl: '',
+        siteUrl: 'http://www.amazon.com',
         spacing: '    '
@@ -67,26 +69,39 @@ }))
 
+### siteUrl
+
+**required**
+
+Your website's base url. This gets prepended to all documents locations.
+
 ### fileName
 
-Determine the output filename for the sitemap. Default: `sitemap.xml`.
+Default: `sitemap.xml`
 
-### siteUrl
+Determine the output filename for the sitemap.
 
-What is your website's url. This gets prepended to all documents locations. Default: ``.
 
 ### changeFreq
 
-Gets filled inside the sitemap in the tag `<changefreq>`. Default: `daily`.
+Default: `daily`
 
+Gets filled inside the sitemap in the tag `<changefreq>`.
+
 ### priority
 
-Gets filled inside the sitemap in the tag `<priority>`. Default: `0.5`.
+Default: `0.5`
 
+Gets filled inside the sitemap in the tag `<priority>`.
+
 ### newLine
 
-How to join line in the target sitemap file. Defaults to your system OS or `\n`.
+Default: Your OS's new line, mostly: `\n`
 
+How to join line in the target sitemap file.
+
 ### spacing
 
+Default: '    '
+
 How should the sitemap xml file be spaced. You can use `\t` for tabs, or `  ` with 2
-spaces if you'd like. Default: `    ` (4 spaces).
+spaces if you'd like.
 
@@ -93,0 +108,0 @@ ## Thanks

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

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

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

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

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

111

increased by15.63%

Number of low supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

4859

decreased by-42.76%

Lines of code

0

decreased by-100%

Number of medium maintenance alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes