Skip to content

Commit eec85d3

Browse files
committed
Replaced 'qlhelp' with 'qhelp'
1 parent 991f2f4 commit eec85d3

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

extensions/ql-vscode/src/cli.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -611,17 +611,17 @@ export class CodeQLCliServer implements Disposable {
611611

612612
/**
613613
* Uses a .qhelp file to generate Query Help documentation in a specified format.
614-
* @param pathToQlhelp The path to the .qhelp file
614+
* @param pathToQhelp The path to the .qhelp file
615615
* @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}
616616
* @param outputDirectory The output directory for the generated file
617617
*/
618-
async generateQueryHelp(pathToQlhelp:string, format: string, outputDirectory?: string): Promise<string> {
618+
async generateQueryHelp(pathToQhelp:string, format: string, outputDirectory?: string): Promise<string> {
619619
const subcommandArgs = [];
620620
subcommandArgs.push('--format', format);
621621
if(outputDirectory) subcommandArgs.push('--output', outputDirectory);
622-
subcommandArgs.push(pathToQlhelp);
622+
subcommandArgs.push(pathToQhelp);
623623

624-
return await this.runCodeQlCliCommand(['generate', 'query-help'], subcommandArgs, `Generating qlhelp in ${format} format at ${outputDirectory}`);
624+
return await this.runCodeQlCliCommand(['generate', 'query-help'], subcommandArgs, `Generating qhelp in ${format} format at ${outputDirectory}`);
625625
}
626626

627627
/**

extensions/ql-vscode/src/extension.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -513,7 +513,7 @@ async function activateWithInstalledDistribution(
513513
await cliServer.generateQueryHelp(path , 'markdown', absolutePathToMd);
514514
await commands.executeCommand('markdown.showPreviewToSide', uri);
515515
} catch (err) {
516-
const errorMessage = err.message.includes('Generating qlhelp in markdown') ? (
516+
const errorMessage = err.message.includes('Generating qhelp in markdown') ? (
517517
`Could not generate markdown from ${path}: Bad formatting in .qhelp file.`
518518
) : `Could not open a preview of the generated file (${absolutePathToMd}).`;
519519
void helpers.showAndLogErrorMessage(errorMessage);

0 commit comments

Comments
 (0)