@bundle-stats/utils 4.7.5-alpha.0 → 4.7.5-beta.2

package/src/config/delta.js

@@ -1,11 +0,0 @@
-export const DELTA_TYPE_NEGATIVE = 'NEGATIVE';
-export const DELTA_TYPE_NO_CHANGE = 'NO_CHANGE';
-export const DELTA_TYPE_POSITIVE = 'POSITIVE';
-
-export const DELTA_TYPE_LEVEL_LOW = 'LOW';
-export const DELTA_TYPE_LEVEL_HIGH = 'HIGH';
-
-export const DELTA_TYPE_LOW_NEGATIVE = `${DELTA_TYPE_LEVEL_LOW}_${DELTA_TYPE_NEGATIVE}`;
-export const DELTA_TYPE_HIGH_NEGATIVE = `${DELTA_TYPE_LEVEL_HIGH}_${DELTA_TYPE_NEGATIVE}`;
-export const DELTA_TYPE_LOW_POSITIVE = `${DELTA_TYPE_LEVEL_LOW}_${DELTA_TYPE_POSITIVE}`;
-export const DELTA_TYPE_HIGH_POSITIVE = `${DELTA_TYPE_LEVEL_HIGH}_${DELTA_TYPE_POSITIVE}`;

package/src/config/metrics.js

@@ -1,31 +0,0 @@
-import { formatNumber, formatDuration, formatFileSize, formatPercentage } from '../utils/format';
-
-export const METRIC_TYPE_FILE_SIZE = 'METRIC_TYPE_FILE_SIZE';
-export const METRIC_TYPE_DURATION = 'METRIC_TYPE_DURATION';
-export const METRIC_TYPE_NUMERIC = 'METRIC_TYPE_NUMERIC';
-export const METRIC_TYPE_SCORE = 'METRIC_TYPE_SCORE';
-export const METRIC_TYPE_PERCENTAGE = 'METRIC_TYPE_PERCENTAGE';
-
-/** @type {Record<string, import('../constants').MetricType>} */
-export const METRIC_TYPES = {
-  [METRIC_TYPE_NUMERIC]: {
-    biggerIsBetter: false,
-    formatter: formatNumber,
-  },
-  [METRIC_TYPE_SCORE]: {
-    biggerIsBetter: true,
-    formatter: formatNumber,
-  },
-  [METRIC_TYPE_DURATION]: {
-    biggerIsBetter: false,
-    formatter: formatDuration,
-  },
-  [METRIC_TYPE_FILE_SIZE]: {
-    biggerIsBetter: false,
-    formatter: formatFileSize,
-  },
-  [METRIC_TYPE_PERCENTAGE]: {
-    biggerIsBetter: true,
-    formatter: formatPercentage,
-  },
-};

package/src/utils/delta.js

@@ -1,94 +0,0 @@
-import round from 'lodash/round';
-
-import {
-  DELTA_TYPE_NO_CHANGE,
-  DELTA_TYPE_NEGATIVE,
-  DELTA_TYPE_POSITIVE,
-  DELTA_TYPE_LEVEL_HIGH,
-  DELTA_TYPE_LEVEL_LOW,
-} from '../config/delta';
-
-export const getDelta = (baseline, current) => {
-  const baselineValue = (baseline && baseline.value) || 0;
-  const currentValue = (current && current.value) || 0;
-
-  if (baselineValue === currentValue) {
-    return {
-      delta: 0,
-      deltaPercentage: 0,
-    };
-  }
-
-  if (baselineValue === 0) {
-    return {
-      delta: currentValue,
-      deltaPercentage: 100,
-    };
-  }
-
-  return {
-    delta: currentValue - baselineValue,
-    deltaPercentage: round((currentValue / baselineValue) * 100 - 100, 8),
-  };
-};
-
-/**
- * Format delta output
- *
- * @param {number} value Metric value
- * @param {Function} formatter Metric type formatter
- * @return {String} Delta output
- */
-export const formatDelta = (value, formatter) => {
-  // eslint-disable-next-line no-nested-ternary
-  let sign = value > 0
-    ? '+'
-    : (value < 0 ? '-' : '');
-
-  let absValue = Math.abs(value);
-
-  if (absValue > 0 && absValue < 0.01) {
-    sign = `~${sign}`;
-    absValue = 0.01;
-  }
-
-  if (absValue > 0.01) {
-    absValue = round(absValue, 2);
-  }
-
-  return `${sign}${formatter(absValue)}`;
-};
-
-/**
- *
- * Get delta type
- *
- * @param {number} deltaValue Delta value
- * @param {Boolean} biggerIsBetter Metric flag
- * @return {string} Delta type
- */
-export const getDeltaType = (deltaValue, biggerIsBetter) => {
-  if (deltaValue === 0) {
-    return DELTA_TYPE_NO_CHANGE;
-  }
-
-  const absDiff = Math.abs(deltaValue);
-  let level = '';
-
-  if (absDiff <= 5) {
-    level = DELTA_TYPE_LEVEL_LOW;
-  }
-
-  if (absDiff > 50) {
-    level = DELTA_TYPE_LEVEL_HIGH;
-  }
-
-  let type = '';
-  if ((deltaValue > 0 && biggerIsBetter) || (deltaValue < 0 && !biggerIsBetter)) {
-    type = DELTA_TYPE_POSITIVE;
-  } else {
-    type = DELTA_TYPE_NEGATIVE;
-  }
-
-  return `${level ? `${level}_` : ''}${type}`;
-};

