mathjs/tools/validate.js

/**
 * Validate whether all functions in math.js are documented in math.expression.docs
 * we use the minified bundle to also check whether that bundle is valid.
 */
const gutil = require('gulp-util')
const math = require('../dist/math.min.js')
let prop

// names to ignore
const ignore = [
  // functions not supported or relevant for the parser:
  'create', 'typed', 'config',
  'on', 'off', 'emit', 'once',
  'compile', 'parse', 'parser',
  'chain', 'print', 'uninitialized',
  'eye', 'var', 'eval', 'typeof', // deprecated functions
  'addScalar', 'divideScalar', 'multiplyScalar', 'equalScalar'
]

// test whether all functions are documented
let undocumentedCount = 0
for (prop in math) {
  if (math.hasOwnProperty(prop)) {
    const 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
let nonExistingCount = 0
const 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.')
}