From 26c720ba4ec1ec24021d1ee57d6676e7a7f1f3d1 Mon Sep 17 00:00:00 2001
From: Krisztian Balla <k.balla@gmx.at>
Date: Sat, 21 Sep 2024 14:17:41 +0200
Subject: [PATCH] Add project documentation to merge-module test case

---
 .../input/project-documents/doc1.md           |  1 +
 test/merge-module/test.cy.ts                  |  4 +++
 test/merge-module/typedoc.json                | 10 ++++++
 test/test.js                                  | 33 ++++++++++---------
 4 files changed, 32 insertions(+), 16 deletions(-)
 create mode 100644 test/merge-module/input/project-documents/doc1.md
 create mode 100644 test/merge-module/typedoc.json

diff --git a/test/merge-module/input/project-documents/doc1.md b/test/merge-module/input/project-documents/doc1.md
new file mode 100644
index 0000000..42d1294
--- /dev/null
+++ b/test/merge-module/input/project-documents/doc1.md
@@ -0,0 +1 @@
+# This is the project documentation file doc1.md
\ No newline at end of file
diff --git a/test/merge-module/test.cy.ts b/test/merge-module/test.cy.ts
index ba62dee..aa993d8 100644
--- a/test/merge-module/test.cy.ts
+++ b/test/merge-module/test.cy.ts
@@ -16,6 +16,10 @@ describe("index.html", () => {
     it("contains a merged module link for a and b", () => {
         cy.get("nav").find("a[href='./modules/merged.html']");
     });
+
+    it("contains a link to the project documentation", () => {
+        cy.get("nav").find("a[href='./documents/doc1.html']");
+    });
 });
 
 describe("modules/c.html", () => {
diff --git a/test/merge-module/typedoc.json b/test/merge-module/typedoc.json
new file mode 100644
index 0000000..d1295db
--- /dev/null
+++ b/test/merge-module/typedoc.json
@@ -0,0 +1,10 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "name": "Project Merge-Module",
+    "entryPoints": ["input/*.ts"],
+    "entryPointStrategy": "expand",
+    "projectDocuments": ["input/project-documents/*.md"],
+    "out": "output",
+    "plugin": ["typedoc-plugin-merge-modules"],
+    "mergeModulesMergeMode": "module"
+}
diff --git a/test/test.js b/test/test.js
index ff95b51..97bf1ca 100644
--- a/test/test.js
+++ b/test/test.js
@@ -1,45 +1,46 @@
 /* eslint-disable max-len */
 /* eslint-disable @typescript-eslint/no-var-requires */
 const { execSync } = require("child_process");
+const execOptions = { stdio: "inherit" };
 
 console.log("===================================== TEST MERGE OFF ===============================================");
 // prettier-ignore
-execSync("cd merge-off && npx typedoc", { stdio: "inherit" });
-execSync("call npx cypress run --quiet --spec 'merge-off/test.cy.ts'", { stdio: "inherit" });
+execSync("cd merge-off && npx typedoc", execOptions);
+execSync("call npx cypress run --quiet --spec 'merge-off/test.cy.ts'", execOptions);
 
 console.log("=================================== TEST MERGE PROJECT =============================================");
 // prettier-ignore
-execSync("cd merge-project && npx typedoc", { stdio: "inherit" });
-execSync("npx cypress run --quiet --spec 'merge-project/test.cy.ts'", { stdio: "inherit" });
+execSync("cd merge-project && npx typedoc", execOptions);
+execSync("npx cypress run --quiet --spec 'merge-project/test.cy.ts'", execOptions);
 
 console.log("==================================== TEST MERGE MODULE =============================================");
 // prettier-ignore
-execSync("npx typedoc --tsconfig merge-module/tsconfig.json --plugin typedoc-plugin-merge-modules --mergeModulesMergeMode module --entryPointStrategy expand --out merge-module/output merge-module/input", { stdio: "inherit" });
-execSync("npx cypress run --quiet --spec 'merge-module/test.cy.ts'", { stdio: "inherit" });
+execSync("cd merge-module && npx typedoc", execOptions);
+execSync("npx cypress run --quiet --spec 'merge-module/test.cy.ts'", execOptions);
 
 console.log("================================ TEST MERGE MODULE CATEGORY ========================================");
 // prettier-ignore
-execSync("npx typedoc --tsconfig merge-module-category/tsconfig.json --plugin typedoc-plugin-merge-modules --mergeModulesMergeMode module-category --entryPointStrategy expand --out merge-module-category/output merge-module-category/input", { stdio: "inherit" });
-execSync("npx cypress run --quiet --spec 'merge-module-category/test.cy.ts'", { stdio: "inherit" });
+execSync("npx typedoc --tsconfig merge-module-category/tsconfig.json --plugin typedoc-plugin-merge-modules --mergeModulesMergeMode module-category --entryPointStrategy expand --out merge-module-category/output merge-module-category/input", execOptions);
+execSync("npx cypress run --quiet --spec 'merge-module-category/test.cy.ts'", execOptions);
 
 console.log("============================== TEST DEFAULT EXPORT RENAMING ON =====================================");
 // prettier-ignore
-execSync("npx typedoc --tsconfig default-export-rename-on/tsconfig.json --plugin typedoc-plugin-merge-modules --mergeModulesRenameDefaults true --entryPointStrategy expand --out default-export-rename-on/output default-export-rename-on/input", { stdio: "inherit" });
-execSync("npx cypress run --quiet --spec 'default-export-rename-on/test.cy.ts'", { stdio: "inherit" });
+execSync("npx typedoc --tsconfig default-export-rename-on/tsconfig.json --plugin typedoc-plugin-merge-modules --mergeModulesRenameDefaults true --entryPointStrategy expand --out default-export-rename-on/output default-export-rename-on/input", execOptions);
+execSync("npx cypress run --quiet --spec 'default-export-rename-on/test.cy.ts'", execOptions);
 
 console.log("============================== TEST DEFAULT EXPORT RENAMING OFF ====================================");
 // prettier-ignore
-execSync("npx typedoc --tsconfig default-export-rename-off/tsconfig.json --plugin typedoc-plugin-merge-modules --mergeModulesRenameDefaults false --entryPointStrategy expand --out default-export-rename-off/output default-export-rename-off/input", { stdio: "inherit" });
-execSync("npx cypress run --quiet --spec 'default-export-rename-off/test.cy.ts'", { stdio: "inherit" });
+execSync("npx typedoc --tsconfig default-export-rename-off/tsconfig.json --plugin typedoc-plugin-merge-modules --mergeModulesRenameDefaults false --entryPointStrategy expand --out default-export-rename-off/output default-export-rename-off/input", execOptions);
+execSync("npx cypress run --quiet --spec 'default-export-rename-off/test.cy.ts'", execOptions);
 
 console.log("=============================== TEST MERGE PROJECT ON MONOREPO =====================================");
 // prettier-ignore
-execSync("npx typedoc --tsconfig merge-project-monorepo/tsconfig.json --plugin typedoc-plugin-merge-modules --entryPointStrategy packages --out merge-project-monorepo/output merge-project-monorepo/input/project1 merge-project-monorepo/input/project2", { stdio: "inherit" });
-execSync("npx cypress run --quiet --spec 'merge-project-monorepo/test.cy.ts'", { stdio: "inherit" });
+execSync("npx typedoc --tsconfig merge-project-monorepo/tsconfig.json --plugin typedoc-plugin-merge-modules --entryPointStrategy packages --out merge-project-monorepo/output merge-project-monorepo/input/project1 merge-project-monorepo/input/project2", execOptions);
+execSync("npx cypress run --quiet --spec 'merge-project-monorepo/test.cy.ts'", execOptions);
 
 console.log("=============================== TEST MERGE MODULE ON MONOREPO ======================================");
 // prettier-ignore
-execSync("npx typedoc --tsconfig merge-module-monorepo/tsconfig.json --plugin typedoc-plugin-merge-modules --mergeModulesMergeMode module --entryPointStrategy packages --out merge-module-monorepo/output merge-module-monorepo/input/project1 merge-module-monorepo/input/project2", { stdio: "inherit" });
-execSync("npx cypress run --quiet --spec 'merge-module-monorepo/test.cy.ts'", { stdio: "inherit" });
+execSync("npx typedoc --tsconfig merge-module-monorepo/tsconfig.json --plugin typedoc-plugin-merge-modules --mergeModulesMergeMode module --entryPointStrategy packages --out merge-module-monorepo/output merge-module-monorepo/input/project1 merge-module-monorepo/input/project2", execOptions);
+execSync("npx cypress run --quiet --spec 'merge-module-monorepo/test.cy.ts'", execOptions);
 
 console.log("======================================== FINISHED ==================================================");