Limit does not affect filter, 4.0.0 release

Author: doesdev

CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to this project will be documented in this file. Dates are displayed in UTC.
 
+### [4.0.0](https://github.com/doesdev/rollup-plugin-analyzer/compare/3.3.0...4.0.0)
+
+> 19 December 2020
+
+- **[BREAKING]** Limit does not affect summary (unless `filterSummary === true`)
+- [DEV] Update dev dependencies (standard, husky)
+- [DEV] Fix standard style issue
+- [DOCS] Add FAQ to readme
+- [DOCS] Add TOC to readme
+
 ### [3.3.0](https://github.com/doesdev/rollup-plugin-analyzer/compare/3.2.3...3.3.0)
 
 > 8 July 2020

README.md

@@ -4,11 +4,21 @@
 
 [![npm](https://img.shields.io/npm/v/rollup-plugin-analyzer?style=for-the-badge)](https://npmjs.org/package/rollup-plugin-analyzer)   [![Travis (.com)](https://img.shields.io/travis/com/doesdev/rollup-plugin-analyzer?style=for-the-badge)](https://travis-ci.com/doesdev/rollup-plugin-analyzer)   [![Dependents (via libraries.io)](https://img.shields.io/librariesio/dependents/npm/rollup-plugin-analyzer?style=for-the-badge)](https://github.com/doesdev/rollup-plugin-analyzer/network/dependents)   [![npm](https://img.shields.io/npm/dm/rollup-plugin-analyzer?style=for-the-badge)](https://npmcharts.com/compare/rollup-plugin-analyzer?minimal=true&interval=7)
 
-## rollup-plugin-analyzer
-
-See what's bloating your bundle, how treeshaking has treated you, and other
-great stuff. Perfect for console printing an analysis of your bundle or
-integrating in your CI workflows.
+## TOC
+
+- [Install](#install)
+- [Usage](#usage)
+  + [Importing or Requiring](#importing-or-requiring)
+    - [Import as ES Module](#import-as-es-module)
+    - [Requiring as CJS](#requiring-as-cjs)
+  + [Usage from rollup config](#usage-from-rollup-config)
+  + [Usage from build script](#usage-from-build-script)
+  + [CI usage example](#ci-usage-example)
+  + [Example results](#results)
+  + [Example results (with `summaryOnly` enabled)](#results--with--summaryonly--enabled-)
+- [Options](#options)
+- [FAQ](#faq)
+- [License](#license)
 
 ## Install
 
@@ -148,7 +158,7 @@ module count:   5
 - **filterSummary** - *optional*
   - type: Boolean
   - default: `false`
-  - description: If `true` the `filter` option will also remove any filtered out module data from the summary
+  - description: If `true` the `filter` and `limit` options will also remove any filtered out module data from the summary
 - **root** - *optional*
   - type: String
   - default: `process.cwd()`
@@ -205,11 +215,19 @@ module count:   5
           - **renderedExports** *(Array)* - list of used named exports
           - **removedExports** *(Array)* - list of unused named exports
 
-## Other considerations
+## FAQ
+
+#### Why is the reported size not the same as the file on disk?
+
+This module is geared towards the details of the individual modules that make up the bundle and their relative impact to bundle size. That's a detailed way of saying, it doesn't really care about size on disk. There are other options which focus on size on disk as well as delivery size which can be used alongside this module (or in place of if your concern is not per module impact). In particular [rollup-plugin-size-snapshot](https://github.com/TrySound/rollup-plugin-size-snapshot) seems like a great option for that.
+
+Getting a bit further into the details, rather than just intent, of why the reported size differs from that on disk. We get the module data from Rollup which reports it after chunk (module) resolution and tree-shaking, but before post-processing (such as minification and compression). We then add the sizes of each of those modules together, this is the `bundle size` that we report.
+
+That means it won't account for post-processing from other plugins and also won't account for post-processing by Rollup itself, which includes boilerplate / shims depending on what the output format is (CJS, ESM, iife, etc...).
+
+#### Why am I seeing multiple analysis outputs emitted?
 
-Rollup allows you to output to multiple files. If you are outputting to multiple
-files you will get a distinct analysis for each output file. Each analysis
-will contain data on the files imported by the respective target.
+Rollup allows you to output to multiple files. If you are outputting to multiple files you will get a distinct analysis for each output file. Each analysis will contain data on the files imported by the respective target.
 
 ## License
 

index.js

@@ -56,7 +56,7 @@ const reporter = (analysis, opts) => {
     const summaryBar = `${id}\n${rawBar} ${m.percent} % (${size})`;
     const bar = !summaryOnly ? rawBar : summaryBar;
 
-    formatted += summaryOnly ? `${bar}\n` : '' +
+    const detailed = !summaryOnly && '' +
       `${bar}\n` +
       `file:           ${buf}${id}\n` +
       `bundle space:   ${buf}${m.percent} %\n` +
@@ -65,6 +65,8 @@ const reporter = (analysis, opts) => {
       `code reduction: ${buf}${m.reduction} %\n` +
       `dependents:     ${buf}${m.dependents.length}\n`;
 
+    formatted += summaryOnly ? `${bar}\n` : detailed;
+
     if (!hideDeps && !summaryOnly) {
       m.dependents.forEach((d) => {
         formatted += `${tab}-${buf}${d.replace(root, '').replace(/\\/g, '/')}\n`;
@@ -126,20 +128,19 @@ const analyzer = (bundle, opts = {}) => {
     return { id, size, origSize, renderedExports, removedExports }
   }).filter((m) => m).sort((a, b) => b.size - a.size);
 
-  if (limit || limit === 0) modules = modules.slice(0, limit);
-
-  modules = modules.map((m) => {
+  modules = modules.map((m, i) => {
     m.dependents = deps[m.id] || [];
     m.percent = Math.min(((m.size / tmpBdlSize) * 100).toFixed(2), 100);
     m.reduction = shakenPct(m.size, m.origSize);
 
     const filtered = applyFilter && !applyFilter(filter, m);
-    if (filtered && filterSummary) return null
+    const limited = !Number.isNaN(+limit) && i >= limit;
+    if ((limited || filtered) && filterSummary) return null
 
     bundleSize += m.size;
     bundleOrigSize += m.origSize;
 
-    return filtered ? null : m
+    return (limited || filtered) ? null : m
   }).filter((m) => m);
 
   if (filterSummary) {

module.js

@@ -56,7 +56,7 @@ const reporter = (analysis, opts) => {
     const summaryBar = `${id}\n${rawBar} ${m.percent} % (${size})`
     const bar = !summaryOnly ? rawBar : summaryBar
 
-    formatted += summaryOnly ? `${bar}\n` : '' +
+    const detailed = !summaryOnly && '' +
       `${bar}\n` +
       `file:           ${buf}${id}\n` +
       `bundle space:   ${buf}${m.percent} %\n` +
@@ -65,6 +65,8 @@ const reporter = (analysis, opts) => {
       `code reduction: ${buf}${m.reduction} %\n` +
       `dependents:     ${buf}${m.dependents.length}\n`
 
+    formatted += summaryOnly ? `${bar}\n` : detailed
+
     if (!hideDeps && !summaryOnly) {
       m.dependents.forEach((d) => {
         formatted += `${tab}-${buf}${d.replace(root, '').replace(/\\/g, '/')}\n`
@@ -126,20 +128,19 @@ const analyzer = (bundle, opts = {}) => {
     return { id, size, origSize, renderedExports, removedExports }
   }).filter((m) => m).sort((a, b) => b.size - a.size)
 
-  if (limit || limit === 0) modules = modules.slice(0, limit)
-
-  modules = modules.map((m) => {
+  modules = modules.map((m, i) => {
     m.dependents = deps[m.id] || []
     m.percent = Math.min(((m.size / tmpBdlSize) * 100).toFixed(2), 100)
     m.reduction = shakenPct(m.size, m.origSize)
 
     const filtered = applyFilter && !applyFilter(filter, m)
-    if (filtered && filterSummary) return null
+    const limited = !Number.isNaN(+limit) && i >= limit
+    if ((limited || filtered) && filterSummary) return null
 
     bundleSize += m.size
     bundleOrigSize += m.origSize
 
-    return filtered ? null : m
+    return (limited || filtered) ? null : m
   }).filter((m) => m)
 
   if (filterSummary) {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "rollup-plugin-analyzer",
-  "version": "3.3.0",
+  "version": "4.0.0",
   "description": "Mad metrics for your rollup bundles, know all the things",
   "engines": {
     "node": ">=8.0.0"
@@ -47,11 +47,11 @@
   },
   "homepage": "http://rollup-plugin-analyzer.doesdev.com/",
   "devDependencies": {
-    "husky": "^4.2.5",
-    "mvt": "4.1.0",
+    "husky": "^4.3.6",
+    "mvt": "4.1.1",
     "rollup": "npm:rollup@latest",
     "rollup100": "npm:rollup@1.0.x",
-    "standard": "^14.3.4"
+    "standard": "^16.0.3"
   },
   "dependencies": {}
 }

test/test.js

@@ -78,6 +78,32 @@ rollers.forEach(({ rollup, version, opts, noTreeshake }) => {
     assert.is((await analyze(bundle, { limit: 0 })).modules.length, 0)
   })
 
+  test(`${version}: limit does not affect summary by default`, async (assert) => {
+    let results
+    const writeTo = (r) => { results = r }
+    const rollOpts = Object.assign(
+      { plugins: [plugin({ writeTo, limit: 0 })] },
+      opts
+    )
+    const bundle = await rollup(rollOpts)
+    await bundle.generate({ format: 'cjs' })
+
+    assert.doesNotContain(results, '0 Byte')
+  })
+
+  test(`${version}: limit respects filterSummary`, async (assert) => {
+    let results
+    const writeTo = (r) => { results = r }
+    const rollOpts = Object.assign(
+      { plugins: [plugin({ writeTo, limit: 0, filterSummary: true })] },
+      opts
+    )
+    const bundle = await rollup(rollOpts)
+    await bundle.generate({ format: 'cjs' })
+
+    assert.contains(results, '0 Byte')
+  })
+
   test(`${version}: filter with array works`, async (assert) => {
     const bundle = await rollup(opts)
     assert.is(