Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: restructure it for future method extensions #626

Merged
merged 1 commit into from
Jul 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion fixtures/no-runner/basic-logs.test.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { assert } from '../../src/modules/essentials/assert.js';
import { test } from '../../src/modules/helpers/test.js';
import { describe } from '../../src/modules/helpers/describe.js';
import { it } from '../../src/modules/helpers/it.js';
import { it } from '../../src/modules/helpers/it/core.js';

assert(true, 'Should emit a basic assetion log');

Expand Down
20 changes: 11 additions & 9 deletions src/modules/helpers/it.ts → src/modules/helpers/it/core.ts
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
import { hrtime, env } from 'node:process';
import { each } from '../../configs/each.js';
import { indentation } from '../../configs/indentation.js';
import { format } from '../../services/format.js';
import { Write } from '../../services/write.js';
import { each } from '../../../configs/each.js';
import { indentation } from '../../../configs/indentation.js';
import { format } from '../../../services/format.js';
import { Write } from '../../../services/write.js';

export async function it(
async function itCore(
message: string,
cb: () => Promise<unknown>
): Promise<void>;
export function it(message: string, cb: () => unknown): void;
export async function it(cb: () => Promise<unknown>): Promise<void>;
export function it(cb: () => unknown): void;
export async function it(
function itCore(message: string, cb: () => unknown): void;
async function itCore(cb: () => Promise<unknown>): Promise<void>;
function itCore(cb: () => unknown): void;
async function itCore(
...args: [
string | (() => unknown | Promise<unknown>),
(() => unknown | Promise<unknown>)?,
Expand Down Expand Up @@ -88,3 +88,5 @@ export async function it(
throw error;
}
}

export const it = Object.assign(itCore, {});
2 changes: 1 addition & 1 deletion src/modules/helpers/test.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
import { it } from './it.js';
import { it } from './it/core.js';

export const test = it;
2 changes: 1 addition & 1 deletion src/modules/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ export { assert } from './essentials/assert.js';
export { strict } from './essentials/strict.js';
export { test } from './helpers/test.js';
export { describe } from './helpers/describe.js';
export { it } from './helpers/it.js';
export { it } from './helpers/it/core.js';
export { envFile } from './helpers/env.js';
export { skip } from './helpers/skip.js';
export { beforeEach, afterEach } from './helpers/each.js';
Expand Down
2 changes: 1 addition & 1 deletion test/e2e/background-process.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { test } from '../../src/modules/helpers/test.js';
import { describe } from '../../src/modules/helpers/describe.js';
import { it } from '../../src/modules/helpers/it.js';
import { it } from '../../src/modules/helpers/it/core.js';
import { assert } from '../../src/modules/essentials/assert.js';
import {
startScript,
Expand Down
2 changes: 1 addition & 1 deletion test/e2e/basic-logs.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { describe } from '../../src/modules/helpers/describe.js';
import { it } from '../../src/modules/helpers/it.js';
import { it } from '../../src/modules/helpers/it/core.js';
import { assert } from '../../src/modules/essentials/assert.js';
import { inspectCLI, isProduction } from '../helpers/capture-cli.test.js';
import { skip } from '../../src/modules/helpers/skip.js';
Expand Down
2 changes: 1 addition & 1 deletion test/e2e/before-and-after-each.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { test } from '../../src/modules/helpers/test.js';
import { describe } from '../../src/modules/helpers/describe.js';
import { it } from '../../src/modules/helpers/it.js';
import { it } from '../../src/modules/helpers/it/core.js';
import { poku } from '../../src/modules/essentials/poku.js';
import { assert } from '../../src/modules/essentials/assert.js';
import { isProduction } from '../helpers/capture-cli.test.js';
Expand Down
2 changes: 1 addition & 1 deletion test/e2e/config-files.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { describe } from '../../src/modules/helpers/describe.js';
import { it } from '../../src/modules/helpers/it.js';
import { it } from '../../src/modules/helpers/it/core.js';
import { assert } from '../../src/modules/essentials/assert.js';
import { inspectCLI, isProduction } from '../helpers/capture-cli.test.js';
import { skip } from '../../src/modules/helpers/skip.js';
Expand Down
2 changes: 1 addition & 1 deletion test/e2e/each-api/failure.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { describe } from '../../../src/modules/helpers/describe.js';
import { it } from '../../../src/modules/helpers/it.js';
import { it } from '../../../src/modules/helpers/it/core.js';
import { assert } from '../../../src/modules/essentials/assert.js';
import { inspectCLI, isProduction } from '../../helpers/capture-cli.test.js';
import { skip } from '../../../src/modules/helpers/skip.js';
Expand Down
2 changes: 1 addition & 1 deletion test/e2e/each-api/order.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { describe } from '../../../src/modules/helpers/describe.js';
import { it } from '../../../src/modules/helpers/it.js';
import { it } from '../../../src/modules/helpers/it/core.js';
import { assert } from '../../../src/modules/essentials/assert.js';
import { inspectCLI, isProduction } from '../../helpers/capture-cli.test.js';
import { skip } from '../../../src/modules/helpers/skip.js';
Expand Down
2 changes: 1 addition & 1 deletion test/e2e/exit-code.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { describe } from '../../src/modules/helpers/describe.js';
import { it } from '../../src/modules/helpers/it.js';
import { it } from '../../src/modules/helpers/it/core.js';
import { poku } from '../../src/modules/essentials/poku.js';
import { assert } from '../../src/modules/essentials/assert.js';

Expand Down
2 changes: 1 addition & 1 deletion test/e2e/fail-fast.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { describe } from '../../src/modules/helpers/describe.js';
import { it } from '../../src/modules/helpers/it.js';
import { it } from '../../src/modules/helpers/it/core.js';
import { assert } from '../../src/modules/essentials/assert.js';
import { inspectCLI, isProduction } from '../helpers/capture-cli.test.js';
import { skip } from '../../src/modules/helpers/skip.js';
Expand Down
2 changes: 1 addition & 1 deletion test/e2e/failure.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { describe } from '../../src/modules/helpers/describe.js';
import { it } from '../../src/modules/helpers/it.js';
import { it } from '../../src/modules/helpers/it/core.js';
import { assert } from '../../src/modules/essentials/assert.js';
import { inspectCLI, isProduction } from '../helpers/capture-cli.test.js';
import { skip } from '../../src/modules/helpers/skip.js';
Expand Down
2 changes: 1 addition & 1 deletion test/e2e/runners.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { execSync } from 'node:child_process';
import { describe } from '../../src/modules/helpers/describe.js';
import { it } from '../../src/modules/helpers/it.js';
import { it } from '../../src/modules/helpers/it/core.js';
import { assert } from '../../src/modules/essentials/assert.js';
import { isProduction, inspectCLI } from '../helpers/capture-cli.test.js';
import { skip } from '../../src/modules/helpers/skip.js';
Expand Down
2 changes: 1 addition & 1 deletion test/e2e/watch.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { describe } from '../../src/modules/helpers/describe.js';
import { it } from '../../src/modules/helpers/it.js';
import { it } from '../../src/modules/helpers/it/core.js';
import { assert } from '../../src/modules/essentials/assert.js';
import { watchCLI } from '../helpers/capture-cli.test.js';
import { skip } from '../../src/modules/helpers/skip.js';
Expand Down
2 changes: 1 addition & 1 deletion test/integration/assert/assert-no-message.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { describe } from '../../../src/modules/helpers/describe.js';
import { it } from '../../../src/modules/helpers/it.js';
import { it } from '../../../src/modules/helpers/it/core.js';
import { assert } from '../../../src/modules/essentials/assert.js';
import { nodeVersion } from '../../../src/parsers/get-runtime.js';

Expand Down
2 changes: 1 addition & 1 deletion test/integration/assert/assert.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { describe } from '../../../src/modules/helpers/describe.js';
import { it } from '../../../src/modules/helpers/it.js';
import { it } from '../../../src/modules/helpers/it/core.js';
import { assert } from '../../../src/modules/essentials/assert.js';
import { nodeVersion } from '../../../src/parsers/get-runtime.js';

Expand Down
2 changes: 1 addition & 1 deletion test/integration/containers/test-docker-compose.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { execSync } from 'node:child_process';
import { describe } from '../../../src/modules/helpers/describe.js';
import { it } from '../../../src/modules/helpers/it.js';
import { it } from '../../../src/modules/helpers/it/core.js';
import { assert } from '../../../src/modules/essentials/assert.js';
import { docker } from '../../../src/modules/helpers/container.js';
import { legacyFetch } from '../../helpers/legacy-fetch.test.js';
Expand Down
2 changes: 1 addition & 1 deletion test/integration/containers/test-dockerfile.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { execSync } from 'node:child_process';
import { describe } from '../../../src/modules/helpers/describe.js';
import { it } from '../../../src/modules/helpers/it.js';
import { it } from '../../../src/modules/helpers/it/core.js';
import { assert } from '../../../src/modules/essentials/assert.js';
import { docker } from '../../../src/modules/helpers/container.js';
import { waitForPort } from '../../../src/modules/helpers/wait-for.js';
Expand Down
2 changes: 1 addition & 1 deletion test/integration/it/each/each-options-promise.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { describe } from '../../../../src/modules/helpers/describe.js';
import { it } from '../../../../src/modules/helpers/it.js';
import { it } from '../../../../src/modules/helpers/it/core.js';
import { assert } from '../../../../src/modules/essentials/assert.js';
import { beforeEach, afterEach } from '../../../../src/modules/helpers/each.js';

Expand Down
2 changes: 1 addition & 1 deletion test/integration/it/each/each-options.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { describe } from '../../../../src/modules/helpers/describe.js';
import { it } from '../../../../src/modules/helpers/it.js';
import { it } from '../../../../src/modules/helpers/it/core.js';
import { assert } from '../../../../src/modules/essentials/assert.js';
import { beforeEach, afterEach } from '../../../../src/modules/helpers/each.js';

Expand Down
2 changes: 1 addition & 1 deletion test/integration/it/it.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { test } from '../../../src/modules/helpers/test.js';
import { describe } from '../../../src/modules/helpers/describe.js';
import { it } from '../../../src/modules/helpers/it.js';
import { it } from '../../../src/modules/helpers/it/core.js';

test('Testing "it" method', () => {
describe(async () => {
Expand Down
2 changes: 1 addition & 1 deletion test/integration/strict/assert-no-message.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ if (nodeVersion && nodeVersion < 16) {
}

import { describe } from '../../../src/modules/helpers/describe.js';
import { it } from '../../../src/modules/helpers/it.js';
import { it } from '../../../src/modules/helpers/it/core.js';
import { strict as assert } from '../../../src/modules/essentials/strict.js';

describe('Strict Suite (No Message)', () => {
Expand Down
2 changes: 1 addition & 1 deletion test/integration/strict/assert.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ if (nodeVersion && nodeVersion < 16) {
}

import { describe } from '../../../src/modules/helpers/describe.js';
import { it } from '../../../src/modules/helpers/it.js';
import { it } from '../../../src/modules/helpers/it/core.js';
import { strict as assert } from '../../../src/modules/essentials/strict.js';

describe('Strict Suite', async () => {
Expand Down
2 changes: 1 addition & 1 deletion test/integration/wait-for/wait-for-port.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { createServer, type Server } from 'node:http';
import { test } from '../../../src/modules/helpers/test.js';
import { it } from '../../../src/modules/helpers/it.js';
import { it } from '../../../src/modules/helpers/it/core.js';
import { assert } from '../../../src/modules/essentials/assert.js';
import { waitForPort } from '../../../src/modules/helpers/wait-for.js';
import { kill } from '../../../src/modules/helpers/kill.js';
Expand Down
2 changes: 1 addition & 1 deletion test/unit/args.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { describe } from '../../src/modules/helpers/describe.js';
import { it } from '../../src/modules/helpers/it.js';
import { it } from '../../src/modules/helpers/it/core.js';
import { assert } from '../../src/modules/essentials/assert.js';
import {
getArg,
Expand Down
2 changes: 1 addition & 1 deletion test/unit/env-services.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { describe } from '../../src/modules/helpers/describe.js';
import { it } from '../../src/modules/helpers/it.js';
import { it } from '../../src/modules/helpers/it/core.js';
import { assert } from '../../src/modules/essentials/assert.js';
import {
removeComments,
Expand Down
2 changes: 1 addition & 1 deletion test/unit/logs.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import process from 'node:process';
import { describe } from '../../src/modules/helpers/describe.js';
import { it } from '../../src/modules/helpers/it.js';
import { it } from '../../src/modules/helpers/it/core.js';
import { assert } from '../../src/modules/essentials/assert.js';
import { isQuiet, isDebug, parserOutput } from '../../src/parsers/output.js';
import { Write } from '../../src/services/write.js';
Expand Down
2 changes: 1 addition & 1 deletion test/unit/map-tests.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { join } from 'node:path';
import { writeFileSync, mkdirSync, rmSync } from 'node:fs';
import { test } from '../../src/modules/helpers/test.js';
import { describe } from '../../src/modules/helpers/describe.js';
import { it } from '../../src/modules/helpers/it.js';
import { it } from '../../src/modules/helpers/it/core.js';
import { beforeEach, afterEach } from '../../src/modules/helpers/each.js';
import { assert } from '../../src/modules/essentials/assert.js';
import {
Expand Down
2 changes: 1 addition & 1 deletion test/unit/run-test-file.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import process from 'node:process';
import { describe } from '../../src/modules/helpers/describe.js';
import { it } from '../../src/modules/helpers/it.js';
import { it } from '../../src/modules/helpers/it/core.js';
import { assert } from '../../src/modules/essentials/assert.js';
import { runTestFile } from '../../src/services/run-test-file.js';
import { getRuntime } from '../../src/parsers/get-runtime.js';
Expand Down
2 changes: 1 addition & 1 deletion test/unit/run-tests.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { describe } from '../../src/modules/helpers/describe.js';
import { it } from '../../src/modules/helpers/it.js';
import { it } from '../../src/modules/helpers/it/core.js';
import { assert } from '../../src/modules/essentials/assert.js';
import { runTests } from '../../src/services/run-tests.js';

Expand Down
2 changes: 1 addition & 1 deletion test/unit/watch.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import fs from 'node:fs';
import path from 'node:path';
import { it } from '../../src/modules/helpers/it.js';
import { it } from '../../src/modules/helpers/it/core.js';
import { describe } from '../../src/modules/helpers/describe.js';
import { beforeEach, afterEach } from '../../src/modules/helpers/each.js';
import { assert } from '../../src/modules/essentials/assert.js';
Expand Down
Loading