Merge pull request pahen#108 from pahen/warnings

Show skipped files as warnings (disable with —-no-warning)

README.md

@@ -82,6 +82,18 @@ madge('path/to/app.js').then((res) => {
 });
 ```
 
+#### .warnings()
+
+> Returns an `Object` of warnings.
+
+```javascript
+const madge = require('madge');
+
+madge('path/to/app.js').then((res) => {
+ console.log(res.warnings());
+});
+```
+
 #### .circular()
 
 > Returns an `Array` with all modules that has circular dependencies.

bin/cli.js

@@ -23,6 +23,7 @@ program
  .option('--require-config <file>', 'path to RequireJS config')
  .option('--webpack-config <file>', 'path to webpack config')
  .option('--no-color', 'disable color in output and image', false)
+ .option('--no-warning', 'disable warnings', false)
  .option('--stdin', 'read predefined tree from STDIN', false)
  .option('--debug', 'turn on debug output', false)
  .parse(process.argv);
@@ -103,15 +104,19 @@ new Promise((resolve, reject) => {
 })
 .then((res) => {
  if (program.summary) {
- return output.summary(res.obj(), {
+ output.summary(res.obj(), {
  json: program.json
  });
+
+ return res;
  }
 
  if (program.depends) {
- return output.depends(res.depends(program.depends), {
+ output.depends(res.depends(program.depends), {
  json: program.json
  });
+
+ return res;
  }
 
  if (program.circular) {
@@ -125,24 +130,33 @@ new Promise((resolve, reject) => {
  process.exit(1);
  }
 
- return;
+ return res;
  }
 
  if (program.image) {
  return res.image(program.image).then((imagePath) => {
  console.log('Image created at %s', imagePath);
+ return res;
  });
  }
 
  if (program.dot) {
  return res.dot().then((output) => {
  process.stdout.write(output);
+ return res;
  });
  }
 
- return output.list(res.obj(), {
+ output.list(res.obj(), {
  json: program.json
  });
+
+ return res;
+})
+.then((res) => {
+ if (program.warning && !program.json) {
+ output.warnings(res);
+ }
 })
 .catch((err) => {
  output.error(err);

lib/api.js

@@ -51,8 +51,9 @@ class Madge {
  path = [path];
  }
 
- return tree(path, this.config).then((tree) => {
- this.tree = tree;
+ return tree(path, this.config).then((res) => {
+ this.tree = res.tree;
+ this.skipped = res.skipped;
  return this;
  });
  }
@@ -66,6 +67,17 @@ class Madge {
  return this.tree;
  }
 
+ /**
+ * Return produced warnings.
+ * @api public
+ * @return {Array}
+ */
+ warnings() {
+ return {
+ skipped: this.skipped
+ };
+ }
+
  /**
  * Return the modules that has circular dependencies.
  * @api public

lib/output.js

@@ -105,6 +105,23 @@ module.exports.depends = function (depends, opts) {
  });
 };
 
+/**
+ * Print warnings to the console.
+ * @param {Object} res
+ * @return {undefined}
+ */
+module.exports.warnings = function (res) {
+ const skipped = res.warnings().skipped;
+
+ if (skipped.length) {
+ console.log(red.bold('\nSkipped files due to errors:\n'));
+
+ skipped.forEach((file) => {
+ console.log(red(file));
+ });
+ }
+};
+
 /**
  * Print error to the console.
  * @param {Object} err

lib/tree.js

@@ -104,6 +104,7 @@ class Tree {
  generateTree(files) {
  const depTree = {};
  const visited = {};
+ const nonExistent = [];
 
  files.forEach((file) => {
  if (visited[file]) {
@@ -117,7 +118,8 @@ class Tree {
  webpackConfig: this.config.webpackConfig,
  visited: visited,
  filter: this.filterPath.bind(this),
- detective: this.config.detectiveOptions
+ detective: this.config.detectiveOptions,
+ nonExistent: nonExistent
  }));
  });
 
@@ -127,9 +129,10 @@ class Tree {
  tree = this.exclude(tree, this.config.excludeRegExp);
  }
 
- tree = this.sort(tree);
-
- return tree;
+ return {
+ tree: this.sort(tree),
+ skipped: nonExistent
+ };
  }
 
  /**

test/api.js

@@ -113,6 +113,21 @@ describe('API', () => {
  });
  });
 
+ describe('warnings()', () => {
+ it('returns an array of skipped files', (done) => {
+ madge(__dirname + '/cjs/missing.js').then((res) => {
+ res.obj().should.eql({
+ missing: ['c'],
+ c: []
+ });
+ res.warnings().should.eql({
+ skipped: ['./path/non/existing/file']
+ });
+ done();
+ }).catch(done);
+ });
+ });
+
  describe('dot()', () => {
  it('returns a promise resolved with graphviz DOT output', (done) => {
  madge(__dirname + '/cjs/b.js')

test/cjs/missing.js

@@ -0,0 +1,2 @@
+require('./c');
+require('./path/non/existing/file');