@bundle-stats/utils 3.3.0-alpha.1 → 3.3.1-beta.12

package/src/transformers/budgets-insights.ts

@@ -1,143 +0,0 @@
-import get from 'lodash/get';
-
-import { InsightType } from '../constants';
-import { getGlobalMetricType } from '../utils';
-
-interface OptionBudgetMetric {
-  metric: string;
-  value: number;
-}
-
-interface Options {
-  budgets?: Array<OptionBudgetMetric>;
-}
-
-interface BudgetInsight {
-  currentValue: number;
-  budgetValue: number;
-  failed: boolean;
-}
-
-interface BudgetInsightInfo {
-  type: InsightType;
-  message: {
-    template: string;
-    data: Record<string, unknown>;
-  };
-  source: {
-    metricId: string;
-    budgetInsight: BudgetInsight;
-  };
-}
-
-interface BudgetInsights {
-  [metricId: string]: BudgetInsight;
-}
-
-interface BudgetsInsightsOutput {
-  insights: {
-    budgets: BudgetInsights;
-  };
-}
-
-export const getExtract =
-  (source: string) => (
-    _: unknown,
-    currentExtractedData: any,
-    __: unknown,
-    options: Options = {},
-  ): BudgetsInsightsOutput | null => {
-    const { budgets: budgetsOptions } = options;
-
-    if (!budgetsOptions) {
-      return null;
-    }
-
-    const insights: Array<[string, BudgetInsight]> = [];
-
-    budgetsOptions.forEach((budgetOption) => {
-      const { metric: budgetMetricId, value: budgetValue } = budgetOption;
-      const currentValue = get(currentExtractedData, `metrics.${budgetMetricId}.value`);
-      const metric = getGlobalMetricType(`${source}.${budgetMetricId}`);
-
-      if (!currentValue) {
-        return;
-      }
-
-      const isValueOverBudget = currentValue > budgetValue;
-
-      const budgetInsight = {
-        currentValue,
-        budgetValue,
-        failed: metric.biggerIsBetter ? !isValueOverBudget : isValueOverBudget,
-      };
-
-      insights.push([budgetMetricId, budgetInsight]);
-    });
-
-    if (insights.length === 0) {
-      return null;
-    }
-
-    return {
-      insights: {
-        budgets: Object.fromEntries(insights),
-      },
-    };
-  };
-
-const resolveDiffLabel = (budgetInsight: BudgetInsight): string => {
-  const { currentValue, budgetValue } = budgetInsight;
-
-  if (currentValue > budgetValue) {
-    return 'over';
-  }
-
-  if (currentValue < budgetValue) {
-    return 'under';
-  }
-
-  return 'equal with';
-};
-
-const resolveType = (budgetInsight: BudgetInsight): InsightType => {
-  if (budgetInsight.failed) {
-    return InsightType.ERROR;
-  }
-
-  if (budgetInsight.currentValue === budgetInsight.budgetValue) {
-    return InsightType.WARNING;
-  }
-
-  return InsightType.SUCCESS;
-};
-
-// Add escapes for (|) to avoid lodash.template syntax errors
-// eslint-disable-next-line no-useless-escape
-export const INFO_MESSAGE_TEMPLATE = '<%= metricLabel %> value \(<%= currentValue %>\) is <%= diffLabel %> <%= budgetValue %> budget';
-
-export const getInfo = (globalMetricId: string, budgetInsight: BudgetInsight): BudgetInsightInfo => {
-  const metric = getGlobalMetricType(globalMetricId);
-
-  const diffLabel = resolveDiffLabel(budgetInsight);
-  const type = resolveType(budgetInsight);
-  const currentValue = metric.formatter(budgetInsight.currentValue);
-  const budgetValue = metric.formatter(budgetInsight.budgetValue);
-
-  return {
-    type,
-    message: {
-      template: INFO_MESSAGE_TEMPLATE,
-      data: {
-        metricLabel: metric.label,
-        diffLabel,
-        currentValue,
-        budgetValue,
-      },
-    },
-    source: {
-      metricId: globalMetricId,
-      budgetInsight,
-    },
-  };
-};

package/src/transformers/index.ts

@@ -1 +0,0 @@
-export * as budgetInsights from './budgets-insights';

package/src/webpack/constants.ts

