Add TypeScript

Author: mantoni

index.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 'use strict';
 
-const yargs = require('yargs/yargs');
+const yargs = require('yargs');
 const { hideBin } = require('yargs/helpers');
 const { mochify } = require('@mochify/mochify');
 

package.json

@@ -8,9 +8,15 @@
   },
   "main": "index.js",
   "scripts": {
+    "lint": "eslint .",
     "test": "echo \"No unit tests yet\"",
     "test:integration": "mocha --timeout 10000 -R spec '**/*.integration.js'",
-    "preversion": "npm run test && npm run test:integration",
+    "prettier:check": "prettier --check '**/*.{js,json,md}'",
+    "build": "tsc --project tsconfig.pack.json",
+    "clean": "rimraf --glob '!(node_modules)/**/*.d.ts' '*.d.ts'",
+    "prepack": "npm run build",
+    "postpack": "npm run clean",
+    "preversion": "npm run lint && npm run prettier:check && tsc && npm test && npm run test:integration",
     "version": "changes --commits --footer --workspace",
     "postversion": "npm publish"
   },
@@ -41,6 +47,7 @@
   },
   "files": [
     "**/*.js",
+    "**/*.d.ts",
     "!**/*.test.js",
     "!test/**",
     "!.*"

test/fixture/client-leak.js

@@ -3,6 +3,7 @@
 
 describe('test', () => {
   it('does not leak client functions into global scope', () => {
+    // @ts-ignore
     if (typeof MochifyReporter !== 'undefined') {
       throw new Error('MochifyReporter leaked');
     }

test/fixture/custom.config.yaml

@@ -5,6 +5,10 @@ const path = require('path');
 const { assert } = require('@sinonjs/referee-sinon');
 const execa = require('execa');
 
+/**
+ * @typedef {import('execa').ExecaError} ExecaError
+ */
+
 describe('jsdom', () => {
   async function run(file, ...extra_args) {
     try {
@@ -17,7 +21,7 @@ describe('jsdom', () => {
         }
       );
     } catch (error) {
-      return error;
+      return /** @type {ExecaError} */ (error);
     }
   }
 
@@ -39,10 +43,10 @@ describe('jsdom', () => {
       const fixture = fs.createReadStream(
         path.resolve(__dirname, './fixture/passes.js')
       );
-      fixture.pipe(cp.stdin);
+      fixture.pipe(/** @type {Object} */ (cp).stdin);
       result = await cp;
     } catch (err) {
-      result = err;
+      result = /** @type {ExecaError} */ (err);
     }
 
     assert.isFalse(result.failed);

test/jsdom.integration.js

@@ -5,6 +5,10 @@ const path = require('path');
 const { assert } = require('@sinonjs/referee-sinon');
 const execa = require('execa');
 
+/**
+ * @typedef {import('execa').ExecaError} ExecaError
+ */
+
 describe('playwright', () => {
   async function run(file, ...extra_args) {
     try {
@@ -24,7 +28,7 @@ describe('playwright', () => {
         }
       );
     } catch (error) {
-      return error;
+      return /** @type {ExecaError} */ (error);
     }
   }
 
@@ -50,10 +54,10 @@ describe('playwright', () => {
       const fixture = fs.createReadStream(
         path.resolve(__dirname, './fixture/passes.js')
       );
-      fixture.pipe(cp.stdin);
+      fixture.pipe(/** @type {Object} */ (cp).stdin);
       result = await cp;
     } catch (err) {
-      result = err;
+      result = /** @type {ExecaError} */ (err);
     }
 
     assert.isFalse(result.failed);

test/playwright.integration.js

@@ -5,6 +5,10 @@ const path = require('path');
 const { assert } = require('@sinonjs/referee-sinon');
 const execa = require('execa');
 
+/**
+ * @typedef {import('execa').ExecaError} ExecaError
+ */
+
 describe('puppeteer', () => {
   async function run(file, ...extra_args) {
     try {
@@ -17,7 +21,7 @@ describe('puppeteer', () => {
         }
       );
     } catch (error) {
-      return error;
+      return /** @type {ExecaError} */ (error);
     }
   }
 
@@ -39,10 +43,11 @@ describe('puppeteer', () => {
       const fixture = fs.createReadStream(
         path.resolve(__dirname, './fixture/passes.js')
       );
+      // @ts-ignore
       fixture.pipe(cp.stdin);
       result = await cp;
     } catch (err) {
-      result = err;
+      result = /** @type {ExecaError} */ (err);
     }
 
     assert.isFalse(result.failed);

test/puppeteer.integration.js

@@ -6,6 +6,10 @@ const path = require('path');
 const { assert } = require('@sinonjs/referee-sinon');
 const execa = require('execa');
 
+/**
+ * @typedef {import('execa').ExecaError} ExecaError
+ */
+
 describe('webdriver', () => {
   async function run(file, ...extra_args) {
     try {
@@ -18,7 +22,7 @@ describe('webdriver', () => {
         }
       );
     } catch (error) {
-      return error;
+      return /** @type {ExecaError} */ (error);
     }
   }
 
@@ -47,10 +51,11 @@ describe('webdriver', () => {
       const fixture = fs.createReadStream(
         path.resolve(__dirname, './fixture/passes.js')
       );
+      // @ts-ignore
       fixture.pipe(cp.stdin);
       result = await cp;
     } catch (err) {
-      result = err;
+      result = /** @type {ExecaError} */ (err);
     }
 
     assert.isFalse(result.failed);

test/webdriver.integration.js

@@ -0,0 +1,5 @@
+{
+  "extends": "@studio/tsconfig",
+  "include": ["**/*.js"],
+  "exclude": ["node_modules"]
+}

tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "@studio/tsconfig",
+  "compilerOptions": {
+    "types": ["node"],
+    "declaration": true,
+    "noEmit": false,
+    "emitDeclarationOnly": true
+  },
+  "include": ["**/*.js"],
+  "exclude": ["node_modules", "**/*.test.js", "test/**"]
+}