@reporters/bail 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 1.0.0 (2023-06-05)
+
+
+### Features
+
+* add @reporters/bail package ([9a2ca5c](https://github.com/MoLow/reporters/commit/9a2ca5c98e029e6b73238adfb0f6e68da9011d87))

package/README.md

@@ -0,0 +1,24 @@
+[![npm version](https://img.shields.io/npm/v/@reporters/bail)](https://www.npmjs.com/package/@reporters/bail) ![tests](https://github.com/MoLow/reporters/actions/workflows/test.yaml/badge.svg?branch=main) [![codecov](https://codecov.io/gh/MoLow/reporters/branch/main/graph/badge.svg?token=0LFVC8SCQV)](https://codecov.io/gh/MoLow/reporters)
+
+# `node:test` Bail on failure
+A package to bail on the first test failure of a test run
+using node built in test runner.
+
+## Installation
+
+```bash
+npm install --save-dev @reporters/bail
+```
+or
+```bash
+yarn add --dev @reporters/bail
+```
+
+## Usage
+
+```bash
+node --test \
+  --test-reporter=@reporters/bail --test-reporter-destination=stderr \
+  --test-reporter=spec --test-reporter-destination=stdout
+```
+

package/index.js

@@ -0,0 +1,8 @@
+module.exports = async function* bail(source) {
+  for await (const event of source) {
+    if (event.type === 'test:fail') {
+      yield `\n\u001b[31m✖ Bailing on failed test: ${event.data.name}\u001b[0m\n`;
+      throw new Error('Bail');
+    }
+  }
+};

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@reporters/bail",
+  "version": "1.0.0",
+  "description": "A Bail library for `node:test`",
+  "keywords": [
+    "node:test",
+    "test",
+    "reporter",
+    "reporters"
+  ],
+  "scripts": {
+    "test": "node --test-reporter=spec --test-reporter-destination=stdout --test-reporter=../github/index.js --test-reporter-destination=stdout --test"
+  },
+  "bugs": {
+    "url": "https://github.com/MoLow/reporters/issues"
+  },
+  "main": "index.js",
+  "homepage": "https://github.com/MoLow/reporters/tree/main/packages/bail",
+  "repository": "https://github.com/MoLow/reporters.git",
+  "author": "Moshe Atlow",
+  "license": "MIT"
+}

package/tests/fixtures/fail.js

@@ -0,0 +1,7 @@
+const { describe, test } = require('node:test');
+const assert = require('node:assert');
+
+describe('enforce no concurrent tests', { concurrent: false }, () => {
+  test('fail', async () => assert.fail());
+  test('dont run', async () => {});
+});

package/tests/fixtures/pass.js

@@ -0,0 +1,3 @@
+const { test } = require('node:test');
+
+test('pass');

package/tests/index.test.js

@@ -0,0 +1,24 @@
+const { test } = require('node:test');
+const { spawnSync } = require('child_process');
+const assert = require('assert');
+
+test('pass should not interfere with passing test', () => {
+  const child = spawnSync(process.execPath, [
+    '--test-reporter', 'dot', '--test-reporter-destination', 'stdout',
+    '--test-reporter', './index.js', '--test-reporter-destination', 'stdout', 'tests/fixtures/pass.js',
+  ], { env: {} });
+  assert.strictEqual(child.stderr?.toString(), '');
+  assert.strictEqual(child.stdout?.toString(), '.\n');
+  assert.strictEqual(child.status, 0);
+});
+
+test('fail should stop after failed test', () => {
+  const child = spawnSync(process.execPath, [
+    '--test-reporter', 'dot', '--test-reporter-destination', 'stdout',
+    '--test-reporter', './index.js', '--test-reporter-destination', 'stdout',
+    'tests/fixtures/fail.js', 'tests/fixtures/pass.js',
+  ], { env: {} });
+  assert.strictEqual(child.stderr?.toString(), '');
+  assert.strictEqual(child.stdout?.toString(), 'X\n\x1B[31m✖ Bailing on failed test: fail\x1B[0m\n');
+  assert.strictEqual(child.status, 1);
+});