Add filterSummary (fixes #19 and #20), v3.3.0

doesdev · doesdev · commit 5ede5f270481 · 2020-07-08T22:16:49.000-04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,12 @@
 
 All notable changes to this project will be documented in this file. Dates are displayed in UTC.
 
-### UNRELEASED
+### [3.3.0](https://github.com/doesdev/rollup-plugin-analyzer/compare/3.2.3...3.3.0)
+
+> 8 July 2020
+
+- Add `filterSummary` option (#19 && #20)
+- Fix `origSize`, `bundleOrigSize`, and `bundleReduction` (was apparently borked)
 - Remove Rollup 0.60.0 from tests
 - Fix incorrect key names in `analysisObject` docs
 - Clarify `filter` usage
diff --git a/README.md b/README.md
@@ -152,8 +152,12 @@ module count:   5
     - If array it checks the same for each string in the array
     - If function, return a boolean to indicate if a module should be in analysis results
     - This only suppresses the modules details, it does not affect the summary output
-    - If you would like it to filter from summary info as well, let us know in [#19](https://github.com/doesdev/rollup-plugin-analyzer/issues/19)
+    - If you would like it to filter from summary info as well set `filterSummary` to `true`
   - notes: Function receives `module` object specified below, should return boolean
+- **filterSummary** - *optional*
+  - type: Boolean
+  - default: `false`
+  - description: If `true` the `filter` option will also remove any filtered out module data from the summary
 - **root** - *optional*
   - type: String
   - default: `process.cwd()`
diff --git a/index.d.ts b/index.d.ts
@@ -3,10 +3,22 @@ import { Plugin } from "rollup";
 declare const analyzer: (options?: AnalyzerOptions) => Plugin;
 export default analyzer;
 
+export interface Module {
+  id: string;
+  size: number;
+  origSize: number;
+  dependents: string[];
+  percent: number;
+  reduction: number;
+  usedExports: string[];
+  unusedExports: string[];
+}
+
 export interface AnalyzerOptions {
   stdout?: boolean;
   limit?: number;
-  filter?: string | string[] | ((id: string) => boolean);
+  filter?: string | string[] | ((moduleObject: Module) => boolean);
+  filterSummary?: boolean;
   root?: string;
   hideDeps?: boolean;
   showExports?: boolean;
@@ -24,14 +36,3 @@ export interface AnalysisObject {
   moduleCount: number;
   modules: Module[];
 }
-
-export interface Module {
-  id: string;
-  size: number;
-  origSize: number;
-  dependents: string[];
-  percent: number;
-  reduction: number;
-  usedExports: string[];
-  unusedExports: string[];
-}
diff --git a/index.js b/index.js
@@ -3,6 +3,7 @@
 const buf = ' ';
 const tab = '  ';
 const borderX = `${Array(30).join('-')}\n`;
+
 const formatBytes = (bytes) => {
   if (bytes === 0) return '0 Byte'
   const k = 1000;
@@ -11,9 +12,25 @@ const formatBytes = (bytes) => {
   const i = Math.floor(Math.log(bytes) / Math.log(k));
   return parseFloat((bytes / Math.pow(k, i)).toFixed(dm)) + ' ' + sizes[i]
 };
-const shakenPct = (n, o) => Math.max((100 - ((n / o) * 100)).toFixed(2), 0);
+
+const shakenPct = (n = 0, o = 0) => {
+  const pct = Math.max((100 - ((n / o) * 100)).toFixed(2), 0);
+  return Number.isNaN(pct) ? 0 : pct
+};
+
 const match = (str, check) => str.indexOf(check) !== -1;
 
+const sizeOrCodeSize = (size, code) => {
+  if (size || size === 0) return size
+  return code ? Buffer.byteLength(code, 'utf8') : 0
+};
+
+const filterByType = {
+  function: (filter, m) => filter(m),
+  array: (filter, m) => filter.some((f) => match(m.id, f)),
+  string: (filter, m) => match(m.id, filter)
+};
+
 const reporter = (analysis, opts) => {
   const { hideDeps, root, showExports, summaryOnly } = opts || {};
 
@@ -72,57 +89,67 @@ const reporter = (analysis, opts) => {
 };
 
 const analyzer = (bundle, opts = {}) => {
-  const { limit, filter } = opts;
-  let { root, transformModuleId } = opts;
-  root = root || (process && process.cwd ? process.cwd() : null);
-  if (typeof transformModuleId !== 'function') transformModuleId = undefined;
-
-  const deps = {};
+  const { limit, filter, transformModuleId, filterSummary } = opts;
+  const root = opts.root || (process && process.cwd ? process.cwd() : null);
+  const idMod = typeof transformModuleId === 'function' && transformModuleId;
+  const filterType = Array.isArray(filter) ? 'array' : typeof filter;
+  const applyFilter = filterByType[filterType];
   const bundleModules = bundle.modules || (bundle.cache || {}).modules || [];
-  const moduleCount = bundleModules.length;
+  const deps = {};
 
+  let tmpBdlSize = 0;
   let bundleSize = 0;
   let bundleOrigSize = 0;
 
   let modules = bundleModules.map((m, i) => {
+    const id = idMod ? idMod(m.id.replace(root, '')) : m.id.replace(root, '');
     const {
-      originalLength: origSize,
+      originalLength,
       renderedLength,
-      code,
       renderedExports,
-      removedExports
+      removedExports,
+      originalCode,
+      code
     } = m;
-    let { id } = m;
-    id = id.replace(root, '');
-    if (transformModuleId) id = transformModuleId(id);
-    let size = renderedLength;
-    if (!size && size !== 0) size = code ? Buffer.byteLength(code, 'utf8') : 0;
-    bundleSize += size;
-    bundleOrigSize += origSize;
 
-    if (Array.isArray(filter) && !filter.some((f) => match(id, f))) return null
-    if (typeof filter === 'string' && !match(id, filter)) return null
+    const size = sizeOrCodeSize(renderedLength, code);
+    const origSize = sizeOrCodeSize(originalLength, originalCode);
+
+    tmpBdlSize += size;
 
     m.dependencies.forEach((d) => {
-      d = d.replace(root, '');
-      if (transformModuleId) d = transformModuleId(d);
+      d = idMod ? idMod(d.replace(root, '')) : d.replace(root, '');
       deps[d] = deps[d] || [];
       deps[d].push(id);
     });
 
     return { id, size, origSize, renderedExports, removedExports }
-  }).filter((m) => m);
+  }).filter((m) => m).sort((a, b) => b.size - a.size);
 
-  modules.sort((a, b) => b.size - a.size);
   if (limit || limit === 0) modules = modules.slice(0, limit);
-  modules.forEach((m) => {
+
+  modules = modules.map((m) => {
     m.dependents = deps[m.id] || [];
-    m.percent = Math.min(((m.size / bundleSize) * 100).toFixed(2), 100);
+    m.percent = Math.min(((m.size / tmpBdlSize) * 100).toFixed(2), 100);
     m.reduction = shakenPct(m.size, m.origSize);
-  });
-  if (typeof filter === 'function') modules = modules.filter(filter);
+
+    const filtered = applyFilter && !applyFilter(filter, m);
+    if (filtered && filterSummary) return null
+
+    bundleSize += m.size;
+    bundleOrigSize += m.origSize;
+
+    return filtered ? null : m
+  }).filter((m) => m);
+
+  if (filterSummary) {
+    modules.forEach((m) => {
+      m.percent = Math.min(((m.size / bundleSize) * 100).toFixed(2), 100);
+    });
+  }
 
   const bundleReduction = shakenPct(bundleSize, bundleOrigSize);
+  const moduleCount = (filterSummary ? modules : bundleModules).length;
 
   return { bundleSize, bundleOrigSize, bundleReduction, modules, moduleCount }
 };
diff --git a/module.js b/module.js
@@ -3,6 +3,7 @@
 const buf = ' '
 const tab = '  '
 const borderX = `${Array(30).join('-')}\n`
+
 const formatBytes = (bytes) => {
   if (bytes === 0) return '0 Byte'
   const k = 1000
@@ -11,9 +12,25 @@ const formatBytes = (bytes) => {
   const i = Math.floor(Math.log(bytes) / Math.log(k))
   return parseFloat((bytes / Math.pow(k, i)).toFixed(dm)) + ' ' + sizes[i]
 }
-const shakenPct = (n, o) => Math.max((100 - ((n / o) * 100)).toFixed(2), 0)
+
+const shakenPct = (n = 0, o = 0) => {
+  const pct = Math.max((100 - ((n / o) * 100)).toFixed(2), 0)
+  return Number.isNaN(pct) ? 0 : pct
+}
+
 const match = (str, check) => str.indexOf(check) !== -1
 
+const sizeOrCodeSize = (size, code) => {
+  if (size || size === 0) return size
+  return code ? Buffer.byteLength(code, 'utf8') : 0
+}
+
+const filterByType = {
+  function: (filter, m) => filter(m),
+  array: (filter, m) => filter.some((f) => match(m.id, f)),
+  string: (filter, m) => match(m.id, filter)
+}
+
 const reporter = (analysis, opts) => {
   const { hideDeps, root, showExports, summaryOnly } = opts || {}
 
@@ -72,57 +89,67 @@ const reporter = (analysis, opts) => {
 }
 
 const analyzer = (bundle, opts = {}) => {
-  const { limit, filter } = opts
-  let { root, transformModuleId } = opts
-  root = root || (process && process.cwd ? process.cwd() : null)
-  if (typeof transformModuleId !== 'function') transformModuleId = undefined
-
-  const deps = {}
+  const { limit, filter, transformModuleId, filterSummary } = opts
+  const root = opts.root || (process && process.cwd ? process.cwd() : null)
+  const idMod = typeof transformModuleId === 'function' && transformModuleId
+  const filterType = Array.isArray(filter) ? 'array' : typeof filter
+  const applyFilter = filterByType[filterType]
   const bundleModules = bundle.modules || (bundle.cache || {}).modules || []
-  const moduleCount = bundleModules.length
+  const deps = {}
 
+  let tmpBdlSize = 0
   let bundleSize = 0
   let bundleOrigSize = 0
 
   let modules = bundleModules.map((m, i) => {
+    const id = idMod ? idMod(m.id.replace(root, '')) : m.id.replace(root, '')
     const {
-      originalLength: origSize,
+      originalLength,
       renderedLength,
-      code,
       renderedExports,
-      removedExports
+      removedExports,
+      originalCode,
+      code
     } = m
-    let { id } = m
-    id = id.replace(root, '')
-    if (transformModuleId) id = transformModuleId(id)
-    let size = renderedLength
-    if (!size && size !== 0) size = code ? Buffer.byteLength(code, 'utf8') : 0
-    bundleSize += size
-    bundleOrigSize += origSize
 
-    if (Array.isArray(filter) && !filter.some((f) => match(id, f))) return null
-    if (typeof filter === 'string' && !match(id, filter)) return null
+    const size = sizeOrCodeSize(renderedLength, code)
+    const origSize = sizeOrCodeSize(originalLength, originalCode)
+
+    tmpBdlSize += size
 
     m.dependencies.forEach((d) => {
-      d = d.replace(root, '')
-      if (transformModuleId) d = transformModuleId(d)
+      d = idMod ? idMod(d.replace(root, '')) : d.replace(root, '')
       deps[d] = deps[d] || []
       deps[d].push(id)
     })
 
     return { id, size, origSize, renderedExports, removedExports }
-  }).filter((m) => m)
+  }).filter((m) => m).sort((a, b) => b.size - a.size)
 
-  modules.sort((a, b) => b.size - a.size)
   if (limit || limit === 0) modules = modules.slice(0, limit)
-  modules.forEach((m) => {
+
+  modules = modules.map((m) => {
     m.dependents = deps[m.id] || []
-    m.percent = Math.min(((m.size / bundleSize) * 100).toFixed(2), 100)
+    m.percent = Math.min(((m.size / tmpBdlSize) * 100).toFixed(2), 100)
     m.reduction = shakenPct(m.size, m.origSize)
-  })
-  if (typeof filter === 'function') modules = modules.filter(filter)
+
+    const filtered = applyFilter && !applyFilter(filter, m)
+    if (filtered && filterSummary) return null
+
+    bundleSize += m.size
+    bundleOrigSize += m.origSize
+
+    return filtered ? null : m
+  }).filter((m) => m)
+
+  if (filterSummary) {
+    modules.forEach((m) => {
+      m.percent = Math.min(((m.size / bundleSize) * 100).toFixed(2), 100)
+    })
+  }
 
   const bundleReduction = shakenPct(bundleSize, bundleOrigSize)
+  const moduleCount = (filterSummary ? modules : bundleModules).length
 
   return { bundleSize, bundleOrigSize, bundleReduction, modules, moduleCount }
 }
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "rollup-plugin-analyzer",
-  "version": "3.2.3",
+  "version": "3.3.0",
   "description": "Mad metrics for your rollup bundles, know all the things",
   "engines": {
     "node": ">=8.0.0"
diff --git a/test/test.js b/test/test.js
@@ -104,6 +104,22 @@ rollers.forEach(({ rollup, version, opts, noTreeshake }) => {
     assert.is((await analyze(bundle, { filter: hasMatch })).modules.length, 1)
   })
 
+  test(`${version}: filterSummary with string works`, async (assert) => {
+    const bundle = await rollup(opts)
+    const filter = 'jimmy'
+    const whenFalse = await analyze(bundle, { filter })
+    const whenTrue = await analyze(bundle, { filter, filterSummary: true })
+
+    assert.is(whenFalse.moduleCount, 5)
+    assert.is(whenTrue.moduleCount, 0)
+
+    assert.true(Math.abs(whenFalse.bundleSize - 11436) < 5)
+    assert.is(whenTrue.bundleSize, 0)
+
+    assert.true(Math.abs(whenFalse.bundleOrigSize - 11436) < 5)
+    assert.is(whenTrue.bundleOrigSize, 0)
+  })
+
   test(`${version}: transformModuleId works`, async (assert) => {
     const bundle = await rollup(opts)
     const transformModuleId = (id) => `transformed-${basename(id)}`
@@ -186,7 +202,7 @@ rollers.forEach(({ rollup, version, opts, noTreeshake }) => {
     await bundle.write(output)
     const imported = results.find((r) => r.id.indexOf(importA) !== -1)
     const expectSize = 27
-    assert.truthy(Math.abs(imported.size - expectSize) < 5)
+    assert.true(Math.abs(imported.size - expectSize) < 5)
   })
 
   test(`${version}: treeshaken bundle filters with callback`, async (assert) => {
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "rollup-plugin-analyzer",`
`3`		`- "version": "3.2.3",`
	`3`	`+ "version": "3.3.0",`
`4`	`4`	`"description": "Mad metrics for your rollup bundles, know all the things",`
`5`	`5`	`"engines": {`
`6`	`6`	`"node": ">=8.0.0"`