elm-review/lib/min-version.js

Run elm-review from Node.js

/**
 * @import {Options} from './types/options';
 * @import {Path} from './types/path';
 * @import {VersionString} from './types/version';
 */
const path = require('node:path');
const chalk = require('chalk');
const ErrorMessage = require('./error-message');
const PathHelpers = require('./path-helpers');

const minimalVersion = /** @type {const} */ ({major: 2, minor: 15});

// TS can't do arithmetic, so make sure the cast is right when bumping the major.
const nextMajor = /** @type {3} */ (minimalVersion.major + 1);

const supportedRange = /** @type {const} */ (
  `${minimalVersion.major}.${minimalVersion.minor}.0 <= v < ${nextMajor}.0.0`
);

/**
 * If given an input version string smaller than the hardcoded `minimalVersion`,
 * it will return the minimal version.
 * Otherwise, the input version string is returned.
 *
 * @param {VersionString} version - input version string, e.g. "1.0"
 * @returns {VersionString}
 */
function updateToAtLeastMinimalVersion(version) {
  const [major, minor] = version.split('.');

  if (Number.parseInt(major, 10) !== minimalVersion.major) {
    // Major version for which the configuration exists is not compatible
    // We'll return the version, and let following checks handle the problem
    return version;
  }

  if (Number.parseInt(minor, 10) >= minimalVersion.minor) {
    // User uses a more recent version of `jfmengels/elm-review`
    return version;
  }

  // User uses a less recent version of `jfmengels/elm-review`
  // And let's hope the patch version of the package is not buggy...
  return `${minimalVersion.major}.${minimalVersion.minor}.0`;
}

/**
 * Throws an error if the passed elm-review version is not compatible with this runner.
 *
 * @param {Options} options
 * @param {Path} elmJsonPath - path to an elm.json file
 * @param {VersionString} version - version string, e.g. "1.0"
 * @returns {void}
 */
function validate(options, elmJsonPath, version) {
  const [major, minor] = version.split('.');

  if (
    Number.parseInt(major, 10) === minimalVersion.major &&
    Number.parseInt(minor, 10) >= minimalVersion.minor
  ) {
    // Configuration uses a compatible version of `elm-review`
    return;
  }

  if (options.template) {
    throw new ErrorMessage.CustomError(
      // prettier-ignore
      'UNSUPPORTED ELM-REVIEW VERSION',
      // prettier-ignore
      `The template uses an unsupported version of the ${chalk.greenBright('jfmengels/elm-review')} Elm package. It is using version ${version}, but I need it to be ${supportedRange}.

Please inform the template author and kindly ask them to update their configuration, or make a pull request to help them out.`
    );
  }

  const dirPath = PathHelpers.format(path.dirname(elmJsonPath));

  throw new ErrorMessage.CustomError(
    // prettier-ignore
    'UNSUPPORTED ELM-REVIEW VERSION',
    // prettier-ignore
    `You are using an unsupported version of the ${chalk.greenBright('jfmengels/elm-review')} Elm package.
You are using version ${chalk.red(version)}, but I need it to be ${chalk.greenBright(supportedRange)}.

Please upgrade your version by running the following commands:
${chalk.magenta(`
cd ${dirPath}
npx elm-json install jfmengels/elm-review@${minimalVersion.major}
`)}
If that doesn't work, try out:
${chalk.magenta(`
cd ${dirPath}
npx elm-json upgrade --unsafe`)}`
  );
}

module.exports = {
  updateToAtLeastMinimalVersion,
  validate,
  minimalVersion,
  supportedRange
};