@testforgejs/vue-test-plugin-i18n 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,60 @@
+# @testforgejs/vue-test-plugin-i18n
+
+Vue I18n integration for TestForge component tests.
+
+## Installation
+
+Choose your preferred package manager.
+
+### pnpm
+
+```bash
+pnpm add -D @testforgejs/vue-test-plugin-i18n@beta
+```
+
+### npm
+
+```bash
+npm install -D @testforgejs/vue-test-plugin-i18n@beta
+```
+
+### Yarn
+
+```bash
+yarn add -D @testforgejs/vue-test-plugin-i18n@beta
+```
+
+> `@testforgejs/vue-test-core` is required.
+
+## Usage
+
+```typescript
+import { createTestFramework } from "@testforgejs/vue-test-core";
+import { i18nPlugin } from "@testforgejs/vue-test-plugin-i18n";
+
+const framework = createTestFramework({
+  presets: {
+    default: {
+      manifest: [
+        {
+          module: i18nPlugin,
+          enabled: true,
+        },
+      ],
+    },
+  },
+});
+```
+
+## Supported versions
+
+- Vue I18n: 9–11
+- Vue: 3.x
+
+## Documentation
+
+See the [TestForge documentation](https://github.com/testforgejs/testforge#readme).
+
+### API Reference
+
+See the [API reference](https://github.com/testforgejs/testforge/blob/main/packages/vue-test-plugin-i18n/docs/api/README.md).

package/dist/index.cjs

@@ -0,0 +1,44 @@
+"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, {
+  i18nPlugin: () => i18nPlugin
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/module/createI18nPlugin.ts
+var import_vue_test_core = require("@testforgejs/vue-test-core");
+var import_vue_i18n = require("vue-i18n");
+function createI18nPlugin(options) {
+  return (0, import_vue_test_core.createPluginInstance)(import_vue_i18n.createI18n, options);
+}
+
+// src/module/i18nPlugin.ts
+var i18nPlugin = {
+  getName: () => "i18n",
+  getDefinition: () => ({
+    create: createI18nPlugin
+  })
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  i18nPlugin
+});

package/dist/index.d.cts

@@ -0,0 +1,54 @@
+import { I18nOptions, I18n } from 'vue-i18n';
+import { PluginControlOptions, PluginModule } from '@testforgejs/vue-test-core';
+
+/**
+ * Configuration options for the Vue I18n test plugin.
+ *
+ * This interface integrates standard internationalization parameters (`I18nOptions` from `vue-i18n`)
+ * with TestForge test kernel control options.
+ *
+ * @see {@link I18nOptions} for configuring locales, fallback languages, and translation messages.
+ * @see {@link PluginControlOptions} for instance capturing and exposure mechanisms.
+ */
+type VueTestI18nOptions = I18nOptions & PluginControlOptions<I18n>;
+
+/**
+ * TestForge core type augmentation for Vue I18n integration.
+ *
+ * This module registers the i18n configuration under the global plugin options map,
+ * enabling full type safety when defining internationalization options in tests.
+ *
+ * @module I18nAugmentation
+ */
+declare module "@testforgejs/vue-test-core" {
+    /**
+     * Global map for TestForge plugin configuration options.
+     */
+    interface PluginOptionsMap {
+        /**
+         * Configuration for the `i18n` plugin.
+         * Accepts a {@link VueTestI18nOptions} object to manage localization and translations.
+         *
+         * @example
+         * ```ts
+         * factory({}, {
+         *   plugins: {
+         *     i18n: {
+         *       locale: "en",
+         *       messages: { en: { hello: "Hello World" } }
+         *     }
+         *   }
+         * });
+         * ```
+         */
+        i18n: VueTestI18nOptions;
+    }
+}
+
+/**
+ * Vue I18n plugin module definition for the TestForge framework.
+ * Automatically handles internationalization setup inside test environments.
+ */
+declare const i18nPlugin: PluginModule<I18n, VueTestI18nOptions>;
+
+export { type VueTestI18nOptions, i18nPlugin };

package/dist/index.d.ts

@@ -0,0 +1,54 @@
+import { I18nOptions, I18n } from 'vue-i18n';
+import { PluginControlOptions, PluginModule } from '@testforgejs/vue-test-core';
+
+/**
+ * Configuration options for the Vue I18n test plugin.
+ *
+ * This interface integrates standard internationalization parameters (`I18nOptions` from `vue-i18n`)
+ * with TestForge test kernel control options.
+ *
+ * @see {@link I18nOptions} for configuring locales, fallback languages, and translation messages.
+ * @see {@link PluginControlOptions} for instance capturing and exposure mechanisms.
+ */
+type VueTestI18nOptions = I18nOptions & PluginControlOptions<I18n>;
+
+/**
+ * TestForge core type augmentation for Vue I18n integration.
+ *
+ * This module registers the i18n configuration under the global plugin options map,
+ * enabling full type safety when defining internationalization options in tests.
+ *
+ * @module I18nAugmentation
+ */
+declare module "@testforgejs/vue-test-core" {
+    /**
+     * Global map for TestForge plugin configuration options.
+     */
+    interface PluginOptionsMap {
+        /**
+         * Configuration for the `i18n` plugin.
+         * Accepts a {@link VueTestI18nOptions} object to manage localization and translations.
+         *
+         * @example
+         * ```ts
+         * factory({}, {
+         *   plugins: {
+         *     i18n: {
+         *       locale: "en",
+         *       messages: { en: { hello: "Hello World" } }
+         *     }
+         *   }
+         * });
+         * ```
+         */
+        i18n: VueTestI18nOptions;
+    }
+}
+
+/**
+ * Vue I18n plugin module definition for the TestForge framework.
+ * Automatically handles internationalization setup inside test environments.
+ */
+declare const i18nPlugin: PluginModule<I18n, VueTestI18nOptions>;
+
+export { type VueTestI18nOptions, i18nPlugin };

package/dist/index.js

@@ -0,0 +1,17 @@
+// src/module/createI18nPlugin.ts
+import { createPluginInstance } from "@testforgejs/vue-test-core";
+import { createI18n } from "vue-i18n";
+function createI18nPlugin(options) {
+  return createPluginInstance(createI18n, options);
+}
+
+// src/module/i18nPlugin.ts
+var i18nPlugin = {
+  getName: () => "i18n",
+  getDefinition: () => ({
+    create: createI18nPlugin
+  })
+};
+export {
+  i18nPlugin
+};

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@testforgejs/vue-test-plugin-i18n",
+  "version": "1.0.0-beta.0",
+  "type": "module",
+  "description": "Official TestForge plugin for vue-i18n integration in component tests",
+  "homepage": "https://github.com/testforgejs/testforge#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/testforgejs/testforge.git",
+    "directory": "packages/vue-test-plugin-i18n"
+  },
+  "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",
+    "vue-test-utils",
+    "vue-i18n",
+    "i18n",
+    "localization",
+    "testforge",
+    "testforge-plugin",
+    "component-testing"
+  ],
+  "license": "MIT",
+  "author": "Roman Levchenko",
+  "peerDependencies": {
+    "vue-i18n": ">=9.0.0 <12.0.0",
+    "@testforgejs/vue-test-core": "1.0.0-beta.0"
+  },
+  "devDependencies": {
+    "vue-i18n": "^11.4.8",
+    "@testforgejs/vue-test-core": "1.0.0-beta.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test:types": "tsd",
+    "docs:generate": "typedoc"
+  }
+}