refactor: simplify types and async methods (#1133)

* refactor: simplify types and async methods

* docs: simplify inline docs

* docs: simplify inline docs

Author: wellwelwel

src/@types/background-process.ts

@@ -1,32 +1,13 @@
 import type { Runner } from './runner.js';
 
 type BackgroundProcessOptions = {
-  /**
-   * - Default: resolves in the first console output
-   * - String: waits for a specifc string on console output to resolve
-   * - Number: waits for time in milliseconds to resolve
-   *
-   * @default undefined
-   */
   startAfter?: string | number;
-  /**
-   * Stops the service for neither success nor failure after:
-   *
-   * @default 60000
-   */
   timeout?: number;
-  /** Shows the output from service */
   verbose?: boolean;
-  /**
-   * Specify a target path to start the process
-   *
-   * @default "./"
-   */
   cwd?: string | undefined;
 };
 
 export type StartScriptOptions = {
-  /** By default, Poku will use `npm`. Change it as you want */
   readonly runner?: Runner;
 } & BackgroundProcessOptions;
 

src/@types/list-files.ts

@@ -1,14 +1,5 @@
 export type Configs = {
-  /**
-   * Filter by path to match only the files that should be performed.
-   *
-   * @default /\.(test|spec)\./i
-   */
+  /** @default /\.(test|spec)\./i */
   filter?: RegExp;
-  /**
-   * Exclude by path to match only the files that should be performed.
-   *
-   * @default undefined
-   */
   exclude?: RegExp | RegExp[];
 };

src/@types/plugin.ts

@@ -21,7 +21,6 @@ export type PluginContext = {
 };
 
 export type PokuPlugin = {
-  /** Plugin name */
   name?: string;
   /** Modify the command array before spawning a test file process */
   runner?: (command: string[], file: string) => string[];

src/@types/poku.ts

@@ -28,103 +28,27 @@ export type Reporter =
   | CustomString;
 
 export type Configs = {
-  /**
-   * By setting `true`, **Poku** won't exit the process and will return the exit code (`0` or `1`)
-   *
-   * @default false
-   */
   noExit?: boolean;
-  /**
-   * This option overwrites all `log` settings
-   *
-   * @default false
-   */
   debug?: boolean;
-  /**
-   * This option overwrites the `debug` settings
-   *
-   * @default false
-   */
   quiet?: boolean;
-  /**
-   * Determines the mode of test execution
-   *
-   * @default false
-   */
   sequential?: boolean;
-  /**
-   * Controls process isolation for test files
-   *
-   * - `'process'` (default): each test file runs in a separate child process
-   * - `'none'`: all test files run in the same process (useful for debugging with `--inspect`)
-   *
-   * @default 'process'
-   */
   isolation?: 'none' | 'process' | CustomString;
-  /**
-   * Stops the tests at the first failure.
-   *
-   * @default false
-   */
   failFast?: boolean;
-  /**
-   * Limits the number of tests running concurrently
-   *
-   * @default (availableParallelism() || cpus().lenght)
-   */
+  /** @default (availableParallelism() || cpus().lenght) */
   concurrency?: number;
-  /**
-   * Sets the maximum time in milliseconds that each test file is allowed to run
-   *
-   * @default undefined
-   */
+  /** Sets the maximum time in milliseconds that each test file is allowed to run */
   timeout?: number;
-  /**
-   * @default "poku"
-   */
+  /** @default "poku" */
   reporter?: Reporter;
-  /**
-   * You can use this option to run a **callback** or a **file** before each test file on your suite
-   *
-   * ```ts
-   * beforeEach(() => myFunc())
-   * ```
-   *
-   * ```ts
-   * beforeEach(async () => await myAsyncFunc())
-   * ```
-   */
+  /** Runs a callback or a file before each test file on your suite */
   beforeEach?: () => unknown | Promise<unknown>;
-  /**
-   * You can use this option to run a **callback** or a **file** after each test file on your suite
-   *
-   * ```ts
-   * afterEach(() => myFunc())
-   * ```
-   *
-   * ```ts
-   * afterEach(async () => await myAsyncFunc())
-   * ```
-   */
+  /** Runs a callback or a file after each test file on your suite */
   afterEach?: () => unknown | Promise<unknown>;
   deno?: DenoOptions;
-  /**
-   * Plugins to extend Poku's behavior
-   *
-   * @default undefined
-   */
   plugins?: PokuPlugin[];
-  /**
-   * Only run tests whose title matches the given regex pattern
-   *
-   * @default undefined
-   */
+  /** Only run tests whose title matches the given regex pattern */
   testNamePattern?: RegExp;
-  /**
-   * Skip tests whose title matches the given regex pattern
-   *
-   * @default undefined
-   */
+  /** Skip tests whose title matches the given regex pattern */
   testSkipPattern?: RegExp;
 } & ListFilesConfigs;
 
@@ -139,17 +63,12 @@ export type States = {
 };
 
 type CliConfigs = {
-  /** Default: searches for _`.test.`_ and `.spec.` files, but you can customize it */
   include?: string | string[];
-  /** Reads an environment file and sets the environment variables */
   envFile?: string;
-  /** Terminates the specified ports, port ranges and process IDs */
+  /** Kills the specified ports, port ranges and process IDs */
   kill?: {
-    /** Terminates the specified ports before running the test suite */
     port?: [number];
-    /** Terminates the specified port range before running the test suite */
     range?: [number, number][];
-    /** Terminates the specified processes before running the test suite */
     pid?: [number];
   };
 };

src/@types/wait-for.ts

@@ -1,37 +1,14 @@
 export type WaitForExpectedResultOptions = {
-  /**
-   * Retry interval in milliseconds
-   *
-   * @default 100
-   */
+  /** @default 100 */
   interval?: number;
-  /**
-   * Timeout in milliseconds
-   *
-   * @default 60000
-   */
+  /** @default 60000 */
   timeout?: number;
-  /**
-   * Delays both the start and end by the defined milliseconds
-   *
-   * @default 0
-   */
   delay?: number;
-  /**
-   * Ensure strict comparisons
-   *
-   * - For **Bun** users, this option isn't necessary
-   *
-   * @default false
-   */
+  /** Ensure strict comparisons */
   strict?: boolean;
 };
 
 export type WaitForPortOptions = {
-  /**
-   * Host to check the port on
-   *
-   * @default "localhost"
-   */
+  /** @default "localhost" */
   host?: string;
 } & Omit<WaitForExpectedResultOptions, 'strict'>;

src/bin/help.ts

@@ -88,7 +88,7 @@ ${bullet} ${b('Poku')} is made with ${b('love')} and ${b('care')} in every detai
 ${bullet} Give him a ${b('star')} to show your support 🌟
 `;
 
-export const help = (): void => {
+export const help = () => {
   hr();
   log(header.trim());
   hr();

src/bin/watch.ts

@@ -19,21 +19,21 @@ export const startWatch = async (dirs: string[]) => {
   const executing = new Set<string>();
   const interval = Number(getArg('watchInterval')) || 1500;
 
-  const addWatcher = (pending: Promise<Watcher>): void => {
+  const addWatcher = (pending: Promise<Watcher>) => {
     pending.then((watcher) => {
       watchers.add(watcher);
     });
   };
 
-  const resultsClear = (): void => {
+  const resultsClear = () => {
     errors.length = 0;
     results.passed = 0;
     results.failed = 0;
     results.skipped = 0;
     results.todo = 0;
   };
 
-  const listenStdin = async (input: Buffer | string): Promise<void> => {
+  const listenStdin = async (input: Buffer | string) => {
     if (isRunning || executing.size > 0) return;
 
     if (String(input).trim() === 'rs') {

src/builders/assert.ts

@@ -83,7 +83,7 @@ export const createAssert = (nodeAssert: typeof assert) => {
     block: () => unknown,
     errorOrMessage?: AssertPredicate | AssertionMessage,
     message?: AssertionMessage
-  ): void => {
+  ) => {
     processAssert(
       () => {
         if (isPredicate(errorOrMessage))
@@ -107,7 +107,7 @@ export const createAssert = (nodeAssert: typeof assert) => {
     block: () => unknown,
     errorOrMessage?: AssertPredicate | AssertionMessage,
     message?: AssertionMessage
-  ): void => {
+  ) => {
     if (isPredicate(errorOrMessage))
       processAssert(() => nodeAssert.throws(block, errorOrMessage), {
         message,
@@ -130,7 +130,7 @@ export const createAssert = (nodeAssert: typeof assert) => {
     block: AsyncBlock,
     errorOrMessage?: AssertPredicate | AssertionMessage,
     message?: AssertionMessage
-  ): Promise<void> => {
+  ) => {
     await processAsyncAssert(
       async () => {
         if (isPredicate(errorOrMessage))
@@ -154,7 +154,7 @@ export const createAssert = (nodeAssert: typeof assert) => {
     block: AsyncBlock,
     errorOrMessage?: AssertPredicate | AssertionMessage,
     message?: AssertionMessage
-  ): Promise<void> => {
+  ) => {
     await processAsyncAssert(
       async () => {
         if (isPredicate(errorOrMessage))

src/modules/essentials/poku.ts

@@ -10,7 +10,7 @@ import { runTests } from '../../services/run-tests.js';
 import { exit } from '../helpers/exit.js';
 import { listFiles } from '../helpers/list-files.js';
 
-export const onSigint = (): void => {
+export const onSigint = () => {
   stdout.write('\u001B[?25h');
 };
 

src/modules/helpers/create-service.ts

@@ -74,7 +74,7 @@ const backgroundProcess = (
 
       runningProcesses.set(PID, end);
 
-      const onData = (data: Buffer): void => {
+      const onData = (data: Buffer) => {
         if (!isResolved && typeof options?.startAfter !== 'number') {
           if (
             typeof options?.startAfter === 'undefined' ||
@@ -122,7 +122,7 @@ const backgroundProcess = (
     } catch {}
   });
 
-/** Starts a file in a background process (useful for servers, APIs, etc.) */
+/** Starts a file in a background process */
 export const startService = (
   file: string,
   options?: StartServiceOptions
@@ -139,14 +139,7 @@ export const startService = (
   );
 };
 
-/**
- *
- * Starts a script (package.json) or task (deno.json) in a background process (useful for servers, APIs, etc.).
- *
- * ---
- *
- * By default it uses **npm**, but you can costumize it using the `runner` option.
- */
+/** Starts a script in a background process */
 export const startScript = (
   script: string,
   options?: StartScriptOptions