terminal tests and fixes

Author: cblanquera

package.json

@@ -166,13 +166,15 @@
     "build:tsc": "yarn build:tsc:cjs && yarn build:tsc:esm",
     "build:tsc:cjs": "tsc -p ./tsconfig.cjs.json",
     "build:tsc:esm": "tsc -p ./tsconfig.esm.json",
-    "test": "nyc ts-mocha -r tsx tests/*.test.ts",
+    "test": "yarn test:env nyc ts-mocha -r tsx tests/*.test.ts",
+    "test:env": "NODE_OPTIONS=\"--disable-warning=ExperimentalWarning --experimental-loader @istanbuljs/esm-loader-hook\"",
     "report": "nyc report -r lcov"
   },
   "dependencies": {
     "@inquirer/prompts": "7.1.0"
   },
   "devDependencies": {
+    "@istanbuljs/esm-loader-hook": "0.3.0",
     "@types/chai": "4.3.20",
     "@types/mocha": "10.0.10",
     "@types/node": "22.9.3",

src/router/Terminal.ts

@@ -1,5 +1,7 @@
 //modules
 import { input } from '@inquirer/prompts';
+//lib
+import type { TypeOf } from '../types.js';
 //data
 import { objectFromArgs } from '../data/Nest.js';
 //local
@@ -144,7 +146,7 @@ export default class Terminal<R = unknown, S = unknown>
   /**
    * Retrieves the first value found from the given flag/s in cli
    */
-  public expect<T>(flags: string[], defaults: T) {
+  public expect<T>(flags: string[], defaults: TypeOf<T>) {
     for (const flag of flags) {
       if (this.data[flag]) {
         return this.data[flag] as T;
@@ -156,9 +158,9 @@ export default class Terminal<R = unknown, S = unknown>
   /**
    * Runs the command
    */
-  public run() {
+  public run<T = unknown>() {
     const req = this.request({ data: this.data });
     const res = this.response();
-    return this.emit(this.command, req, res);
+    return this.resolve<T>(this.command, req, res);
   }
 }

tests/Terminal.test.ts

@@ -0,0 +1,58 @@
+import { describe, it } from 'mocha';
+import { expect } from 'chai';
+//NOTE: no extensions in tests because it's excluded in tsconfig.json and
+//we are testing in a typescript environment via `ts-mocha -r tsx` (esm)
+import Terminal from '../src/router/Terminal';
+
+describe('Terminal Tests', () => {
+  it('Should get args', async () => {
+    const terminal = new Terminal(['command', '--i', 'value']);
+    expect(terminal.args[0]).to.equal('--i');
+    expect(terminal.args[1]).to.equal('value');
+  })
+  it('Should get brand', async () => {
+    const terminal = new Terminal([], '[test]');
+    expect(terminal.brand).to.equal('[test]');
+  })
+  it('Should configure controls', async () => {
+    const terminal = new Terminal(['command', '--i', 'value'], '[test]');
+    const control = terminal.control;
+    expect(control.brand).to.equal('[test]');
+    expect(typeof control.error).to.equal('function');
+    expect(typeof control.success).to.equal('function');
+    expect(typeof control.warning).to.equal('function');
+    expect(typeof control.info).to.equal('function');
+    expect(typeof control.output).to.equal('function');
+    expect(typeof control.input).to.equal('function');
+  })
+  it('Should parse data', async () => {
+    const terminal = new Terminal(['command', '--i', 'value']);
+    expect(terminal.data.i).to.equal('value');
+  })
+  it('Should expect arguments', async () => {
+    const terminal = new Terminal(['command', '--i', 'value']);
+    const input = terminal.expect(['i', 'input'], 'default');
+    expect(input).to.equal('value');
+  })
+  it('Should run command successfully', async () => {
+    const terminal = new Terminal(['command', '--i', 'value']);
+    terminal.on('command', (req, res) => {
+      res.setResults(req.data());
+    })
+    const response = await terminal.run<{ i: string }>();
+    expect(response.code).to.equal(200);
+    expect(response.status).to.equal('OK');
+    expect(response.total).to.equal(1);
+    expect(response.results?.i).to.equal('value');
+  })
+  it('Should run command then error', async () => {
+    const terminal = new Terminal(['command', '--i', 'value']);
+    terminal.on('command', (req, res) => {
+      res.setError('error message');
+    })
+    const response = await terminal.run<{ i: string }>();
+    expect(response.code).to.equal(400);
+    expect(response.status).to.equal('Bad Request');
+    expect(response.error).to.equal('error message');
+  })
+})