jshint-solid/src/jshint-solid.js

Tells how solid your jshint settings are

var read = require('fs').readFileSync;
var exists = require('fs').existsSync;
var join = require('path').join;
var verify = require('check-types').verify;
var removeComments = require('strip-json-comments');

function getAllSettings() {
  var filename = join(__dirname, 'allJsHintSettings.js');
  var allSettingsSrc = read(filename, 'utf-8');
  var withoutComments = removeComments(allSettingsSrc);
  verify.unemptyString(withoutComments, 'expected string without comments');
  var allSettings = JSON.parse(withoutComments);
  return allSettings;
}

// returns percent 0 - no valid settings, 100 - all settings specified
function settingsPercentage(projectJshintSettings) {
  verify.object(projectJshintSettings, 'expected jshint object');

  //console.log('looking at jshint settings\n' +
  //  JSON.stringify(projectJshintSettings, null, 2));

  var allSettings = getAllSettings();
  verify.object(allSettings, 'could not get all jshint settings');
  var totalSettings = Object.keys(allSettings).length;
  verify.positiveNumber(totalSettings, 'epected all settings to have properties');

  Object.keys(projectJshintSettings).forEach(function (key) {
    if (key === 'predef') { return; }

    if (typeof allSettings[key] === 'undefined') {
      console.error('unknown setting', key, projectJshintSettings[key]);
    }
  });

  var specifiedSettings = Object.keys(projectJshintSettings).length;

  return +(specifiedSettings / totalSettings * 100).toPrecision(2);
}

function printMessage(quality, filename) {
  console.assert(quality >= 0 && quality <= 100, 'invalid quality value ' + quality);

  filename = filename || '';
  console.log('jshint %s covers %d% of all possible settings',
    filename, quality);
  if (quality < 75) {
    console.log('see all possible settings at\n' +
      'https://raw.github.com/jshint/jshint/master/examples/.jshintrc');
  }
}

function jshintQuality(filename) {
  var jshintFilename = filename || './.jshintrc';
  if (!exists(jshintFilename)) {
    verify.unemptyString(jshintFilename, 'expected jshint filename');
    throw new Error('Cannot find jshint settings file ' + jshintFilename);
  }
  var settings = JSON.parse(removeComments(read(jshintFilename, 'utf8')));
  verify.object(settings, 'expected jshint settings object');

  var quality = settingsPercentage(settings);
  console.assert(quality >= 0 && quality <= 100, 'invalid quality value ' + quality);

  printMessage(quality, jshintFilename);
  return quality;
}

module.exports = jshintQuality;