Merge pull request #4 from zerodevx/feature/add-save

Add new feature --save directly to <root>/sitemap.xml

Author: zerodevx

README.md

@@ -53,8 +53,9 @@ so that you can pipe it to do other cool stuff. CLI also allows you to pipe in B
 | -p     | --priority   | glob-priority pair (eg: foo/*.html=0.1)                         |
 | -f     | --changefreq | glob-changefreq pair (eg: foo/*.html=daily)                     |
 | -n     | --no-clean   | disable clean URLs                                              |
-| -s     | --slash      | add trailing slash to all URLs                                  |
+| -l     | --slash      | add trailing slash to all URLs                                  |
 | -t     | --text       | output as .TXT instead                                          |
+| -s     | --save       | save output directly to file `<root>/sitemap.xml`               |
 | -v     | --verbose    | be more verbose                                                 |
 
 
@@ -154,6 +155,10 @@ Run `npm run test`.
 
 ## Changelog
 
+**v1.1.0** - 2019-08-18:
+* **BREAKING**: Trailing slash alias `-s` renamed to `-l`. Sorry. :cry:
+* Add feature save directly to file `<rootDir>/sitemap.xml` instead of `stdout`.
+
 **v1.0.1** - 2019-08-16:
 * Bugfix - empty line at EOF in text mode.
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "static-sitemap-cli",
   "description": "Simple CLI to pre-generate XML sitemaps for static sites locally.",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "author": "Jason Lee <[email protected]>",
   "bin": {
     "static-sitemap-cli": "./bin/run",
@@ -10,8 +10,8 @@
   "bugs": "https://github.com/zerodevx/static-sitemap-cli/issues",
   "dependencies": {
     "@oclif/command": "^1.5.18",
-    "@oclif/config": "^1.13.2",
-    "@oclif/plugin-help": "^2.2.0",
+    "@oclif/config": "^1.13.3",
+    "@oclif/plugin-help": "^2.2.1",
     "fast-glob": "^3.0.4",
     "get-stdin": "^7.0.0",
     "js2xmlparser": "^4.0.0",

src/index.js

@@ -3,6 +3,7 @@ const getStdin = require('get-stdin');
 const fg = require('fast-glob');
 const mm = require('micromatch');
 const parser = require('js2xmlparser');
+const fs = require('fs');
 
 class StaticSitemapCliCommand extends Command {
 
@@ -94,7 +95,11 @@ class StaticSitemapCliCommand extends Command {
         doubleQuotes: true
       }
     });
-    this.log(sitemap);
+    if (flags.save) {
+      fs.writeFileSync(`${addSlash(flags.root)}sitemap.xml`, `${sitemap}\n`, 'utf-8');
+    } else {
+      this.log(sitemap);
+    }
 
   }
 }
@@ -118,8 +123,8 @@ StaticSitemapCliCommand.flags = {
   help: flags.help({char: 'h'}),
   root: flags.string({
     char: 'r',
-    description: '[default: current] root working directory',
-    default: '',
+    description: 'root working directory',
+    default: '.',
   }),
   match: flags.string({
     char: 'm',
@@ -143,7 +148,7 @@ StaticSitemapCliCommand.flags = {
     default: false,
   }),
   slash: flags.boolean({
-    char: 's',
+    char: 'l',
     description: 'add trailing slash to all URLs',
     default: false,
     exclusive: ['no-clean'],
@@ -154,6 +159,12 @@ StaticSitemapCliCommand.flags = {
     default: false,
     exclusive: ['priority', 'changefreq'],
   }),
+  save: flags.boolean({
+    char: 's',
+    description: 'save output directly to file <root>/sitemap.xml',
+    default: false,
+    exclusive: ['text'],
+  }),
   verbose: flags.boolean({
     char: 'v',
     description: 'be more verbose',

test/index.test.js

@@ -1,5 +1,6 @@
 const {expect, test} = require('@oclif/test');
 const cmd = require('../src');
+const fs = require('fs');
 
 describe('#index', () => {
 
@@ -58,6 +59,14 @@ describe('#index', () => {
       expect(ctx.stdout).to.contain('https://example.com/blog/mixed-1/</loc>');
     });
 
+  test
+    .do(() => cmd.run(['https://example.com', '--root', 'test/test-site/about', '--save']))
+    .it('saves to sitemap.xml', () => {
+      let out = fs.readFileSync('test/test-site/about/sitemap.xml', 'utf-8');
+      expect(out).to.contain('<loc>https://example.com</loc>');
+      fs.unlinkSync('test/test-site/about/sitemap.xml');
+    });
+
 
   /*
   test