Add ability to filter with callback, 2.0.2

Author: doesdev

README.md

@@ -30,24 +30,43 @@ $ npm install --save-dev rollup-plugin-analyzer
 ### from rollup config
 ```js
 import { plugin as analyze } from 'rollup-analyzer-plugin'
-const opts = {limit: 5, filter: [], root: __dirname}
+
 export default {
   entry: 'module.js',
   dest: 'index.js',
   format: 'cjs',
-  plugins: [analyze(opts)]
+  plugins: [analyze()]
 }
 ```
 
 ### from build script
 ```js
 import { rollup } from 'rollup'
 import { plugin as analyze } from 'rollup-analyzer-plugin'
-const opts = {limit: 5, filter: [], root: __dirname}
 
 rollup({
   entry: 'main.js',
-  plugins: [analyze(opts)]
+  plugins: [analyze()]
+}).then(...)
+```
+
+### CI usage example
+```js
+import { rollup } from 'rollup'
+import { plugin as analyze } from 'rollup-analyzer-plugin'
+const limitBytes = 1e6
+
+const onAnalysis = ({bundleSize}) => {
+  if (bundleSize < limitBytes) return
+  console.log(`Bundle size exceeds ${limitBytes} bytes: ${bundleSize} bytes`)
+  return process.exit(1)
+}
+import { rollup } from 'rollup'
+import { plugin as analyze } from 'rollup-analyzer-plugin'
+
+rollup({
+  entry: 'main.js',
+  plugins: [analyze({onAnalysis})]
 }).then(...)
 ```
 
@@ -97,9 +116,10 @@ dependents:      1
   - default: `null`
   - description: Limit number of files to output analysis of, sorted by DESC size
 - **filter** - *optional*
-  - type: Array | String
+  - type: Array | String | Function
   - default: `null`
   - description: Filter to only show imports matching the specified name(s)
+  - notes: Function receives `module` object specified below, should return boolean
 - **root** - *optional*
   - type: String
   - default: `process.cwd()`

index.js

@@ -14,6 +14,7 @@ const formatBytes = (bytes) => {
   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 match = (str, check) => str.indexOf(check) !== -1;
 
 const analyze = (bundle, opts = {}, format = false) => {
   let { root, limit, filter, hideDeps } = opts;
@@ -32,8 +33,8 @@ const analyze = (bundle, opts = {}, format = false) => {
       bundleSize += size;
       bundleOrigSize += origSize;
 
-      if (Array.isArray(filter) && !filter.some((f) => id.match(f))) return null
-      if (typeof filter === 'string' && !id.match(filter)) return null
+      if (Array.isArray(filter) && !filter.some((f) => match(id, f))) return null
+      if (typeof filter === 'string' && !match(id, filter)) return null
 
       m.dependencies.forEach((d) => {
         d = d.replace(root, '');
@@ -51,6 +52,7 @@ const analyze = (bundle, opts = {}, format = false) => {
       m.percent = Math.min(((m.size / bundleSize) * 100).toFixed(2), 100);
       m.reduction = shakenPct(m.size, m.origSize);
     });
+    if (typeof filter === 'function') modules = modules.filter(filter);
 
     let bundleReduction = shakenPct(bundleSize, bundleOrigSize);
 

module.js

@@ -12,6 +12,7 @@ const formatBytes = (bytes) => {
   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 match = (str, check) => str.indexOf(check) !== -1
 
 export const analyze = (bundle, opts = {}, format = false) => {
   let { root, limit, filter, hideDeps } = opts
@@ -30,8 +31,8 @@ export const analyze = (bundle, opts = {}, format = false) => {
       bundleSize += size
       bundleOrigSize += origSize
 
-      if (Array.isArray(filter) && !filter.some((f) => id.match(f))) return null
-      if (typeof filter === 'string' && !id.match(filter)) return null
+      if (Array.isArray(filter) && !filter.some((f) => match(id, f))) return null
+      if (typeof filter === 'string' && !match(id, filter)) return null
 
       m.dependencies.forEach((d) => {
         d = d.replace(root, '')
@@ -49,6 +50,7 @@ export const analyze = (bundle, opts = {}, format = false) => {
       m.percent = Math.min(((m.size / bundleSize) * 100).toFixed(2), 100)
       m.reduction = shakenPct(m.size, m.origSize)
     })
+    if (typeof filter === 'function') modules = modules.filter(filter)
 
     let bundleReduction = shakenPct(bundleSize, bundleOrigSize)
 

package.json

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

rollup.config.js

@@ -1,8 +1,16 @@
 '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()],
+  plugins: [plugin({onAnalysis})],
   input: 'module.js',
   output: {
     file: 'index.js',

test/test.js

@@ -89,6 +89,14 @@ rollers.forEach(({rollup, version, opts, noTreeshake}) => {
     assert.is((await analyze(bundle, {filter: 'import-b'})).modules.length, 1)
   })
 
+  test(`${version}: filter with callback works`, async (assert) => {
+    let bundle = await rollup(opts)
+    let noMatch = (m) => m.id.indexOf('jimmy') !== -1
+    let hasMatch = (m) => m.id.indexOf('import-b') !== -1
+    assert.is((await analyze(bundle, {filter: noMatch})).modules.length, 0)
+    assert.is((await analyze(bundle, {filter: hasMatch})).modules.length, 1)
+  })
+
   test(`${version}: root works as expected`, async (assert) => {
     let bundle = await rollup(opts)
     assert.not(
@@ -114,7 +122,6 @@ rollers.forEach(({rollup, version, opts, noTreeshake}) => {
     let rollOpts = Object.assign({plugins: [plugin({writeTo})]}, opts)
     let bundle = await rollup(rollOpts)
     await bundle.generate({format: 'cjs'})
-    if (version === 'latest') console.log(results)
     assert.is(results.substr(0, expectHeader.length), expectHeader)
   })
 
@@ -130,5 +137,17 @@ rollers.forEach(({rollup, version, opts, noTreeshake}) => {
       let imported = results.find((r) => r.id.indexOf('import-a') !== -1)
       assert.is(imported.size, 27)
     })
+
+    test(`${version}: treeshaken bundle filters with callback`, async (assert) => {
+      let results
+      let filter = (m) => m.size > 2000
+      let onAnalysis = (r) => { results = r.modules }
+      let plugins = [plugin({onAnalysis, filter})]
+      let rollOpts = Object.assign({}, opts, {plugins})
+      let bundle = await rollup(rollOpts)
+      let output = {file: join(fixtures, 'output.js'), format: 'cjs'}
+      await bundle.write(output)
+      assert.is(results.length, 1)
+    })
   }
 })

yarn.lock

@@ -2246,7 +2246,7 @@ rimraf@^2.6.1:
     "@types/estree" "0.0.39"
     "@types/node" "*"
 
-rollup@^0.60.1:
+rollup@latest:
   version "0.60.1"
   resolved "https://registry.yarnpkg.com/rollup/-/rollup-0.60.1.tgz#07cb66153f1541d5f7e82b8393b405c31647dae9"
   dependencies: