Hardcode --format=markdown option

Author: mgsium

extensions/ql-vscode/src/cli.ts

@@ -620,13 +620,12 @@ export class CodeQLCliServer implements Disposable {
    * @param format The format in which the query help should be generated {@link https://codeql.github.com/docs/codeql-cli/manual/generate-query-help/#cmdoption-codeql-generate-query-help-format}
    * @param outputDirectory The output directory for the generated file
    */
-  async generateQueryHelp(pathToQhelp:string, format: string, outputDirectory?: string): Promise<string> {
-    const subcommandArgs = [];
-    subcommandArgs.push('--format', format);
+  async generateQueryHelp(pathToQhelp:string, outputDirectory?: string): Promise<string> {
+    const subcommandArgs = ['--format=markdown'];
     if(outputDirectory) subcommandArgs.push('--output', outputDirectory);
     subcommandArgs.push(pathToQhelp);
 
-    return await this.runCodeQlCliCommand(['generate', 'query-help'], subcommandArgs, `Generating qhelp in ${format} format at ${outputDirectory}`);
+    return await this.runCodeQlCliCommand(['generate', 'query-help'], subcommandArgs, `Generating qhelp in markdown format at ${outputDirectory}`);
   }
 
   /**

extensions/ql-vscode/src/extension.ts

@@ -497,19 +497,19 @@ async function activateWithInstalledDistribution(
   async function previewQueryHelp(
     selectedQuery: Uri
   ): Promise<void> {
-    const path = selectedQuery ? selectedQuery.path : window.activeTextEditor!.document.uri.fsPath;
-    if(path) {
+    const pathToQhelp = selectedQuery ? selectedQuery.path : window.activeTextEditor!.document.uri.fsPath;
+    if(pathToQhelp) {
       // Create temporary directory
       const tmpDir = tmp.dirSync();
-      const relativePathToMd = path.basename(path, '.qhelp') + '.md'
-      const absolutePathToMd = path.join(tmpDir.name, relativePathToMd)`;
+      const relativePathToMd = path.basename(pathToQhelp, '.qhelp') + '.md';
+      const absolutePathToMd = path.join(tmpDir.name, relativePathToMd);
       const uri = Uri.file(absolutePathToMd);
       try {
-        await cliServer.generateQueryHelp(path , 'markdown', absolutePathToMd);
+        await cliServer.generateQueryHelp(pathToQhelp , absolutePathToMd);
         await commands.executeCommand('markdown.showPreviewToSide', uri);
       } catch (err) {
         const errorMessage =  err.message.includes('Generating qhelp in markdown') ? (
-          `Could not generate markdown from ${path}: Bad formatting in .qhelp file.`
+          `Could not generate markdown from ${pathToQhelp}: Bad formatting in .qhelp file.`
         ) : `Could not open a preview of the generated file (${absolutePathToMd}).`;
         void helpers.showAndLogErrorMessage(errorMessage);
       }