Release 1.1.0

* Generate Sitemap Index and Splitting into multiple sitemaps (#51)
* Update documentation

Author: kuflash

.gitignore

@@ -2,5 +2,6 @@
 .DS_Store
 /node_modules
 sitemap.xml
+sitemap*.xml
 index.es5.js
 npm-debug.log

api.md

@@ -97,14 +97,34 @@ Convert array of paths to sitemap.
 **Parameters**
 
 -   `hostname` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The root name of your site.
+-   `$1` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
+    -   `$1.limitCountPaths`   (optional, default `49999`)
 
 ## save
 
-Save the sitemap to a file.
+Save sitemaps and sitemap index in files.
 
 **Parameters**
 
--   `dist` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The path and file name where the sitemap is saved.
+-   `dist` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The path and file name where the sitemap index is saved.
+-   `publicPath` **\[[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)](default '/')** optional public path relative to hostname, default: '/'
+
+# pathsSplitter
+
+Module for splitting paths array in multiple arrays for support of large projects
+
+**Parameters**
+
+-   `paths` **\[[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)]** Initial paths array (flattened) (optional, default `[]`)
+-   `size` **\[[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]**  (optional, default `49999`)
+
+**Examples**
+
+```javascript
+import { pathsSplitter } from 'react-router-sitemap';
+
+const splitted = pathsSplitter(paths, 49999); // 49999 because of Google sitemap limits
+```
 
 # paramsApplier
 

example/sitemap-builder.js

@@ -1,7 +1,7 @@
 require('babel-register');
 
 const router = require('./router').default;
-const Sitemap = require('../').default;
+const Sitemap = require('../lib').default;
 
 const filterConfig = {
 	isValid: false,
@@ -11,23 +11,48 @@ const filterConfig = {
 	],
 };
 
+
+// Setup some random projects
+const alphabet = 'abcdefghijklmnopqrstuvwxyz'.split('');
+const lotOfNames = [];
+
+function produceItem(arr, char) {
+	return arr.map(c => { lotOfNames.push(`${c}-${char}`); });
+}
+
+alphabet.map(c => produceItem(alphabet, c));
+
+const projects = {
+	projectName: lotOfNames,
+	achievement: lotOfNames
+};
+
+
 const paramsConfig = {
 	'/projects/:projectName': [
 		{ projectName: 'hello-world' },
 		{ projectName: 'second-project' },
 		{ projectName: ['third-project', 'fourth-project'] },
+		projects
 	],
 	'/projects/:projectName/view': [
 		{ projectName: 'hello-world' },
 		{ projectName: 'second-project' },
 		{ projectName: ['third-project', 'fourth-project'] },
+		projects
 	],
+	'/projects/:projectName/achievements/:achievement': [
+		{ projectName: 'hello-world' },
+		{ projectName: 'second-project' },
+		{ projectName: ['third-project', 'fourth-project'] },
+		projects
+	]
 };
 
 (
 	new Sitemap(router)
 		.filterPaths(filterConfig)
 		.applyParams(paramsConfig)
-		.build('http://my-site.ru')
-		.save('./sitemap.xml')
+		.build('http://my-site.ru', { limitCountPaths: 5000 })
+		.save('./sitemap.xml', '/static/')
 );

lib/index.js

@@ -1,13 +1,18 @@
 import fs from 'fs';
+import path from 'path';
+
+import sm from 'sitemap';
 import { createRoutes } from 'react-router';
+
 import parseRoutes from './routes-parser';
 import filterPaths from './paths-filter';
 import applyParams from './params-applier';
+import splitPaths from './paths-splitter';
 import buildSitemap from './sitemap-builder';
 
 /**
  * @class Sitemap
- * @description Generate sitemap by [React Router](https://www.npmjs.com/package/react-router) configuration.
+ * @description Generate a sitemap using the [React Router](https://www.npmjs.com/package/react-router) configuration.
  *
  * @example
  * import Sitemap from 'react-router-sitemap';
@@ -22,7 +27,7 @@ class Sitemap {
 
 	/**
 	 * @constructor
-	 * @description Convert React Router config to array of paths.
+	 * @description Convert a React Router config to an array of paths.
 	 * @param {Route} router - React Router configuration.
 	 *
 	 * @example
@@ -46,7 +51,7 @@ class Sitemap {
 	}
 
 	/**
-	 * @description Filters path on the specified rules.
+	 * @description Filter paths using the specified rules.
 	 * @param {Object} filterConfig - Filter configuration
 	 * @property {Array<RegExp>} rules - List filter rules.
 	 * @property {Boolean} isValid - Flag that defines a way to filter paths.
@@ -74,20 +79,20 @@ class Sitemap {
 	}
 
 	/**
-	 * @description Replaces the dynamic parameters in paths the passed value.
-	 * @param {Object.<String, Array>} paramsConfig - Configuration for replace params.
+	 * @description Replace the dynamic parameters in paths using the given values.
+	 * @param {Object.<String, Array>} paramsConfig - Configuration for replacing params.
 	 *
 	 * @example
-	 * <caption>Config for replace params `:param` in path `/path/:param`</caption>
+	 * <caption>Config for replacing params `:param` in the path `/path/:param`</caption>
 	 * {
 	 *   '/path/:param': [
 	 *     { param: 'value' }
 	 *   ]
 	 * }
 	 *
 	 * @example
-	 * <caption>Config for replace params `:param` and `:subparam`
-	 * in path `/path/:param/:subparam`</caption>
+	 * <caption>Config for replacing params `:param` and `:subparam`
+	 * in the path `/path/:param/:subparam`</caption>
 	 * {
 	 *   '/path/:param/:subparam': [
 	 *     { param: 'value', subparam: ['subvalue1', 'subvalue2'] }
@@ -104,17 +109,40 @@ class Sitemap {
 	 * @description Convert array of paths to sitemap.
 	 * @param {String} hostname - The root name of your site.
 	 */
-	build(hostname) {
-		this.sitemap = buildSitemap(hostname, this.paths);
+	build(hostname, { limitCountPaths = 49999 }) {
+		this.hostname = hostname;
+		this.splitted = splitPaths(this.paths, limitCountPaths);
+		this.sitemaps = this.splitted.map(paths => buildSitemap(hostname, paths));
 		return this;
 	}
 
 	/**
-	 * @description Save sitemap in file.
-	 * @param {String} dist - The path and file name where the sitemap is saved.
+	 * @description Save sitemaps and sitemap index in files.
+	 * @param {String} dist - The path and file name where the sitemap index is saved.
+	 * @param {String} publicPath - optional public path relative to hostname, default: '/'
 	 */
-	save(dist) {
-		fs.writeFileSync(dist, this.sitemap.toString());
+	save(dist, publicPath = '/') {
+		const sitemapPaths = [];
+
+		this.sitemaps.map((sitemap, index) => {
+			const savePath = dist.replace('.xml', `-${index}.xml`);
+
+			// write sitemap
+			fs.writeFileSync(savePath, sitemap.toString());
+
+			// push public path for indexing
+			sitemapPaths.push(this.hostname + publicPath + path.basename(savePath));
+		});
+
+		// create index string
+		const sitemapIndex = sm.buildSitemapIndex({
+			urls: sitemapPaths,
+			hostname: this.hostname
+		});
+
+		// write sitemap index
+		fs.writeFileSync(dist, sitemapIndex);
+
 		return this;
 	}
 
@@ -126,3 +154,4 @@ export { default as routesParser } from './routes-parser';
 export { default as pathsFilter } from './paths-filter';
 export { default as paramsApplier } from './params-applier';
 export { default as sitemapBuilder } from './sitemap-builder';
+export { default as pathsSplitter } from './paths-splitter';

lib/params-applier/index.js

@@ -5,7 +5,7 @@ const hasRules = (path = '', paramsConfig = {}) => {
 };
 
 /**
- * Module for apply params in dynamic paths.
+ * Module for applying params in dynamic paths.
  * @module paramsApplier
  * @param {Array<String>} [paths] Array of paths
  * @param {Object<String, Array>} [paramsConfig] Configuration matching parameters and values

lib/paths-filter/index.js

@@ -1,7 +1,7 @@
 import prepareParams from './params-preparer';
 
 /**
- * Module for filter array of paths.
+ * Module for filtering an array of paths.
  * @function pathsFilter
  * @param {Array<String>} [paths] Array of paths
  * @param {Array<RegExp>} [rules] Filter rules

lib/paths-splitter/index.js

@@ -0,0 +1,18 @@
+/**
+ * Module for splitting paths array in multiple arrays for support of large projects
+ * @module pathsSplitter
+ * @param {Array} [paths = []] Initial paths array (flattened)
+ * @param {Number} [size = 49999]
+ * @return {Array Array<String>} Array of Array of paths
+ *
+ * @example
+ * import { pathsSplitter } from 'react-router-sitemap';
+ *
+ * const splitted = pathsSplitter(paths, 49999); // 49999 because of Google sitemap limits
+ */
+
+const pathsSplitter = (paths, size) => paths.map((path, i) => {
+	return (i % size === 0) ? paths.slice(i, i + size) : null;
+}).filter(e => e);
+
+export default pathsSplitter;

lib/routes-parser/index.js

@@ -1,7 +1,7 @@
 import buildPath from './path-builder';
 
 /**
- * Module for parsing result of execute function `createRoutes(<Route>)`
+ * Module for parsing the result of the `createRoutes(<Route>)` function.
  * from [react-router](https://www.npmjs.com/package/react-router) package.
  * @module routesParser
  * @param {Array|Object} [routes = []] Result of execute function

lib/sitemap-builder/index.js

@@ -1,11 +1,11 @@
 import sitemap from 'sitemap';
 
 /**
- * Module for build sitemap by array of paths. Using [sitemap](https://www.npmjs.com/package/sitemap) package.
+ * Module for building a sitemap using an array of paths. Uses the [sitemap](https://www.npmjs.com/package/sitemap) package.
  * @module sitemapBuilder
  * @param {String} [hostname] The root name of your site
  * @param {Array<String>} [paths] Array of paths
- * @return {Sitemap} Instance of [Sitemap](https://www.npmjs.com/package/sitemap).
+ * @return {Sitemap} instance of [Sitemap](https://www.npmjs.com/package/sitemap).
  *
  * @example
  * import { sitemapBuilder as buildSitemap } from 'react-router-sitemap';

package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-router-sitemap",
-  "version": "1.0.8",
+  "version": "1.1.0",
   "description": "Module to generate a sitemap for react-router configuration",
   "repository": {
     "type": "git",