feat: expose test/suite names in context object (#55)

* feat: also pass the name of the things to hooks

* chore: updates to using an array

* chore: use `crumbs` var name

* fix(types): use `string[]` generic variant

Co-authored-by: Marais Rossouw <me@marais.co>

* stash

* refactor: use `__suite__` and `__test__` context keys

Co-authored-by: Luke Edwards <luke.edwards05@gmail.com>

Author: maraisr

src/index.d.ts

@@ -1,5 +1,6 @@
 declare namespace uvu {
-	type Callback<T> = (context: T) => Promise<void> | void;
+	type Crumbs = { __suite__: string; __test__: string };
+	type Callback<T> = (context: T & Crumbs) => Promise<void> | void;
 
 	interface Hook<T> {
 		(hook: Callback<T>): void;

src/index.js

@@ -66,6 +66,7 @@ async function runner(ctx, name) {
 		for (hook of before) await hook(state);
 
 		for (test of arr) {
+			state.__test__ = test.name;
 			try {
 				for (hook of bEach) await hook(state);
 				await test.handler(state);
@@ -80,6 +81,7 @@ async function runner(ctx, name) {
 			}
 		}
 	} finally {
+		state.__test__ = '';
 		for (hook of after) await hook(state);
 		let msg = `  (${num} / ${total})\n`;
 		let skipped = (only.length ? tests.length : 0) + ctx.skips;
@@ -89,6 +91,8 @@ async function runner(ctx, name) {
 }
 
 function setup(ctx, name = '') {
+	ctx.state.__test__ = '';
+	ctx.state.__suite__ = name;
 	const test = into(ctx, 'tests');
 	test.before = hook(ctx, 'before');
 	test.before.each = hook(ctx, 'bEach');

test/suite.js

@@ -282,3 +282,41 @@ context3('should allow self-referencing instance(s) within context', ctx => {
 });
 
 context3.run();
+
+// ---
+
+const breadcrumbs = suite('breadcrumbs', {
+	count: 1,
+});
+
+breadcrumbs.before(ctx => {
+	assert.is(ctx.__suite__, 'breadcrumbs');
+	assert.is(ctx.__test__, '');
+});
+
+breadcrumbs.after(ctx => {
+	assert.is(ctx.__suite__, 'breadcrumbs');
+	assert.is(ctx.__test__, '');
+});
+
+breadcrumbs.before.each(ctx => {
+	assert.is(ctx.__suite__, 'breadcrumbs');
+	assert.is(ctx.__test__, `test #${ctx.count}`);
+});
+
+breadcrumbs.after.each(ctx => {
+	assert.is(ctx.__suite__, 'breadcrumbs');
+	assert.is(ctx.__test__, `test #${ctx.count++}`);
+});
+
+breadcrumbs('test #1', (ctx) => {
+	assert.is(ctx.__suite__, 'breadcrumbs');
+	assert.is(ctx.__test__, 'test #1');
+});
+
+breadcrumbs('test #2', (ctx) => {
+	assert.is(ctx.__suite__, 'breadcrumbs');
+	assert.is(ctx.__test__, 'test #2');
+});
+
+breadcrumbs.run();