chore!: drop platform option (#894)

* chore!: drop platform option * chore: improve environment variables * chore: adjust Deno polyfill * chore: remove `--platform`, `--node`, `--bun` and `deno` * docs: remove `--platform`, `--node`, `--bun` and `deno` * chore: remove unused deps * ci: fix compatibility tests
wellwelwel · Dec 11, 2024 · 7e07f16 · 7e07f16
1 parent 19bd1d2
commit 7e07f16
Show file tree

Hide file tree

Showing 47 changed files with 586 additions and 1,135 deletions.
diff --git a/benchmark/benchmark.sh b/benchmark/benchmark.sh
@@ -21,7 +21,7 @@ echo '```'
 # Not included in results.json
 hyperfine -i --warmup 3 \
   --command-name 'Node.js' 'node --test "./test/node/**.spec.js"' \
-  --command-name "🐷 Poku ($SHORT_SHA)" '../lib/bin/index.js --node ./test/poku' |
+  --command-name "🐷 Poku ($SHORT_SHA)" '../lib/bin/index.js ./test/poku' |
   awk '/Summary/ {flag=1} flag'
 
 echo '```\n'
@@ -31,7 +31,7 @@ echo '```'
 # Not included in results.json
 hyperfine -i --warmup 3 \
   --command-name 'Bun' 'bun test "test/bun/"' \
-  --command-name "🐷 Poku ($SHORT_SHA)" '../lib/bin/index.js --bun ./test/poku' |
+  --command-name "🐷 Poku ($SHORT_SHA)" 'bun ../lib/bin/index.js ./test/poku' |
   awk '/Summary/ {flag=1} flag'
 
 echo '```\n'

diff --git a/package.json b/package.json
@@ -4,6 +4,7 @@
   "description": "🐷 Poku makes testing easy for Node.js, Bun, Deno, and you at the same time.",
   "main": "./lib/modules/index.js",
   "license": "MIT",
+  "type": "commonjs",
   "bin": {
     "poku": "./lib/bin/index.js"
   },
@@ -31,12 +32,12 @@
   },
   "scripts": {
     "test": "tsx src/bin/index.ts test/unit test/integration test/e2e",
-    "test:bun": "bun src/bin/index.ts --bun test/unit test/integration test/e2e",
-    "test:deno": "tsx src/bin/index.ts --deno --denoAllow=all test/unit test/integration test/e2e",
+    "test:bun": "bun src/bin/index.ts test/unit test/integration test/e2e",
+    "test:deno": "deno run -A src/bin/index.ts --denoAllow=all test/unit test/integration test/e2e",
     "pretest:c8": "tsx tools/build/c8-file.ts",
     "test:c8": "c8 --experimental-monocart tsx test/c8.test.ts",
     "posttest:c8": "rm -rf ./.nycrc.json",
-    "test:docker:node": "tsx test/ci.test.ts",
+    "test:docker:node": "bun test/ci.test.ts",
     "clear": "rm -rf lib ci coverage .temp test-src test-tests",
     "prebuild": "npm run clear",
     "build": "tsc && cd test && tsc",

diff --git a/src/@types/background-process.ts b/src/@types/background-process.ts
@@ -1,5 +1,4 @@
 import type { Runner } from './runner.js';
-import type { Configs } from './poku.js';
 
 type BackgroundProcessOptions = {
   /**
@@ -40,11 +39,6 @@ export type StartScriptOptions = {
   readonly runner?: Runner;
 } & BackgroundProcessOptions;
 
-export type StartServiceOptions = {
-  /**
-   * By default, Poku will try to identify the actual platform, but you can specify it manually
-   */
-  readonly platform?: Configs['platform'];
-} & BackgroundProcessOptions;
+export type StartServiceOptions = BackgroundProcessOptions;
 
 export type End = (port?: number | number[]) => Promise<void>;
diff --git a/src/@types/poku.ts b/src/@types/poku.ts
@@ -35,12 +35,6 @@ export type Configs = {
    * @default false
    */
   sequential?: boolean;
-  /**
-   * Determines the platform for test execution.
-   *
-   * @default 'node'
-   */
-  platform?: Runtime;
   /**
    * Stops the tests at the first failure.
    *

diff --git a/src/bin/enforce.ts b/src/bin/enforce.ts
@@ -4,11 +4,9 @@ import { format } from '../services/format.js';
 
 export const checkFlags = () => {
   const allowedFlags = new Set([
-    '--bun',
     '--concurrency',
     '--config',
     '--debug',
-    '--deno',
     '--denoAllow',
     '--denoCjs',
     '--denoDeny',
@@ -20,9 +18,7 @@ export const checkFlags = () => {
     '--killPid',
     '--killPort',
     '--killRange',
-    '--node',
     '--only',
-    '--platform',
     '--quiet',
     '--sequential',
     '--watch',

diff --git a/src/bin/help.ts b/src/bin/help.ts
@@ -10,11 +10,9 @@ const options = i('[--options]');
 const paths = i('[paths]');
 const bullet = d('●');
 const summary: [string, string][] = [
-  ['--bun', 'Enforce tests to run through Bun.'],
   ['--concurrency', 'Limit the number of tests running concurrently.'],
   ['--config, -c', 'Specify a configuration file.'],
   ['--debug, -d', 'Show detailed logs.'],
-  ['--deno', 'Enforce tests to run through Deno.'],
   ['--denoAllow', 'Allow permissions for Deno.'],
   ['--denoCjs', 'Support CommonJS in Deno.'],
   ['--denoDeny', 'Deny permissions for Deno.'],
@@ -28,9 +26,7 @@ const summary: [string, string][] = [
   ['--killPort', 'Terminate the specified ports.'],
   ['--killRange', 'Terminate the specified port ranges.'],
   ['--listFiles', 'Display all the files returned in the terminal.'],
-  ['--node', 'Enforce tests to run through Node.js.'],
   ['--only', 'Enable selective execution of tests.'],
-  ['--platform', 'Enforce tests to run through a platform.'],
   ['--quiet, -q', 'Run tests with no logs.'],
   ['--sequential', 'Run tests files sequentially.'],
   ['--version, -v', "Show Poku's installed version."],
@@ -49,12 +45,6 @@ const header = `
   poku ${options} ${paths}
   poku ${paths} ${options}
 
-› ${u(b('Ensuring platforms:'))}
-
-  poku ${b('--node')} ${options} ${paths}
-  poku ${b('--bun')} ${options} ${paths}
-  poku ${b('--deno')} ${options} ${paths}
-
 › ${u(b('Tips:'))}
 
   ${bullet} All CLI options use camel case pattern (e.g.: ${b('--failFast')}).

diff --git a/src/bin/index.ts b/src/bin/index.ts
@@ -4,7 +4,6 @@ import type { Configs } from '../@types/poku.js';
 import { escapeRegExp } from '../modules/helpers/list-files.js';
 import { getArg, getPaths, hasArg, argToArray } from '../parsers/get-arg.js';
 import { states } from '../configs/files.js';
-import { platformIsValid } from '../parsers/get-runtime.js';
 import { format } from '../services/format.js';
 import { kill } from '../modules/helpers/kill.js';
 import { envFile } from '../modules/helpers/env.js';
@@ -36,7 +35,6 @@ import { getConfigs } from '../parsers/options.js';
     (defaultConfigs?.include
       ? Array.prototype.concat(defaultConfigs?.include)
       : ['.']);
-  const platform = getArg('platform');
   const filter = getArg('filter') ?? defaultConfigs?.filter;
   const exclude = getArg('exclude') ?? defaultConfigs?.exclude;
   const killPort = getArg('killPort');
@@ -144,15 +142,6 @@ import { getConfigs } from '../parsers/options.js';
   }
 
   const options: Configs = {
-    /* c8 ignore next 8 */ // Varies Platform
-    platform: (() => {
-      if (platformIsValid(platform)) return platform;
-      if (hasArg('node')) return 'node';
-      if (hasArg('bun')) return 'bun';
-      if (hasArg('deno')) return 'deno';
-      if (platformIsValid(defaultConfigs?.platform))
-        return defaultConfigs.platform;
-    })(),
     filter:
       typeof filter === 'string' ? new RegExp(escapeRegExp(filter)) : filter,
     exclude:

diff --git a/src/builders/assert.ts b/src/builders/assert.ts
@@ -1,7 +1,6 @@
 import type { ProcessAssertionOptions } from '../@types/assert.js';
 import type assert from 'node:assert';
 import type { AssertPredicate } from 'node:assert';
-import { nodeVersion } from '../parsers/get-runtime.js';
 import { processAssert, processAsyncAssert } from '../services/assert.js';
 
 export const createAssert = (nodeAssert: typeof assert) => {
@@ -244,10 +243,6 @@ export const createAssert = (nodeAssert: typeof assert) => {
     regExp: RegExp,
     message?: ProcessAssertionOptions['message']
   ): void => {
-    /* c8 ignore next 2 */ // Platform version
-    if (typeof nodeVersion === 'number' && nodeVersion < 12)
-      throw new Error('match is available from Node.js 12 or higher');
-
     processAssert(() => nodeAssert?.match(value, regExp), {
       message,
       actual: 'Value',
@@ -261,10 +256,6 @@ export const createAssert = (nodeAssert: typeof assert) => {
     regExp: RegExp,
     message?: ProcessAssertionOptions['message']
   ): void => {
-    /* c8 ignore next 2 */ // Platform version
-    if (typeof nodeVersion === 'number' && nodeVersion < 12)
-      throw new Error('doesNotMatch is available from Node.js 12 or higher');
-
     processAssert(() => nodeAssert.doesNotMatch(value, regExp), {
       message,
       actual: 'Value',

diff --git a/src/modules/helpers/create-service.ts b/src/modules/helpers/create-service.ts
@@ -147,7 +147,7 @@ export const startService = async (
   file: string,
   options?: StartServiceOptions
 ): Promise<{ end: End }> => {
-  const runtimeOptions = runner(file, { platform: options?.platform });
+  const runtimeOptions = runner(file);
   const runtime = runtimeOptions.shift()!;
   const runtimeArgs = [...runtimeOptions, file];
 

diff --git a/src/modules/helpers/describe.ts b/src/modules/helpers/describe.ts
@@ -15,7 +15,7 @@ export async function describeBase(
   let options: DescribeOptions | undefined;
 
   const isPoku = typeof env?.FILE === 'string' && env?.FILE.length > 0;
-  const FILE = env.FILE;
+  const FILE = env.POKU_FILE;
 
   if (typeof arg1 === 'string') {
     title = arg1;

diff --git a/src/modules/helpers/it/core.ts b/src/modules/helpers/it/core.ts
@@ -16,8 +16,9 @@ export async function itBase(
     let message: string | undefined;
     let cb: () => unknown | Promise<unknown>;
 
-    const isPoku = typeof env?.FILE === 'string' && env?.FILE.length > 0;
-    const FILE = env.FILE;
+    const isPoku =
+      typeof env?.POKU_FILE === 'string' && env?.POKU_FILE.length > 0;
+    const FILE = env.POKU_FILE;
 
     if (typeof args[0] === 'string') {
       message = args[0];

diff --git a/src/modules/helpers/skip.ts b/src/modules/helpers/skip.ts
@@ -3,8 +3,9 @@ import { Write } from '../../services/write.js';
 import { format } from '../../services/format.js';
 
 export const skip = (message = 'Skipping') => {
-  const isPoku = typeof env?.FILE === 'string' && env?.FILE.length > 0;
-  const FILE = env.FILE;
+  const isPoku =
+    typeof env?.POKU_FILE === 'string' && env?.POKU_FILE.length > 0;
+  const FILE = env.POKU_FILE;
 
   if (message)
     Write.log(

diff --git a/src/parsers/assert.ts b/src/parsers/assert.ts
@@ -1,5 +1,3 @@
-import { fromEntries, entries } from '../polyfills/object.js';
-
 const recurse = (value: unknown): unknown => {
   if (
     typeof value === 'undefined' ||
@@ -11,9 +9,11 @@ const recurse = (value: unknown): unknown => {
     return String(value);
   if (Array.isArray(value)) return value.map(recurse);
   if (value instanceof Set) return Array.from(value).map(recurse);
-  if (value instanceof Map) return recurse(fromEntries(value));
+  if (value instanceof Map) return recurse(Object.fromEntries(value));
   if (value !== null && typeof value === 'object')
-    return fromEntries(entries(value).map(([key, val]) => [key, recurse(val)]));
+    return Object.fromEntries(
+      Object.entries(value).map(([key, val]) => [key, recurse(val)])
+    );
 
   return value;
 };

diff --git a/src/parsers/get-runner.ts b/src/parsers/get-runner.ts
@@ -7,7 +7,7 @@ import { getRuntime } from './get-runtime.js';
 export const isWindows = platform === 'win32';
 
 export const runner = (filename: string, configs?: Configs): string[] => {
-  const runtime = getRuntime(configs);
+  const runtime = getRuntime();
 
   if (runtime === 'bun') return ['bun'];
 

diff --git a/src/parsers/get-runtime.ts b/src/parsers/get-runtime.ts
@@ -1,24 +1,13 @@
-import type { Configs, Runtime } from '../@types/poku.js';
-import { version } from 'node:process';
+import type { Runtime } from '../@types/poku.js';
+import { version, env } from 'node:process';
 
 declare const Deno: unknown;
 declare const Bun: unknown;
 
 const regex = /v(\d+)\./;
 
-export const supportedPlatforms: readonly Runtime[] = ['node', 'bun', 'deno'];
-
-export const platformIsValid = (
-  platform: unknown
-): platform is (typeof supportedPlatforms)[number] =>
-  typeof platform === 'string' &&
-  supportedPlatforms.indexOf(platform as Runtime) > -1;
-
-export const getRuntime = (
-  configs?: Configs
-): (typeof supportedPlatforms)[number] => {
-  if (configs?.platform && platformIsValid(configs.platform))
-    return configs.platform;
+export const getRuntime = (): Runtime => {
+  if (env.POKU_RUNTIME) return env.POKU_RUNTIME as Runtime;
   if (typeof Deno !== 'undefined') return 'deno';
   if (typeof Bun !== 'undefined') return 'bun';
 

diff --git a/src/polyfills/deno.mts b/src/polyfills/deno.mts
@@ -1,14 +1,11 @@
-import process from 'node:process';
+import { env, exit, cwd } from 'node:process';
 import { createRequire } from 'node:module';
 import { resolve, normalize } from 'node:path';
 
-const file = process.env?.FILE;
-if (!file) {
-  process.exit(1);
-}
+const file = env?.POKU_FILE;
+if (!file) exit(1);
 
-const cwd = process.cwd();
-const targetPath = resolve(cwd, '');
+const targetPath = resolve(cwd(), '');
 const filePath = resolve(targetPath, file!);
 
 globalThis.require = createRequire(targetPath);

diff --git a/src/polyfills/object.ts b/src/polyfills/object.ts
diff --git a/src/services/assert.ts b/src/services/assert.ts
@@ -13,8 +13,9 @@ const regexFile = /file:(\/\/)?/;
 
 const assertProcessor = () => {
   const isPoku =
-    typeof process.env?.FILE === 'string' && process.env?.FILE.length > 0;
-  const FILE = process.env.FILE;
+    typeof process.env?.POKU_FILE === 'string' &&
+    process.env?.POKU_FILE.length > 0;
+  const FILE = process.env.POKU_FILE;
 
   let preIdentation = '';
 

diff --git a/src/services/run-test-file.ts b/src/services/run-test-file.ts
@@ -47,7 +47,8 @@ export const runTestFile = async (
       shell: isWindows,
       env: {
         ...env,
-        FILE: fileRelative,
+        POKU_FILE: fileRelative,
+        POKU_RUNTIME: env.POKU_RUNTIME,
       },
     });
 

diff --git a/test/__utils__/capture-cli.test.ts b/test/__utils__/capture-cli.test.ts
@@ -1,4 +1,4 @@
-import process from 'node:process';
+import process, { env } from 'node:process';
 import {
   type ChildProcessWithoutNullStreams,
   spawn,
@@ -96,6 +96,10 @@ export const inspectPoku = (
   return inspectCLI(`${cmd} ${basePath}${binFile} ${command}`, {
     shell: isWindows,
     ...options,
+    env: {
+      ...(options?.env || env),
+      POKU_RUNTIME: env.POKU_RUNTIME,
+    },
   });
 };
 
@@ -121,6 +125,10 @@ export const watchCLI = (
   const childProcess = spawn(cmd, args, {
     shell: isWindows,
     ...options,
+    env: {
+      ...(options?.env || env),
+      POKU_RUNTIME: env.POKU_RUNTIME,
+    },
   });
 
   childProcess.stdout.setEncoding('utf8');