[New] add types

tape-testing · Feb 29, 2024 · a507822 · a507822
1 parent d8d42b6
commit a507822
Show file tree

Hide file tree

Showing 83 changed files with 1,032 additions and 164 deletions.
diff --git a/.eslintrc b/.eslintrc
@@ -23,6 +23,8 @@
         "no-underscore-dangle": "warn",
         "object-curly-newline": "off",
         "sort-keys": "off",
+
+		"no-extra-parens": "off",
     },
     "ignorePatterns": ["syntax-error.*"],
     "overrides": [

diff --git a/.github/workflows/node-aught.yml b/.github/workflows/node-aught.yml
@@ -9,3 +9,4 @@ jobs:
       range: '< 10'
       type: minors
       command: npm run tests-only
+      skip-ls-check: true
diff --git a/bin/import-or-require.js b/bin/import-or-require.js
@@ -4,6 +4,7 @@ const { extname: extnamePath } = require('path');
 const { pathToFileURL } = require('url');
 const getPackageType = require('get-package-type');
 
+/** @type {(file: string) => undefined | Promise<unknown>} */
 // eslint-disable-next-line consistent-return
 module.exports = function importOrRequire(file) {
 	const ext = extnamePath(file);

diff --git a/bin/tape b/bin/tape
@@ -100,9 +100,11 @@ var hasImport = require('has-dynamic-import');
 
 var tape = require('../');
 
+/** @type {(hasSupport: boolean) => Promise<void> | void} */
 function importFiles(hasSupport) {
 	tape.wait();
 
+	/** @type {null | undefined | Promise<unknown>} */
 	var filesPromise;
 	if (hasSupport) {
 		var importOrRequire = require('./import-or-require');

diff --git a/example/array.js b/example/array.js
@@ -9,6 +9,7 @@ test('array', function (t) {
 	var src = '(' + function () {
 		var xs = [1, 2, [3, 4]];
 		var ys = [5, 6];
+		// @ts-expect-error
 		g([xs, ys]);
 	} + ')()';
 
@@ -26,11 +27,11 @@ test('array', function (t) {
 	];
 
 	Function('fn', 'g', String(output))(
-		function (xs) {
+		/** @param {(number | number[])[]} xs */ function (xs) {
 			t.same(arrays.shift(), xs);
 			return xs;
 		},
-		function (xs) {
+		/** @param {(number | number[])[]} xs */ function (xs) {
 			t.same(xs, [[1, 2, [3, 4]], [5, 6]]);
 		}
 	);

diff --git a/example/fail.js b/example/fail.js
@@ -9,6 +9,7 @@ test('array', function (t) {
 	var src = '(' + function () {
 		var xs = [1, 2, [3, 4]];
 		var ys = [5, 6];
+		// @ts-expect-error
 		g([xs, ys]);
 	} + ')()';
 
@@ -26,11 +27,11 @@ test('array', function (t) {
 	];
 
 	Function('fn', 'g', String(output))(
-		function (xs) {
+		/** @param {(number | number[])[]} xs */ function (xs) {
 			t.same(arrays.shift(), xs);
 			return xs;
 		},
-		function (xs) {
+		/** @param {(number | number[])[]} xs */ function (xs) {
 			t.same(xs, [[1, 2, [3, 4444]], [5, 6]]);
 		}
 	);

diff --git a/example/nested.js b/example/nested.js
@@ -9,6 +9,7 @@ test('nested array test', function (t) {
 	var src = '(' + function () {
 		var xs = [1, 2, [3, 4]];
 		var ys = [5, 6];
+		// @ts-expect-error
 		g([xs, ys]);
 	} + ')()';
 
@@ -35,11 +36,11 @@ test('nested array test', function (t) {
 	];
 
 	Function('fn', 'g', String(output))(
-		function (xs) {
+		/** @param {(number | number[])[]} xs */ function (xs) {
 			t.same(arrays.shift(), xs);
 			return xs;
 		},
-		function (xs) {
+		/** @param {(number | number[])[]} xs */ function (xs) {
 			t.same(xs, [[1, 2, [3, 4]], [5, 6]]);
 		}
 	);

diff --git a/example/nested_fail.js b/example/nested_fail.js
@@ -9,6 +9,7 @@ test('nested array test', function (t) {
 	var src = '(' + function () {
 		var xs = [1, 2, [3, 4]];
 		var ys = [5, 6];
+		// @ts-expect-error
 		g([xs, ys]);
 	} + ')()';
 
@@ -35,11 +36,11 @@ test('nested array test', function (t) {
 	];
 
 	Function('fn', 'g', String(output))(
-		function (xs) {
+		/** @param {(number | number[])[]} xs */ function (xs) {
 			t.same(arrays.shift(), xs);
 			return xs;
 		},
-		function (xs) {
+		/** @param {(number | number[])[]} xs */ function (xs) {
 			t.same(xs, [[1, 2, [3, 4]], [5, 6]]);
 		}
 	);

diff --git a/example/not_enough_fail.js b/example/not_enough_fail.js
@@ -9,6 +9,7 @@ test('array', function (t) {
 	var src = '(' + function () {
 		var xs = [1, 2, [3, 4]];
 		var ys = [5, 6];
+		// @ts-expect-error
 		g([xs, ys]);
 	} + ')()';
 
@@ -26,11 +27,11 @@ test('array', function (t) {
 	];
 
 	Function('fn', 'g', String(output))(
-		function (xs) {
+		/** @param {(number | number[])[]} xs */ function (xs) {
 			t.same(arrays.shift(), xs);
 			return xs;
 		},
-		function (xs) {
+		/** @param {(number | number[])[]} xs */ function (xs) {
 			t.same(xs, [[1, 2, [3, 4]], [5, 6]]);
 		}
 	);

diff --git a/example/too_many_fail.js b/example/too_many_fail.js
@@ -9,6 +9,7 @@ test('array', function (t) {
 	var src = '(' + function () {
 		var xs = [1, 2, [3, 4]];
 		var ys = [5, 6];
+		// @ts-expect-error
 		g([xs, ys]);
 	} + ')()';
 
@@ -26,11 +27,11 @@ test('array', function (t) {
 	];
 
 	Function('fn', 'g', String(output))(
-		function (xs) {
+		/** @param {(number | number[])[]} xs */ function (xs) {
 			t.same(arrays.shift(), xs);
 			return xs;
 		},
-		function (xs) {
+		/** @param {(number | number[])[]} xs */ function (xs) {
 			t.same(xs, [[1, 2, [3, 4]], [5, 6]]);
 		}
 	);

diff --git a/index.d.ts b/index.d.ts
@@ -0,0 +1,92 @@
+import type { ThroughStream } from '@ljharb/through';
+
+import type Test from './lib/test';
+import type Results from './lib/results';
+
+declare function harnessFunction(this: Test, name: string, opts: tape.TestOptions, cb: Test.TestCase): Test;
+declare function harnessFunction(this: Test, name: string, opts: tape.TestOptions): Test;
+declare function harnessFunction(this: Test, name: string, cb: Test.TestCase): Test;
+declare function harnessFunction(this: Test, name: string): Test;
+declare function harnessFunction(this: Test, opts: tape.TestOptions, cb: Test.TestCase): Test;
+declare function harnessFunction(this: Test, opts: tape.TestOptions): Test;
+declare function harnessFunction(this: Test, cb: Test.TestCase): Test;
+
+declare function harnessFunction(this: void, name: string, opts: tape.TestOptions, cb: Test.TestCase): Test;
+declare function harnessFunction(this: void, name: string, opts: tape.TestOptions): Test;
+declare function harnessFunction(this: void, name: string, cb: Test.TestCase): Test;
+declare function harnessFunction(this: void, name: string): Test;
+declare function harnessFunction(this: void, opts: tape.TestOptions, cb: Test.TestCase): Test;
+declare function harnessFunction(this: void, opts: tape.TestOptions): Test;
+declare function harnessFunction(this: void, cb: Test.TestCase): Test;
+
+declare namespace tape {
+    export type TestOptions = {
+        objectPrintDepth?: number | undefined;
+        skip?: boolean | string | undefined;
+        timeout?: number | undefined;
+        todo?: boolean | string | undefined;
+    };
+
+    export interface AssertOptions {
+        skip?: boolean | string | undefined;
+        todo?: boolean | string | undefined;
+        message?: string | undefined;
+        actual?: unknown;
+        expected?: unknown;
+        exiting?: boolean;
+    }
+
+    export interface StreamOptions {
+        objectMode?: boolean | undefined;
+    }
+
+    function createStream(opts?: StreamOptions): ThroughStream;
+
+    export type CreateStream = typeof createStream;
+
+    export type HarnessEventHandler = (cb: Test.SyncCallback, ...rest: unknown[]) => void;
+
+    function only(name: string, cb: Test.TestCase): void;
+    function only(name: string, opts: tape.TestOptions, cb: Test.TestCase): void;
+    function only(cb: Test.TestCase): void;
+    function only(opts: tape.TestOptions, cb?: Test.TestCase): void;
+
+    export type Harness = typeof harnessFunction & {
+        run?: () => void;
+        only: typeof only;
+        _exitCode: number;
+        _results: Results;
+        _tests: Test[];
+        close: () => void;
+        createStream: CreateStream;
+        onFailure: HarnessEventHandler;
+        onFinish: HarnessEventHandler;
+    }
+
+    export type HarnessConfig = {
+        autoclose?: boolean;
+        noOnly?: boolean;
+        stream?: NodeJS.WritableStream | ThroughStream;
+        exit?: boolean;
+    } & StreamOptions;
+
+    function createHarness(conf_?: HarnessConfig): Harness;
+    const Test: Test;
+    const test: Harness;
+    const skip: Test['skip'];
+
+	function getHarness(opts?: HarnessConfig): Harness;
+	function run(): void;
+	function onFailure(cb: Test.SyncCallback, ...rest: unknown[]): void;
+	function onFinish(cb: Test.SyncCallback, ...rest: unknown[]): void
+	function wait(): void;
+}
+
+declare function tape(this: void | tape.Harness, name: string, opts: tape.TestOptions, cb: Test.TestCase): Test;
+declare function tape(this: void | tape.Harness, name: string, cb: Test.TestCase): Test;
+declare function tape(this: void | tape.Harness, opts?: tape.TestOptions): Test;
+declare function tape(this: void | tape.Harness, opts: tape.TestOptions, cb: Test.TestCase): Test;
+declare function tape(this: void | tape.Harness, cb: Test.TestCase): Test;
+declare function tape(this: void | tape.Harness, name: string): Test;
+
+export = tape;