Class RenderContext

ng-dev/release/notes/context.ts:49–247

/** Context class used for rendering release notes. */
export class RenderContext {
  /** An array of group names in sort order if defined. */
  private readonly groupOrder = this.data.groupOrder || [];
  /** An array of scopes to hide from the release entry output. */
  private readonly hiddenScopes = this.data.hiddenScopes || [];
  /** The title of the release, or `false` if no title should be used. */
  readonly title = this.data.title;
  /** The version of the release. */
  readonly version = this.data.version;
  /** The date stamp string for use in the release notes entry. */
  readonly dateStamp = buildDateStamp(this.data.date);
  /** URL fragment that is used to create an anchor for the release. */
  readonly urlFragmentForRelease = this.data.version;
  /** List of categorized commits in the release period. */
  readonly commits = this._categorizeCommits(this.data.commits);

  constructor(private readonly data: RenderContextData) {}

  /** Gets a list of categorized commits from all commits in the release period. */
  _categorizeCommits(commits: CommitFromGitLog[]): CategorizedCommit[] {
    return commits.map((commit) => {
      const {description, groupName} = this.data.categorizeCommit?.(commit) ?? {};
      const escapedBreakingChanges = commit.breakingChanges.map((bc) => ({
        ...bc,
        text: escapeHtml(bc.text),
      }));
      const escapedDeprecations = commit.deprecations.map((dep) => ({
        ...dep,
        text: escapeHtml(dep.text),
      }));
      return {
        ...commit,
        type: escapeHtml(commit.type),
        groupName: escapeHtml(groupName ?? commit.scope),
        description: escapeHtml(description ?? commit.subject),
        breakingChanges: escapedBreakingChanges,
        deprecations: escapedDeprecations,
      };
    });
  }

  /**
   * Comparator used for sorting commits within a release notes group. Commits
   * are sorted alphabetically based on their type. Commits having the same type
   * will be sorted alphabetically based on their determined description
   */
  private _commitsWithinGroupComparator = (a: CategorizedCommit, b: CategorizedCommit): number => {
    const typeCompareOrder = compareString(a.type, b.type);
    if (typeCompareOrder === 0) {
      return compareString(a.description, b.description);
    }
    return typeCompareOrder;
  };

  /**
   * Organizes and sorts the commits into groups of commits.
   *
   * Groups are sorted either by default `Array.sort` order, or using the provided group order from