@analogjs/vitest-angular 3.0.0-alpha.8 → 3.0.0-alpha.9

package/README.md

@@ -1,297 +0,0 @@
-# @analogjs/vitest-angular
-
-A standalone builder for running tests with Vitest and Angular.
-
-## Supporting Analog
-
-- Star the [GitHub Repo](https://github.com/analogjs/analog)
-- Join the [Discord](https://chat.analogjs.org)
-- Follow us on [Twitter](https://twitter.com/analogjs)
-- Become a [Sponsor](https://analogjs.org/docs/sponsoring)
-
-## Installation
-
-Use your package manager of choice to install the necessary packages.
-
-With ng add:
-
-```sh
-ng add @analogjs/vitest-angular
-```
-
-With npm:
-
-```sh
-npm install @analogjs/vitest-angular vitest --save-dev
-```
-
-With pnpm:
-
-```sh
-pnpm install -w @analogjs/vitest-angular vitest --dev
-```
-
-With Yarn:
-
-```sh
-yarn install @analogjs/vitest-angular vitest --dev
-```
-
-## Automated Setup Using a Schematic
-
-A schematic can be used to setup Vitest in an existing Angular project:
-
-Run the schematic to set up the Vite config, test configuration files, and update the test configuration.
-
-```sh
-npx ng generate @analogjs/vitest-angular:setup --project [your-project-name]
-```
-
-### Schematic Options
-
-| Option        | Type    | Default | Description                                                 |
-| ------------- | ------- | ------- | ----------------------------------------------------------- |
-| `project`     | string  | -       | The name of the project to configure (required)             |
-| `browserMode` | boolean | `false` | Configure Vitest to run tests in a browser using Playwright |
-
-To enable browser mode during setup:
-
-```shell
-ng g @analogjs/vitest-angular:setup --project [your-project-name] --browserMode
-```
-
-This automatically installs Playwright dependencies and configures Vitest for browser testing. See [Setup for Running Tests in the Browser](#setup-for-running-tests-in-the-browser) for more details.
-
-If using browser mode, run `npx playwright install` after the schematic to ensure playwright is installed and configured.
-
-## Manual Setup
-
-Vitest can be setup manually also using the steps below.
-
-### Setup for Running Tests in Node
-
-To setup Vitest, create a `vite.config.mts` at the root of your project:
-
-```ts
-/// <reference types="vitest" />
-import { defineConfig } from 'vite';
-
-import angular from '@analogjs/vite-plugin-angular';
-
-export default defineConfig(({ mode }) => ({
-  plugins: [angular()],
-  test: {
-    globals: true,
-    setupFiles: ['src/test-setup.ts'],
-    environment: 'jsdom',
-    include: ['src/**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
-    reporters: ['default'],
-  },
-}));
-```
-
-Next, define a `src/test-setup.ts` file to setup the `TestBed`:
-
-### Zoneless setup
-
-As of Angular v21, `Zoneless` change detection is the default for new projects.
-
-Use the following setup:
-
-```ts
-import '@angular/compiler';
-import '@analogjs/vitest-angular/setup-snapshots';
-import { setupTestBed } from '@analogjs/vitest-angular/setup-testbed';
-
-setupTestBed();
-```
-
-### Zone.js setup
-
-If you are using `Zone.js` for change detection, import the `setup-zone` script. This script automatically includes support for setting up snapshot tests.
-
-```ts
-import '@angular/compiler';
-import '@analogjs/vitest-angular/setup-zone';
-import { setupTestBed } from '@analogjs/vitest-angular/setup-testbed';
-
-setupTestBed({
-  zoneless: false,
-});
-```
-
-### Configuration Options
-
-The `setupTestBed()` function accepts an optional configuration object with the following properties:
-
-- `zoneless` (boolean): Whether to use zoneless change detection (default: `true`)
-- `providers` (`Type<any>[]`): Additional providers to include in the test environment (default: `[]`)
-- `teardown.destroyAfterEach` (boolean): Whether to destroy the test environment after each test. Set to `false` to keep the component rendered, allowing you to inspect its final state. (default: `true`)
-
-**Example with options:**
-
-```ts
-setupTestBed({
-  zoneless: true,
-  providers: [],
-  teardown: { destroyAfterEach: false },
-});
-```
-
-Next, update the `test` target in the `angular.json` to use the `@analogjs/vitest-angular:test` builder:
-
-```json
-{
-  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
-  "version": 1,
-  "newProjectRoot": "projects",
-  "projects": {
-    "your-project": {
-      "projectType": "application",
-      "architect": {
-        "test": {
-          "builder": "@analogjs/vitest-angular:test"
-        }
-      }
-    }
-  }
-}
-```
-
-Lastly, add the `src/test-setup.ts` to `files` array in the `tsconfig.spec.json` in the root of your project, set the `target` to `es2022`, and update the `types`.
-
-```json
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "outDir": "./out-tsc/spec",
-    "target": "es2022",
-    "types": ["vitest/globals", "node"]
-  },
-  "files": ["src/test-setup.ts"],
-  "include": ["src/**/*.spec.ts", "src/**/*.d.ts"]
-}
-```
-
-## Running Tests
-
-To run unit tests, use the `test` command:
-
-```shell
-npm run test
-```
-
-```shell
-yarn test
-```
-
-```shell
-pnpm test
-```
-
-> The `npx vitest` command can also be used directly.
-
-## Snapshot Testing
-
-For snapshot testing you can use `toMatchSnapshot` from `expect` API.
-
-Below is a small example of how to write a snapshot test:
-
-```ts
-// card.component.spec.ts
-import { ComponentFixture, TestBed } from '@angular/core/testing';
-
-import { CardComponent } from './card.component';
-
-describe('CardComponent', () => {
-  let fixture: ComponentFixture<CardComponent>;
-  let component: CardComponent;
-
-  beforeEach(() =>
-    TestBed.configureTestingModule({
-      imports: [CardComponent],
-    }),
-  );
-
-  beforeEach(() => {
-    fixture = TestBed.createComponent(CardComponent);
-    component = fixture.componentInstance;
-    fixture.detectChanges();
-  });
-
-  it('should create the app', () => {
-    expect(fixture).toMatchSnapshot();
-  });
-});
-```
-
-After you run the test, a `card.component.spec.ts.snap` file is created in the`__snapshots__` folder with the below content:
-
-```ts
-// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
-
-exports[`CardComponent > should create the app 1`] = `
-  <component-code>
-`;
-```
-
-The snapshots generated should be reviewed and added to version control.
-
-## Using TypeScript Config Path Aliases
-
-If you are using `paths` in your `tsconfig.json`, support for those aliases can be added to the `vite.config.ts`.
-
-First, install the `vite-tsconfig-paths` package.
-
-With npm:
-
-```shell
-npm install vite-tsconfig-paths --save-dev
-```
-
-With pnpm:
-
-```shell
-pnpm install -w vite-tsconfig-paths --dev
-```
-
-With Yarn:
-
-```shell
-yarn add vite-tsconfig-paths --dev
-```
-
-Next, add the plugin to the `plugins` array in the `vite.config.ts`.
-
-```ts
-/// <reference types="vitest" />
-import { defineConfig } from 'vite';
-
-import angular from '@analogjs/vite-plugin-angular';
-import viteTsConfigPaths from 'vite-tsconfig-paths';
-
-export default defineConfig(({ mode }) => ({
-  // ...other config
-  plugins: [angular(), viteTsConfigPaths()],
-}));
-```
-
-### With Nx
-
-For Nx workspaces, import and use the `nxViteTsPaths` plugin from the `@nx/vite` package.
-
-```ts
-/// <reference types="vitest" />
-import { defineConfig } from 'vite';
-
-import angular from '@analogjs/vite-plugin-angular';
-import { nxViteTsPaths } from '@nx/vite/plugins/nx-tsconfig-paths.plugin';
-
-export default defineConfig(({ mode }) => ({
-  plugins: [angular(), nxViteTsPaths()],
-}));
-```
-
-## IDE Support
-
-Tests can also be run directly from your IDE using the Vitest [IDE integrations](https://vitest.dev/guide/ide) for VS Code or JetBrains IDEs.

package/src/lib/builders/build/schema.json

@@ -1,47 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema",
-    "title": "Vitest schema for Test Facade.",
-    "description": "Vitest target options",
-    "type": "object",
-    "properties": {
-        "configFile": {
-            "type": "string",
-            "description": "The path to the local vitest config",
-            "x-completion-type": "file",
-            "x-completion-glob": "@vitest.config@(.js|.ts|.mts)",
-            "aliases": ["config"]
-        },
-        "include": {
-            "type": "array",
-            "items": {
-                "type": "string"
-            },
-            "default": ["src/**/*.spec.ts"],
-            "description": "Globs of files to include, relative to project root."
-        },
-        "exclude": {
-            "type": "array",
-            "items": {
-                "type": "string"
-            },
-            "default": ["node_modules", "dist", ".idea", ".git", ".cache"],
-            "description": "Globs of files to exclude, relative to the project root."
-        },
-        "setupFile": {
-            "type": "string",
-            "description": "The path to the setup file.",
-            "default": "src/test-setup.ts"
-        },
-        "tsConfig": {
-            "type": "string",
-            "description": "The relative path to the TypeScript configuration file for running tests.",
-            "default": "tsconfig.spec.json"
-        },
-        "watch": {
-            "type": "boolean",
-            "default": false,
-            "description": "Run the tests in watch mode"
-        }
-    },
-    "additionalProperties": true
-}

package/src/lib/builders/build/utils.js

@@ -1 +0,0 @@
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi8uLi8uLi9wYWNrYWdlcy92aXRlc3QtYW5ndWxhci9zcmMvbGliL2J1aWxkZXJzL2J1aWxkL3V0aWxzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgdHlwZSBBbmd1bGFyTWVtb3J5T3V0cHV0RmlsZXMgPSBNYXA8XG4gIHN0cmluZyxcbiAgeyBjb250ZW50czogVWludDhBcnJheTsgaGFzaDogc3RyaW5nOyBzZXJ2YWJsZTogYm9vbGVhbiB9XG4+O1xuIl19

package/src/lib/builders/test/schema.json

@@ -1,47 +0,0 @@
-{
-    "version": 2,
-    "cli": "nx",
-    "title": "Vitest Builder for Angular",
-    "description": "Run unit tests using Vitest.",
-    "type": "object",
-    "properties": {
-        "configFile": {
-            "type": "string",
-            "description": "The path to the local vitest config",
-            "x-completion-type": "file",
-            "x-completion-glob": "@(vitest|vite).config@(.js|.ts)",
-            "aliases": ["config"]
-        },
-        "reportsDirectory": {
-            "type": "string",
-            "description": "Directory to write coverage report to."
-        },
-        "mode": {
-            "type": "string",
-            "description": "Mode for Vite."
-        },
-        "testFiles": {
-            "aliases": ["testFile"],
-            "type": "array",
-            "items": { "type": "string" }
-        },
-        "watch": {
-            "description": "Watch files for changes and rerun tests related to changed files.",
-            "type": "boolean"
-        },
-        "ui": {
-            "description": "Run tests using Vitest UI Mode.",
-            "type": "boolean"
-        },
-        "coverage": {
-            "description": "Enable code coverage analysis.",
-            "type": "boolean"
-        },
-        "update": {
-            "description": "Update snapshot.",
-            "type": "boolean",
-            "aliases": ["u"]
-        }
-    },
-    "required": []
-}

package/src/lib/tools/src/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/vitest-angular-tools/src/index.ts"],"names":[],"mappings":";;;AAAA,kDAA0D;AAAjD,uGAAA,cAAc,OAAA"}

package/src/lib/tools/src/schematics/utils/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../../../packages/vitest-angular-tools/src/schematics/utils/index.ts"],"names":[],"mappings":";;;AAAA,qDAA2B;AAC3B,oDAA0B;AAC1B,sDAA4B;AAC5B,yDAA+B"}