@bundle-stats/utils 4.0.0-alpha.9 → 4.0.0-rc.1

package/src/webpack/metrics.js

@@ -7,74 +7,74 @@ import {
 export const metrics = {
   totalSizeByTypeALL: {
     label: 'Bundle Size',
-    description: 'Sum of all assets emitted by webpack.',
+    description: 'The total size of the assets produced by webpack',
     url: 'https://relative-ci.com/documentation/metrics-and-data#assets',
     type: METRIC_TYPE_FILE_SIZE,
   },
   totalInitialSizeJS: {
     label: 'Initial JS',
-    description: 'Sum of all JavaScript assets that are labeled as initial(eg: vendor.js, app.js).',
+    description: 'The total size of JavaScript initial chunks',
     url: 'https://relative-ci.com/documentation/metrics-and-data#assets',
     type: METRIC_TYPE_FILE_SIZE,
   },
   totalInitialSizeCSS: {
     label: 'Initial CSS',
-    description: 'Sum of all CSS assets that are labeled as initial(eg: vendor.css, app.css).',
+    description: 'The total size of CSS initial chunks',
     url: 'https://relative-ci.com/documentation/metrics-and-data#assets',
     type: METRIC_TYPE_FILE_SIZE,
   },
   cacheInvalidation: {
     label: 'Cache Invalidation',
-    description: 'Ratio between the total changed assets and Bundle Size.',
+    description: 'The ratio between the total changed assets and total assets size(Bundle Size)',
     url: 'https://relative-ci.com/documentation/metrics-and-data#assets',
     type: METRIC_TYPE_PERCENTAGE,
     biggerIsBetter: false,
   },
   chunkCount: {
     label: 'Chunks',
-    description: 'Total number of chunks generated by webpack.',
+    description: 'The total number of chunks',
     url: 'https://relative-ci.com/documentation/metrics-and-data#assets',
     type: METRIC_TYPE_NUMERIC,
     biggerIsBetter: false,
   },
   assetCount: {
     label: 'Assets',
-    description: 'Total number of assets emitted by webpack.',
+    description: 'Total number of assets',
     url: 'https://relative-ci.com/documentation/metrics-and-data#assets',
     type: METRIC_TYPE_NUMERIC,
     biggerIsBetter: false,
   },
   moduleCount: {
     label: 'Modules',
-    description: 'Total number of modules bundled by webpack.',
+    description: 'The total number of modules bundled by webpack',
     url: 'https://relative-ci.com/documentation/metrics-and-data#modules-1',
     type: METRIC_TYPE_NUMERIC,
     biggerIsBetter: false,
   },
   duplicateModulesCount: {
     label: 'Duplicate Modules',
-    description: 'Total number of modules that belong to more than one chunk.',
+    description: 'The total number of modules that belong to more than one chunk',
     url: 'https://relative-ci.com/documentation/metrics-and-data#modules-1',
     type: METRIC_TYPE_NUMERIC,
     biggerIsBetter: false,
   },
   duplicateCode: {
     label: 'Duplicate Code',
-    description: 'The percentage of total duplicate module size from the total module size.',
+    description: 'The percentage of total duplicate module size from the total module size',
     url: 'https://relative-ci.com/documentation/metrics-and-data#modules-1',
     type: METRIC_TYPE_PERCENTAGE,
     biggerIsBetter: false,
   },
   packageCount: {
     label: 'Packages',
-    description: 'Total number of packages bundled by webpack.',
+    description: 'The total number of packages bundled by webpack',
     url: 'https://relative-ci.com/documentation/metrics-and-data#packages',
     type: METRIC_TYPE_NUMERIC,
     biggerIsBetter: false,
   },
   duplicatePackagesCount: {
     label: 'Duplicate Packages',
-    description: 'Total number of packages that are duplicated.',
+    description: 'The total number of duplicate packages',
     url: 'https://relative-ci.com/documentation/metrics-and-data#packages',
     type: METRIC_TYPE_NUMERIC,
     biggerIsBetter: false,

package/src/webpack/types.ts

@@ -0,0 +1,54 @@
+import { Metric, MetricRun } from '../constants';
+
+interface MetaChunk {
+  id: string;
+  name: string;
+}
+
+export interface Asset extends Metric {
+  name: string;
+  isEntry: boolean;
+  isInitial: boolean;
+  isChunk: boolean;
+  chunkId?: string;
+}
+
+export type Assets = Record<string, Asset>;
+
+export interface MetricsAssets {
+  metrics: {
+    assets: Assets;
+  };
+  meta?: {
+    chunks: Array<MetaChunk>;
+  };
+}
+
+export interface Module extends Metric {
+  name: string;
+  chunkIds: Array<String>;
+  duplicated: boolean;
+}
+
+export type Modules = Record<string, Module>;
+
+export interface MetricsModules {
+  metrics: {
+    duplicateCode: MetricRun;
+    duplicateModulesCount: MetricRun;
+    modules: Modules;
+    moduleCount: MetricRun;
+  };
+}
+
+export interface Package extends Metric {
+  path: string;
+}
+
+export type Packages = Record<string, Package>;
+
+export interface MetricsPackages {
+  metrics: {
+    packages: Packages;
+  };
+}

package/types/constants.d.ts

@@ -37,26 +37,6 @@ export interface MetricRunInfo {
 export interface Metric {
     value: number;
 }
-export interface ModuleMetric extends Metric {
-    name: string;
-    chunkIds: Array<String>;
-    duplicated: boolean;
-}
-export interface PackageMetric extends Metric {
-    path: string;
-}
-export interface WebpackMetricsModules {
-    metrics: {
-        duplicateCode: MetricRun;
-        duplicateModulesCount: MetricRun;
-        modules: Record<string, ModuleMetric>;
-    };
-}
-export interface WebpackMetricsPackages {
-    metrics: {
-        packages: Record<string, PackageMetric>;
-    };
-}
 export interface LighthouseSource {
     lighthouseVersion: string;
     fetchTime: string;

package/types/webpack/extract/assets.d.ts

@@ -1,11 +1,3 @@
-export declare const extractAssets: (webpackStats: any) => {
-    meta?: {
-        chunks: {
-            id: string;
-            name: string;
-        }[];
-    } | undefined;
-    metrics: {
-        assets: {};
-    };
-};
+import { WebpackStatsFiltered } from '@bundle-stats/plugin-webpack-filter';
+import { MetricsAssets } from '../types';
+export declare const extractAssets: (webpackStats: WebpackStatsFiltered) => MetricsAssets;

package/types/webpack/extract/modules-packages.d.ts

@@ -1,7 +1,7 @@
-import { WebpackMetricsModules, WebpackMetricsPackages } from '../../constants';
+import { MetricsModules, MetricsPackages } from '../types';
 export declare const getPackageMetaFromModulePath: (modulePath: string) => {
     id: string;
     name: unknown;
     path: string;
 } | null;
-export declare const extractModulesPackages: (webpackStats?: any, currentExtractedData?: WebpackMetricsModules) => WebpackMetricsPackages;
+export declare const extractModulesPackages: (_?: unknown, currentExtractedData?: MetricsModules) => MetricsPackages;

package/types/webpack/extract/modules.d.ts

@@ -1,2 +1,3 @@
-import { WebpackMetricsModules } from '../../constants';
-export declare const extractModules: (webpackStats?: any) => WebpackMetricsModules;
+import { WebpackStatsFiltered } from '@bundle-stats/plugin-webpack-filter';
+import { MetricsModules } from '../types';
+export declare const extractModules: (webpackStats?: WebpackStatsFiltered) => MetricsModules;

package/types/webpack/index.d.ts

@@ -6,3 +6,4 @@ export * from "./extract";
 export * from "./metrics";
 export * from "./selectors";
 export * from "./utils";
+export * from "./types";

package/types/webpack/types.d.ts

@@ -0,0 +1,45 @@
+import { Metric, MetricRun } from '../constants';
+interface MetaChunk {
+    id: string;
+    name: string;
+}
+export interface Asset extends Metric {
+    name: string;
+    isEntry: boolean;
+    isInitial: boolean;
+    isChunk: boolean;
+    chunkId?: string;
+}
+export declare type Assets = Record<string, Asset>;
+export interface MetricsAssets {
+    metrics: {
+        assets: Assets;
+    };
+    meta?: {
+        chunks: Array<MetaChunk>;
+    };
+}
+export interface Module extends Metric {
+    name: string;
+    chunkIds: Array<String>;
+    duplicated: boolean;
+}
+export declare type Modules = Record<string, Module>;
+export interface MetricsModules {
+    metrics: {
+        duplicateCode: MetricRun;
+        duplicateModulesCount: MetricRun;
+        modules: Modules;
+        moduleCount: MetricRun;
+    };
+}
+export interface Package extends Metric {
+    path: string;
+}
+export declare type Packages = Record<string, Package>;
+export interface MetricsPackages {
+    metrics: {
+        packages: Packages;
+    };
+}
+export {};

package/lib/webpack/extract/modules-count.js

@@ -1,14 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractModulesCount = void 0;
-const get_1 = __importDefault(require("lodash/get"));
-const extractModulesCount = (webpackStats, currentExtractedData = {}) => {
-    const modules = (0, get_1.default)(currentExtractedData, 'metrics.modules', {});
-    const value = Object.values(modules).length || 0;
-    return { metrics: { moduleCount: { value } } };
-};
-exports.extractModulesCount = extractModulesCount;
-//# sourceMappingURL=modules-count.js.map

package/lib/webpack/extract/modules-count.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"modules-count.js","sourceRoot":"","sources":["../../../src/webpack/extract/modules-count.js"],"names":[],"mappings":";;;;;;AAAA,qDAA6B;AAEtB,MAAM,mBAAmB,GAAG,CAAC,YAAY,EAAE,oBAAoB,GAAG,EAAE,EAAE,EAAE;IAC7E,MAAM,OAAO,GAAG,IAAA,aAAG,EAAC,oBAAoB,EAAE,iBAAiB,EAAE,EAAE,CAAC,CAAC;IACjE,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC;IAEjD,OAAO,EAAE,OAAO,EAAE,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;AACjD,CAAC,CAAC;AALW,QAAA,mBAAmB,uBAK9B"}

package/lib-esm/webpack/extract/modules-count.js

@@ -1,7 +0,0 @@
-import get from 'lodash/get';
-export const extractModulesCount = (webpackStats, currentExtractedData = {}) => {
-    const modules = get(currentExtractedData, 'metrics.modules', {});
-    const value = Object.values(modules).length || 0;
-    return { metrics: { moduleCount: { value } } };
-};
-//# sourceMappingURL=modules-count.js.map

package/lib-esm/webpack/extract/modules-count.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"modules-count.js","sourceRoot":"","sources":["../../../src/webpack/extract/modules-count.js"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,YAAY,CAAC;AAE7B,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,YAAY,EAAE,oBAAoB,GAAG,EAAE,EAAE,EAAE;IAC7E,MAAM,OAAO,GAAG,GAAG,CAAC,oBAAoB,EAAE,iBAAiB,EAAE,EAAE,CAAC,CAAC;IACjE,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC;IAEjD,OAAO,EAAE,OAAO,EAAE,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;AACjD,CAAC,CAAC"}

package/src/webpack/extract/modules-count.js

@@ -1,8 +0,0 @@
-import get from 'lodash/get';
-
-export const extractModulesCount = (webpackStats, currentExtractedData = {}) => {
-  const modules = get(currentExtractedData, 'metrics.modules', {});
-  const value = Object.values(modules).length || 0;
-
-  return { metrics: { moduleCount: { value } } };
-};

package/types/webpack/extract/modules-count.d.ts

@@ -1,7 +0,0 @@
-export function extractModulesCount(webpackStats: any, currentExtractedData?: {}): {
-    metrics: {
-        moduleCount: {
-            value: number;
-        };
-    };
-};