@openendurance/config-jest 0.0.0-stage → 0.1.1

package/README.md

@@ -1,3 +1,42 @@
-# Temporary Holding Version
+# @openendurance/config-jest
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Shared Jest configuration for Open Endurance Initiative projects.
+
+This package provides a small default config and a helper that maps TypeScript path aliases into Jest's `moduleNameMapper`, which is the part that usually trips projects up.
+
+## Usage
+
+Install the matching test dependencies in the consuming project first:
+
+```sh
+pnpm add -D jest@^30.4.2 ts-jest@^29.4.11 typescript@^6.0.3
+```
+
+```js
+const { createJestConfig } = require("@openendurance/config-jest");
+
+module.exports = createJestConfig({
+	tsconfigPath: "<rootDir>/tsconfig.json",
+});
+```
+
+## What It Does
+
+- Sets up `ts-jest` for TypeScript test files
+- Infers Jest aliases from the `compilerOptions.paths` section of the chosen tsconfig file
+- Keeps the default environment simple so consumers can override to `jsdom` or something more specific when needed
+
+## Options
+
+| Option             | Purpose                                                                 |
+| ------------------ | ----------------------------------------------------------------------- |
+| `tsconfigPath`     | Path to the tsconfig file whose path aliases should be mapped into Jest |
+| `testEnvironment`  | Jest environment to use; defaults to `node`                             |
+| `moduleNameMapper` | Additional or overriding Jest module name mappings                      |
+| `transform`        | Optional custom transform overrides                                     |
+
+## Conventions
+
+- Keep the default config minimal and predictable
+- Use the helper when you need TypeScript aliases in Jest
+- Override locally for framework-specific needs like `jsdom`, React Native, or Electron renderer tests

package/package.json

@@ -1,6 +1,41 @@
 {
-  "name": "@openendurance/config-jest",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"$schema": "https://json.schemastore.org/package",
+	"name": "@openendurance/config-jest",
+	"version": "0.1.1",
+	"license": "Apache-2.0",
+	"author": "Kristopher Cargile <k@algorythmic.com>",
+	"description": "Shared Jest configuration for Open Endurance Initiative projects.",
+	"keywords": [
+		"endurance-sports",
+		"fitness",
+		"healthtech",
+		"oei",
+		"open-endurance-initiative",
+		"open-source",
+		"openenduranceinitiative"
+	],
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/openendurance/config-dev.git"
+	},
+	"publishConfig": {
+		"access": "public",
+		"provenance": true
+	},
+	"peerDependencies": {
+		"jest": "^30.4.2",
+		"ts-jest": "^29.4.11",
+		"typescript": "^6.0.3"
+	},
+	"files": [
+		"README.md",
+		"src"
+	],
+	"main": "./src/index.js",
+	"exports": "./src/index.js",
+	"scripts": {
+		"build": "pnpm run lint",
+		"lint": "pnpm exec biome lint README.md src",
+		"prepack": "pnpm run build"
+	}
+}

package/src/index.js

@@ -0,0 +1,92 @@
+const fs = require("node:fs");
+const path = require("node:path");
+
+function escapeRegex(value) {
+	return value.replace(/[|\\{}()[\]^$+*?.]/g, "\\$&");
+}
+
+function globToModulePattern(pattern) {
+	const wildcardIndex = pattern.indexOf("*");
+	if (wildcardIndex === -1) {
+		return `^${escapeRegex(pattern)}$`;
+	}
+
+	const prefix = escapeRegex(pattern.slice(0, wildcardIndex));
+	const suffix = escapeRegex(pattern.slice(wildcardIndex + 1));
+	return `^${prefix}(.*)${suffix}$`;
+}
+
+function resolveTsconfig(tsconfigPath) {
+	if (!tsconfigPath) {
+		return {};
+	}
+
+	const absolutePath = path.isAbsolute(tsconfigPath)
+		? tsconfigPath
+		: path.resolve(process.cwd(), tsconfigPath);
+
+	if (!fs.existsSync(absolutePath)) {
+		return {};
+	}
+
+	const raw = fs.readFileSync(absolutePath, "utf8");
+	try {
+		return JSON.parse(raw);
+	} catch {
+		return {};
+	}
+}
+
+function createModuleNameMapper(paths, rootPrefix = "<rootDir>/") {
+	if (!paths || typeof paths !== "object") {
+		return {};
+	}
+
+	return Object.entries(paths).reduce((mapper, [key, targets]) => {
+		if (!Array.isArray(targets) || targets.length === 0) {
+			return mapper;
+		}
+
+		const target = targets[0];
+		if (typeof target !== "string") {
+			return mapper;
+		}
+
+		const pattern = globToModulePattern(key);
+		const replacement = `${rootPrefix}${target.replace(/\*/g, "$1")}`;
+		mapper[pattern] = replacement;
+		return mapper;
+	}, {});
+}
+
+function createJestConfig(options = {}) {
+	const {
+		tsconfigPath = "tsconfig.json",
+		testEnvironment = "node",
+		moduleNameMapper = {},
+		transform = {},
+		...rest
+	} = options;
+
+	const tsconfig = resolveTsconfig(tsconfigPath);
+	const compilerOptions = tsconfig.compilerOptions || {};
+	const mappedAliases = createModuleNameMapper(compilerOptions.paths);
+
+	return {
+		testEnvironment,
+		moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "mjs", "cjs"],
+		transform: {
+			"^.+\\.(ts|tsx)$": ["ts-jest", { tsconfig: tsconfigPath }],
+			...transform,
+		},
+		moduleNameMapper: {
+			...mappedAliases,
+			...moduleNameMapper,
+		},
+		...rest,
+	};
+}
+
+module.exports = createJestConfig;
+module.exports.createJestConfig = createJestConfig;
+module.exports.createModuleNameMapper = createModuleNameMapper;