Function normalizeFlags

packages/plugin-lighthouse/src/lib/normalize-flags.ts:38–63

(flags?: LighthouseOptions)

]);

export function normalizeFlags(flags?: LighthouseOptions): LighthouseCliFlags {
  const prefilledFlags = { ...DEFAULT_LIGHTHOUSE_OPTIONS, ...flags };

  logUnsupportedFlagsInUse(prefilledFlags);

  return Object.fromEntries(
    Object.entries(prefilledFlags)
      .filter(
        ([flagName]) =>
          !LIGHTHOUSE_UNSUPPORTED_CLI_FLAGS.has(
            flagName as UnsupportedCliFlags,
          ),
      )
      // in code-pushup lighthouse categories are mapped as groups, therefor we had to rename "onlyCategories" to "onlyGroups" for the user of the plugin as it was confusing
      .map(([key, v]) => [key === 'onlyGroups' ? 'onlyCategories' : key, v])
      // onlyAudits and onlyCategories cannot be empty arrays, otherwise skipAudits is ignored by lighthouse
      .filter(([_, v]) => !(Array.isArray(v) && v.length === 0))
      // undefined | string | string[] => string[] (empty for undefined)
      .map(([key, v]) => {
        if (!REFINED_STRING_OR_STRING_ARRAY.has(key as never)) {
          return [key, v];
        }
        return [key, Array.isArray(v) ? v : v == null ? [] : [v]];
      }),
  ) as LighthouseCliFlags;
}

export function logUnsupportedFlagsInUse(
  flags: LighthouseOptions,