qt-qml: qmlls: Add -d option to specify kit documentation path

* Add `findQtPathsInKitDir()` to get Qt paths in kit directory
* Add `qt-qml.qmlls.customDocsPath` setting to specify kit documentation path
* Add `-d` option to specify kit documentation path
* Use `QT_INSTALL_DOCS` from `qtpaths` as default documentation path

When `qt-qml.qmlls.docsPath` is specified, it overrides the default
in either selected kit or qtpaths.

qt-lib/src/util.ts

@@ -237,6 +237,18 @@ export async function waitForQtCpp() {
   }
 }
 
+export function findQtPathsInKitDir(dir: string): string | undefined {
+  const exeNames = [`qtpaths${OSExeSuffix}`, `qtpaths6${OSExeSuffix}`];
+
+  for (const exeName of exeNames) {
+    const exePath = path.join(dir, 'bin', exeName);
+    if (fsSync.existsSync(exePath)) {
+      return exePath;
+    }
+  }
+  return undefined;
+}
+
 class FileWriter {
   private readonly files = new Map<
     string,

qt-qml/package.json

@@ -133,6 +133,12 @@
           "description": "Specify the custom qmlls executable path",
           "scope": "machine-overridable"
         },
+        "qt-qml.qmlls.customDocsPath": {
+          "type": "string",
+          "default": "",
+          "description": "Specify the documentation path for qmlls",
+          "scope": "machine-overridable"
+        },
         "qt-qml.qmlls.additionalImportPaths": {
           "type": "array",
           "items": {

qt-qml/src/project.ts

@@ -4,7 +4,12 @@
 import * as vscode from 'vscode';
 import path from 'path';
 
-import { Project, ProjectManager, createLogger } from 'qt-lib';
+import {
+  Project,
+  ProjectManager,
+  createLogger,
+  findQtPathsInKitDir
+} from 'qt-lib';
 import { Qmlls } from '@/qmlls';
 import { coreAPI } from '@/extension';
 
@@ -93,11 +98,29 @@ export class QMLProject implements Project {
     this.qtpathsExe = coreAPI?.getValue<string>(this.folder, 'selectedQtPaths');
     this.buildDir = coreAPI?.getValue<string>(this.folder, 'buildDir');
   }
+  getDocsPathFromKitDir(kitDir: string) {
+    const qtpaths = findQtPathsInKitDir(kitDir);
+    if (!qtpaths) {
+      logger.error(`Could not find qtpaths in: ${this.kitPath}`);
+      return undefined;
+    }
+    const qtInfo = coreAPI?.getQtInfoFromPath(qtpaths);
+    if (!qtInfo) {
+      logger.error('Could not find qtInfo');
+      return undefined;
+    }
+    return qtInfo.get('QT_INSTALL_DOCS');
+  }
 
   updateQmllsParams() {
     this.qmlls.clearImportPaths();
     if (this.kitPath) {
       this.qmlls.addImportPath(path.join(this.kitPath, 'qml'));
+      const docsPath = this.getDocsPathFromKitDir(this.kitPath);
+      if (docsPath) {
+        logger.info('Setting docs path:', docsPath);
+        this.qmlls.docsPath = docsPath;
+      }
     } else if (this.qtpathsExe) {
       const info = coreAPI?.getQtInfoFromPath(this.qtpathsExe);
       if (!info) {
@@ -108,6 +131,11 @@ export class QMLProject implements Project {
         throw new Error('Could not find QT_INSTALL_QML');
       }
       this.qmlls.addImportPath(qmlImportPath);
+      const docsPath = info.get('QT_INSTALL_DOCS');
+      if (docsPath) {
+        logger.info('Setting docs path:', docsPath);
+        this.qmlls.docsPath = docsPath;
+      }
     }
   }
   set buildDir(buildDir: string | undefined) {

qt-qml/src/qmlls.ts

@@ -119,6 +119,7 @@ export async function fetchAssetAndDecide(options?: {
 }
 
 export class Qmlls {
+  private _docsPath: string | undefined;
   private readonly _disposables: vscode.Disposable[] = [];
   private readonly _importPaths = new Set<string>();
   private _client: LanguageClient | undefined;
@@ -151,6 +152,14 @@ export class Qmlls {
     this._importPaths.add(importPath);
   }
 
+  get docsPath() {
+    return this._docsPath;
+  }
+
+  set docsPath(docsPath: string | undefined) {
+    this._docsPath = docsPath;
+  }
+
   removeImportPath(importPath: string) {
     this._importPaths.delete(importPath);
   }
@@ -279,6 +288,18 @@ export class Qmlls {
       []
     );
 
+    let docsPath = configs.get<string>('customDocsPath', '');
+    if (docsPath) {
+      // If qt-qml.qmlls.customDocsPath is set, use it instead of the path from the kit
+      docsPath = untildify(docsPath);
+    } else {
+      docsPath = this.docsPath ?? '';
+    }
+
+    if (docsPath) {
+      args.push(`-d${docsPath}`);
+    }
+
     const toImportParam = (p: string) => {
       return `-I${p}`;
     };