feat: Integrate JSDoc output into vitepress #1240

d3xter666 · 2025-12-11T07:33:20Z

JIRA: CPOUI5FOUNDATION-904

cla-assistant · 2025-12-11T07:33:37Z

All committers have signed the CLA.

coveralls · 2025-12-11T07:37:07Z

coverage: 94.336%. remained the same
when pulling 426458e on jsdoc-to-markdow
into bbf3d69 on main.

internal/documentation/jsdoc-to-markdown.js

internal/documentation/jsdoc-to-markdown-v1.js

internal/documentation/jsdoc/docdash/publish.js

+
+    // Recursively handle the inner type
+    if (isComplexTypeExpression(innerType)) {
+        result += linkComplexType(innerType, null, classString.replace(' class="', '').replace('"', ''));


In general, to fix this kind of problem you should either use a proper sanitization/escaping library or, if you’re just doing simple character stripping, use a regular expression with the global (g) flag so that all occurrences are replaced, not just the first. When removing quotation marks or similar characters, make sure to handle all instances so partially-sanitized strings cannot cause malformed output.

In this concrete case, the intent on line 748 is to turn something like classString (probably class="SomeClass") into just the inner value (SomeClass) for use as a class attribute when generating links for complex types. The current code does this by first removing the substring class=" and then removing only the first remaining " character. To make this robust, we should (a) remove the leading class=" as now, and then (b) remove all remaining double quotes using a regex with the global flag. This preserves existing behavior for simple cases, but correctly handles any classString with more than one double quote.

Concretely, in internal/documentation/jsdoc/docdash/publish.js, within linkGenericType, change line 748 so that the second .replace uses a global regex: .replace(/"/g, '') instead of .replace('"', ''). No new imports or helper methods are required.

matz3 · 2025-12-19T10:17:58Z

internal/documentation/jsdoc/jsdoc.json

 			}
-		}
+		},
+		"githubSourceBaseUrl": "https://github.com/UI5/cli/blob/main/pacakges/"


Suggested change

"githubSourceBaseUrl": "https://github.com/UI5/cli/blob/main/pacakges/"

"githubSourceBaseUrl": "https://github.com/UI5/cli/blob/main/packages/"

matz3 · 2025-12-19T10:20:06Z

packages/server/lib/middleware/testRunner/TestRunner.js

@@ -1,4 +1,4 @@
-(function(window) {
+nbpm(function(window) {


matz3 · 2025-12-19T10:20:20Z

CONTRIBUTING.md

d3xter666

And one general comment:

We shall not modify the content within packages/ folder, nor delete anything from there. That will impact the UI5 CLI functionality, tests and docs

d3xter666 · 2025-12-19T10:34:01Z

internal/documentation/jsdoc-to-markdown-v1.js

+if (process.argv[2] == "gh-pages") {
+    // Read package.json of packages/builder
+    const builderJson = JSON.parse(fs.readFileSync("tmp/packages/@ui5/builder/package.json"));
+    packageTagName = `https://github.com/UI5/cli/blob/cli-v${builderJson["version"]}/packages/`;


This link is invalid, because the previous versions of UI5 CLI are not within a monorepo, but separate packages and they have separate repositories. There is no packages folder, except for the main branch

d3xter666 · 2025-12-19T10:36:43Z

internal/documentation/jsdoc-to-markdown-v1.js

+	for (const file of fs.readdirSync(outputDirectory)) {
+		fs.rmSync(path.join(outputDirectory, file));
+	}
+}


You can use the rimraf package and clean the whole dir

d3xter666 · 2025-12-19T10:39:03Z

internal/documentation/jsdoc-to-markdown-v1.js

+}
+
+async function checkDeadlinks(link, sourcePath) {
+    if ((await fetch(link)).status != 200) {


It should not be within the 4xx range. Please take a look here: https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status

d3xter666 · 2025-12-19T10:42:02Z

internal/documentation/jsdoc/docdash/CHANGELOG.md

@@ -0,0 +1,92 @@
+## Modified by SAP


Why is this package copied here, but not used as dependency to the documentation?

d3xter666 · 2025-12-19T10:44:18Z

packages/builder/lib/lbt/resources/ModuleInfo.js

-		 * <pre>
-		 *	 this["name"] = name;
-		 * </pre>


This is how our current JSDoc works. Can we handle this in the transofrmation?
I know that if we leave it like that here, the vitepress build might fail

Fixes Modify config.ts for vitepress Remove file Layout and functionality improvements Vitepress build fix and search improvements Move to different approach Fixes and move jsdoc to cli Add back apidocs.css and linking fixes Fix internal linking Fix external links Fixes Fix links attempt and disable next/prev in api docs Fix width and build directory and remove pagefind Don't generate js.md files

matz3 · 2026-01-20T12:04:36Z

There are still some dead links. You can find them by searching for .md" within ./internal/documentation/dist/api. Note that some of those links are correct (e.g. links to a RFC document on GitHub).

Please continue to create new commits, as that makes reviewing changes easier. We can squash all commits again after all open points have been addressed.

d3xter666 marked this pull request as draft December 11, 2025 07:33

github-advanced-security bot found potential problems Dec 11, 2025

View reviewed changes

internal/documentation/jsdoc-to-markdown.js Fixed Show fixed Hide fixed

github-advanced-security bot found potential problems Dec 15, 2025

View reviewed changes

internal/documentation/jsdoc-to-markdown-v1.js Fixed Show fixed Hide fixed

github-advanced-security bot found potential problems Dec 18, 2025

View reviewed changes

internal/documentation/jsdoc/docdash/publish.js Fixed Show fixed Hide fixed

github-advanced-security bot found potential problems Dec 18, 2025

View reviewed changes

matz3 reviewed Dec 19, 2025

View reviewed changes

d3xter666 commented Dec 19, 2025

View reviewed changes

werwolf2303 force-pushed the jsdoc-to-markdow branch 7 times, most recently from 0d5c362 to 075a37e Compare January 20, 2026 08:15

werwolf2303 force-pushed the jsdoc-to-markdow branch from 075a37e to 426458e Compare January 20, 2026 10:26

@@ -745,7 +745,7 @@
                 // Recursively handle the inner type
                 if (isComplexTypeExpression(innerType)) {
-                    result += linkComplexType(innerType, null, classString.replace(' class="', '').replace('"', ''));
+                    result += linkComplexType(innerType, null, classString.replace(' class="', '').replace(/"/g, ''));
                 } else {
                     let innerUrl = helper.longnameToUrl[innerType];
                     if (innerUrl) {

	"githubSourceBaseUrl": "https://github.com/UI5/cli/blob/main/pacakges/"
	"githubSourceBaseUrl": "https://github.com/UI5/cli/blob/main/packages/"

		@@ -1,4 +1,4 @@
		(function(window) {
		nbpm(function(window) {

feat: Integrate JSDoc output into vitepress #1240

Are you sure you want to change the base?

feat: Integrate JSDoc output into vitepress #1240

Conversation

d3xter666 commented Dec 11, 2025

Uh oh!

cla-assistant bot commented Dec 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coveralls commented Dec 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Check failure

Copilot Autofix

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

d3xter666 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

matz3 commented Jan 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

cla-assistant bot commented Dec 11, 2025 •

edited

Loading

coveralls commented Dec 11, 2025 •

edited

Loading