@forsakringskassan/cypress-config 1.0.1 → 1.2.0

package/README.md

@@ -2,15 +2,28 @@
 
 Sharable Cypress configuration building blocks for Försäkringskassan.
 
+## Install
+
+```bash
+npm install --save-dev @forsakringskassan/cypress-config
+```
+
+If you previously had these packages installed, they can be uninstalled:
+
+```bash
+npm rm mocha-multi-reporter
+```
+
 ## Usage
 
-In `cypress.config.ts`, replace the vanilla `defineConfig()` helper from `cypress` with `@forsakringskassan/cypress-config`:
+In `cypress.config.ts`, replace the vanilla `defineConfig()` helper from `cypress` with `@forsakringskassan/cypress-config` and pass in `import.meta.dirname` as the first parameter:
 
 ```diff
 -import { defineConfig } from "cypress";
 +import { defineConfig } from "@forsakringskassan/cypress-config";
 
- export default defineConfig({
+-export default defineConfig({
++export default defineConfig(import.meta.dirname, {
    /* ... */
  });
 ```
@@ -18,11 +31,11 @@ In `cypress.config.ts`, replace the vanilla `defineConfig()` helper from `cypres
 It works the same but is preconfigured with new defaults.
 
 > [!TIP]
-> The `defineConfig()` helper does not require any parameters.
-> Unless you are explicitly overwriting the default configuration it is recommended to call `defineConfig()` without parameters.
+> The `defineConfig()` helper does not require the configuration object as the second parameter.
+> Unless you are explicitly overwriting the default configuration it is recommended to call `defineConfig()` without it.
 >
 > ```ts
-> export default defineConfig();
+> export default defineConfig(import.meta.dirname);
 > ```
 >
 > This ensures maximum compatibility with future releases.
@@ -56,7 +69,7 @@ import {
     htmlValidatePlugin,
 } from "@forsakringskassan/cypress-config";
 
-export default defineConfig({
+export default defineConfig(import.meta.dirname, {
     component: {
         async setupNodeEvents(on, config) {
             config = await htmlValidatePlugin(on, config);

package/dist/index.d.ts

@@ -11,11 +11,19 @@ export declare type ConfigOptions = Parameters<typeof defineConfig_2>[0];
  * Default cypress configuration.
  *
  * @public
- * @since v1.0.1
+ * @since v1.1.0
  */
 export declare const defaultConfig: Readonly<{
     allowCypressEnv: false;
     video: false;
+    defaultBrowser: string;
+    reporter: string;
+    reporterOptions: {
+        reporterEnabled: string;
+        mochaJunitReporterReporterOptions: {
+            mochaFile: string;
+        };
+    };
     component: {
         devServer: {
             framework: "vue";
@@ -27,9 +35,10 @@ export declare const defaultConfig: Readonly<{
 
 /**
  * @public
- * @since v1.0.1
+ * @since v1.1.0
+ * @param _rootDir - path to the root directory (containing the `cypress.config.ts` file).
  */
-export declare function defineConfig(userConfig?: Omit<ConfigOptions, "component"> & {
+export declare function defineConfig(_rootDir: string, userConfig?: Omit<ConfigOptions, "component"> & {
     component?: Partial<ConfigOptions["component"]>;
 }): Readonly<ConfigOptions>;
 
@@ -37,7 +46,7 @@ export declare function defineConfig(userConfig?: Omit<ConfigOptions, "component
  * Preconfigured `cypress-html-validate` plugin.
  *
  * @public
- * @since v1.0.1
+ * @since v1.1.0
  * @param on - Cypress `on` callback from `setupNodeEvents`.
  * @param cypressConfig - Cypress `config` parameter from `setupNodeEvents`.
  * @param userConfig - Custom configuration to pass to `html-validate`.

package/dist/index.mjs

@@ -197,11 +197,22 @@ function htmlValidatePlugin(on, cypressConfig, userConfig, userOptions) {
 // src/default-config.ts
 import { createRequire as createRequire2 } from "node:module";
 var require3 = createRequire2(import.meta.url);
+var isGithub = Boolean(process.env["GITHUB_ACTION"]);
 var defaultConfig = Object.freeze({
   allowCypressEnv: false,
   /* disable video recording, it is to slow both on remote machines and on
    * CI/CD testing. */
   video: false,
+  /* use chrome instead of electron as default browser */
+  defaultBrowser: "chrome",
+  /* reporter configuration */
+  reporter: require3.resolve("mocha-multi-reporters"),
+  reporterOptions: {
+    reporterEnabled: isGithub ? "spec, github-actions, mocha-junit-reporter" : "spec, mocha-junit-reporter",
+    mochaJunitReporterReporterOptions: {
+      mochaFile: "test-results/cypress-test-output_[hash].xml"
+    }
+  },
   component: {
     devServer: {
       framework: "vue",
@@ -212,7 +223,7 @@ var defaultConfig = Object.freeze({
 });
 
 // src/define-config.ts
-function defineConfig(userConfig) {
+function defineConfig(_rootDir, userConfig) {
   return mergeConfig(
     defaultConfig,
     userConfig

package/dist/support.d.ts

@@ -4,7 +4,7 @@ import "cypress-html-validate/commands";
  * Configure plugins.
  *
  * @public
- * @since v1.0.1
+ * @since v1.1.0
  */
 export declare function configure(options: {
     afterEach: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forsakringskassan/cypress-config",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "description": "Sharable Cypress configuration building blocks for Försäkringskassan",
   "keywords": [
     "cypress"
@@ -39,11 +39,12 @@
     "dist"
   ],
   "dependencies": {
-    "cypress-html-validate": "9.0.0"
+    "cypress-html-validate": "9.0.0",
+    "mocha-multi-reporters": "1.5.1"
   },
   "peerDependencies": {
     "@fkui/vue": ">= 6.0.0",
-    "cypress": "^15.0.0",
+    "cypress": "^15.17.0",
     "html-validate": ">= 8.0.0"
   },
   "engines": {