feat(schematics): introduce unitTestRunner option to support Vitest (#…

…688)

* Added support for vitest as a unit test runner.
* Introduced a new unitTestRunner option to specify
the test runner (jasmine, jest, vitest).
* Deprecated the jest option to avoid redundancy
and encourage the use of the new unitTestRunner option.

README.md

@@ -1186,15 +1186,17 @@ describe('AuthService', () => {
 });
 ```
 
-When using the component schematic you can specify the `--jest` flag to have the Jest imports used.  In order to Jest imports the default, update `angular.json`:
+When using the component schematic you can specify the `--unitTestRunner` flag to `jest` to have the Jest imports used. In order to Jest imports the default, update `angular.json`:
 ```json
 "schematics": {
   "@ngneat/spectator:spectator-component": {
-    "jest": true
+    "unitTestRunner": "jest"
   }
 }
 ```
 
+Please note that the previous `--jest` flag is deprecated and will be removed in the future.
+
 ## Vitest Support
 Like Jest, Spectator also supports Vitest. 
 
@@ -1246,6 +1248,15 @@ describe('AuthService', () => {
 });
 ```
 
+When using the component schematic you can specify the `--unitTestRunner` flag to `vitest` to have the Vitest imports used. In order to Vitest imports the default, update `angular.json`:
+```json
+"schematics": {
+  "@ngneat/spectator:spectator-component": {
+    "unitTestRunner": "vitest"
+  }
+}
+```
+
 ## Testing with HTTP
 Spectator makes testing data services, which use the Angular HTTP module, a lot easier. For example, let's say that you have service with three methods, one performs a GET, one a POST and one performs
 concurrent requests:

projects/spectator/schematics/src/spectator/component-schema.json

@@ -126,7 +126,15 @@
     "jest": {
       "type": "boolean",
       "default": false,
-      "description": "When true, uses Jest to create mocks."
+      "description": "When true, uses Jest to create mocks. Deprecated: use unitTestRunner instead.",
+      "deprecated": true
+    },
+    "unitTestRunner": {
+      "type": "string",
+      "enum": ["jasmine", "jest", "vitest"],
+      "description": "Test runner to use to create mocks.",
+      "default": "jasmine",
+      "alias": "u"
     }
   },
   "required": [

projects/spectator/schematics/src/spectator/directive-schema.json

@@ -74,7 +74,15 @@
     "jest": {
       "type": "boolean",
       "default": false,
-      "description": "When true, uses Jest to create mocks."
+      "description": "When true, uses Jest to create mocks. Deprecated: use unitTestRunner instead.",
+      "deprecated": true
+    },
+    "unitTestRunner": {
+      "type": "string",
+      "enum": ["jasmine", "jest", "vitest"],
+      "description": "Test runner to use to create mocks.",
+      "default": "jasmine",
+      "alias": "u"
     }
   },
   "required": [

projects/spectator/schematics/src/spectator/files/component-custom-host/__name@dasherize__.__type@dasherize__.spec.ts

@@ -1,5 +1,5 @@
 import { Component } from '@angular/core';
-import { createHostFactory, SpectatorHost } from '@ngneat/spectator<% if (jest) { %>/jest<% } %>';
+import { createHostFactory, SpectatorHost } from '@ngneat/spectator<% if (secondaryEntryPoint) { %>/<%= secondaryEntryPoint%><% } %>';
 
 import { <%= classify(name)%>Component } from './<%= dasherize(name)%>.component';
 

projects/spectator/schematics/src/spectator/files/component-host/__name@dasherize__.__type@dasherize__.spec.ts

@@ -1,4 +1,4 @@
-import { createHostFactory, SpectatorHost } from '@ngneat/spectator<% if (jest) { %>/jest<% } %>';
+import { createHostFactory, SpectatorHost } from '@ngneat/spectator<% if (secondaryEntryPoint) { %>/<%= secondaryEntryPoint%><% } %>';
 
 import { <%= classify(name)%>Component } from './<%= dasherize(name)%>.component';
 

projects/spectator/schematics/src/spectator/files/component/__name@dasherize__.__type@dasherize__.spec.ts

@@ -1,4 +1,4 @@
-import { Spectator, createComponentFactory } from '@ngneat/spectator<% if (jest) { %>/jest<% } %>';
+import { Spectator, createComponentFactory } from '@ngneat/spectator<% if (secondaryEntryPoint) { %>/<%= secondaryEntryPoint%><% } %>';
 
 import { <%= classify(name)%>Component } from './<%= dasherize(name)%>.component';
 

projects/spectator/schematics/src/spectator/files/data-service/__name@dasherize__.service.spec.ts

@@ -1,4 +1,4 @@
-import { createHttpFactory, HttpMethod, SpectatorHttp } from '@ngneat/spectator';
+import { createHttpFactory, HttpMethod, SpectatorHttp } from '@ngneat/spectator<% if (secondaryEntryPoint) { %>/<%= secondaryEntryPoint%><% } %>';
 import { <%= classify(name)%>Service } from './<%= dasherize(name)%>.service';
 
 describe('<%= classify(name)%>Service', () => {

projects/spectator/schematics/src/spectator/files/directive/__name@dasherize__.directive.spec.ts

@@ -1,4 +1,4 @@
-import { createDirectiveFactory, SpectatorDirective } from '@ngneat/spectator<% if (jest) { %>/jest<% } %>';
+import { createDirectiveFactory, SpectatorDirective } from '@ngneat/spectator<% if (secondaryEntryPoint) { %>/<%= secondaryEntryPoint%><% } %>';
 
 import { <%= classify(name)%>Directive } from './<%= dasherize(name)%>.directive';
 

projects/spectator/schematics/src/spectator/files/pipe/__name@dasherize__.pipe.spec.ts

@@ -1,4 +1,4 @@
-import { createPipeFactory, SpectatorPipe } from '@ngneat/spectator<% if (jest) { %>/jest<% } %>';
+import { createPipeFactory, SpectatorPipe } from '@ngneat/spectator<% if (secondaryEntryPoint) { %>/<%= secondaryEntryPoint%><% } %>';
 
 import { <%= classify(name)%>Pipe } from './<%= dasherize(name)%>.pipe';
 

projects/spectator/schematics/src/spectator/files/service/__name@dasherize__.service.spec.ts

@@ -1,4 +1,4 @@
-import { createServiceFactory, SpectatorService } from '@ngneat/spectator<% if (jest) { %>/jest<% } %>';
+import { createServiceFactory, SpectatorService } from '@ngneat/spectator<% if (secondaryEntryPoint) { %>/<%= secondaryEntryPoint%><% } %>';
 import { <%= classify(name)%>Service } from './<%= dasherize(name)%>.service';
 
 describe('<%= classify(name)%>Service', () => {
@@ -10,4 +10,4 @@ describe('<%= classify(name)%>Service', () => {
   it('should...', () => {
     expect(spectator.service).toBeTruthy();
   });
-});
+});