mathjs/tools/validate.js

/**
 * Validate whether all functions in math.js are documented in math.expression.docs
 */
var gutil = require('gulp-util'),
    math = require('../index'),
    prop;

// names to ignore
var ignore = [
  // functions not supported by the parser:
  'compile', 'parse', 'parser', 'chain', 'print', 'config', 'in', 'create',
  // private functions:
  '_divide',
  // deprecated functions:
  'workspace', 'unary', 'edivide', 'emultiply', 'epow', 'smallereq', 'largereq', 'ifElse', 'select'
];

// test whether all functions are documented
var undocumentedCount = 0;
for (prop in math) {
  if (math.hasOwnProperty(prop)) {
    var obj = math[prop];
    if (math['typeof'](obj) != 'object') {
      if (!math.expression.docs[prop] && (ignore.indexOf(prop) == -1)) {
        gutil.log('WARNING: Function ' + prop + ' is undocumented');
        undocumentedCount++;
      }
    }
  }
}

// test whether there is documentation for non existing functions
var nonExistingCount = 0;
var docs = math.expression.docs;
for (prop in docs) {
  if (docs.hasOwnProperty(prop)) {
    if (math[prop] === undefined && !math.type[prop]) {
      gutil.log('WARNING: Documentation for a non-existing function "' + prop + '"');
      nonExistingCount++;
    }
  }
}

// done. Output results
if (undocumentedCount == 0 && nonExistingCount == 0) {
  gutil.log('Validation successful: all functions are documented.');
}
else {
  gutil.log('Validation failed: not all functions are documented.');
}