Merge branch 'GH-22-support-typedoc-0.27'

krisztianb · Nov 30, 2024 · 465b2dc · 465b2dc
2 parents 120293a + 349349d
commit 465b2dc
Show file tree

Hide file tree

Showing 21 changed files with 1,040 additions and 1,810 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [6.1.0] - 2024-11-30
+### Added
+-   Added support for latest TypeDoc version 0.27.x.
+
 ## [6.0.3] - 2024-10-25
 ### Fixed
 -   Category descriptions and group descriptions were missing when merging into the project root.
@@ -92,7 +96,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 First release
 
-[unreleased]: https://github.com/krisztianb/typedoc-plugin-merge-modules/compare/v6.0.3...HEAD
+[unreleased]: https://github.com/krisztianb/typedoc-plugin-merge-modules/compare/v6.1.0...HEAD
+[6.1.0]: https://github.com/krisztianb/typedoc-plugin-merge-modules/releases/tag/v6.1.0
 [6.0.3]: https://github.com/krisztianb/typedoc-plugin-merge-modules/releases/tag/v6.0.3
 [6.0.2]: https://github.com/krisztianb/typedoc-plugin-merge-modules/releases/tag/v6.0.2
 [6.0.1]: https://github.com/krisztianb/typedoc-plugin-merge-modules/releases/tag/v6.0.1

diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ This module can be installed using [npm](https://www.npmjs.com/package/typedoc-p
 $ npm install typedoc-plugin-merge-modules --save-dev
 ```
 
-The plugin requires TypeDoc version 0.26.x to be installed. After installation you need to activate the plugin with a [typedoc command line argument](https://typedoc.org/options/configuration/#plugin) or inside your [typedoc config file](https://typedoc.org/options/configuration/#json-files).
+The plugin requires TypeDoc version 0.26.0 or above to be installed. After installation you need to activate the plugin with a [typedoc command line argument](https://typedoc.org/options/configuration/#plugin) or inside your [typedoc config file](https://typedoc.org/options/configuration/#json-files).
 
 Here is an example using a JavaScript config file:
 
@@ -66,6 +66,7 @@ Special thanks go to the following people that contributed to this project:
 -   [Gerrit Birkeland](https://github.com/Gerrit0) for the suggested solution and code example.
 -   [Felipe Santos](https://github.com/felipecrs) for suggesting improvements.
 -   [Sho Otani](https://github.com/beijaflor) for implementing the merging of modules by name.
+-   And all the other [contributors](https://github.com/krisztianb/typedoc-plugin-merge-modules/graphs/contributors).
 
 ## Donate
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,7 @@
 {
     "name": "typedoc-plugin-merge-modules",
-    "version": "6.0.3",
+    "version": "6.1.0",
+    "type": "module",
     "description": "Plugin for TypeDoc that merges the content of modules.",
     "author": {
         "name": "Krisztián Balla",
@@ -15,18 +16,18 @@
         "@types/node": "20.14.9",
         "@typescript-eslint/eslint-plugin": "7.14.1",
         "@typescript-eslint/parser": "7.14.1",
-        "cypress": "13.14.2",
+        "cypress": "13.16.0",
         "eslint": "8.56.0",
         "eslint-plugin-jsdoc": "48.5.0",
         "eslint-plugin-ordered-imports": "0.6.0",
         "eslint-plugin-unicorn": "54.0.0",
-        "prettier": "3.3.3",
+        "prettier": "3.4.1",
         "rimraf": "6.0.1",
-        "typedoc": "0.26.7",
-        "typescript": "5.5.4"
+        "typedoc": "0.27.2",
+        "typescript": "5.6.3"
     },
     "peerDependencies": {
-        "typedoc": "0.26.x"
+        "typedoc": "0.26.x || ^0.27.1"
     },
     "repository": {
         "type": "git",

diff --git a/src/index.ts b/src/index.ts
@@ -1,6 +1,6 @@
-import { Application } from "typedoc";
-import { Plugin } from "./plugin";
-import { PluginConfig } from "./plugin_options";
+import type { Application } from "typedoc";
+import { Plugin } from "./plugin.js";
+import type { PluginConfig } from "./plugin_options.js";
 
 /**
  * Type that can be intersected with TypeDoc's config type to have static type checking for the plugin's configuration.

diff --git a/src/merger/module_bundle.ts b/src/merger/module_bundle.ts
@@ -1,10 +1,10 @@
-import { Comment, DeclarationReflection, DocumentReflection, ProjectReflection, ReflectionKind } from "typedoc";
+import { Comment, DeclarationReflection, DocumentReflection, type ProjectReflection, ReflectionKind } from "typedoc";
 import {
     getNameFromDescriptionTag,
     moveDeclarationReflectionToTarget,
     moveDocumentReflectionToTarget,
     removeTagFromCommentsOf,
-} from "../utils";
+} from "../utils.js";
 
 /**
  * Name of the comment tag that can be used to mark a module as the target module within the bundle.

diff --git a/src/merger/module_category_merger.ts b/src/merger/module_category_merger.ts
@@ -1,5 +1,5 @@
-import { DeclarationReflection } from "typedoc";
-import { ModuleMerger } from "./module_merger";
+import type { DeclarationReflection } from "typedoc";
+import { ModuleMerger } from "./module_merger.js";
 
 /**
  * Merger that merges the content of modules based on their JSDoc module annotation and category.

diff --git a/src/merger/module_merger.ts b/src/merger/module_merger.ts
@@ -1,7 +1,7 @@
-import { Plugin } from "src/plugin";
-import { DeclarationReflection, ProjectReflection } from "typedoc";
-import { getModulesFrom } from "../utils";
-import { ModuleBundle } from "./module_bundle";
+import type { Plugin } from "src/plugin.js";
+import type { DeclarationReflection, ProjectReflection } from "typedoc";
+import { getModulesFrom } from "../utils.js";
+import { ModuleBundle } from "./module_bundle.js";
 
 /**
  * Merger that merges the content of modules based on their JSDoc module annotation.

diff --git a/src/merger/project_merger.ts b/src/merger/project_merger.ts
@@ -1,7 +1,7 @@
-import { ProjectReflection } from "typedoc";
-import { Plugin } from "../plugin";
-import { getModulesFrom } from "../utils";
-import { ModuleBundle } from "./module_bundle";
+import type { ProjectReflection } from "typedoc";
+import type { Plugin } from "../plugin.js";
+import { getModulesFrom } from "../utils.js";
+import { ModuleBundle } from "./module_bundle.js";
 
 /**
  * Merger that moves the content of all modules into the project root.

diff --git a/src/plugin.ts b/src/plugin.ts
@@ -1,17 +1,17 @@
 import {
     Application,
-    Context,
+    type Context,
     Converter,
-    DeclarationReflection,
+    type DeclarationReflection,
     EntryPointStrategy,
-    ProjectReflection,
+    type ProjectReflection,
     ReflectionKind,
 } from "typedoc";
-import { ModuleCategoryMerger } from "./merger/module_category_merger";
-import { ModuleMerger } from "./merger/module_merger";
-import { ProjectMerger } from "./merger/project_merger";
-import { PluginOptions } from "./plugin_options";
-import { tryGetOriginalReflectionName } from "./utils";
+import { ModuleCategoryMerger } from "./merger/module_category_merger.js";
+import { ModuleMerger } from "./merger/module_merger.js";
+import { ProjectMerger } from "./merger/project_merger.js";
+import { PluginOptions } from "./plugin_options.js";
+import { tryGetOriginalReflectionName } from "./utils.js";
 
 /**
  * The "Merge Modules" plugin.

diff --git a/src/plugin_options.ts b/src/plugin_options.ts
@@ -1,4 +1,4 @@
-import { Application, ParameterType } from "typedoc";
+import { type Application, ParameterType } from "typedoc";
 
 /** Type for the plugin's mode. */
 type Mode = "project" | "module" | "module-category" | "off";

diff --git a/src/utils.ts b/src/utils.ts
@@ -1,12 +1,12 @@
 import {
-    CommentTag,
-    Context,
+    type CommentTag,
+    type Context,
     DeclarationReflection,
-    DocumentReflection,
-    ProjectReflection,
+    type DocumentReflection,
+    type ProjectReflection,
     ReflectionKind,
 } from "typedoc";
-import * as ts from "typescript";
+import type * as ts from "typescript";
 
 /**
  * Type extending the TypeScript Declaration interface with a possible identifier object as a name.

diff --git a/test/cypress.config.js b/test/cypress.config.js
@@ -1,11 +1,12 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/unbound-method
-const { defineConfig } = require("cypress");
+import { defineConfig } from "cypress";
 
-module.exports = defineConfig({
+const config = defineConfig({
     e2e: {
         specPattern: "**/*.cy.ts",
         supportFile: false,
         video: false,
         screenshotOnRunFailure: false,
     },
 });
+
+export default config;
diff --git a/test/merge-module-category/test.cy.ts b/test/merge-module-category/test.cy.ts
@@ -46,7 +46,7 @@ describe("modules/merged-1.html", () => {
     });
 
     it("contains a sub link to the class C", () => {
-        cy.get("nav").find("a[href='../classes/merged-1.C.html']");
+        cy.get("nav").find("a[href='../classes/merged.C.html']");
     });
 });
 
@@ -56,6 +56,6 @@ describe("modules/merged-2.html", () => {
     });
 
     it("contains a sub link to the class D", () => {
-        cy.get("nav").find("a[href='../classes/merged-2.D.html']");
+        cy.get("nav").find("a[href='../classes/merged.D.html']");
     });
 });
diff --git a/test/merge-module-monorepo/test.cy.ts b/test/merge-module-monorepo/test.cy.ts
@@ -43,29 +43,29 @@ describe("modules/Project_2.merged.html", () => {
     });
 
     it("contains index links to the classes A, B and C", () => {
-        cy.get(".col-content .tsd-index-list").find("a[href='../classes/Project_2.merged.A.html']");
-        cy.get(".col-content .tsd-index-list").find("a[href='../classes/Project_2.merged.B.html']");
-        cy.get(".col-content .tsd-index-list").find("a[href='../classes/Project_2.merged.C.html']");
+        cy.get(".col-content .tsd-member-summaries").find("a[href='../classes/Project_2.merged.A.html']");
+        cy.get(".col-content .tsd-member-summaries").find("a[href='../classes/Project_2.merged.B.html']");
+        cy.get(".col-content .tsd-member-summaries").find("a[href='../classes/Project_2.merged.C.html']");
     });
 
     it("contains the category Alpha and its description", () => {
-        const sectionSelector = ".col-content .tsd-index-section:nth-of-type(2)";
+        const sectionSelector = ".col-content .tsd-panel-group:nth-of-type(2)";
 
-        cy.get(sectionSelector + " h3").should("have.text", "Alpha");
+        cy.get(sectionSelector + " h2").should("contain", "Alpha");
         cy.get(sectionSelector + " p").should("have.text", "Category description from the file of A.");
     });
 
     it("contains the category Beta and its description", () => {
-        const sectionSelector = ".col-content .tsd-index-section:nth-of-type(3)";
+        const sectionSelector = ".col-content .tsd-panel-group:nth-of-type(3)";
 
-        cy.get(sectionSelector + " h3").should("have.text", "Beta");
+        cy.get(sectionSelector + " h2").should("contain", "Beta");
         cy.get(sectionSelector + " p").should("have.text", "Category description from the file of B.");
     });
 
     it("contains the category Gamma and its description", () => {
-        const sectionSelector = ".col-content .tsd-index-section:nth-of-type(1)";
+        const sectionSelector = ".col-content .tsd-panel-group:nth-of-type(1)";
 
-        cy.get(sectionSelector + " h3").should("have.text", "Gamma");
+        cy.get(sectionSelector + " h2").should("contain", "Gamma");
         cy.get(sectionSelector + " p").should("have.text", "Category description from the file of C.");
     });
 });
diff --git a/test/merge-module/test.cy.ts b/test/merge-module/test.cy.ts
@@ -32,9 +32,9 @@ describe("modules/notMerged.html", () => {
     });
 
     it("contains the category Gamma and its description", () => {
-        const sectionSelector = ".col-content .tsd-index-section:nth-of-type(1)";
+        const sectionSelector = ".col-content .tsd-panel-group:nth-of-type(1)";
 
-        cy.get(sectionSelector + " h3").should("have.text", "Gamma");
+        cy.get(sectionSelector + " h2").should("contain", "Gamma");
         cy.get(sectionSelector + " p").should("have.text", "Category description from the file of C.");
     });
 });
@@ -50,16 +50,16 @@ describe("modules/merged.html", () => {
     });
 
     it("contains the category Alpha and its description", () => {
-        const sectionSelector = ".col-content .tsd-index-section:nth-of-type(1)";
+        const sectionSelector = ".col-content .tsd-panel-group:nth-of-type(1)";
 
-        cy.get(sectionSelector + " h3").should("have.text", "Alpha");
+        cy.get(sectionSelector + " h2").should("contain", "Alpha");
         cy.get(sectionSelector + " p").should("have.text", "Category description from the file of A.");
     });
 
     it("contains the category Beta and its description", () => {
-        const sectionSelector = ".col-content .tsd-index-section:nth-of-type(2)";
+        const sectionSelector = ".col-content .tsd-panel-group:nth-of-type(2)";
 
-        cy.get(sectionSelector + " h3").should("have.text", "Beta");
+        cy.get(sectionSelector + " h2").should("contain", "Beta");
         cy.get(sectionSelector + " p").should("have.text", "Category description from the file of B.");
     });
 });
diff --git a/test/merge-project-monorepo/test.cy.ts b/test/merge-project-monorepo/test.cy.ts
@@ -28,23 +28,23 @@ describe("modules.html", () => {
     });
 
     it("contains the category Alpha and its description", () => {
-        const sectionSelector = ".col-content .tsd-index-section:nth-of-type(1)";
+        const sectionSelector = ".col-content .tsd-panel-group:nth-of-type(1)";
 
-        cy.get(sectionSelector + " h3").should("have.text", "Alpha");
+        cy.get(sectionSelector + " h2").should("contain", "Alpha");
         cy.get(sectionSelector + " p").should("have.text", "Category description from the file of A.");
     });
 
     it("contains the category Beta and its description", () => {
-        const sectionSelector = ".col-content .tsd-index-section:nth-of-type(2)";
+        const sectionSelector = ".col-content .tsd-panel-group:nth-of-type(2)";
 
-        cy.get(sectionSelector + " h3").should("have.text", "Beta");
+        cy.get(sectionSelector + " h2").should("contain", "Beta");
         cy.get(sectionSelector + " p").should("have.text", "Category description from the file of B.");
     });
 
     it("contains the category Gamma and its description", () => {
-        const sectionSelector = ".col-content .tsd-index-section:nth-of-type(3)";
+        const sectionSelector = ".col-content .tsd-panel-group:nth-of-type(3)";
 
-        cy.get(sectionSelector + " h3").should("have.text", "Gamma");
+        cy.get(sectionSelector + " h2").should("contain", "Gamma");
         cy.get(sectionSelector + " p").should("have.text", "Category description from the file of C.");
     });
 });
diff --git a/test/merge-project/test.cy.ts b/test/merge-project/test.cy.ts
@@ -27,23 +27,23 @@ describe("modules.html", () => {
     });
 
     it("contains the category Alpha and its description", () => {
-        const sectionSelector = ".col-content .tsd-index-section:nth-of-type(1)";
+        const sectionSelector = ".col-content .tsd-panel-group:nth-of-type(1)";
 
-        cy.get(sectionSelector + " h3").should("have.text", "Alpha");
+        cy.get(sectionSelector + " h2").should("contain", "Alpha");
         cy.get(sectionSelector + " p").should("have.text", "Category description from the file of A.");
     });
 
     it("contains the category Beta and its description", () => {
-        const sectionSelector = ".col-content .tsd-index-section:nth-of-type(2)";
+        const sectionSelector = ".col-content .tsd-panel-group:nth-of-type(2)";
 
-        cy.get(sectionSelector + " h3").should("have.text", "Beta");
+        cy.get(sectionSelector + " h2").should("contain", "Beta");
         cy.get(sectionSelector + " p").should("have.text", "Category description from the file of B.");
     });
 
     it("contains the category Gamma and its description", () => {
-        const sectionSelector = ".col-content .tsd-index-section:nth-of-type(3)";
+        const sectionSelector = ".col-content .tsd-panel-group:nth-of-type(3)";
 
-        cy.get(sectionSelector + " h3").should("have.text", "Gamma");
+        cy.get(sectionSelector + " h2").should("contain", "Gamma");
         cy.get(sectionSelector + " p").should("have.text", "Category description from the file of C.");
     });
 });
diff --git a/test/prepare_test.js b/test/prepare_test.js
@@ -1,29 +1,24 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-const fs = require("fs");
-const path = require("path");
+import fs from "node:fs/promises";
+import path from "node:path";
 
 console.log("=================================== SETTING UP THE TESTS ===========================================");
 
-if (!fs.existsSync(path.join("..", "dist"))) {
+if (
+    !(await fs
+        .access(path.join("..", "dist"))
+        .then(() => true)
+        .catch(() => false))
+) {
     console.error("ERROR: Cannot find 'dist' folder. Did you forget to build the plugin with 'npm run build'?");
     process.exit(1);
 }
 
 console.log("Copying current build of plugin to node_modules for testing...");
 const nodeModulesSubDir = path.join("..", "node_modules", "typedoc-plugin-merge-modules");
 
-fs.rm(nodeModulesSubDir, { recursive: true, force: true }, (rmErr) => {
-    if (rmErr) {
-        throw rmErr;
-    }
-    fs.mkdir(path.join(nodeModulesSubDir, "dist"), { recursive: true }, (mkDirErr) => {
-        if (mkDirErr) {
-            throw mkDirErr;
-        } else {
-            fs.copyFileSync(path.join("..", "package.json"), path.join(nodeModulesSubDir, "package.json"));
-            fs.cpSync(path.join("..", "dist"), path.join(nodeModulesSubDir, "dist"), { recursive: true });
-        }
-    });
-});
+await fs.rm(nodeModulesSubDir, { recursive: true, force: true });
+await fs.mkdir(path.join(nodeModulesSubDir, "dist"), { recursive: true });
+await fs.copyFile(path.join("..", "package.json"), path.join(nodeModulesSubDir, "package.json"));
+await fs.cp(path.join("..", "dist"), path.join(nodeModulesSubDir, "dist"), { recursive: true });
 
 console.log("DONE\n");
diff --git a/test/test.js b/test/test.js
@@ -1,5 +1,4 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const { execSync } = require("child_process");
+import { execSync } from "node:child_process";
 const execOptions = { stdio: "inherit" };
 
 console.log("===================================== TEST MERGE OFF ===============================================");