refactor: Move CLI doc generation into documentation folder

Author: d3xter666

.github/workflows/deploy-vitepress-docs.yaml

@@ -43,18 +43,22 @@ jobs:
             - name: Install dependencies
               run: npm ci
             - name: Install documentation dependencies
-              run: cd packages/documentation && npm ci
+              working-directory: packages/documentation
+              run: npm ci
             - name: Fetch gh-pages branch
               run: git fetch origin gh-pages --depth=1
-            - name: Set /site ownership to current user
-              run: |
-                  mkdir site
-                  sudo chown -R $(id -u):$(id -g) ./site
+            # - name: Set /site ownership to current user
+            #   run: |
+            #       mkdir site
+            #       sudo chown -R $(id -u):$(id -g) ./site
             - name: generate CLI doc
+              working-directory: packages/documentation
               run: npm run generate-cli-doc
             - name: Build jsdoc
+              working-directory: packages/documentation
               run: npm run jsdoc-generate
             - name: Build vitepress build
+              working-directory: packages/documentation
               run: |
                 cd packages/documentation
                 # The base output

package.json

@@ -30,7 +30,6 @@
 		"coverage": "npm run coverage --workspaces",
 		"schema-generate": "node ./scripts/buildSchema.js ui5",
 		"schema-workspace-generate": "node ./scripts/buildSchema.js ui5-workspace",
-		"generate-cli-doc": "node ./scripts/generateCliDoc.js",
 		"depcheck": "depcheck --ignores @ui5/builder,@ui5/cli,@ui5/fs,@ui5/logger,@ui5/project,@ui5/server,local-web-server,@commitlint/config-conventional,husky && npm run depcheck --workspaces",
 		"check-licenses": "licensee --errors-only"
 	},

packages/documentation/package.json

@@ -28,7 +28,8 @@
 		"build:assets": "sh -c 'DEST_DIR=${1:-./dist}; cp -r ./docs/images \"$DEST_DIR/images\"' --",
 		"preview": "vitepress preview --port 8080",
 		"jsdoc": "npm run jsdoc-generate && open-cli dist/api/index.html",
-		"jsdoc-generate": "jsdoc -c jsdoc/jsdoc.json -t $(node -p 'path.dirname(require.resolve(\"docdash\"))') ./ || (echo 'Error during JSDoc generation! Check log.' && exit 1)"
+		"jsdoc-generate": "jsdoc -c jsdoc/jsdoc.json -t $(node -p 'path.dirname(require.resolve(\"docdash\"))') ./ || (echo 'Error during JSDoc generation! Check log.' && exit 1)",
+		"generate-cli-doc": "node ./scripts/generateCliDoc.js"
 	},
 	"dependencies": {
 		"@types/node": "^22.5.1",

scripts/generateCliDoc.js …/documentation/scripts/generateCliDoc.jsscripts/generateCliDoc.js renamed to packages/documentation/scripts/generateCliDoc.js scripts/generateCliDoc.js renamed to packages/documentation/scripts/generateCliDoc.js

@@ -3,7 +3,7 @@ import {readFileSync, writeFileSync} from "node:fs";
 import {fileURLToPath} from "node:url";
 import Handlebars from "handlebars";
 
-const source = readFileSync(fileURLToPath(new URL("../scripts/resources/CLI.template.md", import.meta.url)), "utf8");
+const source = readFileSync(fileURLToPath(new URL("./resources/CLI.template.md", import.meta.url)), "utf8");
 const template = Handlebars.compile(source);
 
 
@@ -189,7 +189,7 @@ function generateDoc() {
 		.replace(/(?<!\()(https?:\/\/[^\s)]+)(?!\))/g, "`$1`");
 	content = content.split("&#x3D;").join("=");
 	try {
-		writeFileSync("./packages/documentation/docs/pages/CLI.md", content);
+		writeFileSync("./docs/pages/CLI.md", content);
 	} catch (err) {
 		console.error(`Failed to generate docs/pages/CLI.md: ${err.message}.`);
 		throw err;