Use more descriptive names

This commit is contained in:
Robert
2023-06-12 12:05:52 +01:00
parent fe21a21ca2
commit 8b1e49c6c0
2 changed files with 28 additions and 28 deletions

View File

@@ -72,15 +72,15 @@ export function pathsEqual(
}
/**
* Returns true if path1 contains path2.
* Returns true if `parent` contains `child`.
*/
export function containsPath(
path1: string,
path2: string,
parent: string,
child: string,
platform: NodeJS.Platform,
): boolean {
return normalizePath(path2, platform).startsWith(
normalizePath(path1, platform),
return normalizePath(child, platform).startsWith(
normalizePath(parent, platform),
);
}

View File

@@ -207,79 +207,79 @@ describe("pathsEqual", () => {
describe("containsPath", () => {
const testCases: Array<{
path1: string;
path2: string;
parent: string;
child: string;
platform: NodeJS.Platform;
expected: boolean;
}> = [
{
path1:
parent:
"/home/github/projects/vscode-codeql-starter/codeql-custom-queries-javascript",
path2:
child:
"/home/github/projects/vscode-codeql-starter/codeql-custom-queries-javascript/example.ql",
platform: "linux",
expected: true,
},
{
path1:
parent:
"/HOME/github/projects/vscode-codeql-starter/codeql-custom-queries-javascript",
path2:
child:
"/home/github/projects/vscode-codeql-starter/codeql-custom-queries-javascript/example.ql",
platform: "linux",
expected: false,
},
{
path1:
parent:
"/home/github/projects/vscode-codeql-starter/codeql-custom-queries-javascript/example.ql",
path2:
child:
"/home/github/projects/vscode-codeql-starter/codeql-custom-queries-javascript",
platform: "linux",
expected: false,
},
{
path1:
parent:
"C:/Users/github/projects/vscode-codeql-starter/codeql-custom-queries-javascript",
path2:
child:
"C:/Users/github/projects/vscode-codeql-starter/codeql-custom-queries-javascript/example.ql",
platform: "win32",
expected: true,
},
{
path1:
parent:
"C:/Users/github/projects/vscode-codeql-starter/codeql-custom-queries-javascript",
path2:
child:
"c:/Users/github/projects/vscode-codeql-starter/codeql-custom-queries-javascript/example.ql",
platform: "win32",
expected: true,
},
{
path1:
parent:
"C:/Users/github/projects/vscode-codeql-starter/codeql-custom-queries-javascript",
path2:
child:
"D:/Users/github/projects/vscode-codeql-starter/codeql-custom-queries-javascript/example.ql",
platform: "win32",
expected: false,
},
{
path1:
parent:
"C:/Users/github/projects/vscode-codeql-starter/codeql-custom-queries-javascript/example.ql",
path2:
child:
"C:/Users/github/projects/vscode-codeql-starter/codeql-custom-queries-javascript",
platform: "win32",
expected: false,
},
{
path1:
parent:
"C:/Users/github/projects/vscode-codeql-starter/codeql-custom-queries-javascript",
path2:
child:
"C:\\Users\\github\\projects\\vscode-codeql-starter\\codeql-custom-queries-javascript\\example.ql",
platform: "win32",
expected: true,
},
{
path1:
parent:
"C:/Users/github/projects/vscode-codeql-starter/codeql-custom-queries-javascript",
path2:
child:
"D:\\Users\\github\\projects\\vscode-codeql-starter\\codeql-custom-queries-javascript\\example.ql",
platform: "win32",
expected: false,
@@ -287,15 +287,15 @@ describe("containsPath", () => {
];
test.each(testCases)(
"$path1 contains $path2 on $platform = $expected",
({ path1, path2, platform, expected }) => {
"$parent contains $child on $platform = $expected",
({ parent, child, platform, expected }) => {
if (platform !== process.platform) {
// We're using the platform-specific path.resolve, so we can't really run
// these tests on all platforms.
return;
}
expect(containsPath(path1, path2, platform)).toEqual(expected);
expect(containsPath(parent, child, platform)).toEqual(expected);
},
);
});