Restructure to support extending to other report types

tapjs · Mar 25, 2019 · f726bb8 · f726bb8
1 parent 8d6cc42
commit f726bb8
Show file tree

Hide file tree

Showing 53 changed files with 524 additions and 747 deletions.
diff --git a/index.test.js b/index.test.js
@@ -0,0 +1,2 @@
+const t = require('tap')
+t.ok(require('./index.js'))
diff --git a/test/cardinal-theme.js → lib/cardinal-theme.test.js b/test/cardinal-theme.js → lib/cardinal-theme.test.js
@@ -1,6 +1,6 @@
-require('./term-setup.js')
+require('./term-setup.test.js')
 const t = require('tap')
-const theme = require('../lib/cardinal-theme.js')
+const theme = require('./cardinal-theme.js')
 t.match(theme, { Boolean: { _default: Function }})
 
 const c = require('chalk')
@@ -19,14 +19,3 @@ const str = theme.String._default('str', {
 t.equal(str, c.greenBright('str'), 'strings are bright')
 
 t.equal(theme.Boolean._default('true'), c.redBright('true'), 'red as boold')
-
-/*
-_default: function(s, info) {
-  var nextToken = info.tokens[info.tokenIndex + 1]
-
-  // show keys of object literals and json in different color
-  return (nextToken && nextToken.type === 'Punctuator' && nextToken.value === ':')
-    ? green(s)
-    : greenBright(s)
-}
-*/
diff --git a/lib/index.js b/lib/index.js
@@ -1,6 +1,18 @@
 const React = require('react')
-const importJSX = require('import-jsx')
-const Report = importJSX('./report.js')
 const {render} = require('ink')
+const importJSX = require('import-jsx')
 /* istanbul ignore next */
-module.exports = tap => render(<Report tap={tap} />)
+module.exports = (tap, reporter = 'base') => {
+  if (!types.includes(reporter))
+    throw new Error('unsupported report type: ' + reporter)
+
+  const Report = importJSX('./reports/' + reporter)
+  render(<Report tap={tap} />)
+}
+
+const fs = require('fs')
+const types = module.exports.types = fs.readdirSync(__dirname + '/reports')
+types.forEach(type => Object.defineProperty(module.exports, type, {
+  get: importJSX(`./reports/${type}`),
+  enumerable: true,
+}))
diff --git a/lib/index.test.js b/lib/index.test.js
@@ -0,0 +1,2 @@
+const t = require('tap')
+t.ok(require('import-jsx')('./index.js'))
diff --git a/test/pretty-diff.js → lib/pretty-diff.test.js b/test/pretty-diff.js → lib/pretty-diff.test.js
@@ -1,6 +1,6 @@
-require('./term-setup.js')
+require('./term-setup.test.js')
 const t = require('tap')
-const pretty = require('../lib/pretty-diff.js')
+const pretty = require('./pretty-diff.js')
 
 t.equal(pretty(), null)
 

diff --git a/test/pretty-source.js → lib/pretty-source.test.js b/test/pretty-source.js → lib/pretty-source.test.js
@@ -1,5 +1,5 @@
-require('./term-setup.js')
-const pretty = require('../lib/pretty-source.js')
+require('./term-setup.test.js')
+const pretty = require('./pretty-source.js')
 const t = require('tap')
 const fs = require('fs')
 const path = require('path')

diff --git a/lib/assert-counts.js → lib/reports/base/assert-counts.js b/lib/assert-counts.js → lib/reports/base/assert-counts.js
diff --git a/test/assert-counts.jsx → lib/reports/base/assert-counts.test.jsx b/test/assert-counts.jsx → lib/reports/base/assert-counts.test.jsx
@@ -1,9 +1,9 @@
-require('./term-setup.js')
+require('../../term-setup.test.js')
 const React = require('react')
 const importJSX = require('import-jsx')
 const {render} = require('ink-testing-library')
 const t = require('tap')
-const AssertCounts = importJSX('../lib/assert-counts.js')
+const AssertCounts = importJSX('./assert-counts.js')
 
 const cases = [
   [0, 0, 0, 0],

diff --git a/lib/assert-name.js → lib/reports/base/assert-name.js b/lib/assert-name.js → lib/reports/base/assert-name.js
diff --git a/test/assert-name.jsx → lib/reports/base/assert-name.test.jsx b/test/assert-name.jsx → lib/reports/base/assert-name.test.jsx
@@ -1,8 +1,8 @@
-require('./term-setup.js')
+require('../../term-setup.test.js')
 const React = require('react')
 const importJSX = require('import-jsx')
 const t = require('tap')
-const AssertName = importJSX('../lib/assert-name.js')
+const AssertName = importJSX('./assert-name.js')
 const {render} = require('ink-testing-library')
 
 const ok = [ true, false ]

diff --git a/lib/counts.js → lib/reports/base/counts.js b/lib/counts.js → lib/reports/base/counts.js
diff --git a/test/counts.js → lib/reports/base/counts.test.js b/test/counts.js → lib/reports/base/counts.test.js
@@ -1,6 +1,6 @@
-require('./term-setup.js')
+require('../../term-setup.test.js')
 const t = require('tap')
-const counts = require('../lib/counts.js')
+const counts = require('./counts.js')
 
 const cases = [
   [0,0,0,0],

diff --git a/lib/report.js → lib/reports/base/index.js b/lib/report.js → lib/reports/base/index.js
@@ -6,11 +6,20 @@ const Parser = require('tap-parser')
 const chalk = require('chalk')
 
 const Summary = importJSX('./summary.js')
-const Result = importJSX('./result.js')
 const Runs = importJSX('./runs.js')
 const Log = importJSX('./log.js')
 
 class Report extends React.Component {
+  get Summary () {
+    return Summary
+  }
+  get Runs () {
+    return Runs
+  }
+  get Log () {
+    return Log
+  }
+
   constructor ({ tap }) {
     super()
 
@@ -201,9 +210,9 @@ class Report extends React.Component {
   render () {
     return (
       <Box flexDirection="column">
-        <Log log={this.state.log} />
-        <Runs runs={this.state.runs} />
-        <Summary
+        <this.Log log={this.state.log} />
+        <this.Runs runs={this.state.runs} />
+        <this.Summary
           results={this.state.results || null}
           counts={this.state.counts}
           time={this.state.time}

diff --git a/test/report.jsx → lib/reports/base/index.test.jsx b/test/report.jsx → lib/reports/base/index.test.jsx
@@ -1,7 +1,7 @@
-require('./term-setup.js')
+require('../../term-setup.test.js')
 const importJSX = require('import-jsx')
 const React = require('react')
-const Report = importJSX('../lib/report.js')
+const Report = importJSX('./index.js')
 const t = require('tap')
 const {Test} = t
 const {render, cleanup} = require('ink-testing-library')

diff --git a/lib/log.js → lib/reports/base/log.js b/lib/log.js → lib/reports/base/log.js
diff --git a/test/log.jsx → lib/reports/base/log.test.jsx b/test/log.jsx → lib/reports/base/log.test.jsx
@@ -1,7 +1,7 @@
-require('./term-setup.js')
+require('../../term-setup.test.js')
 const importJSX = require('import-jsx')
 const React = require('react')
-const Log = importJSX('../lib/log.js')
+const Log = importJSX('./log.js')
 const t = require('tap')
 const {render} = require('ink-testing-library')
 

diff --git a/lib/pass-fail.js → lib/reports/base/pass-fail.js b/lib/pass-fail.js → lib/reports/base/pass-fail.js
diff --git a/test/pass-fail.jsx → lib/reports/base/pass-fail.test.jsx b/test/pass-fail.jsx → lib/reports/base/pass-fail.test.jsx
@@ -1,8 +1,8 @@
-require('./term-setup.js')
+require('../../term-setup.test.js')
 const React = require('react')
 const t = require('tap')
 const importJSX = require('import-jsx')
-const PassFail = importJSX('../lib/pass-fail.js')
+const PassFail = importJSX('./pass-fail.js')
 const {render} = require('ink-testing-library')
 
 const r = render(<PassFail ok={true} name="this is fine" />)

diff --git a/lib/result.js → lib/reports/base/result.js b/lib/result.js → lib/reports/base/result.js
diff --git a/test/result.jsx → lib/reports/base/result.test.jsx b/test/result.jsx → lib/reports/base/result.test.jsx
@@ -1,8 +1,8 @@
-require('./term-setup.js')
+require('../../term-setup.test.js')
 const React = require('react')
 const t = require('tap')
 const importJSX = require('import-jsx')
-const Result = importJSX('../lib/result.js')
+const Result = importJSX('./result.js')
 const {render} = require('ink-testing-library')
 
 const r = render(<Result raw="hello" />)

diff --git a/lib/runs.js → lib/reports/base/runs.js b/lib/runs.js → lib/reports/base/runs.js
diff --git a/test/runs.jsx → lib/reports/base/runs.test.jsx b/test/runs.jsx → lib/reports/base/runs.test.jsx
@@ -1,7 +1,7 @@
-require('./term-setup.js')
+require('../../term-setup.test.js')
 const importJSX = require('import-jsx')
 const React = require('react')
-const Runs = importJSX('../lib/runs.js')
+const Runs = importJSX('./runs.js')
 const t = require('tap')
 const {Test} = t
 const {render} = require('ink-testing-library')

diff --git a/lib/status-mark.js → lib/reports/base/status-mark.js b/lib/status-mark.js → lib/reports/base/status-mark.js
diff --git a/test/status-mark.jsx → lib/reports/base/status-mark.test.jsx b/test/status-mark.jsx → lib/reports/base/status-mark.test.jsx
@@ -1,8 +1,8 @@
-require('./term-setup.js')
+require('../../term-setup.test.js')
 const React = require('react')
 const t = require('tap')
 const importJSX = require('import-jsx')
-const StatusMark = importJSX('../lib/status-mark.js')
+const StatusMark = importJSX('./status-mark.js')
 const {render} = require('ink-testing-library')
 
 const r = render(<StatusMark />)

diff --git a/lib/suite-counts.js → lib/reports/base/suite-counts.js b/lib/suite-counts.js → lib/reports/base/suite-counts.js
diff --git a/test/suite-counts.jsx → lib/reports/base/suite-counts.test.jsx b/test/suite-counts.jsx → lib/reports/base/suite-counts.test.jsx
@@ -1,9 +1,9 @@
-require('./term-setup.js')
+require('../../term-setup.test.js')
 const React = require('react')
 const importJSX = require('import-jsx')
 const {render} = require('ink-testing-library')
 const t = require('tap')
-const SuiteCounts = importJSX('../lib/suite-counts.js')
+const SuiteCounts = importJSX('./suite-counts.js')
 
 const cases = [
   [0, 0, 0, 0, 4],

diff --git a/lib/summary.js → lib/reports/base/summary.js b/lib/summary.js → lib/reports/base/summary.js
diff --git a/test/summary.jsx → lib/reports/base/summary.test.jsx b/test/summary.jsx → lib/reports/base/summary.test.jsx
@@ -1,7 +1,7 @@
-require('./term-setup.js')
+require('../../term-setup.test.js')
 const importJSX = require('import-jsx')
 const React = require('react')
-const Summary = importJSX('../lib/summary.js')
+const Summary = importJSX('./summary.js')
 const t = require('tap')
 const {Test} = t
 const {render} = require('ink-testing-library')

diff --git a/lib/test-point.js → lib/reports/base/test-point.js b/lib/test-point.js → lib/reports/base/test-point.js
@@ -1,7 +1,7 @@
 const React = require('react')
 const {Box, Color} = require('ink')
-const prettyDiff = require('./pretty-diff.js')
-const prettySource = require('./pretty-source.js')
+const prettyDiff = require('../../pretty-diff.js')
+const prettySource = require('../../pretty-source.js')
 const yaml = require('tap-yaml')
 const importJSX = require('import-jsx')
 const PassFail = importJSX('./pass-fail.js')

diff --git a/test/test-point.jsx → lib/reports/base/test-point.test.jsx b/test/test-point.jsx → lib/reports/base/test-point.test.jsx
@@ -1,8 +1,8 @@
-require('./term-setup.js')
+require('../../term-setup.test.js')
 const React = require('react')
 const t = require('tap')
 const importJSX = require('import-jsx')
-const TestPoint = importJSX('../lib/test-point.js')
+const TestPoint = importJSX('./test-point.js')
 const {render} = require('ink-testing-library')
 
 const r = render(<div />)

diff --git a/lib/test.js → lib/reports/base/test.js b/lib/test.js → lib/reports/base/test.js
diff --git a/test/test.jsx → lib/reports/base/test.test.jsx b/test/test.jsx → lib/reports/base/test.test.jsx
@@ -1,7 +1,7 @@
-require('./term-setup.js')
+require('../../term-setup.test.js')
 const importJSX = require('import-jsx')
 const React = require('react')
-const TestTag = importJSX('../lib/test.js')
+const TestTag = importJSX('./test.js')
 const t = require('tap')
 const {Test} = t
 const {render} = require('ink-testing-library')

diff --git a/test/term-setup.js → lib/term-setup.test.js b/test/term-setup.js → lib/term-setup.test.js
diff --git a/package.json b/package.json
@@ -29,19 +29,20 @@
     "postpublish": "git push origin --all; git push origin --tags"
   },
   "tap": {
+    "check-coverage": true,
     "test-arg": [
       "--color"
     ]
   },
   "files": [
     "index.js",
-    "lib"
+    "lib/**/!(*.test).js"
   ],
   "nyc": {
     "all": true,
     "include": [
       "index.js",
-      "lib/*.js*"
+      "lib/**/!(*.test).js"
     ]
   }
 }
diff --git a/...snapshots/test-pretty-diff.js-TAP.test.js → ...shots/lib-pretty-diff.test.js-TAP.test.js b/...snapshots/test-pretty-diff.js-TAP.test.js → ...shots/lib-pretty-diff.test.js-TAP.test.js
@@ -5,7 +5,7 @@
  * Make sure to inspect the output below.  Do not ignore changes!
  */
 'use strict'
-exports[`test/pretty-diff.js TAP > a pretty diff at 40 columns 1`] = `
+exports[`lib/pretty-diff.test.js TAP > a pretty diff at 40 columns 1`] = `
   [38;2;51;0;0m[48;2;255;153;204m--- expected                        [49m[39m
   [38;2;0;51;0m[48;2;204;255;153m+++ actual                          [49m[39m
   [48;2;255;255;255m[38;2;17;17;17m Object {                           [39m[49m
@@ -14,7 +14,7 @@ exports[`test/pretty-diff.js TAP > a pretty diff at 40 columns 1`] = `
   [48;2;255;255;255m[38;2;17;17;17m }                                  [39m[49m
 `
 
-exports[`test/pretty-diff.js TAP > a pretty diff at 2 columns 1`] = `
+exports[`lib/pretty-diff.test.js TAP > a pretty diff at 2 columns 1`] = `
   [38;2;51;0;0m[48;2;255;153;204m--- expected[49m[39m
   [38;2;0;51;0m[48;2;204;255;153m+++ actual[49m[39m
   [48;2;255;255;255m[38;2;17;17;17m Object {[39m[49m
@@ -23,7 +23,7 @@ exports[`test/pretty-diff.js TAP > a pretty diff at 2 columns 1`] = `
   [48;2;255;255;255m[38;2;17;17;17m }[39m[49m
 `
 
-exports[`test/pretty-diff.js TAP > a pretty diff at 0 columns 1`] = `
+exports[`lib/pretty-diff.test.js TAP > a pretty diff at 0 columns 1`] = `
   [38;2;51;0;0m[48;2;255;153;204m--- expected                                                       [49m[39m
   [38;2;0;51;0m[48;2;204;255;153m+++ actual                                                         [49m[39m
   [48;2;255;255;255m[38;2;17;17;17m Object {                                                          [39m[49m
@@ -32,7 +32,7 @@ exports[`test/pretty-diff.js TAP > a pretty diff at 0 columns 1`] = `
   [48;2;255;255;255m[38;2;17;17;17m }                                                                 [39m[49m
 `
 
-exports[`test/pretty-diff.js TAP > a pretty diff without ansi support 1`] = `
+exports[`lib/pretty-diff.test.js TAP > a pretty diff without ansi support 1`] = `
   [31m--- expected                        [39m
   [32m+++ actual                          [39m
   [0m Object {                           [0m

diff --git a/...apshots/test-pretty-source.js-TAP.test.js → ...ots/lib-pretty-source.test.js-TAP.test.js b/...apshots/test-pretty-source.js-TAP.test.js → ...ots/lib-pretty-source.test.js-TAP.test.js
@@ -5,7 +5,7 @@
  * Make sure to inspect the output below.  Do not ignore changes!
  */
 'use strict'
-exports[`test/pretty-source.js TAP highlight a file > with the caret 1`] = `
+exports[`lib/pretty-source.test.js TAP highlight a file > with the caret 1`] = `
 [48;2;34;34;34m[38;2;170;170;170m  /Users/isaacs/dev/js/treport/delete-me.js[39m  [49m
 [48;2;34;34;34m [38;2;119;119;119m 2 | [39m[36mconst[39m [38;2;238;238;238mline1[39m [93m=[39m [92m'line 1'[39m                 [49m
 [48;2;34;34;34m [38;2;119;119;119m 3 | [39m[36mconst[39m [38;2;238;238;238mline2[39m [93m=[39m [92m'line 2'[39m                 [49m
@@ -17,7 +17,7 @@ exports[`test/pretty-source.js TAP highlight a file > with the caret 1`] = `
 
 `
 
-exports[`test/pretty-source.js TAP highlight a file > no caret 1`] = `
+exports[`lib/pretty-source.test.js TAP highlight a file > no caret 1`] = `
 [48;2;34;34;34m[38;2;170;170;170m  /Users/isaacs/dev/js/treport/delete-me.js[39m  [49m
 [48;2;34;34;34m [38;2;119;119;119m 2 | [39m[36mconst[39m [38;2;238;238;238mline1[39m [93m=[39m [92m'line 1'[39m                 [49m
 [48;2;34;34;34m [38;2;119;119;119m 3 | [39m[36mconst[39m [38;2;238;238;238mline2[39m [93m=[39m [92m'line 2'[39m                 [49m
@@ -28,15 +28,15 @@ exports[`test/pretty-source.js TAP highlight a file > no caret 1`] = `
 
 `
 
-exports[`test/pretty-source.js TAP highlight a file > last line, no caret 1`] = `
+exports[`lib/pretty-source.test.js TAP highlight a file > last line, no caret 1`] = `
 [48;2;34;34;34m[38;2;170;170;170m  /Users/isaacs/dev/js/treport/delete-me.js[39m  [49m
 [48;2;34;34;34m [38;2;119;119;119m  8 | [39m[36mconst[39m [38;2;238;238;238mline7[39m [93m=[39m [92m'line 7'[39m                [49m
 [48;2;34;34;34m [38;2;119;119;119m  9 | [39m[36mconst[39m [38;2;238;238;238mline8[39m [93m=[39m [92m'line 8'[39m                [49m
 [48;2;34;34;34m[31m[1m>[22m[39m 10[38;2;119;119;119m | [39m[36mconst[39m [38;2;238;238;238mline9[39m [93m=[39m [92m'line 9'[39m                [49m
 
 `
 
-exports[`test/pretty-source.js TAP highlight a file > last line, with caret 1`] = `
+exports[`lib/pretty-source.test.js TAP highlight a file > last line, with caret 1`] = `
 [48;2;34;34;34m[38;2;170;170;170m  /Users/isaacs/dev/js/treport/delete-me.js[39m  [49m
 [48;2;34;34;34m [38;2;119;119;119m  8 | [39m[36mconst[39m [38;2;238;238;238mline7[39m [93m=[39m [92m'line 7'[39m                [49m
 [48;2;34;34;34m [38;2;119;119;119m  9 | [39m[36mconst[39m [38;2;238;238;238mline8[39m [93m=[39m [92m'line 8'[39m                [49m
@@ -45,7 +45,7 @@ exports[`test/pretty-source.js TAP highlight a file > last line, with caret 1`]
 
 `
 
-exports[`test/pretty-source.js TAP highlight a file > caret way too far off the line 1`] = `
+exports[`lib/pretty-source.test.js TAP highlight a file > caret way too far off the line 1`] = `
 [48;2;34;34;34m[38;2;170;170;170m  /Users/isaacs/dev/js/treport/delete-me.js[39m  [49m
 [48;2;34;34;34m [38;2;119;119;119m 1 | [39m[36mconst[39m [38;2;238;238;238mline0[39m [93m=[39m [92m'line 0'[39m                 [49m
 [48;2;34;34;34m[31m[1m>[22m[39m 2[38;2;119;119;119m | [39m[36mconst[39m [38;2;238;238;238mline1[39m [93m=[39m [92m'line 1'[39m                 [49m
@@ -55,7 +55,7 @@ exports[`test/pretty-source.js TAP highlight a file > caret way too far off the
 
 `
 
-exports[`test/pretty-source.js TAP highlight a file > slightly less colorful 1`] = `
+exports[`lib/pretty-source.test.js TAP highlight a file > slightly less colorful 1`] = `
 [48;2;34;34;34m[90m  /Users/isaacs/dev/js/treport/delete-me.js[39m  [49m
 [48;2;34;34;34m [2m 2 | [22m[36mconst[39m [38;2;238;238;238mline1[39m [93m=[39m [92m'line 1'[39m                 [49m
 [48;2;34;34;34m [2m 3 | [22m[36mconst[39m [38;2;238;238;238mline2[39m [93m=[39m [92m'line 2'[39m                 [49m
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		const t = require('tap')
		t.ok(require('./index.js'))
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		const t = require('tap')
		t.ok(require('import-jsx')('./index.js'))