@aljazmc/testero 0.3.0 → 0.3.2

package/README.md

@@ -1,10 +1,16 @@
-![Custom](https://img.shields.io/badge/project_status-barely_working-yellow) ![Custom](https://img.shields.io/badge/breaking_changes-common-red) ![NPM Downloads](https://img.shields.io/npm/dm/%40aljazmc%2Ftestero) ![GitHub package.json version](https://img.shields.io/github/package-json/v/aljazmc/aljazmc?filename=packages%2Ftestero%2Fpackage.json&color=green) ![GitHub License](https://img.shields.io/github/license/aljazmc/aljazmc)
+![Custom](https://img.shields.io/badge/project_status-mostly_working-green) ![Custom](https://img.shields.io/badge/breaking_changes-common-red) ![NPM Downloads](https://img.shields.io/npm/dm/%40aljazmc%2Ftestero) ![GitHub package.json version](https://img.shields.io/github/package-json/v/aljazmc/aljazmc?filename=packages%2Ftestero%2Fpackage.json&color=green) ![GitHub License](https://img.shields.io/github/license/aljazmc/aljazmc)
 
 # > testero
 
 A simple, Jest-like test runner. Easy to understand, easy to customize and easy to extend.
 
-## > usage
+## > Install
+
+```sh
+npm install --save-dev @aljazmc/testero
+```
+
+## > Usage
 
 ```sh
 testero                    # run every test file
@@ -16,7 +22,9 @@ testero --config           # write the defaults to testero.config.ts, --config j
 testero --help
 ```
 
-Test files are written like for [Jest](https://jestjs.io), in JavaScript, TypeScript or JSX, with the same globals:
+## > Writing tests
+
+testero runs test files written in JavaScript, TypeScript or JSX, with the same globals as [Jest](https://jestjs.io):
 
 ```ts
 import { add } from "../src/math.ts";
@@ -49,9 +57,11 @@ describe("add", () => {
 - asymmetric matchers: `expect.any`, `expect.anything`, `expect.objectContaining`, `expect.arrayContaining`, `expect.stringContaining`, `expect.stringMatching`, `expect.closeTo` and their `expect.not` variants
 - `testero.fn`, `testero.spyOn`, `testero.clearAllMocks`, `testero.resetAllMocks`, `testero.restoreAllMocks` and `testero.setTimeout`, also as `jest`; imports from `@jest/globals` get the same functions
 
-Failures show the message, a diff of expected and received values, and the code where they happened.
+testero reports each failure with its message, a diff of the expected and received values, and the code where it happened.
+
+## > Configuration
 
-Settings follow Jest's names and defaults. Override them with `testero.config.ts` or `testero.config.js` in the current directory; objects are merged deeply, anything else (like `ignore`) replaces the default:
+testero reads `testero.config.ts` or `testero.config.js` from the current directory, with Jest's names and defaults. Objects are merged deeply into the defaults, anything else (like `ignore`) replaces them:
 
 ```js
 export default {
@@ -73,7 +83,7 @@ export default {
 };
 ```
 
-## > how it works
+## > How it works
 
 - `src/transformer.ts`: bundles each test file and the local files it imports with [esbuild](https://esbuild.github.io), the only dependency, into one module; installed packages stay external and the globals are injected where the file uses them
 - `src/collector.ts`: the `describe`, `test` and hook functions, collecting what a test file declares into a tree of suites (`src/suite.ts`)
@@ -84,4 +94,4 @@ export default {
 - `src/testero.ts`: finds the test files and runs them one after another
 - `@aljazmc/config` (`shared/config`): loads `testero.config.ts`, finds the files and matches `testMatch`, shared with every package
 
-Each test file is bundled on its own, so it gets fresh copies of the files it imports, and spies are restored after it. Test files run one after another in one process, without workers, module mocking, fake timers, snapshots or coverage.
+testero bundles each test file on its own, so it gets fresh copies of the files it imports, and spies are restored after it. Test files run one after another in one process, without workers, module mocking, fake timers, snapshots or coverage.

package/bin/main.js

@@ -1667,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. */
@@ -1691,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);'
@@ -1709,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))
@@ -1731,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",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aljazmc/testero",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "A simple, Jest like test runner. Easy to understand, easy to customize and easy to extend.",
   "author": "aljazmc",
   "license": "MIT",