deprecated.js

import Deprecated from 'deprecated-obj';
import { readJSON } from './util.js';
import Log from './log.js';

const deprecated = readJSON('../config/deprecated.json');

export default (config, log = new Log()) => {
  const deprecations = new Deprecated(deprecated, config);
  const compliant = deprecations.getCompliant();
  const violations = deprecations.getViolations();
  if (Object.keys(violations).length > 0) {
    log.warn(`Deprecated configuration options found. Please migrate before the next major release.`);
  }
  for (const d in violations) {
    log.warn(
      `The "${d}" option is deprecated. ${
        violations[d] ? (/^[A-Z]/.test(violations[d]) ? violations[d] : `Please use "${violations[d]}" instead.`) : ''
      }`
    );
  }
  return compliant;
};