Merge branch 'typedoc-0.23'

krisztianb · Jul 24, 2022 · d1ffff8 · d1ffff8
2 parents e19947a + b1530db
commit d1ffff8
Show file tree

Hide file tree

Showing 7 changed files with 202 additions and 219 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.7.0] - 2022-07-24
+### Changed
+- Updated to TypeDoc version 0.23
+### Breaking Changes
+- Support changed to TypeDoc versions 0.23.x due to a change in TypeDoc's HTML output.
+
 ## [0.6.1] - 2022-06-05
 ### Changed
 - Updated dependencies to resolve their security vulnerabilities
@@ -111,7 +117,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - First version
 
-[Unreleased]: https://github.com/krisztianb/typedoc-umlclass/compare/v0.6.1...HEAD
+[Unreleased]: https://github.com/krisztianb/typedoc-umlclass/compare/v0.7.0...HEAD
+[0.7.0]: https://github.com/krisztianb/typedoc-umlclass/releases/tag/v0.7.0
 [0.6.1]: https://github.com/krisztianb/typedoc-umlclass/releases/tag/v0.6.1
 [0.6.0]: https://github.com/krisztianb/typedoc-umlclass/releases/tag/v0.6.0
 [0.5.0]: https://github.com/krisztianb/typedoc-umlclass/releases/tag/v0.5.0

diff --git a/README.md b/README.md
@@ -27,7 +27,7 @@ The plugin requires the following software to be installed on your system:
 
 * [JAVA](https://www.java.com/) (latest version)
 * [Graphviz](https://graphviz.org/) (latest version)
-* [TypeDoc](https://typedoc.org/) (supported versions: 0.22.0 and above)
+* [TypeDoc](https://typedoc.org/) (supported versions: 0.23.0 and above)
 
 ## Options
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "typedoc-umlclass",
-    "version": "0.6.1",
+    "version": "0.7.0",
     "description": "Plugin for TypeDoc that generates UML class diagrams",
     "author": {
         "name": "Krisztián Balla",
@@ -22,19 +22,19 @@
         "@types/node": "14.14.27",
         "@types/plantuml-encoder": "1.4.0",
         "@types/progress": "2.0.5",
-        "@typescript-eslint/eslint-plugin": "5.27.0",
-        "@typescript-eslint/parser": "5.27.0",
-        "eslint": "8.17.0",
-        "eslint-plugin-jsdoc": "39.3.2",
+        "@typescript-eslint/eslint-plugin": "5.30.7",
+        "@typescript-eslint/parser": "5.30.7",
+        "eslint": "8.20.0",
+        "eslint-plugin-jsdoc": "39.3.3",
         "eslint-plugin-ordered-imports": "0.6.0",
-        "eslint-plugin-unicorn": "42.0.0",
-        "prettier": "2.6.2",
+        "eslint-plugin-unicorn": "43.0.2",
+        "prettier": "2.7.1",
         "rimraf": "3.0.2",
-        "typedoc": "0.22.17",
-        "typescript": "4.7.3"
+        "typedoc": "0.23.8",
+        "typescript": "4.7.4"
     },
     "peerDependencies": {
-        "typedoc": "0.22.x"
+        "typedoc": "0.23.x"
     },
     "repository": {
         "type": "git",

diff --git a/src/diagram_legend.ts b/src/diagram_legend.ts
@@ -111,7 +111,7 @@ export class DiagramLegend {
      * @returns The HTML for the diagram legend.
      */
     public getHtml(memberVisbilityStyle: "text" | "icon"): string {
-        let legend = `<h4>Legend</h4>
+        let legend = `<h5>Legend</h5>
                       <div class="legend">`;
 
         if (this.hasClassIcon) {
@@ -215,7 +215,7 @@ export class DiagramLegend {
      */
     public static getCss(): string {
         return (
-            ".tsd-hierarchy-diagram h4 { margin: 10px -20px 5px -20px; border-top: 1px solid #eee; padding: 10px 20px; }\n" +
+            ".tsd-hierarchy-diagram h5 { margin: 10px 0 5px 0; padding: 10px 0; }\n" +
             ".tsd-hierarchy-diagram .legend { display: flex; flex-flow: row wrap; align-items: center; font-size: 10px; }\n" +
             ".tsd-hierarchy-diagram .legend div { width: 185px; display: flex; flex-flow: row nowrap; align-items: center; height: 34px; }\n" +
             ".tsd-hierarchy-diagram .legend div span.dt { display: block; width: 55px; text-align: center; margin-right: 5px; }\n" +

diff --git a/src/typedoc/page_section.ts b/src/typedoc/page_section.ts
@@ -22,15 +22,15 @@ export function createHierarchyDiagramSection(
     // URLs with data are not clickable in browsers for security concerns => just output an image tag
     if (imageUrl.startsWith("data:")) {
         return `<section class="tsd-panel tsd-hierarchy-diagram">
-                    <h3>${title}</h3>
+                    <h4>${title}</h4>
                     <img class="diagram" src="${imageUrl}"
                             alt="UML class diagram of ${reflectionName}"
                             title="Right click and select 'View image' to enlarge" />
                     ${legendHtml ?? ""}
                 </section>\n`;
     }
     return `<section class="tsd-panel tsd-hierarchy-diagram">
-                <h3>${title}</h3>
+                <h4>${title}</h4>
                 <a class="diagram" href="${imageUrl}" title="Click to enlarge">
                     <img src="${imageUrl}"
                             alt="UML class diagram of ${reflectionName}" />

diff --git a/src/typedoc/page_section_finder.ts b/src/typedoc/page_section_finder.ts
@@ -57,6 +57,6 @@ export class PageSectionFinder {
      * @returns The regular expression to match the section.
      */
     private static createLookUpRegexpForSection(sectionName: string): RegExp {
-        return new RegExp('<section class="tsd-panel[^"<>]*?">\\s*<h3>' + sectionName + "</h3>[^]*?</section>");
+        return new RegExp('<section class="tsd-panel[^"<>]*?">\\s*<h\\d>' + sectionName + "</h\\d>[^]*?</section>");
     }
 }