danger-plugin-istanbul-coverage/dist/filename-utils.js

Danger.js plugin for monitoring istanbul code coverage on changed files.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const _ = require("lodash");
const path = require("path");
/**
 * Shortens the length of a directory in a pretty way.
 * @param pathName The path to shorten
 * @param maxLength The maximum length of the path. Must be at least 4.
 * @returns The shortened directory name.
 */
function getPrettyPathName(pathName, maxLength) {
    if (maxLength < 4) {
        throw Error("maxLength must be at least 4");
    }
    if (pathName.length <= maxLength) {
        return pathName;
    }
    const parts = path.parse(pathName);
    const dirWithoutRoot = parts.dir.slice(parts.root.length, parts.dir.length - parts.root.length + 1);
    const dirs = dirWithoutRoot.split(path.sep);
    const root = `${parts.root}..${path.sep}`;
    // Save the first directory, we want to try and prioritize keeping it in the path.
    let firstDir = dirs.shift();
    firstDir = firstDir ? firstDir : "";
    while (dirs.length > 0) {
        // Except for the first directory, start removing dirs from left to right.
        dirs.shift();
        const middle = ["..", ...dirs].join(path.sep);
        const newPath = `${parts.root}${firstDir}${path.sep}${middle}${path.sep}${parts.base}`;
        if (newPath.length <= maxLength) {
            return newPath;
        }
    }
    const rootAndName = `..${path.sep}${parts.base}`;
    if (rootAndName.length <= maxLength) {
        return rootAndName;
    }
    return `${rootAndName.slice(0, maxLength - 2)}..`;
}
exports.getPrettyPathName = getPrettyPathName;
/**
 * Escapes the characters |()[]#*{}-+_!\,`> from a string.
 * @param source The source to escape
 * @returns An escaped version of the string
 */
function escapeMarkdownCharacters(source) {
    const escapedCharacters = ["|", "(", ")", "[", "]", "#", "*", "{", "}", "-", "+", "_", "!", "\\", "`"];
    return [...source].map(c => (_.includes(escapedCharacters, c) ? `\\${c}` : c)).join("");
}
exports.escapeMarkdownCharacters = escapeMarkdownCharacters;
/**
 * Parses the output from the git root directory command, removing newlines and adding a platform
 * native separator.
 * @param stdout The output to cleanup
 * @param seperator The separator the path should end in. Defaults to platform native.
 * @returns A cleaned up git root directory.
 */
function parseGitRootPathOutput(stdout, seperator) {
    if (seperator === undefined) {
        seperator = path.sep;
    }
    stdout = trimLineEnding(stdout);
    if (stdout.endsWith(seperator)) {
        return stdout;
    }
    return `${stdout}${seperator}`;
}
exports.parseGitRootPathOutput = parseGitRootPathOutput;
/**
 * Trims the line endings from the end of a string
 * @param input The string to cleanup
 * @returns The string without line endings
 */
function trimLineEnding(input) {
    return input.replace(/[\r\n]*/g, "");
}
exports.trimLineEnding = trimLineEnding;