|
| 1 | +import { writeFile } from "fs-extra"; |
| 2 | +import { dump } from "js-yaml"; |
| 3 | +import { join } from "path"; |
| 4 | +import { Uri, workspace } from "vscode"; |
| 5 | +import { CodeQLCliServer } from "./cli"; |
| 6 | + |
| 7 | +export type QueryLanguage = |
| 8 | + | "csharp" |
| 9 | + | "cpp" |
| 10 | + | "go" |
| 11 | + | "java" |
| 12 | + | "javascript" |
| 13 | + | "python" |
| 14 | + | "ruby" |
| 15 | + | "swift"; |
| 16 | + |
| 17 | +export class QlPackGenerator { |
| 18 | + private readonly qlpackName: string; |
| 19 | + private readonly qlpackVersion: string; |
| 20 | + private readonly header: string; |
| 21 | + private readonly qlpackFileName: string; |
| 22 | + private readonly folderUri: Uri; |
| 23 | + |
| 24 | + constructor( |
| 25 | + private readonly folderName: string, |
| 26 | + private readonly queryLanguage: QueryLanguage, |
| 27 | + private readonly cliServer: CodeQLCliServer, |
| 28 | + private readonly storagePath: string | undefined, |
| 29 | + ) { |
| 30 | + if (this.storagePath === undefined) { |
| 31 | + throw new Error("Workspace storage path is undefined"); |
| 32 | + } |
| 33 | + this.qlpackName = `getting-started/codeql-extra-queries-${this.queryLanguage}`; |
| 34 | + this.qlpackVersion = "1.0.0"; |
| 35 | + this.header = "# This is an automatically generated file.\n\n"; |
| 36 | + |
| 37 | + this.qlpackFileName = "qlpack.yml"; |
| 38 | + this.folderUri = Uri.file(join(this.storagePath, this.folderName)); |
| 39 | + } |
| 40 | + |
| 41 | + public async generate() { |
| 42 | + // create QL pack folder and add to workspace |
| 43 | + await this.createWorkspaceFolder(); |
| 44 | + |
| 45 | + // create qlpack.yml |
| 46 | + await this.createQlPackYaml(); |
| 47 | + |
| 48 | + // create example.ql |
| 49 | + await this.createExampleQlFile(); |
| 50 | + |
| 51 | + // create codeql-pack.lock.yml |
| 52 | + await this.createCodeqlPackLockYaml(); |
| 53 | + } |
| 54 | + |
| 55 | + private async createWorkspaceFolder() { |
| 56 | + await workspace.fs.createDirectory(this.folderUri); |
| 57 | + |
| 58 | + const end = (workspace.workspaceFolders || []).length; |
| 59 | + |
| 60 | + await workspace.updateWorkspaceFolders(end, 0, { |
| 61 | + name: this.folderName, |
| 62 | + uri: this.folderUri, |
| 63 | + }); |
| 64 | + } |
| 65 | + |
| 66 | + private async createQlPackYaml() { |
| 67 | + const qlPackFilePath = join(this.folderUri.fsPath, this.qlpackFileName); |
| 68 | + |
| 69 | + const qlPackYml = { |
| 70 | + name: this.qlpackName, |
| 71 | + version: this.qlpackVersion, |
| 72 | + dependencies: {}, |
| 73 | + }; |
| 74 | + |
| 75 | + await writeFile(qlPackFilePath, this.header + dump(qlPackYml), "utf8"); |
| 76 | + } |
| 77 | + |
| 78 | + private async createExampleQlFile() { |
| 79 | + const exampleQlFilePath = join(this.folderUri.fsPath, "example.ql"); |
| 80 | + |
| 81 | + const exampleQl = ` |
| 82 | +/** |
| 83 | + * This is an automatically generated file |
| 84 | + * @name Empty block |
| 85 | + * @kind problem |
| 86 | + * @problem.severity warning |
| 87 | + * @id ${this.queryLanguage}/example/empty-block |
| 88 | + */ |
| 89 | +
|
| 90 | +import ${this.queryLanguage} |
| 91 | +
|
| 92 | +select "Hello, world!" |
| 93 | +`.trim(); |
| 94 | + |
| 95 | + await writeFile(exampleQlFilePath, exampleQl, "utf8"); |
| 96 | + } |
| 97 | + |
| 98 | + private async createCodeqlPackLockYaml() { |
| 99 | + await this.cliServer.packAdd(this.folderUri.fsPath, this.queryLanguage); |
| 100 | + } |
| 101 | +} |
0 commit comments