Tsify asm-docs-tests to typescript with utils (#4670)

docs/AddingAssemblyDocumentation.md

@@ -76,4 +76,4 @@ Finally we want to tell CE that the new documentation provider exists. This is d
 ## 4. Testing
 
 Testing new assembly documentation providers is really easy. It is just a matter of modifying the `TEST_MATRIX` variable
-found in the `/test/handlers/asm-docs-tests.js` file.
+found in the `/test/handlers/asm-docs-tests.ts` file.

package.json

@@ -101,6 +101,7 @@
   "devDependencies": {
     "@babel/preset-typescript": "^7.16.5",
     "@types/bootstrap": "^5.1.6",
+    "@types/chai": "^4.3.4",
     "@types/express": "^4.17.14",
     "@types/fs-extra": "^9.0.13",
     "@types/jquery": "^3.5.10",

test/handlers/asm-docs-tests.js → test/handlers/asm-docs-tests.ts

@@ -29,7 +29,7 @@ import {withAssemblyDocumentationProviders} from '../../lib/handlers/assembly-do
 import {chai} from '../utils';
 
 /** Test matrix of architecture to [opcode, tooptip, html, url] */
-export const TEST_MATRIX = {
+export const TEST_MATRIX: Record<PropertyKey, [string, string, string, string][]> = {
     6502: [
         [
             'lda',
@@ -82,7 +82,7 @@ export const TEST_MATRIX = {
 };
 
 describe('Assembly Documentation API', () => {
-    let app;
+    let app: express.Express;
 
     before(() => {
         app = express();

test/utils.js → test/utils.ts

@@ -26,12 +26,14 @@ import path from 'path';
 import {fileURLToPath} from 'url';
 
 import chai from 'chai';
+import fs from 'fs-extra';
 
 import {CompilationEnvironment} from '../lib/compilation-env';
 import {CompilationQueue} from '../lib/compilation-queue';
 import {CompilerProps, fakeProps} from '../lib/properties';
 
-export function makeCompilationEnvironment(options) {
+// TODO: Find proper type for options
+export function makeCompilationEnvironment(options: Record<string, any>): CompilationEnvironment {
     const compilerProps = new CompilerProps(options.languages, fakeProps(options.props || {}));
     const compilationQueue = options.queue || new CompilationQueue(options.concurrency || 1, options.timeout);
     return new CompilationEnvironment(compilerProps, compilationQueue, options.doCache);
@@ -44,10 +46,9 @@ export const should = chai.should();
  */
 export const TEST_ROOT = path.resolve(path.dirname(fileURLToPath(import.meta.url)));
 
-export function resolvePathFromTestRoot(...args) {
+export function resolvePathFromTestRoot(...args: string[]): string {
     return path.resolve(TEST_ROOT, ...args);
 }
 
-export {default as fs} from 'fs-extra';
-export {default as chai} from 'chai';
-export {default as path} from 'path';
+// eslint-disable-next-line -- do not rewrite exports
+export { chai, path, fs }

tsconfig.backend.json

@@ -11,6 +11,7 @@
     /* Code generation */
     "outDir": "./out/dist",
     "typeRoots": ["./typings", "./node_modules/@types"],
+    "types": ["mocha", "chai", "chai-http"],
     /* Other options */
     "allowJs": true
   }