@@ -1,96 +0,0 @@
-export const SECTION_WEBPACK_STATS = 'stats';
-export const SECTION_WEBPACK_SIZES = 'sizes';
-export const SECTION_WEBPACK_ASSETS = 'assets';
-export const SECTION_WEBPACK_MODULES = 'modules';
-export const SECTION_WEBPACK_PACKAGES = 'packages';
-
-export const SECTIONS = [
-  SECTION_WEBPACK_STATS,
-  SECTION_WEBPACK_SIZES,
-  SECTION_WEBPACK_ASSETS,
-  SECTION_WEBPACK_MODULES,
-  SECTION_WEBPACK_PACKAGES,
-];
-
-export enum MetricId {
-  BundleSize = 'totalSizeByTypeALL',
-  TotalInitialSizeJS = 'totalInitialSizeJS',
-  TotalInitialSizeCSS = 'totalInitialSizeCSS',
-  CacheInvalidation = 'cacheInvalidation',
-  ModuleName = 'moduleCount',
-  ChunkCount = 'chunkCount',
-  AssetCount = 'assetCount',
-  PackageCount = 'packageCount',
-  DuplicatePackagesCount = 'duplicatePackagesCount',
-}
-
-export const SIZE_BY_TYPE_METRIC_ID_ALL = 'ALL';
-export const SIZE_BY_TYPE_METRIC_ID_PREFIX = 'totalSizeByType';
-
-export enum SizeByTypeMetricId {
-  JS = 'totalSizeByTypeJS',
-  CSS = 'totalSizeByTypeCSS',
-  IMG = 'totalSizeByTypeIMG',
-  Media = 'totalSizeByTypeMEDIA',
-  Font = 'totalSizeByTypeFONT',
-  HTML = 'totalSizeByTypeHTML',
-  Other = 'totalSizeByTypeOTHER',
-}
-
-export const SUMMARY_METRIC_PATHS = Object.values(MetricId);
-
-const PACKAGE_PREFIX = /(?:node_modules|~)(?:\/\.pnpm)?/;
-const PACKAGE_SLUG = /[a-zA-Z0-9]+(?:[-|_|.]+[a-zA-Z0-9]+)*/;
-const VERSION = /@[\w|\-|_|.]+/;
-
-// Extract package paths from module path
-// https://regex101.com/r/22Leep/6
-/* eslint-disable prettier/prettier, @typescript-eslint/indent */
-export const MODULE_PATH_PACKAGES = new RegExp([
-  // match dependency directory (eg: `node_modules/`, `node_modules/.pnpm/`)
-  `(?:${PACKAGE_PREFIX.source}/)`,
-  // match package name
-  '(?:',
-    // match `@organization/` or `@organization+`(pnpm)
-    `(?:@${PACKAGE_SLUG.source}[/|+])?`,
-    // match github.com+organization+
-    `(?:${PACKAGE_SLUG.source}\\+)*`,
-    // match package name
-    `(?:${PACKAGE_SLUG.source})`,
-    // match version
-    `(?:${VERSION.source})?`,
-  ')',
-
-  // Match pnpm peer dependencies (eg: package-a@version_package-b@version)
-  '(?:_',
-    `(?:@${PACKAGE_SLUG.source}[/|+])?`,
-    `(?:${PACKAGE_SLUG.source})`,
-    `(?:@${PACKAGE_SLUG.source})?`,
-  ')*',
-  '/',
-].join(''), 'g');
-
-// Extract package name from package path
-// https://regex101.com/r/tTlU0W/6
-export const PACKAGE_PATH_NAME = new RegExp([
-  `(?:${PACKAGE_PREFIX.source}/)`,
-  // match dependency
-  '(?:',
-    '(',
-      `(?:@${PACKAGE_SLUG.source}[/|+])?`,
-      `(?:(?:${PACKAGE_SLUG.source}\\+)*)`,
-      `(?:${PACKAGE_SLUG.source})`,
-    ')',
-    `(?:${VERSION.source})?`,
-  ')',
-  // match peer dependency
-  '(?:_',
-    '(',
-      `(?:@${PACKAGE_SLUG.source}[/|+])?`,
-      `(?:${PACKAGE_SLUG.source})`,
-    ')',
-    `(?:@${PACKAGE_SLUG.source})`,
-  ')*',
-  '/',
-].join(''), 'g');
-/* eslint-enable prettier/prettier, @typescript-eslint/indent */

