Add showExports option, expose exports in analysis

Author: doesdev

README.md

@@ -127,6 +127,10 @@ dependents:      1
   - type: Boolean
   - default: `false`
   - description: Don't itemize dependents in the formatted output
+- **showExports** - *optional*
+  - type: Boolean
+  - default: `false`
+  - description: Show used and unused exports
 - **writeTo** - *optional*
   - type: Function
   - default: `null`
@@ -151,6 +155,8 @@ dependents:      1
           - **dependents** *(Array)* - list of dependent module ids / paths
           - **percent** *(Number)* - percentage of module size relative to entire bundle
           - **reduction** *(Number)* - percentage of rendered size reduction
+          - **usedExports** *(Array)* - list of used named exports
+          - **unusedExports** *(Array)* - list of unused named exports
 
 
 ## License

index.js

@@ -17,7 +17,7 @@ const shakenPct = (n, o) => Math.max((100 - ((n / o) * 100)).toFixed(2), 0);
 const match = (str, check) => str.indexOf(check) !== -1;
 
 const analyze = (bundle, opts = {}, format = false) => {
-  let { root, limit, filter, hideDeps } = opts;
+  let { root, limit, filter, hideDeps, showExports } = opts;
   root = root || (process && process.cwd ? process.cwd() : null);
   let deps = {};
   let bundleSize = 0;
@@ -27,7 +27,14 @@ const analyze = (bundle, opts = {}, format = false) => {
 
   return new Promise((resolve, reject) => {
     let modules = bundleModules.map((m, i) => {
-      let { id, originalLength: origSize, renderedLength, code } = m;
+      let {
+        id,
+        originalLength: origSize,
+        renderedLength,
+        code,
+        usedExports,
+        unusedExports
+      } = m;
       id = id.replace(root, '');
       let size = renderedLength;
       if (!size && size !== 0) size = code ? Buffer.byteLength(code, 'utf8') : 0;
@@ -43,7 +50,7 @@ const analyze = (bundle, opts = {}, format = false) => {
         deps[d].push(id);
       });
 
-      return {id, size, origSize}
+      return {id, size, origSize, usedExports, unusedExports}
     }).filter((m) => m);
 
     modules.sort((a, b) => b.size - a.size);
@@ -79,11 +86,22 @@ const analyze = (bundle, opts = {}, format = false) => {
         `original size:  ${buf}${formatBytes(m.origSize || 'unknown')}\n` +
         `code reduction: ${buf}${m.reduction} %\n` +
         `dependents:     ${buf}${m.dependents.length}\n`;
+
       if (!hideDeps) {
         m.dependents.forEach((d) => {
           formatted += `${tab}-${buf}${d.replace(root, '')}\n`;
         });
       }
+      if (showExports && m.usedExports && m.unusedExports) {
+        formatted += `used exports:   ${buf}${m.usedExports.length}\n`;
+        m.usedExports.forEach((e) => {
+          formatted += `${tab}-${buf}${e}\n`;
+        });
+        formatted += `unused exports: ${buf}${m.unusedExports.length}\n`;
+        m.unusedExports.forEach((e) => {
+          formatted += `${tab}-${buf}${e}\n`;
+        });
+      }
       formatted += `${borderX}`;
     });
 
@@ -109,6 +127,8 @@ const plugin = (opts = {}) => {
       modules.forEach((m) => {
         let bm = bundle.modules[m.id];
         bm.id = bm.id || m.id;
+        bm.usedExports = bm.renderedExports || m.renderedExports;
+        bm.unusedExports = bm.removedExports || m.removedExports;
         bm.dependencies = m.dependencies || [];
       });
       modules = Object.keys(bundle.modules).map((k) => bundle.modules[k]);

module.js

@@ -15,7 +15,7 @@ const shakenPct = (n, o) => Math.max((100 - ((n / o) * 100)).toFixed(2), 0)
 const match = (str, check) => str.indexOf(check) !== -1
 
 export const analyze = (bundle, opts = {}, format = false) => {
-  let { root, limit, filter, hideDeps } = opts
+  let { root, limit, filter, hideDeps, showExports } = opts
   root = root || (process && process.cwd ? process.cwd() : null)
   let deps = {}
   let bundleSize = 0
@@ -25,7 +25,14 @@ export const analyze = (bundle, opts = {}, format = false) => {
 
   return new Promise((resolve, reject) => {
     let modules = bundleModules.map((m, i) => {
-      let { id, originalLength: origSize, renderedLength, code } = m
+      let {
+        id,
+        originalLength: origSize,
+        renderedLength,
+        code,
+        usedExports,
+        unusedExports
+      } = m
       id = id.replace(root, '')
       let size = renderedLength
       if (!size && size !== 0) size = code ? Buffer.byteLength(code, 'utf8') : 0
@@ -41,7 +48,7 @@ export const analyze = (bundle, opts = {}, format = false) => {
         deps[d].push(id)
       })
 
-      return {id, size, origSize}
+      return {id, size, origSize, usedExports, unusedExports}
     }).filter((m) => m)
 
     modules.sort((a, b) => b.size - a.size)
@@ -77,11 +84,22 @@ export const analyze = (bundle, opts = {}, format = false) => {
         `original size:  ${buf}${formatBytes(m.origSize || 'unknown')}\n` +
         `code reduction: ${buf}${m.reduction} %\n` +
         `dependents:     ${buf}${m.dependents.length}\n`
+
       if (!hideDeps) {
         m.dependents.forEach((d) => {
           formatted += `${tab}-${buf}${d.replace(root, '')}\n`
         })
       }
+      if (showExports && m.usedExports && m.unusedExports) {
+        formatted += `used exports:   ${buf}${m.usedExports.length}\n`
+        m.usedExports.forEach((e) => {
+          formatted += `${tab}-${buf}${e}\n`
+        })
+        formatted += `unused exports: ${buf}${m.unusedExports.length}\n`
+        m.unusedExports.forEach((e) => {
+          formatted += `${tab}-${buf}${e}\n`
+        })
+      }
       formatted += `${borderX}`
     })
 
@@ -107,6 +125,8 @@ export const plugin = (opts = {}) => {
       modules.forEach((m) => {
         let bm = bundle.modules[m.id]
         bm.id = bm.id || m.id
+        bm.usedExports = bm.renderedExports || m.renderedExports
+        bm.unusedExports = bm.removedExports || m.removedExports
         bm.dependencies = m.dependencies || []
       })
       modules = Object.keys(bundle.modules).map((k) => bundle.modules[k])

package.json

@@ -1,6 +1,6 @@
 {
   "name": "rollup-plugin-analyzer",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "Mad metrics for your rollup bundles, know all the things",
   "main": "index.js",
   "module": "module.js",

rollup.config.js

@@ -1,16 +1,9 @@
 'use strict'
 
 import { plugin } from './module'
-const limitBytes = 1e6
-
-const onAnalysis = ({bundleSize}) => {
-  if (bundleSize < limitBytes) return
-  console.log(`Bundle size exceeds ${limitBytes} bytes: ${bundleSize} bytes`)
-  return process.exit(1)
-}
 
 export default {
-  plugins: [plugin({onAnalysis})],
+  plugins: [plugin()],
   input: 'module.js',
   output: {
     file: 'index.js',

test/test.js

@@ -119,7 +119,8 @@ rollers.forEach(({rollup, version, opts, noTreeshake}) => {
   test(`${version}: plugin writes expected results`, async (assert) => {
     let results
     let writeTo = (r) => { results = r }
-    let rollOpts = Object.assign({plugins: [plugin({writeTo, version})]}, opts)
+    let showExports = true
+    let rollOpts = Object.assign({plugins: [plugin({writeTo, showExports})]}, opts)
     let bundle = await rollup(rollOpts)
     await bundle.generate({format: 'cjs'})
     assert.is(results.substr(0, expectHeader.length), expectHeader)