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.337%. remained the same
when pulling c02266f on jsdoc-to-markdow
into f7e2e73 on main.

internal/documentation/jsdoc-to-markdown.js

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

internal/documentation/jsdoc/docdash/publish.js

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

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.

internal/documentation/jsdoc/docdash/publish.js

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


In general, the problem should be fixed by ensuring that all occurrences of the characters being stripped or escaped are handled, rather than just the first one. For JavaScript strings, this typically means using replace with a regular expression that has the g (global) flag, or using replaceAll where available, instead of passing a plain string as the pattern.

In this specific case, the intention on line 695 is to strip the entire class="..."> fragment down to just the class value (e.g., class="foo bar" → foo bar) before passing it onward. The current code uses classString.replace(' class="', '').replace('"', ''), which: (1) removes only the first exact class=" substring, and (2) removes only the first remaining " character. A safer and clearer way is to:

First extract the class name using a capturing regular expression like /\sclass="([^"]*)"/, then

Use that captured value as the class string (or empty string if no match).

This avoids any dependence on fragile multiple replace calls and fully removes quotes instead of just the first occurrence, while preserving existing functionality (it still turns something like class="foo" into foo).

Concretely:

In internal/documentation/jsdoc/docdash/publish.js, update the expression used as the third argument to linkComplexType on line 695.

Instead of chaining two string-based replace calls, use String.prototype.match with /\sclass="([^"]*)"/ to extract the class name; if the regexp does not match, fall back to an empty string.

No new imports or helpers are needed; this can be done inline where the argument is constructed.

This commit adds a copy of original files from docdash 2.0.2 [1]. [1] https://github.com/clenemt/docdash/tree/bee5d0789068be6a1e01ce02968b23dd021b4fb6

This had the risk of potentially destroying an external link that pointed to an .md file with a line number

…les .js.md

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

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

matz3 reviewed Dec 19, 2025

View reviewed changes

d3xter666 commented Dec 19, 2025

View reviewed changes

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

werwolf2303 force-pushed the jsdoc-to-markdow branch from 3ab8984 to 453fa3e Compare January 21, 2026 07:31

github-advanced-security bot found potential problems Jan 21, 2026

View reviewed changes

matz3 force-pushed the jsdoc-to-markdow branch from f856fae to 2ee1b26 Compare January 21, 2026 13:46

matz3 and others added 9 commits January 21, 2026 16:03

docs: Add copy of docdash JSDoc template

a07b02c

This commit adds a copy of original files from docdash 2.0.2 [1]. [1] https://github.com/clenemt/docdash/tree/bee5d0789068be6a1e01ce02968b23dd021b4fb6

docs: Migrate API Docs to Vitepress

6988351

docs: Don't replace all occurrences of .md#

7e05c71

This had the risk of potentially destroying an external link that pointed to an .md file with a line number

docs: Highlight modified code in publish.js and don't write source fi…

1f4fdfb

…les .js.md

docs: Fix .md ending in internal links

b21e5c2

docs: Fix pipe encoding in Markdown files

ebdcf52

refactor: Remove unused code from jsdoc publish.js

c1642f5

refactor: Integrate docdash into documentation project

9cb9aed

docs: Cleanup old comments and unused code

07dea8e

fix: Change two dots in Promise to one

c02266f

werwolf2303 force-pushed the jsdoc-to-markdow branch from c3dfbc9 to c02266f Compare January 21, 2026 15:29

@@ -692,7 +692,9 @@
             	// Recursively handle the inner type
             	if (isComplexTypeExpression(innerType)) {
-            		result += linkComplexType(innerType, null, classString.replace(' class="', '').replace('"', ''));
+            		const classMatch = classString && String(classString).match(/\sclass="([^"]*)"/);
+            		const innerClassString = classMatch ? classMatch[1] : '';
+            		result += linkComplexType(innerType, null, innerClassString);
             	} 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

Uh oh!

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!

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!

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!

Check failure

Copilot Autofix

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