@testforgejs/vue-test-preset-recommended 1.0.0-beta.0

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,128 @@
+# @testforgejs/vue-test-preset-recommended
+
+Recommended presets for the [TestForge](https://github.com/testforgejs/testforge) Vue 3 component testing framework.
+
+This package provides ready-to-use TestForge presets with sensible defaults for commonly used Vue plugins.
+
+## Installation
+
+Choose your preferred package manager.
+
+### pnpm
+
+```bash
+pnpm add -D @testforgejs/vue-test-preset-recommended@beta
+```
+
+### npm
+
+```bash
+npm install -D @testforgejs/vue-test-preset-recommended@beta
+```
+
+### Yarn
+
+```bash
+yarn add -D @testforgejs/vue-test-preset-recommended@beta
+```
+
+> `@testforgejs/vue-test-core` is required.
+
+## 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";
+
+const { testComponentFactory } = createTestFramework({
+  presets,
+});
+
+export { testComponentFactory };
+```
+
+You can then use `testComponentFactory` in your component tests:
+
+```typescript
+import { describe, expect, it } from "vitest";
+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 currently exports the following presets:
+
+### `presets.default`
+
+The default recommended preset enables the following managed plugins:
+
+- Pinia
+- Vue I18n
+- Vue Router — disabled by default
+
+It also provides default configuration for Pinia, Vue I18n, and Vue Router.
+
+```typescript
+const { testComponentFactory } = createTestFramework({
+  presets: {
+    default: presets.default,
+  },
+});
+```
+
+### `presets.i18nPreset`
+
+A minimal preset for tests that require Vue I18n.
+
+It enables Vue I18n with:
+
+- Composition API mode (`legacy: false`);
+- English locale;
+- English fallback locale;
+- empty messages;
+- disabled missing-translation warnings.
+
+```typescript
+const { testComponentFactory } = createTestFramework({
+  presets: {
+    default: presets.i18nPreset,
+  },
+});
+```
+
+## 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 baseline plugin configuration, while individual factories and tests can override configuration when needed.
+
+## Related Packages
+
+- [`@testforgejs/vue-test-core`](https://www.npmjs.com/package/@testforgejs/vue-test-core) — core TestForge testing framework
+- [`@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,86 @@
+"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/defaults/defaultI18n.ts
+var defaultI18n = {
+  legacy: false,
+  locale: "en",
+  fallbackLocale: "en",
+  messages: {},
+  fallbackWarn: false,
+  missingWarn: false
+};
+
+// src/defaults/defaultPinia.ts
+var defaultPinia = {
+  initialState: {},
+  stubActions: false,
+  createSpy: void 0
+};
+
+// src/defaults/defaultRouter.ts
+var import_vue_router = require("vue-router");
+var isBrowser = typeof window !== "undefined";
+var getDefaultRouter = () => ({
+  history: isBrowser ? (0, import_vue_router.createWebHistory)() : (0, import_vue_router.createMemoryHistory)(),
+  routes: [{ path: "/", component: { render: () => null } }]
+});
+
+// src/presets.ts
+var import_vue_test_plugin_pinia = require("@testforgejs/vue-test-plugin-pinia");
+var import_vue_test_plugin_i18n = require("@testforgejs/vue-test-plugin-i18n");
+var import_vue_test_plugin_router = require("@testforgejs/vue-test-plugin-router");
+var presets = {
+  default: {
+    manifest: [
+      { module: import_vue_test_plugin_pinia.piniaPlugin, enabled: true },
+      { module: import_vue_test_plugin_i18n.i18nPlugin, enabled: true },
+      { module: import_vue_test_plugin_router.routerPlugin, enabled: false }
+    ],
+    defaults: {
+      i18n: defaultI18n,
+      pinia: defaultPinia,
+      router: getDefaultRouter()
+    }
+  },
+  i18nPreset: {
+    manifest: [{ module: import_vue_test_plugin_i18n.i18nPlugin, enabled: true }],
+    defaults: {
+      i18n: {
+        legacy: false,
+        locale: "en",
+        fallbackLocale: "en",
+        messages: {},
+        fallbackWarn: false,
+        missingWarn: false
+      }
+    }
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  presets
+});

package/dist/index.d.cts

@@ -0,0 +1,45 @@
+import * as _testforgejs_vue_test_plugin_router from '@testforgejs/vue-test-plugin-router';
+import * as vue_router from 'vue-router';
+import * as vue_i18n from 'vue-i18n';
+import * as _testforgejs_vue_test_core from '@testforgejs/vue-test-core';
+import * as _testforgejs_vue_test_plugin_pinia from '@testforgejs/vue-test-plugin-pinia';
+import * as pinia from 'pinia';
+import { VueTestI18nOptions } from '@testforgejs/vue-test-plugin-i18n';
+
+declare const presets: {
+    default: {
+        manifest: ({
+            module: _testforgejs_vue_test_core.PluginModule<pinia.Pinia, _testforgejs_vue_test_plugin_pinia.VueTestPiniaOptions>;
+            enabled: true;
+        } | {
+            module: _testforgejs_vue_test_core.PluginModule<vue_i18n.I18n<{}, {}, {}, string, boolean>, VueTestI18nOptions>;
+            enabled: true;
+        } | {
+            module: _testforgejs_vue_test_core.PluginModule<vue_router._RouterClassic, _testforgejs_vue_test_plugin_router.VueTestRouterOptions>;
+            enabled: false;
+        })[];
+        defaults: {
+            i18n: VueTestI18nOptions;
+            pinia: _testforgejs_vue_test_plugin_pinia.VueTestPiniaOptions;
+            router: _testforgejs_vue_test_plugin_router.VueTestRouterOptions;
+        };
+    };
+    i18nPreset: {
+        manifest: {
+            module: _testforgejs_vue_test_core.PluginModule<vue_i18n.I18n<{}, {}, {}, string, boolean>, VueTestI18nOptions>;
+            enabled: true;
+        }[];
+        defaults: {
+            i18n: {
+                legacy: false;
+                locale: string;
+                fallbackLocale: string;
+                messages: {};
+                fallbackWarn: false;
+                missingWarn: false;
+            };
+        };
+    };
+};
+
+export { presets };

package/dist/index.d.ts

@@ -0,0 +1,45 @@
+import * as _testforgejs_vue_test_plugin_router from '@testforgejs/vue-test-plugin-router';
+import * as vue_router from 'vue-router';
+import * as vue_i18n from 'vue-i18n';
+import * as _testforgejs_vue_test_core from '@testforgejs/vue-test-core';
+import * as _testforgejs_vue_test_plugin_pinia from '@testforgejs/vue-test-plugin-pinia';
+import * as pinia from 'pinia';
+import { VueTestI18nOptions } from '@testforgejs/vue-test-plugin-i18n';
+
+declare const presets: {
+    default: {
+        manifest: ({
+            module: _testforgejs_vue_test_core.PluginModule<pinia.Pinia, _testforgejs_vue_test_plugin_pinia.VueTestPiniaOptions>;
+            enabled: true;
+        } | {
+            module: _testforgejs_vue_test_core.PluginModule<vue_i18n.I18n<{}, {}, {}, string, boolean>, VueTestI18nOptions>;
+            enabled: true;
+        } | {
+            module: _testforgejs_vue_test_core.PluginModule<vue_router._RouterClassic, _testforgejs_vue_test_plugin_router.VueTestRouterOptions>;
+            enabled: false;
+        })[];
+        defaults: {
+            i18n: VueTestI18nOptions;
+            pinia: _testforgejs_vue_test_plugin_pinia.VueTestPiniaOptions;
+            router: _testforgejs_vue_test_plugin_router.VueTestRouterOptions;
+        };
+    };
+    i18nPreset: {
+        manifest: {
+            module: _testforgejs_vue_test_core.PluginModule<vue_i18n.I18n<{}, {}, {}, string, boolean>, VueTestI18nOptions>;
+            enabled: true;
+        }[];
+        defaults: {
+            i18n: {
+                legacy: false;
+                locale: string;
+                fallbackLocale: string;
+                messages: {};
+                fallbackWarn: false;
+                missingWarn: false;
+            };
+        };
+    };
+};
+
+export { presets };

package/dist/index.js

@@ -0,0 +1,59 @@
+// src/defaults/defaultI18n.ts
+var defaultI18n = {
+  legacy: false,
+  locale: "en",
+  fallbackLocale: "en",
+  messages: {},
+  fallbackWarn: false,
+  missingWarn: false
+};
+
+// src/defaults/defaultPinia.ts
+var defaultPinia = {
+  initialState: {},
+  stubActions: false,
+  createSpy: void 0
+};
+
+// src/defaults/defaultRouter.ts
+import { createMemoryHistory, createWebHistory } from "vue-router";
+var isBrowser = typeof window !== "undefined";
+var getDefaultRouter = () => ({
+  history: isBrowser ? createWebHistory() : createMemoryHistory(),
+  routes: [{ path: "/", component: { render: () => null } }]
+});
+
+// src/presets.ts
+import { piniaPlugin } from "@testforgejs/vue-test-plugin-pinia";
+import { i18nPlugin } from "@testforgejs/vue-test-plugin-i18n";
+import { routerPlugin } from "@testforgejs/vue-test-plugin-router";
+var presets = {
+  default: {
+    manifest: [
+      { module: piniaPlugin, enabled: true },
+      { module: i18nPlugin, enabled: true },
+      { module: routerPlugin, enabled: false }
+    ],
+    defaults: {
+      i18n: defaultI18n,
+      pinia: defaultPinia,
+      router: getDefaultRouter()
+    }
+  },
+  i18nPreset: {
+    manifest: [{ module: i18nPlugin, enabled: true }],
+    defaults: {
+      i18n: {
+        legacy: false,
+        locale: "en",
+        fallbackLocale: "en",
+        messages: {},
+        fallbackWarn: false,
+        missingWarn: false
+      }
+    }
+  }
+};
+export {
+  presets
+};

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@testforgejs/vue-test-preset-recommended",
+  "version": "1.0.0-beta.0",
+  "type": "module",
+  "description": "Official recommended preset for getting started 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"
+  },
+  "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",
+    "recommended",
+    "testforge",
+    "testforge-preset"
+  ],
+  "license": "MIT",
+  "author": "Roman Levchenko",
+  "dependencies": {
+    "@testforgejs/vue-test-plugin-pinia": "1.0.0-beta.0",
+    "@testforgejs/vue-test-plugin-i18n": "1.0.0-beta.0",
+    "@testforgejs/vue-test-plugin-router": "1.0.0-beta.0"
+  },
+  "peerDependencies": {
+    "@testforgejs/vue-test-core": "1.0.0-beta.0"
+  },
+  "devDependencies": {
+    "@testforgejs/vue-test-core": "1.0.0-beta.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch"
+  }
+}