Add support for combining --image and --circular

README.md

@@ -127,6 +127,18 @@ madge('path/to/app.js').then((res) => {
 });
 ```
 
+#### .circularGraph()
+
+> Returns an `Object` with only circular dependencies.
+
+```javascript
+const madge = require('madge');
+
+madge('path/to/app.js').then((res) => {
+ console.log(res.circularGraph());
+});
+```
+
 #### .depends()
 
 > Returns an `Array` of all modules that depend on a given module.
@@ -177,9 +189,9 @@ madge('path/to/app.js')
  });
 ```
 
-#### .image(imagePath: string)
+#### .image(imagePath: string, [circularOnly: boolean])
 
-> Write the graph as an image to the given image path. The [image format](http://www.graphviz.org/content/output-formats) to use is determined from the file extension. Returns a `Promise` resolved with a full path to the written image.
+> Write the graph as an image to the given image path. Set `circularOnly` to only include circular dependencies. The [image format](http://www.graphviz.org/content/output-formats) to use is determined from the file extension. Returns a `Promise` resolved with a full path to the written image.
 
 ```javascript
 const madge = require('madge');
@@ -334,6 +346,12 @@ madge --exclude '^(foo|bar)\.js$' path/src/app.js
 madge --image graph.svg path/src/app.js
 ```
 
+> Save graph with only circular dependencies
+
+```sh
+madge --circular --image graph.svg path/src/app.js
+```
+
 > Save graph as a [DOT](http://en.wikipedia.org/wiki/DOT_language) file for further processing (requires [Graphviz](#graphviz-optional))
 
 ```sh

bin/cli.js

@@ -241,6 +241,13 @@ function createOutputFromOptions(program, res) {
  return res;
  }
 
+ if (program.image) {
+ return res.image(program.image, program.circular).then((imagePath) => {
+ spinner.succeed(`${chalk.bold('Image created at')} ${chalk.cyan.bold(imagePath)}`);
+ return res;
+ });
+ }
+
  if (program.circular) {
  const circular = res.circular();
 
@@ -255,13 +262,6 @@ function createOutputFromOptions(program, res) {
  return res;
  }
 
- if (program.image) {
- return res.image(program.image).then((imagePath) => {
- spinner.succeed(`${chalk.bold('Image created at')} ${chalk.cyan.bold(imagePath)}`);
- return res;
- });
- }
-
  if (program.dot) {
  return res.dot().then((output) => {
  process.stdout.write(output);

lib/api.js

@@ -87,12 +87,28 @@ class Madge {
  /**
  * Return the modules that has circular dependencies.
  * @api public
- * @return {Object}
+ * @return {Array}
  */
  circular() {
  return cyclic(this.tree);
  }
 
+ /**
+ * Return circular dependency graph.
+ * @api public
+ * @return {Object}
+ */
+ circularGraph() {
+ const circularDeps = this.circular();
+
+ return Object.entries(this.obj())
+ .filter(([k]) => circularDeps.some((x) => x.includes(k)))
+ .reduce((acc, [k, v]) => {
+ acc[k] = v.filter((x) => circularDeps.some((y) => y.includes(x)));
+ return acc;
+ }, {});
+ }
+
  /**
  * Return a list of modules that depends on the given module.
  * @api public
@@ -152,14 +168,20 @@ class Madge {
  * Write dependency graph to image.
  * @api public
  * @param {String} imagePath
+ * @param {Boolean} circularOnly
  * @return {Promise}
  */
- image(imagePath) {
+ image(imagePath, circularOnly) {
  if (!imagePath) {
  return Promise.reject(new Error('imagePath not provided'));
  }
 
- return graph.image(this.obj(), this.circular(), imagePath, this.config);
+ return graph.image(
+ circularOnly ? this.circularGraph() : this.obj(),
+ this.circular(),
+ imagePath,
+ this.config
+ );
  }
 
  /**

test/api.js

@@ -190,6 +190,29 @@ describe('API', () => {
  });
  });
 
+ describe('circular()', () => {
+ it('returns list of circular dependencies', (done) => {
+ madge(__dirname + '/cjs/circular/a.js').then((res) => {
+ res.circular().should.eql([
+ ['a.js', 'd.js']
+ ]);
+ done();
+ }).catch(done);
+ });
+ });
+
+ describe('circularGraph()', () => {
+ it('returns graph with only circular dependencies', (done) => {
+ madge(__dirname + '/cjs/circular/a.js').then((res) => {
+ res.circularGraph().should.eql({
+ 'a.js': ['d.js'],
+ 'd.js': ['a.js']
+ });
+ done();
+ }).catch(done);
+ });
+ });
+
  describe('warnings()', () => {
  it('returns an array of skipped files', (done) => {
  madge(__dirname + '/cjs/missing.js').then((res) => {