Drop CommonJS suppport, support ES Modules, 5-beta.1

Author: doesdev

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is (loosely) based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [5.0.0](https://github.com/doesdev/mvt/compare/4.2.1...5.0.0)
+#### 2022-03-03
+
+### BREAKING
+- ES Module format supported, CommonJS no longer supported
+
 ## [4.2.1](https://github.com/doesdev/mvt/compare/4.2.0...4.2.1)
 #### 2021-07-10
 

README.md

@@ -2,6 +2,11 @@
 
 > Minimum Viable Testing framework
 
+## 5.0.0
+Version 5.0.0+ deprecates support for CommonJS, opting to only support ES Modules. 
+
+Please use `mvt@4` for CommonJS usage.
+
 ## A Minimalist Take on AVA's Approach to Testing
 Because [AVA](https://github.com/avajs/ava) is awesome. Security alerts on dev
 dependencies are not awesome. Especially when you use the same test library
@@ -68,7 +73,7 @@ node test.js --verbose
 ```
 
 ```js
-const test = require('mvt')
+import test from 'mvt'
 
 test.setup({ verbose: true })
 

cli.js

@@ -1,12 +1,12 @@
 #! /usr/bin/env node
-'use strict'
+import fs from 'fs'
+import path from 'path'
+import { pathToFileURL } from 'url'
 
-const fs = require('fs')
-const path = require('path')
-const { pathToFileURL } = require('url')
 const cwd = process.cwd()
 const exts = ['.js', '.mjs']
 const args = process.argv.slice(2)
+const setup = {}
 const flags = {
   '-v': 'verbose',
   '--verbose': 'verbose',
@@ -17,7 +17,6 @@ const flags = {
   '-p': 'persist',
   '--persist': 'persist'
 }
-const setup = {}
 
 const deflagged = args.filter((a) => !(flags[a] && (setup[flags[a]] = true)))
 
@@ -77,13 +76,14 @@ const main = async () => {
 
   let test
   try {
-    test = require(path.resolve(cwd, 'node_modules', 'mvt'))
+    test = (await import(path.resolve(cwd, 'node_modules', 'mvt'))).default
   } catch (ex) {
-    test = require('./index')
+    test = (await import('./index.js')).default
   }
 
   const seen = {}
-  files.forEach((f) => {
+
+  for (const f of files) {
     if (seen[f]) return
     seen[f] = true
 
@@ -96,21 +96,11 @@ const main = async () => {
     try {
       test.setup(Object.assign({}, setup, { fileName: path.basename(f) }))
 
-      try {
-        require(f)
-      } catch (ex) {
-        try {
-          /* eslint-disable no-unused-expressions */
-          import(pathToFileURL(f))
-          /* eslint-enable no-unused-expressions */
-        } catch (ex) {
-          logFailedImport(ex)
-        }
-      }
+      await import(pathToFileURL(f))
     } catch (ex) {
       logFailedImport(ex)
     }
-  })
+  }
 }
 
 main().catch(console.error)

index.js

@@ -1,9 +1,7 @@
-'use strict'
-
+import { test } from './lib/tests.js'
+import { _setup } from './lib/state.js'
 process.env.NODE_ENV = process.env.NODE_ENV || 'test'
-const { test } = require('./lib/tests')
-const { _setup } = require('./lib/state')
 
 test.before(_setup)
 
-module.exports = test
+export default test

lib/assertions.js

@@ -1,10 +1,10 @@
-'use strict'
+import { strict } from 'assert'
+import { handleError, diffError } from './errors.js'
+import { toPrint } from './utility.js'
 
-const { deepStrictEqual, notDeepStrictEqual } = require('assert').strict
-const { handleError, diffError } = require('./errors')
-const { toPrint } = require('./utility')
+const { deepStrictEqual, notDeepStrictEqual } = strict
 
-const assert = (msg, f) => ({
+export const assert = (msg, f) => ({
   is: is(msg, f),
   not: not(msg, f),
   pass: pass(msg, f),
@@ -25,8 +25,6 @@ const assert = (msg, f) => ({
   notThrowsAsync: notThrowsAsync(msg, f)
 })
 
-module.exports = { assert }
-
 const wrap = (msg, passFn, err, failing) => {
   let passed = false
   try {

lib/cli-char-supported.js

@@ -1,12 +1,13 @@
-'use strict'
+import readline from 'readline'
 
-const readline = require('readline')
 const scanner = '\x1b[6n'
 const appleTerm = process.env.TERM_PROGRAM === 'Apple_Terminal'
 const xterm = process.env.TERM === 'xterm-256color'
-const charOffset = appleTerm || xterm ? -1 : 0
+const baseCharOffset = appleTerm || xterm ? -1 : 0
 
-const checkChar = (char, expected) => new Promise((resolve, reject) => {
+export const charOffset = Math.abs(baseCharOffset)
+
+export const checkChar = (char, expected) => new Promise((resolve, reject) => {
   if (!process.stdin.isTTY) return resolve(false)
   let clean = false
 
@@ -34,7 +35,7 @@ const checkChar = (char, expected) => new Promise((resolve, reject) => {
 
   const checker = (d) => {
     const val = +((`${d}` || '').match(/;(\d+)R/) || [])[1]
-    return cleanup(val === expect || ((val + charOffset) === expect))
+    return cleanup(val === expect || ((val + baseCharOffset) === expect))
   }
 
   const timeout = setTimeout(() => cleanup(false, true), 500)
@@ -47,5 +48,3 @@ const checkChar = (char, expected) => new Promise((resolve, reject) => {
   process.stdout.write(char)
   process.stdout.write(scanner)
 })
-
-module.exports = { checkChar, charOffset: Math.abs(charOffset) }

lib/errors.js

@@ -1,9 +1,12 @@
-'use strict'
+import { strict } from 'assert'
+import { char, color, toPrint } from './utility.js'
 
-const { deepStrictEqual } = require('assert').strict
-const { char, color, toPrint } = require('./utility')
+const { deepStrictEqual } = strict
 
-const handleError = (msg, err, noExit) => {
+let differ
+import('diff').then((mod) => { differ = mod }).catch(() => {})
+
+export const handleError = (msg, err, noExit) => {
   process.stderr.write(`${char('fail')} ${msg}\n`)
   err = err || `Failed: ${msg}`
   err = err instanceof Error ? err : new Error(err)
@@ -18,7 +21,7 @@ const handleError = (msg, err, noExit) => {
   throw err
 }
 
-const finalizeError = (error) => {
+export const finalizeError = (error) => {
   const { noExit } = error.metaMvt || {}
   delete error.metaMvt
 
@@ -27,12 +30,10 @@ const finalizeError = (error) => {
   if (!noExit) process.exit(1)
 }
 
-const diffError = (a, b, errName = 'Values should be identical') => {
+export const diffError = (a, b, errName = 'Values should be identical') => {
   let diff
 
   try {
-    const differ = require('diff')
-
     diff = ''
     differ.diffLines(a, b).forEach(({ added, removed, value }) => {
       const colored = added ? color.green : (removed ? color.red : color.grey)
@@ -53,5 +54,3 @@ const diffError = (a, b, errName = 'Values should be identical') => {
 
   return new Error(`${errName}:\n${diff.trim()}`)
 }
-
-module.exports = { handleError, diffError, finalizeError }

lib/reporters.js

@@ -1,19 +1,17 @@
-'use strict'
+import readline from 'readline'
+import { state } from './state.js'
+import { char, color, fmtMs, plural } from './utility.js'
 
-const readline = require('readline')
-const { state } = require('./state')
-const { char, color, fmtMs, plural } = require('./utility')
-
-const writeNonVerboseCount = () => {
+export const writeNonVerboseCount = () => {
   const count = ++state.fileTestCount
   readline.cursorTo(process.stdout, 0)
   readline.moveCursor(process.stdout, 0, -2)
   process.stdout.write(`\n${char('good')} ${count} tests passed\n`)
 }
 
-const info = (msg) => process.stdout.write(msg)
+export const info = (msg) => process.stdout.write(msg)
 
-const reporter = ({ msg, pass, out, error, mod }) => {
+export const reporter = ({ msg, pass, out, error, mod }) => {
   const skipNonVerbose = { skip: true, todo: true }
   if (out) {
     if (state.verbose) {
@@ -24,7 +22,7 @@ const reporter = ({ msg, pass, out, error, mod }) => {
   }
 }
 
-const summary = (ms) => {
+export const summary = (ms) => {
   const counts = state.counts
   const result = `${color.green}All tests passed in ${fmtMs(ms)}${color.reset}`
   process.stdout.write(`\n${char('good')} ${result}\n`)
@@ -52,5 +50,3 @@ const summary = (ms) => {
     }
   }
 }
-
-module.exports = { reporter, writeNonVerboseCount, info, summary }

lib/runners.js

@@ -1,12 +1,10 @@
-'use strict'
+import { state } from './state.js'
+import { assert } from './assertions.js'
+import { handleError } from './errors.js'
+import { reporter, info } from './reporters.js'
+import { char, color, fmtMs } from './utility.js'
 
-const { state } = require('./state')
-const { assert } = require('./assertions')
-const { handleError } = require('./errors')
-const { reporter, info } = require('./reporters')
-const { char, color, fmtMs } = require('./utility')
-
-const getRunner = (tests) => {
+export const getRunner = (tests) => {
   const runner = async (t, noExit) => {
     const { msg, fn, failing, benchOpts, fileName: currFile } = t
 
@@ -87,5 +85,3 @@ const getRunner = (tests) => {
 
   return { runner, benchRunner }
 }
-
-module.exports = { getRunner }

lib/state.js

@@ -1,13 +1,12 @@
-'use strict'
+import { initCharCheck } from './utility.js'
 
-const { initCharCheck } = require('./utility')
 const argv = process.argv
 
 const initTap = argv.some((a) => a === '--tap' || a === '-t')
 const initPersist = initTap || argv.some((a) => a === '--persist' || a === '-p')
 const initVerbose = !initTap && argv.some((a) => a === '--verbose' || a === '-v')
 
-const state = {
+export const state = {
   queue: [],
   counts: {},
   fileTestCount: 0,
@@ -16,7 +15,7 @@ const state = {
   verbose: initVerbose
 }
 
-const _setup = async (opts = {}) => {
+export const _setup = async (opts = {}) => {
   const setForKey = (k) => opts[k] !== undefined ? !!opts[k] : state[k]
   state.tap = setForKey('tap')
   state.persist = state.tap || setForKey('persist')
@@ -26,9 +25,7 @@ const _setup = async (opts = {}) => {
   await initCharCheck()
 }
 
-const setup = (opts = {}) => state.queue.push({
+export const setup = (opts = {}) => state.queue.push({
   fn: () => _setup(opts),
   fileName: opts.fileName
 })
-
-module.exports = { state, setup, _setup }