Replace tape with node:test/ node:assert (#225)

* Replace tape with test/assert modules

* Remove tape/tap-arc dev dependencies, add CONTRIBUTING.md docs highlighting Node 21 as minimum version for development.

Author: danburzo

CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# Contributing
+
+## Development
+
+Tests are defined using the `node:test` and `node:assert` modules. Running the tests require Node 21 or newer:
+
+```bash
+npm run test
+```
+
+We use ESLint to lint JavaScript code. 
+
+
+```bash
+npm run lint
+```
+
+While Culori can be used from source in environments supporting ES Modules, we also use esbuild to build bundles in CommonJS, ESM, and UMD formats.
+
+```bash
+npm run build
+```
+
+## Documentation
+
+The documentation website [culorijs.org] is built with Eleventy out of the `www/` folder, and deployed on GitHub pages via the `gh-pages` branch.
+
+The following scripts are available:
+
+```bash
+npm run docs:start
+npm run docs:build
+npm run docs:deploy
+```

README.md

@@ -16,4 +16,8 @@ The full documentation is published on [culorijs.org](https://culorijs.org). Som
 
 ## Contributing
 
-Contributions of any kind (feedback, ideas, bug fixes) are welcome. Please open a GitHub issue before starting work on anything that's not straightforward.
+Contributions of all kinds (feedback, ideas, bug fixes, documentation) are welcome. 
+
+Please open a GitHub issue/discussion before putting in any work that’s not straightforward.
+
+More in [CONTRIBUTING.md](./CONTRIBUTING.md).

package.json

@@ -54,13 +54,11 @@
 		"eslint-plugin-import": "^2.29.1",
 		"gh-pages": "^6.1.1",
 		"prettier": "^3.2.4",
-		"pretty-quick": "^4.0.0",
-		"tap-arc": "^1.2.2",
-		"tape": "^5.7.3"
+		"pretty-quick": "^4.0.0"
 	},
 	"scripts": {
 		"prepare": "git config core.hooksPath .git-hooks",
-		"test": "tape 'test/**/*.test.js' | tap-arc",
+		"test": "node --test 'test/**/*.test.js'",
 		"start": "npx esbuild --servedir=.",
 		"build": "node build.js",
 		"benchmark": "node benchmark/index.js",

test/a98.test.js

@@ -1,14 +1,15 @@
-import tape from 'tape';
+import test from 'node:test';
+import assert from 'node:assert';
 import { a98, rgb, formatCss } from '../src/index.js';
 
-tape('a98', t => {
-	t.deepEqual(
+test('a98', t => {
+	assert.deepEqual(
 		a98('white'),
 		{ mode: 'a98', r: 0.9999999999999999, g: 1, b: 1.0000000000000002 },
 		'white'
 	);
-	t.deepEqual(a98('black'), { mode: 'a98', r: 0, g: 0, b: 0 }, 'black');
-	t.deepEqual(
+	assert.deepEqual(a98('black'), { mode: 'a98', r: 0, g: 0, b: 0 }, 'black');
+	assert.deepEqual(
 		a98('red'),
 		{
 			mode: 'a98',
@@ -18,42 +19,38 @@ tape('a98', t => {
 		},
 		'red'
 	);
-	t.end();
 });
 
-tape('color(a98-rgb)', t => {
-	t.deepEqual(a98('color(a98-rgb 1 0 0 / 0.25)'), {
+test('color(a98-rgb)', t => {
+	assert.deepEqual(a98('color(a98-rgb 1 0 0 / 0.25)'), {
 		r: 1,
 		g: 0,
 		b: 0,
 		alpha: 0.25,
 		mode: 'a98'
 	});
-	t.deepEqual(a98('color(a98-rgb 0% 50% 0.5 / 25%)'), {
+	assert.deepEqual(a98('color(a98-rgb 0% 50% 0.5 / 25%)'), {
 		r: 0,
 		g: 0.5,
 		b: 0.5,
 		alpha: 0.25,
 		mode: 'a98'
 	});
-	t.end();
 });
 
-tape('formatCss', t => {
-	t.equal(
+test('formatCss', t => {
+	assert.equal(
 		formatCss('color(a98-rgb 0% 50% 0.5 / 25%)'),
 		'color(a98-rgb 0 0.5 0.5 / 0.25)'
 	);
-	t.end();
 });
 
-tape('missing components', t => {
-	t.ok(rgb('color(a98-rgb none 0.5 none)'), 'a98 to rgb is ok');
-	t.deepEqual(
+test('missing components', t => {
+	assert.ok(rgb('color(a98-rgb none 0.5 none)'), 'a98 to rgb is ok');
+	assert.deepEqual(
 		rgb('color(a98-rgb none 0.5 none)'),
 		rgb('color(a98-rgb 0 0.5 0')
 	);
-	t.ok(a98('rgb(none 100 20)'), 'rgb to a98 is ok');
-	t.deepEqual(a98('rgb(none 100 20)'), a98('rgb(0 100 20)'));
-	t.end();
+	assert.ok(a98('rgb(none 100 20)'), 'rgb to a98 is ok');
+	assert.deepEqual(a98('rgb(none 100 20)'), a98('rgb(0 100 20)'));
 });

test/api.test.js

@@ -1,7 +1,8 @@
 /*
 	Keep an eye on the API surface of the various bundles
  */
-import tape from 'tape';
+import test from 'node:test';
+import assert from 'node:assert';
 
 import * as full from '../src/index.js';
 import * as css from '../src/bootstrap/css.js';
@@ -474,22 +475,18 @@ const API_FN = [
 	'wcagLuminance'
 ];
 
-tape('culori', t => {
-	t.deepEqual(Object.keys(full).sort(), API_FULL.sort());
-	t.end();
+test('culori', t => {
+	assert.deepEqual(Object.keys(full).sort(), API_FULL.sort());
 });
 
-tape('culori/css', t => {
-	t.deepEqual(Object.keys(css).sort(), API_CSS.sort());
-	t.end();
+test('culori/css', t => {
+	assert.deepEqual(Object.keys(css).sort(), API_CSS.sort());
 });
 
-tape('culori/all', t => {
-	t.deepEqual(Object.keys(all).sort(), API_ALL.sort());
-	t.end();
+test('culori/all', t => {
+	assert.deepEqual(Object.keys(all).sort(), API_ALL.sort());
 });
 
-tape('culori/fn', t => {
-	t.deepEqual(Object.keys(fn).sort(), API_FN.sort());
-	t.end();
+test('culori/fn', t => {
+	assert.deepEqual(Object.keys(fn).sort(), API_FN.sort());
 });

test/average.test.js

@@ -1,13 +1,12 @@
-import tape from 'tape';
+import test from 'node:test';
+import assert from 'node:assert';
 import { average, averageAngle, formatHex } from '../src/index.js';
 
-tape('average', t => {
-	t.equal(formatHex(average(['#ff0000', '#0000ff'])), '#800080');
-	t.equal(formatHex(average(['#ff0000', '#0000ff'], 'lch')), '#f50086');
-	t.end();
+test('average', t => {
+	assert.equal(formatHex(average(['#ff0000', '#0000ff'])), '#800080');
+	assert.equal(formatHex(average(['#ff0000', '#0000ff'], 'lch')), '#f50086');
 });
 
-tape('averageAngle', t => {
-	t.equal(averageAngle([270, 0]), 315);
-	t.end();
+test('averageAngle', t => {
+	assert.equal(averageAngle([270, 0]), 315);
 });

test/blend.test.js

@@ -1,16 +1,17 @@
-import tape from 'tape';
+import test from 'node:test';
+import assert from 'node:assert';
 import { blend } from '../src/index.js';
 
-tape('blendNormal', function (test) {
-	test.deepEqual(blend(['white', 'rgba(0, 0, 0, 0.5)']), {
+test('blendNormal', t => {
+	assert.deepEqual(blend(['white', 'rgba(0, 0, 0, 0.5)']), {
 		mode: 'rgb',
 		r: 0.5,
 		g: 0.5,
 		b: 0.5,
 		alpha: 1
 	});
 
-	test.deepEqual(
+	assert.deepEqual(
 		blend([
 			{ mode: 'rgb', r: 1, g: 0, b: 0, alpha: 0.5 },
 			{ mode: 'rgb', r: 0, g: 0, b: 1, alpha: 0.5 }
@@ -25,16 +26,14 @@ tape('blendNormal', function (test) {
 	);
 
 	// blend with transparent source
-	test.deepEqual(
+	assert.deepEqual(
 		blend([{ mode: 'rgb', r: 1, g: 0, b: 0, alpha: 0.5 }, 'transparent']),
 		{ mode: 'rgb', r: 1, g: 0, b: 0, alpha: 0.5 }
 	);
 
 	// blend with transparent backdrop
-	test.deepEqual(
+	assert.deepEqual(
 		blend(['transparent', { mode: 'rgb', r: 1, g: 0, b: 0, alpha: 0.5 }]),
 		{ mode: 'rgb', r: 1, g: 0, b: 0, alpha: 0.5 }
 	);
-
-	test.end();
 });

test/cat.test.js

@@ -1,4 +1,5 @@
-import tape from 'tape';
+import test from 'node:test';
+import assert from 'node:assert';
 import { xyz65, xyz50, rgb } from '../src/index.js';
 
 let colors = ['red', 'green', 'blue', 'white', 'black', 'magenta', 'tomato'];
@@ -22,16 +23,14 @@ let sameRGB = (a, b) => {
 	);
 };
 
-tape('rgb -> xyz50 = rgb -> xyz65 -> xyz50', t => {
+test('rgb -> xyz50 = rgb -> xyz65 -> xyz50', t => {
 	colors.forEach(c => {
-		t.ok(sameXYZ(xyz50(rgb(c)), xyz50(xyz65(rgb(c)))), c);
+		assert.ok(sameXYZ(xyz50(rgb(c)), xyz50(xyz65(rgb(c)))), c);
 	});
-	t.end();
 });
 
-tape('rgb -> xyz50 -> rgb = rgb -> xyz50 -> xyz65 -> rgb', t => {
+test('rgb -> xyz50 -> rgb = rgb -> xyz50 -> xyz65 -> rgb', t => {
 	colors.forEach(c => {
-		t.ok(sameRGB(rgb(xyz50(rgb(c))), rgb(xyz65(xyz50(rgb(c))))), c);
+		assert.ok(sameRGB(rgb(xyz50(rgb(c))), rgb(xyz65(xyz50(rgb(c))))), c);
 	});
-	t.end();
 });