@small-tech/tap-monkey 1.4.0 → 1.6.0

package/CHANGELOG.md

@@ -4,6 +4,20 @@ All notable changes to this project will be documented in this file.
 
 The format is 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).
 
+## [1.6.0] - 2025-12-29
+
+Bail-on-fail monkey.
+
+  - If you want the process to exit on first failure (e.g., you’re running your unit tests continuously until you hit an unpredictably-reproduced failure), set the `BAIL_ON_FAIL` environment flag before running the tests.
+
+## [1.5.0] - 2025-12-29
+
+Maintenance monkey.
+
+  - Update all dependencies.
+  - Fix failing test.
+  - Remove all vulnerability warnings.
+
 ## [1.4.0] - 2022-05-24
 
 Testy monkey.

package/index.js

@@ -12,7 +12,7 @@
 //
 //////////////////////////////////////////////////////////////////////////////////////////
 
-import Ora from 'ora'
+import ora from 'ora'
 import chalk from 'chalk'
 import { performance } from 'perf_hooks'
 import tapOut from '@small-tech/tap-out'
@@ -31,16 +31,16 @@ export const context = {
 // reflected in the spinner text and that’s ok. Failures, of course, are
 // all output in full to the terminal.
 const indentedMonkey = {
-  "interval": 300,
-  "frames": [
-    "  🙈 ",
-    "  🙈 ",
-    "  🙉 ",
-    "  🙊 "
+  interval: 300,
+  frames: [
+    '  🙈 ',
+    '  🙈 ',
+    '  🙉 ',
+    '  🙊 '
   ]
 }
 
-const spinner = new Ora({
+const spinner = ora({
     spinner: indentedMonkey,
     discardStdin: false,
     text: 'Running tests…'
@@ -88,6 +88,16 @@ const failHandler = (assert => {
     console.log(' ', chalk.red(line))
   })
 
+  if (process.env.BAIL_ON_FAIL) {
+    /* c8 ignore next */
+    if (!process.env.DONT_ACTUALLY_BAIL_ON_FAIL) {
+      /* c8 ignore next */
+      process.exit()
+    } else {
+      return 'I pretended to bail on fail.'
+    }
+  }
+
   spinner.start()
 })
 

package/jsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "checkJs": true,
+    "module": "nodenext",
+    "lib": ["es2024", "dom"],
+    "target": "es2024",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true
+  },
+  "exclude": ["node_modules"]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@small-tech/tap-monkey",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "description": "A tap formatter that’s also a monkey.",
   "keywords": [
     "tap",
@@ -34,13 +34,13 @@
     "url": "https://github.com/small-tech/tap-monkey.git"
   },
   "dependencies": {
-    "@small-tech/tap-out": "^3.2.0",
-    "chalk": "^4.1.0",
-    "ora": "^5.3.0"
+    "@small-tech/tap-out": "^3.3.0",
+    "chalk": "^5.6.2",
+    "ora": "^9.0.0"
   },
   "devDependencies": {
-    "c8": "^7.11.3",
-    "strip-ansi": "^7.0.1",
-    "tape": "^5.5.3"
+    "c8": "^10.1.3",
+    "strip-ansi": "^7.1.2",
+    "tape": "^5.9.0"
   }
 }

package/tests/index.js

@@ -21,11 +21,11 @@ test('test handler', t => {
   tapMonkey.testHandler({name: 'mock'})
   tapMonkey.spinner.stop()
 
-  t.strictEquals(tapMonkey.spinner._spinner.interval, 300, 'spinner interval is as expected')
-  t.strictEquals(tapMonkey.spinner._spinner.frames[0], '  🙈 ', 'animation frame 1 is correct')
-  t.strictEquals(tapMonkey.spinner._spinner.frames[1], '  🙈 ', 'animation frame 2 is correct')
-  t.strictEquals(tapMonkey.spinner._spinner.frames[2], '  🙉 ', 'animation frame 3 is correct')
-  t.strictEquals(tapMonkey.spinner._spinner.frames[3], '  🙊 ', 'animation frame 4 is correct')
+  t.strictEquals(tapMonkey.spinner.interval, 300, 'spinner interval is as expected')
+  t.strictEquals(tapMonkey.spinner.spinner.frames[0], '  🙈 ', 'animation frame 1 is correct')
+  t.strictEquals(tapMonkey.spinner.spinner.frames[1], '  🙈 ', 'animation frame 2 is correct')
+  t.strictEquals(tapMonkey.spinner.spinner.frames[2], '  🙉 ', 'animation frame 3 is correct')
+  t.strictEquals(tapMonkey.spinner.spinner.frames[3], '  🙊 ', 'animation frame 4 is correct')
 
   t.true(strip(tapMonkey.spinner.text).includes('Running mock tests'), 'test name is displayed correctly')
   
@@ -106,7 +106,7 @@ test('fail handler', t => {
   console.log = originalConsoleLog
 
   t.true(output.includes('TypeError: Cannot convert undefined or null to object'), 'output includes main error message')
-  t.true(output.includes('~/Projects/nodekit/node_modules/tape-promise/node_modules/onetime/index.js:30:12'), 'error location shown')
+  t.true(output.includes('/var/home/aral/Projects/nodekit/node_modules/tape-promise/node_modules/onetime/index.js:30:12'), 'error location shown')
   
   // Test a regular assertion failure.
   
@@ -162,6 +162,17 @@ test('fail handler', t => {
   t.true(output.includes('expected: true'), 'output should include expected field')
   t.true(output.includes('actual  : false'), 'output should include actual field')
 
+  // Test bail on fail environment flag.
+  process.env.BAIL_ON_FAIL = 'true'
+  process.env.DONT_ACTUALLY_BAIL_ON_FAIL = 'true'
+  console.log = capturedConsoleLog
+  const mockResult = tapMonkey.failHandler(regularFailedAssertion)
+  delete process.env.BAIL_ON_FAIL
+  delete process.env.DONT_ACTUALLY_BAIL_ON_FAIL
+  console.log = originalConsoleLog
+
+  t.strictEquals(mockResult, 'I pretended to bail on fail.', 'Bail on fail works.')
+  
   t.end()
 })