Method #createGroupMarkers

packages/utils/src/lib/logger.ts:343–387

()

  }

  #createGroupMarkers(): {
    start: (title: string) => string;
    end: () => string;
  } {
    // Nx typically renders native log groups for each target in GitHub
    // + GitHub doesn't support nested log groups: https://github.com/actions/toolkit/issues/1001
    // => skip native GitHub log groups if run within Nx target
    const platform =
      this.#ciPlatform === 'GitHub' && process.env['NX_TASK_TARGET_TARGET'] // https://nx.dev/docs/reference/environment-variables
        ? undefined
        : this.#ciPlatform;

    switch (platform) {
      case 'GitHub':
        // https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-commands#grouping-log-lines
        return {
          start: title =>
            `::group::${this.#formatGroupTitle(title, { prefix: false })}`,
          end: () => '::endgroup::',
        };
      case 'GitLab':
        // https://docs.gitlab.com/ci/jobs/job_logs/#custom-collapsible-sections
        const ansiEscCode = '\u001B[0K'; // '\e' ESC character only works for `echo -e`, Node console must use '\u001B'
        const id = Math.random().toString(HEX_RADIX).slice(2);
        const sectionId = `code_pushup_logs_group_${id}`;
        return {
          start: title => {
            const sectionHeader = this.#formatGroupTitle(title, {
              prefix: true,
            });
            const options = this.#isVerbose ? '' : '[collapsed=true]';
            // return `${ansiEscCode}section_start:${dateToUnixTimestamp(new Date())}:${sectionId}${options}${ansiEscCode}${sectionHeader}`;
            return `${ansiEscCode}section_start:${dateToUnixTimestamp(new Date())}:${sectionId}${options}\r${ansiEscCode}${sectionHeader}`;
          },
          end: () =>
            // `${ansiEscCode}section_end:${dateToUnixTimestamp(new Date())}:${sectionId}${ansiEscCode}`,
            `${ansiEscCode}section_end:${dateToUnixTimestamp(new Date())}:${sectionId}\r${ansiEscCode}`,
        };
      case undefined:
        return {
          start: title => this.#formatGroupTitle(title, { prefix: true }),
          end: () => '',
        };
    }
  }

  #formatGroupTitle(title: string, symbols: { prefix: boolean }): string {
    const text = symbols.prefix