Prettier reporter to beta port (#325)

* add matched path info to files

* get colors from ava

* rewrite reporter

* add compression to output

* update snapsohts

* rename tiny things

* clean up main function

* update snapshots

* tiny change, big cleanup

* tiny refactor

* move things around

Author: siddharthkp

index.js

@@ -1,22 +1,23 @@
 #!/usr/bin/env node
 
-const { inspect } = require('util')
-const config = require('./src/files')
-const analyse = require('./src/analyse')
+const files = require('./src/pipeline/files')
+const analyse = require('./src/pipeline/analyse')
+
 const cli = require('./src/reporters/cli')
-const reporter = require('./src/reporter')
-const build = require('./src/build')
+const github = require('./src/reporters/github')
+const build = require('./src/reporters/build')
 
-const report = analyse(config)
-cli.report(report)
-// broke this
+// old reporter
+const reporter = require('./src/reporter')
 // reporter(report.files)
 
-process.on('unhandledRejection', function(reason) {
-  console.log('Unhandled Promise')
-  console.log(inspect(reason))
-  build.error()
-})
+try {
+  const results = analyse(files)
+  cli.report(results)
+  build.report(results)
+} catch (err) {
+  build.error(err)
+}
 
 /*
   This is the ideal structure to get to:

src/analyse.js

@@ -0,0 +1,38 @@
+/*
+  loop through files and add
+  pass: true|false
+*/
+
+const bytes = require('bytes')
+
+function analyse(config) {
+  const counter = { pass: 0, fail: 0 }
+
+  const files = config.files.map(function(row) {
+    row.filesMatched.map(function(file) {
+      const parsedFileSize = bytes.parse(file.size)
+      const parsedMaxSize = bytes.parse(row.maxSize)
+
+      if (parsedFileSize > parsedMaxSize) {
+        file.pass = false
+        file.operator = '>'
+      } else if (parsedFileSize < parsedMaxSize) {
+        file.pass = true
+        file.operator = '<'
+      } else {
+        file.pass = true
+        file.operator = '='
+      }
+
+      if (file.pass) counter.pass++
+      else counter.fail++
+    })
+    return row
+  })
+
+  const status = counter.fail ? 'fail' : 'pass'
+
+  return { files, counter, status }
+}
+
+module.exports = analyse

src/pipeline/analyse.js

@@ -1,9 +1,9 @@
 const cosmiconfig = require('cosmiconfig')
+const { error } = require('prettycli')
+const program = require('commander')
 const fs = require('fs')
 
-const program = require('commander')
-const { error } = require('prettycli')
-const debug = require('./debug')
+const debug = require('../utils/debug')
 
 // default places we check
 const configPaths = ['package.json', 'bundlesize.config.json']

src/config.js renamed to src/pipeline/config.js

@@ -1,10 +1,11 @@
 const fs = require('fs')
-const bytes = require('bytes')
 const glob = require('glob')
+const bytes = require('bytes')
 const { error } = require('prettycli')
+
 const config = require('./config')
-const debug = require('./debug')
-const compressedSize = require('./compressed-size')
+const debug = require('../utils/debug')
+const compressedSize = require('../utils/compressed-size')
 
 config.files.map(row => {
   row.filesMatched = []

src/files.js renamed to src/pipeline/files.js

@@ -0,0 +1,22 @@
+const colors = require('../utils/colors')
+
+function pass() {
+  // do nothing
+}
+
+function fail() {
+  process.exit(1)
+}
+
+function error(err) {
+  console.log(colors.fail('The build has an error: \n'))
+  console.log(err)
+  fail()
+}
+
+function report(results) {
+  if (results.status === 'fail') fail()
+  else pass()
+}
+
+module.exports = { report, error }

src/reporters/build.js

@@ -6,33 +6,27 @@ const plur = require('plur')
 const colors = require('../utils/colors')
 
 function report(results) {
-  const maxFileLength = getMaxFileLenght(results)
+  const files = results.files
 
-  const counter = { pass: 0, fail: 0 }
+  const maxFileLength = getMaxFileLenght(files)
 
-  results.forEach(function(row) {
+  files.forEach(function(row) {
     printBlockHeader(row)
 
     row.filesMatched.forEach(function(file) {
       printRow(file, row, maxFileLength)
-
-      if (file.pass) counter.pass++
-      else counter.fail++
     })
   })
 
-  printSummary(counter)
-
-  // exit with error code 1 if there are any failed checks
-  if (counter.fail) process.exit(1)
+  printSummary(results.counter)
 }
 
 module.exports = { report }
 
-function getMaxFileLenght(results) {
+function getMaxFileLenght(files) {
   let maxFileLength = 0
 
-  results.forEach(function(row) {
+  files.forEach(function(row) {
     row.filesMatched.forEach(function(file) {
       if (file.path.length > maxFileLength) maxFileLength = file.path.length
     })
@@ -48,7 +42,7 @@ function printBlockHeader(row) {
 
 function printRow(file, row, maxFileLength) {
   const symbol = getSymbol(file)
-  const operator = getOperator(file, row)
+  const operator = getOperator(file)
 
   console.log(
     ' ',
@@ -75,11 +69,12 @@ function getSymbol(file) {
   return file.pass ? colors.pass(figures.tick) : colors.fail(figures.cross)
 }
 
-function getOperator(file, row) {
-  const fileSize = bytes.parse(file.size)
-  const maxSize = bytes.parse(row.maxSize)
+function getOperator(file) {
+  const map = {
+    '>': colors.fail('>'),
+    '<': colors.pass('<'),
+    '=': colors.pass('=')
+  }
 
-  if (fileSize > maxSize) return colors.fail('>')
-  if (fileSize === maxSize) return colors.pass('=')
-  return colors.pass('<')
+  return map[file.operator]
 }

src/reporters/cli.js

@@ -1,11 +1,11 @@
 const { error } = require('prettycli')
 const zlib = require('zlib')
 
-const config = require('./config')
+const config = require('../pipeline/config')
 
 function getBrotliSync() {
   // Does this project want brotli compression?
-  const needsBrotli = config.find(row => row.compression === 'brotli')
+  const needsBrotli = config.files.find(row => row.compression === 'brotli')
 
   // If it doesn't, save us the trouble.
   if (!needsBrotli) return null