@testforgejs/vue-test-preset-recommended-jest 1.0.0-beta.1

package/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright © 2026 Roman Levchenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,301 @@
+# @testforgejs/vue-test-preset-recommended-jest
+
+Recommended **Jest** presets for the [TestForge](https://github.com/testforgejs/testforge) Vue 3 component testing framework.
+
+This package builds on [`@testforgejs/vue-test-preset-base`](https://www.npmjs.com/package/@testforgejs/vue-test-preset-base) and provides recommended defaults for projects using **Jest**.
+
+The main difference from the base presets is the Pinia configuration: the recommended presets configure Pinia to use Jest's `jest.fn` as its `createSpy` implementation.
+
+## Installation
+
+Choose your preferred package manager.
+
+### pnpm
+
+```bash
+pnpm add -D @testforgejs/vue-test-preset-recommended-jest@beta
+```
+
+### npm
+
+```bash
+npm install -D @testforgejs/vue-test-preset-recommended-jest@beta
+```
+
+### Yarn
+
+```bash
+yarn add -D @testforgejs/vue-test-preset-recommended-jest@beta
+```
+
+> `@testforgejs/vue-test-core` and `@testforgejs/vue-test-preset-base` are required dependencies.
+
+## Quick Usage
+
+Import the `presets` object and pass it to `createTestFramework()`:
+
+```typescript
+// tests/setup.ts
+
+import { createTestFramework } from "@testforgejs/vue-test-core";
+import { presets } from "@testforgejs/vue-test-preset-recommended-jest";
+
+const { testComponentFactory } = createTestFramework({
+  presets,
+});
+
+export { testComponentFactory };
+```
+
+You can then use `testComponentFactory` in your component tests:
+
+```typescript
+import { describe, expect, it } from "@jest/globals";
+import { testComponentFactory } from "./setup";
+import MyComponent from "./MyComponent.vue";
+
+describe("MyComponent", () => {
+  it("renders", () => {
+    const factory = testComponentFactory(MyComponent);
+    const wrapper = factory();
+
+    expect(wrapper.exists()).toBe(true);
+  });
+});
+```
+
+## Available Presets
+
+The package exports four presets:
+
+- `presets.default`
+- `presets.piniaPreset`
+- `presets.i18nPreset`
+- `presets.routerPreset`
+
+The presets are based on the corresponding presets from `@testforgejs/vue-test-preset-base`.
+
+### `presets.default`
+
+The default recommended Jest preset enables:
+
+- Pinia;
+- Vue I18n;
+- Vue Router — disabled by default.
+
+It also provides default option factories for these managed plugins.
+
+For Pinia, the recommended preset additionally configures Jest's `jest.fn` as the `createSpy` implementation.
+
+```typescript
+const { testComponentFactory } = createTestFramework({
+  presets: {
+    default: presets.default,
+  },
+});
+```
+
+This is the preset intended for most Jest-based TestForge projects.
+
+### `presets.piniaPreset`
+
+A minimal preset for tests that require Pinia.
+
+It enables Pinia and configures its spy factory to use Jest:
+
+```typescript
+const { testComponentFactory } = createTestFramework({
+  presets: {
+    default: presets.piniaPreset,
+  },
+});
+```
+
+The Pinia option factory is based on the base preset and adds Jest's `jest.fn`:
+
+```typescript
+pinia: () => ({
+  ...basePiniaOptions,
+  createSpy: jest.fn,
+});
+```
+
+This makes the Pinia preset immediately usable in Jest-based TestForge projects.
+
+### `presets.i18nPreset`
+
+A minimal preset for tests that require Vue I18n.
+
+It enables Vue I18n using the base preset's default configuration:
+
+- Composition API mode (`legacy: false`);
+- English locale;
+- English fallback locale;
+- empty messages;
+- disabled missing-translation warnings.
+
+The plugin defaults are provided through a plugin options factory, so each pipeline context receives fresh plugin options.
+
+```typescript
+const { testComponentFactory } = createTestFramework({
+  presets: {
+    default: presets.i18nPreset,
+  },
+});
+```
+
+### `presets.routerPreset`
+
+A minimal preset for tests that require Vue Router.
+
+It enables the managed Vue Router integration using the base preset's default router configuration.
+
+```typescript
+const { testComponentFactory } = createTestFramework({
+  presets: {
+    default: presets.routerPreset,
+  },
+});
+```
+
+The router preset provides a test-oriented router configuration suitable for isolated component tests.
+
+Its plugin defaults are provided through a plugin options factory, which produces fresh options for each pipeline context.
+
+## Recommended vs Base Presets
+
+`@testforgejs/vue-test-preset-base` provides runner-neutral preset definitions.
+
+`@testforgejs/vue-test-preset-recommended-jest` builds on those presets and adds Jest-specific configuration where necessary.
+
+In particular:
+
+```text
+@testforgejs/vue-test-preset-base
+        │
+        ├── default
+        ├── piniaPreset
+        ├── i18nPreset
+        └── routerPreset
+                │
+                ▼
+@testforgejs/vue-test-preset-recommended-jest
+        │
+        ├── default       → adds Jest jest.fn to Pinia
+        ├── piniaPreset   → adds Jest jest.fn to Pinia
+        ├── i18nPreset    → inherited from base
+        └── routerPreset  → inherited from base
+```
+
+This separation keeps the base preset independent from a particular test runner while allowing the recommended Jest preset to provide runner-specific defaults.
+
+The Jest-specific Pinia defaults are implemented as a **plugin options factory**. The factory invokes the base Pinia options factory and adds `createSpy`:
+
+```typescript
+const defaultJestPinia = (() => ({
+  ...defaultPinia(),
+  createSpy: jest.fn,
+})) satisfies PluginOptionsFactory<VueTestPiniaOptions>;
+```
+
+The resulting factory can be reused by both the `default` and `piniaPreset` profiles.
+
+## Switching Presets at Runtime
+
+A **component factory invocation** can select a different registered preset using the fourth `extraOptions` argument:
+
+```typescript
+const factory = testComponentFactory(MyComponent);
+
+factory(
+  {},
+  {},
+  {},
+  {
+    preset: "i18nPreset",
+  },
+);
+```
+
+The selected preset defines the complete managed plugin runtime for that component factory invocation.
+
+This allows the same TestForge framework instance to use different runtime environments without creating a separate framework instance.
+
+For example:
+
+```typescript
+factory(
+  {},
+  {},
+  {},
+  {
+    preset: "piniaPreset",
+  },
+);
+```
+
+selects the Pinia-only runtime environment for that invocation.
+
+## Customizing Presets
+
+The recommended presets are ordinary TestForge preset definitions and can be composed with [`extendPreset()`](https://github.com/testforgejs/testforge).
+
+For example, a project can create its own preset from the recommended default:
+
+```typescript
+import { extendPreset } from "@testforgejs/vue-test-core";
+import { presets as recommendedPresets } from "@testforgejs/vue-test-preset-recommended-jest";
+
+const projectPresets = {
+  default: extendPreset(recommendedPresets.default, {
+    defaults: {
+      pinia: () => ({
+        ...recommendedPresets.default.defaults.pinia(),
+        // project-specific options
+      }),
+    },
+  }),
+};
+```
+
+Because `defaults.pinia` is a plugin options factory, the base Pinia options are obtained by invoking the factory.
+
+When extending a preset, explicitly preserve any base plugin options that should remain enabled. Managed plugin configuration is intentionally replaced when an extension provides configuration for that plugin.
+
+For details about preset composition and configuration layering, see the [TestForge core documentation](https://github.com/testforgejs/testforge/blob/main/packages/vue-test-core/README.md).
+
+## Using a Preset with Other Framework Configuration
+
+The exported presets can be combined with other TestForge configuration options:
+
+```typescript
+const { testComponentFactory } = createTestFramework({
+  presets,
+  shallowByDefault: true,
+});
+```
+
+The preset provides the runtime plugin baseline, while individual component factory invocations and tests can override configuration when needed.
+
+## Plugin Options Factory Isolation
+
+The `defaults` values in the presets are **plugin options factories**, not shared plugin configuration objects.
+
+When a plugin options factory is invoked, it produces fresh plugin options for the current pipeline context.
+
+This keeps mutable configuration isolated between independent pipeline contexts.
+
+This is separate from component factory isolation: `testComponentFactory()` creates a reusable function for mounting a component, while each invocation of that component factory establishes its own runtime environment.
+
+## Related Packages
+
+- [`@testforgejs/vue-test-core`](https://www.npmjs.com/package/@testforgejs/vue-test-core) — TestForge core framework
+- [`@testforgejs/vue-test-preset-base`](https://www.npmjs.com/package/@testforgejs/vue-test-preset-base) — base, runner-neutral presets
+- [`@testforgejs/vue-test-preset-recommended`](https://www.npmjs.com/package/@testforgejs/vue-test-preset-recommended) — recommended Vitest presets
+- [`@testforgejs/vue-test-plugin-pinia`](https://www.npmjs.com/package/@testforgejs/vue-test-plugin-pinia) — Pinia integration
+- [`@testforgejs/vue-test-plugin-i18n`](https://www.npmjs.com/package/@testforgejs/vue-test-plugin-i18n) — Vue I18n integration
+- [`@testforgejs/vue-test-plugin-router`](https://www.npmjs.com/package/@testforgejs/vue-test-plugin-router) — Vue Router integration
+
+## License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,52 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  presets: () => presets
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/presets.ts
+var import_vue_test_core = require("@testforgejs/vue-test-core");
+var import_vue_test_preset_base = require("@testforgejs/vue-test-preset-base");
+var import_globals = require("@jest/globals");
+var defaultJestPinia = (() => ({
+  ...(0, import_vue_test_preset_base.defaultPinia)(),
+  createSpy: import_globals.jest.fn
+}));
+var presets = {
+  default: (0, import_vue_test_core.extendPreset)(import_vue_test_preset_base.presets.default, {
+    defaults: {
+      pinia: defaultJestPinia
+    }
+  }),
+  piniaPreset: (0, import_vue_test_core.extendPreset)(import_vue_test_preset_base.presets.piniaPreset, {
+    defaults: {
+      pinia: defaultJestPinia
+    }
+  }),
+  i18nPreset: import_vue_test_preset_base.presets.i18nPreset,
+  routerPreset: import_vue_test_preset_base.presets.routerPreset
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  presets
+});

package/dist/index.d.cts

@@ -0,0 +1,31 @@
+import * as _testforgejs_vue_test_plugin_router from '@testforgejs/vue-test-plugin-router';
+import * as vue_router from 'vue-router';
+import * as _testforgejs_vue_test_plugin_i18n from '@testforgejs/vue-test-plugin-i18n';
+import * as vue_i18n from 'vue-i18n';
+import * as _testforgejs_vue_test_core from '@testforgejs/vue-test-core';
+import { PluginOptionsFactory } from '@testforgejs/vue-test-core';
+
+declare const presets: {
+    default: _testforgejs_vue_test_core.PresetDefinition;
+    piniaPreset: _testforgejs_vue_test_core.PresetDefinition;
+    i18nPreset: {
+        manifest: {
+            module: _testforgejs_vue_test_core.PluginModule<vue_i18n.I18n<{}, {}, {}, string, boolean>, _testforgejs_vue_test_plugin_i18n.VueTestI18nOptions>;
+            enabled: true;
+        }[];
+        defaults: {
+            i18n: PluginOptionsFactory<_testforgejs_vue_test_plugin_i18n.VueTestI18nOptions>;
+        };
+    };
+    routerPreset: {
+        manifest: {
+            module: _testforgejs_vue_test_core.PluginModule<vue_router._RouterClassic, _testforgejs_vue_test_plugin_router.VueTestRouterOptions>;
+            enabled: true;
+        }[];
+        defaults: {
+            router: PluginOptionsFactory<_testforgejs_vue_test_plugin_router.VueTestRouterOptions>;
+        };
+    };
+};
+
+export { presets };

package/dist/index.d.ts

@@ -0,0 +1,31 @@
+import * as _testforgejs_vue_test_plugin_router from '@testforgejs/vue-test-plugin-router';
+import * as vue_router from 'vue-router';
+import * as _testforgejs_vue_test_plugin_i18n from '@testforgejs/vue-test-plugin-i18n';
+import * as vue_i18n from 'vue-i18n';
+import * as _testforgejs_vue_test_core from '@testforgejs/vue-test-core';
+import { PluginOptionsFactory } from '@testforgejs/vue-test-core';
+
+declare const presets: {
+    default: _testforgejs_vue_test_core.PresetDefinition;
+    piniaPreset: _testforgejs_vue_test_core.PresetDefinition;
+    i18nPreset: {
+        manifest: {
+            module: _testforgejs_vue_test_core.PluginModule<vue_i18n.I18n<{}, {}, {}, string, boolean>, _testforgejs_vue_test_plugin_i18n.VueTestI18nOptions>;
+            enabled: true;
+        }[];
+        defaults: {
+            i18n: PluginOptionsFactory<_testforgejs_vue_test_plugin_i18n.VueTestI18nOptions>;
+        };
+    };
+    routerPreset: {
+        manifest: {
+            module: _testforgejs_vue_test_core.PluginModule<vue_router._RouterClassic, _testforgejs_vue_test_plugin_router.VueTestRouterOptions>;
+            enabled: true;
+        }[];
+        defaults: {
+            router: PluginOptionsFactory<_testforgejs_vue_test_plugin_router.VueTestRouterOptions>;
+        };
+    };
+};
+
+export { presets };

package/dist/index.js

@@ -0,0 +1,25 @@
+// src/presets.ts
+import { extendPreset } from "@testforgejs/vue-test-core";
+import { defaultPinia, presets as basePresets } from "@testforgejs/vue-test-preset-base";
+import { jest } from "@jest/globals";
+var defaultJestPinia = (() => ({
+  ...defaultPinia(),
+  createSpy: jest.fn
+}));
+var presets = {
+  default: extendPreset(basePresets.default, {
+    defaults: {
+      pinia: defaultJestPinia
+    }
+  }),
+  piniaPreset: extendPreset(basePresets.piniaPreset, {
+    defaults: {
+      pinia: defaultJestPinia
+    }
+  }),
+  i18nPreset: basePresets.i18nPreset,
+  routerPreset: basePresets.routerPreset
+};
+export {
+  presets
+};

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@testforgejs/vue-test-preset-recommended-jest",
+  "version": "1.0.0-beta.1",
+  "type": "module",
+  "description": "Official recommended preset for projects using Jest with the TestForge framework",
+  "homepage": "https://github.com/testforgejs/testforge#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/testforgejs/testforge.git",
+    "directory": "packages/vue-test-preset-recommended-jest"
+  },
+  "bugs": {
+    "url": "https://github.com/testforgejs/testforge/issues"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "vue",
+    "vue3",
+    "testing",
+    "component-testing",
+    "vue-test-utils",
+    "preset",
+    "configuration",
+    "jest",
+    "testforge",
+    "testforge-preset"
+  ],
+  "license": "MIT",
+  "author": "Roman Levchenko",
+  "dependencies": {
+    "@testforgejs/vue-test-plugin-i18n": "1.0.0-beta.1",
+    "@testforgejs/vue-test-plugin-pinia": "1.0.0-beta.1",
+    "@testforgejs/vue-test-plugin-router": "1.0.0-beta.1"
+  },
+  "peerDependencies": {
+    "@jest/globals": "^30.0.0",
+    "jest": "^30.0.0",
+    "@testforgejs/vue-test-core": "1.0.0-beta.1",
+    "@testforgejs/vue-test-preset-base": "1.0.0-beta.1"
+  },
+  "devDependencies": {
+    "@jest/globals": "^30.0.0",
+    "jest": "^30.0.0",
+    "@testforgejs/vue-test-core": "1.0.0-beta.1",
+    "@testforgejs/vue-test-preset-base": "1.0.0-beta.1"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch"
+  }
+}