Merge pull request #171 from lleaff/master

Add an .svg public method to the API

README.md

@@ -179,6 +179,20 @@ madge('path/to/app.js')
 	});
 ```
 
+#### .svg()
+
+> Return a `Promise` resolved with the XML SVG representation of the dependency graph as a `Buffer`.
+
+```javascript
+const madge = require('madge');
+
+madge('path/to/app.js')
+	.then((res) => res.svg())
+	.then((output) => {
+		console.log(output.toString());
+	});
+```
+
 # Configuration
 
 Property | Type | Default | Description

lib/api.js

@@ -151,6 +151,15 @@ class Madge {
 
 		return graph.image(this.obj(), this.circular(), imagePath, this.config);
 	}
+
+	/**
+	 * Return Buffer with XML SVG representation of the dependency graph.
+	 * @api public
+	 * @return {Promise}
+	 */
+	svg() {
+		return graph.svg(this.obj(), this.circular(), this.config);
+	}
 }
 
 /**

lib/graph.js

@@ -46,16 +46,19 @@ function createGraphvizOptions(config) {
 	const graphVizOptions = config.graphVizOptions || {};
 
 	return {
+		// Graph
 		G: Object.assign({
 			overlap: false,
 			pad: 0.3,
 			rankdir: config.rankdir,
 			layout: config.layout,
 			bgcolor: config.backgroundColor
 		}, graphVizOptions.G),
+		// Edge
 		E: Object.assign({
 			color: config.edgeColor
 		}, graphVizOptions.E),
+		// Node
 		N: Object.assign({
 			fontname: config.fontName,
 			fontsize: config.fontSize,
@@ -112,6 +115,24 @@ function createGraph(modules, circular, config, options) {
 	});
 }
 
+/**
+ * Return the module dependency graph XML SVG representation as a Buffer.
+ * @param  {Object} modules
+ * @param  {Array} circular
+ * @param  {Object} config
+ * @return {Promise}
+ */
+module.exports.svg = function (modules, circular, config) {
+	const options = createGraphvizOptions(config);
+
+	options.type = 'svg';
+
+	return checkGraphvizInstalled(config)
+		.then(() => {
+			return createGraph(modules, circular, config, options);
+		});
+};
+
 /**
  * Creates an image from the module dependency graph.
  * @param  {Object} modules

test/api.js

@@ -216,6 +216,19 @@ describe('API', () => {
 		});
 	});
 
+	describe('svg()', () => {
+		it('returns a promise resolved with XML SVG output in a Buffer', (done) => {
+			madge(__dirname + '/cjs/b.js')
+				.then((res) => res.svg())
+				.then((output) => {
+					output.should.instanceof(Buffer);
+					output.toString().should.match(/<svg.*/);
+					done();
+				})
+				.catch(done);
+		});
+	});
+
 	describe('image()', () => {
 		let imagePath;