package/src/utils/metrics.js

@@ -1,92 +0,0 @@
-import get from 'lodash/get';
-
-import { METRIC_TYPE_NUMERIC, METRIC_TYPES } from '../config/metrics';
-import { formatDelta, getDelta, getDeltaType } from './delta';
-import { formatPercentage } from './format';
-
-import { metrics as webpackMetricTypes } from '../webpack/metrics';
-import { metrics as lighthouseMetricTypes } from '../lighthouse/metrics';
-import { metrics as browsertimeMeticTypes } from '../browsertime/metrics';
-
-/**
- * Create getMetricTypes handler
- *
- * @param {Object} metrics
- * @return {Function}
- */
-export const createGetMetricType =
-  (metrics) =>
-  /**
-   * Get metric type data
-   *
-   * @param {String} key Metric key
-   * @param {String} [type] Default metric type
-   * @return {import('../constants').MetricType}
-   */
-  // eslint-disable-next-line implicit-arrow-linebreak
-  (key, type) => {
-    /** @type {import('../constants').MetricTypeConfig} */
-    const metric = get(metrics, key);
-
-    if (metric && metric.type) {
-      return {
-        ...METRIC_TYPES[metric.type],
-        ...metric,
-      };
-    }
-
-    const resolvedType = type || METRIC_TYPE_NUMERIC;
-
-    return {
-      ...METRIC_TYPES[resolvedType],
-      type: resolvedType,
-      label: key,
-    };
-  };
-
-/**
- * Get global metric type
- *
- * @param {String} key Metric key
- * @param {import('../constants').MetricTypeType} [type] Default metric type
- * @return {import('../constants').MetricType}
- */
-export const getGlobalMetricType = createGetMetricType({
-  webpack: webpackMetricTypes,
-  lighthouse: lighthouseMetricTypes,
-  browsertime: browsertimeMeticTypes,
-});
-
-/**
- *
- * Get metric information
- *
- * @param {import('../constants').MetricType} metric Metric data
- * @param {number} currentValue Current value
- * @param {number} baselineValue Baseline value
- *
- * @return {import('../constants').MetricRunInfo}
- */
-export const getMetricRunInfo = (metric, currentValue, baselineValue) => {
-  const { formatter, biggerIsBetter } = metric;
-
-  const runInfo = {
-    value: currentValue,
-    displayValue: formatter(currentValue),
-  };
-
-  if (typeof baselineValue === 'undefined') {
-    return runInfo;
-  }
-
-  const { delta, deltaPercentage } = getDelta({ value: baselineValue }, { value: currentValue });
-
-  return {
-    ...runInfo,
-    delta,
-    deltaPercentage,
-    displayDelta: formatDelta(delta, formatter),
-    displayDeltaPercentage: formatDelta(deltaPercentage, formatPercentage),
-    deltaType: getDeltaType(deltaPercentage, biggerIsBetter),
-  };
-};

package/types/config/delta.d.ts

@@ -1,9 +0,0 @@
-export const DELTA_TYPE_NEGATIVE: "NEGATIVE";
-export const DELTA_TYPE_NO_CHANGE: "NO_CHANGE";
-export const DELTA_TYPE_POSITIVE: "POSITIVE";
-export const DELTA_TYPE_LEVEL_LOW: "LOW";
-export const DELTA_TYPE_LEVEL_HIGH: "HIGH";
-export const DELTA_TYPE_LOW_NEGATIVE: string;
-export const DELTA_TYPE_HIGH_NEGATIVE: string;
-export const DELTA_TYPE_LOW_POSITIVE: string;
-export const DELTA_TYPE_HIGH_POSITIVE: string;

package/types/config/metrics.d.ts

@@ -1,6 +0,0 @@
-export const METRIC_TYPE_FILE_SIZE: "METRIC_TYPE_FILE_SIZE";
-export const METRIC_TYPE_DURATION: "METRIC_TYPE_DURATION";
-export const METRIC_TYPE_NUMERIC: "METRIC_TYPE_NUMERIC";
-export const METRIC_TYPE_SCORE: "METRIC_TYPE_SCORE";
-export const METRIC_TYPE_PERCENTAGE: "METRIC_TYPE_PERCENTAGE";
-export const METRIC_TYPES: Record<string, import('../constants').MetricType>;