[New] add types

Author: ljharb

.eslintrc

@@ -23,6 +23,8 @@
         "no-underscore-dangle": "warn",
         "object-curly-newline": "off",
         "sort-keys": "off",
+
+		"no-extra-parens": "off",
     },
     "ignorePatterns": ["syntax-error.*"],
     "overrides": [

.github/workflows/node-aught.yml

@@ -9,3 +9,4 @@ jobs:
       range: '< 10'
       type: minors
       command: npm run tests-only
+      skip-ls-check: true

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);

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');

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]]);
 		}
 	);

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]]);
 		}
 	);

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]]);
 		}
 	);

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]]);
 		}
 	);

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]]);
 		}
 	);

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]]);
 		}
 	);