@aljazmc/testero 0.2.1 → 0.3.1

package/README.md

@@ -12,6 +12,7 @@ testero math unit/         # run test files whose path matches a pattern
 testero -t "adds numbers"  # run tests whose full name matches
 testero --verbose --bail   # list every test, stop at the first failing file
 testero --listTests        # print the test files instead of running them
+testero --config           # write the defaults to testero.config.ts, --config js to testero.config.js
 testero --help
 ```
 

package/bin/main.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 // shared/config/src/config.ts
-import { existsSync, readdirSync, readFileSync } from "node:fs";
+import { existsSync, readdirSync, readFileSync, writeFileSync } from "node:fs";
 import { join } from "node:path";
 import { pathToFileURL } from "node:url";
 
@@ -87,6 +87,62 @@ var Config = class _Config {
     }
     return new _Config(defaults, root);
   }
+  /** Handles `--config`, writing the defaults to a TypeScript config file, or with `--config js` a JavaScript one. Returns whether it was given. */
+  static init(name, defaults, argv = process.argv.slice(2), root = process.cwd()) {
+    const index = argv.indexOf("--config");
+    if (index === -1) return false;
+    const next = argv[index + 1];
+    const extension = next === void 0 || next.startsWith("-") ? "ts" : next;
+    try {
+      console.log(
+        `created: ${_Config.export(name, defaults, extension, root)}`
+      );
+    } catch (error) {
+      console.error(error instanceof Error ? error.message : error);
+      process.exitCode = 1;
+    }
+    return true;
+  }
+  /** Writes the defaults to `<name>.config.<extension>` in the root, unless a config file is there already. */
+  static export(name, defaults, extension = "ts", root = process.cwd()) {
+    if (!_Config.extensions.includes(extension))
+      throw new Error(
+        `Unknown config file type ${extension}, use ts or js.`
+      );
+    for (const existing of _Config.extensions) {
+      const file2 = `${name}.config.${existing}`;
+      if (existsSync(join(root, file2)))
+        throw new Error(`${file2} already exists.`);
+    }
+    const file = `${name}.config.${extension}`;
+    writeFileSync(
+      join(root, file),
+      `export default ${_Config.#literal(defaults)};
+`
+    );
+    return file;
+  }
+  /** A value as JavaScript source, objects one property per line, short arrays on one line. */
+  static #literal(value, indent = "") {
+    const inner = `${indent}    `;
+    const lines = (items, open, close) => items.length === 0 ? `${open}${close}` : `${open}
+${items.map((item) => `${inner}${item},
+`).join("")}${indent}${close}`;
+    if (Array.isArray(value)) {
+      const items = value.map((item) => _Config.#literal(item, inner));
+      const line = `[${items.join(", ")}]`;
+      return line.length <= 60 && !line.includes("\n") ? line : lines(items, "[", "]");
+    }
+    if (value?.constructor === Object)
+      return lines(
+        Object.entries(value).map(
+          ([key, item]) => `${/^[A-Za-z_$][\w$]*$/.test(key) ? key : JSON.stringify(key)}: ${_Config.#literal(item, inner)}`
+        ),
+        "{",
+        "}"
+      );
+    return JSON.stringify(value);
+  }
   /** Deep merges plain objects, anything else in override replaces base. */
   static merge(base, override) {
     const plain = (value) => value?.constructor === Object;
@@ -148,6 +204,7 @@ Options:
   --listTests                    print the test files instead of running them
   --passWithNoTests              succeed when there are no test files
   --testTimeout <ms>             milliseconds a test or hook may take
+  --config [js]                  write the default testero.config.ts, or .js
   -h, --help                     show this help
 `;
   patterns = [];
@@ -1592,7 +1649,7 @@ import { dirname as dirname2, isAbsolute, relative } from "node:path";
 import { fileURLToPath } from "node:url";
 
 // packages/testero/src/transformer.ts
-import { mkdtempSync, readFileSync as readFileSync2, rmSync, writeFileSync } from "node:fs";
+import { mkdtempSync, readFileSync as readFileSync2, rmSync, writeFileSync as writeFileSync2 } from "node:fs";
 import { tmpdir } from "node:os";
 import { dirname, extname, join as join2, sep } from "node:path";
 import { pathToFileURL as pathToFileURL2 } from "node:url";
@@ -1610,6 +1667,8 @@ var Transformer = class _Transformer {
     ".mts": "ts",
     ".tsx": "tsx"
   };
+  /** The import.meta properties that describe the source file. */
+  static #meta = ["url", "filename", "dirname"];
   /** Marks the resolutions the plugin asks esbuild for itself. */
   static #own = /* @__PURE__ */ Symbol("testero");
   /** Where compiled test files go, stack frames there are testero's own. */
@@ -1618,7 +1677,7 @@ var Transformer = class _Transformer {
   #globals = join2(this.#directory, "globals.mjs");
   #count = 0;
   constructor() {
-    writeFileSync(this.#globals, Globals.source());
+    writeFileSync2(this.#globals, Globals.source());
   }
   /** Bundles a test file, returns the URL of the module to import. */
   async compile(file) {
@@ -1634,6 +1693,12 @@ var Transformer = class _Transformer {
       sourcemap: "inline",
       sourcesContent: false,
       inject: [this.#globals],
+      define: Object.fromEntries(
+        _Transformer.#meta.map((name) => [
+          `import.meta.${name}`,
+          `__testero.${name}`
+        ])
+      ),
       // CommonJS code in the bundle may require installed packages
       banner: {
         js: 'import { createRequire as __testeroRequire } from "node:module";\nconst require = __testeroRequire(import.meta.url);'
@@ -1641,7 +1706,7 @@ var Transformer = class _Transformer {
       logLevel: "silent",
       plugins: [this.#plugin()]
     });
-    writeFileSync(outfile, outputFiles[0]?.text ?? "");
+    writeFileSync2(outfile, outputFiles[0]?.text ?? "");
     return pathToFileURL2(outfile).href;
   }
   /** Removes the compiled files. */
@@ -1652,6 +1717,21 @@ var Transformer = class _Transformer {
     return {
       name: "testero",
       setup: (build2) => {
+        build2.onResolve({ filter: /^testero-meta:/ }, (args) => ({
+          path: args.path.slice("testero-meta:".length),
+          namespace: "testero-meta"
+        }));
+        build2.onLoad(
+          { filter: /.*/, namespace: "testero-meta" },
+          (args) => ({
+            contents: `export default ${JSON.stringify({
+              url: pathToFileURL2(args.path).href,
+              filename: args.path,
+              dirname: dirname(args.path)
+            })};`,
+            loader: "js"
+          })
+        );
         build2.onResolve({ filter: /^[^./]/ }, async (args) => {
           if (args.pluginData === _Transformer.#own) return void 0;
           if (_Transformer.modules.includes(args.path))
@@ -1674,15 +1754,10 @@ var Transformer = class _Transformer {
         });
         build2.onLoad({ filter: /\.[cm]?[jt]sx?$/ }, (args) => {
           if (_Transformer.#installed(args.path)) return void 0;
-          const values = {
-            url: pathToFileURL2(args.path).href,
-            filename: args.path,
-            dirname: dirname(args.path)
-          };
-          const contents = readFileSync2(args.path, "utf8").replace(
-            /\bimport\.meta\.(url|filename|dirname)\b/g,
-            (_, name) => JSON.stringify(values[name])
-          );
+          const source = readFileSync2(args.path, "utf8");
+          const contents = /\bimport\.meta\b/.test(source) ? `${source}
+import __testero from ${JSON.stringify(`testero-meta:${args.path}`)};
+` : source;
           return {
             contents,
             loader: _Transformer.#loaders[extname(args.path)] ?? "js",
@@ -2125,6 +2200,7 @@ var Testero = class {
 
 // packages/testero/src/index.ts
 try {
+  if (Config.init("testero", config_default)) process.exit();
   const args = new Arguments(process.argv.slice(2));
   if (args.help) process.stdout.write(Arguments.usage);
   else {

package/bin/types/arguments.d.ts

@@ -2,7 +2,7 @@ import type { Rules } from "./rules.js";
 import type { Options } from "./testero.js";
 /** Command line arguments, named like Jest's. */
 export default class Arguments {
-    static readonly usage = "Usage: testero [patterns...] [options]\n\nRuns the test files whose paths match a pattern, every test file without patterns.\n\nOptions:\n  -t, --testNamePattern <regex>  run only tests whose name matches\n  --bail                         stop after the first failing test file\n  --verbose                      list every test\n  --listTests                    print the test files instead of running them\n  --passWithNoTests              succeed when there are no test files\n  --testTimeout <ms>             milliseconds a test or hook may take\n  -h, --help                     show this help\n";
+    static readonly usage = "Usage: testero [patterns...] [options]\n\nRuns the test files whose paths match a pattern, every test file without patterns.\n\nOptions:\n  -t, --testNamePattern <regex>  run only tests whose name matches\n  --bail                         stop after the first failing test file\n  --verbose                      list every test\n  --listTests                    print the test files instead of running them\n  --passWithNoTests              succeed when there are no test files\n  --testTimeout <ms>             milliseconds a test or hook may take\n  --config [js]                  write the default testero.config.ts, or .js\n  -h, --help                     show this help\n";
     readonly patterns: string[];
     readonly rules: Partial<Rules>;
     namePattern: RegExp | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aljazmc/testero",
-  "version": "0.2.1",
+  "version": "0.3.1",
   "description": "A simple, Jest like test runner. Easy to understand, easy to customize and easy to extend.",
   "author": "aljazmc",
   "license": "MIT",
@@ -20,7 +20,7 @@
     "modular"
   ],
   "engines": {
-    "node": "^20.19.0 || ^22.13.0 || ^24 || ^25 || ^26"
+    "node": "^22.18.0 || ^24 || ^25 || ^26"
   },
   "types": "./bin/types/testero.d.ts",
   "bin": "./bin/main.js",