Use more descriptive names

Author: robertbrignull

extensions/ql-vscode/src/pure/files.ts

@@ -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),
   );
 }
 

extensions/ql-vscode/test/unit-tests/pure/files.test.ts

@@ -207,95 +207,95 @@ 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,
     },
   ];
 
   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);
     },
   );
 });