* @param {[FileMetadata]} fileMetadatas - gitStream's list of metadata about file changes in the PR including path
 * @returns {[Object]} Returns a list of objects for each platform containing info about the changes to files in that platform
 * @example {{ owners | categorize(branch.diff.files_metadata) }}
 */

function categorize(fileOwners, fileMetadatas) {

 * @param {[FileMetadata]} fileMetadatas - gitStream's list of metadata about file changes in the PR including path
 * @returns {[Object]} Returns list of computed summary statistic objects for each platform in the input groupedFiles
 * @example {{ fileOwners | categorize(branch.diff.files_metadata) | changeStatistics(branch.diff.files_metadata) }}
 */

 *
 * The table should be in descending order of the number of lines changed, and should only include platforms with non-0 changes.
 *
 * @param {[Object]} statistics - list of summary data objects from computeStatistics
 * @param {String} title - description of how data is grouped
 * @returns {String} Returns the formatted HTMl table string.

/**
 * @module readField
 * @description Returns one field for a particular named object in a list of objects.
 * @param {[Object]} objects - The objects to search
 * @param {String} objectName - The name of the particular object to find
 * @param {String} fieldName - The name of the field for the group to return
 * @returns String - The specified value
 * @example {{ files | byPlatform | categorize(branch.diff.files_metadata) | readField('jvm', 'name') }}
 */

    // Check if always enabled, or enabled by comment
    if (automationActivations.includes('always')) {
        result = true;
    } else {
        result = Object.values(pr.comments).some(comment => {
            const checks = extractCheckNames(comment.content);
            if (checks.includes(automationName)) {
                return true;
            }
        });
    }

/* istanbul ignore else */
if (typeof Symbol !== 'undefined') {
    TMP_KEY_IGNORE = Symbol.for('node-ignore')
}
const KEY_IGNORE = TMP_KEY_IGNORE

const define = (object, key, value) =>
    Object.defineProperty(object, key, {value})

const REGEX_REGEXP_RANGE = /([0-z])-([0-z])/g

const RETURN_FALSE = () => false

// Sanitize the range of a regular expression

/**
 * @module byCodeowner
 * @description Groups the PR's files' by owner based on the CODEOWNERs file.
 * @param {string[]} files - the gitStream's files context variable
 * @param {Object} pr - the gitStream's pr context variable
 * @param {string} token - access token with repo:read scope, used to read the CODEOWNERS file
 * @param {string} pathToCodeOwners - path from repo root to CODEOWNERS file
 * @returns {Map} - Map from owner name to list of files they own