metamask-extension/development/lib/changelog/changelog.js

const semver = require('semver');

const { orderedChangeCategories, unreleased } = require('./constants');

const changelogTitle = '# Changelog';
const changelogDescription = `All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).`;

// Stringification helpers

function stringifyCategory(category, changes) {
  const categoryHeader = `### ${category}`;
  if (changes.length === 0) {
    return categoryHeader;
  }
  const changeDescriptions = changes
    .map((description) => `- ${description}`)
    .join('\n');
  return `${categoryHeader}\n${changeDescriptions}`;
}

function stringifyRelease(version, categories, { date, status } = {}) {
  const releaseHeader = `## [${version}]${date ? ` - ${date}` : ''}${
    status ? ` [${status}]` : ''
  }`;
  const categorizedChanges = orderedChangeCategories
    .filter((category) => categories[category])
    .map((category) => {
      const changes = categories[category];
      return stringifyCategory(category, changes);
    })
    .join('\n\n');
  if (categorizedChanges === '') {
    return releaseHeader;
  }
  return `${releaseHeader}\n${categorizedChanges}`;
}

function stringifyReleases(releases, changes) {
  const stringifiedUnreleased = stringifyRelease(
    unreleased,
    changes[unreleased],
  );
  const stringifiedReleases = releases.map(({ version, date, status }) => {
    const categories = changes[version];
    return stringifyRelease(version, categories, { date, status });
  });

  return [stringifiedUnreleased, ...stringifiedReleases].join('\n\n');
}

function withTrailingSlash(url) {
  return url.endsWith('/') ? url : `${url}/`;
}

function getCompareUrl(repoUrl, firstRef, secondRef) {
  return `${withTrailingSlash(repoUrl)}compare/${firstRef}...${secondRef}`;
}

function getTagUrl(repoUrl, tag) {
  return `${withTrailingSlash(repoUrl)}releases/tag/${tag}`;
}

function stringifyLinkReferenceDefinitions(repoUrl, releases) {
  const orderedReleases = releases
    .map(({ version }) => version)
    .sort((a, b) => semver.gt(a, b));

  // The "Unreleased" section represents all changes made since the *highest*
  // release, not the most recent release. This is to accomodate patch releases
  // of older versions that don't represent the latest set of changes.
  //
  // For example, if a library has a v2.0.0 but the v1.0.0 release needed a
  // security update, the v1.0.1 release would then be the most recent, but the
  // range of unreleased changes would remain `v2.0.0...HEAD`.
  const unreleasedLinkReferenceDefinition = `[${unreleased}]: ${getCompareUrl(
    repoUrl,
    `v${orderedReleases[0]}`,
    'HEAD',
  )}`;

  // The "previous" release that should be used for comparison is not always
  // the most recent release chronologically. The _highest_ version that is
  // lower than the current release is used as the previous release, so that
  // patch releases on older releases can be accomodated.
  const releaseLinkReferenceDefinitions = releases
    .map(({ version }) => {
      if (version === orderedReleases[orderedReleases.length - 1]) {
        return `[${version}]: ${getTagUrl(repoUrl, `v${version}`)}`;
      }
      const versionIndex = orderedReleases.indexOf(version);
      const previousVersion = orderedReleases
        .slice(versionIndex)
        .find((releaseVersion) => {
          return semver.gt(version, releaseVersion);
        });
      return `[${version}]: ${getCompareUrl(
        repoUrl,
        `v${previousVersion}`,
        `v${version}`,
      )}`;
    })
    .join('\n');
  return `${unreleasedLinkReferenceDefinition}\n${releaseLinkReferenceDefinitions}${
    releases.length > 0 ? '\n' : ''
  }`;
}

/**
 * @typedef {import('./constants.js').Unreleased} Unreleased
 * @typedef {import('./constants.js').ChangeCategories ChangeCategories}
 */
/**
 * @typedef {import('./constants.js').Version} Version
 */
/**
 * Release metadata.
 * @typedef {Object} ReleaseMetadata
 * @property {string} date - An ISO-8601 formatted date, representing the
 *   release date.
 * @property {string} status -The status of the release (e.g. 'WITHDRAWN', 'DEPRECATED')
 * @property {Version} version - The version of the current release.
 */

/**
 * Category changes. A list of changes in a single category.
 * @typedef {Array<string>} CategoryChanges
 */