package/src/webpack/extract/budgets-insights.ts

@@ -1,73 +0,0 @@
-import get from 'lodash/get';
-
-import { getMetricType } from '../utils';
-
-interface OptionBudgetMetric {
-  metric: string;
-  value: number;
-}
-
-interface Options {
-  budgets?: Array<OptionBudgetMetric>;
-}
-
-interface BudgetInsight {
-  currentValue: number;
-  budgetValue: number;
-  failed: boolean;
-}
-
-interface BudgetsInsights {
-  [metricId: string]: BudgetInsight;
-}
-
-interface ExtractBudgetsInsights {
-  insights: {
-    budgets: BudgetsInsights;
-  };
-}
-
-export default function extractBudgetsInsights(
-  _: unknown,
-  currentExtractedData: any,
-  __: unknown,
-  options: Options = {}
-): ExtractBudgetsInsights | null {
-  const { budgets: budgetsOptions } = options;
-
-  if (!budgetsOptions) {
-    return null;
-  }
-
-  const insights: Array<[string, BudgetInsight]> = [];
-
-  budgetsOptions.forEach((budgetOption) => {
-    const { metric: budgetMetricId, value: budgetValue } = budgetOption;
-    const currentValue = get(currentExtractedData, `metrics.${budgetMetricId}.value`);
-    const metric = getMetricType(budgetMetricId);
-
-    if (!currentValue) {
-      return;
-    }
-
-    const isValueOverBudget = currentValue > budgetValue;
-
-    const budgetInsight = {
-      currentValue,
-      budgetValue,
-      failed: metric.biggerIsBetter ? !isValueOverBudget : isValueOverBudget,
-    };
-
-    insights.push([budgetMetricId, budgetInsight]);
-  });
-
-  if (insights.length === 0) {
-    return null;
-  }
-
-  return {
-    insights: {
-      budgets: Object.fromEntries(insights),
-    },
-  };
-}

package/types/transformers/budgets-insights.d.ts

@@ -1,36 +0,0 @@
-import { InsightType } from '../constants';
-interface OptionBudgetMetric {
-    metric: string;
-    value: number;
-}
-interface Options {
-    budgets?: Array<OptionBudgetMetric>;
-}
-interface BudgetInsight {
-    currentValue: number;
-    budgetValue: number;
-    failed: boolean;
-}
-interface BudgetInsightInfo {
-    type: InsightType;
-    message: {
-        template: string;
-        data: Record<string, unknown>;
-    };
-    source: {
-        metricId: string;
-        budgetInsight: BudgetInsight;
-    };
-}
-interface BudgetInsights {
-    [metricId: string]: BudgetInsight;
-}
-interface BudgetsInsightsOutput {
-    insights: {
-        budgets: BudgetInsights;
-    };
-}
-export declare const getExtract: (source: string) => (_: unknown, currentExtractedData: any, __: unknown, options?: Options) => BudgetsInsightsOutput | null;
-export declare const INFO_MESSAGE_TEMPLATE = "<%= metricLabel %> value (<%= currentValue %>) is <%= diffLabel %> <%= budgetValue %> budget";
-export declare const getInfo: (globalMetricId: string, budgetInsight: BudgetInsight) => BudgetInsightInfo;
-export {};

package/types/transformers/index.d.ts

@@ -1 +0,0 @@
-export * as budgetInsights from './budgets-insights';

package/types/webpack/extract/budgets-insights.d.ts

@@ -1,22 +0,0 @@
-interface OptionBudgetMetric {
-    metric: string;
-    value: number;
-}
-interface Options {
-    budgets?: Array<OptionBudgetMetric>;
-}
-interface BudgetInsight {
-    currentValue: number;
-    budgetValue: number;
-    failed: boolean;
-}
-interface BudgetsInsights {
-    [metricId: string]: BudgetInsight;
-}
-interface ExtractBudgetsInsights {
-    insights: {
-        budgets: BudgetsInsights;
-    };
-}
-export default function extractBudgetsInsights(_: unknown, currentExtractedData: any, __: unknown, options?: Options): ExtractBudgetsInsights | null;
-export {};