vitest-browser-angular 0.0.0 → 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 HiRez.io
+
+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

@@ -2,3 +2,104 @@
 
 Mount Angular components in VItest Browser Mode. 
 
+## Installation
+
+```sh
+pnpm add -D vitest-browser-angular
+```
+
+## Setup Test Environment with Zone.js
+
+```ts
+// vitest.config.ts
+
+export default defineConfig({
+  test: {
+    globals: true,
+
+    // 👇 This is what you need to add
+    setupFiles: ['vitest-browser-angular/setup-zones'],
+
+    browser: {
+      enabled: true,
+      provider: 'playwright',
+      instances: [{ browser: 'chromium' }],
+    },
+  },
+});
+```
+
+## Setup Test Environment with Zoneless
+
+TBD
+
+## Usage
+
+```ts
+
+import { test, expect } from 'vitest-browser-angular';
+
+@Component({
+  template: '<h1>{{ title }}</h1>',
+})
+export class HelloWorldComponent {
+  title = 'Hello World';
+}
+
+
+test('mount', async ({ mount }) => {
+  const { component } = await mount(HelloWorldComponent);
+  await expect.element(component).toHaveTextContent('Hello World');
+});
+```
+
+## Extending Vitest Context
+
+If you want to extend the library's test context (fixtures) like this:
+
+```ts
+import { test as testBase } from 'vitest-browser-angular'
+
+export const test = testBase.extend(...)
+```
+
+Make sure you add `vitest-browser-angular` to the `types` array in your `tsconfig.json`
+
+If it doesn't work, you probably forgot to add `@vitest/browser` to the `types` array as well.
+
+**Example:**
+```json
+
+"types": [
+  "@vitest/browser",
+  "vitest-browser-angular"
+]
+```
+
+## Contributing
+
+Want to contribute? Yayy! 🎉
+
+Please read and follow our [Contributing Guidelines](CONTRIBUTING.md) to learn what are the right steps to take before contributing your time, effort and code.
+
+Thanks 🙏
+
+<br/>
+
+## Code Of Conduct
+
+Be kind to each other and please read our [code of conduct](CODE_OF_CONDUCT.md).
+
+<br/>
+
+
+## Credits
+
+This project is inspired by the following projects:
+
+[vitest-browser-vue](https://github.com/vitest-dev/vitest-browser-vue)
+[angular-testing-library](https://github.com/testing-library/angular-testing-library)
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -3,7 +3,7 @@ import { Router, Routes } from "@angular/router";
 import { RouterTestingHarness } from "@angular/router/testing";
 import { BrowserPage, Locator } from "@vitest/browser/context";
 import * as vitest0 from "vitest";
-import { Type } from "@angular/core";
+import { EnvironmentProviders, Provider, Type } from "@angular/core";
 export * from "vitest";
 
 //#region src/index.d.ts
@@ -12,9 +12,9 @@ interface RoutingConfig {
   initialRoute?: string;
 }
 interface MountConfig {
-  withRouting?: RoutingConfig;
-  providers?: any[];
-  imports?: any[];
+  withRouting?: RoutingConfig | boolean;
+  providers?: Array<Provider | EnvironmentProviders>;
+  imports?: unknown[];
 }
 interface MountResult<T> {
   fixture: ComponentFixture<T>;

package/dist/index.js

@@ -17,13 +17,16 @@ const test = test$1.extend({
 			const imports = [componentClass, ...config?.imports || []];
 			const providers = [...config?.providers || []];
 			const mountResult = {};
-			if (config?.withRouting) providers.push(provideRouter(config.withRouting.routes));
+			if (config?.withRouting) {
+				const routes = typeof config.withRouting === "boolean" ? [] : config.withRouting.routes;
+				providers.push(provideRouter(routes));
+			}
 			TestBed.configureTestingModule({
 				imports,
 				providers
 			});
 			if (config?.withRouting) {
-				const routerHarness = await RouterTestingHarness.create(config.withRouting.initialRoute);
+				const routerHarness = await RouterTestingHarness.create(typeof config.withRouting === "boolean" ? void 0 : config.withRouting.initialRoute);
 				mountResult.routerHarness = routerHarness;
 				mountResult.router = TestBed.inject(Router);
 			}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vitest-browser-angular",
-  "version": "0.0.0",
+  "version": "0.0.2",
   "description": "Mount Angular components in VItest Browser Mode",
   "author": "Shai Reznik (HiRez.io)",
   "license": "MIT",
@@ -40,13 +40,6 @@
   "engines": {
     "node": "^18.0.0 || ^20.0.0 || >=22.0.0"
   },
-  "scripts": {
-    "build": "tsdown",
-    "dev": "tsdown --watch --sourcemap",
-    "test": "vitest",
-    "lint": "eslint --cache .",
-    "lint:fix": "pnpm lint --fix"
-  },
   "peerDependencies": {
     "@analogjs/vitest-angular": "^1.20.0",
     "@angular/compiler": "^20.0.0",
@@ -65,11 +58,14 @@
     "@changesets/cli": "^2.29.6",
     "@changesets/get-github-info": "^0.6.0",
     "@changesets/types": "^6.1.0",
+    "@eslint/js": "^9.35.0",
     "@vitest/browser": "^3.2.0",
     "bumpp": "^9.4.2",
     "changelogithub": "^0.13.9",
+    "dotenv": "^17.2.2",
     "eslint": "^9.8.0",
     "eslint-config-prettier": "^10.1.8",
+    "globals": "^16.3.0",
     "playwright": "^1.46.0",
     "prettier": "^3.6.2",
     "pretty-quick": "^4.2.2",
@@ -78,8 +74,25 @@
     "tsup": "^8.2.4",
     "tsx": "^4.17.0",
     "typescript": "^5.5.4",
+    "typescript-eslint": "^8.42.0",
     "vitest": "^3.2.0",
     "zone.js": "^0.15.1",
     "zx": "^8.1.4"
+  },
+  "simple-git-hooks": {
+    "pre-commit": "pnpm fmt.staged && pnpm lint"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "change": "changeset",
+    "dev": "tsdown --watch --sourcemap",
+    "fmt": "prettier --write .",
+    "fmt.check": "prettier --check .",
+    "fmt.staged": "pretty-quick --staged",
+    "lint": "eslint --cache .",
+    "lint:fix": "pnpm lint --fix",
+    "release": "changeset publish",
+    "release.pkg-pr-new": "pnpm dlx pkg-pr-new publish",
+    "test": "vitest"
   }
-}
+}