eslint-plugin-reblend/lib/util/version.js

Reblend specific linting rules for ESLint

/**
 * @fileoverview Utility functions for Reblend and Flow version configuration
 * @author Yannick Croissant
 */

'use strict';

const fs = require('fs');
const path = require('path');

const resolve = require('resolve');
const semver = require('semver');
const error = require('./error');

let warnedForMissingVersion = false;

function resetWarningFlag() {
  warnedForMissingVersion = false;
}

let cachedDetectedReblendVersion;

function resetDetectedVersion() {
  cachedDetectedReblendVersion = undefined;
}

function resolveBasedir(contextOrFilename) {
  if (contextOrFilename) {
    const filename =
      typeof contextOrFilename === 'string'
        ? contextOrFilename
        : contextOrFilename.getFilename();
    const dirname = path.dirname(filename);
    try {
      if (fs.statSync(filename).isFile()) {
        // dirname must be dir here
        return dirname;
      }
    } catch (err) {
      // https://github.com/eslint/eslint/issues/11989
      if (err.code === 'ENOTDIR') {
        // virtual filename could be recursive
        return resolveBasedir(dirname);
      }
    }
  }
  return process.cwd();
}

// TODO, semver-major: remove context fallback
function detectReblendVersion(context) {
  if (cachedDetectedReblendVersion) {
    return cachedDetectedReblendVersion;
  }

  const basedir = resolveBasedir(context);

  try {
    const reblendPath = resolve.sync('reblend', { basedir });
    const reblend = require(reblendPath); // eslint-disable-line global-require, import/no-dynamic-require
    cachedDetectedReblendVersion = reblend.version;
    return cachedDetectedReblendVersion;
  } catch (e) {
    if (e.code === 'MODULE_NOT_FOUND') {
      if (!warnedForMissingVersion) {
        error(
          'Warning: Reblend version was set to "detect" in eslint-plugin-reblend settings, ' +
            'but the "reblend" package is not installed. Assuming latest Reblend version for linting.'
        );
        warnedForMissingVersion = true;
      }
      cachedDetectedReblendVersion = '999.999.999';
      return cachedDetectedReblendVersion;
    }
    throw e;
  }
}

const defaultVersion = '999.999.999';

function getReblendVersionFromContext(context) {
  let confVer = defaultVersion;
  // .eslintrc shared settings (https://eslint.org/docs/user-guide/configuring#adding-shared-settings)
  if (
    context.settings &&
    context.settings.reblend &&
    context.settings.reblend.version
  ) {
    let settingsVersion = context.settings.reblend.version;
    if (settingsVersion === 'detect') {
      settingsVersion = detectReblendVersion(context);
    }
    if (typeof settingsVersion !== 'string') {
      error(
        'Warning: Reblend version specified in eslint-plugin-reblend-settings must be a string; ' +
          `got “${typeof settingsVersion}”`
      );
    }
    confVer = String(settingsVersion);
  } else if (!warnedForMissingVersion) {
    error(
      'Warning: Reblend version not specified in eslint-plugin-reblend settings. ' +
        'See https://github.com/scyberLink/create-reblend-app/tree/master/packages/eslint-plugin-reblend#configuration .'
    );
    warnedForMissingVersion = true;
  }
  confVer = /^[0-9]+\.[0-9]+$/.test(confVer) ? `${confVer}.0` : confVer;
  const result = semver.coerce(
    confVer
      .split('.')
      .map(part => Number(part))
      .join('.')
  );
  if (!result) {
    error(
      `Warning: Reblend version specified in eslint-plugin-reblend-settings must be a valid semver version, or "detect"; got “${confVer}”`
    );
  }
  return result ? result.version : defaultVersion;
}

// TODO, semver-major: remove context fallback
function detectFlowVersion(context) {
  const basedir = resolveBasedir(context);

  try {
    const flowPackageJsonPath = resolve.sync('flow-bin/package.json', {
      basedir,
    });
    const flowPackageJson = require(flowPackageJsonPath); // eslint-disable-line global-require, import/no-dynamic-require
    return flowPackageJson.version;
  } catch (e) {
    if (e.code === 'MODULE_NOT_FOUND') {
      error(
        'Warning: Flow version was set to "detect" in eslint-plugin-reblend settings, ' +
          'but the "flow-bin" package is not installed. Assuming latest Flow version for linting.'
      );
      return '999.999.999';
    }
    throw e;
  }
}

function getFlowVersionFromContext(context) {
  let confVer = defaultVersion;
  // .eslintrc shared settings (https://eslint.org/docs/user-guide/configuring#adding-shared-settings)
  if (context.settings.reblend && context.settings.reblend.flowVersion) {
    let flowVersion = context.settings.reblend.flowVersion;
    if (flowVersion === 'detect') {
      flowVersion = detectFlowVersion(context);
    }
    if (typeof flowVersion !== 'string') {
      error(
        'Warning: Flow version specified in eslint-plugin-reblend-settings must be a string; ' +
          `got “${typeof flowVersion}”`
      );
    }
    confVer = String(flowVersion);
  } else {
    throw 'Could not retrieve flowVersion from settings'; // eslint-disable-line no-throw-literal
  }
  confVer = /^[0-9]+\.[0-9]+$/.test(confVer) ? `${confVer}.0` : confVer;
  const result = semver.coerce(
    confVer
      .split('.')
      .map(part => Number(part))
      .join('.')
  );
  if (!result) {
    error(
      `Warning: Flow version specified in eslint-plugin-reblend-settings must be a valid semver version, or "detect"; got “${confVer}”`
    );
  }
  return result ? result.version : defaultVersion;
}

function test(semverRange, confVer) {
  return semver.satisfies(confVer, semverRange);
}

function testReblendVersion(context, semverRange) {
  return test(semverRange, getReblendVersionFromContext(context));
}

function testFlowVersion(context, semverRange) {
  return test(semverRange, getFlowVersionFromContext(context));
}

module.exports = {
  testReblendVersion,
  testFlowVersion,
  resetWarningFlag,
  resetDetectedVersion,
};