@forsakringskassan/cypress-config 1.2.0 → 1.3.0

package/README.md

@@ -14,6 +14,10 @@ If you previously had these packages installed, they can be uninstalled:
 npm rm mocha-multi-reporter
 ```
 
+- [Usage](#usage)
+- [docs-generator](#docs-generator)
+- [HTML-Validate](#html-validate)
+
 ## Usage
 
 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:
@@ -59,6 +63,42 @@ configure({
 
 See the various components for details.
 
+### docs-generator
+
+A plugin to get all pages and examples generated by `@forsakringskassan/docs-generator`.
+This is typically only useful in E2E testing.
+
+```ts
+import {
+    defineConfig,
+    docsGeneratorPlugin,
+} from "@forsakringskassan/cypress-config";
+/
+const docs = new Generator(import.meta.url, {});
+const sourceFiles = [];
+
+export default defineConfig(import.meta.dirname, {
+    e2e: {
+        async setupNodeEvents(on, config) {
+            config = await docsGeneratorPlugin(on, config, docs, sourceFiles);
+            return config;
+        },
+    },
+});
+```
+
+The pages are retrieved using `Cypress.expose("pages")` which contains additional information:
+
+```ts
+const pages = Cypress.expose("pages") ?? [];
+for (const page of pages) {
+    const { path, examples } = page;
+    /* ... */
+}
+```
+
+See [manifest documentation](https://forsakringskassan.github.io/docs-generator/latest/processors/manifest.html) for details about what each page entry contains.
+
 ### HTML-Validate
 
 A preconfigured [HTML-validate](https://html-validate.org/) plugin ([cypress-html-validate](https://gitlab.com/html-validate/cypress-html-validate/)) is exported as `htmlValidatePlugin`:

package/dist/index.d.ts

@@ -42,6 +42,22 @@ export declare function defineConfig(_rootDir: string, userConfig?: Omit<ConfigO
     component?: Partial<ConfigOptions["component"]>;
 }): Readonly<ConfigOptions>;
 
+/**
+ * Fetch document pages and examples for documentation generated by
+ * `@forsakringskassan/docs-generator`.
+ *
+ * @public
+ * @since v1.3.0
+ * @param on - Cypress `on` callback from `setupNodeEvents`.
+ * @param config - Cypress `config` parameter from `setupNodeEvents`.
+ * @param docs - A `Generator` instance.
+ * @param sourceFiles - A set of source files generate manifest for.
+ * @returns A promise resolved with the updated cypress configuration.
+ */
+export declare function docsGeneratorPlugin<T extends unknown[]>(_on: Cypress.PluginEvents, config: Cypress.PluginConfigOptions, docs: {
+    manifest(sourceFiles: T): Promise<unknown>;
+}, sourceFiles: T): Promise<Cypress.PluginConfigOptions>;
+
 /**
  * Preconfigured `cypress-html-validate` plugin.
  *

package/dist/index.mjs

@@ -131,6 +131,16 @@ var require_cjs = __commonJS({
   }
 });
 
+// src/plugins/docs-generator.ts
+async function docsGeneratorPlugin(_on, config, docs, sourceFiles) {
+  const manifest = await docs.manifest(sourceFiles);
+  const pages = manifest.pages.filter((it) => {
+    return it.path.endsWith(".html");
+  });
+  config.expose["pages"] = pages;
+  return config;
+}
+
 // src/plugins/html-validate.ts
 import { createRequire } from "node:module";
 import "cypress";
@@ -232,5 +242,6 @@ function defineConfig(_rootDir, userConfig) {
 export {
   defaultConfig,
   defineConfig,
+  docsGeneratorPlugin,
   htmlValidatePlugin
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forsakringskassan/cypress-config",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Sharable Cypress configuration building blocks for Försäkringskassan",
   "keywords": [
     "cypress"
@@ -44,9 +44,15 @@
   },
   "peerDependencies": {
     "@fkui/vue": ">= 6.0.0",
+    "@forsakringskassan/docs-generator": "^3.0.0",
     "cypress": "^15.17.0",
     "html-validate": ">= 8.0.0"
   },
+  "peerDependenciesMeta": {
+    "@forsakringskassan/docs-generator": {
+      "optional": true
+    }
+  },
   "engines": {
     "node": "^22.16 || >= 24",
     "npm": ">= 7"