(refactor): migrate all tests and test helper code to TS (#649)

- woot, all TS now!
  - get that big blue line for language TS on GitHub haha

- for the most part, not much more to do other than .js -> .ts
  - for the utils had to add some types around

- also use ESM instead of CJS in tests and test helpers
  - require -> import
  - module.exports -> export
    - the indentation change here with utils/fixture made git treat
      it as a delete + new instead of a rename

Author: agilgur5

test/e2e/tsdx-build-default.test.js renamed to test/e2e/tsdx-build-default.test.ts

@@ -1,6 +1,7 @@
-const shell = require('shelljs');
-const util = require('../utils/fixture');
-const { execWithCache } = require('../utils/shell');
+import * as shell from 'shelljs';
+
+import * as util from '../utils/fixture';
+import { execWithCache } from '../utils/shell';
 
 shell.config.silent = false;
 

test/e2e/tsdx-build-invalid.test.js renamed to test/e2e/tsdx-build-invalid.test.ts

@@ -1,6 +1,7 @@
-const shell = require('shelljs');
-const util = require('../utils/fixture');
-const { execWithCache } = require('../utils/shell');
+import * as shell from 'shelljs';
+
+import * as util from '../utils/fixture';
+import { execWithCache } from '../utils/shell';
 
 shell.config.silent = false;
 

test/e2e/tsdx-build-withTsconfig.test.js renamed to test/e2e/tsdx-build-withTsconfig.test.ts

@@ -1,6 +1,7 @@
-const shell = require('shelljs');
-const util = require('../utils/fixture');
-const { execWithCache } = require('../utils/shell');
+import * as shell from 'shelljs';
+
+import * as util from '../utils/fixture';
+import { execWithCache } from '../utils/shell';
 
 shell.config.silent = false;
 

test/e2e/tsdx-lint.test.js renamed to test/e2e/tsdx-lint.test.ts

@@ -1,6 +1,6 @@
-const shell = require('shelljs');
+import * as shell from 'shelljs';
 
-const util = require('../utils/fixture');
+import * as util from '../utils/fixture';
 
 shell.config.silent = true;
 

test/integration/tsdx-build-options.test.js renamed to test/integration/tsdx-build-options.test.ts

@@ -1,7 +1,7 @@
-const shell = require('shelljs');
+import * as shell from 'shelljs';
 
-const util = require('../utils/fixture');
-const { execWithCache } = require('../utils/shell');
+import * as util from '../utils/fixture';
+import { execWithCache } from '../utils/shell';
 
 shell.config.silent = false;
 

test/integration/tsdx-build-withBabel.test.js renamed to test/integration/tsdx-build-withBabel.test.ts

@@ -1,7 +1,7 @@
-const shell = require('shelljs');
+import * as shell from 'shelljs';
 
-const util = require('../utils/fixture');
-const { execWithCache, grep } = require('../utils/shell');
+import * as util from '../utils/fixture';
+import { execWithCache, grep } from '../utils/shell';
 
 shell.config.silent = false;
 

test/integration/tsdx-build-withConfig.test.js renamed to test/integration/tsdx-build-withConfig.test.ts

@@ -1,8 +1,8 @@
-const shell = require('shelljs');
-const fs = require('fs-extra');
+import * as fs from 'fs-extra';
+import * as shell from 'shelljs';
 
-const util = require('../utils/fixture');
-const { execWithCache } = require('../utils/shell');
+import * as util from '../utils/fixture';
+import { execWithCache } from '../utils/shell';
 
 shell.config.silent = false;
 

test/utils/fixture.js

@@ -0,0 +1,29 @@
+import * as path from 'path';
+import * as shell from 'shelljs';
+
+export const rootDir = process.cwd();
+
+shell.config.silent = true;
+
+export function setupStageWithFixture(
+  testDir: string,
+  stageName: string,
+  fixtureName: string
+): void {
+  const stagePath = path.join(rootDir, stageName);
+  shell.mkdir(stagePath);
+  shell.exec(
+    `cp -a ${rootDir}/test/${testDir}/fixtures/${fixtureName}/. ${stagePath}/`
+  );
+  shell.ln(
+    '-s',
+    path.join(rootDir, 'node_modules'),
+    path.join(stagePath, 'node_modules')
+  );
+  shell.cd(stagePath);
+}
+
+export function teardownStage(stageName: string): void {
+  shell.cd(rootDir);
+  shell.rm('-rf', path.join(rootDir, stageName));
+}

test/utils/fixture.ts

@@ -1,12 +1,15 @@
 // this file contains helper utils for working with shell.js functions
-const shell = require('shelljs');
+import * as shell from 'shelljs';
 
 shell.config.silent = true;
 
 // simple shell.exec "cache" that doesn't re-run the same command twice in a row
 let prevCommand = '';
-let prevCommandOutput = {};
-function execWithCache(command, { noCache = false } = {}) {
+let prevCommandOutput = {} as shell.ShellReturnValue;
+export function execWithCache(
+  command: string,
+  { noCache = false } = {}
+): shell.ShellReturnValue {
   // return the old output
   if (!noCache && prevCommand === command) return prevCommandOutput;
 
@@ -15,7 +18,7 @@ function execWithCache(command, { noCache = false } = {}) {
   // reset if command is not to be cached
   if (noCache) {
     prevCommand = '';
-    prevCommandOutput = {};
+    prevCommandOutput = {} as shell.ShellReturnValue;
   } else {
     prevCommand = command;
     prevCommandOutput = output;
@@ -24,19 +27,11 @@ function execWithCache(command, { noCache = false } = {}) {
   return output;
 }
 
-// shelljs.grep wrapper
-// @param {RegExp} pattern
-// @param {string} fileName
-// @returns {boolean} true if pattern has matches in file
-function grep(pattern, fileName) {
+// shell.js grep wrapper returns true if pattern has matches in file
+export function grep(pattern: RegExp, fileName: string[]): boolean {
   const output = shell.grep(pattern, fileName);
   // output.code is always 0 regardless of matched/unmatched patterns
   // so need to test output.stdout
   // https://github.com/jaredpalmer/tsdx/pull/525#discussion_r395571779
   return Boolean(output.stdout.match(pattern));
 }
-
-module.exports = {
-  execWithCache,
-  grep,
-};