Add a JSDoc description for the method

This commit is contained in:
Elena Tanasoiu
2023-04-13 12:00:23 +00:00
parent 5634c1ee51
commit b83d54f285

View File

@@ -786,6 +786,18 @@ export async function* walkDirectory(
}
}
/**
* Returns the path of the first folder in the workspace.
* This is used to decide where to create skeleton QL packs.
*
* If the first folder is a QL pack, then the parent folder is returned.
* This is because the vscode-codeql-starter repo contains a ql pack in
* the first folder.
*
* This is a temporary workaround until we can retire the
* vscode-codeql-starter repo.
*/
export function getFirstWorkspaceFolder() {
const workspaceFolders = workspace.workspaceFolders;