/**
 * Release changes, organized by category
 * @typedef {Record<keyof ChangeCategories, CategoryChanges>} ReleaseChanges
 */

/**
 * Changelog changes, organized by release and by category.
 * @typedef {Record<Version|Unreleased, ReleaseChanges>} ChangelogChanges
 */

/**
 * A changelog that complies with the ["keep a changelog" v1.1.0 guidelines]{@link https://keepachangelog.com/en/1.0.0/}.
 *
 * This changelog starts out completely empty, and allows new releases and
 * changes to be added such that the changelog remains compliant at all times.
 * This can be used to help validate the contents of a changelog, normalize
 * formatting, update a changelog, or build one from scratch.
 */
class Changelog {
  /**
   * Construct an empty changelog
   *
   * @param {Object} options
   * @param {string} options.repoUrl - The GitHub repository URL for the current project
   */
  constructor({ repoUrl }) {
    this._releases = [];
    this._changes = { [unreleased]: {} };
    this._repoUrl = repoUrl;
  }

  /**
   * Add a release to the changelog
   *
   * @param {Object} options
   * @param {boolean} [options.addToStart] - Determines whether the release is
   *   added to the top or bottom of the changelog. This defaults to 'true'
   *   because new releases should be added to the top of the changelog. This
   *   should be set to 'false' when parsing a changelog top-to-bottom.
   * @param {string} [options.date] - An ISO-8601 formatted date, representing the
   *   release date.
   * @param {string} [options.status] - The status of the release (e.g.
   *   'WITHDRAWN', 'DEPRECATED')
   * @param {Version} options.version - The version of the current release,
   *   which should be a [semver]{@link https://semver.org/spec/v2.0.0.html}-
   *   compatible version.
   */
  addRelease({ addToStart = true, date, status, version }) {
    if (!version) {
      throw new Error('Version required');
    } else if (semver.valid(version) === null) {
      throw new Error(`Not a valid semver version: '${version}'`);
    } else if (this._changes[version]) {
      throw new Error(`Release already exists: '${version}'`);
    }

    this._changes[version] = {};
    const newRelease = { version, date, status };
    if (addToStart) {
      this._releases.unshift(newRelease);
    } else {
      this._releases.push(newRelease);
    }
  }

  /**
   * Add a change to the changelog
   *
   * @param {Object} options
   * @param {boolean} [options.addToStart] - Determines whether the change is
   *   added to the top or bottom of the list of changes in this category. This
   *   defaults to 'true' because changes should be in reverse-chronological
   *   order. This should be set to 'false' when parsing a changelog top-to-
   *   bottom.
   * @param {string} options.category - The category of the change.
   * @param {string} options.description - The description of the change.
   * @param {Version} [options.version] - The version this change was released
   *  in. If this is not given, the change is assumed to be unreleased.
   */
  addChange({ addToStart = true, category, description, version }) {
    if (!category) {
      throw new Error('Category required');
    } else if (!orderedChangeCategories.includes(category)) {
      throw new Error(`Unrecognized category: '${category}'`);
    } else if (!description) {
      throw new Error('Description required');
    } else if (version !== undefined && !this._changes[version]) {
      throw new Error(`Specified release version does not exist: '${version}'`);
    }

    const release = version
      ? this._changes[version]
      : this._changes[unreleased];

    if (!release[category]) {
      release[category] = [];
    }
    if (addToStart) {
      release[category].unshift(description);
    } else {
      release[category].push(description);
    }
  }

  /**
   * Gets the metadata for all releases.
   * @returns {Array<ReleaseMetadata>} The metadata for each release.
   */
  getReleases() {
    return this._releases;
  }

  /**
   * Gets the changes in the given release, organized by category.
   * @param {Version} version - The version of the release being retrieved.
   * @returns {ReleaseChanges} The changes included in the given released.
   */
  getReleaseChanges(version) {
    return this._changes[version];
  }

  /**
   * Gets all changes that have not yet been released
   * @returns {ReleaseChanges} The changes that have not yet been released.
   */
  getUnreleasedChanges() {
    return this._changes[unreleased];
  }

  /**
   * The stringified changelog, formatted according to [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
   * @returns {string} The stringified changelog.
   */
  toString() {
    return `${changelogTitle}
${changelogDescription}

${stringifyReleases(this._releases, this._changes)}

${stringifyLinkReferenceDefinitions(this._repoUrl, this._releases)}`;
  }
}

module.exports = Changelog;